Class: VoucherifySdk::ProductsSkusCreateRequestBody

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/products_skus_create_request_body.rb

Overview

Request body schema for POST ‘/products/productId/skus

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductsSkusCreateRequestBody

Initializes the object



84
85
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.



35
36
37
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 35

def attributes
  @attributes
end

#currency ⇒ Object

SKU price currency.



32
33
34
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 32

def currency
  @currency
end

#id ⇒ Object

Unique SKU ID.



20
21
22
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 20

def id
  @id
end

#image_url ⇒ Object

The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.



38
39
40
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 38

def image_url
  @image_url
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.



41
42
43
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 41

def metadata
  @metadata
end

#price ⇒ Object

SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example ‘10000 cents` for `$100.00`.



29
30
31
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 29

def price
  @price
end

#sku ⇒ Object

Unique user-defined SKU name.



26
27
28
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 26

def sku
  @sku
end

#source_id ⇒ Object

A unique SKU identifier from your inventory system.



23
24
25
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 23

def source_id
  @source_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
232
233
234
235
236
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 199

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'sku' => :'sku',
    :'price' => :'price',
    :'currency' => :'currency',
    :'attributes' => :'attributes',
    :'image_url' => :'image_url',
    :'metadata' => :'metadata'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 175

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 63

def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'sku' => :'String',
    :'price' => :'Integer',
    :'currency' => :'String',
    :'attributes' => :'Object',
    :'image_url' => :'String',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      source_id == o.source_id &&
      sku == o.sku &&
      price == o.price &&
      currency == o.currency &&
      attributes == o.attributes &&
      image_url == o.image_url &&
      metadata == o.metadata
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 270

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


162
163
164
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



168
169
170
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 168

def hash
  [id, source_id, sku, price, currency, attributes, image_url, metadata].hash
end

#list_invalid_properties ⇒ Object

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



132
133
134
135
136
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



246
247
248
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 246

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 252

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



240
241
242
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 240

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



140
141
142
143
 
# File 'lib/VoucherifySdk/models/products_skus_create_request_body.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end