Package ai.vectros.resources.identity.requests

Class ListClientsRequest.Builder

java.lang.Object

ai.vectros.resources.identity.requests.ListClientsRequest.Builder

Enclosing class:

ListClientsRequest

public static final class ListClientsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListClientsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListClientsRequest.Builder	additionalProperty(String key, Object value)
ListClientsRequest	build()
ListClientsRequest.Builder	externalId(String externalId)
ListClientsRequest.Builder	externalId(Optional<String> externalId)	Look up a client by your own externalId.
ListClientsRequest.Builder	field(String field)
ListClientsRequest.Builder	field(Optional<String> field)	Name of the lookup field to filter by.
ListClientsRequest.Builder	from(ListClientsRequest other)
ListClientsRequest.Builder	from(String from)
ListClientsRequest.Builder	from(Optional<String> from)	Inclusive lower bound for a range lookup.
ListClientsRequest.Builder	limit(Long limit)
ListClientsRequest.Builder	limit(Optional<Long> limit)	Maximum number of clients to return per page (1–100; defaults to 20).
ListClientsRequest.Builder	order(ListClientsRequestOrder order)
ListClientsRequest.Builder	order(Optional<ListClientsRequestOrder> order)	Sort direction for the results: asc (the default) or desc.
ListClientsRequest.Builder	orgId(String orgId)
ListClientsRequest.Builder	orgId(Optional<String> orgId)	Return only clients belonging to this organization.
ListClientsRequest.Builder	prefix(String prefix)
ListClientsRequest.Builder	prefix(Optional<String> prefix)	Match clients whose value for field starts with this prefix.
ListClientsRequest.Builder	startFrom(String startFrom)
ListClientsRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListClientsRequest.Builder	to(String to)
ListClientsRequest.Builder	to(Optional<String> to)	Inclusive upper bound for a range lookup.
ListClientsRequest.Builder	type(String type)
ListClientsRequest.Builder	type(Optional<String> type)	Record type of the schema whose lookup fields you are querying.
ListClientsRequest.Builder	userId(String userId)
ListClientsRequest.Builder	userId(Optional<String> userId)	Return only clients owned by this user.
ListClientsRequest.Builder	value(String value)
ListClientsRequest.Builder	value(Optional<String> value)	Exact value to match for field (equality mode).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public ListClientsRequest.Builder from(ListClientsRequest other)

orgId

public ListClientsRequest.Builder orgId(Optional<String> orgId)

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.

orgId

public ListClientsRequest.Builder orgId(String orgId)

userId

public ListClientsRequest.Builder userId(Optional<String> userId)

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.

userId

public ListClientsRequest.Builder userId(String userId)

externalId

public ListClientsRequest.Builder externalId(Optional<String> externalId)

Look up a client by your own externalId. Returns a single-element list, or an empty list if no client matches.

externalId

public ListClientsRequest.Builder externalId(String externalId)

startFrom

public ListClientsRequest.Builder startFrom(Optional<String> startFrom)

Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

startFrom

public ListClientsRequest.Builder startFrom(String startFrom)

limit

public ListClientsRequest.Builder limit(Optional<Long> limit)

Maximum number of clients to return per page (1–100; defaults to 20).

limit

public ListClientsRequest.Builder limit(Long limit)

type

public ListClientsRequest.Builder type(Optional<String> type)

Record type of the schema whose lookup fields you are querying. Must be supplied together with field and exactly one lookup mode.

type

public ListClientsRequest.Builder type(String type)

field

public ListClientsRequest.Builder field(Optional<String> field)

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.

field

public ListClientsRequest.Builder field(String field)

value

public ListClientsRequest.Builder value(Optional<String> value)

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.

value

public ListClientsRequest.Builder value(String value)

from

public ListClientsRequest.Builder from(Optional<String> from)

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.

from

public ListClientsRequest.Builder from(String from)

to

public ListClientsRequest.Builder to(Optional<String> to)

Inclusive upper bound for a range lookup. Requires from.

to

public ListClientsRequest.Builder to(String to)

prefix

public ListClientsRequest.Builder prefix(Optional<String> prefix)

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.

prefix

public ListClientsRequest.Builder prefix(String prefix)

order

public ListClientsRequest.Builder order(Optional<ListClientsRequestOrder> order)

Sort direction for the results: asc (the default) or desc.

order

public ListClientsRequest.Builder order(ListClientsRequestOrder order)

build

public ListClientsRequest build()

additionalProperty

public ListClientsRequest.Builder additionalProperty(String key,
 Object value)

additionalProperties

public ListClientsRequest.Builder additionalProperties(Map<String,Object> additionalProperties)