Class: PCPServerSDK::Models::CheckoutResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/checkout_response.rb

Overview

The Checkout corresponds to the order of the WL API. We do not take additionalInput from the WL API. We have no shipping and use deliveryAddress instead of address.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckoutResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 111

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

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

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

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

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

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

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

  if attributes.key?(:'payment_executions')
    if (value = attributes[:'payment_executions']).is_a?(Array)
      self.payment_executions = value
    end
  end

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

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

  if attributes.key?(:'payment_information')
    if (value = attributes[:'payment_information']).is_a?(Array)
      self.payment_information = value
    end
  end

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

  if attributes.key?(:'allowed_payment_actions')
    if (value = attributes[:'allowed_payment_actions']).is_a?(Array)
      self.allowed_payment_actions = value
    end
  end
end

Instance Attribute Details

#allowed_payment_actions ⇒ Object

Returns the value of attribute allowed_payment_actions.



36
37
38
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 36

def allowed_payment_actions
  @allowed_payment_actions
end

#amount_of_money ⇒ Object

Returns the value of attribute amount_of_money.



17
18
19
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 17

def amount_of_money
  @amount_of_money
end

#checkout_id ⇒ Object

reference to the Checkout.



12
13
14
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 12

def checkout_id
  @checkout_id
end

#checkout_status ⇒ Object

Returns the value of attribute checkout_status.



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 27

def checkout_status
  @checkout_status
end

#commerce_case_id ⇒ Object

reference to the Commerce Case.



9
10
11
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 9

def commerce_case_id
  @commerce_case_id
end

#creation_date_time ⇒ Object

Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD’T’HH:mm:ss’Z’ * YYYY-MM-DD’T’HH:mm:ss+XX:XX * YYYY-MM-DD’T’HH:mm:ss-XX:XX * YYYY-MM-DD’T’HH:mm’Z’ * YYYY-MM-DD’T’HH:mm+XX:XX * YYYY-MM-DD’T’HH:mm-XX:XX All other formats may be ignored by the system.



34
35
36
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 34

def creation_date_time
  @creation_date_time
end

#merchant_customer_id ⇒ Object

Unique identifier for the customer.



15
16
17
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 15

def merchant_customer_id
  @merchant_customer_id
end

#payment_executions ⇒ Object

Returns the value of attribute payment_executions.



25
26
27
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 25

def payment_executions
  @payment_executions
end

#payment_information ⇒ Object

Returns the value of attribute payment_information.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 31

def payment_information
  @payment_information
end

#references ⇒ Object

Returns the value of attribute references.



19
20
21
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 19

def references
  @references
end

#shipping ⇒ Object

Returns the value of attribute shipping.



21
22
23
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 21

def shipping
  @shipping
end

#shopping_cart ⇒ Object

Returns the value of attribute shopping_cart.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 23

def shopping_cart
  @shopping_cart
end

#status_output ⇒ Object

Returns the value of attribute status_output.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 29

def status_output
  @status_output
end

Class Method Details

._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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 242

def self._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 = PCPServerSDK::Models.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 61

def self.attribute_map
  {
    :'commerce_case_id' => :'commerceCaseId',
    :'checkout_id' => :'checkoutId',
    :'merchant_customer_id' => :'merchantCustomerId',
    :'amount_of_money' => :'amountOfMoney',
    :'references' => :'references',
    :'shipping' => :'shipping',
    :'shopping_cart' => :'shoppingCart',
    :'payment_executions' => :'paymentExecutions',
    :'checkout_status' => :'checkoutStatus',
    :'status_output' => :'statusOutput',
    :'payment_information' => :'paymentInformation',
    :'creation_date_time' => :'creationDateTime',
    :'allowed_payment_actions' => :'allowedPaymentActions'
  }
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 218

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 85

def self.openapi_types
  {
    :'commerce_case_id' => :'String',
    :'checkout_id' => :'String',
    :'merchant_customer_id' => :'String',
    :'amount_of_money' => :'AmountOfMoney',
    :'references' => :'CheckoutReferences',
    :'shipping' => :'Shipping',
    :'shopping_cart' => :'ShoppingCartResult',
    :'payment_executions' => :'Array<PaymentExecution>',
    :'checkout_status' => :'StatusCheckout',
    :'status_output' => :'StatusOutput',
    :'payment_information' => :'Array<PaymentInformationResponse>',
    :'creation_date_time' => :'Time',
    :'allowed_payment_actions' => :'Array<AllowedPaymentActions>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_case_id == o.commerce_case_id &&
      checkout_id == o.checkout_id &&
      merchant_customer_id == o.merchant_customer_id &&
      amount_of_money == o.amount_of_money &&
      references == o.references &&
      shipping == o.shipping &&
      shopping_cart == o.shopping_cart &&
      payment_executions == o.payment_executions &&
      checkout_status == o.checkout_status &&
      status_output == o.status_output &&
      payment_information == o.payment_information &&
      creation_date_time == o.creation_date_time &&
      allowed_payment_actions == o.allowed_payment_actions
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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 313

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 211

def hash
  [commerce_case_id, checkout_id, merchant_customer_id, amount_of_money, references, shipping, shopping_cart, payment_executions, checkout_status, status_output, payment_information, creation_date_time, allowed_payment_actions].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 295

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



283
284
285
 
# File 'lib/PCP-server-Ruby-SDK/models/checkout_response.rb', line 283

def to_s
  to_hash.to_s
end