Class ApprovalRules

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
```
ApprovalRules.As().List() // lists ApprovalRules using the impersonated users' token
```
- Defined in api/ApprovalRules.ts:174

Create

Create<TApprovalRule extends ApprovalRule<any>>(
    buyerID: string,
    approvalRule: ApprovalRule,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TApprovalRule>>
Create an approval rule Check out the docs for more info
Type Parameters
- TApprovalRule extends ApprovalRule<any>
Parameters
- buyerID: string
  ID of the buyer.
- approvalRule: ApprovalRule
  Required fields: ApprovingGroupID, RuleExpression
- 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<TApprovalRule>>
- Defined in api/ApprovalRules.ts:65

Delete

Delete(
    buyerID: string,
    approvalRuleID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Delete an approval rule Check out the docs for more info
Parameters
- buyerID: string
  ID of the buyer.
- approvalRuleID: string
  ID of the approval rule.
- 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/ApprovalRules.ts:132

Get

Get<TApprovalRule extends ApprovalRule<any>>(
    buyerID: string,
    approvalRuleID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TApprovalRule>>
Retrieve an approval rule Check out the docs for more info
Type Parameters
- TApprovalRule extends ApprovalRule<any>
Parameters
- buyerID: string
  ID of the buyer.
- approvalRuleID: string
  ID of the approval rule.
- 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<TApprovalRule>>
- Defined in api/ApprovalRules.ts:87

List

List<TApprovalRule extends ApprovalRule<any>>(
    buyerID: string,
    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<TApprovalRule>>>
List approval rules Check out the docs for more info
Type Parameters
- TApprovalRule extends ApprovalRule<any>
Parameters
- buyerID: string
  ID of the buyer.
- 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).
  - 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<RequiredObjectDeep<ListPage<TApprovalRule>>>
- Defined in api/ApprovalRules.ts:43

Patch

Patch<TApprovalRule extends ApprovalRule<any>>(
    buyerID: string,
    approvalRuleID: string,
    approvalRule: PartialDeep<ApprovalRule>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TApprovalRule>>
Partially update an approval rule Check out the docs for more info
Type Parameters
- TApprovalRule extends ApprovalRule<any>
Parameters
- buyerID: string
  ID of the buyer.
- approvalRuleID: string
  ID of the approval rule.
- approvalRule: PartialDeep<ApprovalRule>
- 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<TApprovalRule>>
- Defined in api/ApprovalRules.ts:155

Save

Save<TApprovalRule extends ApprovalRule<any>>(
    buyerID: string,
    approvalRuleID: string,
    approvalRule: ApprovalRule,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TApprovalRule>>
Create or update an approval rule If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TApprovalRule extends ApprovalRule<any>
Parameters
- buyerID: string
  ID of the buyer.
- approvalRuleID: string
  ID of the approval rule.
- approvalRule: ApprovalRule
  Required fields: ApprovingGroupID, RuleExpression
- 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<TApprovalRule>>
- Defined in api/ApprovalRules.ts:110

Class ApprovalRules

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TApprovalRule>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TApprovalRule>>

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

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TApprovalRule>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TApprovalRule>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TApprovalRule>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`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`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string