Class: Printful::Order

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

Overview

Information about the Order

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

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
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/printful_client/models/order.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#branding_itemsObject

Array of branding items in the order



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

def branding_items
  @branding_items
end

#costsObject

Returns the value of attribute costs.



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

def costs
  @costs
end

#createdObject

Time when the order was created



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

def created
  @created
end

#external_idObject

Order ID from the external system



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

def external_id
  @external_id
end

#giftObject

Returns the value of attribute gift.



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

def gift
  @gift
end

#idObject

Order ID



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

def id
  @id
end

#incomplete_itemsObject

Array of incomplete items in the order



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

def incomplete_items
  @incomplete_items
end

#itemsObject

Array of items in the order



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

def items
  @items
end

#packing_slipObject

Returns the value of attribute packing_slip.



66
67
68
# File 'lib/printful_client/models/order.rb', line 66

def packing_slip
  @packing_slip
end

#pricing_breakdownObject

Difference between order price and retail costs. Will be shown only if order is completed.



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

def pricing_breakdown
  @pricing_breakdown
end

#recipientObject

Returns the value of attribute recipient.



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

def recipient
  @recipient
end

#retail_costsObject

Returns the value of attribute retail_costs.



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

def retail_costs
  @retail_costs
end

#shipmentsObject

Array of shipments already shipped for this order



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

def shipments
  @shipments
end

#shippingObject

Shipping method. Defaults to ‘STANDARD’



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

def shipping
  @shipping
end

#shipping_service_nameObject

Human readable shipping method name.



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

def shipping_service_name
  @shipping_service_name
end

#statusObject

Order status:<br /> draft - order is not submitted for fulfillment<br /> failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)<br /> pending - order has been submitted for fulfillment<br /> canceled - order is canceled<br /> onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service inprocess - order is being fulfilled and is no longer cancellable<br /> partial - order is partially fulfilled (some items are shipped already, the rest will follow)<br /> fulfilled - all items are shipped<br />



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

def status
  @status
end

#storeObject

Store ID



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

def store
  @store
end

#updatedObject

Time when the order was updated



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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/printful_client/models/order.rb', line 319

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_attributesObject

Returns all the JSON keys this model knows about



93
94
95
# File 'lib/printful_client/models/order.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'external_id' => :'external_id',
    :'store' => :'store',
    :'status' => :'status',
    :'shipping' => :'shipping',
    :'shipping_service_name' => :'shipping_service_name',
    :'created' => :'created',
    :'updated' => :'updated',
    :'recipient' => :'recipient',
    :'items' => :'items',
    :'branding_items' => :'branding_items',
    :'incomplete_items' => :'incomplete_items',
    :'costs' => :'costs',
    :'retail_costs' => :'retail_costs',
    :'pricing_breakdown' => :'pricing_breakdown',
    :'shipments' => :'shipments',
    :'gift' => :'gift',
    :'packing_slip' => :'packing_slip'
  }
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/printful_client/models/order.rb', line 295

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_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

Attribute type mapping.



98
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/order.rb', line 98

def self.openapi_types
  {
    :'id' => :'Integer',
    :'external_id' => :'String',
    :'store' => :'Integer',
    :'status' => :'String',
    :'shipping' => :'String',
    :'shipping_service_name' => :'String',
    :'created' => :'Integer',
    :'updated' => :'Integer',
    :'recipient' => :'Address',
    :'items' => :'Array<Item>',
    :'branding_items' => :'Array<Item>',
    :'incomplete_items' => :'Array<IncompleteItem>',
    :'costs' => :'OrderCosts',
    :'retail_costs' => :'RetailCosts',
    :'pricing_breakdown' => :'Array<PricingBreakdown>',
    :'shipments' => :'Array<Shipment>',
    :'gift' => :'Gift',
    :'packing_slip' => :'PackingSlip'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/printful_client/models/order.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      external_id == o.external_id &&
      store == o.store &&
      status == o.status &&
      shipping == o.shipping &&
      shipping_service_name == o.shipping_service_name &&
      created == o.created &&
      updated == o.updated &&
      recipient == o.recipient &&
      items == o.items &&
      branding_items == o.branding_items &&
      incomplete_items == o.incomplete_items &&
      costs == o.costs &&
      retail_costs == o.retail_costs &&
      pricing_breakdown == o.pricing_breakdown &&
      shipments == o.shipments &&
      gift == o.gift &&
      packing_slip == o.packing_slip
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



390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/printful_client/models/order.rb', line 390

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


282
283
284
# File 'lib/printful_client/models/order.rb', line 282

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



288
289
290
# File 'lib/printful_client/models/order.rb', line 288

def hash
  [id, external_id, store, status, shipping, shipping_service_name, created, updated, recipient, items, branding_items, incomplete_items, costs, retail_costs, pricing_breakdown, shipments, gift, packing_slip].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/printful_client/models/order.rb', line 232

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @recipient.nil?
    invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
  end

  if @items.nil?
    invalid_properties.push('invalid value for "items", items cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



366
367
368
# File 'lib/printful_client/models/order.rb', line 366

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



360
361
362
# File 'lib/printful_client/models/order.rb', line 360

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



248
249
250
251
252
253
# File 'lib/printful_client/models/order.rb', line 248

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @recipient.nil?
  return false if @items.nil?
  true
end