Class CategoriesApi

Hierarchy

CategoriesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CategoriesApi(basePath?: string): CategoriesApi

- Defined in api/api.ts:28923
Parameters
- Optional basePath: string
Returns CategoriesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

procurementCategoriesCountGet

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

- Defined in api/api.ts:28936
Get Categories Count

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

procurementCategoriesGet

procurementCategoriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Category>>

- Defined in api/api.ts:28977
Get Categories

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<Category>>

procurementCategoriesIdDelete

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

- Defined in api/api.ts:29033
Delete Category By Id

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

procurementCategoriesIdGet

procurementCategoriesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Category>

- Defined in api/api.ts:29070
Get Category By Id

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

procurementCategoriesIdPatch

procurementCategoriesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Category>

- Defined in api/api.ts:29108
Update Category

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

procurementCategoriesIdPut

procurementCategoriesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Category>

- Defined in api/api.ts:29153
Replace Category

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

procurementCategoriesPost

procurementCategoriesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Category>

- Defined in api/api.ts:29197
Create Category

Parameters
- params: object
  - category: Category
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Category>

Generated using TypeDoc