Class: OrbipayPaymentsapiClient::PaymentNetworkResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PaymentNetworkResponse

Returns a new instance of PaymentNetworkResponse.



35
36
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 35

def initialize
end

Instance Attribute Details

#payment_auth_code ⇒ String (readonly)

The Auth Code returned by the card gateway. This is relevant only for card payments.

Returns:

  • (String) —

    The attribute payment_auth_code.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 6

def payment_auth_code
  @payment_auth_code
end

#payment_response_code ⇒ String (readonly)

This is the ACH return code in the case of a returned payment over the NACHA ACH network. In the case of declined card payment, it's the decline code received from the card issuer or the card processor. In the case of a card chargeback, it's the chargeback code received from the card network.

Returns:

  • (String) —

    The attribute payment_response_code.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 10

def payment_response_code
  @payment_response_code
end

#payment_response_msg ⇒ String (readonly)

The text describing the appropriate code captured in the payment_response_code as received from the corresponding payment network.

Returns:

  • (String) —

    The attribute payment_response_msg.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 14

def payment_response_msg
  @payment_response_msg
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 18

def self.attribute_map
  {
    :'payment_auth_code' => :'payment_auth_code', 
    :'payment_response_code' => :'payment_response_code', 
    :'payment_response_msg' => :'payment_response_msg' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



27
28
29
30
31
32
33
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 27

def self.swagger_types
  {
    :'payment_auth_code' => :'String',	
    :'payment_response_code' => :'String',	
    :'payment_response_msg' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



50
51
52
53
54
55
56
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 50

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_auth_code == o.payment_auth_code &&
      payment_response_code == o.payment_response_code &&
      payment_response_msg == o.payment_response_msg
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 93

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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 = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 172

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 72

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)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(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

Returns:

  • (Boolean)

See Also:

  • `==` method


59
60
61
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 59

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



65
66
67
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 65

def hash
  [payment_auth_code, payment_response_code, payment_response_msg].hash
end

#set_values(args) ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 41

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 151

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



157
158
159
160
161
162
163
164
165
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 157

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



145
146
147
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb', line 145

def to_s
  to_hash.to_s
end