Class: AmznSpApi::ListingsItemsApiModel::ListingsItemSubmissionResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/listings_items_api_model/models/listings_item_submission_response.rb

Overview

Response containing the results of a submission to the Selling Partner API for Listings Items.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListingsItemSubmissionResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 75

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

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

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

  return unless attributes.key?(:issues)
  return unless (value = attributes[:issues]).is_a?(Array)

  self.issues = value
end

Instance Attribute Details

#issues ⇒ Object

Listings item issues related to the listings item submission.



25
26
27
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 25

def issues
  @issues
end

#sku ⇒ Object

A selling partner provided identifier for an Amazon listing.



16
17
18
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 16

def sku
  @sku
end

#status ⇒ Object

The status of the listings item submission.



19
20
21
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 19

def status
  @status
end

#submission_id ⇒ Object

The unique identifier of the listings item submission.



22
23
24
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 22

def submission_id
  @submission_id
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 49

def self.attribute_map
  {
    'sku': :sku,
    'status': :status,
    'submission_id': :submissionId,
    'issues': :issues
  }
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



159
160
161
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 159

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 59

def self.openapi_types
  {
    'sku': :Object,
    'status': :Object,
    'submission_id': :Object,
    'issues': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 134

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

  self.class == other.class &&
    sku == other.sku &&
    status == other.status &&
    submission_id == other.submission_id &&
    issues == other.issues
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



188
189
190
191
192
193
194
195
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
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 188

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 257

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 166

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


146
147
148
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 152

def hash
  [sku, status, submission_id, issues].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



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 99

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "sku", sku cannot be nil.') if @sku.nil?

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

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

  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



233
234
235
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 233

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 239

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



227
228
229
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 227

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



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/listings_items_api_model/models/listings_item_submission_response.rb', line 112

def valid?
  return false if @sku.nil?
  return false if @status.nil?

  status_validator = EnumAttributeValidator.new('Object', %w[ACCEPTED INVALID])
  return false unless status_validator.valid?(@status)
  return false if @submission_id.nil?

  true
end