Class: AmznSpApi::ProductFeesApiModel::FeesEstimateIdentifier

Inherits:
Object
  • Object
show all
Defined in:
lib/product_fees_api_model/models/fees_estimate_identifier.rb

Overview

An item identifier, marketplace, time of request, and other details that identify an estimate.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeesEstimateIdentifier

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Raises:

  • (ArgumentError)


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 67

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ProductFeesApiModel::FeesEstimateIdentifier` initialize method' unless attributes.is_a?(Hash)

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

    h[k.to_sym] = v
  end

  self.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

  self.seller_id = attributes[:seller_id] if attributes.key?(:seller_id)

  self.id_type = attributes[:id_type] if attributes.key?(:id_type)

  self.id_value = attributes[:id_value] if attributes.key?(:id_value)

  self.is_amazon_fulfilled = attributes[:is_amazon_fulfilled] if attributes.key?(:is_amazon_fulfilled)

  self.price_to_estimate_fees = attributes[:price_to_estimate_fees] if attributes.key?(:price_to_estimate_fees)

  self.seller_input_identifier = attributes[:seller_input_identifier] if attributes.key?(:seller_input_identifier)

  return unless attributes.key?(:optional_fulfillment_program)

  self.optional_fulfillment_program = attributes[:optional_fulfillment_program]
end

Instance Attribute Details

#id_typeObject

Returns the value of attribute id_type.



21
22
23
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 21

def id_type
  @id_type
end

#id_valueObject

The item identifier.



24
25
26
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 24

def id_value
  @id_value
end

#is_amazon_fulfilledObject

When true, the offer is fulfilled by Amazon.



27
28
29
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 27

def is_amazon_fulfilled
  @is_amazon_fulfilled
end

#marketplace_idObject

A marketplace identifier.



16
17
18
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 16

def marketplace_id
  @marketplace_id
end

#optional_fulfillment_programObject

Returns the value of attribute optional_fulfillment_program.



21
22
23
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 21

def optional_fulfillment_program
  @optional_fulfillment_program
end

#price_to_estimate_feesObject

Returns the value of attribute price_to_estimate_fees.



21
22
23
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 21

def price_to_estimate_fees
  @price_to_estimate_fees
end

#seller_idObject

The seller identifier.



19
20
21
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 19

def seller_id
  @seller_id
end

#seller_input_identifierObject

A unique identifier provided by the caller to track this request.



30
31
32
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 30

def seller_input_identifier
  @seller_input_identifier
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 33

def self.attribute_map
  {
    'marketplace_id': :MarketplaceId,
    'seller_id': :SellerId,
    'id_type': :IdType,
    'id_value': :IdValue,
    'is_amazon_fulfilled': :IsAmazonFulfilled,
    'price_to_estimate_fees': :PriceToEstimateFees,
    'seller_input_identifier': :SellerInputIdentifier,
    'optional_fulfillment_program': :OptionalFulfillmentProgram
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



139
140
141
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 139

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



61
62
63
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 61

def self.openapi_nullable
  Set.new([])
end

.openapi_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 47

def self.openapi_types
  {
    'marketplace_id': :Object,
    'seller_id': :Object,
    'id_type': :Object,
    'id_value': :Object,
    'is_amazon_fulfilled': :Object,
    'price_to_estimate_fees': :Object,
    'seller_input_identifier': :Object,
    'optional_fulfillment_program': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 110

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    marketplace_id == other.marketplace_id &&
    seller_id == other.seller_id &&
    id_type == other.id_type &&
    id_value == other.id_value &&
    is_amazon_fulfilled == other.is_amazon_fulfilled &&
    price_to_estimate_fees == other.price_to_estimate_fees &&
    seller_input_identifier == other.seller_input_identifier &&
    optional_fulfillment_program == other.optional_fulfillment_program
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 168

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    AmznSpApi::ProductFeesApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 237

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 146

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if 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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


126
127
128
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 126

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



132
133
134
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 132

def hash
  [marketplace_id, seller_id, id_type, id_value, is_amazon_fulfilled, price_to_estimate_fees, seller_input_identifier, optional_fulfillment_program].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 98

def list_invalid_properties
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



213
214
215
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 213

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



207
208
209
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 207

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



104
105
106
# File 'lib/product_fees_api_model/models/fees_estimate_identifier.rb', line 104

def valid?
  true
end