Class OpportunitiesApi

Hierarchy

OpportunitiesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OpportunitiesApi(basePath?: string): OpportunitiesApi

- Defined in api/api.ts:61515
Parameters
- Optional basePath: string
Returns OpportunitiesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesOpportunitiesCountGet

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

- Defined in api/api.ts:61529
Get Opportunities Count

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

salesOpportunitiesGet

salesOpportunitiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Opportunity>>

- Defined in api/api.ts:61574
Get Opportunities

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

salesOpportunitiesIdConvertToAgreementPost

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

- Defined in api/api.ts:61631
Convert Opportunity To Agreement

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

salesOpportunitiesIdConvertToProjectPost

salesOpportunitiesIdConvertToProjectPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Project>

- Defined in api/api.ts:61676
Convert Opportunity To Project

Parameters
- params: object
  - conversion: OpportunityToProjectConversion
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Project>

salesOpportunitiesIdConvertToSalesOrderPost

salesOpportunitiesIdConvertToSalesOrderPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Order>

- Defined in api/api.ts:61721
Convert Opportunity To Sales Order

Parameters
- params: object
  - conversion: OpportunityToSalesOrderConversion
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Order>

salesOpportunitiesIdConvertToServiceTicketPost

salesOpportunitiesIdConvertToServiceTicketPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Ticket>

- Defined in api/api.ts:61766
Convert Opportunity To Service Ticket

Parameters
- params: object
  - conversion: OpportunityToServiceTicketConversion
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Ticket>

salesOpportunitiesIdDelete

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

- Defined in api/api.ts:61810
Delete Opportunity By Id

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

salesOpportunitiesIdGet

salesOpportunitiesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Opportunity>

- Defined in api/api.ts:61847
Get Opportunity By Id

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

salesOpportunitiesIdPatch

salesOpportunitiesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Opportunity>

- Defined in api/api.ts:61885
Update Opportunity

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

salesOpportunitiesIdPut

salesOpportunitiesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Opportunity>

- Defined in api/api.ts:61930
Replace Opportunity

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

salesOpportunitiesPost

salesOpportunitiesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Opportunity>

- Defined in api/api.ts:61974
Create Opportunity

Parameters
- params: object
  - opportunity: Opportunity
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Opportunity>

Generated using TypeDoc