Class BundleLineItems

Hierarchy

BundleLineItems

Index

Properties

Methods

As Create Delete

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TLineItem>(direction: OrderDirection, orderID: string, bundleID: string, bundleItems: BundleItems<any, any, any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLineItem>>
Create a new bundle line 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
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- bundleID: string
  
  ID of the bundle.
- bundleItems: BundleItems<any, any, any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/BundleLineItems.ts:34

Delete

Delete(direction: OrderDirection, orderID: string, bundleID: string, bundleItemID: string, requestOptions?: RequestOptions): Promise<void>
Delete a bundle line item. Check out the docs for more info
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- bundleID: string
  
  ID of the bundle.
- bundleItemID: string
  
  ID of the bundle item.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/BundleLineItems.ts:58

Generated using TypeDoc