Class: CybridApiBank::TransfersBankApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransfersBankApi

Returns a new instance of TransfersBankApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_transfer(post_transfer_bank_model, opts = {}) ⇒ TransferBankModel

Create Transfer Creates a transfer. ## State | State | Description | |——-|————-| | storing | The Platform is storing the trade details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |——|————-| | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | refresh_required | The transfer’s associated external_bank_account needs to be reconnected via Plaid | | party_name_invalid | The transfer’s associated external bank account has an invalid party name | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | compliance_rejection | The transfer was rejected for compliance reasons | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | Required scope: transfers:execute

Parameters:

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

    the optional parameters

Returns:



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

def create_transfer(post_transfer_bank_model, opts = {})
  data, _status_code, _headers = create_transfer_with_http_info(post_transfer_bank_model, opts)
  data
end

#create_transfer_with_http_info(post_transfer_bank_model, opts = {}) ⇒ Array<(TransferBankModel, Integer, Hash)>

Create Transfer Creates a transfer. ## State | State | Description | |——-|————-| | storing | The Platform is storing the trade details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |——|————-| | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | refresh_required | The transfer&#39;s associated external_bank_account needs to be reconnected via Plaid | | party_name_invalid | The transfer&#39;s associated external bank account has an invalid party name | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | compliance_rejection | The transfer was rejected for compliance reasons | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | Required scope: transfers:execute

Parameters:

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

    the optional parameters

Returns:

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

    TransferBankModel 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/transfers_bank_api.rb', line 37

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

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

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

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

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

#get_transfer(transfer_guid, opts = {}) ⇒ TransferBankModel

Get Transfer Retrieves a transfer. Required scope: transfers:read

Parameters:

  • transfer_guid (String) —

    Identifier for the transfer.

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

    the optional parameters

Returns:



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

def get_transfer(transfer_guid, opts = {})
  data, _status_code, _headers = get_transfer_with_http_info(transfer_guid, opts)
  data
end

#get_transfer_with_http_info(transfer_guid, opts = {}) ⇒ Array<(TransferBankModel, Integer, Hash)>

Get Transfer Retrieves a transfer. Required scope: transfers:read

Parameters:

  • transfer_guid (String) —

    Identifier for the transfer.

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

    the optional parameters

Returns:

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

    TransferBankModel 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/transfers_bank_api.rb', line 105

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

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

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

#list_transfers(opts = {}) ⇒ TransferListBankModel

Get transfers list Retrieves a listing of transfers. Required scope: transfers: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 transfer_guids to list transfers for.

  • :transfer_type (String) —

    Comma separated transfer_types to list accounts for.

  • :bank_guid (String) —

    Comma separated bank_guids to list transfers for.

  • :customer_guid (String) —

    Comma separated customer_guids to list transfers for.

  • :account_guid (String) —

    Comma separated account_guids to list transfers for.

  • :state (String) —

    Comma separated states to list transfers for.

  • :side (String) —

    Comma separated sides to list transfers for.

  • :label (String) —

    Comma separated labels to list transfers for.

  • :created_at_gte (String) —

    Created at start date inclusive lower bound, ISO8601

  • :created_at_lt (String) —

    Created at end date exclusive upper bound, ISO8601.

  • :updated_at_gte (String) —

    Created at start date inclusive lower bound, ISO8601

  • :updated_at_lt (String) —

    Created at end date exclusive upper bound, ISO8601.

Returns:



171
172
173
174
 
# File 'lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb', line 171

def list_transfers(opts = {})
  data, _status_code, _headers = list_transfers_with_http_info(opts)
  data
end

#list_transfers_with_http_info(opts = {}) ⇒ Array<(TransferListBankModel, Integer, Hash)>

Get transfers list Retrieves a listing of transfers. Required scope: transfers: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 transfer_guids to list transfers for.

  • :transfer_type (String) —

    Comma separated transfer_types to list accounts for.

  • :bank_guid (String) —

    Comma separated bank_guids to list transfers for.

  • :customer_guid (String) —

    Comma separated customer_guids to list transfers for.

  • :account_guid (String) —

    Comma separated account_guids to list transfers for.

  • :state (String) —

    Comma separated states to list transfers for.

  • :side (String) —

    Comma separated sides to list transfers for.

  • :label (String) —

    Comma separated labels to list transfers for.

  • :created_at_gte (String) —

    Created at start date inclusive lower bound, ISO8601

  • :created_at_lt (String) —

    Created at end date exclusive upper bound, ISO8601.

  • :updated_at_gte (String) —

    Created at start date inclusive lower bound, ISO8601

  • :updated_at_lt (String) —

    Created at end date exclusive upper bound, ISO8601.

Returns:

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

    TransferListBankModel data, response status code and response headers



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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb', line 194

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

  # resource path
  local_var_path = '/api/transfers'

  # 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?
  query_params[:'transfer_type'] = opts[:'transfer_type'] if !opts[:'transfer_type'].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[:'account_guid'] = opts[:'account_guid'] if !opts[:'account_guid'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'side'] = opts[:'side'] if !opts[:'side'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?
  query_params[:'created_at_gte'] = opts[:'created_at_gte'] if !opts[:'created_at_gte'].nil?
  query_params[:'created_at_lt'] = opts[:'created_at_lt'] if !opts[:'created_at_lt'].nil?
  query_params[:'updated_at_gte'] = opts[:'updated_at_gte'] if !opts[:'updated_at_gte'].nil?
  query_params[:'updated_at_lt'] = opts[:'updated_at_lt'] if !opts[:'updated_at_lt'].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] || 'TransferListBankModel'

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

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