Class CatalogComponentsApi

Hierarchy

CatalogComponentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CatalogComponentsApi(basePath?: string): CatalogComponentsApi

- Defined in api/api.ts:28209
Parameters
- Optional basePath: string
Returns CatalogComponentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

procurementCatalogIdComponentsComponentIdDelete

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

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

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

procurementCatalogIdComponentsComponentIdGet

procurementCatalogIdComponentsComponentIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogComponent>

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

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

procurementCatalogIdComponentsComponentIdPatch

procurementCatalogIdComponentsComponentIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogComponent>

- Defined in api/api.ts:28310
Update Catalog Component

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

procurementCatalogIdComponentsComponentIdPut

procurementCatalogIdComponentsComponentIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogComponent>

- Defined in api/api.ts:28361
Replace Catalog Component

Parameters
- params: object
  - catalogComponent: CatalogComponent
  - componentId: number
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CatalogComponent>

procurementCatalogIdComponentsCountGet

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

- Defined in api/api.ts:28411
Get Catalog Components Count

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

procurementCatalogIdComponentsGet

procurementCatalogIdComponentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CatalogComponent>>

- Defined in api/api.ts:28458
Get Catalog Components

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

procurementCatalogIdComponentsPost

procurementCatalogIdComponentsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CatalogComponent>

- Defined in api/api.ts:28520
Create Catalog Component

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

Generated using TypeDoc