Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::CreatePaymentAuthorizationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.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 = {}) ⇒ CreatePaymentAuthorizationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
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
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 82

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_reference')
    self.payment_auth_reference = attributes[:'payment_auth_reference']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'custom_fields')
    if (value = attributes[:'custom_fields']).is_a?(Hash)
      self.custom_fields = value
    end
  end
end

Instance Attribute Details

#auth_amount ⇒ String (readonly)

The amount being authorized.

Returns:

  • (String) —

    The attribute auth_amount.



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

def auth_amount
  @auth_amount
end

#card_cvv_number ⇒ String (readonly)

Returns The attribute card_cvv_number.

Returns:

  • (String) —

    The attribute card_cvv_number.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 33

def card_cvv_number
  @card_cvv_number
end

#comments ⇒ String (readonly)

Comments that can be used to recollect the operation performed on the resource object.

Returns:

  • (String) —

    The attribute comments.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 46

def comments
  @comments
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 50

def custom_fields
  @custom_fields
end

#customer ⇒ PaymentAuthCustomerRequest (readonly)

Returns The attribute customer.

Returns:



36
37
38
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 36

def customer
  @customer
end

#customer_account ⇒ PaymentAuthCustomerAccountRequest (readonly)

Returns The attribute customer_account.

Returns:



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 42

def 
  @customer_account
end

#funding_account ⇒ PaymentAuthFundingAccountRequest (readonly)

Returns The attribute funding_account.

Returns:



39
40
41
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 39

def 
  @funding_account
end

#payment_auth_reference ⇒ String (readonly)

The unique identifier in the client system for the payment authorization. This is mandatory in case of voyager fleet card payment.

Returns:

  • (String) —

    The attribute payment_auth_reference.



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

def payment_auth_reference
  @payment_auth_reference
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 53

def self.attribute_map
  {
    :'payment_auth_reference' => :'payment_auth_reference',
    :'auth_amount' => :'auth_amount',
    :'card_cvv_number' => :'card_cvv_number',
    :'customer' => :'customer',
    :'funding_account' => :'funding_account',
    :'customer_account' => :'customer_account',
    :'comments' => :'comments',
    :'custom_fields' => :'custom_fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 67

def self.swagger_types
  {
    :'payment_auth_reference' => :'String',
    :'auth_amount' => :'String',
    :'card_cvv_number' => :'String',
    :'customer' => :'PaymentAuthCustomerRequest',
    :'funding_account' => :'PaymentAuthFundingAccountRequest',
    :'customer_account' => :'PaymentAuthCustomerAccountRequest',
    :'comments' => :'String',
    :'custom_fields' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_auth_reference == o.payment_auth_reference &&
      auth_amount == o.auth_amount &&
      card_cvv_number == o.card_cvv_number &&
      customer == o.customer &&
       == o. &&
       == o. &&
      comments == o.comments &&
      custom_fields == o.custom_fields
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 183

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 262

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 162

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


149
150
151
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 155

def hash
  [payment_auth_reference, auth_amount, card_cvv_number, customer, , , comments, custom_fields].hash
end

#set_values(args) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 124

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



241
242
243
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 247

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



235
236
237
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_authorization_request.rb', line 235

def to_s
  to_hash.to_s
end