Class Promotions

Hierarchy

Promotions

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TPromotion>(promotion: Promotion<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotion>>
Create a new promotion. 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
- TPromotion extends Promotion<any, TPromotion>
Parameters
- promotion: Promotion<any>
  
  Required fields: Code, EligibleExpression
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotion>>
- Defined in api/Promotions.ts:68

Delete

Delete(promotionID: string, requestOptions?: RequestOptions): Promise<void>
Delete a promotion. Check out the docs for more info
Parameters
- promotionID: string
  
  ID of the promotion.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Promotions.ts:132

DeleteAssignment

DeleteAssignment(promotionID: string, listOptions?: {
    buyerID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a promotion assignment. Check out the docs for more info
Parameters
- promotionID: string
  
  ID of the promotion.
- listOptions: {
      buyerID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Promotions.ts:178

Get

Get<TPromotion>(promotionID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotion>>
Get a single promotion. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any, TPromotion>
Parameters
- promotionID: string
  
  ID of the promotion.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotion>>
- Defined in api/Promotions.ts:89

List

List<TPromotion>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
    sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TPromotion>>>
Get a list of promotions. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any, TPromotion>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
      sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TPromotion>>>
- Defined in api/Promotions.ts:47

ListAssignments

ListAssignments<TPromotionAssignment>(listOptions?: {
    buyerID?: string;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    promotionID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TPromotionAssignment>>>
Get a list of promotion assignments. Check out the docs for more info
Type Parameters
- TPromotionAssignment extends PromotionAssignment
Parameters
- listOptions: {
      buyerID?: string;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      promotionID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional level?: PartyType
    
    Level of the promotion assignment. Possible values: User, Group, Company.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional promotionID?: string
    
    ID of the promotion.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TPromotionAssignment>>>
- Defined in api/Promotions.ts:205

Patch

Patch<TPromotion>(promotionID: string, promotion: PartialObjectDeep<Promotion<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotion>>
Partially update a promotion. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any, TPromotion>
Parameters
- promotionID: string
  
  ID of the promotion.
- promotion: PartialObjectDeep<Promotion<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotion>>
- Defined in api/Promotions.ts:154

Save

Save<TPromotion>(promotionID: string, promotion: Promotion<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPromotion>>
Create or update a promotion. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any, TPromotion>
Parameters
- promotionID: string
  
  ID of the promotion.
- promotion: Promotion<any>
  
  Required fields: Code, EligibleExpression
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPromotion>>
- Defined in api/Promotions.ts:111

SaveAssignment

SaveAssignment(promotionAssignment: PromotionAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a promotion assignment. Check out the docs for more info
Parameters
- promotionAssignment: PromotionAssignment
  
  Required fields: PromotionID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Promotions.ts:226

Class Promotions

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Promotions

Create

Type Parameters

TPromotion extends Promotion<any, TPromotion>

Parameters

promotion: Promotion<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPromotion>>

Delete

Parameters

promotionID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

promotionID: string

listOptions: { buyerID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TPromotion extends Promotion<any, TPromotion>

Parameters

promotionID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPromotion>>

List

Type Parameters

TPromotion extends Promotion<any, TPromotion>

Parameters

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TPromotion>>>

ListAssignments

Type Parameters

TPromotionAssignment extends PromotionAssignment

Parameters

listOptions: { buyerID?: string; level?: PartyType; page?: number; pageSize?: number; promotionID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional level?: PartyType

Optional page?: number

Optional pageSize?: number

Optional promotionID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TPromotionAssignment>>>

Patch

Type Parameters

TPromotion extends Promotion<any, TPromotion>

Parameters

promotionID: string

promotion: PartialObjectDeep<Promotion<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPromotion>>

Save

Type Parameters

TPromotion extends Promotion<any, TPromotion>

Parameters

promotionID: string

promotion: Promotion<any>

requestOptions: RequestOptions = {}

`Private` impersonating

listOptions: {
buyerID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]

listOptions: {
buyerID?: string;
level?: PartyType;
page?: number;
pageSize?: number;
promotionID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` promotionID?: string

`Optional` userGroupID?: string

`Optional` userID?: string