Class SellerApprovalRules

Index

Methods

As Create Delete Get List Patch Save

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
SellerApprovalRules.As().List() // lists SellerApprovalRules using the impersonated users' token
```
- Defined in api/SellerApprovalRules.ts:168

Create

Create<TSellerApprovalRule extends SellerApprovalRule<any>>(
sellerApprovalRule: SellerApprovalRule,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSellerApprovalRule>>
Create a seller approval rule Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any>
Parameters
- sellerApprovalRule: SellerApprovalRule
  Required fields: ApprovalType, ApprovingGroupID, RuleExpression
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<void>
- Defined in api/SellerApprovalRules.ts:127

Get

Get<TSellerApprovalRule extends SellerApprovalRule<any>>(
approvalRuleID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSellerApprovalRule>>
Retrieve a seller approval rule Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any>
Parameters
- approvalRuleID: string
  ID of the approval rule.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:84

List

List<TSellerApprovalRule extends SellerApprovalRule<any>>(
    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>>>
List seller approval rules Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[];
      sortBy?: (
          | "ID"
          | "Name"
          | "RuleExpression"
          | "ApprovingGroupID"
          | "!ID"
          | "!Name"
          | "!ApprovingGroupID"
          | "!RuleExpression"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description" | "RuleExpression")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "Name"
        | "RuleExpression"
        | "ApprovingGroupID"
        | "!ID"
        | "!Name"
        | "!ApprovingGroupID"
        | "!RuleExpression"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<RequiredObjectDeep<ListPage<TSellerApprovalRule>>>
- Defined in api/SellerApprovalRules.ts:42

Patch

Patch<TSellerApprovalRule extends SellerApprovalRule<any>>(
    approvalRuleID: string,
    sellerApprovalRule: PartialDeep<SellerApprovalRule>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSellerApprovalRule>>
Partially update a seller approval rule Check out the docs for more info
Type Parameters
- TSellerApprovalRule extends SellerApprovalRule<any>
Parameters
- approvalRuleID: string
  ID of the approval rule.
- sellerApprovalRule: PartialDeep<SellerApprovalRule>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:149

Save

Save<TSellerApprovalRule extends SellerApprovalRule<any>>(
    approvalRuleID: string,
    sellerApprovalRule: SellerApprovalRule,
    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>
Parameters
- approvalRuleID: string
  ID of the approval rule.
- sellerApprovalRule: SellerApprovalRule
  Required fields: ApprovalType, ApprovingGroupID, RuleExpression
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<RequiredDeep<TSellerApprovalRule>>
- Defined in api/SellerApprovalRules.ts:106

Class SellerApprovalRules

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Delete

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TSellerApprovalRule>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

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

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

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredObjectDeep<ListPage<TSellerApprovalRule>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TSellerApprovalRule>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`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"
)[]

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal