SubscriptionServiceAsync

Types

Link copied to clipboard
interface WithRawResponse

A view of SubscriptionServiceAsync that provides access to raw HTTP responses for each method.

Functions

Link copied to clipboard
abstract suspend fun create(params: EventSubscriptionCreateParams, requestOptions: RequestOptions = RequestOptions.none()): EventSubscription

Create a new event subscription.

Link copied to clipboard
abstract suspend fun delete(params: EventSubscriptionDeleteParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun delete(eventSubscriptionToken: String, requestOptions: RequestOptions)

open suspend fun delete(eventSubscriptionToken: String, params: EventSubscriptionDeleteParams = EventSubscriptionDeleteParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Delete an event subscription.

Link copied to clipboard
open suspend fun list(requestOptions: RequestOptions): EventSubscriptionListPageAsync

abstract suspend fun list(params: EventSubscriptionListParams = EventSubscriptionListParams.none(), requestOptions: RequestOptions = RequestOptions.none()): EventSubscriptionListPageAsync

List all the event subscriptions.

Link copied to clipboard
abstract suspend fun listAttempts(params: EventSubscriptionListAttemptsParams, requestOptions: RequestOptions = RequestOptions.none()): EventSubscriptionListAttemptsPageAsync
open suspend fun listAttempts(eventSubscriptionToken: String, requestOptions: RequestOptions): EventSubscriptionListAttemptsPageAsync

open suspend fun listAttempts(eventSubscriptionToken: String, params: EventSubscriptionListAttemptsParams = EventSubscriptionListAttemptsParams.none(), requestOptions: RequestOptions = RequestOptions.none()): EventSubscriptionListAttemptsPageAsync

List all the message attempts for a given event subscription.

Link copied to clipboard
abstract suspend fun recover(params: EventSubscriptionRecoverParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun recover(eventSubscriptionToken: String, requestOptions: RequestOptions)

open suspend fun recover(eventSubscriptionToken: String, params: EventSubscriptionRecoverParams = EventSubscriptionRecoverParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Resend all failed messages since a given time.

Link copied to clipboard
abstract suspend fun replayMissing(params: EventSubscriptionReplayMissingParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun replayMissing(eventSubscriptionToken: String, requestOptions: RequestOptions)

open suspend fun replayMissing(eventSubscriptionToken: String, params: EventSubscriptionReplayMissingParams = EventSubscriptionReplayMissingParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Replays messages to the endpoint. Only messages that were created after begin will be sent. Messages that were previously sent to the endpoint are not resent. Message will be retried if endpoint responds with a non-2xx status code. See Retry Schedule for details.

Link copied to clipboard
abstract suspend fun retrieve(params: EventSubscriptionRetrieveParams, requestOptions: RequestOptions = RequestOptions.none()): EventSubscription
open suspend fun retrieve(eventSubscriptionToken: String, requestOptions: RequestOptions): EventSubscription

open suspend fun retrieve(eventSubscriptionToken: String, params: EventSubscriptionRetrieveParams = EventSubscriptionRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): EventSubscription

Get an event subscription.

Link copied to clipboard
abstract suspend fun retrieveSecret(params: EventSubscriptionRetrieveSecretParams, requestOptions: RequestOptions = RequestOptions.none()): SubscriptionRetrieveSecretResponse
open suspend fun retrieveSecret(eventSubscriptionToken: String, requestOptions: RequestOptions): SubscriptionRetrieveSecretResponse

open suspend fun retrieveSecret(eventSubscriptionToken: String, params: EventSubscriptionRetrieveSecretParams = EventSubscriptionRetrieveSecretParams.none(), requestOptions: RequestOptions = RequestOptions.none()): SubscriptionRetrieveSecretResponse

Get the secret for an event subscription.

Link copied to clipboard
abstract suspend fun rotateSecret(params: EventSubscriptionRotateSecretParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun rotateSecret(eventSubscriptionToken: String, requestOptions: RequestOptions)

open suspend fun rotateSecret(eventSubscriptionToken: String, params: EventSubscriptionRotateSecretParams = EventSubscriptionRotateSecretParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.

Link copied to clipboard
abstract suspend fun sendSimulatedExample(params: EventSubscriptionSendSimulatedExampleParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun sendSimulatedExample(eventSubscriptionToken: String, requestOptions: RequestOptions)

open suspend fun sendSimulatedExample(eventSubscriptionToken: String, params: EventSubscriptionSendSimulatedExampleParams = EventSubscriptionSendSimulatedExampleParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Send an example message for event.

Link copied to clipboard
abstract suspend fun update(params: EventSubscriptionUpdateParams, requestOptions: RequestOptions = RequestOptions.none()): EventSubscription

open suspend fun update(eventSubscriptionToken: String, params: EventSubscriptionUpdateParams, requestOptions: RequestOptions = RequestOptions.none()): EventSubscription

Update an event subscription.

Link copied to clipboard

Returns a view of this service with the given option modifications applied.

Link copied to clipboard

Returns a view of this service that provides access to raw HTTP responses for each method.