• management
• SDK
• DeliveriesClient

Class DeliveriesClient

Index

Constructors

constructor

Methods

listgetHistory

Properties

_options

Constructors

constructor

new DeliveriesClient(options: BaseClientOptions): DeliveriesClient

Parameters

• options: BaseClientOptions

Returns DeliveriesClient

Methods

list

list(
id: string,
request?: ListEventStreamDeliveriesRequestParameters,
requestOptions?: DeliveriesClient.RequestOptions,
): HttpResponsePromise<EventStreamDelivery[]>

Parameters

• id: string

Unique identifier for the event stream.

• request: ListEventStreamDeliveriesRequestParameters = {}
• OptionalrequestOptions: DeliveriesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<EventStreamDelivery[]>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.deliveries.list("id", { statuses: "statuses", event_types: "event_types", date_from: "date_from", date_to: "date_to", from: "from", take: 1 })Copy

getHistory

getHistory(
id: string,
event_id: string,
requestOptions?: DeliveriesClient.RequestOptions,
): HttpResponsePromise<GetEventStreamDeliveryHistoryResponseContent>

Parameters

• id: string

Unique identifier for the event stream.

• event_id: string

Unique identifier for the event

• OptionalrequestOptions: DeliveriesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetEventStreamDeliveryHistoryResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.eventStreams.deliveries.getHistory("id", "event_id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listgetHistory Properties _options