Class MembersApi

Hierarchy

MembersApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MembersApi(basePath?: string): MembersApi

- Defined in api/api.ts:59792
Parameters
- Optional basePath: string
Returns MembersApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemMembersCountGet

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

- Defined in api/api.ts:59805
Get Members Count

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

systemMembersGet

systemMembersGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Member>>

- Defined in api/api.ts:59846
Get Members

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

systemMembersIdDeactivatePost

systemMembersIdDeactivatePost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MemberDeactivation>

- Defined in api/api.ts:59903
Deactivatemember

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

systemMembersIdGet

systemMembersIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Member>

- Defined in api/api.ts:59947
Get Member By Id

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

systemMembersIdPatch

systemMembersIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Member>

- Defined in api/api.ts:59985
Update Member

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

systemMembersIdPut

systemMembersIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Member>

- Defined in api/api.ts:60030
Replace Member

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

systemMembersIdUnusedTimeSheetsDelete

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

- Defined in api/api.ts:60074
Delete Member Unused Time Sheets

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

systemMembersMemberIdentifierGet

systemMembersMemberIdentifierGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Member>

- Defined in api/api.ts:60111
Get Member By Member Identifier

Parameters
- params: object
  - memberIdentifier: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Member>

systemMembersMemberIdentifierTokensPost

systemMembersMemberIdentifierTokensPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Token>

- Defined in api/api.ts:60148
Create Token By Member Identifier

Parameters
- params: object
  - memberIdentifier: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Token>

systemMembersPost

systemMembersPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Member>

- Defined in api/api.ts:60185
Create Member

Parameters
- params: object
  - member: Member
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Member>

Generated using TypeDoc