Class: AmznSpApi::SellersApiModel::Marketplace

Inherits:
Object
  • Object
show all
Defined in:
lib/sellers_api_model/models/marketplace.rb

Overview

Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Marketplace

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 64

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

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

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

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

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

  return unless attributes.key?(:domain_name)

  self.domain_name = attributes[:domain_name]
end

Instance Attribute Details

#country_code ⇒ Object

The ISO 3166-1 alpha-2 format country code of the marketplace.



22
23
24
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 22

def country_code
  @country_code
end

#default_currency_code ⇒ Object

The ISO 4217 format currency code of the marketplace.



25
26
27
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 25

def default_currency_code
  @default_currency_code
end

#default_language_code ⇒ Object

The ISO 639-1 format language code of the marketplace.



28
29
30
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 28

def default_language_code
  @default_language_code
end

#domain_name ⇒ Object

The domain name of the marketplace.



31
32
33
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 31

def domain_name
  @domain_name
end

#id ⇒ Object

The encrypted marketplace value.



16
17
18
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 16

def id
  @id
end

#name ⇒ Object

Marketplace name.



19
20
21
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 19

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 34

def self.attribute_map
  {
    'id': :id,
    'name': :name,
    'country_code': :countryCode,
    'default_currency_code': :defaultCurrencyCode,
    'default_language_code': :defaultLanguageCode,
    'domain_name': :domainName
  }
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



150
151
152
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 150

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



58
59
60
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 58

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 46

def self.openapi_types
  {
    'id': :Object,
    'name': :Object,
    'country_code': :Object,
    'default_currency_code': :Object,
    'default_language_code': :Object,
    'domain_name': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 123

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    country_code == other.country_code &&
    default_currency_code == other.default_currency_code &&
    default_language_code == other.default_language_code &&
    domain_name == other.domain_name
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



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
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 179

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 248

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 157

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


137
138
139
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



143
144
145
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 143

def hash
  [id, name, country_code, default_currency_code, default_language_code, domain_name].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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 91

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

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

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

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

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

  invalid_properties.push('invalid value for "domain_name", domain_name cannot be nil.') if @domain_name.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



224
225
226
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 224

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 230

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



218
219
220
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 218

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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/sellers_api_model/models/marketplace.rb', line 110

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @country_code.nil?
  return false if @default_currency_code.nil?
  return false if @default_language_code.nil?
  return false if @domain_name.nil?

  true
end