@aws-sdk/client-connect 3.989.0 → 3.990.0
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/README.md +56 -0
- package/dist-cjs/index.js +149 -0
- package/dist-cjs/schemas/schemas_0.js +222 -36
- package/dist-es/Connect.js +16 -0
- package/dist-es/commands/CreateNotificationCommand.js +16 -0
- package/dist-es/commands/DeleteNotificationCommand.js +16 -0
- package/dist-es/commands/DescribeNotificationCommand.js +16 -0
- package/dist-es/commands/ListNotificationsCommand.js +16 -0
- package/dist-es/commands/ListUserNotificationsCommand.js +16 -0
- package/dist-es/commands/SearchNotificationsCommand.js +16 -0
- package/dist-es/commands/UpdateNotificationContentCommand.js +16 -0
- package/dist-es/commands/UpdateUserNotificationStatusCommand.js +16 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/enums.js +32 -0
- package/dist-es/schemas/schemas_0.js +194 -9
- package/dist-types/Connect.d.ts +56 -0
- package/dist-types/ConnectClient.d.ts +10 -2
- package/dist-types/commands/CreateNotificationCommand.d.ts +109 -0
- package/dist-types/commands/DeleteNotificationCommand.d.ts +91 -0
- package/dist-types/commands/DescribeNotificationCommand.d.ts +110 -0
- package/dist-types/commands/GetTrafficDistributionCommand.d.ts +2 -1
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ImportWorkspaceMediaCommand.d.ts +1 -1
- package/dist-types/commands/ListNotificationsCommand.d.ts +114 -0
- package/dist-types/commands/ListUserNotificationsCommand.d.ts +110 -0
- package/dist-types/commands/SearchNotificationsCommand.d.ts +165 -0
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +1 -2
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/commands/SearchViewsCommand.d.ts +1 -2
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateNotificationContentCommand.d.ts +94 -0
- package/dist-types/commands/UpdateUserNotificationStatusCommand.d.ts +95 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/enums.d.ts +72 -0
- package/dist-types/models/models_0.d.ts +64 -48
- package/dist-types/models/models_1.d.ts +151 -140
- package/dist-types/models/models_2.d.ts +402 -469
- package/dist-types/models/models_3.d.ts +545 -4
- package/dist-types/schemas/schemas_0.d.ts +29 -0
- package/dist-types/ts3.4/Connect.d.ts +136 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetTrafficDistributionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ImportWorkspaceMediaCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNotificationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListUserNotificationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchNotificationsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/SearchViewsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateNotificationContentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserNotificationStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/enums.d.ts +41 -0
- package/dist-types/ts3.4/models/models_0.d.ts +16 -11
- package/dist-types/ts3.4/models/models_1.d.ts +40 -34
- package/dist-types/ts3.4/models/models_2.d.ts +90 -98
- package/dist-types/ts3.4/models/models_3.d.ts +126 -7
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +29 -0
- package/package.json +6 -6
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { ListNotificationsRequest, ListNotificationsResponse } from "../models/models_2";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListNotificationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListNotificationsCommandInput extends ListNotificationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListNotificationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListNotificationsCommandOutput extends ListNotificationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListNotificationsCommand_base: {
|
|
25
|
+
new (input: ListNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListNotificationsCommandInput, ListNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListNotificationsCommandInput, ListNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of all notifications in the Amazon Connect instance.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectClient, ListNotificationsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
35
|
+
* // const { ConnectClient, ListNotificationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
36
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
37
|
+
* const config = {}; // type is ConnectClientConfig
|
|
38
|
+
* const client = new ConnectClient(config);
|
|
39
|
+
* const input = { // ListNotificationsRequest
|
|
40
|
+
* InstanceId: "STRING_VALUE", // required
|
|
41
|
+
* NextToken: "STRING_VALUE",
|
|
42
|
+
* MaxResults: Number("int"),
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListNotificationsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListNotificationsResponse
|
|
47
|
+
* // NextToken: "STRING_VALUE",
|
|
48
|
+
* // NotificationSummaryList: [ // NotificationSummaryList // required
|
|
49
|
+
* // { // Notification
|
|
50
|
+
* // Content: { // NotificationContent
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // Id: "STRING_VALUE", // required
|
|
54
|
+
* // Arn: "STRING_VALUE", // required
|
|
55
|
+
* // Priority: "URGENT" || "HIGH" || "LOW",
|
|
56
|
+
* // Recipients: [ // RecipientList
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // LastModifiedTime: new Date("TIMESTAMP"), // required
|
|
60
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
61
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
62
|
+
* // LastModifiedRegion: "STRING_VALUE",
|
|
63
|
+
* // Tags: { // TagMap
|
|
64
|
+
* // "<keys>": "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param ListNotificationsCommandInput - {@link ListNotificationsCommandInput}
|
|
73
|
+
* @returns {@link ListNotificationsCommandOutput}
|
|
74
|
+
* @see {@link ListNotificationsCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link ListNotificationsCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
82
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
85
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
88
|
+
* <p>The request is not valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>The specified resource was not found.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
94
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ConnectServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
98
|
+
*
|
|
99
|
+
*
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export declare class ListNotificationsCommand extends ListNotificationsCommand_base {
|
|
103
|
+
/** @internal type navigation helper, not in runtime. */
|
|
104
|
+
protected static __types: {
|
|
105
|
+
api: {
|
|
106
|
+
input: ListNotificationsRequest;
|
|
107
|
+
output: ListNotificationsResponse;
|
|
108
|
+
};
|
|
109
|
+
sdk: {
|
|
110
|
+
input: ListNotificationsCommandInput;
|
|
111
|
+
output: ListNotificationsCommandOutput;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { ListUserNotificationsRequest, ListUserNotificationsResponse } from "../models/models_2";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListUserNotificationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListUserNotificationsCommandInput extends ListUserNotificationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListUserNotificationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListUserNotificationsCommandOutput extends ListUserNotificationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListUserNotificationsCommand_base: {
|
|
25
|
+
new (input: ListUserNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListUserNotificationsCommandInput, ListUserNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListUserNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListUserNotificationsCommandInput, ListUserNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of notifications for a specific user, including the notification status for that user.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectClient, ListUserNotificationsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
35
|
+
* // const { ConnectClient, ListUserNotificationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
36
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
37
|
+
* const config = {}; // type is ConnectClientConfig
|
|
38
|
+
* const client = new ConnectClient(config);
|
|
39
|
+
* const input = { // ListUserNotificationsRequest
|
|
40
|
+
* InstanceId: "STRING_VALUE", // required
|
|
41
|
+
* NextToken: "STRING_VALUE",
|
|
42
|
+
* MaxResults: Number("int"),
|
|
43
|
+
* UserId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListUserNotificationsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListUserNotificationsResponse
|
|
48
|
+
* // UserNotifications: [ // UserNotificationSummaryList
|
|
49
|
+
* // { // UserNotificationSummary
|
|
50
|
+
* // NotificationId: "STRING_VALUE",
|
|
51
|
+
* // NotificationStatus: "READ" || "UNREAD" || "HIDDEN",
|
|
52
|
+
* // InstanceId: "STRING_VALUE",
|
|
53
|
+
* // RecipientId: "STRING_VALUE",
|
|
54
|
+
* // Content: { // NotificationContent
|
|
55
|
+
* // "<keys>": "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // Priority: "URGENT" || "HIGH" || "LOW",
|
|
58
|
+
* // Source: "CUSTOMER" || "RULES" || "SYSTEM",
|
|
59
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
60
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // NextToken: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param ListUserNotificationsCommandInput - {@link ListUserNotificationsCommandInput}
|
|
69
|
+
* @returns {@link ListUserNotificationsCommandOutput}
|
|
70
|
+
* @see {@link ListUserNotificationsCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link ListUserNotificationsCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
78
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
81
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
84
|
+
* <p>The request is not valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The specified resource was not found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ConnectServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class ListUserNotificationsCommand extends ListUserNotificationsCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: ListUserNotificationsRequest;
|
|
103
|
+
output: ListUserNotificationsResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: ListUserNotificationsCommandInput;
|
|
107
|
+
output: ListUserNotificationsCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { SearchNotificationsResponse } from "../models/models_2";
|
|
5
|
+
import type { SearchNotificationsRequest } from "../models/models_3";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link SearchNotificationsCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface SearchNotificationsCommandInput extends SearchNotificationsRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link SearchNotificationsCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface SearchNotificationsCommandOutput extends SearchNotificationsResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const SearchNotificationsCommand_base: {
|
|
26
|
+
new (input: SearchNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchNotificationsCommandInput, SearchNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: SearchNotificationsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchNotificationsCommandInput, SearchNotificationsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { ConnectClient, SearchNotificationsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
36
|
+
* // const { ConnectClient, SearchNotificationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
37
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
38
|
+
* const config = {}; // type is ConnectClientConfig
|
|
39
|
+
* const client = new ConnectClient(config);
|
|
40
|
+
* const input = { // SearchNotificationsRequest
|
|
41
|
+
* InstanceId: "STRING_VALUE", // required
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* MaxResults: Number("int"),
|
|
44
|
+
* SearchFilter: { // NotificationSearchFilter
|
|
45
|
+
* AttributeFilter: { // ControlPlaneAttributeFilter
|
|
46
|
+
* OrConditions: [ // CommonAttributeOrConditionList
|
|
47
|
+
* { // CommonAttributeAndCondition
|
|
48
|
+
* TagConditions: [ // TagAndConditionList
|
|
49
|
+
* { // TagCondition
|
|
50
|
+
* TagKey: "STRING_VALUE",
|
|
51
|
+
* TagValue: "STRING_VALUE",
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* },
|
|
55
|
+
* ],
|
|
56
|
+
* AndCondition: {
|
|
57
|
+
* TagConditions: [
|
|
58
|
+
* {
|
|
59
|
+
* TagKey: "STRING_VALUE",
|
|
60
|
+
* TagValue: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
63
|
+
* },
|
|
64
|
+
* TagCondition: "<TagCondition>",
|
|
65
|
+
* },
|
|
66
|
+
* },
|
|
67
|
+
* SearchCriteria: { // NotificationSearchCriteria
|
|
68
|
+
* OrConditions: [ // NotificationSearchConditionList
|
|
69
|
+
* {
|
|
70
|
+
* OrConditions: [
|
|
71
|
+
* "<NotificationSearchCriteria>",
|
|
72
|
+
* ],
|
|
73
|
+
* AndConditions: [
|
|
74
|
+
* "<NotificationSearchCriteria>",
|
|
75
|
+
* ],
|
|
76
|
+
* StringCondition: { // StringCondition
|
|
77
|
+
* FieldName: "STRING_VALUE",
|
|
78
|
+
* Value: "STRING_VALUE",
|
|
79
|
+
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
|
|
80
|
+
* },
|
|
81
|
+
* },
|
|
82
|
+
* ],
|
|
83
|
+
* AndConditions: [
|
|
84
|
+
* "<NotificationSearchCriteria>",
|
|
85
|
+
* ],
|
|
86
|
+
* StringCondition: {
|
|
87
|
+
* FieldName: "STRING_VALUE",
|
|
88
|
+
* Value: "STRING_VALUE",
|
|
89
|
+
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
|
|
90
|
+
* },
|
|
91
|
+
* },
|
|
92
|
+
* };
|
|
93
|
+
* const command = new SearchNotificationsCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* // { // SearchNotificationsResponse
|
|
96
|
+
* // Notifications: [ // NotificationSearchSummaryList
|
|
97
|
+
* // { // NotificationSearchSummary
|
|
98
|
+
* // Id: "STRING_VALUE",
|
|
99
|
+
* // Arn: "STRING_VALUE",
|
|
100
|
+
* // InstanceId: "STRING_VALUE",
|
|
101
|
+
* // Content: { // NotificationContent
|
|
102
|
+
* // "<keys>": "STRING_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // Priority: "URGENT" || "HIGH" || "LOW",
|
|
105
|
+
* // Recipients: [ // RecipientList
|
|
106
|
+
* // "STRING_VALUE",
|
|
107
|
+
* // ],
|
|
108
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
109
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
110
|
+
* // LastModifiedRegion: "STRING_VALUE",
|
|
111
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
112
|
+
* // Tags: { // TagMap
|
|
113
|
+
* // "<keys>": "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // NextToken: "STRING_VALUE",
|
|
118
|
+
* // ApproximateTotalCount: Number("long"),
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param SearchNotificationsCommandInput - {@link SearchNotificationsCommandInput}
|
|
124
|
+
* @returns {@link SearchNotificationsCommandOutput}
|
|
125
|
+
* @see {@link SearchNotificationsCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link SearchNotificationsCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
133
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
136
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
139
|
+
* <p>The request is not valid.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
142
|
+
* <p>The specified resource was not found.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
145
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ConnectServiceException}
|
|
148
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
149
|
+
*
|
|
150
|
+
*
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export declare class SearchNotificationsCommand extends SearchNotificationsCommand_base {
|
|
154
|
+
/** @internal type navigation helper, not in runtime. */
|
|
155
|
+
protected static __types: {
|
|
156
|
+
api: {
|
|
157
|
+
input: SearchNotificationsRequest;
|
|
158
|
+
output: SearchNotificationsResponse;
|
|
159
|
+
};
|
|
160
|
+
sdk: {
|
|
161
|
+
input: SearchNotificationsCommandInput;
|
|
162
|
+
output: SearchNotificationsCommandOutput;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
}
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchUserHierarchyGroupsResponse } from "../models/
|
|
5
|
-
import type { SearchUserHierarchyGroupsRequest } from "../models/models_3";
|
|
4
|
+
import type { SearchUserHierarchyGroupsRequest, SearchUserHierarchyGroupsResponse } from "../models/models_3";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchUsersResponse } from "../models/
|
|
5
|
-
import type { SearchUsersRequest } from "../models/models_3";
|
|
4
|
+
import type { SearchUsersRequest, SearchUsersResponse } from "../models/models_3";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchViewsResponse } from "../models/
|
|
5
|
-
import type { SearchViewsRequest } from "../models/models_3";
|
|
4
|
+
import type { SearchViewsRequest, SearchViewsResponse } from "../models/models_3";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchVocabulariesRequest, SearchVocabulariesResponse } from "../models/
|
|
4
|
+
import type { SearchVocabulariesRequest, SearchVocabulariesResponse } from "../models/models_3";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { UpdateNotificationContentRequest, UpdateNotificationContentResponse } from "../models/models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateNotificationContentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateNotificationContentCommandInput extends UpdateNotificationContentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateNotificationContentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateNotificationContentCommandOutput extends UpdateNotificationContentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateNotificationContentCommand_base: {
|
|
25
|
+
new (input: UpdateNotificationContentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNotificationContentCommandInput, UpdateNotificationContentCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateNotificationContentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNotificationContentCommandInput, UpdateNotificationContentCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectClient, UpdateNotificationContentCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
35
|
+
* // const { ConnectClient, UpdateNotificationContentCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
36
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
37
|
+
* const config = {}; // type is ConnectClientConfig
|
|
38
|
+
* const client = new ConnectClient(config);
|
|
39
|
+
* const input = { // UpdateNotificationContentRequest
|
|
40
|
+
* InstanceId: "STRING_VALUE", // required
|
|
41
|
+
* NotificationId: "STRING_VALUE", // required
|
|
42
|
+
* Content: { // NotificationContent // required
|
|
43
|
+
* "<keys>": "STRING_VALUE",
|
|
44
|
+
* },
|
|
45
|
+
* };
|
|
46
|
+
* const command = new UpdateNotificationContentCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // {};
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param UpdateNotificationContentCommandInput - {@link UpdateNotificationContentCommandInput}
|
|
53
|
+
* @returns {@link UpdateNotificationContentCommandOutput}
|
|
54
|
+
* @see {@link UpdateNotificationContentCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link UpdateNotificationContentCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
62
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
65
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
68
|
+
* <p>The request is not valid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>The specified resource was not found.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConnectServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class UpdateNotificationContentCommand extends UpdateNotificationContentCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: UpdateNotificationContentRequest;
|
|
87
|
+
output: {};
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: UpdateNotificationContentCommandInput;
|
|
91
|
+
output: UpdateNotificationContentCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { UpdateUserNotificationStatusRequest, UpdateUserNotificationStatusResponse } from "../models/models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateUserNotificationStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateUserNotificationStatusCommandInput extends UpdateUserNotificationStatusRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateUserNotificationStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateUserNotificationStatusCommandOutput extends UpdateUserNotificationStatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateUserNotificationStatusCommand_base: {
|
|
25
|
+
new (input: UpdateUserNotificationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserNotificationStatusCommandInput, UpdateUserNotificationStatusCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateUserNotificationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserNotificationStatusCommandInput, UpdateUserNotificationStatusCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectClient, UpdateUserNotificationStatusCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
35
|
+
* // const { ConnectClient, UpdateUserNotificationStatusCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
36
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
37
|
+
* const config = {}; // type is ConnectClientConfig
|
|
38
|
+
* const client = new ConnectClient(config);
|
|
39
|
+
* const input = { // UpdateUserNotificationStatusRequest
|
|
40
|
+
* InstanceId: "STRING_VALUE", // required
|
|
41
|
+
* NotificationId: "STRING_VALUE", // required
|
|
42
|
+
* UserId: "STRING_VALUE", // required
|
|
43
|
+
* Status: "READ" || "UNREAD" || "HIDDEN", // required
|
|
44
|
+
* LastModifiedTime: new Date("TIMESTAMP"),
|
|
45
|
+
* LastModifiedRegion: "STRING_VALUE",
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateUserNotificationStatusCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // {};
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param UpdateUserNotificationStatusCommandInput - {@link UpdateUserNotificationStatusCommandInput}
|
|
54
|
+
* @returns {@link UpdateUserNotificationStatusCommandOutput}
|
|
55
|
+
* @see {@link UpdateUserNotificationStatusCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link UpdateUserNotificationStatusCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
63
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
66
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
69
|
+
* <p>The request is not valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The specified resource was not found.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConnectServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class UpdateUserNotificationStatusCommand extends UpdateUserNotificationStatusCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: UpdateUserNotificationStatusRequest;
|
|
88
|
+
output: {};
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: UpdateUserNotificationStatusCommandInput;
|
|
92
|
+
output: UpdateUserNotificationStatusCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|