Class OpportunityNotesApi

Hierarchy

OpportunityNotesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OpportunityNotesApi(basePath?: string): OpportunityNotesApi

- Defined in api/api.ts:62729
Parameters
- Optional basePath: string
Returns OpportunityNotesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesOpportunitiesIdNotesCountGet

salesOpportunitiesIdNotesCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OpportunityNote>>

- Defined in api/api.ts:62743
Get Opportunity Notes Count

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

salesOpportunitiesIdNotesGet

salesOpportunitiesIdNotesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OpportunityNote>>

- Defined in api/api.ts:62790
Get Opportunity 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<OpportunityNote>>

salesOpportunitiesIdNotesNoteIdDelete

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

- Defined in api/api.ts:62852
Delete Opportunity Note By Id

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

salesOpportunitiesIdNotesNoteIdGet

salesOpportunitiesIdNotesNoteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OpportunityNote>

- Defined in api/api.ts:62895
Get Opportunity Note By Id

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

salesOpportunitiesIdNotesNoteIdPatch

salesOpportunitiesIdNotesNoteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OpportunityNote>

- Defined in api/api.ts:62939
Update Opportunity Note

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

salesOpportunitiesIdNotesNoteIdPut

salesOpportunitiesIdNotesNoteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OpportunityNote>

- Defined in api/api.ts:62990
Replace Opportunity Note

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

salesOpportunitiesIdNotesPost

salesOpportunitiesIdNotesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OpportunityNote>

- Defined in api/api.ts:63040
Create Opportunity Note

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

Generated using TypeDoc