Class DeliveriesClient

Index

Constructors

Methods

list getHistory

Properties

Constructors

constructor

new DeliveriesClient(options: BaseClientOptions): DeliveriesClient
Parameters
- options: BaseClientOptions
Returns DeliveriesClient

Methods

list

list(
    id: string,
    request?: ListEventStreamDeliveriesRequestParameters,
    requestOptions?: DeliveriesClient.RequestOptions,
): Promise<
    Page<EventStreamDelivery, ListEventStreamDeliveriesResponseContent>,
>
Parameters
- id: string
  Unique identifier for the event stream.
- request: ListEventStreamDeliveriesRequestParameters = {}
- OptionalrequestOptions: DeliveriesClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<EventStreamDelivery, ListEventStreamDeliveriesResponseContent>>
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
    })
```

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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>