Class SubscriptionsApiWrapper

Hierarchy

BaseApiWrapper<SubscriptionsApi>
- SubscriptionsApiWrapper

Index

Constructors

constructor

Properties

Accessors

observers

Methods

Constructors

constructor

new SubscriptionsApiWrapper(accessToken: string, basePath?: string): SubscriptionsApiWrapper

Overrides BaseApiWrapper.constructor
- Defined in src/apis/subscriptionsApiWrapper.ts:16
Parameters
- accessToken: string
- Optional basePath: string
Returns SubscriptionsApiWrapper

Properties

Protected Readonly api

api: SubscriptionsApi

Static type

type: string = "subscriptions"

Accessors

observers

get observers(): Observer[]

Inherited from BaseApiWrapper.observers
- Defined in src/apis/baseApiWrapper.ts:36
Returns Observer[]

Methods

create

create(req: CreateSubscriptionRequest): Promise<SubscriptionResponse>

- Defined in src/apis/subscriptionsApiWrapper.ts:24
Create a subscription.

Parameters
- req: CreateSubscriptionRequest
  
  Parameters to create a subscription.
Returns Promise<SubscriptionResponse>

delete

delete(id: string): Promise<SubscriptionDeleteResponse>

- Defined in src/apis/subscriptionsApiWrapper.ts:50
Delete a subscription by providing its subscription id.

Parameters
- id: string
  
  Id of the subscription
Returns Promise<SubscriptionDeleteResponse>

get

get(req: GetSubscriptionRequest): Promise<SubscriptionResponse>

- Defined in src/apis/subscriptionsApiWrapper.ts:42
Retrieves the details of an existing subscription. Supply the unique subscription ID.

Supply the unique subscription ID.

Parameters
- req: GetSubscriptionRequest
  
  Criteria to get subscription by.
Returns Promise<SubscriptionResponse>

list

list(): Promise<SubscriptionListResponse>

- Defined in src/apis/subscriptionsApiWrapper.ts:32
Returns a list of subscriptions. The subscriptions are returned sorted by creation date, with the most recently created appearing first. By default, a maximum of 10 subscriptions are shown per page.

Returns Promise<SubscriptionListResponse>

subscribe

subscribe(observer: Observer): void

Inherited from BaseApiWrapper.subscribe
- Defined in src/apis/baseApiWrapper.ts:32
Parameters
- observer: Observer
Returns void

Generated using TypeDoc