Class Catalogs

Hierarchy

Catalogs

Index

Properties

Methods

As Create Delete DeleteAssignment DeleteBundleAssignment DeleteProductAssignment Get List ListAssignments ListBundleAssignments ListProductAssignments Patch Save SaveAssignment SaveBundleAssignment SaveProductAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TCatalog>(catalog: Catalog<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCatalog>>
Create a catalog Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any, TCatalog>
Parameters
- catalog: Catalog<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCatalog>>
- Defined in api/Catalogs.ts:75

Delete

Delete(catalogID: string, requestOptions?: RequestOptions): Promise<void>
Delete a catalog Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:139

DeleteAssignment

DeleteAssignment(catalogID: string, listOptions?: {
buyerID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a catalog assignment Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- listOptions: {
  buyerID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:183

DeleteBundleAssignment

DeleteBundleAssignment(catalogID: string, bundleID: string, requestOptions?: RequestOptions): Promise<void>
Delete a catalog bundle assignment Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- bundleID: string
  
  ID of the bundle.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:205

DeleteProductAssignment

DeleteProductAssignment(catalogID: string, productID: string, requestOptions?: RequestOptions): Promise<void>
Delete a catalog product assignment Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- productID: string
  
  ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:227

Get

Get<TCatalog>(catalogID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TCatalog>>
Retrieve a catalog Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any, TCatalog>
Parameters
- catalogID: string
  
  ID of the catalog.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCatalog>>
- Defined in api/Catalogs.ts:96

List

List<TCatalog>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCatalog>>>
List catalogs Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any, TCatalog>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      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. 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.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "Description")[]
    
    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<TCatalog>>>
- Defined in api/Catalogs.ts:54

ListAssignments

ListAssignments<TCatalogAssignment>(listOptions?: {
    buyerID?: string;
    catalogID?: string;
    page?: number;
    pageSize?: number;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCatalogAssignment>>>
List catalog assignments Check out the docs for more info
Type Parameters
- TCatalogAssignment extends CatalogAssignment
Parameters
- listOptions: {
      buyerID?: string;
      catalogID?: string;
      page?: number;
      pageSize?: number;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional catalogID?: string
    
    ID of the catalog.
  - Optional page?: 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.
  - Optional pageSize?: number
    
    Number of results to return per page.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCatalogAssignment>>>
- Defined in api/Catalogs.ts:251

ListBundleAssignments

ListBundleAssignments<TBundleCatalogAssignment>(listOptions?: {
    bundleID?: string;
    catalogID?: string;
    page?: number;
    pageSize?: number;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TBundleCatalogAssignment>>>
List catalog bundle assignments Check out the docs for more info
Type Parameters
- TBundleCatalogAssignment extends BundleCatalogAssignment
Parameters
- listOptions: {
      bundleID?: string;
      catalogID?: string;
      page?: number;
      pageSize?: number;
  } = {}
  - Optional bundleID?: string
    
    ID of the bundle.
  - Optional catalogID?: string
    
    ID of the catalog.
  - Optional page?: 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.
  - Optional pageSize?: number
    
    Number of results to return per page.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TBundleCatalogAssignment>>>
- Defined in api/Catalogs.ts:296

ListProductAssignments

ListProductAssignments<TProductCatalogAssignment>(listOptions?: {
    catalogID?: string;
    page?: number;
    pageSize?: number;
    productID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TProductCatalogAssignment>>>
List catalog product assignments Check out the docs for more info
Type Parameters
- TProductCatalogAssignment extends ProductCatalogAssignment
Parameters
- listOptions: {
      catalogID?: string;
      page?: number;
      pageSize?: number;
      productID?: string;
  } = {}
  - Optional catalogID?: string
    
    ID of the catalog.
  - Optional page?: 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.
  - Optional pageSize?: number
    
    Number of results to return per page.
  - Optional productID?: string
    
    ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TProductCatalogAssignment>>>
- Defined in api/Catalogs.ts:341

Patch

Patch<TCatalog>(catalogID: string, catalog: PartialObjectDeep<Catalog<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCatalog>>
Partially update a catalog Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any, TCatalog>
Parameters
- catalogID: string
  
  ID of the catalog.
- catalog: PartialObjectDeep<Catalog<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCatalog>>
- Defined in api/Catalogs.ts:161

Save

Save<TCatalog>(catalogID: string, catalog: Catalog<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCatalog>>
Create or update a catalog If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any, TCatalog>
Parameters
- catalogID: string
  
  ID of the catalog.
- catalog: Catalog<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCatalog>>
- Defined in api/Catalogs.ts:118

SaveAssignment

SaveAssignment(catalogAssignment: CatalogAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a catalog assignment Check out the docs for more info
Parameters
- catalogAssignment: CatalogAssignment
  
  Required fields: CatalogID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:272

SaveBundleAssignment

SaveBundleAssignment(bundleCatalogAssignment: BundleCatalogAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a catalog bundle assignment Check out the docs for more info
Parameters
- bundleCatalogAssignment: BundleCatalogAssignment
  
  Required fields: CatalogID, BundleID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:317

SaveProductAssignment

SaveProductAssignment(productCatalogAssignment: ProductCatalogAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a catalog product assignment Check out the docs for more info
Parameters
- productCatalogAssignment: ProductCatalogAssignment
  
  Required fields: CatalogID, ProductID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Catalogs.ts:362

Class Catalogs

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Catalogs

Create

Type Parameters

TCatalog extends Catalog<any, TCatalog>

Parameters

catalog: Catalog<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCatalog>>

Delete

Parameters

catalogID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

catalogID: string

listOptions: { buyerID?: string; } = {}

Optional buyerID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteBundleAssignment

Parameters

catalogID: string

bundleID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteProductAssignment

Parameters

catalogID: string

productID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TCatalog extends Catalog<any, TCatalog>

Parameters

catalogID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCatalog>>

List

Type Parameters

TCatalog extends Catalog<any, TCatalog>

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

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

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TCatalog>>>

ListAssignments

Type Parameters

TCatalogAssignment extends CatalogAssignment

Parameters

listOptions: { buyerID?: string; catalogID?: string; page?: number; pageSize?: number; } = {}

Optional buyerID?: string

Optional catalogID?: string

Optional page?: number

Optional pageSize?: number

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TCatalogAssignment>>>

ListBundleAssignments

Type Parameters

TBundleCatalogAssignment extends BundleCatalogAssignment

Parameters

listOptions: { bundleID?: string; catalogID?: string; page?: number; pageSize?: number; } = {}

Optional bundleID?: string

`Private` impersonating

listOptions: {
buyerID?: string;
} = {}

`Optional` buyerID?: string

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

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

listOptions: {
buyerID?: string;
catalogID?: string;
page?: number;
pageSize?: number;
} = {}

`Optional` buyerID?: string

`Optional` catalogID?: string

`Optional` page?: number

`Optional` pageSize?: number

listOptions: {
bundleID?: string;
catalogID?: string;
page?: number;
pageSize?: number;
} = {}

`Optional` bundleID?: string

`Optional` catalogID?: string

`Optional` page?: number

`Optional` pageSize?: number

listOptions: {
catalogID?: string;
page?: number;
pageSize?: number;
productID?: string;
} = {}

`Optional` catalogID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` productID?: string