Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::PaymentNetworkResponseVo

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentNetworkResponseVo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 26

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.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 30

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.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 34

def payment_response_msg
  @payment_response_msg
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 37

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.



46
47
48
49
50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 46

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.

Parameters:

  • o (Object) —

    Object to be compared



86
87
88
89
90
91
92
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 86

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



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
172
173
174
175
176
177
178
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 130

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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 209

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 109

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

Parameters:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


96
97
98
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 96

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 102

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

#set_values(args) ⇒ Object 



76
77
78
79
80
81
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 76

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



188
189
190
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 188

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



194
195
196
197
198
199
200
201
202
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 194

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



182
183
184
 
# File 'lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb', line 182

def to_s
  to_hash.to_s
end