Class ContactTypesApi

Hierarchy

ContactTypesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactTypesApi(basePath?: string): ContactTypesApi

- Defined in api/api.ts:38785
Parameters
- Optional basePath: string
Returns ContactTypesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyContactsTypesCountGet

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

- Defined in api/api.ts:38798
Get Contact Types Count

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

companyContactsTypesGet

companyContactsTypesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ContactType>>

- Defined in api/api.ts:38839
Get Contact Types

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

companyContactsTypesIdDelete

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

- Defined in api/api.ts:38895
Delete Contact Type By Id

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

companyContactsTypesIdGet

companyContactsTypesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactType>

- Defined in api/api.ts:38932
Get Contact Type By Id

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

companyContactsTypesIdPatch

companyContactsTypesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactType>

- Defined in api/api.ts:38970
Update Contact Type

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

companyContactsTypesIdPut

companyContactsTypesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactType>

- Defined in api/api.ts:39015
Replace Contact Type

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

companyContactsTypesPost

companyContactsTypesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ContactType>

- Defined in api/api.ts:39059
Create Contact Type

Parameters
- params: object
  - contactType: ContactType
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ContactType>

Generated using TypeDoc