Class: CybridApiBank::FilesBankApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FilesBankApi

Returns a new instance of FilesBankApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_file(post_file_bank_model, opts = {}) ⇒ PlatformFileBankModel

Create File Creates a file. #### This feature is currently in preview mode and is not yet available for partner use. ## Data The attribute contains the base64 encoded file content. The value needs to be smaller than 10MB otherwise the Platform will reject the request. To upload files larger than 10MB do not provide the content and use the returned upload URL to provide the file. ## State | State | Description | |——-|————-| | storing | The Platform is storing the file in our private store | | completed | The Platform has completed storing the file | | failed | The Platform failed to store the file | Required scope: files:execute

Parameters:

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

    the optional parameters

Returns:



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

def create_file(post_file_bank_model, opts = {})
  data, _status_code, _headers = create_file_with_http_info(post_file_bank_model, opts)
  data
end

#create_file_with_http_info(post_file_bank_model, opts = {}) ⇒ Array<(PlatformFileBankModel, Integer, Hash)>

Create File Creates a file. #### This feature is currently in preview mode and is not yet available for partner use. ## Data The attribute contains the base64 encoded file content. The value needs to be smaller than 10MB otherwise the Platform will reject the request. To upload files larger than 10MB do not provide the content and use the returned upload URL to provide the file. ## State | State | Description | |——-|————-| | storing | The Platform is storing the file in our private store | | completed | The Platform has completed storing the file | | failed | The Platform failed to store the file | Required scope: files:execute

Parameters:

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

    the optional parameters

Returns:

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

    PlatformFileBankModel 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/files_bank_api.rb', line 37

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

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

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

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

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

#get_file(file_guid, opts = {}) ⇒ PlatformFileBankModel

Get File Retrieves a file. Required scopes: **files:read, files:pii:read**

Parameters:

  • file_guid (String) —

    Identifier for the file.

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

    the optional parameters

Options Hash (opts):

  • :include_download_url (String) —

    Include download information in response. Note, the files:pii:read scope is required if this parameter is set.

Returns:



96
97
98
99
 
# File 'lib/cybrid_api_bank_ruby/api/files_bank_api.rb', line 96

def get_file(file_guid, opts = {})
  data, _status_code, _headers = get_file_with_http_info(file_guid, opts)
  data
end

#get_file_with_http_info(file_guid, opts = {}) ⇒ Array<(PlatformFileBankModel, Integer, Hash)>

Get File Retrieves a file. Required scopes: **files:read, files:pii:read**

Parameters:

  • file_guid (String) —

    Identifier for the file.

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

    the optional parameters

Options Hash (opts):

  • :include_download_url (String) —

    Include download information in response. Note, the files:pii:read scope is required if this parameter is set.

Returns:

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

    PlatformFileBankModel data, response status code and response headers



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
152
153
154
 
# File 'lib/cybrid_api_bank_ruby/api/files_bank_api.rb', line 107

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_download_url'] = opts[:'include_download_url'] if !opts[:'include_download_url'].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] || 'PlatformFileBankModel'

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

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

#list_files(opts = {}) ⇒ PlatformFileListBankModel

List Files Retrieves a list of files. Required scope: files: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 file_guids to list files for.

  • :type (String) —

    Comma separated file types to list files for.

  • :state (String) —

    Comma separated file states to list files for.

  • :bank_guid (String) —

    Comma separated bank_guids to list files for.

  • :customer_guid (String) —

    Comma separated customer_guids to list files for.

Returns:



167
168
169
170
 
# File 'lib/cybrid_api_bank_ruby/api/files_bank_api.rb', line 167

def list_files(opts = {})
  data, _status_code, _headers = list_files_with_http_info(opts)
  data
end

#list_files_with_http_info(opts = {}) ⇒ Array<(PlatformFileListBankModel, Integer, Hash)>

List Files Retrieves a list of files. Required scope: files: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 file_guids to list files for.

  • :type (String) —

    Comma separated file types to list files for.

  • :state (String) —

    Comma separated file states to list files for.

  • :bank_guid (String) —

    Comma separated bank_guids to list files for.

  • :customer_guid (String) —

    Comma separated customer_guids to list files for.

Returns:

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

    PlatformFileListBankModel data, response status code and response headers



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cybrid_api_bank_ruby/api/files_bank_api.rb', line 183

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

  # resource path
  local_var_path = '/api/files'

  # 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[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].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?

  # 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] || 'PlatformFileListBankModel'

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

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