Package api

Class FilesApi

java.lang.Object

api.FilesApi

public class FilesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FilesApi.APIlistExternalLinksRequest
class	FilesApi.APIlistFilesRequest

Constructor Summary

Constructors

Constructor	Description
FilesApi()
FilesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
ModelFile	create(CreateFileRequest createFileRequest)	Create a File Before uploading a file, you need to create a `File` resource.
ExternalLink	createExternalLink(String fileId, CreateExternalLinkRequest createExternalLinkRequest)	Create an External Link Create an `external_link` resource to share with users so they can upload files directly from their browser.
okhttp3.Call	createExternalLinkAsync(String fileId, CreateExternalLinkRequest createExternalLinkRequest, ApiCallback<ExternalLink> _callback)	Create an External Link (asynchronously) Create an `external_link` resource to share with users so they can upload files directly from their browser.
okhttp3.Call	createExternalLinkCall(String fileId, CreateExternalLinkRequest createExternalLinkRequest, ApiCallback _callback)	Build call for createExternalLink
ApiResponse<ExternalLink>	createExternalLinkWithHttpInfo(String fileId, CreateExternalLinkRequest createExternalLinkRequest)	Create an External Link Create an `external_link` resource to share with users so they can upload files directly from their browser.
okhttp3.Call	createFilesAsync(CreateFileRequest createFileRequest, ApiCallback<ModelFile> _callback)	Create a File (asynchronously) Before uploading a file, you need to create a `File` resource.
okhttp3.Call	createFilesCall(CreateFileRequest createFileRequest, ApiCallback _callback)	Build call for createFiles
ApiResponse<ModelFile>	createFilesWithHttpInfo(CreateFileRequest createFileRequest)	Create a File Before uploading a file, you need to create a `File` resource.
File	downloadFile(String fileId)	Download a file Download a file uploaded to a `File` resource.
okhttp3.Call	downloadFileAsync(String fileId, ApiCallback<File> _callback)	Download a file (asynchronously) Download a file uploaded to a `File` resource.
okhttp3.Call	downloadFileCall(String fileId, ApiCallback _callback)	Build call for downloadFile
ApiResponse<File>	downloadFileWithHttpInfo(String fileId)	Download a file Download a file uploaded to a `File` resource.
ModelFile	get(String fileId)	Fetch a File Retrieve the details of a `File` resource.
String	getCustomBaseUrl()
ExternalLink	getExternalLink(String fileId, String externalLinkId)	Fetch an External LInk Fetch a previously created `external_link` resource.
okhttp3.Call	getExternalLinkAsync(String fileId, String externalLinkId, ApiCallback<ExternalLink> _callback)	Fetch an External LInk (asynchronously) Fetch a previously created `external_link` resource.
okhttp3.Call	getExternalLinkCall(String fileId, String externalLinkId, ApiCallback _callback)	Build call for getExternalLink
ApiResponse<ExternalLink>	getExternalLinkWithHttpInfo(String fileId, String externalLinkId)	Fetch an External LInk Fetch a previously created `external_link` resource.
okhttp3.Call	getFileAsync(String fileId, ApiCallback<ModelFile> _callback)	Fetch a File (asynchronously) Retrieve the details of a `File` resource.
okhttp3.Call	getFileCall(String fileId, ApiCallback _callback)	Build call for getFile
ApiResponse<ModelFile>	getFileWithHttpInfo(String fileId)	Fetch a File Retrieve the details of a `File` resource.
FinixClient	getFinixClient()
int	getHostIndex()
FilesList	list(ListFilesQueryParams listFilesQueryParams)	List All Files List all the `File` resources you've created.
ExternalLinksList	listExternalLinks(String fileId, ListExternalLinksQueryParams listExternalLinksQueryParams)	List All External Links List the previously `external_links` for a `File`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
ModelFile	uploadFile(String fileId, UploadFileRequest uploadFileRequest)	Upload files Directly Upload files directly with a `multipart/form-data` request.
okhttp3.Call	uploadFileAsync(String fileId, UploadFileRequest uploadFileRequest, ApiCallback<ModelFile> _callback)	Upload files Directly (asynchronously) Upload files directly with a `multipart/form-data` request.
okhttp3.Call	uploadFileCall(String fileId, UploadFileRequest uploadFileRequest, ApiCallback _callback)	Build call for uploadFile
ApiResponse<ModelFile>	uploadFileWithHttpInfo(String fileId, UploadFileRequest uploadFileRequest)	Upload files Directly Upload files directly with a `multipart/form-data` request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilesApi

