Class EventStreams

Index

Accessors

deliveries

get deliveries(): Deliveries
Returns Deliveries

redeliveries

get redeliveries(): Redeliveries
Returns Redeliveries

Constructors

constructor

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

Methods

list

list(
request?: Management.ListEventStreamsRequestParameters,
requestOptions?: EventStreams.RequestOptions,
): HttpResponsePromise<EventStreamResponseContent[]>
Parameters
- request: Management.ListEventStreamsRequestParameters = {}
- OptionalrequestOptions: EventStreams.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<EventStreamResponseContent[]>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.eventStreams.list()
```

create

create(
request: Management.EventStreamsCreateRequest,
requestOptions?: EventStreams.RequestOptions,
): HttpResponsePromise<CreateEventStreamResponseContent>
Parameters
- request: Management.EventStreamsCreateRequest
- OptionalrequestOptions: EventStreams.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?: EventStreams.RequestOptions,
): HttpResponsePromise<GetEventStreamResponseContent>
Parameters
- id: string
  Unique identifier for the event stream.
- OptionalrequestOptions: EventStreams.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?: EventStreams.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  Unique identifier for the event stream.
- OptionalrequestOptions: EventStreams.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?: Management.UpdateEventStreamRequestContent,
    requestOptions?: EventStreams.RequestOptions,
): HttpResponsePromise<UpdateEventStreamResponseContent>
Parameters
- id: string
  Unique identifier for the event stream.
- request: Management.UpdateEventStreamRequestContent = {}
- OptionalrequestOptions: EventStreams.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: Management.CreateEventStreamTestEventRequestContent,
    requestOptions?: EventStreams.RequestOptions,
): HttpResponsePromise<CreateEventStreamTestEventResponseContent>
Parameters
- id: string
  Unique identifier for the event stream.
- request: Management.CreateEventStreamTestEventRequestContent
- OptionalrequestOptions: EventStreams.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"
    })
```

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: EventStreams.Options

`Protected`_deliveries

_deliveries: undefined | Deliveries

`Protected`_redeliveries

_redeliveries: undefined | Redeliveries

Class EventStreams

Index

Accessors

Constructors

Methods

Properties

Accessors

deliveries

Returns Deliveries

redeliveries

Returns Redeliveries

Constructors

constructor

Parameters

Returns EventStreams

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

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Protected_deliveries

Protected_redeliveries

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options

`Protected`_deliveries

`Protected`_redeliveries