Class: CyberSource::GenerateUnifiedCheckoutCaptureContextRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateUnifiedCheckoutCaptureContextRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
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
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 92

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'clientVersion')
    self.client_version = attributes[:'clientVersion']
  end

  if attributes.has_key?(:'targetOrigins')
    if (value = attributes[:'targetOrigins']).is_a?(Array)
      self.target_origins = value
    end
  end

  if attributes.has_key?(:'allowedCardNetworks')
    if (value = attributes[:'allowedCardNetworks']).is_a?(Array)
      self.allowed_card_networks = value
    end
  end

  if attributes.has_key?(:'allowedPaymentTypes')
    if (value = attributes[:'allowedPaymentTypes']).is_a?(Array)
      self.allowed_payment_types = value
    end
  end

  if attributes.has_key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.has_key?(:'locale')
    self.locale = attributes[:'locale']
  end

  if attributes.has_key?(:'captureMandate')
    self.capture_mandate = attributes[:'captureMandate']
  end

  if attributes.has_key?(:'completeMandate')
    self.complete_mandate = attributes[:'completeMandate']
  end

  if attributes.has_key?(:'orderInformation')
    self.order_information = attributes[:'orderInformation']
  end

  if attributes.has_key?(:'transientTokenResponseOptions')
    self.transient_token_response_options = attributes[:'transientTokenResponseOptions']
  end
end

Instance Attribute Details

#allowed_card_networks ⇒ Object

The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK



23
24
25
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 23

def allowed_card_networks
  @allowed_card_networks
end

#allowed_payment_types ⇒ Object

The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE
Unified Checkout also supports the following Alternative Payments: - AFTERPAY
Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY
Important: - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant’s existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.
**Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.
**Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to "true". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to "FULL" or "PARTIAL". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa
If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.



26
27
28
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 26

def allowed_payment_types
  @allowed_payment_types
end

#capture_mandate ⇒ Object

Returns the value of attribute capture_mandate.



34
35
36
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 34

def capture_mandate
  @capture_mandate
end

#client_version ⇒ Object

Specify the version of Unified Checkout that you want to use.



17
18
19
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 17

def client_version
  @client_version
end

#complete_mandate ⇒ Object

Returns the value of attribute complete_mandate.



36
37
38
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 36

def complete_mandate
  @complete_mandate
end

#country ⇒ Object

Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard



29
30
31
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 29

def country
  @country
end

#locale ⇒ Object

Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)



32
33
34
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 32

def locale
  @locale
end

#order_information ⇒ Object

Returns the value of attribute order_information.



38
39
40
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 38

def order_information
  @order_information
end

#target_origins ⇒ Object

The [target origin](developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use hostname (unless you use localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - example.com - subdomain.example.com - example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ "example.com", "basket.example.com", "ecom.example.com" ]



20
21
22
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 20

def target_origins
  @target_origins
end

#transient_token_response_options ⇒ Object

Returns the value of attribute transient_token_response_options.



40
41
42
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 40

def transient_token_response_options
  @transient_token_response_options
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 43

def self.attribute_map
  {
    :'client_version' => :'clientVersion',
    :'target_origins' => :'targetOrigins',
    :'allowed_card_networks' => :'allowedCardNetworks',
    :'allowed_payment_types' => :'allowedPaymentTypes',
    :'country' => :'country',
    :'locale' => :'locale',
    :'capture_mandate' => :'captureMandate',
    :'complete_mandate' => :'completeMandate',
    :'order_information' => :'orderInformation',
    :'transient_token_response_options' => :'transientTokenResponseOptions'
  }
end

.json_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 59

def self.json_map
  {
    :'client_version' => :'client_version',
    :'target_origins' => :'target_origins',
    :'allowed_card_networks' => :'allowed_card_networks',
    :'allowed_payment_types' => :'allowed_payment_types',
    :'country' => :'country',
    :'locale' => :'locale',
    :'capture_mandate' => :'capture_mandate',
    :'complete_mandate' => :'complete_mandate',
    :'order_information' => :'order_information',
    :'transient_token_response_options' => :'transient_token_response_options'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 75

def self.swagger_types
  {
    :'client_version' => :'String',
    :'target_origins' => :'Array<String>',
    :'allowed_card_networks' => :'Array<String>',
    :'allowed_payment_types' => :'Array<String>',
    :'country' => :'String',
    :'locale' => :'String',
    :'capture_mandate' => :'Upv1capturecontextsCaptureMandate',
    :'complete_mandate' => :'Upv1capturecontextsCompleteMandate',
    :'order_information' => :'Upv1capturecontextsOrderInformation',
    :'transient_token_response_options' => :'Microformv2sessionsTransientTokenResponseOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_version == o.client_version &&
      target_origins == o.target_origins &&
      allowed_card_networks == o.allowed_card_networks &&
      allowed_payment_types == o.allowed_payment_types &&
      country == o.country &&
      locale == o.locale &&
      capture_mandate == o.capture_mandate &&
      complete_mandate == o.complete_mandate &&
      order_information == o.order_information &&
      transient_token_response_options == o.transient_token_response_options
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



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
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 223

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CyberSource.const_get(type).new
    temp_model.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



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

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 202

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 195

def hash
  [client_version, target_origins, allowed_card_networks, allowed_payment_types, country, locale, capture_mandate, complete_mandate, order_information, transient_token_response_options].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



147
148
149
150
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 147

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



269
270
271
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 269

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



275
276
277
278
279
280
281
282
283
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



263
264
265
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 263

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



154
155
156
 
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 154

def valid?
  true
end