Class AgreementSitesApi

Hierarchy

AgreementSitesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgreementSitesApi(basePath?: string): AgreementSitesApi

- Defined in api/api.ts:15421
Parameters
- Optional basePath: string
Returns AgreementSitesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementsIdSitesCountGet

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

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

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

financeAgreementsIdSitesGet

financeAgreementsIdSitesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AgreementSite>>

- Defined in api/api.ts:15482
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<AgreementSite>>

financeAgreementsIdSitesPost

financeAgreementsIdSitesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementSite>

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

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

financeAgreementsIdSitesSiteIdDelete

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

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

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

financeAgreementsIdSitesSiteIdGet

financeAgreementsIdSitesSiteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementSite>

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

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

financeAgreementsIdSitesSiteIdPatch

financeAgreementsIdSitesSiteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementSite>

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

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

financeAgreementsIdSitesSiteIdPut

financeAgreementsIdSitesSiteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementSite>

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

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

Generated using TypeDoc