Class: OrbipayPaymentsapiClient::FundingAccounts

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/funding_accounts.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 ⇒ FundingAccounts

Returns a new instance of FundingAccounts.



100
101
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 100

def initialize
end

Instance Attribute Details

#aba_routing_number ⇒ String (readonly)

The ABA/Routing number for the bank account.

Returns:

  • (String) —

    The attribute aba_routing_number.



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

def aba_routing_number
  @aba_routing_number
end

#account_number ⇒ String (readonly)

The Account Number to get details of.

Returns:

  • (String) —

    The attribute account_number.



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

def 
  @account_number
end

#account_subtype ⇒ String (readonly)

The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account.

Returns:

  • (String) —

    The attribute account_subtype.



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

def 
  @account_subtype
end

#account_type ⇒ Array<String> (readonly)

The type of the funding account. This can take multiple values in the format key=value1&key=value2.…

Returns:

  • (Array<String>) —

    The attribute account_type.



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

def 
  @account_type
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/funding_accounts.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/funding_accounts.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/funding_accounts.rb', line 33

def id_customer
  @id_customer
end

#list ⇒ Array<FundingAccount> (readonly)

Returns The attribute list.

Returns:



5
6
7
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.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.



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

def page_size
  @page_size
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/funding_accounts.rb', line 29

def query_id
  @query_id
end

#status ⇒ Array<String> (readonly)

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

Returns:

  • (Array<String>) —

    The attribute status.



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

def status
  @status
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/funding_accounts.rb', line 25

def to_index
  @to_index
end

#total_results_count ⇒ String (readonly)

The total number of funding accounts of the customer matching the search criteria.

Returns:

  • (String) —

    The attribute total_results_count.



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

def total_results_count
  @total_results_count
end

#url ⇒ String (readonly)

This URL fetches the next or previous set of funding accounts, 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/funding_accounts.rb', line 17

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 61

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', 
    :'page_size' => :'page_size', 
    :'account_number' => :'account_number', 
    :'status' => :'status', 
    :'aba_routing_number' => :'aba_routing_number', 
    :'account_type' => :'account_type', 
    :'account_subtype' => :'account_subtype' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 81

def self.swagger_types
  {
    :'list' => :'Array<FundingAccount>',	
    :'total_results_count' => :'String',	
    :'has_more_results' => :'String',	
    :'url' => :'String',	
    :'from_index' => :'String',	
    :'to_index' => :'String',	
    :'query_id' => :'String',	
    :'id_customer' => :'String',	
    :'page_size' => :'String',	
    :'account_number' => :'String',	
    :'status' => :'Array<String>',	
    :'aba_routing_number' => :'String',	
    :'account_type' => :'Array<String>',	
    :'account_subtype' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 213

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 &&
      page_size == o.page_size &&
       == o. &&
      status == o.status &&
      aba_routing_number == o.aba_routing_number &&
       == o. &&
       == o.
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 267

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 346

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 246

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


233
234
235
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 233

def eql?(o)
  self == o
end

#find_by(filter_map) ⇒ FundingAccounts

Returns The Instance of FundingAccounts.

Parameters:

  • filter_map (Multimap) —

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

Returns:



120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 120

def find_by(filter_map)
    		aba_routing_number_values = filter_map["aba_routing_number"]
if (aba_routing_number_values != nil && aba_routing_number_values.length() > 0)
@aba_routing_number = aba_routing_number_values[aba_routing_number_values.length() - 1]
end
    		 = filter_map["account_type"]
if ( != nil && .length() > 0)
@account_type = ;
end
    		 = filter_map["account_subtype"]
if ( != nil && .length() > 0)
@account_subtype = [.length() - 1]
end
    		 = filter_map["account_number"]
if ( != nil && .length() > 0)
@account_number = [.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) ⇒ FundingAccounts

Returns The Instance of FundingAccounts.

Parameters:

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

    attribute in the form of String.

Returns:



106
107
108
109
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 106

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

#for_customer(id_customer: nil) ⇒ FundingAccounts

Returns The Instance of FundingAccounts.

Parameters:

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

    attribute in the form of String.

Returns:



163
164
165
166
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 163

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

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

Returns The Instance of FundingAccounts.

Returns:



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 177

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::RetrieveFundingAccountsHandler.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

#get_page(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ FundingAccounts

Returns The Instance of FundingAccounts.

Returns:



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 190

def get_page(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::RetrieveFundingAccountsPageHandler.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



239
240
241
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 239

def hash
  [list, total_results_count, has_more_results, url, from_index, to_index, query_id, id_customer, page_size, , status, aba_routing_number, , ].hash
end

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

Returns The Instance of FundingAccounts.

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:



171
172
173
174
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 171

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 



204
205
206
207
208
209
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 204

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



325
326
327
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 331

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



319
320
321
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 319

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ FundingAccounts

Returns The Instance of FundingAccounts.

Parameters:

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

    attribute in the form of String.

Returns:



113
114
115
116
 
# File 'lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb', line 113

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