Class: SyncteraRubySdk::RemoteCheckDepositBetaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RemoteCheckDepositBetaApi

Returns a new instance of RemoteCheckDepositBetaApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_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/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_rdc_deposit(opts = {}) ⇒ DepositGet

Create a Remote Check Deposit Create a new deposit using remote deposit capture to an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deposit_post (DepositPost) —

    Attributes of the Remote Check Deposit to create

Returns:



27
28
29
30
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 27

def create_rdc_deposit(opts = {})
  data, _status_code, _headers = create_rdc_deposit_with_http_info(opts)
  data
end

#create_rdc_deposit_with_http_info(opts = {}) ⇒ Array<(DepositGet, Integer, Hash)>

Create a Remote Check Deposit Create a new deposit using remote deposit capture to an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deposit_post (DepositPost) —

    Attributes of the Remote Check Deposit to create

Returns:

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

    DepositGet 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
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 37

def create_rdc_deposit_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemoteCheckDepositBetaApi.create_rdc_deposit ...'
  end
  # resource path
  local_var_path = '/rdc/deposits'

  # 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', 'application/problem+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(opts[:'deposit_post'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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

#get_rdc_deposit(deposit_id, opts = {}) ⇒ DepositGet

Get Remote Check Deposit Retrieves one deposit made using remote deposit capture associated with an account

Parameters:

  • deposit_id (String) —

    ID of a deposit for a remote deposit capture

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 91

def get_rdc_deposit(deposit_id, opts = {})
  data, _status_code, _headers = get_rdc_deposit_with_http_info(deposit_id, opts)
  data
end

#get_rdc_deposit_with_http_info(deposit_id, opts = {}) ⇒ Array<(DepositGet, Integer, Hash)>

Get Remote Check Deposit Retrieves one deposit made using remote deposit capture associated with an account

Parameters:

  • deposit_id (String) —

    ID of a deposit for a remote deposit capture

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

    the optional parameters

Returns:

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

    DepositGet data, response status code and response headers



101
102
103
104
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
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 101

def get_rdc_deposit_with_http_info(deposit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemoteCheckDepositBetaApi.get_rdc_deposit ...'
  end
  # verify the required parameter 'deposit_id' is set
  if @api_client.config.client_side_validation && deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_id' when calling RemoteCheckDepositBetaApi.get_rdc_deposit"
  end
  # resource path
  local_var_path = '/rdc/deposits/{deposit_id}'.sub('{' + 'deposit_id' + '}', CGI.escape(deposit_id.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', 'application/problem+json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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

#list_rdc_deposits(opts = {}) ⇒ DepositList

List Remote Check Deposits Retrieves a paginated list of the deposits made using remote deposit capture associated with an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Unique identifier for the account.

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:



156
157
158
159
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 156

def list_rdc_deposits(opts = {})
  data, _status_code, _headers = list_rdc_deposits_with_http_info(opts)
  data
end

#list_rdc_deposits_with_http_info(opts = {}) ⇒ Array<(DepositList, Integer, Hash)>

List Remote Check Deposits Retrieves a paginated list of the deposits made using remote deposit capture associated with an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Unique identifier for the account.

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:

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

    DepositList 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
215
216
217
 
# File 'lib/synctera_ruby_sdk/api/remote_check_deposit_beta_api.rb', line 168

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

  # resource path
  local_var_path = '/rdc/deposits'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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