Class Subscriptions

Subscriptions - object-oriented interface

export

Hierarchy

BaseAPI
- Subscriptions

Index

Constructors

constructor

Methods

Constructors

constructor

new Subscriptions(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): Subscriptions

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Subscriptions

Methods

cancel

cancel(subscriptionId: string, options?: any): Promise<AxiosResponse<SubscriptionResult>>

- Defined in src/openapi/api.ts:5479
summary
Cancel a subscription

throws
{RequiredError}

memberof
Subscriptions

Parameters
- subscriptionId: string
  
  Subscription ID
- Optional options: any
Returns Promise<AxiosResponse<SubscriptionResult>>

create

create(subscriptionParams: SubscriptionParams, options?: any): Promise<AxiosResponse<SubscriptionResult>>

- Defined in src/openapi/api.ts:5491
summary
Create a subscription

throws
{RequiredError}

memberof
Subscriptions

Parameters
- subscriptionParams: SubscriptionParams
- Optional options: any
Returns Promise<AxiosResponse<SubscriptionResult>>

list

list(startingAfter?: string, options?: any): Promise<AxiosResponse<SubscriptionListResult>>

- Defined in src/openapi/api.ts:5503
summary
List subscriptions

throws
{RequiredError}

memberof
Subscriptions

Parameters
- Optional startingAfter: string
- Optional options: any
Returns Promise<AxiosResponse<SubscriptionListResult>>

retrieve

retrieve(subscriptionId: string, options?: any): Promise<AxiosResponse<SubscriptionResult>>

- Defined in src/openapi/api.ts:5515
summary
Retrieve a subscription

throws
{RequiredError}

memberof
Subscriptions

Parameters
- subscriptionId: string
  
  Subscription ID
- Optional options: any
Returns Promise<AxiosResponse<SubscriptionResult>>

retrieveByCustomId

retrieveByCustomId(customId: string, options?: any): Promise<AxiosResponse<SubscriptionResult>>

- Defined in src/openapi/api.ts:5527
summary
Retrieve a subscription by custom_id

throws
{RequiredError}

memberof
Subscriptions

Parameters
- customId: string
- Optional options: any
Returns Promise<AxiosResponse<SubscriptionResult>>

Generated using TypeDoc