Class BundleLineItems

Index

Methods

As Create Delete

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
BundleLineItems.As().List() // lists BundleLineItems using the impersonated users' token
```
- Defined in api/BundleLineItems.ts:77

Create

Create<TLineItem extends LineItem<any, any, any, any, any>>(
    direction: OrderDirection,
    orderID: string,
    bundleID: string,
    bundleItems: BundleItems,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Create a bundle line item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- bundleID: string
  ID of the bundle.
- bundleItems: BundleItems
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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.
- orderID: string
  ID of the order.
- bundleID: string
  ID of the bundle.
- bundleItemID: string
  ID of the bundle item.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/BundleLineItems.ts:58