Package ai.vectros.resources.identity.requests

Class ListOrgsRequest

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

  • Method Details

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Return only organizations owned by this user, given as the Vectros-assigned ID (UUID) of a user. To resolve a user ID from your own identifier, call GET /v1/users?externalId=.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Look up an organization by your own identifier. Returns a list with the single matching organization, or an empty list if none 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 organizations to return per page (1–100; defaults to 20).

    • getType

      public Optional<String> getType()
      Returns:
      The schema record type whose lookup fields you want to query. Must be supplied together with field and exactly one lookup mode (value, from/to, or prefix).

    • getField

      public Optional<String> getField()
      Returns:
      The schema-declared lookup field to filter on. Must be one of the lookup fields defined on the schema named by type. Supplied together with type and one lookup mode.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match for field (equality lookup). Mutually exclusive with from/to and prefix. Not allowed for a sensitive field — use POST /v1/orgs/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 supported on non-sensitive fields that have range lookups 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 all values for field that start with this prefix. Only supported on string fields that have range lookups enabled. Mutually exclusive with value and from/to.

    • getOrder

      public Optional<ListOrgsRequestOrder> getOrder()
      Returns:
      Sort direction for lookup results: asc (ascending, the default) or desc (descending).

    • 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 ListOrgsRequest.Builder builder()