Class: CybridApiBank::ExternalWalletsBankApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExternalWalletsBankApi

Returns a new instance of ExternalWalletsBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/external_wallets_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/external_wallets_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_external_wallet(post_external_wallet_bank_model, opts = {}) ⇒ ExternalWalletBankModel

Create ExternalWallet Create an ExternalWallet. ## Wallet creation External Wallets can be created for a Bank or a Customer. To create a wallet for your Bank, omit the ‘customer_guid` parameter in the request body. To create a wallet for your Customers, include the `customer_guid` parameter in the request body. ## State | State | Description | |——-|————-| | storing | The Platform is storing the external wallet details in our private store | | pending | The Platform is waiting for the external wallet to be created | | completed | The Platform has created the external wallet | | failed | The Platform was not able to successfully create the external wallet | | deleting | The Platform is deleting the external wallet | | deleted | The Platform has deleted the external wallet | External wallets can be added to the bank by leaving the customer_guid blank. External wallets added to the bank can be used by any customer of the bank. External wallets can also be added to a specific customer by providing the customer_guid. External wallets added to a customer can only be used by that customer. Required scope: external_wallets:execute

Parameters:

Returns:



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

def create_external_wallet(post_external_wallet_bank_model, opts = {})
  data, _status_code, _headers = create_external_wallet_with_http_info(post_external_wallet_bank_model, opts)
  data
end

#create_external_wallet_with_http_info(post_external_wallet_bank_model, opts = {}) ⇒ Array<(ExternalWalletBankModel, Integer, Hash)>

Create ExternalWallet Create an ExternalWallet. ## Wallet creation External Wallets can be created for a Bank or a Customer. To create a wallet for your Bank, omit the &#x60;customer_guid&#x60; parameter in the request body. To create a wallet for your Customers, include the &#x60;customer_guid&#x60; parameter in the request body. ## State | State | Description | |——-|————-| | storing | The Platform is storing the external wallet details in our private store | | pending | The Platform is waiting for the external wallet to be created | | completed | The Platform has created the external wallet | | failed | The Platform was not able to successfully create the external wallet | | deleting | The Platform is deleting the external wallet | | deleted | The Platform has deleted the external wallet | External wallets can be added to the bank by leaving the customer_guid blank. External wallets added to the bank can be used by any customer of the bank. External wallets can also be added to a specific customer by providing the customer_guid. External wallets added to a customer can only be used by that customer. Required scope: external_wallets:execute

Parameters:

