Class SellerApprovalRules

Hierarchy

SellerApprovalRules

Index

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TSellerApprovalRule>(sellerApprovalRule: SellerApprovalRule<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSellerApprovalRule>>
Create a new seller approval rule. 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
- TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>
Parameters
- sellerApprovalRule: SellerApprovalRule<any>
  
  Required fields: ApprovalType, ApprovingGroupID, RuleExpression
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:63

Delete

Delete(approvalRuleID: string, requestOptions?: RequestOptions): Promise<void>
Delete a seller approval rule. Check out the docs for more info
Parameters
- approvalRuleID: string
  
  ID of the approval rule.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SellerApprovalRules.ts:127

Get

Get<TSellerApprovalRule>(approvalRuleID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TSellerApprovalRule>>
Get a single seller approval rule. Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>
Parameters
- approvalRuleID: string
  
  ID of the approval rule.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:84

List

List<TSellerApprovalRule>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[];
    sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSellerApprovalRule>>>
Get a list of seller approval rules. Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[];
      sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[];
  } = {}
  - 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" | "RuleExpression")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSellerApprovalRule>>>
- Defined in api/SellerApprovalRules.ts:42

Patch

Patch<TSellerApprovalRule>(approvalRuleID: string, sellerApprovalRule: PartialObjectDeep<SellerApprovalRule<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSellerApprovalRule>>
Partially update a seller approval rule. Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>
Parameters
- approvalRuleID: string
  
  ID of the approval rule.
- sellerApprovalRule: PartialObjectDeep<SellerApprovalRule<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:149

Save

Save<TSellerApprovalRule>(approvalRuleID: string, sellerApprovalRule: SellerApprovalRule<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSellerApprovalRule>>
Create or update a seller approval rule. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>
Parameters
- approvalRuleID: string
  
  ID of the approval rule.
- sellerApprovalRule: SellerApprovalRule<any>
  
  Required fields: ApprovalType, ApprovingGroupID, RuleExpression
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:106

Class SellerApprovalRules

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns SellerApprovalRules

Create

Type Parameters

TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>

Parameters

sellerApprovalRule: SellerApprovalRule<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Delete

Parameters

approvalRuleID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>

Parameters

approvalRuleID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSellerApprovalRule>>

List

Type Parameters

TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>

Parameters

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[]; sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[]

Optional sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSellerApprovalRule>>>

Patch

Type Parameters

TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>

Parameters

approvalRuleID: string

sellerApprovalRule: PartialObjectDeep<SellerApprovalRule<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Save

Type Parameters

TSellerApprovalRule extends SellerApprovalRule<any, TSellerApprovalRule>

Parameters

approvalRuleID: string

sellerApprovalRule: SellerApprovalRule<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Settings

Member Visibility

Theme

`Private` impersonating

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[];
sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[]

`Optional` sortBy?: ("ID" | "Name" | "RuleExpression" | "ApprovingGroupID" | "!ID" | "!Name" | "!ApprovingGroupID" | "!RuleExpression")[]