Class ContactCommunicationsApi

Hierarchy

ContactCommunicationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactCommunicationsApi(basePath?: string): ContactCommunicationsApi

- Defined in api/api.ts:37614
Parameters
- Optional basePath: string
Returns ContactCommunicationsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsIdCommunicationsCommunicationIdDelete

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

- Defined in api/api.ts:37628
Delete Contact Communication By Id

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

companyContactsIdCommunicationsCommunicationIdGet

companyContactsIdCommunicationsCommunicationIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactCommunication>

- Defined in api/api.ts:37671
Get Contact Communication By Id

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

companyContactsIdCommunicationsCommunicationIdPatch

companyContactsIdCommunicationsCommunicationIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactCommunication>

- Defined in api/api.ts:37715
Update Contact Communication

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

companyContactsIdCommunicationsCommunicationIdPut

companyContactsIdCommunicationsCommunicationIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactCommunication>

- Defined in api/api.ts:37766
Replace Contact Communication

Parameters
- params: object
  - communicationId: number
  - contactCommunication: ContactCommunication
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactCommunication>

companyContactsIdCommunicationsCountGet

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

- Defined in api/api.ts:37816
Get Contact Communications Count

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

companyContactsIdCommunicationsGet

companyContactsIdCommunicationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactCommunication>>

- Defined in api/api.ts:37863
Get Contact Communications

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

companyContactsIdCommunicationsPost

companyContactsIdCommunicationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactCommunication>

- Defined in api/api.ts:37925
Create Contact Communication

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

Generated using TypeDoc