Returns:

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

    ExternalWalletBankModel 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/external_wallets_bank_api.rb', line 37

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

  # 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_external_wallet_bank_model)

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

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

  new_options = opts.merge(
    :operation => :"ExternalWalletsBankApi.create_external_wallet",
    :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: ExternalWalletsBankApi#create_external_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_external_wallet(external_wallet_guid, opts = {}) ⇒ ExternalWalletBankModel

Delete External Wallet Deletes an external wallet. Required scope: external_wallets:execute

Parameters:

  • external_wallet_guid (String) —

    Identifier for the external wallet.

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

    the optional parameters

Returns:



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

def delete_external_wallet(external_wallet_guid, opts = {})
  data, _status_code, _headers = delete_external_wallet_with_http_info(external_wallet_guid, opts)
  data
end

#delete_external_wallet_with_http_info(external_wallet_guid, opts = {}) ⇒ Array<(ExternalWalletBankModel, Integer, Hash)>

Delete External Wallet Deletes an external wallet. Required scope: external_wallets:execute

Parameters:

  • external_wallet_guid (String) —

    Identifier for the external wallet.

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

    the optional parameters

Returns:

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

    ExternalWalletBankModel 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/external_wallets_bank_api.rb', line 105

def delete_external_wallet_with_http_info(external_wallet_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalWalletsBankApi.delete_external_wallet ...'
  end
  # verify the required parameter 'external_wallet_guid' is set
  if @api_client.config.client_side_validation && external_wallet_guid.nil?
    fail ArgumentError, "Missing the required parameter 'external_wallet_guid' when calling ExternalWalletsBankApi.delete_external_wallet"
  end
  # resource path
  local_var_path = '/api/external_wallets/{external_wallet_guid}'.sub('{' + 'external_wallet_guid' + '}', CGI.escape(external_wallet_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] || 'ExternalWalletBankModel'

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

  new_options = opts.merge(
    :operation => :"ExternalWalletsBankApi.delete_external_wallet",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExternalWalletsBankApi#delete_external_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_external_wallet(external_wallet_guid, opts = {}) ⇒ ExternalWalletBankModel

Get External Wallet Retrieves an external_wallet. Required scope: external_wallets:read

Parameters:

  • external_wallet_guid (String) —

    Identifier for the external_wallet.

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb', line 158

def get_external_wallet(external_wallet_guid, opts = {})
  data, _status_code, _headers = get_external_wallet_with_http_info(external_wallet_guid, opts)
  data
end

#get_external_wallet_with_http_info(external_wallet_guid, opts = {}) ⇒ Array<(ExternalWalletBankModel, Integer, Hash)>

Get External Wallet Retrieves an external_wallet. Required scope: external_wallets:read

Parameters:

  • external_wallet_guid (String) —

    Identifier for the external_wallet.

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

    the optional parameters

Returns:

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

    ExternalWalletBankModel data, response status code and response headers



168
169
170
171
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
 
# File 'lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb', line 168

def get_external_wallet_with_http_info(external_wallet_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalWalletsBankApi.get_external_wallet ...'
  end
  # verify the required parameter 'external_wallet_guid' is set
  if @api_client.config.client_side_validation && external_wallet_guid.nil?
    fail ArgumentError, "Missing the required parameter 'external_wallet_guid' when calling ExternalWalletsBankApi.get_external_wallet"
  end
  # resource path
  local_var_path = '/api/external_wallets/{external_wallet_guid}'.sub('{' + 'external_wallet_guid' + '}', CGI.escape(external_wallet_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] || 'ExternalWalletBankModel'

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

  new_options = opts.merge(
    :operation => :"ExternalWalletsBankApi.get_external_wallet",
    :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: ExternalWalletsBankApi#get_external_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_external_wallets(opts = {}) ⇒ ExternalWalletListBankModel

Get external wallets list Retrieves a listing of external wallets. Required scope: external_wallets: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.

  • :owner (String) —

    The owner of the entity.

  • :guid (String) —

    Comma separated external_wallet_guids to list external_wallets for.

  • :bank_guid (String) —

    Comma separated bank_guids to list external_wallets for.

  • :customer_guid (String) —

    Comma separated customer_guids to list external_wallets for.

  • :asset (String) —

    Comma separated assets to list external_wallets for.

  • :state (String) —

    Comma separated states to list external_wallets for.

Returns:



228
229
230
231
 
# File 'lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb', line 228

def list_external_wallets(opts = {})
  data, _status_code, _headers = list_external_wallets_with_http_info(opts)
  data
end

#list_external_wallets_with_http_info(opts = {}) ⇒ Array<(ExternalWalletListBankModel, Integer, Hash)>

Get external wallets list Retrieves a listing of external wallets. Required scope: external_wallets: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.

  • :owner (String) —

    The owner of the entity.

  • :guid (String) —

    Comma separated external_wallet_guids to list external_wallets for.

  • :bank_guid (String) —

    Comma separated bank_guids to list external_wallets for.

  • :customer_guid (String) —

    Comma separated customer_guids to list external_wallets for.

  • :asset (String) —

    Comma separated assets to list external_wallets for.

  • :state (String) —

    Comma separated states to list external_wallets for.

Returns:

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

    ExternalWalletListBankModel data, response status code and response headers



245
246
247
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
304
305
306
307
 
# File 'lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb', line 245

def list_external_wallets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalWalletsBankApi.list_external_wallets ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ExternalWalletsBankApi.list_external_wallets, 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 ExternalWalletsBankApi.list_external_wallets, 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 ExternalWalletsBankApi.list_external_wallets, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/external_wallets'

  # 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[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'asset'] = opts[:'asset'] if !opts[:'asset'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].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] || 'ExternalWalletListBankModel'

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

  new_options = opts.merge(
    :operation => :"ExternalWalletsBankApi.list_external_wallets",
    :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: ExternalWalletsBankApi#list_external_wallets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end