Class ContactRelationshipsApi

Hierarchy

ContactRelationshipsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactRelationshipsApi(basePath?: string): ContactRelationshipsApi

- Defined in api/api.ts:38215
Parameters
- Optional basePath: string
Returns ContactRelationshipsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsRelationshipsCountGet

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

- Defined in api/api.ts:38228
Get Contact Relationships Count

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

companyContactsRelationshipsGet

companyContactsRelationshipsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactRelationship>>

- Defined in api/api.ts:38269
Get Contact Relationships

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ContactRelationship>>

companyContactsRelationshipsIdDelete

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

- Defined in api/api.ts:38325
Delete Contact Relationship By Id

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

companyContactsRelationshipsIdGet

companyContactsRelationshipsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactRelationship>

- Defined in api/api.ts:38362
Get Contact Relationship By Id

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

companyContactsRelationshipsIdPatch

companyContactsRelationshipsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactRelationship>

- Defined in api/api.ts:38400
Update Contact Relationship

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

companyContactsRelationshipsIdPut

companyContactsRelationshipsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactRelationship>

- Defined in api/api.ts:38445
Replace Contact Relationship

Parameters
- params: object
  - contactRelationship: ContactRelationship
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactRelationship>

companyContactsRelationshipsPost

companyContactsRelationshipsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactRelationship>

- Defined in api/api.ts:38489
Create Contact Relationship

Parameters
- params: object
  - contactRelationship: ContactRelationship
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactRelationship>

Generated using TypeDoc