Class: Printful::Item

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

Overview

Information about an item in the order

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
217
218
219
220
221
 
# File 'lib/printful_client/models/item.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#discontinued ⇒ Object

Whether the item belongs to discontinued product i.e. it’s permanently unavailable



67
68
69
 
# File 'lib/printful_client/models/item.rb', line 67

def discontinued
  @discontinued
end

#external_id ⇒ Object

Line item ID from the external system



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

def external_id
  @external_id
end

#external_product_id ⇒ Object

The External Product ID associated with a Product Template to generate the printfiles from. The ‘variant_id` field must be passed as well. Can’t be combined with following fields: ‘sync_variant_id`, `external_variant_id`, `warehouse_product_variant_id`, `files`, `options`, `product_template_id`. [Examples](#section/Orders-API-examples/Using-a-product-template).



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

def external_product_id
  @external_product_id
end

#external_variant_id ⇒ Object

External variant ID of the item ordered. [Example](#section/Orders-API-examples/Using-sync-variant-with-external-ID).



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

def external_variant_id
  @external_variant_id
end

#files ⇒ Object

Array of attached printfiles / preview images



58
59
60
 
# File 'lib/printful_client/models/item.rb', line 58

def files
  @files
end

#id ⇒ Object

Line item ID



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

def id
  @id
end

#name ⇒ Object

Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip



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

def name
  @name
end

#options ⇒ Object

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



61
62
63
 
# File 'lib/printful_client/models/item.rb', line 61

def options
  @options
end

#out_of_stock ⇒ Object

Whether the item is out of stock i.e. temporarily unavailable



70
71
72
 
# File 'lib/printful_client/models/item.rb', line 70

def out_of_stock
  @out_of_stock
end

#price ⇒ Object

Printful price of the item



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

def price
  @price
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#product_template_id ⇒ Object

The ID of a Product Template to generate the printfiles from. The ‘variant_id` field must be passed as well. Can’t be combined with following fields: ‘sync_variant_id`, `external_variant_id`, `warehouse_product_variant_id`, `files`, `options`, `external_product_id`. [Examples](#section/Orders-API-examples/Using-a-product-template).



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

def product_template_id
  @product_template_id
end

#quantity ⇒ Object

Number of items ordered (Limited to 1000 for one item)



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

def quantity
  @quantity
end

#retail_price ⇒ Object

Original retail price of the item to be displayed on the packing slip



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

def retail_price
  @retail_price
end

#sku ⇒ Object

Product identifier (SKU) from the external system



64
65
66
 
# File 'lib/printful_client/models/item.rb', line 64

def sku
  @sku
end

#sync_variant_id ⇒ Object

Sync variant ID of the item ordered. [Example](#section/Orders-API-examples/Using-a-sync-variant).



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

def sync_variant_id
  @sync_variant_id
end

#variant_id ⇒ Object

Variant ID of the item ordered. See [Catalog API](#tag/Catalog-API)



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

def variant_id
  @variant_id
end

#warehouse_product_variant_id ⇒ Object

Warehousing product variant ID of the item ordered. See Warehouse Products API



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

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



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
334
335
336
337
338
339
 
# File 'lib/printful_client/models/item.rb', line 302

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



97
98
99
 
# File 'lib/printful_client/models/item.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'external_id' => :'external_id',
    :'variant_id' => :'variant_id',
    :'sync_variant_id' => :'sync_variant_id',
    :'external_variant_id' => :'external_variant_id',
    :'warehouse_product_variant_id' => :'warehouse_product_variant_id',
    :'product_template_id' => :'product_template_id',
    :'external_product_id' => :'external_product_id',
    :'quantity' => :'quantity',
    :'price' => :'price',
    :'retail_price' => :'retail_price',
    :'name' => :'name',
    :'product' => :'product',
    :'files' => :'files',
    :'options' => :'options',
    :'sku' => :'sku',
    :'discontinued' => :'discontinued',
    :'out_of_stock' => :'out_of_stock'
  }
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/printful_client/models/item.rb', line 278

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



126
127
128
129
 
# File 'lib/printful_client/models/item.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/printful_client/models/item.rb', line 102

def self.openapi_types
  {
    :'id' => :'Integer',
    :'external_id' => :'String',
    :'variant_id' => :'Integer',
    :'sync_variant_id' => :'Integer',
    :'external_variant_id' => :'String',
    :'warehouse_product_variant_id' => :'Integer',
    :'product_template_id' => :'Integer',
    :'external_product_id' => :'String',
    :'quantity' => :'Integer',
    :'price' => :'String',
    :'retail_price' => :'String',
    :'name' => :'String',
    :'product' => :'ProductVariant',
    :'files' => :'Array<ItemFilesInner>',
    :'options' => :'Array<Option>',
    :'sku' => :'String',
    :'discontinued' => :'Boolean',
    :'out_of_stock' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/printful_client/models/item.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      external_id == o.external_id &&
      variant_id == o.variant_id &&
      sync_variant_id == o.sync_variant_id &&
      external_variant_id == o.external_variant_id &&
      warehouse_product_variant_id == o.warehouse_product_variant_id &&
      product_template_id == o.product_template_id &&
      external_product_id == o.external_product_id &&
      quantity == o.quantity &&
      price == o.price &&
      retail_price == o.retail_price &&
      name == o.name &&
      product == o.product &&
      files == o.files &&
      options == o.options &&
      sku == o.sku &&
      discontinued == o.discontinued &&
      out_of_stock == o.out_of_stock
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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/printful_client/models/item.rb', line 373

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/printful_client/models/item.rb', line 271

def hash
  [id, external_id, variant_id, sync_variant_id, external_variant_id, warehouse_product_variant_id, product_template_id, external_product_id, quantity, price, retail_price, name, product, files, options, sku, discontinued, out_of_stock].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



225
226
227
228
229
 
# File 'lib/printful_client/models/item.rb', line 225

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



349
350
351
 
# File 'lib/printful_client/models/item.rb', line 349

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/printful_client/models/item.rb', line 355

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



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

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



233
234
235
236
 
# File 'lib/printful_client/models/item.rb', line 233

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