Class: OpenapiClient::PartialShipment

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/partial_shipment.rb

Overview

The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.

Direct Known Subclasses

Shipment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartialShipment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 151

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#advanced_options ⇒ Object

Advanced shipment options. These are entirely optional.



67
68
69
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 67

def advanced_options
  @advanced_options
end

#carrier_id ⇒ Object

The carrier account that is billed for the shipping charges



22
23
24
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 22

def carrier_id
  @carrier_id
end

#confirmation ⇒ Object

The type of delivery confirmation that is required for this shipment.



61
62
63
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 61

def confirmation
  @confirmation
end

#created_at ⇒ Object

The date and time that the shipment was created in ShipEngine.



40
41
42
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 40

def created_at
  @created_at
end

#customs ⇒ Object

Customs information. This is usually only needed for international shipments.



64
65
66
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 64

def customs
  @customs
end

#external_order_id ⇒ Object

ID that the Order Source assigned



28
29
30
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 28

def external_order_id
  @external_order_id
end

#external_shipment_id ⇒ Object

You can optionally use this field to store your own identifier for this shipment. > Warning: The ‘external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.



34
35
36
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 34

def external_shipment_id
  @external_shipment_id
end

#insurance_provider ⇒ Object

The insurance provider to use for any insured packages in the shipment.



70
71
72
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 70

def insurance_provider
  @insurance_provider
end

#items ⇒ Object

Describe the packages included in this shipment as related to potential metadata that was imported from external order sources



31
32
33
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 31

def items
  @items
end

#modified_at ⇒ Object

The date and time that the shipment was created or last modified.



43
44
45
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 43

def modified_at
  @modified_at
end

#order_source_code ⇒ Object

Returns the value of attribute order_source_code.



75
76
77
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 75

def order_source_code
  @order_source_code
end

#packages ⇒ Object

The packages in the shipment. > Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn’t allow it, an error will be returned.



78
79
80
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 78

def packages
  @packages
end

#return_to ⇒ Object

The return address for this shipment. Defaults to the ‘ship_from` address.



58
59
60
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 58

def return_to
  @return_to
end

#service_code ⇒ Object

The [carrier service](www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as ‘fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.



25
26
27
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 25

def service_code
  @service_code
end

#ship_date ⇒ Object

The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.



37
38
39
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 37

def ship_date
  @ship_date
end

#ship_from ⇒ Object

The shipment’s origin address. If you frequently ship from the same location, consider [creating a warehouse](www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the ‘warehouse_id` rather than the complete address each time.



52
53
54
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 52

def ship_from
  @ship_from
end

#ship_to ⇒ Object

The recipient’s mailing address



49
50
51
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 49

def ship_to
  @ship_to
end

#shipment_id ⇒ Object

A string that uniquely identifies the shipment



19
20
21
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 19

def shipment_id
  @shipment_id
end

#shipment_status ⇒ Object

The current status of the shipment



46
47
48
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 46

def shipment_status
  @shipment_status
end

#tags ⇒ Object

Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.



73
74
75
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 73

def tags
  @tags
end

#total_weight ⇒ Object

The combined weight of all packages in the shipment



81
82
83
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 81

def total_weight
  @total_weight
end

#warehouse_id ⇒ Object

The [warehouse](www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either ‘warehouse_id` or `ship_from` must be specified.



55
56
57
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 55

def warehouse_id
  @warehouse_id
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 84

def self.attribute_map
  {
    :'shipment_id' => :'shipment_id',
    :'carrier_id' => :'carrier_id',
    :'service_code' => :'service_code',
    :'external_order_id' => :'external_order_id',
    :'items' => :'items',
    :'external_shipment_id' => :'external_shipment_id',
    :'ship_date' => :'ship_date',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at',
    :'shipment_status' => :'shipment_status',
    :'ship_to' => :'ship_to',
    :'ship_from' => :'ship_from',
    :'warehouse_id' => :'warehouse_id',
    :'return_to' => :'return_to',
    :'confirmation' => :'confirmation',
    :'customs' => :'customs',
    :'advanced_options' => :'advanced_options',
    :'insurance_provider' => :'insurance_provider',
    :'tags' => :'tags',
    :'order_source_code' => :'order_source_code',
    :'packages' => :'packages',
    :'total_weight' => :'total_weight'
  }
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



331
332
333
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 331

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
144
145
146
147
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 140

def self.openapi_nullable
  Set.new([
    :'external_order_id',
    :'external_shipment_id',
    :'warehouse_id',
    :'customs',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 112

def self.openapi_types
  {
    :'shipment_id' => :'String',
    :'carrier_id' => :'String',
    :'service_code' => :'String',
    :'external_order_id' => :'String',
    :'items' => :'Array<ShipmentItem>',
    :'external_shipment_id' => :'String',
    :'ship_date' => :'DateTime',
    :'created_at' => :'DateTime',
    :'modified_at' => :'DateTime',
    :'shipment_status' => :'ShipmentStatus',
    :'ship_to' => :'Address',
    :'ship_from' => :'Address',
    :'warehouse_id' => :'String',
    :'return_to' => :'Address',
    :'confirmation' => :'DeliveryConfirmation',
    :'customs' => :'InternationalShipmentOptions',
    :'advanced_options' => :'AdvancedShipmentOptions',
    :'insurance_provider' => :'InsuranceProvider',
    :'tags' => :'Array<Tag>',
    :'order_source_code' => :'OrderSourceName',
    :'packages' => :'Array<Package>',
    :'total_weight' => :'Weight'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipment_id == o.shipment_id &&
      carrier_id == o.carrier_id &&
      service_code == o.service_code &&
      external_order_id == o.external_order_id &&
      items == o.items &&
      external_shipment_id == o.external_shipment_id &&
      ship_date == o.ship_date &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      shipment_status == o.shipment_status &&
      ship_to == o.ship_to &&
      ship_from == o.ship_from &&
      warehouse_id == o.warehouse_id &&
      return_to == o.return_to &&
      confirmation == o.confirmation &&
      customs == o.customs &&
      advanced_options == o.advanced_options &&
      insurance_provider == o.insurance_provider &&
      tags == o.tags &&
      order_source_code == o.order_source_code &&
      packages == o.packages &&
      total_weight == o.total_weight
end

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 359

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    OpenapiClient.const_get(type).build_from_hash(value)
  end
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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 428

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

#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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 338

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 324

def hash
  [shipment_id, carrier_id, service_code, external_order_id, items, external_shipment_id, ship_date, created_at, modified_at, shipment_status, ship_to, ship_from, warehouse_id, return_to, confirmation, customs, advanced_options, insurance_provider, tags, order_source_code, packages, total_weight].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



261
262
263
264
265
266
267
268
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 261

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_shipment_id.nil? && @external_shipment_id.to_s.length > 50
    invalid_properties.push('invalid value for "external_shipment_id", the character length must be smaller than or equal to 50.')
  end

  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



404
405
406
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 404

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 410

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



398
399
400
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 398

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



272
273
274
275
 
# File 'lib/openapi_client/models/partial_shipment.rb', line 272

def valid?
  return false if !@external_shipment_id.nil? && @external_shipment_id.to_s.length > 50
  true
end