Class ContactGroupsApi

Hierarchy

ContactGroupsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactGroupsApi(basePath?: string): ContactGroupsApi

- Defined in api/api.ts:37501
Parameters
- Optional basePath: string
Returns ContactGroupsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsIdGroupsCountGet

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

- Defined in api/api.ts:37515
Get Contact Groups Count

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

companyContactsIdGroupsGet

companyContactsIdGroupsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactGroup>>

- Defined in api/api.ts:37562
Get Contact Groups

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

companyContactsIdGroupsGroupidDelete

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

- Defined in api/api.ts:37624
Delete Contact Group By Id

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

companyContactsIdGroupsGroupidGet

companyContactsIdGroupsGroupidGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactGroup>

- Defined in api/api.ts:37667
Get Contact Group By Id

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

companyContactsIdGroupsGroupidPatch

companyContactsIdGroupsGroupidPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactGroup>

- Defined in api/api.ts:37711
Update Contact Group

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

companyContactsIdGroupsGroupidPut

companyContactsIdGroupsGroupidPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactGroup>

- Defined in api/api.ts:37762
Replace Contact Group

Parameters
- params: object
  - contactGroup: ContactGroup
  - groupid: number
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactGroup>

companyContactsIdGroupsPost

companyContactsIdGroupsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactGroup>

- Defined in api/api.ts:37812
Create Contact Group

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

Generated using TypeDoc