Package ai.vectros.resources.identity.requests

Class ListClientsRequest

java.lang.Object
ai.vectros.resources.identity.requests.ListClientsRequest
public final class ListClientsRequest extends Object

  • Method Details

    • getOrgId

      public Optional<String> getOrgId()
      Returns:
      Return only clients belonging to this organization. Pass the Vectros-assigned UUID of an org; use GET /v1/orgs?externalId= to resolve your own identifier to this UUID.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Return only clients owned by this user. Pass the Vectros-assigned UUID of a user; use GET /v1/users?externalId= to resolve your own identifier to this UUID.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Look up a client by your own externalId. Returns a single-element list, or an empty list if no client matches.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of clients to return per page (1–100; defaults to 20).

    • getType

      public Optional<String> getType()
      Returns:
      Record type of the schema whose lookup fields you are querying. Must be supplied together with field and exactly one lookup mode.

    • getField

      public Optional<String> getField()
      Returns:
      Name of the lookup field to filter by. Must be declared as a lookup field on the schema identified by type. Supply it together with type and exactly one lookup mode.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match for field (equality mode). Mutually exclusive with from/to and prefix. Not allowed for a sensitive field — use POST /v1/clients/lookup instead so the value is not exposed in the URL.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup. Requires to, and is only allowed on non-sensitive fields that have range queries enabled. Mutually exclusive with value and prefix.

    • getTo

      public Optional<String> getTo()
      Returns:
      Inclusive upper bound for a range lookup. Requires from.

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Match clients whose value for field starts with this prefix. Only allowed on string fields that have range queries enabled. Mutually exclusive with value and from/to.

    • getOrder

      public Optional<ListClientsRequestOrder> getOrder()
      Returns:
      Sort direction for the results: asc (the default) or desc.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ListClientsRequest.Builder builder()