public FilesApi()

FilesApi

public FilesApi(FinixClient finixClient)

Method Details

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createExternalLinkCall

public okhttp3.Call createExternalLinkCall(String fileId,
 CreateExternalLinkRequest createExternalLinkRequest,
 ApiCallback _callback)
                                    throws ApiException

Build call for createExternalLink

Parameters:

fileId - Your `File` ID. (required)

createExternalLinkRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createExternalLink

public ExternalLink createExternalLink(String fileId,
 CreateExternalLinkRequest createExternalLinkRequest)
                                throws ApiException

Create an External Link Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). Once created, you can upload the user's file to the `external_link` resource: [Upload files to External Link](#operation/uploadExternalLink)

Parameters:

fileId - Your `File` ID. (required)

createExternalLinkRequest - (optional)

Returns:

ExternalLink

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createExternalLinkWithHttpInfo

public ApiResponse<ExternalLink> createExternalLinkWithHttpInfo(String fileId,
 CreateExternalLinkRequest createExternalLinkRequest)
                                                         throws ApiException

Create an External Link Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). Once created, you can upload the user's file to the `external_link` resource: [Upload files to External Link](#operation/uploadExternalLink)

Parameters:

fileId - Your `File` ID. (required)

createExternalLinkRequest - (optional)

Returns:

ApiResponse<ExternalLink>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createExternalLinkAsync

public okhttp3.Call createExternalLinkAsync(String fileId,
 CreateExternalLinkRequest createExternalLinkRequest,
 ApiCallback<ExternalLink> _callback)
                                     throws ApiException

Create an External Link (asynchronously) Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). Once created, you can upload the user's file to the `external_link` resource: [Upload files to External Link](#operation/uploadExternalLink)

Parameters:

fileId - Your `File` ID. (required)

createExternalLinkRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createFilesCall

public okhttp3.Call createFilesCall(CreateFileRequest createFileRequest,
 ApiCallback _callback)
                             throws ApiException

Build call for createFiles

Parameters:

createFileRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

create

public ModelFile create(CreateFileRequest createFileRequest)
                 throws ApiException

