Class SubscriptionItems

Hierarchy

SubscriptionItems

Index

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TLineItem>(subscriptionID: string, lineItem: LineItem<any, any, any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Create a new 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.
- lineItem: LineItem<any, any, any, any, any>
  
  Required fields: ProductID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/SubscriptionItems.ts:65

Delete

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

Get

Get<TLineItem>(subscriptionID: string, subscriptionItemID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Get a single subscription item. 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.
- subscriptionItemID: string
  
  ID of the subscription item.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/SubscriptionItems.ts:87

List

List<TLineItem>(subscriptionID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "ProductID")[];
    sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TLineItem>>>
Get a list of subscription items. 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.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "ProductID")[];
      sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "ProductID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TLineItem>>>
- Defined in api/SubscriptionItems.ts:43

Patch

Patch<TLineItem>(subscriptionID: string, subscriptionItemID: string, lineItem: PartialObjectDeep<LineItem<any, any, any, any, any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Partially update a subscription item. 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.
- subscriptionItemID: string
  
  ID of the subscription item.
- lineItem: PartialObjectDeep<LineItem<any, any, any, any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/SubscriptionItems.ts:155

Save

Save<TLineItem>(subscriptionID: string, subscriptionItemID: string, lineItem: LineItem<any, any, any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Create or update a subscription item. If an object with the same ID already exists, it will be overwritten. 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.
- subscriptionItemID: string
  
  ID of the subscription item.
- lineItem: LineItem<any, any, any, any, any>
  
  Required fields: ProductID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/SubscriptionItems.ts:110

Class SubscriptionItems

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns SubscriptionItems

Create

Type Parameters

TLineItem extends LineItem<any, any, any, any, any, TLineItem>

Parameters

subscriptionID: string

lineItem: LineItem<any, any, any, any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLineItem>>

Delete

Parameters

subscriptionID: string

subscriptionItemID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TLineItem extends LineItem<any, any, any, any, any, TLineItem>

Parameters

subscriptionID: string

subscriptionItemID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLineItem>>

List

Type Parameters

TLineItem extends LineItem<any, any, any, any, any, TLineItem>

Parameters

subscriptionID: string

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "ProductID")[]; sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "ProductID")[]

Optional sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TLineItem>>>

Patch

Type Parameters

TLineItem extends LineItem<any, any, any, any, any, TLineItem>

Parameters

subscriptionID: string

subscriptionItemID: string

lineItem: PartialObjectDeep<LineItem<any, any, any, any, any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLineItem>>

Save

Type Parameters

TLineItem extends LineItem<any, any, any, any, any, TLineItem>

Parameters

subscriptionID: string

subscriptionItemID: string

lineItem: LineItem<any, any, any, any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLineItem>>

Settings

Member Visibility

Theme

`Private` impersonating

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "ProductID")[];
sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "ProductID")[]

`Optional` sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[]