Class: AmzSpApi::FinancesApiModel::TrialShipmentEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/finances-api-model/models/trial_shipment_event.rb

Overview

An event related to a trial shipment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrialShipmentEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
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
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 60

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FinancesApiModel::TrialShipmentEvent` 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 `AmzSpApi::FinancesApiModel::TrialShipmentEvent`. 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?(:'amazon_order_id')
    self.amazon_order_id = attributes[:'amazon_order_id']
  end

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

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

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

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

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



18
19
20
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 18

def amazon_order_id
  @amazon_order_id
end

#fee_list ⇒ Object

Returns the value of attribute fee_list.



28
29
30
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 28

def fee_list
  @fee_list
end

#financial_event_group_id ⇒ Object

The identifier of the financial event group.



21
22
23
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 21

def financial_event_group_id
  @financial_event_group_id
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



23
24
25
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 23

def posted_date
  @posted_date
end

#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.



26
27
28
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 26

def sku
  @sku
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 31

def self.attribute_map
  {
    :'amazon_order_id' => :'AmazonOrderId',
    :'financial_event_group_id' => :'FinancialEventGroupId',
    :'posted_date' => :'PostedDate',
    :'sku' => :'SKU',
    :'fee_list' => :'FeeList'
  }
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



134
135
136
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 134

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
56
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 42

def self.openapi_types
  {
    :'amazon_order_id' => :'Object',
    :'financial_event_group_id' => :'Object',
    :'posted_date' => :'Object',
    :'sku' => :'Object',
    :'fee_list' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 109

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amazon_order_id == o.amazon_order_id &&
      financial_event_group_id == o.financial_event_group_id &&
      posted_date == o.posted_date &&
      sku == o.sku &&
      fee_list == o.fee_list
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



164
165
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
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 164

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
    AmzSpApi::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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 233

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 141

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
      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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 127

def hash
  [amazon_order_id, financial_event_group_id, posted_date, sku, fee_list].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



96
97
98
99
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 96

def list_invalid_properties
  invalid_properties = Array.new
  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



209
210
211
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 209

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 215

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



203
204
205
 
# File 'lib/finances-api-model/models/trial_shipment_event.rb', line 203

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/trial_shipment_event.rb', line 103

def valid?
  true
end