Class Deliveries

Index

Constructors

Methods

list getHistory _getAuthorizationHeader

Properties

Constructors

constructor

new Deliveries(_options: Deliveries.Options): Deliveries
Parameters
- _options: Deliveries.Options
Returns Deliveries

Methods

list

list(
    id: string,
    request?: ListEventStreamDeliveriesRequestParameters,
    requestOptions?: Deliveries.RequestOptions,
): HttpResponsePromise<EventStreamDelivery[]>
Parameters
- id: string
  Unique identifier for the event stream.
- request: ListEventStreamDeliveriesRequestParameters = {}
- OptionalrequestOptions: Deliveries.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
    })
```

getHistory

getHistory(
    id: string,
    eventId: string,
    requestOptions?: Deliveries.RequestOptions,
): HttpResponsePromise<GetEventStreamDeliveryHistoryResponseContent>
Parameters
- id: string
  Unique identifier for the event stream.
- eventId: string
  Unique identifier for the event
- OptionalrequestOptions: Deliveries.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Deliveries.Options