@aws-sdk/client-connectcases 3.901.0 → 3.906.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 +3259 -3300
- 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 +5 -5
package/dist-es/ConnectCases.js
CHANGED
|
@@ -31,6 +31,7 @@ import { ListLayoutsCommand } from "./commands/ListLayoutsCommand";
|
|
|
31
31
|
import { ListTagsForResourceCommand, } from "./commands/ListTagsForResourceCommand";
|
|
32
32
|
import { ListTemplatesCommand, } from "./commands/ListTemplatesCommand";
|
|
33
33
|
import { PutCaseEventConfigurationCommand, } from "./commands/PutCaseEventConfigurationCommand";
|
|
34
|
+
import { SearchAllRelatedItemsCommand, } from "./commands/SearchAllRelatedItemsCommand";
|
|
34
35
|
import { SearchCasesCommand } from "./commands/SearchCasesCommand";
|
|
35
36
|
import { SearchRelatedItemsCommand, } from "./commands/SearchRelatedItemsCommand";
|
|
36
37
|
import { TagResourceCommand } from "./commands/TagResourceCommand";
|
|
@@ -74,6 +75,7 @@ const commands = {
|
|
|
74
75
|
ListTagsForResourceCommand,
|
|
75
76
|
ListTemplatesCommand,
|
|
76
77
|
PutCaseEventConfigurationCommand,
|
|
78
|
+
SearchAllRelatedItemsCommand,
|
|
77
79
|
SearchCasesCommand,
|
|
78
80
|
SearchRelatedItemsCommand,
|
|
79
81
|
TagResourceCommand,
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { SearchAllRelatedItemsRequestFilterSensitiveLog, SearchAllRelatedItemsResponseFilterSensitiveLog, } from "../models/models_0";
|
|
6
|
+
import { de_SearchAllRelatedItemsCommand, se_SearchAllRelatedItemsCommand } from "../protocols/Aws_restJson1";
|
|
7
|
+
export { $Command };
|
|
8
|
+
export class SearchAllRelatedItemsCommand extends $Command
|
|
9
|
+
.classBuilder()
|
|
10
|
+
.ep(commonParams)
|
|
11
|
+
.m(function (Command, cs, config, o) {
|
|
12
|
+
return [
|
|
13
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
14
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
15
|
+
];
|
|
16
|
+
})
|
|
17
|
+
.s("AmazonConnectCases", "SearchAllRelatedItems", {})
|
|
18
|
+
.n("ConnectCasesClient", "SearchAllRelatedItemsCommand")
|
|
19
|
+
.f(SearchAllRelatedItemsRequestFilterSensitiveLog, SearchAllRelatedItemsResponseFilterSensitiveLog)
|
|
20
|
+
.ser(se_SearchAllRelatedItemsCommand)
|
|
21
|
+
.de(de_SearchAllRelatedItemsCommand)
|
|
22
|
+
.build() {
|
|
23
|
+
}
|
|
@@ -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";
|
|
@@ -273,6 +273,10 @@ export const DomainStatus = {
|
|
|
273
273
|
CREATION_FAILED: "CreationFailed",
|
|
274
274
|
CREATION_IN_PROGRESS: "CreationInProgress",
|
|
275
275
|
};
|
|
276
|
+
export const SearchAllRelatedItemsSortProperty = {
|
|
277
|
+
ASSOCIATION_TIME: "AssociationTime",
|
|
278
|
+
CASE_ID: "CaseId",
|
|
279
|
+
};
|
|
276
280
|
export const FieldNamespace = {
|
|
277
281
|
CUSTOM: "Custom",
|
|
278
282
|
SYSTEM: "System",
|
|
@@ -455,6 +459,17 @@ export const UpdateCaseRequestFilterSensitiveLog = (obj) => ({
|
|
|
455
459
|
...(obj.fields && { fields: obj.fields.map((item) => item) }),
|
|
456
460
|
...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
|
|
457
461
|
});
|
|
462
|
+
export const SearchAllRelatedItemsResponseItemFilterSensitiveLog = (obj) => ({
|
|
463
|
+
...obj,
|
|
464
|
+
...(obj.content && { content: RelatedItemContentFilterSensitiveLog(obj.content) }),
|
|
465
|
+
...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
|
|
466
|
+
});
|
|
467
|
+
export const SearchAllRelatedItemsResponseFilterSensitiveLog = (obj) => ({
|
|
468
|
+
...obj,
|
|
469
|
+
...(obj.relatedItems && {
|
|
470
|
+
relatedItems: obj.relatedItems.map((item) => SearchAllRelatedItemsResponseItemFilterSensitiveLog(item)),
|
|
471
|
+
}),
|
|
472
|
+
});
|
|
458
473
|
export const RelatedItemTypeFilterFilterSensitiveLog = (obj) => {
|
|
459
474
|
if (obj.contact !== undefined)
|
|
460
475
|
return { contact: obj.contact };
|
|
@@ -471,6 +486,10 @@ export const RelatedItemTypeFilterFilterSensitiveLog = (obj) => {
|
|
|
471
486
|
if (obj.$unknown !== undefined)
|
|
472
487
|
return { [obj.$unknown[0]]: "UNKNOWN" };
|
|
473
488
|
};
|
|
489
|
+
export const SearchAllRelatedItemsRequestFilterSensitiveLog = (obj) => ({
|
|
490
|
+
...obj,
|
|
491
|
+
...(obj.filters && { filters: obj.filters.map((item) => RelatedItemTypeFilterFilterSensitiveLog(item)) }),
|
|
492
|
+
});
|
|
474
493
|
export const SearchRelatedItemsRequestFilterSensitiveLog = (obj) => ({
|
|
475
494
|
...obj,
|
|
476
495
|
...(obj.filters && { filters: obj.filters.map((item) => RelatedItemTypeFilterFilterSensitiveLog(item)) }),
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { createPaginator } from "@smithy/core";
|
|
2
|
+
import { SearchAllRelatedItemsCommand, } from "../commands/SearchAllRelatedItemsCommand";
|
|
3
|
+
import { ConnectCasesClient } from "../ConnectCasesClient";
|
|
4
|
+
export const paginateSearchAllRelatedItems = createPaginator(ConnectCasesClient, SearchAllRelatedItemsCommand, "nextToken", "nextToken", "maxResults");
|
|
@@ -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";
|
|
@@ -419,6 +419,23 @@ export const se_PutCaseEventConfigurationCommand = async (input, context) => {
|
|
|
419
419
|
b.m("PUT").h(headers).b(body);
|
|
420
420
|
return b.build();
|
|
421
421
|
};
|
|
422
|
+
export const se_SearchAllRelatedItemsCommand = async (input, context) => {
|
|
423
|
+
const b = rb(input, context);
|
|
424
|
+
const headers = {
|
|
425
|
+
"content-type": "application/json",
|
|
426
|
+
};
|
|
427
|
+
b.bp("/domains/{domainId}/related-items-search");
|
|
428
|
+
b.p("domainId", () => input.domainId, "{domainId}", false);
|
|
429
|
+
let body;
|
|
430
|
+
body = JSON.stringify(take(input, {
|
|
431
|
+
filters: (_) => se_RelatedItemFilterList(_, context),
|
|
432
|
+
maxResults: [],
|
|
433
|
+
nextToken: [],
|
|
434
|
+
sorts: (_) => _json(_),
|
|
435
|
+
}));
|
|
436
|
+
b.m("POST").h(headers).b(body);
|
|
437
|
+
return b.build();
|
|
438
|
+
};
|
|
422
439
|
export const se_SearchCasesCommand = async (input, context) => {
|
|
423
440
|
const b = rb(input, context);
|
|
424
441
|
const headers = {
|
|
@@ -1026,6 +1043,21 @@ export const de_PutCaseEventConfigurationCommand = async (output, context) => {
|
|
|
1026
1043
|
await collectBody(output.body, context);
|
|
1027
1044
|
return contents;
|
|
1028
1045
|
};
|
|
1046
|
+
export const de_SearchAllRelatedItemsCommand = async (output, context) => {
|
|
1047
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1048
|
+
return de_CommandError(output, context);
|
|
1049
|
+
}
|
|
1050
|
+
const contents = map({
|
|
1051
|
+
$metadata: deserializeMetadata(output),
|
|
1052
|
+
});
|
|
1053
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
1054
|
+
const doc = take(data, {
|
|
1055
|
+
nextToken: __expectString,
|
|
1056
|
+
relatedItems: (_) => de_SearchAllRelatedItemsResponseItemList(_, context),
|
|
1057
|
+
});
|
|
1058
|
+
Object.assign(contents, doc);
|
|
1059
|
+
return contents;
|
|
1060
|
+
};
|
|
1029
1061
|
export const de_SearchCasesCommand = async (output, context) => {
|
|
1030
1062
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1031
1063
|
return de_CommandError(output, context);
|
|
@@ -1674,6 +1706,26 @@ const de_RequiredCaseRule = (output, context) => {
|
|
|
1674
1706
|
defaultValue: __expectBoolean,
|
|
1675
1707
|
});
|
|
1676
1708
|
};
|
|
1709
|
+
const de_SearchAllRelatedItemsResponseItem = (output, context) => {
|
|
1710
|
+
return take(output, {
|
|
1711
|
+
associationTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
|
|
1712
|
+
caseId: __expectString,
|
|
1713
|
+
content: (_) => de_RelatedItemContent(__expectUnion(_), context),
|
|
1714
|
+
performedBy: (_) => _json(__expectUnion(_)),
|
|
1715
|
+
relatedItemId: __expectString,
|
|
1716
|
+
tags: (_) => de_Tags(_, context),
|
|
1717
|
+
type: __expectString,
|
|
1718
|
+
});
|
|
1719
|
+
};
|
|
1720
|
+
const de_SearchAllRelatedItemsResponseItemList = (output, context) => {
|
|
1721
|
+
const retVal = (output || []).map((entry) => {
|
|
1722
|
+
if (entry === null) {
|
|
1723
|
+
return null;
|
|
1724
|
+
}
|
|
1725
|
+
return de_SearchAllRelatedItemsResponseItem(entry, context);
|
|
1726
|
+
});
|
|
1727
|
+
return retVal;
|
|
1728
|
+
};
|
|
1677
1729
|
const de_SearchCasesResponseItem = (output, context) => {
|
|
1678
1730
|
return take(output, {
|
|
1679
1731
|
caseId: __expectString,
|
|
@@ -31,6 +31,7 @@ import { ListLayoutsCommandInput, ListLayoutsCommandOutput } from "./commands/Li
|
|
|
31
31
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
32
32
|
import { ListTemplatesCommandInput, ListTemplatesCommandOutput } from "./commands/ListTemplatesCommand";
|
|
33
33
|
import { PutCaseEventConfigurationCommandInput, PutCaseEventConfigurationCommandOutput } from "./commands/PutCaseEventConfigurationCommand";
|
|
34
|
+
import { SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput } from "./commands/SearchAllRelatedItemsCommand";
|
|
34
35
|
import { SearchCasesCommandInput, SearchCasesCommandOutput } from "./commands/SearchCasesCommand";
|
|
35
36
|
import { SearchRelatedItemsCommandInput, SearchRelatedItemsCommandOutput } from "./commands/SearchRelatedItemsCommand";
|
|
36
37
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
@@ -235,6 +236,12 @@ export interface ConnectCases {
|
|
|
235
236
|
putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutCaseEventConfigurationCommandOutput>;
|
|
236
237
|
putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void): void;
|
|
237
238
|
putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void): void;
|
|
239
|
+
/**
|
|
240
|
+
* @see {@link SearchAllRelatedItemsCommand}
|
|
241
|
+
*/
|
|
242
|
+
searchAllRelatedItems(args: SearchAllRelatedItemsCommandInput, options?: __HttpHandlerOptions): Promise<SearchAllRelatedItemsCommandOutput>;
|
|
243
|
+
searchAllRelatedItems(args: SearchAllRelatedItemsCommandInput, cb: (err: any, data?: SearchAllRelatedItemsCommandOutput) => void): void;
|
|
244
|
+
searchAllRelatedItems(args: SearchAllRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAllRelatedItemsCommandOutput) => void): void;
|
|
238
245
|
/**
|
|
239
246
|
* @see {@link SearchCasesCommand}
|
|
240
247
|
*/
|
|
@@ -39,6 +39,7 @@ import { ListLayoutsCommandInput, ListLayoutsCommandOutput } from "./commands/Li
|
|
|
39
39
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
40
40
|
import { ListTemplatesCommandInput, ListTemplatesCommandOutput } from "./commands/ListTemplatesCommand";
|
|
41
41
|
import { PutCaseEventConfigurationCommandInput, PutCaseEventConfigurationCommandOutput } from "./commands/PutCaseEventConfigurationCommand";
|
|
42
|
+
import { SearchAllRelatedItemsCommandInput, SearchAllRelatedItemsCommandOutput } from "./commands/SearchAllRelatedItemsCommand";
|
|
42
43
|
import { SearchCasesCommandInput, SearchCasesCommandOutput } from "./commands/SearchCasesCommand";
|
|
43
44
|
import { SearchRelatedItemsCommandInput, SearchRelatedItemsCommandOutput } from "./commands/SearchRelatedItemsCommand";
|
|
44
45
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
@@ -54,11 +55,11 @@ export { __Client };
|
|
|
54
55
|
/**
|
|
55
56
|
* @public
|
|
56
57
|
*/
|
|
57
|
-
export type ServiceInputTypes = BatchGetCaseRuleCommandInput | BatchGetFieldCommandInput | BatchPutFieldOptionsCommandInput | CreateCaseCommandInput | CreateCaseRuleCommandInput | CreateDomainCommandInput | CreateFieldCommandInput | CreateLayoutCommandInput | CreateRelatedItemCommandInput | CreateTemplateCommandInput | DeleteCaseCommandInput | DeleteCaseRuleCommandInput | DeleteDomainCommandInput | DeleteFieldCommandInput | DeleteLayoutCommandInput | DeleteRelatedItemCommandInput | DeleteTemplateCommandInput | GetCaseAuditEventsCommandInput | GetCaseCommandInput | GetCaseEventConfigurationCommandInput | GetDomainCommandInput | GetLayoutCommandInput | GetTemplateCommandInput | ListCaseRulesCommandInput | ListCasesForContactCommandInput | ListDomainsCommandInput | ListFieldOptionsCommandInput | ListFieldsCommandInput | ListLayoutsCommandInput | ListTagsForResourceCommandInput | ListTemplatesCommandInput | PutCaseEventConfigurationCommandInput | SearchCasesCommandInput | SearchRelatedItemsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCaseCommandInput | UpdateCaseRuleCommandInput | UpdateFieldCommandInput | UpdateLayoutCommandInput | UpdateTemplateCommandInput;
|
|
58
|
+
export type ServiceInputTypes = BatchGetCaseRuleCommandInput | BatchGetFieldCommandInput | BatchPutFieldOptionsCommandInput | CreateCaseCommandInput | CreateCaseRuleCommandInput | CreateDomainCommandInput | CreateFieldCommandInput | CreateLayoutCommandInput | CreateRelatedItemCommandInput | CreateTemplateCommandInput | DeleteCaseCommandInput | DeleteCaseRuleCommandInput | DeleteDomainCommandInput | DeleteFieldCommandInput | DeleteLayoutCommandInput | DeleteRelatedItemCommandInput | DeleteTemplateCommandInput | GetCaseAuditEventsCommandInput | GetCaseCommandInput | GetCaseEventConfigurationCommandInput | GetDomainCommandInput | GetLayoutCommandInput | GetTemplateCommandInput | ListCaseRulesCommandInput | ListCasesForContactCommandInput | ListDomainsCommandInput | ListFieldOptionsCommandInput | ListFieldsCommandInput | ListLayoutsCommandInput | ListTagsForResourceCommandInput | ListTemplatesCommandInput | PutCaseEventConfigurationCommandInput | SearchAllRelatedItemsCommandInput | SearchCasesCommandInput | SearchRelatedItemsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCaseCommandInput | UpdateCaseRuleCommandInput | UpdateFieldCommandInput | UpdateLayoutCommandInput | UpdateTemplateCommandInput;
|
|
58
59
|
/**
|
|
59
60
|
* @public
|
|
60
61
|
*/
|
|
61
|
-
export type ServiceOutputTypes = BatchGetCaseRuleCommandOutput | BatchGetFieldCommandOutput | BatchPutFieldOptionsCommandOutput | CreateCaseCommandOutput | CreateCaseRuleCommandOutput | CreateDomainCommandOutput | CreateFieldCommandOutput | CreateLayoutCommandOutput | CreateRelatedItemCommandOutput | CreateTemplateCommandOutput | DeleteCaseCommandOutput | DeleteCaseRuleCommandOutput | DeleteDomainCommandOutput | DeleteFieldCommandOutput | DeleteLayoutCommandOutput | DeleteRelatedItemCommandOutput | DeleteTemplateCommandOutput | GetCaseAuditEventsCommandOutput | GetCaseCommandOutput | GetCaseEventConfigurationCommandOutput | GetDomainCommandOutput | GetLayoutCommandOutput | GetTemplateCommandOutput | ListCaseRulesCommandOutput | ListCasesForContactCommandOutput | ListDomainsCommandOutput | ListFieldOptionsCommandOutput | ListFieldsCommandOutput | ListLayoutsCommandOutput | ListTagsForResourceCommandOutput | ListTemplatesCommandOutput | PutCaseEventConfigurationCommandOutput | SearchCasesCommandOutput | SearchRelatedItemsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCaseCommandOutput | UpdateCaseRuleCommandOutput | UpdateFieldCommandOutput | UpdateLayoutCommandOutput | UpdateTemplateCommandOutput;
|
|
62
|
+
export type ServiceOutputTypes = BatchGetCaseRuleCommandOutput | BatchGetFieldCommandOutput | BatchPutFieldOptionsCommandOutput | CreateCaseCommandOutput | CreateCaseRuleCommandOutput | CreateDomainCommandOutput | CreateFieldCommandOutput | CreateLayoutCommandOutput | CreateRelatedItemCommandOutput | CreateTemplateCommandOutput | DeleteCaseCommandOutput | DeleteCaseRuleCommandOutput | DeleteDomainCommandOutput | DeleteFieldCommandOutput | DeleteLayoutCommandOutput | DeleteRelatedItemCommandOutput | DeleteTemplateCommandOutput | GetCaseAuditEventsCommandOutput | GetCaseCommandOutput | GetCaseEventConfigurationCommandOutput | GetDomainCommandOutput | GetLayoutCommandOutput | GetTemplateCommandOutput | ListCaseRulesCommandOutput | ListCasesForContactCommandOutput | ListDomainsCommandOutput | ListFieldOptionsCommandOutput | ListFieldsCommandOutput | ListLayoutsCommandOutput | ListTagsForResourceCommandOutput | ListTemplatesCommandOutput | PutCaseEventConfigurationCommandOutput | SearchAllRelatedItemsCommandOutput | SearchCasesCommandOutput | SearchRelatedItemsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCaseCommandOutput | UpdateCaseRuleCommandOutput | UpdateFieldCommandOutput | UpdateLayoutCommandOutput | UpdateTemplateCommandOutput;
|
|
62
63
|
/**
|
|
63
64
|
* @public
|
|
64
65
|
*/
|
|
@@ -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";
|