class NFTStorage::Deal

Attributes

batch_root_cid[RW]
chain_deal_id[RW]

Identifier for the deal stored on chain.

deal_activation[RW]

This is a timestamp in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ.

deal_expiration[RW]

This is a timestamp in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ.

last_change[RW]

This is a timestamp in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ.

miner[RW]

Miner ID

network[RW]

Filecoin network for this Deal

piece_cid[RW]

Piece CID string

status[RW]

Deal status

status_text[RW]

Deal status description.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/nft_storage/models/deal.rb, line 86
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/nft_storage/models/deal.rb, line 70
def self.attribute_map
  {
    :'batch_root_cid' => :'batchRootCid',
    :'last_change' => :'lastChange',
    :'miner' => :'miner',
    :'network' => :'network',
    :'piece_cid' => :'pieceCid',
    :'status' => :'status',
    :'status_text' => :'statusText',
    :'chain_deal_id' => :'chainDealID',
    :'deal_activation' => :'dealActivation',
    :'deal_expiration' => :'dealExpiration'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/nft_storage/models/deal.rb, line 247
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/nft_storage/models/deal.rb, line 114
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NFTStorage::Deal` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `NFTStorage::Deal`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'batch_root_cid')
    self.batch_root_cid = attributes[:'batch_root_cid']
  end

  if attributes.key?(:'last_change')
    self.last_change = attributes[:'last_change']
  end

  if attributes.key?(:'miner')
    self.miner = attributes[:'miner']
  end

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  end

  if attributes.key?(:'piece_cid')
    self.piece_cid = attributes[:'piece_cid']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'status_text')
    self.status_text = attributes[:'status_text']
  end

  if attributes.key?(:'chain_deal_id')
    self.chain_deal_id = attributes[:'chain_deal_id']
  end

  if attributes.key?(:'deal_activation')
    self.deal_activation = attributes[:'deal_activation']
  end

  if attributes.key?(:'deal_expiration')
    self.deal_expiration = attributes[:'deal_expiration']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/nft_storage/models/deal.rb, line 107
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/nft_storage/models/deal.rb, line 91
def self.openapi_types
  {
    :'batch_root_cid' => :'String',
    :'last_change' => :'String',
    :'miner' => :'String',
    :'network' => :'String',
    :'piece_cid' => :'String',
    :'status' => :'String',
    :'status_text' => :'String',
    :'chain_deal_id' => :'Float',
    :'deal_activation' => :'String',
    :'deal_expiration' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/nft_storage/models/deal.rb, line 217
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      batch_root_cid == o.batch_root_cid &&
      last_change == o.last_change &&
      miner == o.miner &&
      network == o.network &&
      piece_cid == o.piece_cid &&
      status == o.status &&
      status_text == o.status_text &&
      chain_deal_id == o.chain_deal_id &&
      deal_activation == o.deal_activation &&
      deal_expiration == o.deal_expiration
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/nft_storage/models/deal.rb, line 277
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = NFTStorage.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/nft_storage/models/deal.rb, line 348
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/nft_storage/models/deal.rb, line 254
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/nft_storage/models/deal.rb, line 234
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/nft_storage/models/deal.rb, line 240
def hash
  [batch_root_cid, last_change, miner, network, piece_cid, status, status_text, chain_deal_id, deal_activation, deal_expiration].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/nft_storage/models/deal.rb, line 170
def list_invalid_properties
  invalid_properties = Array.new
  if @last_change.nil?
    invalid_properties.push('invalid value for "last_change", last_change cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end
network=(network) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned

# File lib/nft_storage/models/deal.rb, line 197
def network=(network)
  validator = EnumAttributeValidator.new('String', ["nerpanet", "mainnet"])
  unless validator.valid?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{validator.allowable_values}."
  end
  @network = network
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/nft_storage/models/deal.rb, line 207
def status=(status)
  validator = EnumAttributeValidator.new('String', ["queued", "proposing", "accepted", "failed", "active", "published", "terminated"])
  unless validator.valid?(status)
    fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/nft_storage/models/deal.rb, line 324
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/nft_storage/models/deal.rb, line 330
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/nft_storage/models/deal.rb, line 318
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/nft_storage/models/deal.rb, line 185
def valid?
  return false if @last_change.nil?
  network_validator = EnumAttributeValidator.new('String', ["nerpanet", "mainnet"])
  return false unless network_validator.valid?(@network)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["queued", "proposing", "accepted", "failed", "active", "published", "terminated"])
  return false unless status_validator.valid?(@status)
  true
end