Class FilesBankApi


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2025-04-10T20:45:15.651956Z[Etc/UTC]")
    public class FilesBankApi
    extends Object
    • Constructor Detail

      • FilesBankApi

        public FilesBankApi()
      • FilesBankApi

        @Autowired
        public FilesBankApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • createFile

        public reactor.core.publisher.Mono<PlatformFileBankModel> createFile​(PostFileBankModel postFileBankModel)
                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        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**

        201 - file created

        400 - Invalid requests

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        Parameters:
        postFileBankModel - The postFileBankModel parameter
        Returns:
        PlatformFileBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • createFileWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PlatformFileBankModel>> createFileWithHttpInfo​(PostFileBankModel postFileBankModel)
                                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • getFile

        public reactor.core.publisher.Mono<PlatformFileBankModel> getFile​(String fileGuid)
                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get File Retrieves a file. Required scope: **files:read**

        200 - file found

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - file not found

        Parameters:
        fileGuid - Identifier for the file.
        Returns:
        PlatformFileBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • getFileWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PlatformFileBankModel>> getFileWithHttpInfo​(String fileGuid)
                                                                                                                        throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • listFiles

        public reactor.core.publisher.Mono<PlatformFileListBankModel> listFiles​(BigInteger page,
                                                                                BigInteger perPage,
                                                                                String guid,
                                                                                String type,
                                                                                String state,
                                                                                String bankGuid,
                                                                                String customerGuid)
                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        List Files Retrieves a list of files. Required scope: **files:read**

        200 - get list of files

        400 - Invalid requests

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        Parameters:
        page - The page index to retrieve.
        perPage - The number of entities per page to return.
        guid - Comma separated file_guids to list files for.
        type - Comma separated file types to list files for.
        state - Comma separated file states to list files for.
        bankGuid - Comma separated bank_guids to list files for.
        customerGuid - Comma separated customer_guids to list files for.
        Returns:
        PlatformFileListBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • listFilesWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PlatformFileListBankModel>> listFilesWithHttpInfo​(BigInteger page,
                                                                                                                                     BigInteger perPage,
                                                                                                                                     String guid,
                                                                                                                                     String type,
                                                                                                                                     String state,
                                                                                                                                     String bankGuid,
                                                                                                                                     String customerGuid)
                                                                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException