Package api

Class FilesApi.APIlistFilesRequest

  • Enclosing class:
    FilesApi
    public class FilesApi.APIlistFilesRequest
extends Object

    • Method Detail

      • sort

        public FilesApi.APIlistFilesRequest sort​(String sort)
        Set sort
        Parameters:
        sort - Specify key to be used for sorting the collection. (optional)
        Returns:
        APIlistFilesRequest

      • afterCursor

        public FilesApi.APIlistFilesRequest afterCursor​(String afterCursor)
        Set afterCursor
        Parameters:
        afterCursor - Return every resource created after the cursor value. (optional)
        Returns:
        APIlistFilesRequest

      • limit

        public FilesApi.APIlistFilesRequest limit​(Long limit)
        Set limit
        Parameters:
        limit - The numbers of items to return. (optional)
        Returns:
        APIlistFilesRequest

      • createdAtGte

        public FilesApi.APIlistFilesRequest createdAtGte​(String createdAtGte)
        Set createdAtGte
        Parameters:
        createdAtGte - Filter where `created_at` is after the given date. (optional)
        Returns:
        APIlistFilesRequest

      • createdAtLte

        public FilesApi.APIlistFilesRequest createdAtLte​(String createdAtLte)
        Set createdAtLte
        Parameters:
        createdAtLte - Filter where `created_at` is before the given date. (optional)
        Returns:
        APIlistFilesRequest

      • updatedAtGte

        public FilesApi.APIlistFilesRequest updatedAtGte​(String updatedAtGte)
        Set updatedAtGte
        Parameters:
        updatedAtGte - Filter where `updated_at` is after the given date. (optional)
        Returns:
        APIlistFilesRequest

      • updatedAtLte

        public FilesApi.APIlistFilesRequest updatedAtLte​(String updatedAtLte)
        Set updatedAtLte
        Parameters:
        updatedAtLte - Filter where `updated_at` is before the given date. (optional)
        Returns:
        APIlistFilesRequest

      • beforeCursor

        public FilesApi.APIlistFilesRequest beforeCursor​(String beforeCursor)
        Set beforeCursor
        Parameters:
        beforeCursor - Return every resource created before the cursor value. (optional)
        Returns:
        APIlistFilesRequest

      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                       throws ApiException
        Build call for listFiles
        Parameters:
        _callback - ApiCallback API callback
        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 File objects * finix-apiuser-role -
        * date -
        * x-request-id -
        401 Authentication information is missing or invalid * finix-apiuser-role -
        * date -
        * x-request-id -
        403 Forbidden * finix-apiuser-role -
        * date -
        * x-request-id -
        404 Object does not exist * finix-apiuser-role -
        * date -
        * x-request-id -
        406 Not Acceptable * finix-apiuser-role -
        * date -
        * x-request-id -

      • execute

        public FilesList execute()
                  throws ApiException
        Execute listFiles request
        Returns:
        FilesList
        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 File objects * finix-apiuser-role -
        * date -
        * x-request-id -
        401 Authentication information is missing or invalid * finix-apiuser-role -
        * date -
        * x-request-id -
        403 Forbidden * finix-apiuser-role -
        * date -
        * x-request-id -
        404 Object does not exist * finix-apiuser-role -
        * date -
        * x-request-id -
        406 Not Acceptable * finix-apiuser-role -
        * date -
        * x-request-id -

      • executeWithHttpInfo

        public ApiResponse<FilesList> executeWithHttpInfo()
                                           throws ApiException
        Execute listFiles request with HTTP info returned
        Returns:
        ApiResponse<FilesList>
        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 File objects * finix-apiuser-role -
        * date -
        * x-request-id -
        401 Authentication information is missing or invalid * finix-apiuser-role -
        * date -
        * x-request-id -
        403 Forbidden * finix-apiuser-role -
        * date -
        * x-request-id -
        404 Object does not exist * finix-apiuser-role -
        * date -
        * x-request-id -
        406 Not Acceptable * finix-apiuser-role -
        * date -
        * x-request-id -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<FilesList> _callback)
                          throws ApiException
        Execute listFiles request (asynchronously)
        Parameters:
        _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 File objects * finix-apiuser-role -
        * date -
        * x-request-id -
        401 Authentication information is missing or invalid * finix-apiuser-role -
        * date -
        * x-request-id -
        403 Forbidden * finix-apiuser-role -
        * date -
        * x-request-id -
        404 Object does not exist * finix-apiuser-role -
        * date -
        * x-request-id -
        406 Not Acceptable * finix-apiuser-role -
        * date -
        * x-request-id -