Class: OrbipayPaymentsapiClient::Payments

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

Instance Attribute Summary collapse

Attributes inherited from Base

#api_end_point, #http_status_code, #invocation_context, #live_mode

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#requested_by, #set_api_end_point, #with_context

Constructor Details

#initialize ⇒ Payments

Returns a new instance of Payments.



118
119
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 118

def initialize
end

Instance Attribute Details

#confirmation_number ⇒ String (readonly)

The confirmation number or reference provided to the customer for the successful payment.

Returns:

  • (String) —

    The attribute confirmation_number.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 45

def confirmation_number
  @confirmation_number
end

#from_date ⇒ String (readonly)

The date from which payments, matching the criteria specified, need to be retrieved.

Returns:

  • (String) —

    The attribute from_date.



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 61

def from_date
  @from_date
end

#from_index ⇒ String (readonly)

The id of the object before which the previous set of objects are to be retrieved.

Returns:

  • (String) —

    The attribute from_index.



21
22
23
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 21

def from_index
  @from_index
end

#has_more_results ⇒ String (readonly)

true if there are more results or pages

Returns:

  • (String) —

    The attribute has_more_results.



13
14
15
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 13

def has_more_results
  @has_more_results
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 33

def id_customer
  @id_customer
end

#id_customer_account ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer account

Returns:

  • (String) —

    The attribute id_customer_account.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 41

def 
  @id_customer_account
end

#id_funding_account ⇒ String (readonly)

The unique identifier assigned by EBPP to the funding account

Returns:

  • (String) —

    The attribute id_funding_account.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 37

def 
  @id_funding_account
end

#list ⇒ Array<Payment> (readonly)

Returns The attribute list.

Returns:

  • (Array<Payment>) —

    The attribute list.



5
6
7
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 5

def list
  @list
end

#page_size ⇒ String (readonly)

The maximum number of objects returned in the query.

Returns:

  • (String) —

    The attribute page_size.



69
70
71
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 69

def page_size
  @page_size
end

#payment_method ⇒ Array<String> (readonly)

The fulfillment method for the payment.

Returns:

  • (Array<String>) —

    The attribute payment_method.



57
58
59
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 57

def payment_method
  @payment_method
end

#payment_schedule_type ⇒ Array<String> (readonly)

The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.…

Returns:

  • (Array<String>) —

    The attribute payment_schedule_type.



53
54
55
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 53

def payment_schedule_type
  @payment_schedule_type
end

#query_id ⇒ String (readonly)

The query id of the object.

Returns:

  • (String) —

    The attribute query_id.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 29

def query_id
  @query_id
end

#status ⇒ Array<String> (readonly)

The status of the payment. This can take multiple values in the format key=value1&key=value2.…

Returns:

  • (Array<String>) —

    The attribute status.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 49

def status
  @status
end

#to_date ⇒ String (readonly)

The date upto which payments, matching the criteria specified, need to be retrieved.

Returns:

  • (String) —

    The attribute to_date.



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

def to_date
  @to_date
end

#to_index ⇒ String (readonly)

The id of the object after which the next set of objects are to be retrieved.

Returns:

  • (String) —

    The attribute to_index.



25
26
27
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 25

def to_index
  @to_index
end

#total_results_count ⇒ String (readonly)

total number of payments available with matching criteria

Returns:

  • (String) —

    The attribute total_results_count.



9
10
11
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 9

def total_results_count
  @total_results_count
end

#url ⇒ String (readonly)

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

Returns:

  • (String) —

    The attribute url.



17
18
19
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 17

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 73

