Class PromotionIntegrations

Hierarchy

PromotionIntegrations

Index

Properties

Methods

As Delete Get Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Delete

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

Get

Get<TPromotionIntegration>(requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotionIntegration>>
Retrieve a promotion integration Check out the docs for more info
Type Parameters
- TPromotionIntegration extends PromotionIntegration
Parameters
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotionIntegration>>
- Defined in api/PromotionIntegrations.ts:30

Patch

Patch<TPromotionIntegration>(promotionIntegration: PartialObjectDeep<PromotionIntegration>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotionIntegration>>
Partially update a promotion integration Check out the docs for more info
Type Parameters
- TPromotionIntegration extends PromotionIntegration
Parameters
- promotionIntegration: PartialObjectDeep<PromotionIntegration>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotionIntegration>>
- Defined in api/PromotionIntegrations.ts:92

Save

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

Generated using TypeDoc