Create a File Before uploading a file, you need to create a `File` resource. Once created, you can [upload](#operations/uploadFile) your file to the new `File` resource.

Parameters:

createFileRequest - (optional)

Returns:

ModelFile

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createFilesWithHttpInfo

public ApiResponse<ModelFile> createFilesWithHttpInfo(CreateFileRequest createFileRequest)
                                               throws ApiException

Create a File Before uploading a file, you need to create a `File` resource. Once created, you can [upload](#operations/uploadFile) your file to the new `File` resource.

Parameters:

createFileRequest - (optional)

Returns:

ApiResponse<ModelFile>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createFilesAsync

public okhttp3.Call createFilesAsync(CreateFileRequest createFileRequest,
 ApiCallback<ModelFile> _callback)
                              throws ApiException

Create a File (asynchronously) Before uploading a file, you need to create a `File` resource. Once created, you can [upload](#operations/uploadFile) your file to the new `File` resource.

Parameters:

createFileRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

downloadFileCall

public okhttp3.Call downloadFileCall(String fileId,
 ApiCallback _callback)
                              throws ApiException

Build call for downloadFile

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Example response	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

downloadFile

public File downloadFile(String fileId)
                  throws ApiException

Download a file Download a file uploaded to a `File` resource. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Example response	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

downloadFileWithHttpInfo

public ApiResponse<File> downloadFileWithHttpInfo(String fileId)
                                           throws ApiException

Download a file Download a file uploaded to a `File` resource. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Example response	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

downloadFileAsync

public okhttp3.Call downloadFileAsync(String fileId,
 ApiCallback<File> _callback)
                               throws ApiException

Download a file (asynchronously) Download a file uploaded to a `File` resource. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Example response	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getExternalLinkCall

public okhttp3.Call getExternalLinkCall(String fileId,
 String externalLinkId,
 ApiCallback _callback)
                                 throws ApiException

Build call for getExternalLink

Parameters:

fileId - The ID of the `File` that has the links you want to retrieve. (required)

externalLinkId - The ID of the `external_link` that you want to retireve. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getExternalLink

public ExternalLink getExternalLink(String fileId,
 String externalLinkId)
                             throws ApiException

Fetch an External LInk Fetch a previously created `external_link` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - The ID of the `File` that has the links you want to retrieve. (required)

externalLinkId - The ID of the `external_link` that you want to retireve. (required)

Returns:

ExternalLink

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getExternalLinkWithHttpInfo

public ApiResponse<ExternalLink> getExternalLinkWithHttpInfo(String fileId,
 String externalLinkId)
                                                      throws ApiException

Fetch an External LInk Fetch a previously created `external_link` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - The ID of the `File` that has the links you want to retrieve. (required)

externalLinkId - The ID of the `external_link` that you want to retireve. (required)

Returns:

ApiResponse<ExternalLink>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getExternalLinkAsync

public okhttp3.Call getExternalLinkAsync(String fileId,
 String externalLinkId,
 ApiCallback<ExternalLink> _callback)
                                  throws ApiException

Fetch an External LInk (asynchronously) Fetch a previously created `external_link` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - The ID of the `File` that has the links you want to retrieve. (required)

externalLinkId - The ID of the `external_link` that you want to retireve. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single external_link object	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getFileCall

public okhttp3.Call getFileCall(String fileId,
 ApiCallback _callback)
                         throws ApiException

Build call for getFile

Parameters:

fileId - Your `File` ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public ModelFile get(String fileId)
              throws ApiException

Fetch a File Retrieve the details of a `File` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - Your `File` ID. (required)

Returns:

ModelFile

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getFileWithHttpInfo

public ApiResponse<ModelFile> getFileWithHttpInfo(String fileId)
                                           throws ApiException

Fetch a File Retrieve the details of a `File` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - Your `File` ID. (required)

Returns:

ApiResponse<ModelFile>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getFileAsync

public okhttp3.Call getFileAsync(String fileId,
 ApiCallback<ModelFile> _callback)
                          throws ApiException

Fetch a File (asynchronously) Retrieve the details of a `File` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - Your `File` ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

listExternalLinks

public ExternalLinksList listExternalLinks(String fileId,
 ListExternalLinksQueryParams listExternalLinksQueryParams)
                                    throws ApiException

List All External Links List the previously `external_links` for a `File`. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).

Parameters:

fileId - Your `File` ID. (required)

Returns:

APIlistExternalLinksRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of external_link objects	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	-

list

public FilesList list(ListFilesQueryParams listFilesQueryParams)
               throws ApiException

List All Files List all the `File` resources you've created. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-1-create-a-file).

Returns:

APIlistFilesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of File objects	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

uploadFileCall

public okhttp3.Call uploadFileCall(String fileId,
 UploadFileRequest uploadFileRequest,
 ApiCallback _callback)
                            throws ApiException

Build call for uploadFile

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

uploadFileRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

uploadFile

public ModelFile uploadFile(String fileId,
 UploadFileRequest uploadFileRequest)
                     throws ApiException

Upload files Directly Upload files directly with a `multipart/form-data` request. For more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

uploadFileRequest - (optional)

Returns:

ModelFile

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

uploadFileWithHttpInfo

public ApiResponse<ModelFile> uploadFileWithHttpInfo(String fileId,
 UploadFileRequest uploadFileRequest)
                                              throws ApiException

Upload files Directly Upload files directly with a `multipart/form-data` request. For more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

uploadFileRequest - (optional)

Returns:

ApiResponse<ModelFile>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

uploadFileAsync

public okhttp3.Call uploadFileAsync(String fileId,
 UploadFileRequest uploadFileRequest,
 ApiCallback<ModelFile> _callback)
                             throws ApiException

Upload files Directly (asynchronously) Upload files directly with a `multipart/form-data` request. For more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file).

Parameters:

fileId - The ID of the `File` that was created to upload the file. (required)

uploadFileRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single File object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -