Class CompanyGroupsApi

Hierarchy

CompanyGroupsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanyGroupsApi(basePath?: string): CompanyGroupsApi

- Defined in api/api.ts:31726
Parameters
- Optional basePath: string
Returns CompanyGroupsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCompaniesIdGroupsCountGet

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

- Defined in api/api.ts:31740
Get Company Groups Count

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

companyCompaniesIdGroupsGet

companyCompaniesIdGroupsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CompanyGroup>>

- Defined in api/api.ts:31787
Get Company 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<CompanyGroup>>

companyCompaniesIdGroupsGroupidDelete

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

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

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

companyCompaniesIdGroupsGroupidGet

companyCompaniesIdGroupsGroupidGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyGroup>

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

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

companyCompaniesIdGroupsGroupidPatch

companyCompaniesIdGroupsGroupidPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyGroup>

- Defined in api/api.ts:31936
Update Company Group

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

companyCompaniesIdGroupsGroupidPut

companyCompaniesIdGroupsGroupidPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyGroup>

- Defined in api/api.ts:31987
Replace Company Group

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

companyCompaniesIdGroupsPost

companyCompaniesIdGroupsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanyGroup>

- Defined in api/api.ts:32037
Create Company Group

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

Generated using TypeDoc