Package api

Class IdentitiesApi.APIlistIdentitiesRequest

java.lang.Object
api.IdentitiesApi.APIlistIdentitiesRequest
Enclosing class:
IdentitiesApi
public class IdentitiesApi.APIlistIdentitiesRequest extends Object

  • Method Details

    • sort

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

    • afterCursor

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

    • limit

      public IdentitiesApi.APIlistIdentitiesRequest limit(Long limit)
      Set limit
      Parameters:
      limit - The numbers of items to return (optional)
      Returns:
      APIlistIdentitiesRequest

    • id

      public IdentitiesApi.APIlistIdentitiesRequest id(String id)
      Set id
      Parameters:
      id - Filter by id (optional)
      Returns:
      APIlistIdentitiesRequest

    • createdAtGte

      public IdentitiesApi.APIlistIdentitiesRequest createdAtGte(String createdAtGte)
      Set createdAtGte
      Parameters:
      createdAtGte - Filter where created_at is after the given date. (optional)
      Returns:
      APIlistIdentitiesRequest

    • createdAtLte

      public IdentitiesApi.APIlistIdentitiesRequest createdAtLte(String createdAtLte)
      Set createdAtLte
      Parameters:
      createdAtLte - Filter where created_at is before the given date. (optional)
      Returns:
      APIlistIdentitiesRequest

    • defaultStatementDescriptor

      public IdentitiesApi.APIlistIdentitiesRequest defaultStatementDescriptor(String defaultStatementDescriptor)
      Set defaultStatementDescriptor
      Parameters:
      defaultStatementDescriptor - Filter by the default_statement_descriptor (optional)
      Returns:
      APIlistIdentitiesRequest

    • businessName

      public IdentitiesApi.APIlistIdentitiesRequest businessName(String businessName)
      Set businessName
      Parameters:
      businessName - Filter by the full business name. Partial business names are not supported. (optional)
      Returns:
      APIlistIdentitiesRequest

    • businessType

      public IdentitiesApi.APIlistIdentitiesRequest businessType(String businessType)
      Set businessType
      Parameters:
      businessType - Filter by the business type. Partial business types are not supported (optional)
      Returns:
      APIlistIdentitiesRequest

    • email

      public IdentitiesApi.APIlistIdentitiesRequest email(String email)
      Set email
      Parameters:
      email - Filter by the email address or email domain. Partial emails are not supported. (optional)
      Returns:
      APIlistIdentitiesRequest

    • firstName

      public IdentitiesApi.APIlistIdentitiesRequest firstName(String firstName)
      Set firstName
      Parameters:
      firstName - Filter by the first name of the person associated to the Identity. (optional)
      Returns:
      APIlistIdentitiesRequest

    • lastName

      public IdentitiesApi.APIlistIdentitiesRequest lastName(String lastName)
      Set lastName
      Parameters:
      lastName - Filter by the last name of the person associated to the identity. (optional)
      Returns:
      APIlistIdentitiesRequest

    • title

      public IdentitiesApi.APIlistIdentitiesRequest title(String title)
      Set title
      Parameters:
      title - Filter by the title if available. (optional)
      Returns:
      APIlistIdentitiesRequest

    • beforeCursor

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

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for listIdentities
      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 Identity 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 IdentitiesList execute() throws ApiException
      Execute listIdentities request
      Returns:
      IdentitiesList
      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 Identity 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<IdentitiesList> executeWithHttpInfo() throws ApiException
      Execute listIdentities request with HTTP info returned
      Returns:
      ApiResponse<IdentitiesList>
      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 Identity 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<IdentitiesList> _callback) throws ApiException
      Execute listIdentities 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 Identity 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 -