Class: UltracartClient::OrderShipping

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_shipping.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderShipping

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/ultracart_api/models/order_shipping.rb', line 175

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'address1')
    self.address1 = attributes[:'address1']
  end

  if attributes.has_key?(:'address2')
    self.address2 = attributes[:'address2']
  end

  if attributes.has_key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.has_key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.has_key?(:'country_code')
    self.country_code = attributes[:'country_code']
  end

  if attributes.has_key?(:'day_phone')
    self.day_phone = attributes[:'day_phone']
  end

  if attributes.has_key?(:'day_phone_e164')
    self.day_phone_e164 = attributes[:'day_phone_e164']
  end

  if attributes.has_key?(:'delivery_date')
    self.delivery_date = attributes[:'delivery_date']
  end

  if attributes.has_key?(:'evening_phone')
    self.evening_phone = attributes[:'evening_phone']
  end

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.has_key?(:'least_cost_route')
    self.least_cost_route = attributes[:'least_cost_route']
  end

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

  if attributes.has_key?(:'lift_gate')
    self.lift_gate = attributes[:'lift_gate']
  end

  if attributes.has_key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  end

  if attributes.has_key?(:'rma')
    self.rma = attributes[:'rma']
  end

  if attributes.has_key?(:'ship_on_date')
    self.ship_on_date = attributes[:'ship_on_date']
  end

  if attributes.has_key?(:'ship_to_residential')
    self.ship_to_residential = attributes[:'ship_to_residential']
  end

  if attributes.has_key?(:'shipping_3rd_party_account_number')
    self. = attributes[:'shipping_3rd_party_account_number']
  end

  if attributes.has_key?(:'shipping_date')
    self.shipping_date = attributes[:'shipping_date']
  end

  if attributes.has_key?(:'shipping_department_status')
    self.shipping_department_status = attributes[:'shipping_department_status']
  end

  if attributes.has_key?(:'shipping_method')
    self.shipping_method = attributes[:'shipping_method']
  end

  if attributes.has_key?(:'shipping_method_accounting_code')
    self.shipping_method_accounting_code = attributes[:'shipping_method_accounting_code']
  end

  if attributes.has_key?(:'special_instructions')
    self.special_instructions = attributes[:'special_instructions']
  end

  if attributes.has_key?(:'state_region')
    self.state_region = attributes[:'state_region']
  end

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

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

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

  if attributes.has_key?(:'weight')
    self.weight = attributes[:'weight']
  end
end

Instance Attribute Details

#address1Object

Address line 1



18
19
20
# File 'lib/ultracart_api/models/order_shipping.rb', line 18

def address1
  @address1
end

#address2Object

Address line 2



21
22
23
# File 'lib/ultracart_api/models/order_shipping.rb', line 21

def address2
  @address2
end

#cityObject

City



24
25
26
# File 'lib/ultracart_api/models/order_shipping.rb', line 24

def city
  @city
end

#companyObject

Company



27
28
29
# File 'lib/ultracart_api/models/order_shipping.rb', line 27

def company
  @company
end

#country_codeObject

ISO-3166 two letter country code



30
31
32
# File 'lib/ultracart_api/models/order_shipping.rb', line 30

def country_code
  @country_code
end

#day_phoneObject

Day time phone



33
34
35
# File 'lib/ultracart_api/models/order_shipping.rb', line 33

def day_phone
  @day_phone
end

#day_phone_e164Object

Day time phone (E164 format)



36
37
38
# File 'lib/ultracart_api/models/order_shipping.rb', line 36

def day_phone_e164
  @day_phone_e164
end

#delivery_dateObject

Date the customer is requesting delivery on. Typically used for perishable product delivery.



39
40
41
# File 'lib/ultracart_api/models/order_shipping.rb', line 39

def delivery_date
  @delivery_date
end

#evening_phoneObject

Evening phone



42
43
44
# File 'lib/ultracart_api/models/order_shipping.rb', line 42

def evening_phone
  @evening_phone
end

#first_nameObject

First name



45
46
47
# File 'lib/ultracart_api/models/order_shipping.rb', line 45

def first_name
  @first_name
end

#last_nameObject

Last name



48
49
50
# File 'lib/ultracart_api/models/order_shipping.rb', line 48

def last_name
  @last_name
end

#least_cost_routeObject

If true, instructs UltraCart to apply the cheapest shipping method to this order. Used only for channel partner order inserts.



51
52
53
# File 'lib/ultracart_api/models/order_shipping.rb', line 51

def least_cost_route
  @least_cost_route
end

#least_cost_route_shipping_methodsObject

List of shipping methods to consider if least_code_route is true. Used only for channel parter order inserts.



54
55
56
# File 'lib/ultracart_api/models/order_shipping.rb', line 54

def least_cost_route_shipping_methods
  @least_cost_route_shipping_methods
end

#lift_gateObject

Lift gate requested (LTL shipping methods only)



57
58
59
# File 'lib/ultracart_api/models/order_shipping.rb', line 57

def lift_gate
  @lift_gate
end

#postal_codeObject

Postal code



60
61
62
# File 'lib/ultracart_api/models/order_shipping.rb', line 60

