Class Users

Hierarchy

UrlSection
- Users

Index

Constructors

constructor

Methods

Constructors

constructor

new Users(prv: PathSegment, id?: string, service?: any): Users

Overrides UrlSection.constructor
- Defined in paths/Users.ts:8
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Users

Methods

delete

delete(): Promise<void>

- Defined in paths/Users.ts:55
Since 1.0.31 (Release 9.2)
Required Permissions
Permission Description
EditAccounts Viewing and updating user account info (including name, business name, address and phone number/account number)
API Group
Medium

Returns Promise<void>

get

get(query?: GetQuery): Promise<GetUserListResponse>

- Defined in paths/Users.ts:16
Since 1.0.31 (Release 9.2)
Returns the list of users requested.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Medium

Parameters
- Optional query: GetQuery
Returns Promise<GetUserListResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

post

post(body: UserCreationRequest): Promise<UserInfo>

- Defined in paths/Users.ts:29
Since 1.0.31 (Release 9.2)
Creates a user.
Required Permissions
Permission Description
EditAccounts Viewing and updating user account info (including name, business name, address and phone number/account number)
API Group
Medium

Parameters
- body: UserCreationRequest
Returns Promise<UserInfo>

put

put(body: UserUpdateRequest): Promise<UserInfo>

- Defined in paths/Users.ts:42
Since 1.0.31 (Release 9.2)
Required Permissions
Permission Description
EditExtensions Viewing and updating my extension info (includes extension name, number, email and phone number)
API Group
Medium

Parameters
- body: UserUpdateRequest
Returns Promise<UserInfo>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc