Class AgreementTypesApi

Hierarchy

AgreementTypesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgreementTypesApi(basePath?: string): AgreementTypesApi

- Defined in api/api.ts:17359
Parameters
- Optional basePath: string
Returns AgreementTypesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementsTypesCountGet

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

- Defined in api/api.ts:17372
Get Agreement Types Count

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

financeAgreementsTypesGet

financeAgreementsTypesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AgreementType>>

- Defined in api/api.ts:17413
Get Agreement Types

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

financeAgreementsTypesIdDelete

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

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

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

financeAgreementsTypesIdGet

financeAgreementsTypesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementType>

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

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

financeAgreementsTypesIdPatch

financeAgreementsTypesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementType>

- Defined in api/api.ts:17544
Update Agreement Type

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

financeAgreementsTypesIdPut

financeAgreementsTypesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementType>

- Defined in api/api.ts:17589
Replace Agreement Type

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

financeAgreementsTypesPost

financeAgreementsTypesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementType>

- Defined in api/api.ts:17633
Create Agreement Type

Parameters
- params: object
  - agreementType: AgreementType
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<AgreementType>

Generated using TypeDoc