Class CompanySitesApi

Hierarchy

CompanySitesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanySitesApi(basePath?: string): CompanySitesApi

- Defined in api/api.ts:34163
Parameters
- Optional basePath: string
Returns CompanySitesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCompaniesIdSitesCountGet

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

- Defined in api/api.ts:34177
Get Sites Count

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

companyCompaniesIdSitesGet

companyCompaniesIdSitesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CompanySite>>

- Defined in api/api.ts:34224
Get Sites

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

companyCompaniesIdSitesPost

companyCompaniesIdSitesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanySite>

- Defined in api/api.ts:34286
Create Site

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

companyCompaniesIdSitesSiteIdDelete

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

- Defined in api/api.ts:34331
Delete Site By Id

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

companyCompaniesIdSitesSiteIdGet

companyCompaniesIdSitesSiteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanySite>

- Defined in api/api.ts:34374
Get Site By Id

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

companyCompaniesIdSitesSiteIdPatch

companyCompaniesIdSitesSiteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanySite>

- Defined in api/api.ts:34418
Update Site

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

companyCompaniesIdSitesSiteIdPut

companyCompaniesIdSitesSiteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CompanySite>

- Defined in api/api.ts:34469
Replace Site

Parameters
- params: object
  - id: number
  - site: CompanySite
  - siteId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CompanySite>

Generated using TypeDoc