Package io.moov.sdk

Class Files

java.lang.Object

io.moov.sdk.Files

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallGetFileDetails, SDKMethodInterfaces.MethodCallListFiles, SDKMethodInterfaces.MethodCallUploadFile

public class Files
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallUploadFile, SDKMethodInterfaces.MethodCallListFiles, SDKMethodInterfaces.MethodCallGetFileDetails

Method Summary

Modifier and Type	Method	Description
GetFileDetailsRequestBuilder	get()	Retrieve file details associated with a specific Moov account.
GetFileDetailsResponse	get(java.lang.String accountID, java.lang.String fileID)	Retrieve file details associated with a specific Moov account.
GetFileDetailsResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String fileID)	Retrieve file details associated with a specific Moov account.
ListFilesRequestBuilder	list()	List all the files associated with a particular Moov account.
ListFilesResponse	list(java.lang.String accountID)	List all the files associated with a particular Moov account.
ListFilesResponse	list(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	List all the files associated with a particular Moov account.
UploadFileRequestBuilder	upload()	Upload a file and link it to the specified Moov account.
UploadFileResponse	upload(java.lang.String accountID, FileUploadRequestMultiPart fileUploadRequestMultiPart)	Upload a file and link it to the specified Moov account.
UploadFileResponse	upload(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, FileUploadRequestMultiPart fileUploadRequestMultiPart)	Upload a file and link it to the specified Moov account.

Methods inherited from class java.lang.Object

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

Method Detail

upload

public UploadFileRequestBuilder upload()

Upload a file and link it to the specified Moov account.

The maximum file size is 20MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf, and png.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.write` scope.

Returns:

The call builder

upload

public UploadFileResponse upload(java.lang.String accountID,
                                 FileUploadRequestMultiPart fileUploadRequestMultiPart)
                          throws java.lang.Exception

Upload a file and link it to the specified Moov account.

The maximum file size is 20MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf, and png.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.write` scope.

Parameters:

accountID -

fileUploadRequestMultiPart - Request to upload a file for an account.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

upload

public UploadFileResponse upload(java.util.Optional<java.lang.String> xMoovVersion,
                                 java.lang.String accountID,
                                 FileUploadRequestMultiPart fileUploadRequestMultiPart)
                          throws java.lang.Exception

Upload a file and link it to the specified Moov account.

The maximum file size is 20MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf, and png.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.write` scope.

Specified by:

upload in interface SDKMethodInterfaces.MethodCallUploadFile

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

fileUploadRequestMultiPart - Request to upload a file for an account.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListFilesRequestBuilder list()

List all the files associated with a particular Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Returns:

The call builder

list

public ListFilesResponse list(java.lang.String accountID)
                       throws java.lang.Exception

List all the files associated with a particular Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListFilesResponse list(java.util.Optional<java.lang.String> xMoovVersion,
                              java.lang.String accountID)
                       throws java.lang.Exception

List all the files associated with a particular Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Specified by:

list in interface SDKMethodInterfaces.MethodCallListFiles

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetFileDetailsRequestBuilder get()

Retrieve file details associated with a specific Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Returns:

The call builder

get

public GetFileDetailsResponse get(java.lang.String accountID,
                                  java.lang.String fileID)
                           throws java.lang.Exception

Retrieve file details associated with a specific Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Parameters:

accountID -

fileID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetFileDetailsResponse get(java.util.Optional<java.lang.String> xMoovVersion,
                                  java.lang.String accountID,
                                  java.lang.String fileID)
                           throws java.lang.Exception

Retrieve file details associated with a specific Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/files.read` scope.

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetFileDetails

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

fileID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails