Class: AmznSpApi::ServicesApiModel::AssociatedItem

Inherits:
Object
  • Object
show all
Defined in:
lib/services_api_model/models/associated_item.rb

Overview

Information about an item associated with the service job.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssociatedItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/services_api_model/models/associated_item.rb', line 86

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

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

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

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

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

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

  return unless attributes.key?(:item_delivery)

  self.item_delivery = attributes[:item_delivery]
end

Instance Attribute Details

#asin ⇒ Object

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



16
17
18
 
# File 'lib/services_api_model/models/associated_item.rb', line 16

def asin
  @asin
end

#brand_name ⇒ Object

The brand name of the item.



30
31
32
 
# File 'lib/services_api_model/models/associated_item.rb', line 30

def brand_name
  @brand_name
end

#item_delivery ⇒ Object

Returns the value of attribute item_delivery.



24
25
26
 
# File 'lib/services_api_model/models/associated_item.rb', line 24

def item_delivery
  @item_delivery
end

#item_status ⇒ Object

The status of the item.



27
28
29
 
# File 'lib/services_api_model/models/associated_item.rb', line 27

def item_status
  @item_status
end

#order_id ⇒ Object

Returns the value of attribute order_id.



24
25
26
 
# File 'lib/services_api_model/models/associated_item.rb', line 24

def order_id
  @order_id
end

#quantity ⇒ Object

The total number of items included in the order.



22
23
24
 
# File 'lib/services_api_model/models/associated_item.rb', line 22

def quantity
  @quantity
end

#title ⇒ Object

The title of the item.



19
20
21
 
# File 'lib/services_api_model/models/associated_item.rb', line 19

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/services_api_model/models/associated_item.rb', line 54

def self.attribute_map
  {
    'asin': :asin,
    'title': :title,
    'quantity': :quantity,
    'order_id': :orderId,
    'item_status': :itemStatus,
    'brand_name': :brandName,
    'item_delivery': :itemDelivery
  }
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



167
168
169
 
# File 'lib/services_api_model/models/associated_item.rb', line 167

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
 
# File 'lib/services_api_model/models/associated_item.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/services_api_model/models/associated_item.rb', line 67

def self.openapi_types
  {
    'asin': :Object,
    'title': :Object,
    'quantity': :Object,
    'order_id': :Object,
    'item_status': :Object,
    'brand_name': :Object,
    'item_delivery': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/services_api_model/models/associated_item.rb', line 139

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

  self.class == other.class &&
    asin == other.asin &&
    title == other.title &&
    quantity == other.quantity &&
    order_id == other.order_id &&
    item_status == other.item_status &&
    brand_name == other.brand_name &&
    item_delivery == other.item_delivery
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/services_api_model/models/associated_item.rb', line 196

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/services_api_model/models/associated_item.rb', line 265

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/services_api_model/models/associated_item.rb', line 174

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


154
155
156
 
# File 'lib/services_api_model/models/associated_item.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/services_api_model/models/associated_item.rb', line 160

def hash
  [asin, title, quantity, order_id, item_status, brand_name, item_delivery].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



115
116
117
 
# File 'lib/services_api_model/models/associated_item.rb', line 115

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



241
242
243
 
# File 'lib/services_api_model/models/associated_item.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/services_api_model/models/associated_item.rb', line 247

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



235
236
237
 
# File 'lib/services_api_model/models/associated_item.rb', line 235

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



121
122
123
124
125
126
 
# File 'lib/services_api_model/models/associated_item.rb', line 121

def valid?
  item_status_validator = EnumAttributeValidator.new('Object', %w[ACTIVE CANCELLED SHIPPED DELIVERED])
  return false unless item_status_validator.valid?(@item_status)

  true
end