Class: AdvancedBilling::ChjsTokenizationFailure

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/chjs_tokenization_failure.rb

Overview

ChjsTokenizationFailure Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #get_additional_properties, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(errors:, payment_profile_params: SKIP, additional_properties: {}) ⇒ ChjsTokenizationFailure

Returns a new instance of ChjsTokenizationFailure.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 41

def initialize(errors:, payment_profile_params: SKIP,
               additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @errors = errors
  @payment_profile_params = payment_profile_params unless payment_profile_params == SKIP
end

Instance Attribute Details

#errors ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 14

def errors
  @errors
end

#payment_profile_params ⇒ PaymentProfileParams

PCI-safe cardholder fields only. Full card numbers, CVV, and billing address are never included.

Returns:



19
20
21
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 19

def payment_profile_params
  @payment_profile_params
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  errors = hash.key?('errors') ? hash['errors'] : nil
  payment_profile_params = PaymentProfileParams.from_hash(hash['payment_profile_params']) if
    hash['payment_profile_params']

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  ChjsTokenizationFailure.new(errors: errors,
                              payment_profile_params: payment_profile_params,
                              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['errors'] = 'errors'
  @_hash['payment_profile_params'] = 'payment_profile_params'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 30

def self.optionals
  %w[
    payment_profile_params
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 72

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.errors,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['errors'],
                        ->(val) { val.instance_of? String })
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 92

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} errors: #{@errors.inspect}, payment_profile_params:"\
  " #{@payment_profile_params.inspect}, additional_properties: #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



85
86
87
88
89
 
# File 'lib/advanced_billing/models/chjs_tokenization_failure.rb', line 85

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} errors: #{@errors}, payment_profile_params: #{@payment_profile_params},"\
  " additional_properties: #{get_additional_properties}>"
end