Package Avalara.SDK.api.EInvoicing.V1

Class TradingPartnersApi

  • public class TradingPartnersApi
extends Object

    • Constructor Detail

      • TradingPartnersApi

        public TradingPartnersApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(String customBaseUrl)

      • batchSearchParticipantsCall

        public okhttp3.Call batchSearchParticipantsCall​(TradingPartnersApi.BatchSearchParticipantsRequest requestParameters,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for batchSearchParticipants
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        202 Batch search file accepted for processing the search. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • batchSearchParticipants

        public BatchSearchParticipants202Response batchSearchParticipants​(TradingPartnersApi.BatchSearchParticipantsRequest requestParameters)
                                                           throws ApiException
        Handles batch search requests by uploading a file containing search parameters. This endpoint creates a batch search and performs a batch search in the directory for participants in the background.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        BatchSearchParticipants202Response
        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
        202 Batch search file accepted for processing the search. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • batchSearchParticipantsWithHttpInfo

        public ApiResponse<BatchSearchParticipants202Response> batchSearchParticipantsWithHttpInfo​(TradingPartnersApi.BatchSearchParticipantsRequest requestParameters)
                                                                                    throws ApiException
        Handles batch search requests by uploading a file containing search parameters. This endpoint creates a batch search and performs a batch search in the directory for participants in the background.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<BatchSearchParticipants202Response>
        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
        202 Batch search file accepted for processing the search. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • batchSearchParticipantsAsync

        public okhttp3.Call batchSearchParticipantsAsync​(TradingPartnersApi.BatchSearchParticipantsRequest requestParameters,
                                                 ApiCallback<BatchSearchParticipants202Response> _callback)
                                          throws ApiException
        Handles batch search requests by uploading a file containing search parameters. (asynchronously) This endpoint creates a batch search and performs a batch search in the directory for participants in the background.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        202 Batch search file accepted for processing the search. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnerCall

        public okhttp3.Call createTradingPartnerCall​(TradingPartnersApi.CreateTradingPartnerRequest requestParameters,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for createTradingPartner
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        201 The trading partner has been successfully created. * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartner

        public CreateTradingPartner201Response createTradingPartner​(TradingPartnersApi.CreateTradingPartnerRequest requestParameters)
                                                     throws ApiException
        Creates a new trading partner. This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the `TradingPartner` schema.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateTradingPartner201Response
        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
        201 The trading partner has been successfully created. * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnerWithHttpInfo

        public ApiResponse<CreateTradingPartner201Response> createTradingPartnerWithHttpInfo​(TradingPartnersApi.CreateTradingPartnerRequest requestParameters)
                                                                              throws ApiException
        Creates a new trading partner. This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the `TradingPartner` schema.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateTradingPartner201Response>
        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
        201 The trading partner has been successfully created. * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnerAsync

        public okhttp3.Call createTradingPartnerAsync​(TradingPartnersApi.CreateTradingPartnerRequest requestParameters,
                                              ApiCallback<CreateTradingPartner201Response> _callback)
                                       throws ApiException
        Creates a new trading partner. (asynchronously) This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the `TradingPartner` schema.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        201 The trading partner has been successfully created. * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnersBatchCall

        public okhttp3.Call createTradingPartnersBatchCall​(TradingPartnersApi.CreateTradingPartnersBatchRequest requestParameters,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for createTradingPartnersBatch
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 Batch processing completed * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        413 ContentTooLarge * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnersBatch

        public CreateTradingPartnersBatch200Response createTradingPartnersBatch​(TradingPartnersApi.CreateTradingPartnersBatchRequest requestParameters)
                                                                 throws ApiException
        Creates a batch of multiple trading partners. This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateTradingPartnersBatch200Response
        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 Batch processing completed * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        413 ContentTooLarge * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnersBatchWithHttpInfo

        public ApiResponse<CreateTradingPartnersBatch200Response> createTradingPartnersBatchWithHttpInfo​(TradingPartnersApi.CreateTradingPartnersBatchRequest requestParameters)
                                                                                          throws ApiException
        Creates a batch of multiple trading partners. This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateTradingPartnersBatch200Response>
        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 Batch processing completed * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        413 ContentTooLarge * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • createTradingPartnersBatchAsync

        public okhttp3.Call createTradingPartnersBatchAsync​(TradingPartnersApi.CreateTradingPartnersBatchRequest requestParameters,
                                                    ApiCallback<CreateTradingPartnersBatch200Response> _callback)
                                             throws ApiException
        Creates a batch of multiple trading partners. (asynchronously) This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 Batch processing completed * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        413 ContentTooLarge * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • deleteTradingPartnerCall

        public okhttp3.Call deleteTradingPartnerCall​(TradingPartnersApi.DeleteTradingPartnerRequest requestParameters,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for deleteTradingPartner
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        204 Trading partner deleted successfully. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • deleteTradingPartner

        public void deleteTradingPartner​(TradingPartnersApi.DeleteTradingPartnerRequest requestParameters)
                          throws ApiException
        Deletes a trading partner using ID. This endpoint deletes an existing trading partner identified by the provided ID.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        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
        204 Trading partner deleted successfully. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • deleteTradingPartnerWithHttpInfo

        public ApiResponse<Void> deleteTradingPartnerWithHttpInfo​(TradingPartnersApi.DeleteTradingPartnerRequest requestParameters)
                                                   throws ApiException
        Deletes a trading partner using ID. This endpoint deletes an existing trading partner identified by the provided ID.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Void>
        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
        204 Trading partner deleted successfully. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • deleteTradingPartnerAsync

        public okhttp3.Call deleteTradingPartnerAsync​(TradingPartnersApi.DeleteTradingPartnerRequest requestParameters,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Deletes a trading partner using ID. (asynchronously) This endpoint deletes an existing trading partner identified by the provided ID.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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
        204 Trading partner deleted successfully. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • downloadBatchSearchReportCall

        public okhttp3.Call downloadBatchSearchReportCall​(TradingPartnersApi.DownloadBatchSearchReportRequest requestParameters,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for downloadBatchSearchReport
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 Successful report download Output Constraints: - Maximum of 1000 query results returned in the CSV * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • downloadBatchSearchReport

        public File downloadBatchSearchReport​(TradingPartnersApi.DownloadBatchSearchReportRequest requestParameters)
                               throws ApiException
        Downloads batch search results in a csv file. This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        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 Successful report download Output Constraints: - Maximum of 1000 query results returned in the CSV * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • downloadBatchSearchReportWithHttpInfo

        public ApiResponse<File> downloadBatchSearchReportWithHttpInfo​(TradingPartnersApi.DownloadBatchSearchReportRequest requestParameters)
                                                        throws ApiException
        Downloads batch search results in a csv file. This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        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 Successful report download Output Constraints: - Maximum of 1000 query results returned in the CSV * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • downloadBatchSearchReportAsync

        public okhttp3.Call downloadBatchSearchReportAsync​(TradingPartnersApi.DownloadBatchSearchReportRequest requestParameters,
                                                   ApiCallback<File> _callback)
                                            throws ApiException
        Downloads batch search results in a csv file. (asynchronously) This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 Successful report download Output Constraints: - Maximum of 1000 query results returned in the CSV * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • getBatchSearchDetailCall

        public okhttp3.Call getBatchSearchDetailCall​(TradingPartnersApi.GetBatchSearchDetailRequest requestParameters,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getBatchSearchDetail
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 The batch search details for a given ID. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • getBatchSearchDetail

        public BatchSearch getBatchSearchDetail​(TradingPartnersApi.GetBatchSearchDetailRequest requestParameters)
                                 throws ApiException
        Returns the batch search details using ID. This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        BatchSearch
        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 The batch search details for a given ID. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • getBatchSearchDetailWithHttpInfo

        public ApiResponse<BatchSearch> getBatchSearchDetailWithHttpInfo​(TradingPartnersApi.GetBatchSearchDetailRequest requestParameters)
                                                          throws ApiException
        Returns the batch search details using ID. This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<BatchSearch>
        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 The batch search details for a given ID. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • getBatchSearchDetailAsync

        public okhttp3.Call getBatchSearchDetailAsync​(TradingPartnersApi.GetBatchSearchDetailRequest requestParameters,
                                              ApiCallback<BatchSearch> _callback)
                                       throws ApiException
        Returns the batch search details using ID. (asynchronously) This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 The batch search details for a given ID. * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 Report not found * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • listBatchSearchesCall

        public okhttp3.Call listBatchSearchesCall​(TradingPartnersApi.ListBatchSearchesRequest requestParameters,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for listBatchSearches
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 List of batch searches * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • listBatchSearches

        public BatchSearchListResponse listBatchSearches​(TradingPartnersApi.ListBatchSearchesRequest requestParameters)
                                          throws ApiException
        Lists all batch searches that were previously submitted. This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        BatchSearchListResponse
        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 List of batch searches * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • listBatchSearchesWithHttpInfo

        public ApiResponse<BatchSearchListResponse> listBatchSearchesWithHttpInfo​(TradingPartnersApi.ListBatchSearchesRequest requestParameters)
                                                                   throws ApiException
        Lists all batch searches that were previously submitted. This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<BatchSearchListResponse>
        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 List of batch searches * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • listBatchSearchesAsync

        public okhttp3.Call listBatchSearchesAsync​(TradingPartnersApi.ListBatchSearchesRequest requestParameters,
                                           ApiCallback<BatchSearchListResponse> _callback)
                                    throws ApiException
        Lists all batch searches that were previously submitted. (asynchronously) This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 List of batch searches * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • searchParticipantsCall

        public okhttp3.Call searchParticipantsCall​(TradingPartnersApi.SearchParticipantsRequest requestParameters,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for searchParticipants
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 OK * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • searchParticipants

        public SearchParticipants200Response searchParticipants​(TradingPartnersApi.SearchParticipantsRequest requestParameters)
                                                 throws ApiException
        Returns a list of participants matching the input query. This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        SearchParticipants200Response
        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 OK * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • searchParticipantsWithHttpInfo

        public ApiResponse<SearchParticipants200Response> searchParticipantsWithHttpInfo​(TradingPartnersApi.SearchParticipantsRequest requestParameters)
                                                                          throws ApiException
        Returns a list of participants matching the input query. This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<SearchParticipants200Response>
        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 OK * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • searchParticipantsAsync

        public okhttp3.Call searchParticipantsAsync​(TradingPartnersApi.SearchParticipantsRequest requestParameters,
                                            ApiCallback<SearchParticipants200Response> _callback)
                                     throws ApiException
        Returns a list of participants matching the input query. (asynchronously) This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 OK * X-Correlation-Id -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • updateTradingPartnerCall

        public okhttp3.Call updateTradingPartnerCall​(TradingPartnersApi.UpdateTradingPartnerRequest requestParameters,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for updateTradingPartner
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 The trading partner has been successfully created. -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • updateTradingPartner

        public UpdateTradingPartner200Response updateTradingPartner​(TradingPartnersApi.UpdateTradingPartnerRequest requestParameters)
                                                     throws ApiException
        Updates a trading partner using ID. This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        UpdateTradingPartner200Response
        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 The trading partner has been successfully created. -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • updateTradingPartnerWithHttpInfo

        public ApiResponse<UpdateTradingPartner200Response> updateTradingPartnerWithHttpInfo​(TradingPartnersApi.UpdateTradingPartnerRequest requestParameters)
                                                                              throws ApiException
        Updates a trading partner using ID. This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<UpdateTradingPartner200Response>
        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 The trading partner has been successfully created. -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • updateTradingPartnerAsync

        public okhttp3.Call updateTradingPartnerAsync​(TradingPartnersApi.UpdateTradingPartnerRequest requestParameters,
                                              ApiCallback<UpdateTradingPartner200Response> _callback)
                                       throws ApiException
        Updates a trading partner using ID. (asynchronously) This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _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 The trading partner has been successfully created. -
        400 Bad request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        404 NotFound * X-Correlation-Id -
        409 Conflict * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -