Class: UltracartClient::CheckoutHandoffRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckoutHandoffRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 104

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

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

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

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

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

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

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

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

Instance Attribute Details

#cart ⇒ Object

Returns the value of attribute cart.



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

def cart
  @cart
end

#error_parameter_name ⇒ Object

If any error happen during the processing on the UltraCart side, the browser will be redirected to your error_return_url with the error passed in this parameter name.



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

def error_parameter_name
  @error_parameter_name
end

#error_return_url ⇒ Object

The URL to return the browser to if there are processing errors on the UltraCart side.



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

def error_return_url
  @error_return_url
end

#operation ⇒ Object

The type of handoff operation to perform



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

def operation
  @operation
end

#paypal_maximum_upsell_revenue ⇒ Object

The maximum amount of revenue that you think the customer could add during a custom upsell after sequence on your checkout.



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

def paypal_maximum_upsell_revenue
  @paypal_maximum_upsell_revenue
end

#paypal_return_url ⇒ Object

The URl to return the customers browser to after they have completed the PayPal process.



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

def paypal_return_url
  @paypal_return_url
end

#secure_host_name ⇒ Object

The desired secure host name to perform the handoff on. This should match the desired StoreFront.



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

def secure_host_name
  @secure_host_name
end

#ucacid ⇒ Object

The UltraCart Analytics cookie value. Populate this if you’re handing off from a different domain than the checkout.



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

def ucacid
  @ucacid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 64

def self.attribute_map
  {
    :'cart' => :'cart',
    :'error_parameter_name' => :'error_parameter_name',
    :'error_return_url' => :'error_return_url',
    :'operation' => :'operation',
    :'paypal_maximum_upsell_revenue' => :'paypal_maximum_upsell_revenue',
    :'paypal_return_url' => :'paypal_return_url',
    :'secure_host_name' => :'secure_host_name',
    :'ucacid' => :'ucacid'
  }
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



205
206
207
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 205

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 83

def self.openapi_types
  {
    :'cart' => :'Cart',
    :'error_parameter_name' => :'String',
    :'error_return_url' => :'String',
    :'operation' => :'String',
    :'paypal_maximum_upsell_revenue' => :'Float',
    :'paypal_return_url' => :'String',
    :'secure_host_name' => :'String',
    :'ucacid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cart == o.cart &&
      error_parameter_name == o.error_parameter_name &&
      error_return_url == o.error_return_url &&
      operation == o.operation &&
      paypal_maximum_upsell_revenue == o.paypal_maximum_upsell_revenue &&
      paypal_return_url == o.paypal_return_url &&
      secure_host_name == o.secure_host_name &&
      ucacid == o.ucacid
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



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

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 307

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 212

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


192
193
194
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 198

def hash
  [cart, error_parameter_name, error_return_url, operation, paypal_maximum_upsell_revenue, paypal_return_url, secure_host_name, ucacid].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



152
153
154
155
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 152

def list_invalid_properties
  invalid_properties = Array.new
  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



283
284
285
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 283

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 289

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



277
278
279
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 277

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



159
160
161
162
163
 
# File 'lib/ultracart_api/models/checkout_handoff_request.rb', line 159

def valid?
  operation_validator = EnumAttributeValidator.new('String', ["checkout", "payPal", "payPalCredit", "view", "affirm", "sezzle"])
  return false unless operation_validator.valid?(@operation)
  true
end