Class ServiceSurveysApi

Hierarchy

ServiceSurveysApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServiceSurveysApi(basePath?: string): ServiceSurveysApi

- Defined in api/api.ts:86218
Parameters
- Optional basePath: string
Returns ServiceSurveysApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceSurveysCountGet

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

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

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

serviceSurveysGet

serviceSurveysGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ServiceSurvey>>

- Defined in api/api.ts:86272
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<ServiceSurvey>>

serviceSurveysIdCopyPost

serviceSurveysIdCopyPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceSurvey>

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

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

serviceSurveysIdDelete

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

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

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

serviceSurveysIdGet

serviceSurveysIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceSurvey>

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

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

serviceSurveysIdPatch

serviceSurveysIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceSurvey>

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

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

serviceSurveysIdPut

serviceSurveysIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceSurvey>

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

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

serviceSurveysPost

serviceSurveysPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceSurvey>

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

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

Generated using TypeDoc