Class SurveysApi

Hierarchy

SurveysApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SurveysApi(basePath?: string): SurveysApi

- Defined in api/api.ts:90877
Parameters
- Optional basePath: string
Returns SurveysApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemSurveysCountGet

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

- Defined in api/api.ts:90890
Get Surveys Count

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

systemSurveysGet

systemSurveysGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Survey>>

- Defined in api/api.ts:90931
Get Surveys

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

systemSurveysIdCopyPost

systemSurveysIdCopyPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Survey>

- Defined in api/api.ts:90987
Copy Survey

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

systemSurveysIdDelete

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

- Defined in api/api.ts:91024
Delete Survey By Id

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

systemSurveysIdGet

systemSurveysIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Survey>

- Defined in api/api.ts:91061
Get Survey By Id

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

systemSurveysIdPatch

systemSurveysIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Survey>

- Defined in api/api.ts:91099
Update Survey

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

systemSurveysIdPut

systemSurveysIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Survey>

- Defined in api/api.ts:91144
Replace Survey

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

systemSurveysPost

systemSurveysPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Survey>

- Defined in api/api.ts:91188
Create Survey

Parameters
- params: object
  - survey: Survey
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Survey>

Generated using TypeDoc