def postal_code
  @postal_code
end

#rmaObject

RMA number



63
64
65
# File 'lib/ultracart_api/models/order_shipping.rb', line 63

def rma
  @rma
end

#ship_on_dateObject

Date the customer is requesting that the order ship on. Typically used for perishable product delivery.



66
67
68
# File 'lib/ultracart_api/models/order_shipping.rb', line 66

def ship_on_date
  @ship_on_date
end

#ship_to_residentialObject

True if the shipping address is residential. Effects the methods that are available to the customer as well as the price of the shipping method.



69
70
71
# File 'lib/ultracart_api/models/order_shipping.rb', line 69

def ship_to_residential
  @ship_to_residential
end

#shipping_3rd_party_account_numberObject

Shipping 3rd party account number



72
73
74
# File 'lib/ultracart_api/models/order_shipping.rb', line 72

def 
  @shipping_3rd_party_account_number
end

#shipping_dateObject

Date/time the order shipped on. This date is set once the first shipment is sent to the customer.



75
76
77
# File 'lib/ultracart_api/models/order_shipping.rb', line 75

def shipping_date
  @shipping_date
end

#shipping_department_statusObject

Shipping department status



78
79
80
# File 'lib/ultracart_api/models/order_shipping.rb', line 78

def shipping_department_status
  @shipping_department_status
end

#shipping_methodObject

Shipping method



81
82
83
# File 'lib/ultracart_api/models/order_shipping.rb', line 81

def shipping_method
  @shipping_method
end

#shipping_method_accounting_codeObject

Shipping method accounting code



84
85
86
# File 'lib/ultracart_api/models/order_shipping.rb', line 84

def shipping_method_accounting_code
  @shipping_method_accounting_code
end

#special_instructionsObject

Special instructions from the customer regarding shipping



87
88
89
# File 'lib/ultracart_api/models/order_shipping.rb', line 87

def special_instructions
  @special_instructions
end

#state_regionObject

State



90
91
92
# File 'lib/ultracart_api/models/order_shipping.rb', line 90

def state_region
  @state_region
end

#titleObject

Title



93
94
95
# File 'lib/ultracart_api/models/order_shipping.rb', line 93

def title
  @title
end

#tracking_number_detailsObject

Tracking number details



96
97
98
# File 'lib/ultracart_api/models/order_shipping.rb', line 96

def tracking_number_details
  @tracking_number_details
end

#tracking_numbersObject

Tracking numbers



99
100
101
# File 'lib/ultracart_api/models/order_shipping.rb', line 99

def tracking_numbers
  @tracking_numbers
end

#weightObject

Returns the value of attribute weight.



101
102
103
# File 'lib/ultracart_api/models/order_shipping.rb', line 101

def weight
  @weight
end

Class Method Details

.attribute_mapObject

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



104
105
106
107
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
# File 'lib/ultracart_api/models/order_shipping.rb', line 104

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'city' => :'city',
    :'company' => :'company',
    :'country_code' => :'country_code',
    :'day_phone' => :'day_phone',
    :'day_phone_e164' => :'day_phone_e164',
    :'delivery_date' => :'delivery_date',
    :'evening_phone' => :'evening_phone',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'least_cost_route' => :'least_cost_route',
    :'least_cost_route_shipping_methods' => :'least_cost_route_shipping_methods',
    :'lift_gate' => :'lift_gate',
    :'postal_code' => :'postal_code',
    :'rma' => :'rma',
    :'ship_on_date' => :'ship_on_date',
    :'ship_to_residential' => :'ship_to_residential',
    :'shipping_3rd_party_account_number' => :'shipping_3rd_party_account_number',
    :'shipping_date' => :'shipping_date',
    :'shipping_department_status' => :'shipping_department_status',
    :'shipping_method' => :'shipping_method',
    :'shipping_method_accounting_code' => :'shipping_method_accounting_code',
    :'special_instructions' => :'special_instructions',
    :'state_region' => :'state_region',
    :'title' => :'title',
    :'tracking_number_details' => :'tracking_number_details',
    :'tracking_numbers' => :'tracking_numbers',
    :'weight' => :'weight'
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/ultracart_api/models/order_shipping.rb', line 139

def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'company' => :'String',
    :'country_code' => :'String',
    :'day_phone' => :'String',
    :'day_phone_e164' => :'String',
    :'delivery_date' => :'String',
    :'evening_phone' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'least_cost_route' => :'BOOLEAN',
    :'least_cost_route_shipping_methods' => :'Array<String>',
    :'lift_gate' => :'BOOLEAN',
    :'postal_code' => :'String',
    :'rma' => :'String',
    :'ship_on_date' => :'String',
    :'ship_to_residential' => :'BOOLEAN',
    :'shipping_3rd_party_account_number' => :'String',
    :'shipping_date' => :'String',
    :'shipping_department_status' => :'String',
    :'shipping_method' => :'String',
    :'shipping_method_accounting_code' => :'String',
    :'special_instructions' => :'String',
    :'state_region' => :'String',
    :'title' => :'String',
    :'tracking_number_details' => :'Array<OrderTrackingNumberDetails>',
    :'tracking_numbers' => :'Array<String>',
    :'weight' => :'Weight'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
