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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

Address line 1



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

def address1
  @address1
end

#address2 ⇒ Object

Address line 2



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

def address2
  @address2
end

#city ⇒ Object

City



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

def city
  @city
end

#company ⇒ Object

Company



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

def company
  @company
end

#country_code ⇒ Object

ISO-3166 two letter country code



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

def country_code
  @country_code
end

#day_phone ⇒ Object

Day time phone



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

def day_phone
  @day_phone
end

#delivery_date ⇒ Object

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



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

def delivery_date
  @delivery_date
end

#evening_phone ⇒ Object

Evening phone



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

def evening_phone
  @evening_phone
end

#first_name ⇒ Object

First name



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

def first_name
  @first_name
end

#last_name ⇒ Object

Last name



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

def last_name
  @last_name
end

#lift_gate ⇒ Object

Lift gate requested (LTL shipping methods only)



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

def lift_gate
  @lift_gate
end

#postal_code ⇒ Object

Postal code



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

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.



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

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.



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

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



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

def 
  @shipping_3rd_party_account_number
end

#shipping_method ⇒ Object

Shipping method



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

def shipping_method
  @shipping_method
end

#special_instructions ⇒ Object

Special instructions from the customer regarding shipping



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

def special_instructions
  @special_instructions
end

#state_region ⇒ Object

State/Region



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

def state_region
  @state_region
end

#title ⇒ Object

Title



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

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



507
508
509
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 507

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 131

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 106

def self.openapi_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



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 468

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



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 538

def _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 = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



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

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



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 514

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


494
495
496
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 494

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



500
501
502
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 500

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



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

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



585
586
587
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 585

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



591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 591

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



579
580
581
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 579

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ultracart_api/models/cart_shipping.rb', line 297

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