Class BundleSubscriptionItems

Hierarchy

BundleSubscriptionItems

Index

Properties

Methods

As Create Delete

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): BundleSubscriptionItems
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
BundleSubscriptionItems.As().List() // lists BundleSubscriptionItems using the impersonated users' token
```
Returns BundleSubscriptionItems
- Defined in api/BundleSubscriptionItems.ts:74

Create

Create<TLineItem>(subscriptionID: string, bundleID: string, bundleItems: BundleItems<any, any, any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Create a new bundle subscription item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any, TLineItem>
Parameters
- subscriptionID: string
  
  ID of the subscription.
- bundleID: string
  
  ID of the bundle.
- bundleItems: BundleItems<any, any, any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/BundleSubscriptionItems.ts:32

Delete

Delete(subscriptionID: string, bundleID: string, bundleItemID: string, requestOptions?: RequestOptions): Promise<void>
Delete a bundle subscription item. Check out the docs for more info
Parameters
- subscriptionID: string
  
  ID of the subscription.
- bundleID: string
  
  ID of the bundle.
- bundleItemID: string
  
  ID of the bundle item.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/BundleSubscriptionItems.ts:55

Generated using TypeDoc