Class: CybridApiBank::BanksBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/banks_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BanksBankApi

Returns a new instance of BanksBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bank(post_bank_bank_model, opts = {}) ⇒ BankBankModel

Create Bank Creates a bank. ## Bank Type Bank’s can be created in either ‘sandbox` or `production` mode. Sandbox Banks will not transact in real fiat dollars or cryptocurrencies. Via the API, only `sandbox` banks can be created. In order to enable a `production` bank please contact [Support]([email protected]). ## Attestation Identity Records Attestation Identity Records is a method the Cybrid Platform uses to verify the identity of a Bank’s customers. Please see the documentation under the create Identity Record API for more technical detail. This feature must specifically be enabled in the Bank’s ‘features` array by including the `attestation_identity_records` flag. At present, attestation identity records is the supported method for verifying a customer’s identity on the platform. Please contact [Support]([email protected]) to inquire about enabling this option for your Organization. Required scope: banks:execute

Parameters:

  • post_bank_bank_model (PostBankBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 27

def create_bank(post_bank_bank_model, opts = {})
  data, _status_code, _headers = create_bank_with_http_info(post_bank_bank_model, opts)
  data
end

#create_bank_with_http_info(post_bank_bank_model, opts = {}) ⇒ Array<(BankBankModel, Integer, Hash)>

Create Bank Creates a bank. ## Bank Type Bank&#39;s can be created in either &#x60;sandbox&#x60; or &#x60;production&#x60; mode. Sandbox Banks will not transact in real fiat dollars or cryptocurrencies. Via the API, only &#x60;sandbox&#x60; banks can be created. In order to enable a &#x60;production&#x60; bank please contact [Support]([email protected]). ## Attestation Identity Records Attestation Identity Records is a method the Cybrid Platform uses to verify the identity of a Bank&#39;s customers. Please see the documentation under the create Identity Record API for more technical detail. This feature must specifically be enabled in the Bank&#39;s &#x60;features&#x60; array by including the &#x60;attestation_identity_records&#x60; flag. At present, attestation identity records is the supported method for verifying a customer&#39;s identity on the platform. Please contact [Support]([email protected]) to inquire about enabling this option for your Organization. Required scope: banks:execute

Parameters:

  • post_bank_bank_model (PostBankBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BankBankModel, Integer, Hash)>) —

    BankBankModel data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 37

def create_bank_with_http_info(post_bank_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksBankApi.create_bank ...'
  end
  # verify the required parameter 'post_bank_bank_model' is set
  if @api_client.config.client_side_validation && post_bank_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_bank_bank_model' when calling BanksBankApi.create_bank"
  end
  # resource path
  local_var_path = '/api/banks'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_bank_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'BankBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"BanksBankApi.create_bank",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BanksBankApi#create_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank(bank_guid, opts = {}) ⇒ BankBankModel

Get Bank Retrieves a bank. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 95

def get_bank(bank_guid, opts = {})
  data, _status_code, _headers = get_bank_with_http_info(bank_guid, opts)
  data
end

#get_bank_with_http_info(bank_guid, opts = {}) ⇒ Array<(BankBankModel, Integer, Hash)>

Get Bank Retrieves a bank. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Returns:

  • (Array<(BankBankModel, Integer, Hash)>) —

    BankBankModel data, response status code and response headers



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
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 105

def get_bank_with_http_info(bank_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksBankApi.get_bank ...'
  end
  # verify the required parameter 'bank_guid' is set
  if @api_client.config.client_side_validation && bank_guid.nil?
    fail ArgumentError, "Missing the required parameter 'bank_guid' when calling BanksBankApi.get_bank"
  end
  # resource path
  local_var_path = '/api/banks/{bank_guid}'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BankBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"BanksBankApi.get_bank",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BanksBankApi#get_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_banks(opts = {}) ⇒ BankListBankModel

Get banks list Retrieves a listing of bank. Required scope: banks:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated bank_guids to list banks for.

Returns:



160
161
162
163
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 160

def list_banks(opts = {})
  data, _status_code, _headers = list_banks_with_http_info(opts)
  data
end

#list_banks_with_http_info(opts = {}) ⇒ Array<(BankListBankModel, Integer, Hash)>

Get banks list Retrieves a listing of bank. Required scope: banks:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated bank_guids to list banks for.

Returns:

  • (Array<(BankListBankModel, Integer, Hash)>) —

    BankListBankModel data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
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
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 172

def list_banks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksBankApi.list_banks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling BanksBankApi.list_banks, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling BanksBankApi.list_banks, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling BanksBankApi.list_banks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/banks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BankListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"BanksBankApi.list_banks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BanksBankApi#list_banks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bank(bank_guid, patch_bank_bank_model, opts = {}) ⇒ BankBankModel

Patch Bank Update a bank. Required scope: banks:write

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

  • patch_bank_bank_model (PatchBankBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 237

def update_bank(bank_guid, patch_bank_bank_model, opts = {})
  data, _status_code, _headers = update_bank_with_http_info(bank_guid, patch_bank_bank_model, opts)
  data
end

#update_bank_with_http_info(bank_guid, patch_bank_bank_model, opts = {}) ⇒ Array<(BankBankModel, Integer, Hash)>

Patch Bank Update a bank. Required scope: banks:write

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

  • patch_bank_bank_model (PatchBankBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BankBankModel, Integer, Hash)>) —

    BankBankModel data, response status code and response headers



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
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
 
# File 'lib/cybrid_api_bank_ruby/api/banks_bank_api.rb', line 248

def update_bank_with_http_info(bank_guid, patch_bank_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksBankApi.update_bank ...'
  end
  # verify the required parameter 'bank_guid' is set
  if @api_client.config.client_side_validation && bank_guid.nil?
    fail ArgumentError, "Missing the required parameter 'bank_guid' when calling BanksBankApi.update_bank"
  end
  # verify the required parameter 'patch_bank_bank_model' is set
  if @api_client.config.client_side_validation && patch_bank_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'patch_bank_bank_model' when calling BanksBankApi.update_bank"
  end
  # resource path
  local_var_path = '/api/banks/{bank_guid}'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_bank_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'BankBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"BanksBankApi.update_bank",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BanksBankApi#update_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end