Class CodesApi

Hierarchy

CodesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CodesApi(basePath?: string): CodesApi

- Defined in api/api.ts:31159
Parameters
- Optional basePath: string
Returns CodesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceCodesCountGet

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

- Defined in api/api.ts:31172
Create Codes Count

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

serviceCodesGet

serviceCodesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Code>>

- Defined in api/api.ts:31213
Get Codes

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

serviceCodesIdDelete

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

- Defined in api/api.ts:31269
Delete Code By Id

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

serviceCodesIdGet

serviceCodesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

- Defined in api/api.ts:31306
Get Code By Id

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

serviceCodesIdPatch

serviceCodesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

- Defined in api/api.ts:31344
Update Code

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

serviceCodesIdPut

serviceCodesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

- Defined in api/api.ts:31389
Replace Code

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

serviceCodesPost

serviceCodesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

- Defined in api/api.ts:31433
Create Codes

Parameters
- params: object
  - code: Code
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Code>

Generated using TypeDoc