Class: Printful::Variant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Variant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
 
# File 'lib/printful_client/models/variant.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_regions ⇒ Object

Map of [region code, region name] of regions where the variant is available for fulfillment



49
50
51
 
# File 'lib/printful_client/models/variant.rb', line 49

def availability_regions
  @availability_regions
end

#availability_status ⇒ Object

Detailed stock status per region



52
53
54
 
# File 'lib/printful_client/models/variant.rb', line 52

def availability_status
  @availability_status
end

#color ⇒ Object

Item color



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

def color
  @color
end

#color_code ⇒ Object

Hexadecimal RGB color code. May not exactly reflect the real-world color



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

def color_code
  @color_code
end

#color_code2 ⇒ Object

Secondary hexadecimal RGB color code. May not exactly reflect the real-world color



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

def color_code2
  @color_code2
end

#id ⇒ Object

Variant ID, use this to specify the product when creating orders



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

def id
  @id
end

#image ⇒ Object

URL of a preview image for this variant



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

def image
  @image
end

#in_stock ⇒ Object

Stock availability of this variant



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

def in_stock
  @in_stock
end

#material ⇒ Object

A list of materials this Variant is composed of



55
56
57
 
# File 'lib/printful_client/models/variant.rb', line 55

def material
  @material
end

#name ⇒ Object

Display name



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

def name
  @name
end

#price ⇒ Object

Variant’s price (can change depending on print files and optional settings)



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

def price
  @price
end

#product_id ⇒ Object

ID of the product that this variant belongs to



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

def product_id
  @product_id
end

#size ⇒ Object

Item size



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

def size
  @size
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/printful_client/models/variant.rb', line 254

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



77
78
79
 
# File 'lib/printful_client/models/variant.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/printful_client/models/variant.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'product_id' => :'product_id',
    :'name' => :'name',
    :'size' => :'size',
    :'color' => :'color',
    :'color_code' => :'color_code',
    :'color_code2' => :'color_code2',
    :'image' => :'image',
    :'price' => :'price',
    :'in_stock' => :'in_stock',
    :'availability_regions' => :'availability_regions',
    :'availability_status' => :'availability_status',
    :'material' => :'material'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/printful_client/models/variant.rb', line 230

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



101
102
103
104
 
# File 'lib/printful_client/models/variant.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/printful_client/models/variant.rb', line 82

def self.openapi_types
  {
    :'id' => :'Integer',
    :'product_id' => :'Integer',
    :'name' => :'String',
    :'size' => :'String',
    :'color' => :'String',
    :'color_code' => :'String',
    :'color_code2' => :'String',
    :'image' => :'String',
    :'price' => :'String',
    :'in_stock' => :'Boolean',
    :'availability_regions' => :'Hash<String, Object>',
    :'availability_status' => :'Array<AvailabilityStatus>',
    :'material' => :'Array<Material>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/printful_client/models/variant.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      product_id == o.product_id &&
      name == o.name &&
      size == o.size &&
      color == o.color &&
      color_code == o.color_code &&
      color_code2 == o.color_code2 &&
      image == o.image &&
      price == o.price &&
      in_stock == o.in_stock &&
      availability_regions == o.availability_regions &&
      availability_status == o.availability_status &&
      material == o.material
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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/printful_client/models/variant.rb', line 325

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


217
218
219
 
# File 'lib/printful_client/models/variant.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/printful_client/models/variant.rb', line 223

def hash
  [id, product_id, name, size, color, color_code, color_code2, image, price, in_stock, availability_regions, availability_status, material].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



182
183
184
185
186
 
# File 'lib/printful_client/models/variant.rb', line 182

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



301
302
303
 
# File 'lib/printful_client/models/variant.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/printful_client/models/variant.rb', line 307

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



295
296
297
 
# File 'lib/printful_client/models/variant.rb', line 295

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



190
191
192
193
 
# File 'lib/printful_client/models/variant.rb', line 190

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