Class: SyncteraRubySdk::ExternalCardVerifications

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/external_card_verifications.rb

Overview

Verify card passed AVS and CVV checks and if it able to perform PUSH/PULL transfers.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalCardVerifications

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
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
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 90

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

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

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

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

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

Instance Attribute Details

#address_verification_result ⇒ Object

Address verification results Status | Description — | — VERIFIED | AVS verified NOT_VERIFIED | AVS not verified ADDRESS_MISMATCH | ZIP code match, address no match ZIP_MISMATCH | Address match, ZIP code no match ADDRESS_AND_ZIP_MISMATCH | Address and ZIP code no match



20
21
22
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 20

def address_verification_result
  @address_verification_result
end

#cvv2_result ⇒ Object

Card Verification Value results Status | Description — | — VERIFIED | CVV and expiration date verified NOT_VERIFIED | CVV and expiration date not verified CVV_MISMATCH | Either CVV or expiration date does not match NOT_SUPPORTED | Issuer does not participate in CVV2 service



23
24
25
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 23

def cvv2_result
  @cvv2_result
end

#pull_enabled ⇒ Object

Indicates if the card is able to perform PULL transfers.



26
27
28
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 26

def pull_enabled
  @pull_enabled
end

#push_enabled ⇒ Object

Indicates if the card is able to perform PUSH transfers.



29
30
31
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 29

def push_enabled
  @push_enabled
end

#state ⇒ Object

Returns the value of attribute state.



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 31

def state
  @state
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 56

def self.attribute_map
  {
    :'address_verification_result' => :'address_verification_result',
    :'cvv2_result' => :'cvv2_result',
    :'pull_enabled' => :'pull_enabled',
    :'push_enabled' => :'push_enabled',
    :'state' => :'state'
  }
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



225
226
227
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 225

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 72

def self.openapi_types
  {
    :'address_verification_result' => :'String',
    :'cvv2_result' => :'String',
    :'pull_enabled' => :'Boolean',
    :'push_enabled' => :'Boolean',
    :'state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_verification_result == o.address_verification_result &&
      cvv2_result == o.cvv2_result &&
      pull_enabled == o.pull_enabled &&
      push_enabled == o.push_enabled &&
      state == o.state
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



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
285
286
287
288
289
290
291
292
293
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 256

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 327

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 232

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 218

def hash
  [address_verification_result, cvv2_result, pull_enabled, push_enabled, state].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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 126

def list_invalid_properties
  invalid_properties = Array.new
  if @address_verification_result.nil?
    invalid_properties.push('invalid value for "address_verification_result", address_verification_result cannot be nil.')
  end

  if @cvv2_result.nil?
    invalid_properties.push('invalid value for "cvv2_result", cvv2_result cannot be nil.')
  end

  if @pull_enabled.nil?
    invalid_properties.push('invalid value for "pull_enabled", pull_enabled cannot be nil.')
  end

  if @push_enabled.nil?
    invalid_properties.push('invalid value for "push_enabled", push_enabled cannot be nil.')
  end

  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  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



303
304
305
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 309

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



297
298
299
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 297

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/synctera_ruby_sdk/models/external_card_verifications.rb', line 153

def valid?
  return false if @address_verification_result.nil?
  address_verification_result_validator = EnumAttributeValidator.new('String', ["VERIFIED", "NOT_VERIFIED", "ADDRESS_MISMATCH", "ZIP_MISMATCH", "ADDRESS_AND_ZIP_MISMATCH"])
  return false unless address_verification_result_validator.valid?(@address_verification_result)
  return false if @cvv2_result.nil?
  cvv2_result_validator = EnumAttributeValidator.new('String', ["VERIFIED", "NOT_VERIFIED", "CVV_MISMATCH", "NOT_SUPPORTED"])
  return false unless cvv2_result_validator.valid?(@cvv2_result)
  return false if @pull_enabled.nil?
  return false if @push_enabled.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED"])
  return false unless state_validator.valid?(@state)
  true
end