@wildix/xbees-users-client 1.2.3 → 1.2.4
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-types/commands/AddIdentityCommand.d.ts +93 -0
- package/dist-types/commands/BatchGetUsersCommand.d.ts +110 -0
- package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +95 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +146 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +146 -0
- package/dist-types/commands/ChangeUserEmailCommand.d.ts +100 -0
- package/dist-types/commands/CreateBotApiKeyCommand.d.ts +108 -0
- package/dist-types/commands/CreateBotCommand.d.ts +210 -0
- package/dist-types/commands/CreateSystemBotCommand.d.ts +90 -0
- package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +92 -0
- package/dist-types/commands/DeleteBotCommand.d.ts +89 -0
- package/dist-types/commands/GetAccountCommand.d.ts +182 -0
- package/dist-types/commands/GetAppVersionCommand.d.ts +88 -0
- package/dist-types/commands/GetBotCallbackCommand.d.ts +196 -0
- package/dist-types/commands/GetBotCommand.d.ts +102 -0
- package/dist-types/commands/GetUserCommand.d.ts +108 -0
- package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +144 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +91 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +91 -0
- package/dist-types/commands/IntelligenceSearchCommand.d.ts +97 -0
- package/dist-types/commands/InviteCommand.d.ts +116 -0
- package/dist-types/commands/ListAccountIdentitiesCommand.d.ts +94 -0
- package/dist-types/commands/ListBotApiKeysCommand.d.ts +95 -0
- package/dist-types/commands/ListBotsCommand.d.ts +101 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +170 -0
- package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/QueryColleaguesCommand.d.ts +164 -0
- package/dist-types/commands/QueryUserCommand.d.ts +117 -0
- package/dist-types/commands/QueryUsersCommand.d.ts +117 -0
- package/dist-types/commands/RemoveIdentityCommand.d.ts +87 -0
- package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +87 -0
- package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +87 -0
- package/dist-types/commands/UnbindWorkspaceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateAccountCommand.d.ts +94 -0
- package/dist-types/commands/UpdateBotCallbackCommand.d.ts +300 -0
- package/dist-types/commands/UpdateBotCommand.d.ts +105 -0
- package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +171 -0
- package/dist-types/commands/UploadPictureCommand.d.ts +88 -0
- package/dist-types/commands/UploadPictureV1Command.d.ts +90 -0
- package/dist-types/commands/VerifyAddIdentityCommand.d.ts +95 -0
- package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +92 -0
- package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +92 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,164 @@
|
|
|
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
|
+
* Searches for colleagues using various filters and search criteria, with optional auto-invitation for new users.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, QueryColleaguesCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, QueryColleaguesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // QueryColleaguesInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* query: { // QueryColleaguesParameters
|
|
40
|
+
* id: [ // ColleaguesFilterList
|
|
41
|
+
* "STRING_VALUE",
|
|
42
|
+
* ],
|
|
43
|
+
* extension: [
|
|
44
|
+
* "STRING_VALUE",
|
|
45
|
+
* ],
|
|
46
|
+
* officePhone: [
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* mobilePhone: [
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* name: [
|
|
53
|
+
* "STRING_VALUE",
|
|
54
|
+
* ],
|
|
55
|
+
* email: "<ColleaguesFilterList>",
|
|
56
|
+
* department: "<ColleaguesFilterList>",
|
|
57
|
+
* search: "STRING_VALUE",
|
|
58
|
+
* searchFields: [ // PbxColleaguesQueryFieldList
|
|
59
|
+
* "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
|
|
60
|
+
* ],
|
|
61
|
+
* searchStrategy: "contain" || "startsWith",
|
|
62
|
+
* sort: [
|
|
63
|
+
* "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
|
|
64
|
+
* ],
|
|
65
|
+
* start: Number("int"),
|
|
66
|
+
* count: Number("int"),
|
|
67
|
+
* dir: "asc" || "desc",
|
|
68
|
+
* },
|
|
69
|
+
* invite: true || false,
|
|
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
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
92
|
+
* // createdAt: "STRING_VALUE",
|
|
93
|
+
* // updatedAt: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // colleague: { // PbxColleague
|
|
96
|
+
* // id: "STRING_VALUE", // required
|
|
97
|
+
* // name: "STRING_VALUE",
|
|
98
|
+
* // login: "STRING_VALUE",
|
|
99
|
+
* // extension: "STRING_VALUE", // required
|
|
100
|
+
* // officePhone: "STRING_VALUE",
|
|
101
|
+
* // mobilePhone: "STRING_VALUE",
|
|
102
|
+
* // faxNumber: "STRING_VALUE",
|
|
103
|
+
* // email: "STRING_VALUE",
|
|
104
|
+
* // pbxDn: "STRING_VALUE", // required
|
|
105
|
+
* // pbx: "STRING_VALUE", // required
|
|
106
|
+
* // role: "admin" || "user" || "fax" || "park_orbit" || "room", // required
|
|
107
|
+
* // groupName: "STRING_VALUE", // required
|
|
108
|
+
* // groupDn: "STRING_VALUE", // required
|
|
109
|
+
* // language: "STRING_VALUE", // required
|
|
110
|
+
* // dialplan: "STRING_VALUE", // required
|
|
111
|
+
* // faxDialplan: "STRING_VALUE", // required
|
|
112
|
+
* // department: "STRING_VALUE",
|
|
113
|
+
* // picture: "STRING_VALUE", // required
|
|
114
|
+
* // sourceId: "STRING_VALUE",
|
|
115
|
+
* // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
|
|
116
|
+
* // jid: "STRING_VALUE", // required
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // ],
|
|
120
|
+
* // };
|
|
121
|
+
*
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @param QueryColleaguesCommandInput - {@link QueryColleaguesCommandInput}
|
|
125
|
+
* @returns {@link QueryColleaguesCommandOutput}
|
|
126
|
+
* @see {@link QueryColleaguesCommandInput} for command's `input` shape.
|
|
127
|
+
* @see {@link QueryColleaguesCommandOutput} for command's `response` shape.
|
|
128
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link ValidationException} (client fault)
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link UsersServiceException}
|
|
147
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
148
|
+
*
|
|
149
|
+
*
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export declare class QueryColleaguesCommand extends QueryColleaguesCommand_base {
|
|
153
|
+
/** @internal type navigation helper, not in runtime. */
|
|
154
|
+
protected static __types: {
|
|
155
|
+
api: {
|
|
156
|
+
input: QueryColleaguesInput;
|
|
157
|
+
output: QueryColleaguesOutput;
|
|
158
|
+
};
|
|
159
|
+
sdk: {
|
|
160
|
+
input: QueryColleaguesCommandInput;
|
|
161
|
+
output: QueryColleaguesCommandOutput;
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { QueryUserInput, QueryUserOutput } 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 QueryUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface QueryUserCommandInput extends QueryUserInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link QueryUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface QueryUserCommandOutput extends QueryUserOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const QueryUserCommand_base: {
|
|
25
|
+
new (input: QueryUserCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUserCommandInput, QueryUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: QueryUserCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUserCommandInput, QueryUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Searches for a single user using a query with optional predicate validation.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, QueryUserCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, QueryUserCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // QueryUserInput
|
|
38
|
+
* query: { // UserQuery Union: only one key present
|
|
39
|
+
* id: "STRING_VALUE",
|
|
40
|
+
* email: "STRING_VALUE",
|
|
41
|
+
* phone: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* predicate: { // UserQueryPredicate
|
|
44
|
+
* license: "basic" || "essential" || "business" || "premium" || "wizyconf",
|
|
45
|
+
* },
|
|
46
|
+
* };
|
|
47
|
+
* const command = new QueryUserCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // QueryUserOutput
|
|
50
|
+
* // user: { // User
|
|
51
|
+
* // id: "STRING_VALUE", // required
|
|
52
|
+
* // name: "STRING_VALUE",
|
|
53
|
+
* // email: "STRING_VALUE",
|
|
54
|
+
* // phone: "STRING_VALUE",
|
|
55
|
+
* // picture: "STRING_VALUE",
|
|
56
|
+
* // locale: "STRING_VALUE",
|
|
57
|
+
* // timeZone: "STRING_VALUE",
|
|
58
|
+
* // company: "STRING_VALUE",
|
|
59
|
+
* // bot: true || false,
|
|
60
|
+
* // pbxDomain: "STRING_VALUE",
|
|
61
|
+
* // pbxPort: "STRING_VALUE",
|
|
62
|
+
* // pbxExtension: "STRING_VALUE",
|
|
63
|
+
* // pbxSerial: "STRING_VALUE",
|
|
64
|
+
* // pbxUserId: "STRING_VALUE",
|
|
65
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
66
|
+
* // createdAt: "STRING_VALUE",
|
|
67
|
+
* // updatedAt: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param QueryUserCommandInput - {@link QueryUserCommandInput}
|
|
74
|
+
* @returns {@link QueryUserCommandOutput}
|
|
75
|
+
* @see {@link QueryUserCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link QueryUserCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link UserQueryPredicateNotMetException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link UsersServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class QueryUserCommand extends QueryUserCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: QueryUserInput;
|
|
110
|
+
output: QueryUserOutput;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: QueryUserCommandInput;
|
|
114
|
+
output: QueryUserCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { QueryUsersInput, QueryUsersOutput } 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 QueryUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface QueryUsersCommandInput extends QueryUsersInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link QueryUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface QueryUsersCommandOutput extends QueryUsersOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const QueryUsersCommand_base: {
|
|
25
|
+
new (input: QueryUsersCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: QueryUsersCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Searches for multiple users using queries with optional predicate validation.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, QueryUsersCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, QueryUsersCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // QueryUsersInput
|
|
38
|
+
* queries: [ // UsersQueryList // required
|
|
39
|
+
* { // UserQuery Union: only one key present
|
|
40
|
+
* id: "STRING_VALUE",
|
|
41
|
+
* email: "STRING_VALUE",
|
|
42
|
+
* phone: "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* ],
|
|
45
|
+
* predicate: { // UserQueryPredicate
|
|
46
|
+
* license: "basic" || "essential" || "business" || "premium" || "wizyconf",
|
|
47
|
+
* },
|
|
48
|
+
* };
|
|
49
|
+
* const command = new QueryUsersCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // QueryUsersOutput
|
|
52
|
+
* // users: [ // UsersList // required
|
|
53
|
+
* // { // User
|
|
54
|
+
* // id: "STRING_VALUE", // required
|
|
55
|
+
* // name: "STRING_VALUE",
|
|
56
|
+
* // email: "STRING_VALUE",
|
|
57
|
+
* // phone: "STRING_VALUE",
|
|
58
|
+
* // picture: "STRING_VALUE",
|
|
59
|
+
* // locale: "STRING_VALUE",
|
|
60
|
+
* // timeZone: "STRING_VALUE",
|
|
61
|
+
* // company: "STRING_VALUE",
|
|
62
|
+
* // bot: true || false,
|
|
63
|
+
* // pbxDomain: "STRING_VALUE",
|
|
64
|
+
* // pbxPort: "STRING_VALUE",
|
|
65
|
+
* // pbxExtension: "STRING_VALUE",
|
|
66
|
+
* // pbxSerial: "STRING_VALUE",
|
|
67
|
+
* // pbxUserId: "STRING_VALUE",
|
|
68
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
69
|
+
* // createdAt: "STRING_VALUE",
|
|
70
|
+
* // updatedAt: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param QueryUsersCommandInput - {@link QueryUsersCommandInput}
|
|
78
|
+
* @returns {@link QueryUsersCommandOutput}
|
|
79
|
+
* @see {@link QueryUsersCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link QueryUsersCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link UsersServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class QueryUsersCommand extends QueryUsersCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: QueryUsersInput;
|
|
110
|
+
output: QueryUsersOutput;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: QueryUsersCommandInput;
|
|
114
|
+
output: QueryUsersCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { RemoveIdentityInput, RemoveIdentityOutput } 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 RemoveIdentityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RemoveIdentityCommandInput extends RemoveIdentityInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RemoveIdentityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RemoveIdentityCommandOutput extends RemoveIdentityOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RemoveIdentityCommand_base: {
|
|
25
|
+
new (input: RemoveIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveIdentityCommandInput, RemoveIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: RemoveIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveIdentityCommandInput, RemoveIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes a non-primary identity from the account. Requires step-up verification for the primary identity.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, RemoveIdentityCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, RemoveIdentityCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // RemoveIdentityInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* identity: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new RemoveIdentityCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param RemoveIdentityCommandInput - {@link RemoveIdentityCommandInput}
|
|
48
|
+
* @returns {@link RemoveIdentityCommandOutput}
|
|
49
|
+
* @see {@link RemoveIdentityCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link RemoveIdentityCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link UsersServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class RemoveIdentityCommand extends RemoveIdentityCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: RemoveIdentityInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: RemoveIdentityCommandInput;
|
|
84
|
+
output: RemoveIdentityCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { ToggleTranscriptionEmailNotificationsSubscriptionInput, ToggleTranscriptionEmailNotificationsSubscriptionOutput } 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 ToggleTranscriptionEmailNotificationsSubscriptionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ToggleTranscriptionEmailNotificationsSubscriptionCommandInput extends ToggleTranscriptionEmailNotificationsSubscriptionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ToggleTranscriptionEmailNotificationsSubscriptionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput extends ToggleTranscriptionEmailNotificationsSubscriptionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ToggleTranscriptionEmailNotificationsSubscriptionCommand_base: {
|
|
25
|
+
new (input: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Using unsubscribeToken from email you can Toggle transcription email notifications subscription
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, ToggleTranscriptionEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, ToggleTranscriptionEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // ToggleTranscriptionEmailNotificationsSubscriptionInput
|
|
38
|
+
* unsubscribeToken: "STRING_VALUE", // required
|
|
39
|
+
* subscribe: true || false, // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ToggleTranscriptionEmailNotificationsSubscriptionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param ToggleTranscriptionEmailNotificationsSubscriptionCommandInput - {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandInput}
|
|
48
|
+
* @returns {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput}
|
|
49
|
+
* @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ValidationException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link UsersServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class ToggleTranscriptionEmailNotificationsSubscriptionCommand extends ToggleTranscriptionEmailNotificationsSubscriptionCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: ToggleTranscriptionEmailNotificationsSubscriptionInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput;
|
|
84
|
+
output: ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { ToggleUnreadEmailNotificationsSubscriptionInput, ToggleUnreadEmailNotificationsSubscriptionOutput } 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 ToggleUnreadEmailNotificationsSubscriptionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ToggleUnreadEmailNotificationsSubscriptionCommandInput extends ToggleUnreadEmailNotificationsSubscriptionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ToggleUnreadEmailNotificationsSubscriptionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ToggleUnreadEmailNotificationsSubscriptionCommandOutput extends ToggleUnreadEmailNotificationsSubscriptionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ToggleUnreadEmailNotificationsSubscriptionCommand_base: {
|
|
25
|
+
new (input: ToggleUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ToggleUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Using unsubscribeToken from email you can Toggle unread messages email notifications subscription
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, ToggleUnreadEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, ToggleUnreadEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // ToggleUnreadEmailNotificationsSubscriptionInput
|
|
38
|
+
* unsubscribeToken: "STRING_VALUE", // required
|
|
39
|
+
* subscribe: true || false, // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ToggleUnreadEmailNotificationsSubscriptionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param ToggleUnreadEmailNotificationsSubscriptionCommandInput - {@link ToggleUnreadEmailNotificationsSubscriptionCommandInput}
|
|
48
|
+
* @returns {@link ToggleUnreadEmailNotificationsSubscriptionCommandOutput}
|
|
49
|
+
* @see {@link ToggleUnreadEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link ToggleUnreadEmailNotificationsSubscriptionCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ValidationException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link UsersServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class ToggleUnreadEmailNotificationsSubscriptionCommand extends ToggleUnreadEmailNotificationsSubscriptionCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: ToggleUnreadEmailNotificationsSubscriptionInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: ToggleUnreadEmailNotificationsSubscriptionCommandInput;
|
|
84
|
+
output: ToggleUnreadEmailNotificationsSubscriptionCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|