Class SubscriptionAPI

Hierarchy

APIWrapper
- SubscriptionAPI

Index

Constructors

constructor

Properties

iugu

Methods

Constructors

constructor

new SubscriptionAPI(iugu: Iugu): SubscriptionAPI

Inherited from APIWrapper.constructor
- Defined in api/api-wrapper.ts:14
Parameters
- iugu: Iugu
Returns SubscriptionAPI

Properties

Protected iugu

iugu: Iugu

Methods

activate

activate(subscription: string | Subscription): Promise<Subscription>

- Defined in api/subscription.ts:75
Activates an existing subscription

Parameters
- subscription: string | Subscription
  
  the id or object of the subscription that will be activated
Returns Promise<Subscription>

a promise that may resolve to the associated subscription object

create

create(data: NewSubscription): Promise<Subscription>

- Defined in api/subscription.ts:42
Creates a new Subscription

Parameters
- data: NewSubscription
  
  the data for the subscription that will be created
Returns Promise<Subscription>

a promise that may resolve to the created object

delete

delete(subscription: string | Subscription): Promise<Subscription>

- Defined in api/subscription.ts:123
Deletes an existing subscription

Parameters
- subscription: string | Subscription
  
  the id or object of the subscription that will be deleted
Returns Promise<Subscription>

a promise that may resolve to the deleted subscription object

get

get(subscription: string | Subscription): Promise<Subscription>

- Defined in api/subscription.ts:52
Retrieves information of an existing subscription

Parameters
- subscription: string | Subscription
  
  the id or object of the subscription that will be retrieved
Returns Promise<Subscription>

a promise that may resolve to the subscription object

list

list(): PagedRequest<void, Subscription>

- Defined in api/subscription.ts:65
Returns all existing Subscriptions

Returns PagedRequest<void, Subscription>

Private recreateExpires

recreateExpires(sub: Subscription): Subscription

- Defined in api/subscription.ts:28
Parameters
- sub: Subscription
Returns Subscription

Private subscriptionParamToString

subscriptionParamToString(subscription: string | Subscription): string

- Defined in api/subscription.ts:16
Parameters
- subscription: string | Subscription
Returns string

suspend

suspend(subscription: string | Subscription): Promise<Subscription>

- Defined in api/subscription.ts:91
Suspends an existing subscription

Parameters
- subscription: string | Subscription
  
  the id or object of the subscription that will be suspended
Returns Promise<Subscription>

a promise that may resolve to the associated subscription object

update

update(subscription: string | Subscription, newData: UpdateSubscription): Promise<Subscription>

- Defined in api/subscription.ts:107
Updates an existing subscription

Parameters
- subscription: string | Subscription
  
  the id or object of the subscription that will be modified
- newData: UpdateSubscription
Returns Promise<Subscription>

a promise that may resolve to the associated subscription object

Generated using TypeDoc