// This is Generated Source.
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?) {
super("Users", id, prv, service);
}
/**
* 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
*/
get(query?: GetQuery): Promise {
return this._send({
body: undefined,
ignoreId: true,
method: "get",
query: query,
}).then((res) => {
return res.json();
});
}
/**
* 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
* return {ApiResponse}
*/
getRaw(query?: GetQuery): Promise {
return this._send({
body: undefined,
ignoreId: true,
method: "get",
query: query,
});
}
/**
* 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
*/
post(body: UserCreationRequest): Promise {
return this._send({
body: body,
ignoreId: true,
method: "post",
query: undefined,
}).then((res) => {
return res.json();
});
}
/**
* 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
* return {ApiResponse}
*/
postRaw(body: UserCreationRequest): Promise {
return this._send({
body: body,
ignoreId: true,
method: "post",
query: undefined,
});
}
/**
* Since 1.0.31 (Release 9.2)
Required Permissions
| Permission | Description |
|---|
| EditExtensions | Updating User using SCIM |
API Group
Medium
*/
put(body: UserUpdateRequest): Promise {
return this._send({
body: body,
ignoreId: true,
method: "put",
query: undefined,
}).then((res) => {
return res.json();
});
}
/**
* Since 1.0.31 (Release 9.2)
Required Permissions
| Permission | Description |
|---|
| EditExtensions | Updating User using SCIM |
API Group
Medium
* return {ApiResponse}
*/
putRaw(body: UserUpdateRequest): Promise {
return this._send({
body: body,
ignoreId: true,
method: "put",
query: undefined,
});
}
/**
* Since 1.0.31 (Release 9.2)
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Deleting User using scim |
API Group
Medium
*/
delete(): Promise {
return this._send({
body: undefined,
ignoreId: true,
method: "delete",
query: undefined,
});
}
/**
* Since 1.0.31 (Release 9.2)
Required Permissions
| Permission | Description |
|---|
| EditAccounts | Deleting User using scim |
API Group
Medium
* return {ApiResponse}
*/
deleteRaw(): Promise {
return this._send({
body: undefined,
ignoreId: true,
method: "delete",
query: undefined,
});
}
}
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;
}