# File 'lib/ultracart_api/models/order_shipping.rb', line 559

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      city == o.city &&
      company == o.company &&
      country_code == o.country_code &&
      day_phone == o.day_phone &&
      day_phone_e164 == o.day_phone_e164 &&
      delivery_date == o.delivery_date &&
      evening_phone == o.evening_phone &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      least_cost_route == o.least_cost_route &&
      least_cost_route_shipping_methods == o.least_cost_route_shipping_methods &&
      lift_gate == o.lift_gate &&
      postal_code == o.postal_code &&
      rma == o.rma &&
      ship_on_date == o.ship_on_date &&
      ship_to_residential == o.ship_to_residential &&
       == o. &&
      shipping_date == o.shipping_date &&
      shipping_department_status == o.shipping_department_status &&
      shipping_method == o.shipping_method &&
      shipping_method_accounting_code == o.shipping_method_accounting_code &&
      special_instructions == o.special_instructions &&
      state_region == o.state_region &&
      title == o.title &&
      tracking_number_details == o.tracking_number_details &&
      tracking_numbers == o.tracking_numbers &&
      weight == o.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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
# File 'lib/ultracart_api/models/order_shipping.rb', line 629

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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



695
696
697
698
699
700
701
702
703
704
705
706
707
# File 'lib/ultracart_api/models/order_shipping.rb', line 695

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



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
# File 'lib/ultracart_api/models/order_shipping.rb', line 608

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


595
596
597
# File 'lib/ultracart_api/models/order_shipping.rb', line 595

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



601
602
603
# File 'lib/ultracart_api/models/order_shipping.rb', line 601

def hash
  [address1, address2, city, company, country_code, day_phone, day_phone_e164, delivery_date, evening_phone, first_name, last_name, least_cost_route, least_cost_route_shipping_methods, lift_gate, postal_code, rma, ship_on_date, ship_to_residential, , shipping_date, shipping_department_status, shipping_method, shipping_method_accounting_code, special_instructions, state_region, title, tracking_number_details, tracking_numbers, weight].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/ultracart_api/models/order_shipping.rb', line 306

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

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

  if !@city.nil? && @city.to_s.length > 32
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 32.')
  end

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

  if !@country_code.nil? && @country_code.to_s.length > 2
    invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
  end

  if !@day_phone.nil? && @day_phone.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone", the character length must be smaller than or equal to 25.')
  end

  if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone_e164", the character length must be smaller than or equal to 25.')
  end

  if !@evening_phone.nil? && @evening_phone.to_s.length > 25
    invalid_properties.push('invalid value for "evening_phone", the character length must be smaller than or equal to 25.')
  end

  if !@first_name.nil? && @first_name.to_s.length > 30
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 30.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 30
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 30.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 20
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 20.')
  end

  if !@rma.nil? && @rma.to_s.length > 30
    invalid_properties.push('invalid value for "rma", the character length must be smaller than or equal to 30.')
  end

  if !@shipping_3rd_party_account_number.nil? && @shipping_3rd_party_account_number.to_s.length > 20
    invalid_properties.push('invalid value for "shipping_3rd_party_account_number", the character length must be smaller than or equal to 20.')
  end

  if !@shipping_department_status.nil? && @shipping_department_status.to_s.length > 30
    invalid_properties.push('invalid value for "shipping_department_status", the character length must be smaller than or equal to 30.')
  end

  if !@state_region.nil? && @state_region.to_s.length > 32
    invalid_properties.push('invalid value for "state_region", the character length must be smaller than or equal to 32.')
  end

  if !@title.nil? && @title.to_s.length > 50
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 50.')
  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



675
676
677
# File 'lib/ultracart_api/models/order_shipping.rb', line 675

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



681
682
683
684
685
686
687
688
689
# File 'lib/ultracart_api/models/order_shipping.rb', line 681

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



669
670
671
# File 'lib/ultracart_api/models/order_shipping.rb', line 669

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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# File 'lib/ultracart_api/models/order_shipping.rb', line 377

def valid?
  return false if !@address1.nil? && @address1.to_s.length > 50
  return false if !@address2.nil? && @address2.to_s.length > 50
  return false if !@city.nil? && @city.to_s.length > 32
  return false if !@company.nil? && @company.to_s.length > 50
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@day_phone.nil? && @day_phone.to_s.length > 25
  return false if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
  return false if !@evening_phone.nil? && @evening_phone.to_s.length > 25
  return false if !@first_name.nil? && @first_name.to_s.length > 30
  return false if !@last_name.nil? && @last_name.to_s.length > 30
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@rma.nil? && @rma.to_s.length > 30
  return false if !@shipping_3rd_party_account_number.nil? && @shipping_3rd_party_account_number.to_s.length > 20
  return false if !@shipping_department_status.nil? && @shipping_department_status.to_s.length > 30
  return false if !@state_region.nil? && @state_region.to_s.length > 32
  return false if !@title.nil? && @title.to_s.length > 50
  true
end