Class ContactDepartmentsApi

Hierarchy

ContactDepartmentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactDepartmentsApi(basePath?: string): ContactDepartmentsApi

- Defined in api/api.ts:37186
Parameters
- Optional basePath: string
Returns ContactDepartmentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsDepartmentsCountGet

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

- Defined in api/api.ts:37199
Get Contact Departments Count

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

companyContactsDepartmentsGet

companyContactsDepartmentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactDepartment>>

- Defined in api/api.ts:37240
Get Contact Departments

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

companyContactsDepartmentsIdDelete

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

- Defined in api/api.ts:37296
Delete Contact Department By Id

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

companyContactsDepartmentsIdGet

companyContactsDepartmentsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactDepartment>

- Defined in api/api.ts:37333
Get Contact Department By Id

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

companyContactsDepartmentsIdPatch

companyContactsDepartmentsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactDepartment>

- Defined in api/api.ts:37371
Update Contact Department

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

companyContactsDepartmentsIdPut

companyContactsDepartmentsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactDepartment>

- Defined in api/api.ts:37416
Replace Contact Department

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

companyContactsDepartmentsPost

companyContactsDepartmentsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactDepartment>

- Defined in api/api.ts:37460
Create Contact Department

Parameters
- params: object
  - contactDepartment: ContactDepartment
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactDepartment>

Generated using TypeDoc