@wildix/xbees-users-client 1.0.26 → 1.0.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/Users.js +4 -4
- package/dist-cjs/commands/{GetUserSettingsCommand.js → CreateSystemBotCommand.js} +7 -7
- package/dist-cjs/commands/{PartialUpdateUserSettingsCommand.js → QueryColleaguesCommand.js} +7 -7
- package/dist-cjs/commands/index.js +2 -2
- package/dist-cjs/models/models_0.js +35 -1
- package/dist-cjs/protocols/Aws_restJson1.js +46 -39
- package/dist-es/Users.js +4 -4
- package/dist-es/commands/{GetUserSettingsCommand.js → CreateSystemBotCommand.js} +6 -6
- package/dist-es/commands/QueryColleaguesCommand.js +17 -0
- package/dist-es/commands/index.js +2 -2
- package/dist-es/models/models_0.js +34 -0
- package/dist-es/protocols/Aws_restJson1.js +41 -34
- package/dist-types/Users.d.ts +13 -12
- package/dist-types/UsersClient.d.ts +4 -4
- package/dist-types/commands/CreateSystemBotCommand.d.ts +66 -0
- package/dist-types/commands/QueryColleaguesCommand.d.ts +138 -0
- package/dist-types/commands/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +144 -57
- package/dist-types/protocols/Aws_restJson1.d.ts +14 -14
- package/package.json +2 -2
- package/dist-es/commands/PartialUpdateUserSettingsCommand.js +0 -17
- package/dist-types/commands/GetUserSettingsCommand.d.ts +0 -69
- package/dist-types/commands/PartialUpdateUserSettingsCommand.d.ts +0 -76
package/dist-types/Users.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1Comma
|
|
|
5
5
|
import { ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
|
|
6
6
|
import { CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
|
|
7
7
|
import { CreateBotCommandInput, CreateBotCommandOutput } from "./commands/CreateBotCommand";
|
|
8
|
+
import { CreateSystemBotCommandInput, CreateSystemBotCommandOutput } from "./commands/CreateSystemBotCommand";
|
|
8
9
|
import { DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput } from "./commands/DeleteBotApiKeyCommand";
|
|
9
10
|
import { DeleteBotCommandInput, DeleteBotCommandOutput } from "./commands/DeleteBotCommand";
|
|
10
11
|
import { GetBotCallbackCommandInput, GetBotCallbackCommandOutput } from "./commands/GetBotCallbackCommand";
|
|
@@ -13,10 +14,9 @@ import { GetUserCommandInput, GetUserCommandOutput } from "./commands/GetUserCom
|
|
|
13
14
|
import { GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput } from "./commands/GetUserPbxLinkDataCommand";
|
|
14
15
|
import { GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionCommandOutput } from "./commands/GetUserPbxLinkSuggestionCommand";
|
|
15
16
|
import { GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
|
|
16
|
-
import { GetUserSettingsCommandInput, GetUserSettingsCommandOutput } from "./commands/GetUserSettingsCommand";
|
|
17
17
|
import { ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
|
|
18
18
|
import { ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
|
|
19
|
-
import {
|
|
19
|
+
import { QueryColleaguesCommandInput, QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
|
|
20
20
|
import { QueryUserCommandInput, QueryUserCommandOutput } from "./commands/QueryUserCommand";
|
|
21
21
|
import { QueryUsersCommandInput, QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
|
|
22
22
|
import { UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
|
|
@@ -63,6 +63,12 @@ export interface Users {
|
|
|
63
63
|
createBotApiKey(args: CreateBotApiKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateBotApiKeyCommandOutput>;
|
|
64
64
|
createBotApiKey(args: CreateBotApiKeyCommandInput, cb: (err: any, data?: CreateBotApiKeyCommandOutput) => void): void;
|
|
65
65
|
createBotApiKey(args: CreateBotApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotApiKeyCommandOutput) => void): void;
|
|
66
|
+
/**
|
|
67
|
+
* @see {@link CreateSystemBotCommand}
|
|
68
|
+
*/
|
|
69
|
+
createSystemBot(args: CreateSystemBotCommandInput, options?: __HttpHandlerOptions): Promise<CreateSystemBotCommandOutput>;
|
|
70
|
+
createSystemBot(args: CreateSystemBotCommandInput, cb: (err: any, data?: CreateSystemBotCommandOutput) => void): void;
|
|
71
|
+
createSystemBot(args: CreateSystemBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSystemBotCommandOutput) => void): void;
|
|
66
72
|
/**
|
|
67
73
|
* @see {@link DeleteBotCommand}
|
|
68
74
|
*/
|
|
@@ -113,12 +119,6 @@ export interface Users {
|
|
|
113
119
|
getUserPbxLinkSuggestionV1(args: GetUserPbxLinkSuggestionV1CommandInput, options?: __HttpHandlerOptions): Promise<GetUserPbxLinkSuggestionV1CommandOutput>;
|
|
114
120
|
getUserPbxLinkSuggestionV1(args: GetUserPbxLinkSuggestionV1CommandInput, cb: (err: any, data?: GetUserPbxLinkSuggestionV1CommandOutput) => void): void;
|
|
115
121
|
getUserPbxLinkSuggestionV1(args: GetUserPbxLinkSuggestionV1CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPbxLinkSuggestionV1CommandOutput) => void): void;
|
|
116
|
-
/**
|
|
117
|
-
* @see {@link GetUserSettingsCommand}
|
|
118
|
-
*/
|
|
119
|
-
getUserSettings(args: GetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetUserSettingsCommandOutput>;
|
|
120
|
-
getUserSettings(args: GetUserSettingsCommandInput, cb: (err: any, data?: GetUserSettingsCommandOutput) => void): void;
|
|
121
|
-
getUserSettings(args: GetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserSettingsCommandOutput) => void): void;
|
|
122
122
|
/**
|
|
123
123
|
* @see {@link ListBotApiKeysCommand}
|
|
124
124
|
*/
|
|
@@ -133,11 +133,12 @@ export interface Users {
|
|
|
133
133
|
listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void;
|
|
134
134
|
listBots(args: ListBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotsCommandOutput) => void): void;
|
|
135
135
|
/**
|
|
136
|
-
* @see {@link
|
|
136
|
+
* @see {@link QueryColleaguesCommand}
|
|
137
137
|
*/
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
138
|
+
queryColleagues(): Promise<QueryColleaguesCommandOutput>;
|
|
139
|
+
queryColleagues(args: QueryColleaguesCommandInput, options?: __HttpHandlerOptions): Promise<QueryColleaguesCommandOutput>;
|
|
140
|
+
queryColleagues(args: QueryColleaguesCommandInput, cb: (err: any, data?: QueryColleaguesCommandOutput) => void): void;
|
|
141
|
+
queryColleagues(args: QueryColleaguesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryColleaguesCommandOutput) => void): void;
|
|
141
142
|
/**
|
|
142
143
|
* @see {@link QueryUserCommand}
|
|
143
144
|
*/
|
|
@@ -4,6 +4,7 @@ import { BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1Comma
|
|
|
4
4
|
import { ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
|
|
5
5
|
import { CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
|
|
6
6
|
import { CreateBotCommandInput, CreateBotCommandOutput } from "./commands/CreateBotCommand";
|
|
7
|
+
import { CreateSystemBotCommandInput, CreateSystemBotCommandOutput } from "./commands/CreateSystemBotCommand";
|
|
7
8
|
import { DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput } from "./commands/DeleteBotApiKeyCommand";
|
|
8
9
|
import { DeleteBotCommandInput, DeleteBotCommandOutput } from "./commands/DeleteBotCommand";
|
|
9
10
|
import { GetBotCallbackCommandInput, GetBotCallbackCommandOutput } from "./commands/GetBotCallbackCommand";
|
|
@@ -12,10 +13,9 @@ import { GetUserCommandInput, GetUserCommandOutput } from "./commands/GetUserCom
|
|
|
12
13
|
import { GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput } from "./commands/GetUserPbxLinkDataCommand";
|
|
13
14
|
import { GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionCommandOutput } from "./commands/GetUserPbxLinkSuggestionCommand";
|
|
14
15
|
import { GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
|
|
15
|
-
import { GetUserSettingsCommandInput, GetUserSettingsCommandOutput } from "./commands/GetUserSettingsCommand";
|
|
16
16
|
import { ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
|
|
17
17
|
import { ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
|
|
18
|
-
import {
|
|
18
|
+
import { QueryColleaguesCommandInput, QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
|
|
19
19
|
import { QueryUserCommandInput, QueryUserCommandOutput } from "./commands/QueryUserCommand";
|
|
20
20
|
import { QueryUsersCommandInput, QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
|
|
21
21
|
import { UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
|
|
@@ -35,11 +35,11 @@ export { __Client };
|
|
|
35
35
|
/**
|
|
36
36
|
* @public
|
|
37
37
|
*/
|
|
38
|
-
export type ServiceInputTypes = BatchGetUsersCommandInput | BatchGetUsersPbxLinkDataCommandInput | BatchGetUsersPbxLinkDataV1CommandInput | ChangeUserEmailCommandInput | CreateBotApiKeyCommandInput | CreateBotCommandInput | DeleteBotApiKeyCommandInput | DeleteBotCommandInput | GetBotCallbackCommandInput | GetBotCommandInput | GetUserCommandInput | GetUserPbxLinkDataCommandInput | GetUserPbxLinkSuggestionCommandInput | GetUserPbxLinkSuggestionV1CommandInput |
|
|
38
|
+
export type ServiceInputTypes = BatchGetUsersCommandInput | BatchGetUsersPbxLinkDataCommandInput | BatchGetUsersPbxLinkDataV1CommandInput | ChangeUserEmailCommandInput | CreateBotApiKeyCommandInput | CreateBotCommandInput | CreateSystemBotCommandInput | DeleteBotApiKeyCommandInput | DeleteBotCommandInput | GetBotCallbackCommandInput | GetBotCommandInput | GetUserCommandInput | GetUserPbxLinkDataCommandInput | GetUserPbxLinkSuggestionCommandInput | GetUserPbxLinkSuggestionV1CommandInput | ListBotApiKeysCommandInput | ListBotsCommandInput | QueryColleaguesCommandInput | QueryUserCommandInput | QueryUsersCommandInput | UpdateBotCallbackCommandInput | UpdateBotCommandInput | UploadPictureCommandInput | UploadPictureV1CommandInput | VerifyBotSecretKeyCommandInput | VerifyBotSecretKeyV1CommandInput;
|
|
39
39
|
/**
|
|
40
40
|
* @public
|
|
41
41
|
*/
|
|
42
|
-
export type ServiceOutputTypes = BatchGetUsersCommandOutput | BatchGetUsersPbxLinkDataCommandOutput | BatchGetUsersPbxLinkDataV1CommandOutput | ChangeUserEmailCommandOutput | CreateBotApiKeyCommandOutput | CreateBotCommandOutput | DeleteBotApiKeyCommandOutput | DeleteBotCommandOutput | GetBotCallbackCommandOutput | GetBotCommandOutput | GetUserCommandOutput | GetUserPbxLinkDataCommandOutput | GetUserPbxLinkSuggestionCommandOutput | GetUserPbxLinkSuggestionV1CommandOutput |
|
|
42
|
+
export type ServiceOutputTypes = BatchGetUsersCommandOutput | BatchGetUsersPbxLinkDataCommandOutput | BatchGetUsersPbxLinkDataV1CommandOutput | ChangeUserEmailCommandOutput | CreateBotApiKeyCommandOutput | CreateBotCommandOutput | CreateSystemBotCommandOutput | DeleteBotApiKeyCommandOutput | DeleteBotCommandOutput | GetBotCallbackCommandOutput | GetBotCommandOutput | GetUserCommandOutput | GetUserPbxLinkDataCommandOutput | GetUserPbxLinkSuggestionCommandOutput | GetUserPbxLinkSuggestionV1CommandOutput | ListBotApiKeysCommandOutput | ListBotsCommandOutput | QueryColleaguesCommandOutput | QueryUserCommandOutput | QueryUsersCommandOutput | UpdateBotCallbackCommandOutput | UpdateBotCommandOutput | UploadPictureCommandOutput | UploadPictureV1CommandOutput | VerifyBotSecretKeyCommandOutput | VerifyBotSecretKeyV1CommandOutput;
|
|
43
43
|
/**
|
|
44
44
|
* @public
|
|
45
45
|
*/
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { CreateSystemBotInput, CreateSystemBotOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateSystemBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateSystemBotCommandInput extends CreateSystemBotInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateSystemBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateSystemBotCommandOutput extends CreateSystemBotOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateSystemBotCommand_base: {
|
|
25
|
+
new (input: CreateSystemBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSystemBotCommandInput, CreateSystemBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateSystemBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSystemBotCommandInput, CreateSystemBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { UsersClient, CreateSystemBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
36
|
+
* // const { UsersClient, CreateSystemBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
37
|
+
* const client = new UsersClient(config);
|
|
38
|
+
* const input = { // CreateSystemBotInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* name: "STRING_VALUE", // required
|
|
41
|
+
* picture: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CreateSystemBotCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // CreateSystemBotOutput
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param CreateSystemBotCommandInput - {@link CreateSystemBotCommandInput}
|
|
52
|
+
* @returns {@link CreateSystemBotCommandOutput}
|
|
53
|
+
* @see {@link CreateSystemBotCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link CreateSystemBotCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link UsersServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
export declare class CreateSystemBotCommand extends CreateSystemBotCommand_base {
|
|
66
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { QueryColleaguesInput, QueryColleaguesOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link QueryColleaguesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface QueryColleaguesCommandInput extends QueryColleaguesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link QueryColleaguesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface QueryColleaguesCommandOutput extends QueryColleaguesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const QueryColleaguesCommand_base: {
|
|
25
|
+
new (input: QueryColleaguesCommandInput): import("@smithy/smithy-client").CommandImpl<QueryColleaguesCommandInput, QueryColleaguesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [QueryColleaguesCommandInput]): import("@smithy/smithy-client").CommandImpl<QueryColleaguesCommandInput, QueryColleaguesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { UsersClient, QueryColleaguesCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
36
|
+
* // const { UsersClient, QueryColleaguesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
37
|
+
* const client = new UsersClient(config);
|
|
38
|
+
* const input = { // QueryColleaguesInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* query: { // QueryColleaguesParameters
|
|
41
|
+
* id: [ // ColleaguesFilterList
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* extension: [
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* officePhone: [
|
|
48
|
+
* "STRING_VALUE",
|
|
49
|
+
* ],
|
|
50
|
+
* mobilePhone: [
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* name: [
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* email: "<ColleaguesFilterList>",
|
|
57
|
+
* department: "<ColleaguesFilterList>",
|
|
58
|
+
* search: "STRING_VALUE",
|
|
59
|
+
* searchFields: [ // PbxColleaguesQueryFieldList
|
|
60
|
+
* "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
|
|
61
|
+
* ],
|
|
62
|
+
* searchStrategy: "contain" || "startsWith",
|
|
63
|
+
* sort: [
|
|
64
|
+
* "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
|
|
65
|
+
* ],
|
|
66
|
+
* start: Number("int"),
|
|
67
|
+
* count: Number("int"),
|
|
68
|
+
* dir: "asc" || "desc",
|
|
69
|
+
* },
|
|
70
|
+
* };
|
|
71
|
+
* const command = new QueryColleaguesCommand(input);
|
|
72
|
+
* const response = await client.send(command);
|
|
73
|
+
* // { // QueryColleaguesOutput
|
|
74
|
+
* // colleagues: [ // QueryColleaguesOutputItemList // required
|
|
75
|
+
* // { // QueryColleaguesOutputItem
|
|
76
|
+
* // user: { // User
|
|
77
|
+
* // id: "STRING_VALUE", // required
|
|
78
|
+
* // name: "STRING_VALUE",
|
|
79
|
+
* // email: "STRING_VALUE",
|
|
80
|
+
* // phone: "STRING_VALUE",
|
|
81
|
+
* // picture: "STRING_VALUE",
|
|
82
|
+
* // locale: "STRING_VALUE",
|
|
83
|
+
* // timeZone: "STRING_VALUE",
|
|
84
|
+
* // company: "STRING_VALUE",
|
|
85
|
+
* // bot: true || false,
|
|
86
|
+
* // pbxDomain: "STRING_VALUE",
|
|
87
|
+
* // pbxPort: "STRING_VALUE",
|
|
88
|
+
* // pbxExtension: "STRING_VALUE",
|
|
89
|
+
* // pbxSerial: "STRING_VALUE",
|
|
90
|
+
* // pbxUserId: "STRING_VALUE",
|
|
91
|
+
* // createdAt: "STRING_VALUE",
|
|
92
|
+
* // updatedAt: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // colleague: { // PbxColleague
|
|
95
|
+
* // id: "STRING_VALUE", // required
|
|
96
|
+
* // name: "STRING_VALUE",
|
|
97
|
+
* // login: "STRING_VALUE",
|
|
98
|
+
* // extension: "STRING_VALUE", // required
|
|
99
|
+
* // officePhone: "STRING_VALUE",
|
|
100
|
+
* // mobilePhone: "STRING_VALUE",
|
|
101
|
+
* // faxNumber: "STRING_VALUE",
|
|
102
|
+
* // email: "STRING_VALUE",
|
|
103
|
+
* // pbxDn: "STRING_VALUE", // required
|
|
104
|
+
* // pbx: "STRING_VALUE", // required
|
|
105
|
+
* // role: "admin" || "user" || "fax" || "park_orbit" || "room", // required
|
|
106
|
+
* // groupName: "STRING_VALUE", // required
|
|
107
|
+
* // groupDn: "STRING_VALUE", // required
|
|
108
|
+
* // language: "STRING_VALUE", // required
|
|
109
|
+
* // dialplan: "STRING_VALUE", // required
|
|
110
|
+
* // faxDialplan: "STRING_VALUE", // required
|
|
111
|
+
* // department: "STRING_VALUE",
|
|
112
|
+
* // picture: "STRING_VALUE", // required
|
|
113
|
+
* // sourceId: "STRING_VALUE",
|
|
114
|
+
* // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
|
|
115
|
+
* // jid: "STRING_VALUE", // required
|
|
116
|
+
* // },
|
|
117
|
+
* // },
|
|
118
|
+
* // ],
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param QueryColleaguesCommandInput - {@link QueryColleaguesCommandInput}
|
|
124
|
+
* @returns {@link QueryColleaguesCommandOutput}
|
|
125
|
+
* @see {@link QueryColleaguesCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link QueryColleaguesCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link ValidationException} (client fault)
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link UsersServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
135
|
+
*
|
|
136
|
+
*/
|
|
137
|
+
export declare class QueryColleaguesCommand extends QueryColleaguesCommand_base {
|
|
138
|
+
}
|
|
@@ -4,6 +4,7 @@ export * from "./BatchGetUsersPbxLinkDataV1Command";
|
|
|
4
4
|
export * from "./ChangeUserEmailCommand";
|
|
5
5
|
export * from "./CreateBotCommand";
|
|
6
6
|
export * from "./CreateBotApiKeyCommand";
|
|
7
|
+
export * from "./CreateSystemBotCommand";
|
|
7
8
|
export * from "./DeleteBotCommand";
|
|
8
9
|
export * from "./DeleteBotApiKeyCommand";
|
|
9
10
|
export * from "./GetBotCommand";
|
|
@@ -12,10 +13,9 @@ export * from "./GetUserCommand";
|
|
|
12
13
|
export * from "./GetUserPbxLinkDataCommand";
|
|
13
14
|
export * from "./GetUserPbxLinkSuggestionCommand";
|
|
14
15
|
export * from "./GetUserPbxLinkSuggestionV1Command";
|
|
15
|
-
export * from "./GetUserSettingsCommand";
|
|
16
16
|
export * from "./ListBotApiKeysCommand";
|
|
17
17
|
export * from "./ListBotsCommand";
|
|
18
|
-
export * from "./
|
|
18
|
+
export * from "./QueryColleaguesCommand";
|
|
19
19
|
export * from "./QueryUserCommand";
|
|
20
20
|
export * from "./QueryUsersCommand";
|
|
21
21
|
export * from "./UpdateBotCommand";
|
|
@@ -106,6 +106,98 @@ export interface BotWebhookEndpoint {
|
|
|
106
106
|
url: string;
|
|
107
107
|
secret: string;
|
|
108
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
* @enum
|
|
112
|
+
*/
|
|
113
|
+
export declare const PbxColleagueRole: {
|
|
114
|
+
readonly ADMIN: "admin";
|
|
115
|
+
readonly FAX: "fax";
|
|
116
|
+
readonly PARK_ORBIT: "park_orbit";
|
|
117
|
+
readonly ROOM: "room";
|
|
118
|
+
readonly USER: "user";
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export type PbxColleagueRole = typeof PbxColleagueRole[keyof typeof PbxColleagueRole];
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export interface PbxColleague {
|
|
128
|
+
id: string;
|
|
129
|
+
name?: string;
|
|
130
|
+
login?: string;
|
|
131
|
+
extension: string;
|
|
132
|
+
officePhone?: string;
|
|
133
|
+
mobilePhone?: string;
|
|
134
|
+
faxNumber?: string;
|
|
135
|
+
email?: string;
|
|
136
|
+
pbxDn: string;
|
|
137
|
+
pbx: string;
|
|
138
|
+
role: PbxColleagueRole;
|
|
139
|
+
groupName: string;
|
|
140
|
+
groupDn: string;
|
|
141
|
+
language: string;
|
|
142
|
+
dialplan: string;
|
|
143
|
+
faxDialplan: string;
|
|
144
|
+
department?: string;
|
|
145
|
+
picture: string;
|
|
146
|
+
sourceId?: string;
|
|
147
|
+
licenseType: PbxLicenseType;
|
|
148
|
+
jid: string;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* @enum
|
|
153
|
+
*/
|
|
154
|
+
export declare const GetPbxColleaguesDir: {
|
|
155
|
+
readonly ASC: "asc";
|
|
156
|
+
readonly DESC: "desc";
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export type GetPbxColleaguesDir = typeof GetPbxColleaguesDir[keyof typeof GetPbxColleaguesDir];
|
|
162
|
+
/**
|
|
163
|
+
* @public
|
|
164
|
+
* @enum
|
|
165
|
+
*/
|
|
166
|
+
export declare const PbxColleaguesQueryField: {
|
|
167
|
+
readonly DEPARTMENT: "department";
|
|
168
|
+
readonly DIALPLAN: "dialplan";
|
|
169
|
+
readonly EMAIL: "email";
|
|
170
|
+
readonly EXTENSION: "extension";
|
|
171
|
+
readonly FAX_DIALPLAN: "faxDialplan";
|
|
172
|
+
readonly GROUP_DN: "groupDn";
|
|
173
|
+
readonly ID: "id";
|
|
174
|
+
readonly LANGUAGE: "language";
|
|
175
|
+
readonly LICENSE_TYPE: "licenseType";
|
|
176
|
+
readonly LOGIN: "login";
|
|
177
|
+
readonly MOBILE_PHONE: "mobilePhone";
|
|
178
|
+
readonly NAME: "name";
|
|
179
|
+
readonly OFFICE_PHONE: "officePhone";
|
|
180
|
+
readonly PBX_DN: "pbxDn";
|
|
181
|
+
readonly PICTURE: "picture";
|
|
182
|
+
readonly ROLE: "role";
|
|
183
|
+
readonly SOURCE_ID: "sourceId";
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export type PbxColleaguesQueryField = typeof PbxColleaguesQueryField[keyof typeof PbxColleaguesQueryField];
|
|
189
|
+
/**
|
|
190
|
+
* @public
|
|
191
|
+
* @enum
|
|
192
|
+
*/
|
|
193
|
+
export declare const PbxColleaguesSearchStrategy: {
|
|
194
|
+
readonly CONTAIN: "contain";
|
|
195
|
+
readonly STARTS_WITH: "startsWith";
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
export type PbxColleaguesSearchStrategy = typeof PbxColleaguesSearchStrategy[keyof typeof PbxColleaguesSearchStrategy];
|
|
109
201
|
/**
|
|
110
202
|
* @public
|
|
111
203
|
*/
|
|
@@ -612,6 +704,28 @@ export interface CreateBotApiKeyOutput {
|
|
|
612
704
|
bot: Bot;
|
|
613
705
|
key: BotApiKey;
|
|
614
706
|
}
|
|
707
|
+
/**
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
export interface CreateSystemBotInput {
|
|
711
|
+
/**
|
|
712
|
+
* The unique identifier of the tenant when a service token is used.
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
company?: string;
|
|
716
|
+
name: string;
|
|
717
|
+
/**
|
|
718
|
+
* A URL pointing to the bot's avatar.
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
picture?: string;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
export interface CreateSystemBotOutput {
|
|
727
|
+
id: string;
|
|
728
|
+
}
|
|
615
729
|
/**
|
|
616
730
|
* @public
|
|
617
731
|
*/
|
|
@@ -637,21 +751,6 @@ export interface DeleteBotApiKeyInput {
|
|
|
637
751
|
*/
|
|
638
752
|
export interface DeleteBotApiKeyOutput {
|
|
639
753
|
}
|
|
640
|
-
/**
|
|
641
|
-
* @public
|
|
642
|
-
*/
|
|
643
|
-
export interface EmailNotificationsSettings {
|
|
644
|
-
/**
|
|
645
|
-
* Indicates whether the user wants to receive email notifications about unread messages.
|
|
646
|
-
* @public
|
|
647
|
-
*/
|
|
648
|
-
unread: boolean;
|
|
649
|
-
/**
|
|
650
|
-
* Indicates whether the user wants to receive email notifications about AI transcription.
|
|
651
|
-
* @public
|
|
652
|
-
*/
|
|
653
|
-
transcription: boolean;
|
|
654
|
-
}
|
|
655
754
|
/**
|
|
656
755
|
* @public
|
|
657
756
|
*/
|
|
@@ -765,26 +864,6 @@ export interface GetUserPbxLinkSuggestionV1Output {
|
|
|
765
864
|
*/
|
|
766
865
|
suggestion?: UserPbxLinkSuggestion;
|
|
767
866
|
}
|
|
768
|
-
/**
|
|
769
|
-
* @public
|
|
770
|
-
*/
|
|
771
|
-
export interface GetUserSettingsInput {
|
|
772
|
-
/**
|
|
773
|
-
* The unique identifier of the user (Cloud ID, not ID of the user on PBX).
|
|
774
|
-
* @public
|
|
775
|
-
*/
|
|
776
|
-
userId: string;
|
|
777
|
-
}
|
|
778
|
-
/**
|
|
779
|
-
* @public
|
|
780
|
-
*/
|
|
781
|
-
export interface GetUserSettingsOutput {
|
|
782
|
-
/**
|
|
783
|
-
* Indicates whether the user wants to receive email notifications.
|
|
784
|
-
* @public
|
|
785
|
-
*/
|
|
786
|
-
emailNotifications?: EmailNotificationsSettings;
|
|
787
|
-
}
|
|
788
867
|
/**
|
|
789
868
|
* @public
|
|
790
869
|
*/
|
|
@@ -813,49 +892,57 @@ export interface ListBotsOutput {
|
|
|
813
892
|
/**
|
|
814
893
|
* @public
|
|
815
894
|
*/
|
|
816
|
-
export interface
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
895
|
+
export interface QueryColleaguesParameters {
|
|
896
|
+
id?: (string)[];
|
|
897
|
+
extension?: (string)[];
|
|
898
|
+
officePhone?: (string)[];
|
|
899
|
+
mobilePhone?: (string)[];
|
|
900
|
+
name?: (string)[];
|
|
901
|
+
email?: (string)[];
|
|
902
|
+
department?: (string)[];
|
|
903
|
+
search?: string;
|
|
904
|
+
searchFields?: (PbxColleaguesQueryField)[];
|
|
905
|
+
searchStrategy?: PbxColleaguesSearchStrategy;
|
|
906
|
+
sort?: (PbxColleaguesQueryField)[];
|
|
907
|
+
start?: number;
|
|
908
|
+
count?: number;
|
|
909
|
+
dir?: GetPbxColleaguesDir;
|
|
827
910
|
}
|
|
828
911
|
/**
|
|
829
912
|
* @public
|
|
830
913
|
*/
|
|
831
|
-
export interface
|
|
914
|
+
export interface QueryColleaguesInput {
|
|
832
915
|
/**
|
|
833
|
-
*
|
|
916
|
+
* The unique identifier of the tenant when a service token is used.
|
|
834
917
|
* @public
|
|
835
918
|
*/
|
|
836
|
-
|
|
919
|
+
company?: string;
|
|
920
|
+
query?: QueryColleaguesParameters;
|
|
837
921
|
}
|
|
838
922
|
/**
|
|
839
923
|
* @public
|
|
840
924
|
*/
|
|
841
|
-
export interface
|
|
925
|
+
export interface QueryColleaguesOutputItem {
|
|
842
926
|
/**
|
|
843
|
-
*
|
|
927
|
+
* A user object associated on the cloud for this colleague that is registered on the WMS.
|
|
844
928
|
* @public
|
|
845
929
|
*/
|
|
846
|
-
|
|
930
|
+
user?: User;
|
|
847
931
|
/**
|
|
848
|
-
*
|
|
932
|
+
* A colleague object returned by the PBX.
|
|
849
933
|
* @public
|
|
850
934
|
*/
|
|
851
|
-
|
|
852
|
-
settings: PartialUserSettings;
|
|
935
|
+
colleague: PbxColleague;
|
|
853
936
|
}
|
|
854
937
|
/**
|
|
855
938
|
* @public
|
|
856
939
|
*/
|
|
857
|
-
export interface
|
|
858
|
-
|
|
940
|
+
export interface QueryColleaguesOutput {
|
|
941
|
+
/**
|
|
942
|
+
* A list of users that exist in the platform and matches predicate if specified.
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
colleagues: (QueryColleaguesOutputItem)[];
|
|
859
946
|
}
|
|
860
947
|
/**
|
|
861
948
|
* @public
|