Class CatalogsItemApi

Hierarchy

CatalogsItemApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CatalogsItemApi(basePath?: string): CatalogsItemApi

- Defined in api/api.ts:29246
Parameters
- Optional basePath: string
Returns CatalogsItemApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

procurementCatalogCatalogItemIdentifierQuantityOnHandGet

procurementCatalogCatalogItemIdentifierQuantityOnHandGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:29260
Get Inventory Quantity On Hand

Parameters
- params: object
  - catalogItemIdentifier: string
  - Optional warehouseBinId?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

procurementCatalogCountGet

procurementCatalogCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:29301
Get Catalogs Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

procurementCatalogGet

procurementCatalogGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CatalogItem>>

- Defined in api/api.ts:29342
Get Catalogs

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<CatalogItem>>

procurementCatalogIdDelete

procurementCatalogIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:29398
Delete Catalog By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

procurementCatalogIdGet

procurementCatalogIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogItem>

- Defined in api/api.ts:29435
Get Catalog By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CatalogItem>

procurementCatalogIdPatch

procurementCatalogIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogItem>

- Defined in api/api.ts:29473
Update Catalog

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CatalogItem>

procurementCatalogIdPut

procurementCatalogIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogItem>

- Defined in api/api.ts:29518
Replace Catalog

Parameters
- params: object
  - catalogItem: CatalogItem
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CatalogItem>

procurementCatalogPost

procurementCatalogPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogItem>

- Defined in api/api.ts:29562
Create Catalog

Parameters
- params: object
  - catalogItem: CatalogItem
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CatalogItem>

Generated using TypeDoc