@wildix/xbees-users-client 1.0.28 → 1.0.30

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.
Files changed (34) hide show
  1. package/dist-cjs/Users.js +12 -4
  2. package/dist-cjs/commands/BatchGetUsersEmailNotificationsSettingsCommand.js +21 -0
  3. package/dist-cjs/commands/{GetUserSettingsCommand.js → GetUserEmailNotificationsSettingsCommand.js} +7 -7
  4. package/dist-cjs/commands/ManageTranscriptionEmailNotificationsSubscriptionCommand.js +21 -0
  5. package/dist-cjs/commands/ManageUnreadEmailNotificationsSubscriptionCommand.js +21 -0
  6. package/dist-cjs/commands/PartialUpdateUserEmailNotificationsSettingsCommand.js +21 -0
  7. package/dist-cjs/commands/{PartialUpdateUserSettingsCommand.js → UpdateUserEmailNotificationsSettingsCommand.js} +7 -7
  8. package/dist-cjs/commands/index.js +6 -2
  9. package/dist-cjs/protocols/Aws_restJson1.js +154 -43
  10. package/dist-es/Users.js +12 -4
  11. package/dist-es/commands/BatchGetUsersEmailNotificationsSettingsCommand.js +17 -0
  12. package/dist-es/commands/GetUserEmailNotificationsSettingsCommand.js +17 -0
  13. package/dist-es/commands/ManageTranscriptionEmailNotificationsSubscriptionCommand.js +17 -0
  14. package/dist-es/commands/ManageUnreadEmailNotificationsSubscriptionCommand.js +17 -0
  15. package/dist-es/commands/PartialUpdateUserEmailNotificationsSettingsCommand.js +17 -0
  16. package/dist-es/commands/UpdateUserEmailNotificationsSettingsCommand.js +17 -0
  17. package/dist-es/commands/index.js +6 -2
  18. package/dist-es/protocols/Aws_restJson1.js +136 -33
  19. package/dist-types/Users.d.ts +40 -13
  20. package/dist-types/UsersClient.d.ts +8 -4
  21. package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +71 -0
  22. package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +69 -0
  23. package/dist-types/commands/ManageTranscriptionEmailNotificationsSubscriptionCommand.d.ts +63 -0
  24. package/dist-types/commands/ManageUnreadEmailNotificationsSubscriptionCommand.d.ts +63 -0
  25. package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +69 -0
  26. package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +69 -0
  27. package/dist-types/commands/index.d.ts +6 -2
  28. package/dist-types/models/models_0.d.ts +103 -54
  29. package/dist-types/protocols/Aws_restJson1.d.ts +50 -14
  30. package/package.json +5 -5
  31. package/dist-es/commands/GetUserSettingsCommand.js +0 -17
  32. package/dist-es/commands/PartialUpdateUserSettingsCommand.js +0 -17
  33. package/dist-types/commands/GetUserSettingsCommand.d.ts +0 -69
  34. package/dist-types/commands/PartialUpdateUserSettingsCommand.d.ts +0 -76
