Class: Printful::UpdateSyncVariantRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/printful_client/models/update_sync_variant_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSyncVariantRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
200
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 124

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  end

  if attributes.key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end

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

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

Instance Attribute Details

#currency ⇒ Object

Currency in which prices are returned



40
41
42
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 40

def currency
  @currency
end

#external_id ⇒ Object

Variant ID from the Ecommerce platform



22
23
24
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 22

def external_id
  @external_id
end

#files ⇒ Object

Array of attached printfiles / preview images



51
52
53
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 51

def files
  @files
end

#id ⇒ Object

Sync Variant ID. Please specify the IDs of all Sync Variants you wish to keep.



19
20
21
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 19

def id
  @id
end

#is_ignored ⇒ Object

Indicates if this Sync Variant is ignored



43
44
45
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 43

def is_ignored
  @is_ignored
end

#main_category_id ⇒ Object

Printful Variant catalog category ID



57
58
59
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 57

def main_category_id
  @main_category_id
end

#name ⇒ Object

Sync Variant name



28
29
30
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 28

def name
  @name
end

#options ⇒ Object

Array of additional options for the configured product/variant [See examples](#section/Options)



54
55
56
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 54

def options
  @options
end

#product ⇒ Object

Returns the value of attribute product.



48
49
50
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 48

def product
  @product
end

#retail_price ⇒ Object

Retail price that this item is sold for



37
38
39
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 37

def retail_price
  @retail_price
end

#sku ⇒ Object

SKU of this Sync Variant



46
47
48
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 46

def sku
  @sku
end

#sync_product_id ⇒ Object

Sync Product ID that this variant belongs to



25
26
27
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 25

def sync_product_id
  @sync_product_id
end

#synced ⇒ Object

Indicates if this Sync Variant is properly linked with Printful product



31
32
33
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 31

def synced
  @synced
end

#variant_id ⇒ Object

Printful Variant ID that this Sync Variant is synced to



34
35
36
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 34

def variant_id
  @variant_id
end

#warehouse_product_variant_id ⇒ Object

Warehousing variant ID. If sync variant is connected with a warehousing item, this is its ID



60
61
62
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 60

def warehouse_product_variant_id
  @warehouse_product_variant_id
end

Class Method Details

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 278

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 = Printful.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



84
85
86
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'external_id' => :'external_id',
    :'sync_product_id' => :'sync_product_id',
    :'name' => :'name',
    :'synced' => :'synced',
    :'variant_id' => :'variant_id',
    :'retail_price' => :'retail_price',
    :'currency' => :'currency',
    :'is_ignored' => :'is_ignored',
    :'sku' => :'sku',
    :'product' => :'product',
    :'files' => :'files',
    :'options' => :'options',
    :'main_category_id' => :'main_category_id',
    :'warehouse_product_variant_id' => :'warehouse_product_variant_id'
  }
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 254

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



116
117
118
119
120
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 116

def self.openapi_all_of
  [
  :'SyncVariant'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 110

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 89

def self.openapi_types
  {
    :'id' => :'Integer',
    :'external_id' => :'String',
    :'sync_product_id' => :'Integer',
    :'name' => :'String',
    :'synced' => :'Boolean',
    :'variant_id' => :'Integer',
    :'retail_price' => :'String',
    :'currency' => :'String',
    :'is_ignored' => :'Boolean',
    :'sku' => :'String',
    :'product' => :'SyncVariantProduct',
    :'files' => :'Array<File>',
    :'options' => :'Array<ItemOption>',
    :'main_category_id' => :'Integer',
    :'warehouse_product_variant_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      external_id == o.external_id &&
      sync_product_id == o.sync_product_id &&
      name == o.name &&
      synced == o.synced &&
      variant_id == o.variant_id &&
      retail_price == o.retail_price &&
      currency == o.currency &&
      is_ignored == o.is_ignored &&
      sku == o.sku &&
      product == o.product &&
      files == o.files &&
      options == o.options &&
      main_category_id == o.main_category_id &&
      warehouse_product_variant_id == o.warehouse_product_variant_id
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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 349

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 247

def hash
  [id, external_id, sync_product_id, name, synced, variant_id, retail_price, currency, is_ignored, sku, product, files, options, main_category_id, warehouse_product_variant_id].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



204
205
206
207
208
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 204

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



325
326
327
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 331

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



319
320
321
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 319

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



212
213
214
215
 
# File 'lib/printful_client/models/update_sync_variant_request.rb', line 212

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