Class RecipientSet

A reusable collection of recipients.

Hierarchy (View Summary)

Entity<RecipientSetData>
- RecipientSet

Index

Constructors

Properties

Accessors

createdAt data description displayName id isDeleted setRef tenantId updatedAt

Methods

delete members reload update

Constructors

constructor

new RecipientSet(options: EntityOptions<RecipientSetData>): RecipientSet
Parameters
- options: EntityOptions<RecipientSetData>
  The client, path, backing data, and delete state.
Returns RecipientSet
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

createdAt

get createdAt(): string
Creation timestamp.

Returns string
- Defined in recipient-sets/entity.ts:47

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

description

get description(): string | null | undefined
Optional description.

Returns string | null | undefined
- Defined in recipient-sets/entity.ts:42

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in recipient-sets/entity.ts:37

id

get id(): string
Recipient-set identifier.

Returns string
- Defined in recipient-sets/entity.ts:22

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

setRef

get setRef(): string
Immutable recipient-set reference.

Returns string
- Defined in recipient-sets/entity.ts:32

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in recipient-sets/entity.ts:27

updatedAt

get updatedAt(): string
Last-update timestamp.

Returns string
- Defined in recipient-sets/entity.ts:52

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

members

members(): RecipientSetMembersClient
Accesses this set's membership.

Returns RecipientSetMembersClient
A client for member operations.
- Defined in recipient-sets/entity.ts:108

reload

reload(options?: RequestOptions): Promise<RecipientSet>
Re-fetches this recipient set.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSet>
A fresh snapshot.

Throws
NotFoundException When the set is no longer visible.
- Defined in recipient-sets/entity.ts:65

update

update(
request: UpdateRecipientSetRequest,
options?: RequestOptions,
): Promise<RecipientSet>
Replaces the name and description.
Parameters
- request: UpdateRecipientSetRequest
  The new values; null clears a field.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSet>
The updated recipient set.
- Defined in recipient-sets/entity.ts:84