Class CompaniesApi

Hierarchy

CompaniesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompaniesApi(basePath?: string): CompaniesApi

- Defined in api/api.ts:31789
Parameters
- Optional basePath: string
Returns CompaniesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCompaniesCountGet

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

- Defined in api/api.ts:31803
Get Companies Count

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

companyCompaniesGet

companyCompaniesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Company>>

- Defined in api/api.ts:31848
Get Companies

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

companyCompaniesIdDelete

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

- Defined in api/api.ts:31904
Delete Company By Id

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

companyCompaniesIdGet

companyCompaniesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Company>

- Defined in api/api.ts:31941
Get Company By Id

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

companyCompaniesIdMergePost

companyCompaniesIdMergePost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SuccessResponse>

- Defined in api/api.ts:31979
Merge Company

Parameters
- params: object
  - id: number
  - merge: CompanyMerge
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<SuccessResponse>

companyCompaniesIdPatch

companyCompaniesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Company>

- Defined in api/api.ts:32024
Update Company

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

companyCompaniesIdPut

companyCompaniesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Company>

- Defined in api/api.ts:32069
Replace Company

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

companyCompaniesPost

companyCompaniesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Company>

- Defined in api/api.ts:32113
Create Company

Parameters
- params: object
  - company: Company
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Company>

Generated using TypeDoc