Class EventStreamsClient

Index

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,
): HttpResponsePromise<EventStreamResponseContent[]>
Parameters
- request: ListEventStreamsRequestParameters = {}
- OptionalrequestOptions: EventStreamsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<EventStreamResponseContent[]>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.eventStreams.list({
        from: "from",
        take: 1
    })
```

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

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

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

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

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: "user.created"
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_deliveries

_deliveries: DeliveriesClient | undefined

`Protected`_redeliveries

_redeliveries: RedeliveriesClient | undefined

Class EventStreamsClient

Index

Accessors

Constructors

Methods

Properties

Accessors

deliveries

Returns DeliveriesClient

redeliveries

Returns RedeliveriesClient

Constructors

constructor

Parameters

Returns EventStreamsClient

Methods

list

Parameters

Returns HttpResponsePromise<EventStreamResponseContent[]>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateEventStreamResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetEventStreamResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateEventStreamResponseContent>

Throws

Throws

Throws

Throws

Example

test

Parameters

Returns HttpResponsePromise<CreateEventStreamTestEventResponseContent>

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_deliveries

Protected_redeliveries

Settings

On This Page

`Protected` `Readonly`_options

`Protected`_deliveries

`Protected`_redeliveries