def self.attribute_map
  {
    :'list' => :'list', 
    :'total_results_count' => :'total_results_count', 
    :'has_more_results' => :'has_more_results', 
    :'url' => :'url', 
    :'from_index' => :'from_index', 
    :'to_index' => :'to_index', 
    :'query_id' => :'query_id', 
    :'id_customer' => :'id_customer', 
    :'id_funding_account' => :'id_funding_account', 
    :'id_customer_account' => :'id_customer_account', 
    :'confirmation_number' => :'confirmation_number', 
    :'status' => :'status', 
    :'payment_schedule_type' => :'payment_schedule_type', 
    :'payment_method' => :'payment_method', 
    :'from_date' => :'from_date', 
    :'to_date' => :'to_date', 
    :'page_size' => :'page_size' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 96

def self.swagger_types
  {
    :'list' => :'Array<Payment>',	
    :'total_results_count' => :'String',	
    :'has_more_results' => :'String',	
    :'url' => :'String',	
    :'from_index' => :'String',	
    :'to_index' => :'String',	
    :'query_id' => :'String',	
    :'id_customer' => :'String',	
    :'id_funding_account' => :'String',	
    :'id_customer_account' => :'String',	
    :'confirmation_number' => :'String',	
    :'status' => :'Array<String>',	
    :'payment_schedule_type' => :'Array<String>',	
    :'payment_method' => :'Array<String>',	
    :'from_date' => :'String',	
    :'to_date' => :'String',	
    :'page_size' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      list == o.list &&
      total_results_count == o.total_results_count &&
      has_more_results == o.has_more_results &&
      url == o.url &&
      from_index == o.from_index &&
      to_index == o.to_index &&
      query_id == o.query_id &&
      id_customer == o.id_customer &&
       == o. &&
       == o. &&
      confirmation_number == o.confirmation_number &&
      status == o.status &&
      payment_schedule_type == o.payment_schedule_type &&
      payment_method == o.payment_method &&
      from_date == o.from_date &&
      to_date == o.to_date &&
      page_size == o.page_size
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 283

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 362

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 262

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


249
250
251
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 249

def eql?(o)
  self == o
end

#find_by(filter_map) ⇒ Payments

Returns The Instance of Payments.

Parameters:

  • filter_map (Multimap) —

    attribute in the form of MultiMap with key and values as string.

Returns:

  • (Payments) —

    The Instance of Payments.



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
179
180
181
182
183
184
185
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 138

def find_by(filter_map)
    		 = filter_map["id_funding_account"]
if ( != nil && .length() > 0)
@id_funding_account = [.length() - 1]
end
    		 = filter_map["id_customer_account"]
if ( != nil && .length() > 0)
@id_customer_account = [.length() - 1]
end
    		confirmation_number_values = filter_map["confirmation_number"]
if (confirmation_number_values != nil && confirmation_number_values.length() > 0)
@confirmation_number = confirmation_number_values[confirmation_number_values.length() - 1]
end
    		payment_schedule_type_values = filter_map["payment_schedule_type"]
if (payment_schedule_type_values != nil && payment_schedule_type_values.length() > 0)
@payment_schedule_type = payment_schedule_type_values;
end
    		from_date_values = filter_map["from_date"]
if (from_date_values != nil && from_date_values.length() > 0)
@from_date = from_date_values[from_date_values.length() - 1]
end
    		to_date_values = filter_map["to_date"]
if (to_date_values != nil && to_date_values.length() > 0)
@to_date = to_date_values[to_date_values.length() - 1]
end
    		status_values = filter_map["status"]
if (status_values != nil && status_values.length() > 0)
@status = status_values;
end
    		page_size_values = filter_map["page_size"]
if (page_size_values != nil && page_size_values.length() > 0)
@page_size = page_size_values[page_size_values.length() - 1]
end
    		query_id_values = filter_map["query_id"]
if (query_id_values != nil && query_id_values.length() > 0)
@query_id = query_id_values[query_id_values.length() - 1]
end
    		from_index_values = filter_map["from_index"]
if (from_index_values != nil && from_index_values.length() > 0)
@from_index = from_index_values[from_index_values.length() - 1]
end
    		to_index_values = filter_map["to_index"]
if (to_index_values != nil && to_index_values.length() > 0)
@to_index = to_index_values[to_index_values.length() - 1]
end

    self 
end

#for_client(client_key: nil) ⇒ Payments

Returns The Instance of Payments.

Parameters:

  • client_key (String) (defaults to: nil) —

    attribute in the form of String.

Returns:

  • (Payments) —

    The Instance of Payments.



124
125
126
127
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 124

def for_client(client_key: nil)
    super(client_key: client_key)
    self 
end

#for_customer(id_customer: nil) ⇒ Payments

Returns The Instance of Payments.

Parameters:

  • id_customer (String) (defaults to: nil) —

    attribute in the form of String.

Returns:

  • (Payments) —

    The Instance of Payments.



189
190
191
192
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 189

def for_customer(id_customer: nil)
    @id_customer = id_customer
    self 
end

#get(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Payments

Returns The Instance of Payments.

Returns:

  • (Payments) —

    The Instance of Payments.



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 203

def get(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::RetrievePaymentsHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 255

def hash
  [list, total_results_count, has_more_results, url, from_index, to_index, query_id, id_customer, , , confirmation_number, status, payment_schedule_type, payment_method, from_date, to_date, page_size].hash
end

#retrieved_by(requestor: nil, requestor_type: nil) ⇒ Payments

Returns The Instance of Payments.

Parameters:

  • requestor (String) (defaults to: nil) —

    attribute in the form of String.

  • requestor_type (String) (defaults to: nil) —

    attribute in the form of String.

Returns:

  • (Payments) —

    The Instance of Payments.



197
198
199
200
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 197

def retrieved_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#set_values(args) ⇒ Object 



217
218
219
220
221
222
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 217

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



341
342
343
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 341

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



347
348
349
350
351
352
353
354
355
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 347

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



335
336
337
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 335

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ Payments

Returns The Instance of Payments.

Parameters:

  • channel (String) (defaults to: nil) —

    attribute in the form of String.

Returns:

  • (Payments) —

    The Instance of Payments.



131
132
133
134
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payments.rb', line 131

def vide_channel(channel: nil)
    super(channel: channel)
    self 
end