• management
• SDK
• EventStreamsClient

Class EventStreamsClient

Index

Accessors

deliveriesredeliveries

Constructors

constructor

Methods

listcreategetdeleteupdatetest

Properties

_options_deliveries_redeliveries

Accessors

deliveries

get deliveries(): DeliveriesClient

Returns DeliveriesClient

redeliveries

get redeliveries(): RedeliveriesClient

Returns RedeliveriesClient

Constructors

constructor

new EventStreamsClient(options: BaseClientOptions): EventStreamsClient

Parameters

• options: BaseClientOptions

Returns EventStreamsClient

Methods

list

list(
request?: ListEventStreamsRequestParameters,
requestOptions?: EventStreamsClient.RequestOptions,
): Promise<
Page<EventStreamResponseContent, ListEventStreamsResponseContent>,
>

Parameters

• request: ListEventStreamsRequestParameters = {}
• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<EventStreamResponseContent, ListEventStreamsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.list({ from: "from", take: 1 })Copy

create

create(
request: Management.EventStreamsCreateRequest,
requestOptions?: EventStreamsClient.RequestOptions,
): HttpResponsePromise<CreateEventStreamResponseContent>

Parameters

• request: Management.EventStreamsCreateRequest
• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateEventStreamResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.create({ destination: { type: "webhook", configuration: { webhook_endpoint: "webhook_endpoint", webhook_authorization: { method: "basic", username: "username" } } } })Copy

get

get(
id: string,
requestOptions?: EventStreamsClient.RequestOptions,
): HttpResponsePromise<GetEventStreamResponseContent>

Parameters

• id: string

Unique identifier for the event stream.

• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetEventStreamResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.get("id")Copy

delete

delete(
id: string,
requestOptions?: EventStreamsClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

• id: string

Unique identifier for the event stream.

• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.delete("id")Copy

update

update(
id: string,
request?: UpdateEventStreamRequestContent,
requestOptions?: EventStreamsClient.RequestOptions,
): HttpResponsePromise<UpdateEventStreamResponseContent>

Parameters

• id: string

Unique identifier for the event stream.

• request: UpdateEventStreamRequestContent = {}
• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateEventStreamResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.update("id")Copy

test

test(
id: string,
request: CreateEventStreamTestEventRequestContent,
requestOptions?: EventStreamsClient.RequestOptions,
): HttpResponsePromise<CreateEventStreamTestEventResponseContent>

Parameters

• id: string

Unique identifier for the event stream.

• request: CreateEventStreamTestEventRequestContent
• OptionalrequestOptions: EventStreamsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateEventStreamTestEventResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.test("id", { event_type: "group.created" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_deliveries

_deliveries: DeliveriesClient | undefined

Protected_redeliveries

_redeliveries: RedeliveriesClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors deliveriesredeliveries Constructors constructor Methods listcreategetdeleteupdatetest Properties _options_deliveries_redeliveries