Class CompanyNoteTypesApi

Hierarchy

CompanyNoteTypesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanyNoteTypesApi(basePath?: string): CompanyNoteTypesApi

- Defined in api/api.ts:33225
Parameters
- Optional basePath: string
Returns CompanyNoteTypesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyNoteTypesCountGet

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

- Defined in api/api.ts:33238
Get Note Type Count

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

companyNoteTypesGet

companyNoteTypesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<NoteType>>

- Defined in api/api.ts:33279
Get Note Type

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

companyNoteTypesIdDelete

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

- Defined in api/api.ts:33335
Delete Note Type By Id

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

companyNoteTypesIdGet

companyNoteTypesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NoteType>

- Defined in api/api.ts:33372
Get Note Type By Id

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

companyNoteTypesIdPatch

companyNoteTypesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NoteType>

- Defined in api/api.ts:33410
Update Note Type

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

companyNoteTypesIdPut

companyNoteTypesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NoteType>

- Defined in api/api.ts:33455
Replace Note Type

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

companyNoteTypesPost

companyNoteTypesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NoteType>

- Defined in api/api.ts:33499
Create Note Type

Parameters
- params: object
  - noteType: NoteType
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<NoteType>

Generated using TypeDoc