import GetUserListResponse from "../definitions/GetUserListResponse"; import UserCreationRequest from "../definitions/UserCreationRequest"; import UserInfo from "../definitions/UserInfo"; import UserUpdateRequest from "../definitions/UserUpdateRequest"; import PathSegment from "../PathSegment"; export default class Users extends PathSegment { constructor(prv: PathSegment, id?: string, service?: any); /** *

Since 1.0.31 (Release 9.2)

Returns the list of users requested.

Required Permissions

PermissionDescription
ReadAccountsViewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

*/ get(query?: GetQuery): Promise; /** *

Since 1.0.31 (Release 9.2)

Returns the list of users requested.

Required Permissions

PermissionDescription
ReadAccountsViewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

* return {ApiResponse} */ getRaw(query?: GetQuery): Promise; /** *

Since 1.0.31 (Release 9.2)

Creates a user.

Required Permissions

PermissionDescription
EditAccountsViewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Medium

*/ post(body: UserCreationRequest): Promise; /** *

Since 1.0.31 (Release 9.2)

Creates a user.

Required Permissions

PermissionDescription
EditAccountsViewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Medium

* return {ApiResponse} */ postRaw(body: UserCreationRequest): Promise; /** *

Since 1.0.31 (Release 9.2)

Required Permissions

PermissionDescription
EditExtensionsUpdating User using SCIM

API Group

Medium

*/ put(body: UserUpdateRequest): Promise; /** *

Since 1.0.31 (Release 9.2)

Required Permissions

PermissionDescription
EditExtensionsUpdating User using SCIM

API Group

Medium

* return {ApiResponse} */ putRaw(body: UserUpdateRequest): Promise; /** *

Since 1.0.31 (Release 9.2)

Required Permissions

PermissionDescription
EditAccountsDeleting User using scim

API Group

Medium

*/ delete(): Promise; /** *

Since 1.0.31 (Release 9.2)

Required Permissions

PermissionDescription
EditAccountsDeleting User using scim

API Group

Medium

* return {ApiResponse} */ deleteRaw(): Promise; } export interface GetQuery { /** * only support 'userName' or 'email' filter expressions for now */ filter?: "userName" | "email"; /** * page size */ count?: number; /** * start index (1-based) */ startIndex?: number; }