Class: Printful::Product

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

Overview

Information about the Product that the Variant belongs to

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Product

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/printful_client/models/product.rb', line 130

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

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

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

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

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

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

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

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

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  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?(:'is_discontinued')
    self.is_discontinued = attributes[:'is_discontinued']
  end

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

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

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

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

Instance Attribute Details

#avg_fulfillment_time ⇒ Object

Average number of days for order to be fulfilled



59
60
61
 
# File 'lib/printful_client/models/product.rb', line 59

def avg_fulfillment_time
  @avg_fulfillment_time
end

#brand ⇒ Object

Brand name



35
36
37
 
# File 'lib/printful_client/models/product.rb', line 35

def brand
  @brand
end

#currency ⇒ Object

Currency in which prices are returned



47
48
49
 
# File 'lib/printful_client/models/product.rb', line 47

def currency
  @currency
end

#description ⇒ Object

Product description



62
63
64
 
# File 'lib/printful_client/models/product.rb', line 62

def description
  @description
end

#files ⇒ Object

Definitions of Print/Mockup file categories that can be attached to this product



50
51
52
 
# File 'lib/printful_client/models/product.rb', line 50

def files
  @files
end

#id ⇒ Object

Product ID



20
21
22
 
# File 'lib/printful_client/models/product.rb', line 20

def id
  @id
end

#image ⇒ Object

URL of a sample image for this product



41
42
43
 
# File 'lib/printful_client/models/product.rb', line 41

def image
  @image
end

#is_discontinued ⇒ Object

If product is disabled in push



56
57
58
 
# File 'lib/printful_client/models/product.rb', line 56

def is_discontinued
  @is_discontinued
end

#main_category_id ⇒ Object

Main category of product



23
24
25
 
# File 'lib/printful_client/models/product.rb', line 23

def main_category_id
  @main_category_id
end

#model ⇒ Object

Model name



38
39
40
 
# File 'lib/printful_client/models/product.rb', line 38

def model
  @model
end

#options ⇒ Object

Definitions of additional options that are available for this product [See examples](#section/Options)



53
54
55
 
# File 'lib/printful_client/models/product.rb', line 53

def options
  @options
end

#origin_country ⇒ Object

The origin country for inside label



68
69
70
 
# File 'lib/printful_client/models/product.rb', line 68

def origin_country
  @origin_country
end

#techniques ⇒ Object

Available techniques



65
66
67
 
# File 'lib/printful_client/models/product.rb', line 65

def techniques
  @techniques
end

#title ⇒ Object

Product title



32
33
34
 
# File 'lib/printful_client/models/product.rb', line 32

def title
  @title
end

#type ⇒ Object

Product type identifier



26
27
28
 
# File 'lib/printful_client/models/product.rb', line 26

def type
  @type
end

#type_name ⇒ Object

Product type name



29
30
31
 
# File 'lib/printful_client/models/product.rb', line 29

def type_name
  @type_name
end

#variant_count ⇒ Object

Number of available variants for this product



44
45
46
 
# File 'lib/printful_client/models/product.rb', line 44

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/printful_client/models/product.rb', line 296

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



94
95
96
 
# File 'lib/printful_client/models/product.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/printful_client/models/product.rb', line 71

def self.attribute_map
  {
    :'id' => :'id',
    :'main_category_id' => :'main_category_id',
    :'type' => :'type',
    :'type_name' => :'type_name',
    :'title' => :'title',
    :'brand' => :'brand',
    :'model' => :'model',
    :'image' => :'image',
    :'variant_count' => :'variant_count',
    :'currency' => :'currency',
    :'files' => :'files',
    :'options' => :'options',
    :'is_discontinued' => :'is_discontinued',
    :'avg_fulfillment_time' => :'avg_fulfillment_time',
    :'description' => :'description',
    :'techniques' => :'techniques',
    :'origin_country' => :'origin_country'
  }
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/printful_client/models/product.rb', line 272

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



122
123
124
125
126
 
# File 'lib/printful_client/models/product.rb', line 122

def self.openapi_nullable
  Set.new([
    :'origin_country'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/printful_client/models/product.rb', line 99

def self.openapi_types
  {
    :'id' => :'Integer',
    :'main_category_id' => :'Integer',
    :'type' => :'String',
    :'type_name' => :'String',
    :'title' => :'String',
    :'brand' => :'String',
    :'model' => :'String',
    :'image' => :'String',
    :'variant_count' => :'Integer',
    :'currency' => :'String',
    :'files' => :'Array<FileType>',
    :'options' => :'Array<OptionType>',
    :'is_discontinued' => :'Boolean',
    :'avg_fulfillment_time' => :'Float',
    :'description' => :'String',
    :'techniques' => :'Array<AvailableTechnique>',
    :'origin_country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/printful_client/models/product.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      main_category_id == o.main_category_id &&
      type == o.type &&
      type_name == o.type_name &&
      title == o.title &&
      brand == o.brand &&
      model == o.model &&
      image == o.image &&
      variant_count == o.variant_count &&
      currency == o.currency &&
      files == o.files &&
      options == o.options &&
      is_discontinued == o.is_discontinued &&
      avg_fulfillment_time == o.avg_fulfillment_time &&
      description == o.description &&
      techniques == o.techniques &&
      origin_country == o.origin_country
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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/printful_client/models/product.rb', line 367

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


259
260
261
 
# File 'lib/printful_client/models/product.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/printful_client/models/product.rb', line 265

def hash
  [id, main_category_id, type, type_name, title, brand, model, image, variant_count, currency, files, options, is_discontinued, avg_fulfillment_time, description, techniques, origin_country].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



220
221
222
223
224
 
# File 'lib/printful_client/models/product.rb', line 220

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



343
344
345
 
# File 'lib/printful_client/models/product.rb', line 343

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



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

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



337
338
339
 
# File 'lib/printful_client/models/product.rb', line 337

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



228
229
230
231
 
# File 'lib/printful_client/models/product.rb', line 228

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