Class ActivitiesApi

Hierarchy

ActivitiesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ActivitiesApi(basePath?: string): ActivitiesApi

- Defined in api/api.ts:11288
Parameters
- Optional basePath: string
Returns ActivitiesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesActivitiesCountGet

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

- Defined in api/api.ts:11302
Get Activities Count

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

salesActivitiesGet

salesActivitiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Activity>>

- Defined in api/api.ts:11347
Get Activities

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

salesActivitiesIdDelete

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

- Defined in api/api.ts:11403
Delete Activity By Id

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

salesActivitiesIdGet

salesActivitiesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Activity>

- Defined in api/api.ts:11440
Get Activity By Id

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

salesActivitiesIdPatch

salesActivitiesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Activity>

- Defined in api/api.ts:11478
Update Activity

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

salesActivitiesIdPut

salesActivitiesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Activity>

- Defined in api/api.ts:11523
Replace Activity

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

salesActivitiesPost

salesActivitiesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Activity>

- Defined in api/api.ts:11567
Create Activity

Parameters
- params: object
  - activity: Activity
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Activity>

Generated using TypeDoc