Class: CyberSource::Upv1capturecontextsCaptureMandate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upv1capturecontextsCaptureMandate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/upv1capturecontexts_capture_mandate.rb', line 96

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?(:'billingType')
    self.billing_type = attributes[:'billingType']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_type ⇒ Object

Configure Unified Checkout to capture billing address information. Possible values: - FULL: Capture complete billing address information. - PARTIAL: Capture first name, last name, country and postal/zip code only. - NONE: Capture only first name and last name.



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

def billing_type
  @billing_type
end

#combo_card ⇒ Object

Configure Unified Checkout to display combo card at checkout.
A combo debit/credit card is a single card that functions both as a Debit/Credit card. Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card. Important: This is applicable to Visa cards only. Possible values: - True - False
**Use Cases:** **Offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to true. - When set to true, Combo Card selection is shown at checkout
**Do not offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request. - The Combo Card selection is not shown at checkout.



41
42
43
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 41

def combo_card
  @combo_card
end

#cpf ⇒ Object

Configure Unified Checkout to display and capture the CPF number (Cadastro de Pessoas Físicas). The CPF number is a unique 11-digit identifier issued to Brazilian citizens and residents for tax purposes. Possible values: - True - False
This field is optional. If set to true the field is required. If set to false the field is optional. If the field is not included in the capture context then it is not captured.
Important: - If PANENTRY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout regardless of what card number is entered. - If CLICKTOPAY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout only when a Visa Click To Pay card is entered.



44
45
46
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 44

def cpf
  @cpf
end

#request_email ⇒ Object

Configure Unified Checkout to capture customer email address. Possible values: - True - False



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

def request_email
  @request_email
end

#request_phone ⇒ Object

Configure Unified Checkout to capture customer phone number. Possible values: - True - False



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

def request_phone
  @request_phone
end

#request_save_card ⇒ Object

Configure Unified Checkout to display the "Save card for future use" checkbox.
Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.
Applicable when manually entering the details and not enrolling in Click to Pay. Possible values: - True - False
**Use Cases:** **Offer consumers option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to true. - When set to true, this will show a checkbox with the message ‘Save card for future use’ in Unified Checkout. - When selected this provides a response in both the Transient Token and Get Credentials API response.
**Do not offer consumers the option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request. - When set to false, the save card option is not shown to consumers when manually entering card details.



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

def request_save_card
  @request_save_card
end

#request_shipping ⇒ Object

Configure Unified Checkout to capture customer shipping details. Possible values: - True - False



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

def request_shipping
  @request_shipping
end

#ship_to_countries ⇒ Object

List of countries available to ship to. Use the two-character ISO Standard Country Codes.



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

def ship_to_countries
  @ship_to_countries
end

#show_accepted_network_icons ⇒ Object

Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False



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

def show_accepted_network_icons
  @show_accepted_network_icons
end

#show_confirmation_step ⇒ Object

Configure Unified Checkout to display the final confirmation screen when using Click to Pay.
Where ‘BillingType’= NONE and ‘requestShipping’= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray. Possible values: - True - False



35
36
37
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 35

def show_confirmation_step
  @show_confirmation_step
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 47

def self.attribute_map
  {
    :'billing_type' => :'billingType',
    :'request_email' => :'requestEmail',
    :'request_phone' => :'requestPhone',
    :'request_shipping' => :'requestShipping',
    :'ship_to_countries' => :'shipToCountries',
    :'show_accepted_network_icons' => :'showAcceptedNetworkIcons',
    :'show_confirmation_step' => :'showConfirmationStep',
    :'request_save_card' => :'requestSaveCard',
    :'combo_card' => :'comboCard',
    :'cpf' => :'CPF'
  }
end

.json_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 63

def self.json_map
  {
    :'billing_type' => :'billing_type',
    :'request_email' => :'request_email',
    :'request_phone' => :'request_phone',
    :'request_shipping' => :'request_shipping',
    :'ship_to_countries' => :'ship_to_countries',
    :'show_accepted_network_icons' => :'show_accepted_network_icons',
    :'show_confirmation_step' => :'show_confirmation_step',
    :'request_save_card' => :'request_save_card',
    :'combo_card' => :'combo_card',
    :'cpf' => :'cpf'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 79

def self.swagger_types
  {
    :'billing_type' => :'String',
    :'request_email' => :'BOOLEAN',
    :'request_phone' => :'BOOLEAN',
    :'request_shipping' => :'BOOLEAN',
    :'ship_to_countries' => :'Array<String>',
    :'show_accepted_network_icons' => :'BOOLEAN',
    :'show_confirmation_step' => :'BOOLEAN',
    :'request_save_card' => :'BOOLEAN',
    :'combo_card' => :'BOOLEAN',
    :'cpf' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_type == o.billing_type &&
      request_email == o.request_email &&
      request_phone == o.request_phone &&
      request_shipping == o.request_shipping &&
      ship_to_countries == o.ship_to_countries &&
      show_accepted_network_icons == o.show_accepted_network_icons &&
      show_confirmation_step == o.show_confirmation_step &&
      request_save_card == o.request_save_card &&
      combo_card == o.combo_card &&
      cpf == o.cpf
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



217
218
219
220
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
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 217

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 196

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


183
184
185
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [billing_type, request_email, request_phone, request_shipping, ship_to_countries, show_accepted_network_icons, show_confirmation_step, request_save_card, combo_card, cpf].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/upv1capturecontexts_capture_mandate.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



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

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 269

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



257
258
259
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb', line 257

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/upv1capturecontexts_capture_mandate.rb', line 154

def valid?
  true
end