Class CompanyNotesApi

Hierarchy

CompanyNotesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanyNotesApi(basePath?: string): CompanyNotesApi

- Defined in api/api.ts:32755
Parameters
- Optional basePath: string
Returns CompanyNotesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCompaniesIdNotesCountGet

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

- Defined in api/api.ts:32769
Get Company Notes Count

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

companyCompaniesIdNotesGet

companyCompaniesIdNotesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CompanyNote>>

- Defined in api/api.ts:32816
Get Company 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<CompanyNote>>

companyCompaniesIdNotesNoteIdDelete

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

- Defined in api/api.ts:32878
Delete Company Note By Id

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

companyCompaniesIdNotesNoteIdGet

companyCompaniesIdNotesNoteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyNote>

- Defined in api/api.ts:32921
Get Company Note By Id

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

companyCompaniesIdNotesNoteIdPatch

companyCompaniesIdNotesNoteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyNote>

- Defined in api/api.ts:32965
Update Company Note

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

companyCompaniesIdNotesNoteIdPut

companyCompaniesIdNotesNoteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyNote>

- Defined in api/api.ts:33016
Replace Company Note

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

companyCompaniesIdNotesPost

companyCompaniesIdNotesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyNote>

- Defined in api/api.ts:33066
Create Company Note

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

Generated using TypeDoc