Class SubscriptionsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getAll getAllWithHttpInfo getById getByIdWithHttpInfo update updateBatch updateBatchWithHttpInfo updateWithHttpInfo

Constructors

constructor

new SubscriptionsApi(configuration, requestFactory?, responseProcessor?): SubscriptionsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: SubscriptionsApiRequestFactory
- OptionalresponseProcessor: SubscriptionsApiResponseProcessor
Returns SubscriptionsApi
- Defined in codegen/webhooks/types/PromiseAPI.ts:100

Methods

archiveWithHttpInfo

archiveWithHttpInfo(subscriptionId, appId, _options?): Promise<HttpInfo<void>>
Delete an existing event subscription by ID. Delete event subscription
Parameters
- subscriptionId: number
  The ID of the event subscription.
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:114

create

create(appId, subscriptionCreateRequest, _options?): Promise<SubscriptionResponse>
Create new event subscription for the specified app. Create an event subscription
Parameters
- appId: number
  The ID of the app.
- subscriptionCreateRequest: SubscriptionCreateRequest
- Optional_options: Configuration
Returns Promise<SubscriptionResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:147

createWithHttpInfo

createWithHttpInfo(appId, subscriptionCreateRequest, _options?): Promise<HttpInfo<SubscriptionResponse>>
Create new event subscription for the specified app. Create an event subscription
Parameters
- appId: number
  The ID of the app.
- subscriptionCreateRequest: SubscriptionCreateRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<SubscriptionResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:136

getAll

getAll(appId, _options?): Promise<SubscriptionListResponse>
Retrieve event subscriptions for the specified app. Read event subscriptions
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<SubscriptionListResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:167

getAllWithHttpInfo

getAllWithHttpInfo(appId, _options?): Promise<HttpInfo<SubscriptionListResponse>>
Retrieve event subscriptions for the specified app. Read event subscriptions
Parameters
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<HttpInfo<SubscriptionListResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:157

getById

getById(subscriptionId, appId, _options?): Promise<SubscriptionResponse>
Retrieve a specific event subscription by ID. Read an event subscription
Parameters
- subscriptionId: number
  The ID of the event subscription.
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<SubscriptionResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:189

getByIdWithHttpInfo

getByIdWithHttpInfo(subscriptionId, appId, _options?): Promise<HttpInfo<SubscriptionResponse>>
Retrieve a specific event subscription by ID. Read an event subscription
Parameters
- subscriptionId: number
  The ID of the event subscription.
- appId: number
  The ID of the app.
- Optional_options: Configuration
Returns Promise<HttpInfo<SubscriptionResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:178

update

update(subscriptionId, appId, subscriptionPatchRequest, _options?): Promise<SubscriptionResponse>
Update an existing event subscription by ID. Update an event subscription
Parameters
- subscriptionId: number
  The ID of the event subscription.
- appId: number
  The ID of the app.
- subscriptionPatchRequest: SubscriptionPatchRequest
- Optional_options: Configuration
Returns Promise<SubscriptionResponse>
- Defined in codegen/webhooks/types/PromiseAPI.ts:213

updateBatch

updateBatch(appId, batchInputSubscriptionBatchUpdateRequest, _options?): Promise<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>
Batch create event subscriptions for the specified app. Batch create event subscriptions
Parameters
- appId: number
  The ID of the app.
- batchInputSubscriptionBatchUpdateRequest: BatchInputSubscriptionBatchUpdateRequest
- Optional_options: Configuration
Returns Promise<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>
- Defined in codegen/webhooks/types/PromiseAPI.ts:235

updateBatchWithHttpInfo

updateBatchWithHttpInfo(appId, batchInputSubscriptionBatchUpdateRequest, _options?): Promise<HttpInfo<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>>
Batch create event subscriptions for the specified app. Batch create event subscriptions
Parameters
- appId: number
  The ID of the app.
- batchInputSubscriptionBatchUpdateRequest: BatchInputSubscriptionBatchUpdateRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:224

updateWithHttpInfo

updateWithHttpInfo(subscriptionId, appId, subscriptionPatchRequest, _options?): Promise<HttpInfo<SubscriptionResponse>>
Update an existing event subscription by ID. Update an event subscription
Parameters
- subscriptionId: number
  The ID of the event subscription.
- appId: number
  The ID of the app.
- subscriptionPatchRequest: SubscriptionPatchRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<SubscriptionResponse>>
- Defined in codegen/webhooks/types/PromiseAPI.ts:201

Class SubscriptionsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SubscriptionsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<SubscriptionResponse>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<SubscriptionResponse>>

getAll

Parameters

Returns Promise<SubscriptionListResponse>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<SubscriptionListResponse>>

getById

Parameters

Returns Promise<SubscriptionResponse>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<SubscriptionResponse>>

update

Parameters

Returns Promise<SubscriptionResponse>

updateBatch

Parameters

Returns Promise<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>

updateBatchWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseSubscriptionResponse | BatchResponseSubscriptionResponseWithErrors>>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<SubscriptionResponse>>

Settings

On This Page