Class PromotionIntegrations

Index

Methods

As Delete Get Patch Save

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
PromotionIntegrations.As().List() // lists PromotionIntegrations using the impersonated users' token
```
- 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 = {}
  - 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/PromotionIntegrations.ts:71

Get

Get<TPromotionIntegration extends PromotionIntegration>(
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPromotionIntegration>>
Retrieve a promotion integration Check out the docs for more info
Type Parameters
- TPromotionIntegration extends PromotionIntegration
Parameters
- 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<TPromotionIntegration>>
- Defined in api/PromotionIntegrations.ts:30

Patch

Patch<TPromotionIntegration extends PromotionIntegration>(
promotionIntegration: PartialDeep<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: PartialDeep<PromotionIntegration>
- 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<TPromotionIntegration>>
- Defined in api/PromotionIntegrations.ts:92

Save

Save<TPromotionIntegration extends PromotionIntegration>(
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 = {}
  - 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<TPromotionIntegration>>
- Defined in api/PromotionIntegrations.ts:51