Class RolesApi

Hierarchy

RolesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RolesApi(basePath?: string): RolesApi

- Defined in api/api.ts:80262
Parameters
- Optional basePath: string
Returns RolesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesRolesCountGet

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

- Defined in api/api.ts:80275
Get Role Count

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

salesRolesGet

salesRolesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Role>>

- Defined in api/api.ts:80316
Get Role

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

salesRolesIdDelete

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

- Defined in api/api.ts:80372
Delete Role By Id

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

salesRolesIdGet

salesRolesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Role>

- Defined in api/api.ts:80409
Get Role By Id

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

salesRolesIdPatch

salesRolesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Role>

- Defined in api/api.ts:80447
Update Role

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

salesRolesIdPut

salesRolesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Role>

- Defined in api/api.ts:80492
Replace Role

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

salesRolesPost

salesRolesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Role>

- Defined in api/api.ts:80536
Create Role

Parameters
- params: object
  - role: Role
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Role>

Generated using TypeDoc