Class CompanyCustomNotesApi

Hierarchy

CompanyCustomNotesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanyCustomNotesApi(basePath?: string): CompanyCustomNotesApi

- Defined in api/api.ts:32154
Parameters
- Optional basePath: string
Returns CompanyCustomNotesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCompaniesIdCustomStatusNotesCountGet

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

- Defined in api/api.ts:32168
Get Custom Note Count

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

companyCompaniesIdCustomStatusNotesCustomNoteIdDelete

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

- Defined in api/api.ts:32210
Delete Custom Note By Id

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

companyCompaniesIdCustomStatusNotesCustomNoteIdGet

companyCompaniesIdCustomStatusNotesCustomNoteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyCustomNote>

- Defined in api/api.ts:32253
Get Custom Note By Id

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

companyCompaniesIdCustomStatusNotesCustomNoteIdPatch

companyCompaniesIdCustomStatusNotesCustomNoteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyCustomNote>

- Defined in api/api.ts:32297
Update Custom Note

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

companyCompaniesIdCustomStatusNotesCustomNoteIdPut

companyCompaniesIdCustomStatusNotesCustomNoteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyCustomNote>

- Defined in api/api.ts:32348
Replace Custom Note

Parameters
- params: object
  - customNote: CompanyCustomNote
  - customNoteId: number
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CompanyCustomNote>

companyCompaniesIdCustomStatusNotesGet

companyCompaniesIdCustomStatusNotesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CompanyCustomNote>>

- Defined in api/api.ts:32403
Get Custom Note

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

companyCompaniesIdCustomStatusNotesPost

companyCompaniesIdCustomStatusNotesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyCustomNote>

- Defined in api/api.ts:32465
Create Custom Note

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

Generated using TypeDoc