Class: PCPServerSDK::Models::CreateCheckoutRequest

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

Overview

Request to create a Checkout for a Commerce Case. The payment for the Checkout can be directly executed if autoExecuteOrder = true. In this case, the paymentMethodSpecificInput must be provided and only a full order is possible. If no amountOfMoney is provided, the platform will calculate the respective Checkout amount based on the cartItem productPrice and quantity. In case of a payment error, the payment can be retried by providing the respective commerceCaseId and checkoutId to the the Order or Payment Execution endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCheckoutRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 63

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

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

  if attributes.key?(:'auto_execute_order')
    self.auto_execute_order = attributes[:'auto_execute_order']
  else
    self.auto_execute_order = false
  end
end

Instance Attribute Details

#amount_of_money ⇒ Object

Returns the value of attribute amount_of_money.



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

def amount_of_money
  @amount_of_money
end

#auto_execute_order ⇒ Object

Set this flag to directly execute a payment when creating a Commerce Case or Checkout. If the value for autoExecuteOrder is set to true, the paymentMethodSpecificInput for the order is mandatory and has to be provided. The autoExecuteOrder can only be used for orderType = full. If no shoppingCart information has been provided, a Payment Execution will be created instead of an Order. As a consequence, only Payment Execution endpoints can be used.



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

def auto_execute_order
  @auto_execute_order
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.



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

def creation_date_time
  @creation_date_time
end

#order_request ⇒ Object

Returns the value of attribute order_request.



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

def order_request
  @order_request
end

#references ⇒ Object

Returns the value of attribute references.



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

def references
  @references
end

#shipping ⇒ Object

Returns the value of attribute shipping.



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

def shipping
  @shipping
end

#shopping_cart ⇒ Object

Returns the value of attribute shopping_cart.



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

def shopping_cart
  @shopping_cart
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



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

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



38
39
40
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 38

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 25

def self.attribute_map
  {
    :'amount_of_money' => :'amountOfMoney',
    :'references' => :'references',
    :'shipping' => :'shipping',
    :'shopping_cart' => :'shoppingCart',
    :'order_request' => :'orderRequest',
    :'creation_date_time' => :'creationDateTime',
    :'auto_execute_order' => :'autoExecuteOrder'
  }
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 136

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



56
57
58
59
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 43

def self.openapi_types
  {
    :'amount_of_money' => :'AmountOfMoney',
    :'references' => :'CheckoutReferences',
    :'shipping' => :'Shipping',
    :'shopping_cart' => :'ShoppingCartInput',
    :'order_request' => :'OrderRequest',
    :'creation_date_time' => :'Time',
    :'auto_execute_order' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 109

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount_of_money == o.amount_of_money &&
      references == o.references &&
      shipping == o.shipping &&
      shopping_cart == o.shopping_cart &&
      order_request == o.order_request &&
      creation_date_time == o.creation_date_time &&
      auto_execute_order == o.auto_execute_order
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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 231

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


123
124
125
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



129
130
131
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 129

def hash
  [amount_of_money, references, shipping, shopping_cart, order_request, creation_date_time, auto_execute_order].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



207
208
209
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 207

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 213

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



201
202
203
 
# File 'lib/PCP-server-Ruby-SDK/models/create_checkout_request.rb', line 201

def to_s
  to_hash.to_s
end