Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SubscriptionsApi

Index

Constructors

  • new SubscriptionsApi(configuration: Configuration, requestFactory?: SubscriptionsApiRequestFactory, responseProcessor?: SubscriptionsApiResponseProcessor): SubscriptionsApi

Properties

api: ObservableSubscriptionsApi

Methods

  • Deletes a trigger for the given subscription. This object represents the trigger where the subscription owner has subscribed to. Delete trigger of subscription.

    Parameters

    • id: string

      Specifies the unique subscription ID (starts with sub_).

    • triggerId: string

      Specifies the unique subscription ID (starts with sub_).

    • Optional _options: Configuration

    Returns Promise<TriggerDeleteResponse>

  • Returns a subscription for the given project. This object represents the subscription where the project owner has subscribed to. Get subscription of project.

    Parameters

    • id: string

      Specifies the unique subscription ID (starts with sub_).

    • Optional _options: Configuration

    Returns Promise<SubscriptionResponse>

  • Returns a list of subscriptions for the given project. This object represents the subscriptions where the project owner has subscribed to. Subscriptions are returned sorted by creation date, with the most recently created subscriptions appearing first. By default, a maximum of 10 subscriptions are shown per page. List subscriptions of project.

    Parameters

    Returns Promise<SubscriptionListResponse>

  • Returns a trigger for the given id. This object represents the trigger where the subscription owner has subscribed to. Get trigger by id.

    Parameters

    • id: string

      Specifies the unique subscription ID (starts with sub_).

    • triggerId: string

      Specifies the unique subscription ID (starts with sub_).

    • Optional _options: Configuration

    Returns Promise<TriggerResponse>

  • Returns a list of triggers for the given subscription. This object represents the triggers where the subscription owner has subscribed to. Triggers are returned sorted by creation date, with the most recently created triggers appearing first. By default, a maximum of 10 triggers are shown per page. List triggers of subscription.

    Parameters

    • id: string

      Specifies the unique subscription ID (starts with sub_).

    • Optional _options: Configuration

    Returns Promise<BaseEntityListResponseTriggerResponse>

  • Lists logs of the triggered subscriptions for the given project. This object represents the logs of the triggered subscriptions where the project owner has subscribed to. List logs of triggered subscriptions.

    Parameters

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional topic: APITopic

      Specifies the topic of the subscription logs

    • Optional status: Status

      Specifies the status of the subscription logs

    • Optional object: string

      Specifies the object ID of the object related to triggered notification

    • Optional subscription: string

      Specifies the subscription ID

    • Optional trigger: string

      Specifies the trigger ID

    • Optional requestID: string

      Specifies the request ID

    • Optional _options: Configuration

    Returns Promise<BaseEntityListResponseLogResponse>

Generated using TypeDoc