Class: AmznSpApi::FinancesApiModel::ServiceFeeEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/finances_api_model/models/service_fee_event.rb

Overview

A service fee on the seller’s account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceFeeEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 68

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FinancesApiModel::ServiceFeeEvent` 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::FinancesApiModel::ServiceFeeEvent`. 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.amazon_order_id = attributes[:amazon_order_id] if attributes.key?(:amazon_order_id)

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

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

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

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

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

  return unless attributes.key?(:asin)

  self.asin = attributes[:asin]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



16
17
18
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 16

def amazon_order_id
  @amazon_order_id
end

#asin ⇒ Object

The Amazon Standard Identification Number (ASIN) of the item.



33
34
35
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 33

def asin
  @asin
end

#fee_description ⇒ Object

A short description of the service fee event.



30
31
32
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 30

def fee_description
  @fee_description
end

#fee_list ⇒ Object

Returns the value of attribute fee_list.



21
22
23
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 21

def fee_list
  @fee_list
end

#fee_reason ⇒ Object

A short description of the service fee reason.



19
20
21
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 19

def fee_reason
  @fee_reason
end

#fn_sku ⇒ Object

A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.



27
28
29
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 27

def fn_sku
  @fn_sku
end

#seller_sku ⇒ Object

The seller SKU of the item. The seller SKU is qualified by the seller’s seller ID, which is included with every call to the Selling Partner API.



24
25
26
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 24

def seller_sku
  @seller_sku
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 36

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'fee_reason': :FeeReason,
    'fee_list': :FeeList,
    'seller_sku': :SellerSKU,
    'fn_sku': :FnSKU,
    'fee_description': :FeeDescription,
    'asin': :ASIN
  }
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



137
138
139
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 137

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 49

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'fee_reason': :Object,
    'fee_list': :Object,
    'seller_sku': :Object,
    'fn_sku': :Object,
    'fee_description': :Object,
    'asin': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 109

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    fee_reason == other.fee_reason &&
    fee_list == other.fee_list &&
    seller_sku == other.seller_sku &&
    fn_sku == other.fn_sku &&
    fee_description == other.fee_description &&
    asin == other.asin
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



166
167
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
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 166

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::FinancesApiModel.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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 235

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 144

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


124
125
126
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



130
131
132
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 130

def hash
  [amazon_order_id, fee_reason, fee_list, seller_sku, fn_sku, fee_description, asin].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



97
98
99
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 97

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 211

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 217

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



205
206
207
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 205

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



103
104
105
 
# File 'lib/finances_api_model/models/service_fee_event.rb', line 103

def valid?
  true
end