Class InventoryIntegrations

Hierarchy

InventoryIntegrations

Index

Properties

Methods

As Delete Get Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Delete

Delete(requestOptions?: RequestOptions): Promise<void>
Delete an inventory integration. Check out the docs for more info
Parameters
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryIntegrations.ts:71

Get

Get<TInventoryIntegration>(requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryIntegration>>
Get a single inventory integration. Check out the docs for more info
Type Parameters
- TInventoryIntegration extends InventoryIntegration
Parameters
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryIntegration>>
- Defined in api/InventoryIntegrations.ts:30

Patch

Patch<TInventoryIntegration>(inventoryIntegration: PartialObjectDeep<InventoryIntegration>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryIntegration>>
Partially update an inventory integration. Check out the docs for more info
Type Parameters
- TInventoryIntegration extends InventoryIntegration
Parameters
- inventoryIntegration: PartialObjectDeep<InventoryIntegration>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryIntegration>>
- Defined in api/InventoryIntegrations.ts:92

Save

Save<TInventoryIntegration>(inventoryIntegration: InventoryIntegration, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryIntegration>>
Create or update an inventory integration. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TInventoryIntegration extends InventoryIntegration
Parameters
- inventoryIntegration: InventoryIntegration
  
  Required fields: DeliveryConfigID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryIntegration>>
- Defined in api/InventoryIntegrations.ts:51

Generated using TypeDoc