Class: UltracartClient::OrderCheckout

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderCheckout

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/order_checkout.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#browser ⇒ Object

Returns the value of attribute browser.



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

def browser
  @browser
end

#comments ⇒ Object

Comments from the customer. Rarely used on the single page checkout.



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

def comments
  @comments
end

#custom_field1 ⇒ Object

Custom field 1



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

def custom_field1
  @custom_field1
end

#custom_field10 ⇒ Object

Custom field 10



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

def custom_field10
  @custom_field10
end

#custom_field2 ⇒ Object

Custom field 2



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

def custom_field2
  @custom_field2
end

#custom_field3 ⇒ Object

Custom field 3



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

def custom_field3
  @custom_field3
end

#custom_field4 ⇒ Object

Custom field 4



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

def custom_field4
  @custom_field4
end

#custom_field5 ⇒ Object

Custom field 5



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

def custom_field5
  @custom_field5
end

#custom_field6 ⇒ Object

Custom field 6



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

def custom_field6
  @custom_field6
end

#custom_field7 ⇒ Object

Custom field 7



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

def custom_field7
  @custom_field7
end

#custom_field8 ⇒ Object

Custom field 8



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

def custom_field8
  @custom_field8
end

#custom_field9 ⇒ Object

Custom field 9



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

def custom_field9
  @custom_field9
end

#customer_ip_address ⇒ Object

IP address of the customer when placing the order



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

def customer_ip_address
  @customer_ip_address
end

#screen_branding_theme_code ⇒ Object

Screen branding theme code associated with the order (legacy checkout)



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

def screen_branding_theme_code
  @screen_branding_theme_code
end

#screen_size ⇒ Object

Screen size small, medium or large



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

def screen_size
  @screen_size
end

#storefront_host_name ⇒ Object

StoreFront host name associated with the order



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

def storefront_host_name
  @storefront_host_name
end

#upsell_path_code ⇒ Object

Upsell path code assigned during the checkout that the customer went through



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

def upsell_path_code
  @upsell_path_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

def self.attribute_map
  {
    :'browser' => :'browser',
    :'comments' => :'comments',
    :'custom_field1' => :'custom_field1',
    :'custom_field10' => :'custom_field10',
    :'custom_field2' => :'custom_field2',
    :'custom_field3' => :'custom_field3',
    :'custom_field4' => :'custom_field4',
    :'custom_field5' => :'custom_field5',
    :'custom_field6' => :'custom_field6',
    :'custom_field7' => :'custom_field7',
    :'custom_field8' => :'custom_field8',
    :'custom_field9' => :'custom_field9',
    :'customer_ip_address' => :'customer_ip_address',
    :'screen_branding_theme_code' => :'screen_branding_theme_code',
    :'screen_size' => :'screen_size',
    :'storefront_host_name' => :'storefront_host_name',
    :'upsell_path_code' => :'upsell_path_code'
  }
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



426
427
428
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 426

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 120

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 97

def self.openapi_types
  {
    :'browser' => :'Browser',
    :'comments' => :'String',
    :'custom_field1' => :'String',
    :'custom_field10' => :'String',
    :'custom_field2' => :'String',
    :'custom_field3' => :'String',
    :'custom_field4' => :'String',
    :'custom_field5' => :'String',
    :'custom_field6' => :'String',
    :'custom_field7' => :'String',
    :'custom_field8' => :'String',
    :'custom_field9' => :'String',
    :'customer_ip_address' => :'String',
    :'screen_branding_theme_code' => :'String',
    :'screen_size' => :'String',
    :'storefront_host_name' => :'String',
    :'upsell_path_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 389

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      browser == o.browser &&
      comments == o.comments &&
      custom_field1 == o.custom_field1 &&
      custom_field10 == o.custom_field10 &&
      custom_field2 == o.custom_field2 &&
      custom_field3 == o.custom_field3 &&
      custom_field4 == o.custom_field4 &&
      custom_field5 == o.custom_field5 &&
      custom_field6 == o.custom_field6 &&
      custom_field7 == o.custom_field7 &&
      custom_field8 == o.custom_field8 &&
      custom_field9 == o.custom_field9 &&
      customer_ip_address == o.customer_ip_address &&
      screen_branding_theme_code == o.screen_branding_theme_code &&
      screen_size == o.screen_size &&
      storefront_host_name == o.storefront_host_name &&
      upsell_path_code == o.upsell_path_code
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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 457

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



528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 528

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 433

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


413
414
415
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 413

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



419
420
421
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 419

def hash
  [browser, comments, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, customer_ip_address, screen_branding_theme_code, screen_size, storefront_host_name, upsell_path_code].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
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 211

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

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

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

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

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

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

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

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

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

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

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



504
505
506
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 504

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



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 510

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



498
499
500
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 498

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ultracart_api/models/order_checkout.rb', line 262

def valid?
  return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
  return false if !@custom_field10.nil? && @custom_field10.to_s.length > 200
  return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
  return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
  return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
  return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
  return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
  return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
  return false if !@custom_field8.nil? && @custom_field8.to_s.length > 200
  return false if !@custom_field9.nil? && @custom_field9.to_s.length > 200
  return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
  true
end