@@ -0,0 +1,71 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { BatchGetUsersEmailNotificationsSettingsInput, BatchGetUsersEmailNotificationsSettingsOutput } 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 BatchGetUsersEmailNotificationsSettingsCommand}.
14
+ */
15
+ export interface BatchGetUsersEmailNotificationsSettingsCommandInput extends BatchGetUsersEmailNotificationsSettingsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetUsersEmailNotificationsSettingsCommand}.
21
+ */
22
+ export interface BatchGetUsersEmailNotificationsSettingsCommandOutput extends BatchGetUsersEmailNotificationsSettingsOutput, __MetadataBearer {
23
+ }
24
+ declare const BatchGetUsersEmailNotificationsSettingsCommand_base: {
25
+ new (input: BatchGetUsersEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: BatchGetUsersEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get multiple user settings by their IDs
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, BatchGetUsersEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, BatchGetUsersEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // BatchGetUsersEmailNotificationsSettingsInput
38
+ * usersIds: [ // UsersIdList // required
39
+ * "STRING_VALUE",
40
+ * ],
41
+ * };
42
+ * const command = new BatchGetUsersEmailNotificationsSettingsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // BatchGetUsersEmailNotificationsSettingsOutput
45
+ * // notifications: { // UsersEmailNotificationsSettingsMap // required
46
+ * // "<keys>": { // UserEmailNotificationsSettings
47
+ * // unread: true || false, // required
48
+ * // transcription: true || false, // required
49
+ * // },
50
+ * // },
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param BatchGetUsersEmailNotificationsSettingsCommandInput - {@link BatchGetUsersEmailNotificationsSettingsCommandInput}
56
+ * @returns {@link BatchGetUsersEmailNotificationsSettingsCommandOutput}
57
+ * @see {@link BatchGetUsersEmailNotificationsSettingsCommandInput} for command's `input` shape.
58
+ * @see {@link BatchGetUsersEmailNotificationsSettingsCommandOutput} for command's `response` shape.
59
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
60
+ *
61
+ * @throws {@link ForbiddenException} (client fault)
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ *
65
+ * @throws {@link UsersServiceException}
66
+ * <p>Base exception class for all service exceptions from Users service.</p>
67
+ *
68
+ * @public
69
+ */
70
+ export declare class BatchGetUsersEmailNotificationsSettingsCommand extends BatchGetUsersEmailNotificationsSettingsCommand_base {
71
+ }
@@ -0,0 +1,69 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { GetUserEmailNotificationsSettingsInput, GetUserEmailNotificationsSettingsOutput } 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 GetUserEmailNotificationsSettingsCommand}.
14
+ */
15
+ export interface GetUserEmailNotificationsSettingsCommandInput extends GetUserEmailNotificationsSettingsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetUserEmailNotificationsSettingsCommand}.
21
+ */
22
+ export interface GetUserEmailNotificationsSettingsCommandOutput extends GetUserEmailNotificationsSettingsOutput, __MetadataBearer {
23
+ }
24
+ declare const GetUserEmailNotificationsSettingsCommand_base: {
25
+ new (input: GetUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserEmailNotificationsSettingsCommandInput, GetUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserEmailNotificationsSettingsCommandInput, GetUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Getting user email notifications settings
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, GetUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, GetUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // GetUserEmailNotificationsSettingsInput
38
+ * userId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetUserEmailNotificationsSettingsCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetUserEmailNotificationsSettingsOutput
43
+ * // notifications: { // UserEmailNotificationsSettings
44
+ * // unread: true || false, // required
45
+ * // transcription: true || false, // required
46
+ * // },
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetUserEmailNotificationsSettingsCommandInput - {@link GetUserEmailNotificationsSettingsCommandInput}
52
+ * @returns {@link GetUserEmailNotificationsSettingsCommandOutput}
53
+ * @see {@link GetUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
54
+ * @see {@link GetUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
55
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
56
+ *
57
+ * @throws {@link UserNotFoundException} (client fault)
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ *
63
+ * @throws {@link UsersServiceException}
64
+ * <p>Base exception class for all service exceptions from Users service.</p>
65
+ *
66
+ * @public
67
+ */
68
+ export declare class GetUserEmailNotificationsSettingsCommand extends GetUserEmailNotificationsSettingsCommand_base {
69
+ }
@@ -0,0 +1,63 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ManageTranscriptionEmailNotificationsSubscriptionInput, ManageTranscriptionEmailNotificationsSubscriptionOutput } 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 ManageTranscriptionEmailNotificationsSubscriptionCommand}.
14
+ */
15
+ export interface ManageTranscriptionEmailNotificationsSubscriptionCommandInput extends ManageTranscriptionEmailNotificationsSubscriptionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ManageTranscriptionEmailNotificationsSubscriptionCommand}.
21
+ */
22
+ export interface ManageTranscriptionEmailNotificationsSubscriptionCommandOutput extends ManageTranscriptionEmailNotificationsSubscriptionOutput, __MetadataBearer {
23
+ }
24
+ declare const ManageTranscriptionEmailNotificationsSubscriptionCommand_base: {
25
+ new (input: ManageTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ManageTranscriptionEmailNotificationsSubscriptionCommandInput, ManageTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ManageTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ManageTranscriptionEmailNotificationsSubscriptionCommandInput, ManageTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Using unsubscribeToken from email you can manage 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, ManageTranscriptionEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ManageTranscriptionEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ManageTranscriptionEmailNotificationsSubscriptionInput
38
+ * unsubscribeToken: "STRING_VALUE", // required
39
+ * subscribe: true || false, // required
40
+ * };
41
+ * const command = new ManageTranscriptionEmailNotificationsSubscriptionCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param ManageTranscriptionEmailNotificationsSubscriptionCommandInput - {@link ManageTranscriptionEmailNotificationsSubscriptionCommandInput}
48
+ * @returns {@link ManageTranscriptionEmailNotificationsSubscriptionCommandOutput}
49
+ * @see {@link ManageTranscriptionEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
50
+ * @see {@link ManageTranscriptionEmailNotificationsSubscriptionCommandOutput} 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 UsersServiceException}
58
+ * <p>Base exception class for all service exceptions from Users service.</p>
59
+ *
60
+ * @public
61
+ */
62
+ export declare class ManageTranscriptionEmailNotificationsSubscriptionCommand extends ManageTranscriptionEmailNotificationsSubscriptionCommand_base {
63
+ }
@@ -0,0 +1,63 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ManageUnreadEmailNotificationsSubscriptionInput, ManageUnreadEmailNotificationsSubscriptionOutput } 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 ManageUnreadEmailNotificationsSubscriptionCommand}.
14
+ */
15
+ export interface ManageUnreadEmailNotificationsSubscriptionCommandInput extends ManageUnreadEmailNotificationsSubscriptionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ManageUnreadEmailNotificationsSubscriptionCommand}.
21
+ */
22
+ export interface ManageUnreadEmailNotificationsSubscriptionCommandOutput extends ManageUnreadEmailNotificationsSubscriptionOutput, __MetadataBearer {
23
+ }
24
+ declare const ManageUnreadEmailNotificationsSubscriptionCommand_base: {
25
+ new (input: ManageUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ManageUnreadEmailNotificationsSubscriptionCommandInput, ManageUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ManageUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ManageUnreadEmailNotificationsSubscriptionCommandInput, ManageUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Using unsubscribeToken from email you can manage 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, ManageUnreadEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ManageUnreadEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ManageUnreadEmailNotificationsSubscriptionInput
38
+ * unsubscribeToken: "STRING_VALUE", // required
39
+ * subscribe: true || false, // required
40
+ * };
41
+ * const command = new ManageUnreadEmailNotificationsSubscriptionCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param ManageUnreadEmailNotificationsSubscriptionCommandInput - {@link ManageUnreadEmailNotificationsSubscriptionCommandInput}
48
+ * @returns {@link ManageUnreadEmailNotificationsSubscriptionCommandOutput}
49
+ * @see {@link ManageUnreadEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
50
+ * @see {@link ManageUnreadEmailNotificationsSubscriptionCommandOutput} 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 UsersServiceException}
58
+ * <p>Base exception class for all service exceptions from Users service.</p>
59
+ *
60
+ * @public
61
+ */
62
+ export declare class ManageUnreadEmailNotificationsSubscriptionCommand extends ManageUnreadEmailNotificationsSubscriptionCommand_base {
63
+ }
@@ -0,0 +1,69 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { PartialUpdateUserEmailNotificationsSettingsInput, PartialUpdateUserEmailNotificationsSettingsOutput } 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 PartialUpdateUserEmailNotificationsSettingsCommand}.
14
+ */
15
+ export interface PartialUpdateUserEmailNotificationsSettingsCommandInput extends PartialUpdateUserEmailNotificationsSettingsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PartialUpdateUserEmailNotificationsSettingsCommand}.
21
+ */
22
+ export interface PartialUpdateUserEmailNotificationsSettingsCommandOutput extends PartialUpdateUserEmailNotificationsSettingsOutput, __MetadataBearer {
23
+ }
24
+ declare const PartialUpdateUserEmailNotificationsSettingsCommand_base: {
25
+ new (input: PartialUpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: PartialUpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Partially update user email notifications settings
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, PartialUpdateUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, PartialUpdateUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // PartialUpdateUserEmailNotificationsSettingsInput
38
+ * unread: true || false,
39
+ * transcription: true || false,
40
+ * userId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new PartialUpdateUserEmailNotificationsSettingsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // PartialUpdateUserEmailNotificationsSettingsOutput
45
+ * // notifications: { // UserEmailNotificationsSettings
46
+ * // unread: true || false, // required
47
+ * // transcription: true || false, // required
48
+ * // },
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param PartialUpdateUserEmailNotificationsSettingsCommandInput - {@link PartialUpdateUserEmailNotificationsSettingsCommandInput}
54
+ * @returns {@link PartialUpdateUserEmailNotificationsSettingsCommandOutput}
55
+ * @see {@link PartialUpdateUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
56
+ * @see {@link PartialUpdateUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
57
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ *
63
+ * @throws {@link UsersServiceException}
64
+ * <p>Base exception class for all service exceptions from Users service.</p>
65
+ *
66
+ * @public
67
+ */
68
+ export declare class PartialUpdateUserEmailNotificationsSettingsCommand extends PartialUpdateUserEmailNotificationsSettingsCommand_base {
69
+ }
@@ -0,0 +1,69 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { UpdateUserEmailNotificationsSettingsInput, UpdateUserEmailNotificationsSettingsOutput } 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 UpdateUserEmailNotificationsSettingsCommand}.
14
+ */
15
+ export interface UpdateUserEmailNotificationsSettingsCommandInput extends UpdateUserEmailNotificationsSettingsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateUserEmailNotificationsSettingsCommand}.
21
+ */
22
+ export interface UpdateUserEmailNotificationsSettingsCommandOutput extends UpdateUserEmailNotificationsSettingsOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateUserEmailNotificationsSettingsCommand_base: {
25
+ new (input: UpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserEmailNotificationsSettingsCommandInput, UpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserEmailNotificationsSettingsCommandInput, UpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Update user email notifications settings
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, UpdateUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, UpdateUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // UpdateUserEmailNotificationsSettingsInput
38
+ * unread: true || false,
39
+ * transcription: true || false,
40
+ * userId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new UpdateUserEmailNotificationsSettingsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // UpdateUserEmailNotificationsSettingsOutput
45
+ * // notifications: { // UserEmailNotificationsSettings
46
+ * // unread: true || false, // required
47
+ * // transcription: true || false, // required
48
+ * // },
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param UpdateUserEmailNotificationsSettingsCommandInput - {@link UpdateUserEmailNotificationsSettingsCommandInput}
54
+ * @returns {@link UpdateUserEmailNotificationsSettingsCommandOutput}
55
+ * @see {@link UpdateUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
56
+ * @see {@link UpdateUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
57
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ *
63
+ * @throws {@link UsersServiceException}
64
+ * <p>Base exception class for all service exceptions from Users service.</p>
65
+ *
66
+ * @public
67
+ */
68
+ export declare class UpdateUserEmailNotificationsSettingsCommand extends UpdateUserEmailNotificationsSettingsCommand_base {
69
+ }
@@ -1,4 +1,5 @@
1
1
  export * from "./BatchGetUsersCommand";
2
+ export * from "./BatchGetUsersEmailNotificationsSettingsCommand";
2
3
  export * from "./BatchGetUsersPbxLinkDataCommand";
3
4
  export * from "./BatchGetUsersPbxLinkDataV1Command";
4
5
  export * from "./ChangeUserEmailCommand";
@@ -10,18 +11,21 @@ export * from "./DeleteBotApiKeyCommand";
10
11
  export * from "./GetBotCommand";
11
12
  export * from "./GetBotCallbackCommand";
12
13
  export * from "./GetUserCommand";
14
+ export * from "./GetUserEmailNotificationsSettingsCommand";
13
15
  export * from "./GetUserPbxLinkDataCommand";
14
16
  export * from "./GetUserPbxLinkSuggestionCommand";
15
17
  export * from "./GetUserPbxLinkSuggestionV1Command";
16
- export * from "./GetUserSettingsCommand";
17
18
  export * from "./ListBotApiKeysCommand";
18
19
  export * from "./ListBotsCommand";
19
- export * from "./PartialUpdateUserSettingsCommand";
20
+ export * from "./ManageTranscriptionEmailNotificationsSubscriptionCommand";
21
+ export * from "./ManageUnreadEmailNotificationsSubscriptionCommand";
22
+ export * from "./PartialUpdateUserEmailNotificationsSettingsCommand";
20
23
  export * from "./QueryColleaguesCommand";
21
24
  export * from "./QueryUserCommand";
22
25
  export * from "./QueryUsersCommand";
23
26
  export * from "./UpdateBotCommand";
24
27
  export * from "./UpdateBotCallbackCommand";
28
+ export * from "./UpdateUserEmailNotificationsSettingsCommand";
25
29
  export * from "./UploadPictureCommand";
26
30
  export * from "./UploadPictureV1Command";
27
31
  export * from "./VerifyBotSecretKeyCommand";
@@ -214,6 +214,37 @@ export interface BatchGetUsersOutput {
214
214
  */
215
215
  users: (User)[];
216
216
  }
217
+ /**
218
+ * @public
219
+ */
220
+ export interface BatchGetUsersEmailNotificationsSettingsInput {
221
+ /**
222
+ * List of the unique identifier of the user
223
+ * @public
224
+ */
225
+ usersIds: (string)[];
226
+ }
227
+ /**
228
+ * @public
229
+ */
230
+ export interface UserEmailNotificationsSettings {
231
+ /**
232
+ * A flag that indicates whether the system should send email notifications about unread messages.
233
+ * @public
234
+ */
235
+ unread: boolean;
236
+ /**
237
+ * A flag that indicates whether the system should send email notifications about AI transcription.
238
+ * @public
239
+ */
240
+ transcription: boolean;
241
+ }
242
+ /**
243
+ * @public
244
+ */
245
+ export interface BatchGetUsersEmailNotificationsSettingsOutput {
246
+ notifications: Record<string, UserEmailNotificationsSettings>;
247
+ }
217
248
  /**
218
249
  * @public
219
250
  */
@@ -751,21 +782,6 @@ export interface DeleteBotApiKeyInput {
751
782
  */
752
783
  export interface DeleteBotApiKeyOutput {
753
784
  }
754
- /**
755
- * @public
756
- */
757
- export interface EmailNotificationsSettings {
758
- /**
759
- * Indicates whether the user wants to receive email notifications about unread messages.
760
- * @public
761
- */
762
- unread: boolean;
763
- /**
764
- * Indicates whether the user wants to receive email notifications about AI transcription.
765
- * @public
766
- */
767
- transcription: boolean;
768
- }
769
785
  /**
770
786
  * @public
771
787
  */
@@ -808,6 +824,22 @@ export interface GetUserInput {
808
824
  export interface GetUserOutput {
809
825
  user: User;
810
826
  }
827
+ /**
828
+ * @public
829
+ */
830
+ export interface GetUserEmailNotificationsSettingsInput {
831
+ /**
832
+ * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
833
+ * @public
834
+ */
835
+ userId: string;
836
+ }
837
+ /**
838
+ * @public
839
+ */
840
+ export interface GetUserEmailNotificationsSettingsOutput {
841
+ notifications: UserEmailNotificationsSettings;
842
+ }
811
843
  /**
812
844
  * @public
813
845
  */
@@ -879,26 +911,6 @@ export interface GetUserPbxLinkSuggestionV1Output {
879
911
  */
880
912
  suggestion?: UserPbxLinkSuggestion;
881
913
  }
882
- /**
883
- * @public
884
- */
885
- export interface GetUserSettingsInput {
886
- /**
887
- * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
888
- * @public
889
- */
890
- userId?: string;
891
- }
892
- /**
893
- * @public
894
- */
895
- export interface GetUserSettingsOutput {
896
- /**
897
- * Indicates whether the user wants to receive email notifications.
898
- * @public
899
- */
900
- emailNotifications?: EmailNotificationsSettings;
901
- }
902
914
  /**
903
915
  * @public
904
916
  */
@@ -927,49 +939,60 @@ export interface ListBotsOutput {
927
939
  /**
928
940
  * @public
929
941
  */
930
- export interface PartialEmailNotificationsSettings {
931
- /**
932
- * Indicates whether the user wants to receive email notifications about unread messages.
933
- * @public
934
- */
935
- unread?: boolean;
942
+ export interface ManageTranscriptionEmailNotificationsSubscriptionInput {
943
+ unsubscribeToken: string;
936
944
  /**
937
- * Indicates whether the user wants to receive email notifications about AI transcription.
945
+ * A flag that indicates whether the system should send email notifications about AI transcription.
938
946
  * @public
939
947
  */
940
- transcription?: boolean;
948
+ subscribe: boolean;
941
949
  }
942
950
  /**
943
951
  * @public
944
952
  */
945
- export interface PartialUserSettings {
953
+ export interface ManageTranscriptionEmailNotificationsSubscriptionOutput {
954
+ }
955
+ /**
956
+ * @public
957
+ */
958
+ export interface ManageUnreadEmailNotificationsSubscriptionInput {
959
+ unsubscribeToken: string;
946
960
  /**
947
- * Indicates whether the user wants to receive email notifications.
961
+ * A flag that indicates whether the system should send email notifications about unread messages.
948
962
  * @public
949
963
  */
950
- emailNotifications?: PartialEmailNotificationsSettings;
964
+ subscribe: boolean;
951
965
  }
952
966
  /**
953
967
  * @public
954
968
  */
955
- export interface PartialUpdateUserSettingsInput {
969
+ export interface ManageUnreadEmailNotificationsSubscriptionOutput {
970
+ }
971
+ /**
972
+ * @public
973
+ */
974
+ export interface PartialUpdateUserEmailNotificationsSettingsInput {
956
975
  /**
957
- * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
976
+ * A flag that indicates whether the system should send email notifications about unread messages.
977
+ * @public
978
+ */
979
+ unread?: boolean;
980
+ /**
981
+ * A flag that indicates whether the system should send email notifications about AI transcription.
958
982
  * @public
959
983
  */
960
- userId?: string;
984
+ transcription?: boolean;
961
985
  /**
962
- * Email unsubscribe token.
986
+ * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
963
987
  * @public
964
988
  */
965
- token?: string;
966
- settings: PartialUserSettings;
989
+ userId: string;
967
990
  }
968
991
  /**
969
992
  * @public
970
993
  */
971
- export interface PartialUpdateUserSettingsOutput {
972
- emailNotifications?: EmailNotificationsSettings;
994
+ export interface PartialUpdateUserEmailNotificationsSettingsOutput {
995
+ notifications: UserEmailNotificationsSettings;
973
996
  }
974
997
  /**
975
998
  * @public
@@ -1166,6 +1189,32 @@ export interface UpdateBotCallbackInput {
1166
1189
  export interface UpdateBotCallbackOutput {
1167
1190
  callback: BotCallback;
1168
1191
  }
1192
+ /**
1193
+ * @public
1194
+ */
1195
+ export interface UpdateUserEmailNotificationsSettingsInput {
1196
+ /**
1197
+ * A flag that indicates whether the system should send email notifications about unread messages.
1198
+ * @public
1199
+ */
1200
+ unread?: boolean;
1201
+ /**
1202
+ * A flag that indicates whether the system should send email notifications about AI transcription.
1203
+ * @public
1204
+ */
1205
+ transcription?: boolean;
1206
+ /**
1207
+ * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
1208
+ * @public
1209
+ */
1210
+ userId: string;
1211
+ }
1212
+ /**
1213
+ * @public
1214
+ */
1215
+ export interface UpdateUserEmailNotificationsSettingsOutput {
1216
+ notifications: UserEmailNotificationsSettings;
1217
+ }
1169
1218
  /**
1170
1219
  * @public
1171
1220
  */