Class ServiceLocationsApi

Hierarchy

ServiceLocationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServiceLocationsApi(basePath?: string): ServiceLocationsApi

- Defined in api/api.ts:83202
Parameters
- Optional basePath: string
Returns ServiceLocationsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceLocationsCountGet

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

- Defined in api/api.ts:83215
Create Locations Count

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

serviceLocationsGet

serviceLocationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ServiceLocation>>

- Defined in api/api.ts:83256
Get Locations

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

serviceLocationsIdDelete

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

- Defined in api/api.ts:83312
Delete Location By Id

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

serviceLocationsIdGet

serviceLocationsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceLocation>

- Defined in api/api.ts:83349
Get Location By Id

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

serviceLocationsIdPatch

serviceLocationsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceLocation>

- Defined in api/api.ts:83387
Update Location

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

serviceLocationsIdPut

serviceLocationsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceLocation>

- Defined in api/api.ts:83432
Replace Location

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

serviceLocationsPost

serviceLocationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ServiceLocation>

- Defined in api/api.ts:83476
Create Location

Parameters
- params: object
  - location: ServiceLocation
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ServiceLocation>

Generated using TypeDoc