Class AgreementsApi

Hierarchy

AgreementsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgreementsApi(basePath?: string): AgreementsApi

- Defined in api/api.ts:18464
Parameters
- Optional basePath: string
Returns AgreementsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementsCountGet

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

- Defined in api/api.ts:18478
Get Agreements Count

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

financeAgreementsGet

financeAgreementsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Agreement>>

- Defined in api/api.ts:18523
Get Agreements

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

financeAgreementsIdConfigurationsConfigurationIdDelete

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

- Defined in api/api.ts:18580
Delete Configuration Association

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

financeAgreementsIdConfigurationsConfigurationIdGet

financeAgreementsIdConfigurationsConfigurationIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ConfigurationReference>

- Defined in api/api.ts:18623
Get Configuration Association

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

financeAgreementsIdConfigurationsCountGet

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

- Defined in api/api.ts:18665
Get Agreement Configurations Count

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

financeAgreementsIdConfigurationsGet

financeAgreementsIdConfigurationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ConfigurationReference>>

- Defined in api/api.ts:18704
Get Agreement Configurations

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ConfigurationReference>>

financeAgreementsIdConfigurationsPost

financeAgreementsIdConfigurationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ConfigurationReference>

- Defined in api/api.ts:18750
Create Configuration Association

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

financeAgreementsIdDelete

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

- Defined in api/api.ts:18794
Delete Agreement By Id

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

financeAgreementsIdGet

financeAgreementsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Agreement>

- Defined in api/api.ts:18831
Get Agreement By Id

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

financeAgreementsIdPatch

financeAgreementsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Agreement>

- Defined in api/api.ts:18869
Update Agreement

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

financeAgreementsIdPut

financeAgreementsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Agreement>

- Defined in api/api.ts:18914
Replace Agreement

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

financeAgreementsPost

financeAgreementsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Agreement>

- Defined in api/api.ts:18958
Create Agreement

Parameters
- params: object
  - agreement: Agreement
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Agreement>

Generated using TypeDoc