Class WalletApi


  • public class WalletApi
    extends Object
    • Constructor Detail

      • WalletApi

        public WalletApi()
      • WalletApi

        public WalletApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • getCharactersCharacterIdWalletCall

        public okhttp3.Call getCharactersCharacterIdWalletCall​(Integer characterId,
                                                               String datasource,
                                                               String ifNoneMatch,
                                                               String token,
                                                               ApiCallback _callback)
                                                        throws ApiException
        Build call for getCharactersCharacterIdWallet
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCharactersCharacterIdWallet

        public Double getCharactersCharacterIdWallet​(Integer characterId,
                                                     String datasource,
                                                     String ifNoneMatch,
                                                     String token)
                                              throws ApiException
        Get a character's wallet balance Returns a character's wallet balance --- This route is cached for up to 120 seconds --- [Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/characters /{character_id}/wallet/) SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        Double
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletWithHttpInfo

        public ApiResponse<Double> getCharactersCharacterIdWalletWithHttpInfo​(Integer characterId,
                                                                              String datasource,
                                                                              String ifNoneMatch,
                                                                              String token)
                                                                       throws ApiException
        Get a character's wallet balance Returns a character's wallet balance --- This route is cached for up to 120 seconds --- [Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/characters /{character_id}/wallet/) SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<Double>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletAsync

        public okhttp3.Call getCharactersCharacterIdWalletAsync​(Integer characterId,
                                                                String datasource,
                                                                String ifNoneMatch,
                                                                String token,
                                                                ApiCallback<Double> _callback)
                                                         throws ApiException
        Get a character's wallet balance (asynchronously) Returns a character's wallet balance --- This route is cached for up to 120 seconds --- [Diff of the upcoming changes](https://esi.evetech.net/diff/latest /dev/#GET-/characters/{character_id}/wallet/) SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (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
      • getCharactersCharacterIdWalletJournalCall

        public okhttp3.Call getCharactersCharacterIdWalletJournalCall​(Integer characterId,
                                                                      String datasource,
                                                                      String ifNoneMatch,
                                                                      Integer page,
                                                                      String token,
                                                                      ApiCallback _callback)
                                                               throws ApiException
        Build call for getCharactersCharacterIdWalletJournal
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCharactersCharacterIdWalletJournal

        public List<CharacterWalletJournalResponse> getCharactersCharacterIdWalletJournal​(Integer characterId,
                                                                                          String datasource,
                                                                                          String ifNoneMatch,
                                                                                          Integer page,
                                                                                          String token)
                                                                                   throws ApiException
        Get character wallet journal Retrieve the given character's wallet journal going 30 days back --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        Returns:
        List<CharacterWalletJournalResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletJournalWithHttpInfo

        public ApiResponse<List<CharacterWalletJournalResponse>> getCharactersCharacterIdWalletJournalWithHttpInfo​(Integer characterId,
                                                                                                                   String datasource,
                                                                                                                   String ifNoneMatch,
                                                                                                                   Integer page,
                                                                                                                   String token)
                                                                                                            throws ApiException
        Get character wallet journal Retrieve the given character's wallet journal going 30 days back --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<List<CharacterWalletJournalResponse>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletJournalAsync

        public okhttp3.Call getCharactersCharacterIdWalletJournalAsync​(Integer characterId,
                                                                       String datasource,
                                                                       String ifNoneMatch,
                                                                       Integer page,
                                                                       String token,
                                                                       ApiCallback<List<CharacterWalletJournalResponse>> _callback)
                                                                throws ApiException
        Get character wallet journal (asynchronously) Retrieve the given character's wallet journal going 30 days back --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (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
      • getCharactersCharacterIdWalletTransactionsCall

        public okhttp3.Call getCharactersCharacterIdWalletTransactionsCall​(Integer characterId,
                                                                           String datasource,
                                                                           Long fromId,
                                                                           String ifNoneMatch,
                                                                           String token,
                                                                           ApiCallback _callback)
                                                                    throws ApiException
        Build call for getCharactersCharacterIdWalletTransactions
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show transactions happened before the one referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCharactersCharacterIdWalletTransactions

        public List<CharacterWalletTransactionsResponse> getCharactersCharacterIdWalletTransactions​(Integer characterId,
                                                                                                    String datasource,
                                                                                                    Long fromId,
                                                                                                    String ifNoneMatch,
                                                                                                    String token)
                                                                                             throws ApiException
        Get wallet transactions Get wallet transactions of a character --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show transactions happened before the one referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        List<CharacterWalletTransactionsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletTransactionsWithHttpInfo

        public ApiResponse<List<CharacterWalletTransactionsResponse>> getCharactersCharacterIdWalletTransactionsWithHttpInfo​(Integer characterId,
                                                                                                                             String datasource,
                                                                                                                             Long fromId,
                                                                                                                             String ifNoneMatch,
                                                                                                                             String token)
                                                                                                                      throws ApiException
        Get wallet transactions Get wallet transactions of a character --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show transactions happened before the one referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<List<CharacterWalletTransactionsResponse>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCharactersCharacterIdWalletTransactionsAsync

        public okhttp3.Call getCharactersCharacterIdWalletTransactionsAsync​(Integer characterId,
                                                                            String datasource,
                                                                            Long fromId,
                                                                            String ifNoneMatch,
                                                                            String token,
                                                                            ApiCallback<List<CharacterWalletTransactionsResponse>> _callback)
                                                                     throws ApiException
        Get wallet transactions (asynchronously) Get wallet transactions of a character --- This route is cached for up to 3600 seconds SSO Scope: esi-wallet.read_character_wallet.v1
        Parameters:
        characterId - An EVE character ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show transactions happened before the one referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (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
      • getCorporationsCorporationIdWalletsCall

        public okhttp3.Call getCorporationsCorporationIdWalletsCall​(Integer corporationId,
                                                                    String datasource,
                                                                    String ifNoneMatch,
                                                                    String token,
                                                                    ApiCallback _callback)
                                                             throws ApiException
        Build call for getCorporationsCorporationIdWallets
        Parameters:
        corporationId - An EVE corporation ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCorporationsCorporationIdWallets

        public List<CorporationWalletsResponse> getCorporationsCorporationIdWallets​(Integer corporationId,
                                                                                    String datasource,
                                                                                    String ifNoneMatch,
                                                                                    String token)
                                                                             throws ApiException
        Returns a corporation's wallet balance Get a corporation's wallets --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        List<CorporationWalletsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsWithHttpInfo

        public ApiResponse<List<CorporationWalletsResponse>> getCorporationsCorporationIdWalletsWithHttpInfo​(Integer corporationId,
                                                                                                             String datasource,
                                                                                                             String ifNoneMatch,
                                                                                                             String token)
                                                                                                      throws ApiException
        Returns a corporation's wallet balance Get a corporation's wallets --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<List<CorporationWalletsResponse>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsAsync

        public okhttp3.Call getCorporationsCorporationIdWalletsAsync​(Integer corporationId,
                                                                     String datasource,
                                                                     String ifNoneMatch,
                                                                     String token,
                                                                     ApiCallback<List<CorporationWalletsResponse>> _callback)
                                                              throws ApiException
        Returns a corporation's wallet balance (asynchronously) Get a corporation's wallets --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (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
      • getCorporationsCorporationIdWalletsDivisionJournalCall

        public okhttp3.Call getCorporationsCorporationIdWalletsDivisionJournalCall​(Integer corporationId,
                                                                                   Integer division,
                                                                                   String datasource,
                                                                                   String ifNoneMatch,
                                                                                   Integer page,
                                                                                   String token,
                                                                                   ApiCallback _callback)
                                                                            throws ApiException
        Build call for getCorporationsCorporationIdWalletsDivisionJournal
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCorporationsCorporationIdWalletsDivisionJournal

        public List<CorporationWalletJournalResponse> getCorporationsCorporationIdWalletsDivisionJournal​(Integer corporationId,
                                                                                                         Integer division,
                                                                                                         String datasource,
                                                                                                         String ifNoneMatch,
                                                                                                         Integer page,
                                                                                                         String token)
                                                                                                  throws ApiException
        Get corporation wallet journal Retrieve the given corporation's wallet journal for the given division going 30 days back --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        Returns:
        List<CorporationWalletJournalResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsDivisionJournalWithHttpInfo

        public ApiResponse<List<CorporationWalletJournalResponse>> getCorporationsCorporationIdWalletsDivisionJournalWithHttpInfo​(Integer corporationId,
                                                                                                                                  Integer division,
                                                                                                                                  String datasource,
                                                                                                                                  String ifNoneMatch,
                                                                                                                                  Integer page,
                                                                                                                                  String token)
                                                                                                                           throws ApiException
        Get corporation wallet journal Retrieve the given corporation's wallet journal for the given division going 30 days back --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<List<CorporationWalletJournalResponse>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsDivisionJournalAsync

        public okhttp3.Call getCorporationsCorporationIdWalletsDivisionJournalAsync​(Integer corporationId,
                                                                                    Integer division,
                                                                                    String datasource,
                                                                                    String ifNoneMatch,
                                                                                    Integer page,
                                                                                    String token,
                                                                                    ApiCallback<List<CorporationWalletJournalResponse>> _callback)
                                                                             throws ApiException
        Get corporation wallet journal (asynchronously) Retrieve the given corporation's wallet journal for the given division going 30 days back --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        page - Which page of results to return (optional, default to 1)
        token - Access token to use if unable to set a header (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
      • getCorporationsCorporationIdWalletsDivisionTransactionsCall

        public okhttp3.Call getCorporationsCorporationIdWalletsDivisionTransactionsCall​(Integer corporationId,
                                                                                        Integer division,
                                                                                        String datasource,
                                                                                        Long fromId,
                                                                                        String ifNoneMatch,
                                                                                        String token,
                                                                                        ApiCallback _callback)
                                                                                 throws ApiException
        Build call for getCorporationsCorporationIdWalletsDivisionTransactions
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show journal entries happened before the transaction referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getCorporationsCorporationIdWalletsDivisionTransactions

        public List<CorporationWalletTransactionsResponse> getCorporationsCorporationIdWalletsDivisionTransactions​(Integer corporationId,
                                                                                                                   Integer division,
                                                                                                                   String datasource,
                                                                                                                   Long fromId,
                                                                                                                   String ifNoneMatch,
                                                                                                                   String token)
                                                                                                            throws ApiException
        Get corporation wallet transactions Get wallet transactions of a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show journal entries happened before the transaction referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        List<CorporationWalletTransactionsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsDivisionTransactionsWithHttpInfo

        public ApiResponse<List<CorporationWalletTransactionsResponse>> getCorporationsCorporationIdWalletsDivisionTransactionsWithHttpInfo​(Integer corporationId,
                                                                                                                                            Integer division,
                                                                                                                                            String datasource,
                                                                                                                                            Long fromId,
                                                                                                                                            String ifNoneMatch,
                                                                                                                                            String token)
                                                                                                                                     throws ApiException
        Get corporation wallet transactions Get wallet transactions of a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show journal entries happened before the transaction referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (optional)
        Returns:
        ApiResponse<List<CorporationWalletTransactionsResponse>> ;
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getCorporationsCorporationIdWalletsDivisionTransactionsAsync

        public okhttp3.Call getCorporationsCorporationIdWalletsDivisionTransactionsAsync​(Integer corporationId,
                                                                                         Integer division,
                                                                                         String datasource,
                                                                                         Long fromId,
                                                                                         String ifNoneMatch,
                                                                                         String token,
                                                                                         ApiCallback<List<CorporationWalletTransactionsResponse>> _callback)
                                                                                  throws ApiException
        Get corporation wallet transactions (asynchronously) Get wallet transactions of a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant SSO Scope: esi-wallet.read_corporation_wallets.v1
        Parameters:
        corporationId - An EVE corporation ID (required)
        division - Wallet key of the division to fetch journals from (required)
        datasource - The server name you would like data from (optional, default to tranquility)
        fromId - Only show journal entries happened before the transaction referenced by this id (optional)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        token - Access token to use if unable to set a header (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