Class: CityPayApiClient::ThreeDSecure

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/three_d_secure.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ThreeDSecure

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accept_headers ⇒ Object

Required for 3DSv1. Optional if the ‘cp_bx` value is provided otherwise required for 3Dv2 processing operating in browser authentication mode. The `cp_bx` value will override any value supplied to this field. The content of the HTTP accept header as sent to the merchant from the cardholder’s user agent. This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.



18
19
20
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 18

def accept_headers
  @accept_headers
end

#browser_color_depth ⇒ Object

BrowserColorDepth field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



21
22
23
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 21

def browser_color_depth
  @browser_color_depth
end

#browser_ip ⇒ Object

BrowserIP field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



24
25
26
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 24

def browser_ip
  @browser_ip
end

#browser_java_enabled ⇒ Object

BrowserJavaEnabled field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



27
28
29
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 27

def browser_java_enabled
  @browser_java_enabled
end

#browser_language ⇒ Object

BrowserLanguage field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



30
31
32
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 30

def browser_language
  @browser_language
end

#browser_screen_height ⇒ Object

BrowserScreenHeight field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



33
34
35
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 33

def browser_screen_height
  @browser_screen_height
end

#browser_screen_width ⇒ Object

BrowserScreenWidth field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



36
37
38
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 36

def browser_screen_width
  @browser_screen_width
end

#browser_tz ⇒ Object

BrowserTZ offset field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the ‘bx` function to gather this value.



39
40
41
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 39

def browser_tz
  @browser_tz
end

#cp_bx ⇒ Object

Required for 3DSv2. Browser extension value produced by the citypay.js ‘bx` function. See [sandbox.citypay.com/3dsv2/bx](https://sandbox.citypay.com/3dsv2/bx) for details.



42
43
44
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 42

def cp_bx
  @cp_bx
end

#downgrade1 ⇒ Object

Where a merchant is configured for 3DSv2, setting this option will attempt to downgrade the transaction to 3DSv1.



45
46
47
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 45

def downgrade1
  @downgrade1
end

#merchant_termurl ⇒ Object

A controller URL for 3D-Secure processing that any response from an authentication request or challenge request should be sent to. The controller should forward on the response from the URL back via this API for subsequent processing.



48
49
50
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 48

def merchant_termurl
  @merchant_termurl
end

#tds_policy ⇒ Object

A policy value which determines whether ThreeDSecure is enforced or bypassed. Note that this will only work for e-commerce transactions and accounts that have 3DSecure enabled and fully registered with Visa, MasterCard or American Express. It is useful when transactions may be wanted to bypass processing rules. Note that this may affect the liability shift of transactions and may occur a higher fee with the acquiring bank. Values are ‘0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions will be enabled for 3DS processing `2` to bypass. Transactions that are bypassed will switch off 3DS processing.



51
52
53
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 51

def tds_policy
  @tds_policy
end

#user_agent ⇒ Object

Required for 3DSv1. Optional if the ‘cp_bx` value is provided otherwise required 3Dv2 processing operating in browser authentication mode. The `cp_bx` value will override any value supplied to this field. The content of the HTTP user-agent header as sent to the merchant from the cardholder’s user agent. This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.



54
55
56
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 54

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



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
280
281
282
283
284
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 247

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 = CityPayApiClient.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



76
77
78
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 57

def self.attribute_map
  {
    :'accept_headers' => :'accept_headers',
    :'browser_color_depth' => :'browserColorDepth',
    :'browser_ip' => :'browserIP',
    :'browser_java_enabled' => :'browserJavaEnabled',
    :'browser_language' => :'browserLanguage',
    :'browser_screen_height' => :'browserScreenHeight',
    :'browser_screen_width' => :'browserScreenWidth',
    :'browser_tz' => :'browserTZ',
    :'cp_bx' => :'cp_bx',
    :'downgrade1' => :'downgrade1',
    :'merchant_termurl' => :'merchant_termurl',
    :'tds_policy' => :'tds_policy',
    :'user_agent' => :'user_agent'
  }
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 223

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



100
101
102
103
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 81

def self.openapi_types
  {
    :'accept_headers' => :'String',
    :'browser_color_depth' => :'String',
    :'browser_ip' => :'String',
    :'browser_java_enabled' => :'String',
    :'browser_language' => :'String',
    :'browser_screen_height' => :'String',
    :'browser_screen_width' => :'String',
    :'browser_tz' => :'String',
    :'cp_bx' => :'String',
    :'downgrade1' => :'Boolean',
    :'merchant_termurl' => :'String',
    :'tds_policy' => :'String',
    :'user_agent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accept_headers == o.accept_headers &&
      browser_color_depth == o.browser_color_depth &&
      browser_ip == o.browser_ip &&
      browser_java_enabled == o.browser_java_enabled &&
      browser_language == o.browser_language &&
      browser_screen_height == o.browser_screen_height &&
      browser_screen_width == o.browser_screen_width &&
      browser_tz == o.browser_tz &&
      cp_bx == o.cp_bx &&
      downgrade1 == o.downgrade1 &&
      merchant_termurl == o.merchant_termurl &&
      tds_policy == o.tds_policy &&
      user_agent == o.user_agent
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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 318

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


210
211
212
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 216

def hash
  [accept_headers, browser_color_depth, browser_ip, browser_java_enabled, browser_language, browser_screen_height, browser_screen_width, browser_tz, cp_bx, downgrade1, merchant_termurl, tds_policy, user_agent].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



175
176
177
178
179
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 175

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



294
295
296
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 294

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 300

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



288
289
290
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 288

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



183
184
185
186
 
# File 'lib/citypay_api_client/models/three_d_secure.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end