Class Products

Methods

As

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

Create

Create<TProduct extends Product<any>>(
product: Product,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProduct>>
Create a product Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- product: Product
  Required fields: Name
- 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<TProduct>>
- Defined in api/Products.ts:86

Delete

Delete(productID: string, requestOptions?: RequestOptions): Promise<void>
Delete a product Check out the docs for more info
Parameters
- productID: string
  ID of the product.
- 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/Products.ts:150

DeleteAssignment

DeleteAssignment(
    productID: string,
    buyerID: string,
    listOptions?: { sellerID?: string; userGroupID?: string; userID?: string },
    requestOptions?: RequestOptions,
): Promise<void>
Delete a product assignment Check out the docs for more info
Parameters
- productID: string
  ID of the product.
- buyerID: string
  ID of the buyer.
- listOptions: { sellerID?: string; userGroupID?: string; userID?: string } = {}
  - OptionalsellerID?: string
    
    ID of the seller.
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- 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/Products.ts:197

GenerateVariants

GenerateVariants<TProduct extends Product<any>>(
    productID: string,
    variantOverrides: VariantOverrides,
    listOptions?: { overwriteExisting?: boolean },
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProduct>>
Generate variants Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- productID: string
  ID of the product.
- variantOverrides: VariantOverrides
- listOptions: { overwriteExisting?: boolean } = {}
  - OptionaloverwriteExisting?: boolean
    
    Overwrite existing of the product.
- 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<TProduct>>
- Defined in api/Products.ts:414

Get

Get<TProduct extends Product<any>>(
productID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProduct>>
Retrieve a product Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- productID: string
  ID of the product.
- 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<TProduct>>
- Defined in api/Products.ts:107

GetVariant

GetVariant<TVariant extends Variant<any>>(
    productID: string,
    variantID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TVariant>>
Retrieve a product variant Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
Parameters
- productID: string
  ID of the product.
- variantID: string
  ID of the variant.
- 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<TVariant>>
- Defined in api/Products.ts:345

List

List<TProduct extends Product<any>>(
    listOptions?: {
        catalogID?: string;
        categoryID?: string;
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: string[];
        searchType?: SearchType;
        sortBy?: string[];
        supplierID?: string;
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPageWithFacets<TProduct, any>>>
List products Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- listOptions: {
      catalogID?: string;
      categoryID?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: string[];
      searchType?: SearchType;
      sortBy?: string[];
      supplierID?: string;
  } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
  - OptionalcategoryID?: string
    
    ID of the category.
  - 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?: string[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsortBy?: string[]
    
    Comma-delimited list of fields to sort by.
  - OptionalsupplierID?: string
    
    ID of the supplier.
- 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<ListPageWithFacets<TProduct, any>>>
- Defined in api/Products.ts:65

ListAssignments

ListAssignments<TProductAssignment extends ProductAssignment>(
    listOptions?: {
        buyerID?: string;
        level?: "Group" | "Company";
        page?: number;
        pageSize?: number;
        priceScheduleID?: string;
        productID?: string;
        userGroupID?: string;
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TProductAssignment>>>
List product assignments Check out the docs for more info
Type Parameters
- TProductAssignment extends ProductAssignment
Parameters
- listOptions: {
      buyerID?: string;
      level?: "Group" | "Company";
      page?: number;
      pageSize?: number;
      priceScheduleID?: string;
      productID?: string;
      userGroupID?: string;
  } = {}
  - OptionalbuyerID?: string
    
    ID of the buyer.
  - Optionallevel?: "Group" | "Company"
    
    Level of the product assignment. Possible values: Group, Company, BuyerGroup.
  - 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.
  - OptionalpriceScheduleID?: string
    
    ID of the price schedule.
  - OptionalproductID?: string
    
    ID of the product.
  - OptionaluserGroupID?: string
    
    ID of the user group.
- 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<TProductAssignment>>>
- Defined in api/Products.ts:441

ListSpecs

ListSpecs<TSpec extends Spec<any, any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSpec>>>
List product specs Check out the docs for more info
Type Parameters
- TSpec extends Spec<any, any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[];
  } = {}
  - 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")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[]
    
    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<TSpec>>>
- Defined in api/Products.ts:224

ListSuppliers

ListSuppliers<TProductSupplier extends ProductSupplier<any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: (
            "ID"
            | "Name"
            | "DateCreated"
            | "!ID"
            | "!DateCreated"
            | "!Name"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TProductSupplier>>>
List product suppliers Check out the docs for more info
Type Parameters
- TProductSupplier extends ProductSupplier<any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[];
  } = {}
  - 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")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]
    
    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<TProductSupplier>>>
- Defined in api/Products.ts:251

ListVariants

ListVariants<TVariant extends Variant<any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TVariant>>>
List product variants Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - 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")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    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<TVariant>>>
- Defined in api/Products.ts:323

Patch

Patch<TProduct extends Product<any>>(
    productID: string,
    product: PartialDeep<Product>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProduct>>
Partially update a product Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- productID: string
  ID of the product.
- product: PartialDeep<Product>
- 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<TProduct>>
- Defined in api/Products.ts:172

PatchVariant

PatchVariant<TVariant extends Variant<any>>(
    productID: string,
    variantID: string,
    variant: PartialDeep<Variant>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TVariant>>
Partially update a product variant Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
Parameters
- productID: string
  ID of the product.
- variantID: string
  ID of the variant.
- variant: PartialDeep<Variant>
- 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<TVariant>>
- Defined in api/Products.ts:391

RemoveSupplier

RemoveSupplier(
    productID: string,
    supplierID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Remove a product supplier Check out the docs for more info
Parameters
- productID: string
  ID of the product.
- supplierID: string
  ID of the supplier.
- 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/Products.ts:296

Save

Save<TProduct extends Product<any>>(
    productID: string,
    product: Product,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProduct>>
Create or update a product If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TProduct extends Product<any>
Parameters
- productID: string
  ID of the product.
- product: Product
  Required fields: Name
- 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<TProduct>>
- Defined in api/Products.ts:129

SaveAssignment

SaveAssignment(
productAssignment: ProductAssignment,
requestOptions?: RequestOptions,
): Promise<void>
Create or update a product assignment Check out the docs for more info
Parameters
- productAssignment: ProductAssignment
  Required fields: ProductID, BuyerID
- 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/Products.ts:462

SaveSupplier

SaveSupplier(
    productID: string,
    supplierID: string,
    listOptions?: { defaultPriceScheduleID?: string },
    requestOptions?: RequestOptions,
): Promise<void>
Create or update a product supplier Check out the docs for more info
Parameters
- productID: string
  ID of the product.
- supplierID: string
  ID of the supplier.
- listOptions: { defaultPriceScheduleID?: string } = {}
  - OptionaldefaultPriceScheduleID?: string
    
    ID of the default price schedule.
- 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/Products.ts:274

SaveVariant

SaveVariant<TVariant extends Variant<any>>(
    productID: string,
    variantID: string,
    variant: Variant,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TVariant>>
Update a product variant Update a product variant. Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
Parameters
- productID: string
  ID of the product.
- variantID: string
  ID of the variant.
- variant: Variant
- 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<TVariant>>
- Defined in api/Products.ts:368

Class Products

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TProduct>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteAssignment

Parameters

OptionalsellerID?: string

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

GenerateVariants

Type Parameters

Parameters

OptionaloverwriteExisting?: boolean

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TProduct>>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TProduct>>

GetVariant

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TVariant>>

List

Type Parameters

Parameters

OptionalcatalogID?: string

OptionalcategoryID?: string

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: string[]

OptionalsearchType?: SearchType

OptionalsortBy?: string[]

OptionalsupplierID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPageWithFacets<TProduct, any>>>

ListAssignments

Type Parameters

Parameters

OptionalbuyerID?: string

Optionallevel?: "Group" | "Company"

Optionalpage?: number

OptionalpageSize?: number

OptionalpriceScheduleID?: string

OptionalproductID?: string

OptionaluserGroupID?: string

OptionalaccessToken?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`sellerID?: string

`Optional`userGroupID?: string

`Optional`userID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`overwriteExisting?: boolean

`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`catalogID?: string

`Optional`categoryID?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

`Optional`searchOn?: string[]

`Optional`searchType?: SearchType

`Optional`sortBy?: string[]

`Optional`supplierID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`buyerID?: string

`Optional`level?: "Group" | "Company"

`Optional`page?: number

`Optional`pageSize?: number

`Optional`priceScheduleID?: string

`Optional`productID?: string

`Optional`userGroupID?: 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")[]

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

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

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

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

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

`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`accessToken?: string

`Optional`cancelToken?: CancelToken