Class ContactNotesApi

Hierarchy

ContactNotesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactNotesApi(basePath?: string): ContactNotesApi

- Defined in api/api.ts:37858
Parameters
- Optional basePath: string
Returns ContactNotesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsIdNotesCountGet

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

- Defined in api/api.ts:37872
Get Contact Notes Count

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

companyContactsIdNotesGet

companyContactsIdNotesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactNote>>

- Defined in api/api.ts:37919
Get Contact Notes

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

companyContactsIdNotesNoteIdDelete

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

- Defined in api/api.ts:37981
Delete Contact Note By Id

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

companyContactsIdNotesNoteIdGet

companyContactsIdNotesNoteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactNote>

- Defined in api/api.ts:38024
Get Contact Note By Id

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

companyContactsIdNotesNoteIdPatch

companyContactsIdNotesNoteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactNote>

- Defined in api/api.ts:38068
Update Contact Note

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

companyContactsIdNotesNoteIdPut

companyContactsIdNotesNoteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactNote>

- Defined in api/api.ts:38119
Replace Contact Note

Parameters
- params: object
  - contactNote: ContactNote
  - id: number
  - noteId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactNote>

companyContactsIdNotesPost

companyContactsIdNotesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactNote>

- Defined in api/api.ts:38169
Create Contact Note

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

Generated using TypeDoc