Class PriceSchedules

Hierarchy

PriceSchedules

Index

Properties

impersonating

Methods

As Create Delete DeletePriceBreak Get List Patch Save SavePriceBreak

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TPriceSchedule>(priceSchedule: PriceSchedule<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPriceSchedule>>
Create a new price schedule. 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
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- priceSchedule: PriceSchedule<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPriceSchedule>>
- Defined in api/PriceSchedules.ts:66

Delete

Delete(priceScheduleID: string, requestOptions?: RequestOptions): Promise<void>
Delete a price schedule. Check out the docs for more info
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/PriceSchedules.ts:130

DeletePriceBreak

DeletePriceBreak(priceScheduleID: string, listOptions?: {
quantity?: number;
}, requestOptions?: RequestOptions): Promise<void>
Delete a price schedule price break. Check out the docs for more info
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- listOptions: {
  quantity?: number;
  } = {}
  - Optional quantity?: number
    
    Quantity of the price schedule.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/PriceSchedules.ts:196

Get

Get<TPriceSchedule>(priceScheduleID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TPriceSchedule>>
Get a single price schedule. Check out the docs for more info
Type Parameters
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPriceSchedule>>
- Defined in api/PriceSchedules.ts:87

List

List<TPriceSchedule>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Currency" | "ApplyTax")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TPriceSchedule>>>
Get a list of price schedules. Check out the docs for more info
Type Parameters
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Currency" | "ApplyTax")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
  } = {}
  - 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" | "Currency" | "ApplyTax")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TPriceSchedule>>>
- Defined in api/PriceSchedules.ts:45

Patch

Patch<TPriceSchedule>(priceScheduleID: string, priceSchedule: PartialObjectDeep<PriceSchedule<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPriceSchedule>>
Partially update a price schedule. Check out the docs for more info
Type Parameters
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- priceSchedule: PartialObjectDeep<PriceSchedule<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPriceSchedule>>
- Defined in api/PriceSchedules.ts:152

Save

Save<TPriceSchedule>(priceScheduleID: string, priceSchedule: PriceSchedule<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPriceSchedule>>
Create or update a price schedule. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- priceSchedule: PriceSchedule<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPriceSchedule>>
- Defined in api/PriceSchedules.ts:109

SavePriceBreak

SavePriceBreak<TPriceSchedule>(priceScheduleID: string, priceBreak: PriceBreak, requestOptions?: RequestOptions): Promise<RequiredDeep<TPriceSchedule>>
Create or update a price schedule price break. Check out the docs for more info
Type Parameters
- TPriceSchedule extends PriceSchedule<any, TPriceSchedule>
Parameters
- priceScheduleID: string
  
  ID of the price schedule.
- priceBreak: PriceBreak
  
  Required fields: Quantity, Price
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPriceSchedule>>
- Defined in api/PriceSchedules.ts:174

Class PriceSchedules

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns PriceSchedules

Create

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

priceSchedule: PriceSchedule<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPriceSchedule>>

Delete

Parameters

priceScheduleID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeletePriceBreak

Parameters

priceScheduleID: string

listOptions: { quantity?: number; } = {}

Optional quantity?: number

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

priceScheduleID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPriceSchedule>>

List

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "Currency" | "ApplyTax")[]

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TPriceSchedule>>>

Patch

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

priceScheduleID: string

priceSchedule: PartialObjectDeep<PriceSchedule<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPriceSchedule>>

Save

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

priceScheduleID: string

priceSchedule: PriceSchedule<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPriceSchedule>>

SavePriceBreak

Type Parameters

TPriceSchedule extends PriceSchedule<any, TPriceSchedule>

Parameters

priceScheduleID: string

priceBreak: PriceBreak

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPriceSchedule>>

Settings

Member Visibility

Theme

`Private` impersonating

listOptions: {
quantity?: number;
} = {}

`Optional` quantity?: number

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "Currency" | "ApplyTax")[]

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