Class GroupCompaniesApi

Hierarchy

GroupCompaniesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GroupCompaniesApi(basePath?: string): GroupCompaniesApi

- Defined in api/api.ts:46590
Parameters
- Optional basePath: string
Returns GroupCompaniesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

marketingGroupsIdCompaniesCompanyIdDelete

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

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

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

marketingGroupsIdCompaniesCompanyIdGet

marketingGroupsIdCompaniesCompanyIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingCompany>

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

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

marketingGroupsIdCompaniesCompanyIdPatch

marketingGroupsIdCompaniesCompanyIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingCompany>

- Defined in api/api.ts:46691
Update Marketing Company

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

marketingGroupsIdCompaniesCompanyIdPut

marketingGroupsIdCompaniesCompanyIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingCompany>

- Defined in api/api.ts:46742
Replace Marketing Company

Parameters
- params: object
  - companyId: number
  - id: number
  - marketingCompany: MarketingCompany
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MarketingCompany>

marketingGroupsIdCompaniesCountGet

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

- Defined in api/api.ts:46792
Get Marketing Companys Count

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

marketingGroupsIdCompaniesGet

marketingGroupsIdCompaniesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<MarketingCompany>>

- Defined in api/api.ts:46839
Get Marketing Companys

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

marketingGroupsIdCompaniesPost

marketingGroupsIdCompaniesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingCompany>

- Defined in api/api.ts:46901
Create Marketing Company

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

Generated using TypeDoc