Class RecipientSetsClient

Tenant recipient-set collection.

Index

Constructors

Methods

create getByRef list

Constructors

constructor

new RecipientSetsClient(
options: RecipientSetsClientOptions,
): RecipientSetsClient
Parameters
- options: RecipientSetsClientOptions
  The underlying admin client and tenant slug.
Returns RecipientSetsClient
- Defined in recipient-sets/client.ts:56

Methods

create

create(
request: CreateRecipientSetRequest,
options?: RequestOptions,
): Promise<RecipientSet>
Creates a recipient set.
Parameters
- request: CreateRecipientSetRequest
  The set reference and optional name/description.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSet>
The created recipient set.

Throws
Error When the set reference is invalid.

Throws
ConflictException When the reference already exists.
- Defined in recipient-sets/client.ts:112

getByRef

getByRef(setRef: string, options?: RequestOptions): Promise<RecipientSet>
Gets a recipient set by its immutable reference.
Parameters
- setRef: string
  The recipient-set reference.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSet>
The hydrated recipient set.

Throws
NotFoundException When the set is not visible.
- Defined in recipient-sets/client.ts:94

list

list(options?: ListRecipientSetsOptions): Promise<Paged<RecipientSet>>
Lists recipient sets with optional filters.
Parameters
- options: ListRecipientSetsOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<RecipientSet>>
A lazily paginating collection of recipient sets.

Throws
ApiException When the control plane returns a non-success status.
- Defined in recipient-sets/client.ts:70