Class: UltracartClient::CartShipping

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CartShipping

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
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
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 126

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?(:'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?(:'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?(:'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_method')
    self.shipping_method = attributes[:'shipping_method']
  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
end

Instance Attribute Details

#address1 ⇒ Object

Address line 1



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

def address1
  @address1
end

#address2 ⇒ Object

Address line 2



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

def address2
  @address2
end

#city ⇒ Object

City



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

def city
  @city
end

#company ⇒ Object

Company



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

def company
  @company
end

#country_code ⇒ Object

ISO-3166 two letter country code



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

def country_code
  @country_code
end

#day_phone ⇒ Object

Day time phone



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

def day_phone
  @day_phone
end

#delivery_date ⇒ Object

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



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

def delivery_date
  @delivery_date
end

#evening_phone ⇒ Object

Evening phone



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

def evening_phone
  @evening_phone
end

#first_name ⇒ Object

First name



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

def first_name
  @first_name
end

#last_name ⇒ Object

Last name



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

def last_name
  @last_name
end

#lift_gate ⇒ Object

Lift gate requested (LTL shipping methods only)



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

def lift_gate
  @lift_gate
end

#postal_code ⇒ Object

Postal code



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

def postal_code
  @postal_code
end

#ship_on_date ⇒ Object

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



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

def ship_on_date
  @ship_on_date
end

#ship_to_residential ⇒ Object

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



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

def ship_to_residential
  @ship_to_residential
end

#shipping_3rd_party_account_number ⇒ Object

3rd party account number to ship against for UPS or FedEx



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

def 
  @shipping_3rd_party_account_number
end

#shipping_method ⇒ Object

Shipping method



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

def shipping_method
  @shipping_method
end

#special_instructions ⇒ Object

Special instructions from the customer regarding shipping



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

def special_instructions
  @special_instructions
end

#state_region ⇒ Object

State/Region



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

def state_region
  @state_region
end

#title ⇒ Object

Title



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 75

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'city' => :'city',
    :'company' => :'company',
    :'country_code' => :'country_code',
    :'day_phone' => :'day_phone',
    :'delivery_date' => :'delivery_date',
    :'evening_phone' => :'evening_phone',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'lift_gate' => :'lift_gate',
    :'postal_code' => :'postal_code',
    :'ship_on_date' => :'ship_on_date',
    :'ship_to_residential' => :'ship_to_residential',
    :'shipping_3rd_party_account_number' => :'shipping_3rd_party_account_number',
    :'shipping_method' => :'shipping_method',
    :'special_instructions' => :'special_instructions',
    :'state_region' => :'state_region',
    :'title' => :'title'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'company' => :'String',
    :'country_code' => :'String',
    :'day_phone' => :'String',
    :'delivery_date' => :'String',
    :'evening_phone' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'lift_gate' => :'BOOLEAN',
    :'postal_code' => :'String',
    :'ship_on_date' => :'String',
    :'ship_to_residential' => :'BOOLEAN',
    :'shipping_3rd_party_account_number' => :'String',
    :'shipping_method' => :'String',
    :'special_instructions' => :'String',
    :'state_region' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 449

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 &&
      delivery_date == o.delivery_date &&
      evening_phone == o.evening_phone &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      lift_gate == o.lift_gate &&
      postal_code == o.postal_code &&
      ship_on_date == o.ship_on_date &&
      ship_to_residential == o.ship_to_residential &&
       == o. &&
      shipping_method == o.shipping_method &&
      special_instructions == o.special_instructions &&
      state_region == o.state_region &&
      title == o.title
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



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 509

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



575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 575

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



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 488

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


475
476
477
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 475

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



481
482
483
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 481

def hash
  [address1, address2, city, company, country_code, day_phone, delivery_date, evening_phone, first_name, last_name, lift_gate, postal_code, ship_on_date, ship_to_residential, , shipping_method, special_instructions, state_region, title].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



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

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 !@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 > 25
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 25.')
  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_method.nil? && @shipping_method.to_s.length > 40
    invalid_properties.push('invalid value for "shipping_method", the character length must be smaller than or equal to 40.')
  end

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



555
556
557
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 555

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



561
562
563
564
565
566
567
568
569
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 561

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



549
550
551
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 549

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



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

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 !@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 > 25
  return false if !@shipping_3rd_party_account_number.nil? && @shipping_3rd_party_account_number.to_s.length > 20
  return false if !@shipping_method.nil? && @shipping_method.to_s.length > 40
  return false if !@special_instructions.nil? && @special_instructions.to_s.length > 10000
  return false if !@state_region.nil? && @state_region.to_s.length > 32
  return false if !@title.nil? && @title.to_s.length > 50
  true
end