@aws-sdk/client-connectcases 3.900.0 → 3.902.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 +8 -0
- package/dist-cjs/index.js +105 -0
- package/dist-es/ConnectCases.js +2 -0
- package/dist-es/commands/SearchAllRelatedItemsCommand.js +23 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +19 -0
- package/dist-es/pagination/SearchAllRelatedItemsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +52 -0
- package/dist-types/ConnectCases.d.ts +7 -0
- package/dist-types/ConnectCasesClient.d.ts +3 -2
- package/dist-types/commands/SearchAllRelatedItemsCommand.d.ts +263 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +148 -22
- package/dist-types/pagination/SearchAllRelatedItemsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/ConnectCases.d.ts +17 -0
- package/dist-types/ts3.4/ConnectCasesClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/SearchAllRelatedItemsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +39 -0
- package/dist-types/ts3.4/pagination/SearchAllRelatedItemsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +38 -38
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
|
|
4
|
+
import { SearchAllRelatedItemsRequest, SearchAllRelatedItemsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SearchAllRelatedItemsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchAllRelatedItemsCommandInput extends SearchAllRelatedItemsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchAllRelatedItemsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchAllRelatedItemsCommandOutput extends SearchAllRelatedItemsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchAllRelatedItemsCommand_base: {
|
|
25
|
+
new (input: SearchAllRelatedItemsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SearchAllRelatedItemsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html">SearchRelatedItems</a> API.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions.</p> </li> <li> <p>Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. </p> </li> <li> <p>Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts.</p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>This API returns case IDs, not complete case objects. To retrieve full case details, you must make additional calls to the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html">GetCase</a> API for each returned case ID. </p> </li> <li> <p>This API searches across related items content, not case fields. Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html">SearchCases</a> API to search within case field values.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and quotas</a>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCasesClient, SearchAllRelatedItemsCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
|
|
35
|
+
* // const { ConnectCasesClient, SearchAllRelatedItemsCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
|
|
36
|
+
* // import type { ConnectCasesClientConfig } from "@aws-sdk/client-connectcases";
|
|
37
|
+
* const config = {}; // type is ConnectCasesClientConfig
|
|
38
|
+
* const client = new ConnectCasesClient(config);
|
|
39
|
+
* const input = { // SearchAllRelatedItemsRequest
|
|
40
|
+
* domainId: "STRING_VALUE", // required
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* filters: [ // RelatedItemFilterList
|
|
44
|
+
* { // RelatedItemTypeFilter Union: only one key present
|
|
45
|
+
* contact: { // ContactFilter
|
|
46
|
+
* channel: [ // ChannelList
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* contactArn: "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* comment: {},
|
|
52
|
+
* file: { // FileFilter
|
|
53
|
+
* fileArn: "STRING_VALUE",
|
|
54
|
+
* },
|
|
55
|
+
* sla: { // SlaFilter
|
|
56
|
+
* name: "STRING_VALUE",
|
|
57
|
+
* status: "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* connectCase: { // ConnectCaseFilter
|
|
60
|
+
* caseId: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* custom: { // CustomFilter
|
|
63
|
+
* fields: { // CustomFieldsFilter Union: only one key present
|
|
64
|
+
* field: { // FieldFilter Union: only one key present
|
|
65
|
+
* equalTo: { // FieldValue
|
|
66
|
+
* id: "STRING_VALUE", // required
|
|
67
|
+
* value: { // FieldValueUnion Union: only one key present
|
|
68
|
+
* stringValue: "STRING_VALUE",
|
|
69
|
+
* doubleValue: Number("double"),
|
|
70
|
+
* booleanValue: true || false,
|
|
71
|
+
* emptyValue: {},
|
|
72
|
+
* userArnValue: "STRING_VALUE",
|
|
73
|
+
* },
|
|
74
|
+
* },
|
|
75
|
+
* contains: {
|
|
76
|
+
* id: "STRING_VALUE", // required
|
|
77
|
+
* value: {// Union: only one key present
|
|
78
|
+
* stringValue: "STRING_VALUE",
|
|
79
|
+
* doubleValue: Number("double"),
|
|
80
|
+
* booleanValue: true || false,
|
|
81
|
+
* emptyValue: {},
|
|
82
|
+
* userArnValue: "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* },
|
|
85
|
+
* greaterThan: {
|
|
86
|
+
* id: "STRING_VALUE", // required
|
|
87
|
+
* value: {// Union: only one key present
|
|
88
|
+
* stringValue: "STRING_VALUE",
|
|
89
|
+
* doubleValue: Number("double"),
|
|
90
|
+
* booleanValue: true || false,
|
|
91
|
+
* emptyValue: {},
|
|
92
|
+
* userArnValue: "STRING_VALUE",
|
|
93
|
+
* },
|
|
94
|
+
* },
|
|
95
|
+
* greaterThanOrEqualTo: {
|
|
96
|
+
* id: "STRING_VALUE", // required
|
|
97
|
+
* value: {// Union: only one key present
|
|
98
|
+
* stringValue: "STRING_VALUE",
|
|
99
|
+
* doubleValue: Number("double"),
|
|
100
|
+
* booleanValue: true || false,
|
|
101
|
+
* emptyValue: {},
|
|
102
|
+
* userArnValue: "STRING_VALUE",
|
|
103
|
+
* },
|
|
104
|
+
* },
|
|
105
|
+
* lessThan: {
|
|
106
|
+
* id: "STRING_VALUE", // required
|
|
107
|
+
* value: {// Union: only one key present
|
|
108
|
+
* stringValue: "STRING_VALUE",
|
|
109
|
+
* doubleValue: Number("double"),
|
|
110
|
+
* booleanValue: true || false,
|
|
111
|
+
* emptyValue: {},
|
|
112
|
+
* userArnValue: "STRING_VALUE",
|
|
113
|
+
* },
|
|
114
|
+
* },
|
|
115
|
+
* lessThanOrEqualTo: "<FieldValue>",
|
|
116
|
+
* },
|
|
117
|
+
* not: {// Union: only one key present
|
|
118
|
+
* field: {// Union: only one key present
|
|
119
|
+
* equalTo: "<FieldValue>",
|
|
120
|
+
* contains: "<FieldValue>",
|
|
121
|
+
* greaterThan: "<FieldValue>",
|
|
122
|
+
* greaterThanOrEqualTo: "<FieldValue>",
|
|
123
|
+
* lessThan: "<FieldValue>",
|
|
124
|
+
* lessThanOrEqualTo: "<FieldValue>",
|
|
125
|
+
* },
|
|
126
|
+
* not: "<CustomFieldsFilter>",
|
|
127
|
+
* andAll: [ // CustomFieldsFilterList
|
|
128
|
+
* "<CustomFieldsFilter>",
|
|
129
|
+
* ],
|
|
130
|
+
* orAll: [
|
|
131
|
+
* "<CustomFieldsFilter>",
|
|
132
|
+
* ],
|
|
133
|
+
* },
|
|
134
|
+
* andAll: [
|
|
135
|
+
* "<CustomFieldsFilter>",
|
|
136
|
+
* ],
|
|
137
|
+
* orAll: [
|
|
138
|
+
* "<CustomFieldsFilter>",
|
|
139
|
+
* ],
|
|
140
|
+
* },
|
|
141
|
+
* },
|
|
142
|
+
* },
|
|
143
|
+
* ],
|
|
144
|
+
* sorts: [ // SearchAllRelatedItemsSortList
|
|
145
|
+
* { // SearchAllRelatedItemsSort
|
|
146
|
+
* sortProperty: "STRING_VALUE", // required
|
|
147
|
+
* sortOrder: "STRING_VALUE", // required
|
|
148
|
+
* },
|
|
149
|
+
* ],
|
|
150
|
+
* };
|
|
151
|
+
* const command = new SearchAllRelatedItemsCommand(input);
|
|
152
|
+
* const response = await client.send(command);
|
|
153
|
+
* // { // SearchAllRelatedItemsResponse
|
|
154
|
+
* // nextToken: "STRING_VALUE",
|
|
155
|
+
* // relatedItems: [ // SearchAllRelatedItemsResponseItemList // required
|
|
156
|
+
* // { // SearchAllRelatedItemsResponseItem
|
|
157
|
+
* // relatedItemId: "STRING_VALUE", // required
|
|
158
|
+
* // caseId: "STRING_VALUE", // required
|
|
159
|
+
* // type: "STRING_VALUE", // required
|
|
160
|
+
* // associationTime: new Date("TIMESTAMP"), // required
|
|
161
|
+
* // content: { // RelatedItemContent Union: only one key present
|
|
162
|
+
* // contact: { // ContactContent
|
|
163
|
+
* // contactArn: "STRING_VALUE", // required
|
|
164
|
+
* // channel: "STRING_VALUE", // required
|
|
165
|
+
* // connectedToSystemTime: new Date("TIMESTAMP"), // required
|
|
166
|
+
* // },
|
|
167
|
+
* // comment: { // CommentContent
|
|
168
|
+
* // body: "STRING_VALUE", // required
|
|
169
|
+
* // contentType: "STRING_VALUE", // required
|
|
170
|
+
* // },
|
|
171
|
+
* // file: { // FileContent
|
|
172
|
+
* // fileArn: "STRING_VALUE", // required
|
|
173
|
+
* // },
|
|
174
|
+
* // sla: { // SlaContent
|
|
175
|
+
* // slaConfiguration: { // SlaConfiguration
|
|
176
|
+
* // name: "STRING_VALUE", // required
|
|
177
|
+
* // type: "STRING_VALUE", // required
|
|
178
|
+
* // status: "STRING_VALUE", // required
|
|
179
|
+
* // fieldId: "STRING_VALUE",
|
|
180
|
+
* // targetFieldValues: [ // SlaFieldValueUnionList
|
|
181
|
+
* // { // FieldValueUnion Union: only one key present
|
|
182
|
+
* // stringValue: "STRING_VALUE",
|
|
183
|
+
* // doubleValue: Number("double"),
|
|
184
|
+
* // booleanValue: true || false,
|
|
185
|
+
* // emptyValue: {},
|
|
186
|
+
* // userArnValue: "STRING_VALUE",
|
|
187
|
+
* // },
|
|
188
|
+
* // ],
|
|
189
|
+
* // targetTime: new Date("TIMESTAMP"), // required
|
|
190
|
+
* // completionTime: new Date("TIMESTAMP"),
|
|
191
|
+
* // },
|
|
192
|
+
* // },
|
|
193
|
+
* // connectCase: { // ConnectCaseContent
|
|
194
|
+
* // caseId: "STRING_VALUE", // required
|
|
195
|
+
* // },
|
|
196
|
+
* // custom: { // CustomContent
|
|
197
|
+
* // fields: [ // FieldValueList // required
|
|
198
|
+
* // { // FieldValue
|
|
199
|
+
* // id: "STRING_VALUE", // required
|
|
200
|
+
* // value: {// Union: only one key present
|
|
201
|
+
* // stringValue: "STRING_VALUE",
|
|
202
|
+
* // doubleValue: Number("double"),
|
|
203
|
+
* // booleanValue: true || false,
|
|
204
|
+
* // emptyValue: {},
|
|
205
|
+
* // userArnValue: "STRING_VALUE",
|
|
206
|
+
* // },
|
|
207
|
+
* // },
|
|
208
|
+
* // ],
|
|
209
|
+
* // },
|
|
210
|
+
* // },
|
|
211
|
+
* // performedBy: { // UserUnion Union: only one key present
|
|
212
|
+
* // userArn: "STRING_VALUE",
|
|
213
|
+
* // customEntity: "STRING_VALUE",
|
|
214
|
+
* // },
|
|
215
|
+
* // tags: { // Tags
|
|
216
|
+
* // "<keys>": "STRING_VALUE",
|
|
217
|
+
* // },
|
|
218
|
+
* // },
|
|
219
|
+
* // ],
|
|
220
|
+
* // };
|
|
221
|
+
*
|
|
222
|
+
* ```
|
|
223
|
+
*
|
|
224
|
+
* @param SearchAllRelatedItemsCommandInput - {@link SearchAllRelatedItemsCommandInput}
|
|
225
|
+
* @returns {@link SearchAllRelatedItemsCommandOutput}
|
|
226
|
+
* @see {@link SearchAllRelatedItemsCommandInput} for command's `input` shape.
|
|
227
|
+
* @see {@link SearchAllRelatedItemsCommandOutput} for command's `response` shape.
|
|
228
|
+
* @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
|
|
229
|
+
*
|
|
230
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
231
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link InternalServerException} (server fault)
|
|
234
|
+
* <p>We couldn't process your request because of an issue with the server. Try again later.</p>
|
|
235
|
+
*
|
|
236
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
237
|
+
* <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
|
|
238
|
+
*
|
|
239
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
240
|
+
* <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
|
|
241
|
+
*
|
|
242
|
+
* @throws {@link ValidationException} (client fault)
|
|
243
|
+
* <p>The request isn't valid. Check the syntax and try again.</p>
|
|
244
|
+
*
|
|
245
|
+
* @throws {@link ConnectCasesServiceException}
|
|
246
|
+
* <p>Base exception class for all service exceptions from ConnectCases service.</p>
|
|
247
|
+
*
|
|
248
|
+
*
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export declare class SearchAllRelatedItemsCommand extends SearchAllRelatedItemsCommand_base {
|
|
252
|
+
/** @internal type navigation helper, not in runtime. */
|
|
253
|
+
protected static __types: {
|
|
254
|
+
api: {
|
|
255
|
+
input: SearchAllRelatedItemsRequest;
|
|
256
|
+
output: SearchAllRelatedItemsResponse;
|
|
257
|
+
};
|
|
258
|
+
sdk: {
|
|
259
|
+
input: SearchAllRelatedItemsCommandInput;
|
|
260
|
+
output: SearchAllRelatedItemsCommandOutput;
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
}
|
|
@@ -30,6 +30,7 @@ export * from "./ListLayoutsCommand";
|
|
|
30
30
|
export * from "./ListTagsForResourceCommand";
|
|
31
31
|
export * from "./ListTemplatesCommand";
|
|
32
32
|
export * from "./PutCaseEventConfigurationCommand";
|
|
33
|
+
export * from "./SearchAllRelatedItemsCommand";
|
|
33
34
|
export * from "./SearchCasesCommand";
|
|
34
35
|
export * from "./SearchRelatedItemsCommand";
|
|
35
36
|
export * from "./TagResourceCommand";
|
|
@@ -685,12 +685,12 @@ export interface CommentContent {
|
|
|
685
685
|
contentType: CommentBodyTextType | undefined;
|
|
686
686
|
}
|
|
687
687
|
/**
|
|
688
|
-
* Represents the
|
|
688
|
+
* <p>Represents the content of a <code>ConnectCase</code> related item.</p>
|
|
689
689
|
* @public
|
|
690
690
|
*/
|
|
691
691
|
export interface ConnectCaseInputContent {
|
|
692
692
|
/**
|
|
693
|
-
*
|
|
693
|
+
* <p>A unique identifier of the case.</p>
|
|
694
694
|
* @public
|
|
695
695
|
*/
|
|
696
696
|
caseId: string | undefined;
|
|
@@ -707,12 +707,12 @@ export interface Contact {
|
|
|
707
707
|
contactArn: string | undefined;
|
|
708
708
|
}
|
|
709
709
|
/**
|
|
710
|
-
* Represents the
|
|
710
|
+
* <p>Represents the content of a <code>Custom</code> related item.</p>
|
|
711
711
|
* @public
|
|
712
712
|
*/
|
|
713
713
|
export interface CustomInputContent {
|
|
714
714
|
/**
|
|
715
|
-
* List of field values for the
|
|
715
|
+
* <p>List of field values for the <code>Custom</code> related item.</p>
|
|
716
716
|
* @public
|
|
717
717
|
*/
|
|
718
718
|
fields: FieldValue[] | undefined;
|
|
@@ -862,7 +862,7 @@ export declare namespace RelatedItemInputContent {
|
|
|
862
862
|
$unknown?: never;
|
|
863
863
|
}
|
|
864
864
|
/**
|
|
865
|
-
*
|
|
865
|
+
* <p>Represents the Amazon Connect case to be created as a related item.</p>
|
|
866
866
|
* @public
|
|
867
867
|
*/
|
|
868
868
|
interface ConnectCaseMember {
|
|
@@ -875,7 +875,7 @@ export declare namespace RelatedItemInputContent {
|
|
|
875
875
|
$unknown?: never;
|
|
876
876
|
}
|
|
877
877
|
/**
|
|
878
|
-
*
|
|
878
|
+
* <p>Represents the content of a <code>Custom</code> type related item.</p>
|
|
879
879
|
* @public
|
|
880
880
|
*/
|
|
881
881
|
interface CustomMember {
|
|
@@ -999,12 +999,12 @@ export interface DeleteRelatedItemResponse {
|
|
|
999
999
|
export interface CommentFilter {
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
1002
|
-
* A filter for related items of type
|
|
1002
|
+
* <p>A filter for related items of type <code>ConnectCase</code>.</p>
|
|
1003
1003
|
* @public
|
|
1004
1004
|
*/
|
|
1005
1005
|
export interface ConnectCaseFilter {
|
|
1006
1006
|
/**
|
|
1007
|
-
*
|
|
1007
|
+
* <p>A unique identifier of the case.</p>
|
|
1008
1008
|
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
caseId?: string | undefined;
|
|
@@ -1177,12 +1177,12 @@ export interface SlaFilter {
|
|
|
1177
1177
|
status?: SlaStatus | undefined;
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
|
-
* Represents the content of a
|
|
1180
|
+
* <p>Represents the content of a <code>ConnectCase</code> type related item.</p>
|
|
1181
1181
|
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
export interface ConnectCaseContent {
|
|
1184
1184
|
/**
|
|
1185
|
-
*
|
|
1185
|
+
* <p>A unique identifier of the case.</p>
|
|
1186
1186
|
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
caseId: string | undefined;
|
|
@@ -1209,12 +1209,12 @@ export interface ContactContent {
|
|
|
1209
1209
|
connectedToSystemTime: Date | undefined;
|
|
1210
1210
|
}
|
|
1211
1211
|
/**
|
|
1212
|
-
* Represents the content of a Custom related item
|
|
1212
|
+
* <p>Represents the content of a <code>Custom</code> type related item.</p>
|
|
1213
1213
|
* @public
|
|
1214
1214
|
*/
|
|
1215
1215
|
export interface CustomContent {
|
|
1216
1216
|
/**
|
|
1217
|
-
* List of field values for the
|
|
1217
|
+
* <p>List of field values for the <code>Custom</code> related item.</p>
|
|
1218
1218
|
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
fields: FieldValue[] | undefined;
|
|
@@ -1333,7 +1333,7 @@ export declare namespace RelatedItemContent {
|
|
|
1333
1333
|
$unknown?: never;
|
|
1334
1334
|
}
|
|
1335
1335
|
/**
|
|
1336
|
-
*
|
|
1336
|
+
* <p>Represents the Amazon Connect case to be created as a related item.</p>
|
|
1337
1337
|
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
interface ConnectCaseMember {
|
|
@@ -1346,7 +1346,7 @@ export declare namespace RelatedItemContent {
|
|
|
1346
1346
|
$unknown?: never;
|
|
1347
1347
|
}
|
|
1348
1348
|
/**
|
|
1349
|
-
*
|
|
1349
|
+
* <p>Represents the content of a <code>Custom</code> type related item.</p>
|
|
1350
1350
|
* @public
|
|
1351
1351
|
*/
|
|
1352
1352
|
interface CustomMember {
|
|
@@ -2281,6 +2281,90 @@ export interface PutCaseEventConfigurationRequest {
|
|
|
2281
2281
|
*/
|
|
2282
2282
|
export interface PutCaseEventConfigurationResponse {
|
|
2283
2283
|
}
|
|
2284
|
+
/**
|
|
2285
|
+
* @public
|
|
2286
|
+
* @enum
|
|
2287
|
+
*/
|
|
2288
|
+
export declare const SearchAllRelatedItemsSortProperty: {
|
|
2289
|
+
readonly ASSOCIATION_TIME: "AssociationTime";
|
|
2290
|
+
readonly CASE_ID: "CaseId";
|
|
2291
|
+
};
|
|
2292
|
+
/**
|
|
2293
|
+
* @public
|
|
2294
|
+
*/
|
|
2295
|
+
export type SearchAllRelatedItemsSortProperty = (typeof SearchAllRelatedItemsSortProperty)[keyof typeof SearchAllRelatedItemsSortProperty];
|
|
2296
|
+
/**
|
|
2297
|
+
* <p>The order in which all returned related items should be sorted.</p>
|
|
2298
|
+
* @public
|
|
2299
|
+
*/
|
|
2300
|
+
export interface SearchAllRelatedItemsSort {
|
|
2301
|
+
/**
|
|
2302
|
+
* <p>Whether related items should be sorted in ascending or descending order. </p>
|
|
2303
|
+
* @public
|
|
2304
|
+
*/
|
|
2305
|
+
sortProperty: SearchAllRelatedItemsSortProperty | undefined;
|
|
2306
|
+
/**
|
|
2307
|
+
* <p>Whether related items should be sorted by association time or case ID. </p>
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2310
|
+
sortOrder: Order | undefined;
|
|
2311
|
+
}
|
|
2312
|
+
/**
|
|
2313
|
+
* <p>A list of items that represent RelatedItems. This data type is similar to <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItemsResponseItem.html">SearchRelatedItemsResponseItem</a> except Search<b>All</b>RelatedItemsResponseItem has a caseId field.</p>
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2316
|
+
export interface SearchAllRelatedItemsResponseItem {
|
|
2317
|
+
/**
|
|
2318
|
+
* <p>Unique identifier of a related item.</p>
|
|
2319
|
+
* @public
|
|
2320
|
+
*/
|
|
2321
|
+
relatedItemId: string | undefined;
|
|
2322
|
+
/**
|
|
2323
|
+
* <p>A unique identifier of the case.</p>
|
|
2324
|
+
* @public
|
|
2325
|
+
*/
|
|
2326
|
+
caseId: string | undefined;
|
|
2327
|
+
/**
|
|
2328
|
+
* <p>Type of a related item.</p>
|
|
2329
|
+
* @public
|
|
2330
|
+
*/
|
|
2331
|
+
type: RelatedItemType | undefined;
|
|
2332
|
+
/**
|
|
2333
|
+
* <p>Time at which a related item was associated with a case.</p>
|
|
2334
|
+
* @public
|
|
2335
|
+
*/
|
|
2336
|
+
associationTime: Date | undefined;
|
|
2337
|
+
/**
|
|
2338
|
+
* <p>Represents the content of a particular type of related item.</p>
|
|
2339
|
+
* @public
|
|
2340
|
+
*/
|
|
2341
|
+
content: RelatedItemContent | undefined;
|
|
2342
|
+
/**
|
|
2343
|
+
* <p>Represents the entity that performed the action.</p>
|
|
2344
|
+
* @public
|
|
2345
|
+
*/
|
|
2346
|
+
performedBy?: UserUnion | undefined;
|
|
2347
|
+
/**
|
|
2348
|
+
* <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
|
|
2349
|
+
* @public
|
|
2350
|
+
*/
|
|
2351
|
+
tags?: Record<string, string> | undefined;
|
|
2352
|
+
}
|
|
2353
|
+
/**
|
|
2354
|
+
* @public
|
|
2355
|
+
*/
|
|
2356
|
+
export interface SearchAllRelatedItemsResponse {
|
|
2357
|
+
/**
|
|
2358
|
+
* <p>The token for the next set of results. This is null if there are no more results to return.</p>
|
|
2359
|
+
* @public
|
|
2360
|
+
*/
|
|
2361
|
+
nextToken?: string | undefined;
|
|
2362
|
+
/**
|
|
2363
|
+
* <p>A list of items related to a case.</p>
|
|
2364
|
+
* @public
|
|
2365
|
+
*/
|
|
2366
|
+
relatedItems: SearchAllRelatedItemsResponseItem[] | undefined;
|
|
2367
|
+
}
|
|
2284
2368
|
/**
|
|
2285
2369
|
* @public
|
|
2286
2370
|
*/
|
|
@@ -3449,7 +3533,7 @@ export declare namespace CaseFilter {
|
|
|
3449
3533
|
const visit: <T>(value: CaseFilter, visitor: Visitor<T>) => T;
|
|
3450
3534
|
}
|
|
3451
3535
|
/**
|
|
3452
|
-
* A filter for fields in related items
|
|
3536
|
+
* <p>A filter for fields in <code>Custom</code> type related items. Only one value can be provided.</p>
|
|
3453
3537
|
* @public
|
|
3454
3538
|
*/
|
|
3455
3539
|
export type CustomFieldsFilter = CustomFieldsFilter.AndAllMember | CustomFieldsFilter.FieldMember | CustomFieldsFilter.NotMember | CustomFieldsFilter.OrAllMember | CustomFieldsFilter.$UnknownMember;
|
|
@@ -3469,7 +3553,7 @@ export declare namespace CustomFieldsFilter {
|
|
|
3469
3553
|
$unknown?: never;
|
|
3470
3554
|
}
|
|
3471
3555
|
/**
|
|
3472
|
-
* Excludes items matching the filter
|
|
3556
|
+
* <p>Excludes items matching the filter.</p>
|
|
3473
3557
|
* @public
|
|
3474
3558
|
*/
|
|
3475
3559
|
interface NotMember {
|
|
@@ -3480,7 +3564,7 @@ export declare namespace CustomFieldsFilter {
|
|
|
3480
3564
|
$unknown?: never;
|
|
3481
3565
|
}
|
|
3482
3566
|
/**
|
|
3483
|
-
*
|
|
3567
|
+
* <p>Provides "and all" filtering.</p>
|
|
3484
3568
|
* @public
|
|
3485
3569
|
*/
|
|
3486
3570
|
interface AndAllMember {
|
|
@@ -3491,7 +3575,7 @@ export declare namespace CustomFieldsFilter {
|
|
|
3491
3575
|
$unknown?: never;
|
|
3492
3576
|
}
|
|
3493
3577
|
/**
|
|
3494
|
-
*
|
|
3578
|
+
* <p>Provides "or all" filtering.</p>
|
|
3495
3579
|
* @public
|
|
3496
3580
|
*/
|
|
3497
3581
|
interface OrAllMember {
|
|
@@ -3521,12 +3605,12 @@ export declare namespace CustomFieldsFilter {
|
|
|
3521
3605
|
const visit: <T>(value: CustomFieldsFilter, visitor: Visitor<T>) => T;
|
|
3522
3606
|
}
|
|
3523
3607
|
/**
|
|
3524
|
-
* A filter for related items of type Custom
|
|
3608
|
+
* <p>A filter for related items of type <code>Custom</code>.</p>
|
|
3525
3609
|
* @public
|
|
3526
3610
|
*/
|
|
3527
3611
|
export interface CustomFilter {
|
|
3528
3612
|
/**
|
|
3529
|
-
* Filter conditions for custom fields
|
|
3613
|
+
* <p>Filter conditions for custom fields.</p>
|
|
3530
3614
|
* @public
|
|
3531
3615
|
*/
|
|
3532
3616
|
fields?: CustomFieldsFilter | undefined;
|
|
@@ -3633,7 +3717,7 @@ export declare namespace RelatedItemTypeFilter {
|
|
|
3633
3717
|
$unknown?: never;
|
|
3634
3718
|
}
|
|
3635
3719
|
/**
|
|
3636
|
-
*
|
|
3720
|
+
* <p>Represents the Amazon Connect case to be created as a related item.</p>
|
|
3637
3721
|
* @public
|
|
3638
3722
|
*/
|
|
3639
3723
|
interface ConnectCaseMember {
|
|
@@ -3646,7 +3730,7 @@ export declare namespace RelatedItemTypeFilter {
|
|
|
3646
3730
|
$unknown?: never;
|
|
3647
3731
|
}
|
|
3648
3732
|
/**
|
|
3649
|
-
*
|
|
3733
|
+
* <p>Represents the content of a <code>Custom</code> type related item.</p>
|
|
3650
3734
|
* @public
|
|
3651
3735
|
*/
|
|
3652
3736
|
interface CustomMember {
|
|
@@ -3681,6 +3765,36 @@ export declare namespace RelatedItemTypeFilter {
|
|
|
3681
3765
|
}
|
|
3682
3766
|
const visit: <T>(value: RelatedItemTypeFilter, visitor: Visitor<T>) => T;
|
|
3683
3767
|
}
|
|
3768
|
+
/**
|
|
3769
|
+
* @public
|
|
3770
|
+
*/
|
|
3771
|
+
export interface SearchAllRelatedItemsRequest {
|
|
3772
|
+
/**
|
|
3773
|
+
* <p>The unique identifier of the Cases domain. </p>
|
|
3774
|
+
* @public
|
|
3775
|
+
*/
|
|
3776
|
+
domainId: string | undefined;
|
|
3777
|
+
/**
|
|
3778
|
+
* <p>The maximum number of results to return per page.</p>
|
|
3779
|
+
* @public
|
|
3780
|
+
*/
|
|
3781
|
+
maxResults?: number | undefined;
|
|
3782
|
+
/**
|
|
3783
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
3784
|
+
* @public
|
|
3785
|
+
*/
|
|
3786
|
+
nextToken?: string | undefined;
|
|
3787
|
+
/**
|
|
3788
|
+
* <p>The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.</p>
|
|
3789
|
+
* @public
|
|
3790
|
+
*/
|
|
3791
|
+
filters?: RelatedItemTypeFilter[] | undefined;
|
|
3792
|
+
/**
|
|
3793
|
+
* <p>A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.</p>
|
|
3794
|
+
* @public
|
|
3795
|
+
*/
|
|
3796
|
+
sorts?: SearchAllRelatedItemsSort[] | undefined;
|
|
3797
|
+
}
|
|
3684
3798
|
/**
|
|
3685
3799
|
* @public
|
|
3686
3800
|
*/
|
|
@@ -3775,10 +3889,22 @@ export declare const SearchRelatedItemsResponseFilterSensitiveLog: (obj: SearchR
|
|
|
3775
3889
|
* @internal
|
|
3776
3890
|
*/
|
|
3777
3891
|
export declare const UpdateCaseRequestFilterSensitiveLog: (obj: UpdateCaseRequest) => any;
|
|
3892
|
+
/**
|
|
3893
|
+
* @internal
|
|
3894
|
+
*/
|
|
3895
|
+
export declare const SearchAllRelatedItemsResponseItemFilterSensitiveLog: (obj: SearchAllRelatedItemsResponseItem) => any;
|
|
3896
|
+
/**
|
|
3897
|
+
* @internal
|
|
3898
|
+
*/
|
|
3899
|
+
export declare const SearchAllRelatedItemsResponseFilterSensitiveLog: (obj: SearchAllRelatedItemsResponse) => any;
|
|
3778
3900
|
/**
|
|
3779
3901
|
* @internal
|
|
3780
3902
|
*/
|
|
3781
3903
|
export declare const RelatedItemTypeFilterFilterSensitiveLog: (obj: RelatedItemTypeFilter) => any;
|
|
3904
|
+
/**
|
|
3905
|
+
* @internal
|
|
3906
|
+
*/
|
|
3907
|
+
export declare const SearchAllRelatedItemsRequestFilterSensitiveLog: (obj: SearchAllRelatedItemsRequest) => any;
|
|
3782
3908
|
/**
|
|
3783
3909
|
* @internal
|
|
3784
3910
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput } from "../commands/SearchAllRelatedItemsCommand";
|
|
3
|
+
import { ConnectCasesPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateSearchAllRelatedItems: (config: ConnectCasesPaginationConfiguration, input: SearchAllRelatedItemsCommandInput, ...rest: any[]) => Paginator<SearchAllRelatedItemsCommandOutput>;
|
|
@@ -8,5 +8,6 @@ export * from "./ListFieldOptionsPaginator";
|
|
|
8
8
|
export * from "./ListFieldsPaginator";
|
|
9
9
|
export * from "./ListLayoutsPaginator";
|
|
10
10
|
export * from "./ListTemplatesPaginator";
|
|
11
|
+
export * from "./SearchAllRelatedItemsPaginator";
|
|
11
12
|
export * from "./SearchCasesPaginator";
|
|
12
13
|
export * from "./SearchRelatedItemsPaginator";
|
|
@@ -32,6 +32,7 @@ import { ListLayoutsCommandInput, ListLayoutsCommandOutput } from "../commands/L
|
|
|
32
32
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
33
33
|
import { ListTemplatesCommandInput, ListTemplatesCommandOutput } from "../commands/ListTemplatesCommand";
|
|
34
34
|
import { PutCaseEventConfigurationCommandInput, PutCaseEventConfigurationCommandOutput } from "../commands/PutCaseEventConfigurationCommand";
|
|
35
|
+
import { SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput } from "../commands/SearchAllRelatedItemsCommand";
|
|
35
36
|
import { SearchCasesCommandInput, SearchCasesCommandOutput } from "../commands/SearchCasesCommand";
|
|
36
37
|
import { SearchRelatedItemsCommandInput, SearchRelatedItemsCommandOutput } from "../commands/SearchRelatedItemsCommand";
|
|
37
38
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
@@ -169,6 +170,10 @@ export declare const se_ListTemplatesCommand: (input: ListTemplatesCommandInput,
|
|
|
169
170
|
* serializeAws_restJson1PutCaseEventConfigurationCommand
|
|
170
171
|
*/
|
|
171
172
|
export declare const se_PutCaseEventConfigurationCommand: (input: PutCaseEventConfigurationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
173
|
+
/**
|
|
174
|
+
* serializeAws_restJson1SearchAllRelatedItemsCommand
|
|
175
|
+
*/
|
|
176
|
+
export declare const se_SearchAllRelatedItemsCommand: (input: SearchAllRelatedItemsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
172
177
|
/**
|
|
173
178
|
* serializeAws_restJson1SearchCasesCommand
|
|
174
179
|
*/
|
|
@@ -333,6 +338,10 @@ export declare const de_ListTemplatesCommand: (output: __HttpResponse, context:
|
|
|
333
338
|
* deserializeAws_restJson1PutCaseEventConfigurationCommand
|
|
334
339
|
*/
|
|
335
340
|
export declare const de_PutCaseEventConfigurationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutCaseEventConfigurationCommandOutput>;
|
|
341
|
+
/**
|
|
342
|
+
* deserializeAws_restJson1SearchAllRelatedItemsCommand
|
|
343
|
+
*/
|
|
344
|
+
export declare const de_SearchAllRelatedItemsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchAllRelatedItemsCommandOutput>;
|
|
336
345
|
/**
|
|
337
346
|
* deserializeAws_restJson1SearchCasesCommand
|
|
338
347
|
*/
|
|
@@ -127,6 +127,10 @@ import {
|
|
|
127
127
|
PutCaseEventConfigurationCommandInput,
|
|
128
128
|
PutCaseEventConfigurationCommandOutput,
|
|
129
129
|
} from "./commands/PutCaseEventConfigurationCommand";
|
|
130
|
+
import {
|
|
131
|
+
SearchAllRelatedItemsCommandInput,
|
|
132
|
+
SearchAllRelatedItemsCommandOutput,
|
|
133
|
+
} from "./commands/SearchAllRelatedItemsCommand";
|
|
130
134
|
import {
|
|
131
135
|
SearchCasesCommandInput,
|
|
132
136
|
SearchCasesCommandOutput,
|
|
@@ -582,6 +586,19 @@ export interface ConnectCases {
|
|
|
582
586
|
options: __HttpHandlerOptions,
|
|
583
587
|
cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void
|
|
584
588
|
): void;
|
|
589
|
+
searchAllRelatedItems(
|
|
590
|
+
args: SearchAllRelatedItemsCommandInput,
|
|
591
|
+
options?: __HttpHandlerOptions
|
|
592
|
+
): Promise<SearchAllRelatedItemsCommandOutput>;
|
|
593
|
+
searchAllRelatedItems(
|
|
594
|
+
args: SearchAllRelatedItemsCommandInput,
|
|
595
|
+
cb: (err: any, data?: SearchAllRelatedItemsCommandOutput) => void
|
|
596
|
+
): void;
|
|
597
|
+
searchAllRelatedItems(
|
|
598
|
+
args: SearchAllRelatedItemsCommandInput,
|
|
599
|
+
options: __HttpHandlerOptions,
|
|
600
|
+
cb: (err: any, data?: SearchAllRelatedItemsCommandOutput) => void
|
|
601
|
+
): void;
|
|
585
602
|
searchCases(
|
|
586
603
|
args: SearchCasesCommandInput,
|
|
587
604
|
options?: __HttpHandlerOptions
|