Class CustomersBankApi


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2024-07-26T18:03:12.105460Z[Etc/UTC]")
    public class CustomersBankApi
    extends Object
    • Constructor Detail

      • CustomersBankApi

        public CustomersBankApi()
      • CustomersBankApi

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

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • createCustomer

        public reactor.core.publisher.Mono<CustomerBankModel> createCustomer​(PostCustomerBankModel postCustomerBankModel)
                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        Create Customer Creates a customer. ## Customer Type Customer resources are an abstraction for real world individuals and businesses on the Cybrid Platform and are used throughout the platform to perform high level operations, e.g., create a quote, execute a trade, etc.. Customers can have additional resources attached to them, e.g., identity verifications, accounts, etc. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the customer details in our private store | | unverified | The Platform has not yet verified the customer's identity | | verified | The Platform has verified the customer's identity | | rejected | The Platform was not able to successfully verify the customer's identity | | frozen | The customer has been frozen on the Platform | Required scope: **customers:execute**

        201 - customer created

        400 - Invalid requests

        401 - Unauthorized - Authentication failed, invalid subject

        403 - Invalid scope

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

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CustomerBankModel>> createCustomerWithHttpInfo​(PostCustomerBankModel postCustomerBankModel)
                                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • getCustomer

        public reactor.core.publisher.Mono<CustomerBankModel> getCustomer​(String customerGuid,
                                                                          Boolean includePii)
                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get Customer Retrieves a customer. Required scope: **customers:read**

        200 - customer found

        401 - Unauthorized - Authentication failed, invalid subject

        403 - Invalid scope

        404 - customer not found

        Parameters:
        customerGuid - Identifier for the customer.
        includePii - Include PII in the response.
        Returns:
        CustomerBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • getCustomerWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CustomerBankModel>> getCustomerWithHttpInfo​(String customerGuid,
                                                                                                                               Boolean includePii)
                                                                                                                        throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • listCustomers

        public reactor.core.publisher.Mono<CustomerListBankModel> listCustomers​(BigInteger page,
                                                                                BigInteger perPage,
                                                                                String bankGuid,
                                                                                String guid,
                                                                                String label)
                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get customers list Retrieves a listing of customers. Required scope: **customers:read**

        200 - get list of customers

        400 - Invalid requests

        401 - Unauthorized - Authentication failed, invalid subject,

        403 - Invalid scope

        Parameters:
        page - The page parameter
        perPage - The perPage parameter
        bankGuid - Comma separated bank_guids to list customers for.
        guid - Comma separated customer_guids to list customers for.
        label - Comma separated labels to list customers for.
        Returns:
        CustomerListBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • listCustomersWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CustomerListBankModel>> listCustomersWithHttpInfo​(BigInteger page,
                                                                                                                                     BigInteger perPage,
                                                                                                                                     String bankGuid,
                                                                                                                                     String guid,
                                                                                                                                     String label)
                                                                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException
      • updateCustomer

        public reactor.core.publisher.Mono<CustomerBankModel> updateCustomer​(String customerGuid,
                                                                             PatchCustomerBankModel patchCustomerBankModel)
                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        Patch Customer Update a customer. Required scope: **customers:write**

        200 - customer found

        401 - Unauthorized - Authentication failed, invalid subject

        403 - Invalid scope

        404 - customer not found

        Parameters:
        customerGuid - Identifier for the customer.
        patchCustomerBankModel - The patchCustomerBankModel parameter
        Returns:
        CustomerBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API
      • updateCustomerWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CustomerBankModel>> updateCustomerWithHttpInfo​(String customerGuid,
                                                                                                                                  PatchCustomerBankModel patchCustomerBankModel)
                                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException