Class: UltracartClient::CartCheckout

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CartCheckout

Initializes the object



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
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 133

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

  if attributes.key?(:'current_step')
    self.current_step = attributes[:'current_step']
  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?(:'ip_address')
    self.ip_address = attributes[:'ip_address']
  end

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

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



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

def comments
  @comments
end

#current_step ⇒ Object

Current step of the checkout (read only)



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

def current_step
  @current_step
end

#custom_field1 ⇒ Object

Custom field 1



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

def custom_field1
  @custom_field1
end

#custom_field10 ⇒ Object

Custom field 10



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

def custom_field10
  @custom_field10
end

#custom_field2 ⇒ Object

Custom field 2



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

def custom_field2
  @custom_field2
end

#custom_field3 ⇒ Object

Custom field 3



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

def custom_field3
  @custom_field3
end

#custom_field4 ⇒ Object

Custom field 4



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

def custom_field4
  @custom_field4
end

#custom_field5 ⇒ Object

Custom field 5



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

def custom_field5
  @custom_field5
end

#custom_field6 ⇒ Object

Custom field 6



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

def custom_field6
  @custom_field6
end

#custom_field7 ⇒ Object

Custom field 7



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

def custom_field7
  @custom_field7
end

#custom_field8 ⇒ Object

Custom field 8



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

def custom_field8
  @custom_field8
end

#custom_field9 ⇒ Object

Custom field 9



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

def custom_field9
  @custom_field9
end

#ip_address ⇒ Object

IP Address (read only unless non-browser key authenticated)



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

def ip_address
  @ip_address
end

#return_code ⇒ Object

Return code assigned for send return email operation



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

def return_code
  @return_code
end

#return_url ⇒ Object

The URL to redirect the customer to when they return from an abandon cart email. Must be https protocol.



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

def return_url
  @return_url
end

#screen_branding_theme_code ⇒ Object

Screen branding theme code



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

def screen_branding_theme_code
  @screen_branding_theme_code
end

#storefront_host_name ⇒ Object

StoreFront Host Name



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

def storefront_host_name
  @storefront_host_name
end

#user_agent ⇒ Object

User agent of the browser



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

def user_agent
  @user_agent
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'comments' => :'comments',
    :'current_step' => :'current_step',
    :'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',
    :'ip_address' => :'ip_address',
    :'return_code' => :'return_code',
    :'return_url' => :'return_url',
    :'screen_branding_theme_code' => :'screen_branding_theme_code',
    :'storefront_host_name' => :'storefront_host_name',
    :'user_agent' => :'user_agent'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



467
468
469
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 467

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'comments' => :'String',
    :'current_step' => :'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',
    :'ip_address' => :'String',
    :'return_code' => :'String',
    :'return_url' => :'String',
    :'screen_branding_theme_code' => :'String',
    :'storefront_host_name' => :'String',
    :'user_agent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comments == o.comments &&
      current_step == o.current_step &&
      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 &&
      ip_address == o.ip_address &&
      return_code == o.return_code &&
      return_url == o.return_url &&
      screen_branding_theme_code == o.screen_branding_theme_code &&
      storefront_host_name == o.storefront_host_name &&
      user_agent == o.user_agent
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



498
499
500
501
502
503
504
505
506
507
508
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
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 498

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



569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 569

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



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 474

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

See Also:

  • `==` method


454
455
456
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 454

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



460
461
462
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 460

def hash
  [comments, current_step, custom_field1, custom_field10, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, custom_field8, custom_field9, ip_address, return_code, return_url, screen_branding_theme_code, storefront_host_name, user_agent].hash
end

#list_invalid_properties ⇒ Object

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



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

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

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



545
546
547
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 545

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 551

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



539
540
541
 
# File 'lib/ultracart_api/models/cart_checkout.rb', line 539

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



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

def valid?
  return false if !@comments.nil? && @comments.to_s.length > 2000
  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 !@return_url.nil? && @return_url.to_s.length > 2048
  return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
  true
end