@aws-sdk/client-connectcases 3.321.1 → 3.326.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.
Files changed (31) hide show
  1. package/dist-types/commands/BatchGetFieldCommand.d.ts +25 -0
  2. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +12 -0
  3. package/dist-types/commands/CreateCaseCommand.d.ts +7 -0
  4. package/dist-types/commands/CreateDomainCommand.d.ts +8 -0
  5. package/dist-types/commands/CreateFieldCommand.d.ts +7 -0
  6. package/dist-types/commands/CreateLayoutCommand.d.ts +7 -0
  7. package/dist-types/commands/CreateRelatedItemCommand.d.ts +7 -0
  8. package/dist-types/commands/CreateTemplateCommand.d.ts +7 -0
  9. package/dist-types/commands/DeleteDomainCommand.d.ts +4 -0
  10. package/dist-types/commands/GetCaseCommand.d.ts +20 -0
  11. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +20 -0
  12. package/dist-types/commands/GetDomainCommand.d.ts +13 -0
  13. package/dist-types/commands/GetLayoutCommand.d.ts +43 -0
  14. package/dist-types/commands/GetTemplateCommand.d.ts +21 -0
  15. package/dist-types/commands/ListCasesForContactCommand.d.ts +12 -0
  16. package/dist-types/commands/ListDomainsCommand.d.ts +13 -0
  17. package/dist-types/commands/ListFieldOptionsCommand.d.ts +13 -0
  18. package/dist-types/commands/ListFieldsCommand.d.ts +15 -0
  19. package/dist-types/commands/ListLayoutsCommand.d.ts +13 -0
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  21. package/dist-types/commands/ListTemplatesCommand.d.ts +14 -0
  22. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +4 -0
  23. package/dist-types/commands/SearchCasesCommand.d.ts +25 -0
  24. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +27 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  27. package/dist-types/commands/UpdateCaseCommand.d.ts +4 -0
  28. package/dist-types/commands/UpdateFieldCommand.d.ts +4 -0
  29. package/dist-types/commands/UpdateLayoutCommand.d.ts +4 -0
  30. package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -0
  31. package/package.json +16 -16
@@ -36,6 +36,29 @@ export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __Met
36
36
  * };
37
37
  * const command = new BatchGetFieldCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // BatchGetFieldResponse
40
+ * // fields: [ // BatchGetFieldList // required
41
+ * // { // GetFieldResponse
42
+ * // fieldId: "STRING_VALUE", // required
43
+ * // name: "STRING_VALUE", // required
44
+ * // fieldArn: "STRING_VALUE", // required
45
+ * // description: "STRING_VALUE",
46
+ * // type: "STRING_VALUE", // required
47
+ * // namespace: "STRING_VALUE", // required
48
+ * // tags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // },
52
+ * // ],
53
+ * // errors: [ // BatchGetFieldErrorList // required
54
+ * // { // FieldError
55
+ * // id: "STRING_VALUE", // required
56
+ * // errorCode: "STRING_VALUE", // required
57
+ * // message: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
39
62
  * ```
40
63
  *
41
64
  * @param BatchGetFieldCommandInput - {@link BatchGetFieldCommandInput}
@@ -61,6 +84,8 @@ export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __Met
61
84
  * @throws {@link ValidationException} (client fault)
62
85
  * <p>The request isn't valid. Check the syntax and try again.</p>
63
86
  *
87
+ * @throws {@link ConnectCasesServiceException}
88
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
64
89
  *
65
90
  */
66
91
  export declare class BatchGetFieldCommand extends $Command<BatchGetFieldCommandInput, BatchGetFieldCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -40,6 +40,16 @@ export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsR
40
40
  * };
41
41
  * const command = new BatchPutFieldOptionsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // BatchPutFieldOptionsResponse
44
+ * // errors: [ // FieldOptionErrorList
45
+ * // { // FieldOptionError
46
+ * // message: "STRING_VALUE", // required
47
+ * // errorCode: "STRING_VALUE", // required
48
+ * // value: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
43
53
  * ```
44
54
  *
45
55
  * @param BatchPutFieldOptionsCommandInput - {@link BatchPutFieldOptionsCommandInput}
@@ -69,6 +79,8 @@ export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsR
69
79
  * @throws {@link ValidationException} (client fault)
70
80
  * <p>The request isn't valid. Check the syntax and try again.</p>
71
81
  *
82
+ * @throws {@link ConnectCasesServiceException}
83
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
72
84
  *
73
85
  */
74
86
  export declare class BatchPutFieldOptionsCommand extends $Command<BatchPutFieldOptionsCommandInput, BatchPutFieldOptionsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -63,6 +63,11 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
63
63
  * };
64
64
  * const command = new CreateCaseCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // { // CreateCaseResponse
67
+ * // caseId: "STRING_VALUE", // required
68
+ * // caseArn: "STRING_VALUE", // required
69
+ * // };
70
+ *
66
71
  * ```
67
72
  *
68
73
  * @param CreateCaseCommandInput - {@link CreateCaseCommandInput}
@@ -93,6 +98,8 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
93
98
  * @throws {@link ValidationException} (client fault)
94
99
  * <p>The request isn't valid. Check the syntax and try again.</p>
95
100
  *
101
+ * @throws {@link ConnectCasesServiceException}
102
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
96
103
  *
97
104
  */
98
105
  export declare class CreateCaseCommand extends $Command<CreateCaseCommandInput, CreateCaseCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -40,6 +40,12 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
40
40
  * };
41
41
  * const command = new CreateDomainCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // CreateDomainResponse
44
+ * // domainId: "STRING_VALUE", // required
45
+ * // domainArn: "STRING_VALUE", // required
46
+ * // domainStatus: "STRING_VALUE", // required
47
+ * // };
48
+ *
43
49
  * ```
44
50
  *
45
51
  * @param CreateDomainCommandInput - {@link CreateDomainCommandInput}
@@ -70,6 +76,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
70
76
  * @throws {@link ValidationException} (client fault)
71
77
  * <p>The request isn't valid. Check the syntax and try again.</p>
72
78
  *
79
+ * @throws {@link ConnectCasesServiceException}
80
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
73
81
  *
74
82
  */
75
83
  export declare class CreateDomainCommand extends $Command<CreateDomainCommandInput, CreateDomainCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -35,6 +35,11 @@ export interface CreateFieldCommandOutput extends CreateFieldResponse, __Metadat
35
35
  * };
36
36
  * const command = new CreateFieldCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreateFieldResponse
39
+ * // fieldId: "STRING_VALUE", // required
40
+ * // fieldArn: "STRING_VALUE", // required
41
+ * // };
42
+ *
38
43
  * ```
39
44
  *
40
45
  * @param CreateFieldCommandInput - {@link CreateFieldCommandInput}
@@ -69,6 +74,8 @@ export interface CreateFieldCommandOutput extends CreateFieldResponse, __Metadat
69
74
  * @throws {@link ValidationException} (client fault)
70
75
  * <p>The request isn't valid. Check the syntax and try again.</p>
71
76
  *
77
+ * @throws {@link ConnectCasesServiceException}
78
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
72
79
  *
73
80
  */
74
81
  export declare class CreateFieldCommand extends $Command<CreateFieldCommandInput, CreateFieldCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -77,6 +77,11 @@ export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __Metad
77
77
  * };
78
78
  * const command = new CreateLayoutCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // CreateLayoutResponse
81
+ * // layoutId: "STRING_VALUE", // required
82
+ * // layoutArn: "STRING_VALUE", // required
83
+ * // };
84
+ *
80
85
  * ```
81
86
  *
82
87
  * @param CreateLayoutCommandInput - {@link CreateLayoutCommandInput}
@@ -111,6 +116,8 @@ export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __Metad
111
116
  * @throws {@link ValidationException} (client fault)
112
117
  * <p>The request isn't valid. Check the syntax and try again.</p>
113
118
  *
119
+ * @throws {@link ConnectCasesServiceException}
120
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
114
121
  *
115
122
  */
116
123
  export declare class CreateLayoutCommand extends $Command<CreateLayoutCommandInput, CreateLayoutCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -50,6 +50,11 @@ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemRespons
50
50
  * };
51
51
  * const command = new CreateRelatedItemCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // CreateRelatedItemResponse
54
+ * // relatedItemId: "STRING_VALUE", // required
55
+ * // relatedItemArn: "STRING_VALUE", // required
56
+ * // };
57
+ *
53
58
  * ```
54
59
  *
55
60
  * @param CreateRelatedItemCommandInput - {@link CreateRelatedItemCommandInput}
@@ -79,6 +84,8 @@ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemRespons
79
84
  * @throws {@link ValidationException} (client fault)
80
85
  * <p>The request isn't valid. Check the syntax and try again.</p>
81
86
  *
87
+ * @throws {@link ConnectCasesServiceException}
88
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
82
89
  *
83
90
  */
84
91
  export declare class CreateRelatedItemCommand extends $Command<CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -47,6 +47,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
47
47
  * };
48
48
  * const command = new CreateTemplateCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // CreateTemplateResponse
51
+ * // templateId: "STRING_VALUE", // required
52
+ * // templateArn: "STRING_VALUE", // required
53
+ * // };
54
+ *
50
55
  * ```
51
56
  *
52
57
  * @param CreateTemplateCommandInput - {@link CreateTemplateCommandInput}
@@ -81,6 +86,8 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
81
86
  * @throws {@link ValidationException} (client fault)
82
87
  * <p>The request isn't valid. Check the syntax and try again.</p>
83
88
  *
89
+ * @throws {@link ConnectCasesServiceException}
90
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
84
91
  *
85
92
  */
86
93
  export declare class CreateTemplateCommand extends $Command<CreateTemplateCommandInput, CreateTemplateCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
31
31
  * };
32
32
  * const command = new DeleteDomainCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteDomainCommandInput - {@link DeleteDomainCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
61
63
  * @throws {@link ValidationException} (client fault)
62
64
  * <p>The request isn't valid. Check the syntax and try again.</p>
63
65
  *
66
+ * @throws {@link ConnectCasesServiceException}
67
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
64
68
  *
65
69
  */
66
70
  export declare class DeleteDomainCommand extends $Command<DeleteDomainCommandInput, DeleteDomainCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -38,6 +38,24 @@ export interface GetCaseCommandOutput extends GetCaseResponse, __MetadataBearer
38
38
  * };
39
39
  * const command = new GetCaseCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // GetCaseResponse
42
+ * // fields: [ // FieldValueList // required
43
+ * // { // FieldValue
44
+ * // id: "STRING_VALUE", // required
45
+ * // value: { // FieldValueUnion Union: only one key present
46
+ * // stringValue: "STRING_VALUE",
47
+ * // doubleValue: Number("double"),
48
+ * // booleanValue: true || false,
49
+ * // },
50
+ * // },
51
+ * // ],
52
+ * // templateId: "STRING_VALUE", // required
53
+ * // nextToken: "STRING_VALUE",
54
+ * // tags: { // Tags
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // };
58
+ *
41
59
  * ```
42
60
  *
43
61
  * @param GetCaseCommandInput - {@link GetCaseCommandInput}
@@ -63,6 +81,8 @@ export interface GetCaseCommandOutput extends GetCaseResponse, __MetadataBearer
63
81
  * @throws {@link ValidationException} (client fault)
64
82
  * <p>The request isn't valid. Check the syntax and try again.</p>
65
83
  *
84
+ * @throws {@link ConnectCasesServiceException}
85
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
66
86
  *
67
87
  */
68
88
  export declare class GetCaseCommand extends $Command<GetCaseCommandInput, GetCaseCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -31,6 +31,24 @@ export interface GetCaseEventConfigurationCommandOutput extends GetCaseEventConf
31
31
  * };
32
32
  * const command = new GetCaseEventConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCaseEventConfigurationResponse
35
+ * // eventBridge: { // EventBridgeConfiguration
36
+ * // enabled: true || false, // required
37
+ * // includedData: { // EventIncludedData
38
+ * // caseData: { // CaseEventIncludedData
39
+ * // fields: [ // FieldIdentifierList // required
40
+ * // { // FieldIdentifier
41
+ * // id: "STRING_VALUE", // required
42
+ * // },
43
+ * // ],
44
+ * // },
45
+ * // relatedItemData: { // RelatedItemEventIncludedData
46
+ * // includeContent: true || false, // required
47
+ * // },
48
+ * // },
49
+ * // },
50
+ * // };
51
+ *
34
52
  * ```
35
53
  *
36
54
  * @param GetCaseEventConfigurationCommandInput - {@link GetCaseEventConfigurationCommandInput}
@@ -56,6 +74,8 @@ export interface GetCaseEventConfigurationCommandOutput extends GetCaseEventConf
56
74
  * @throws {@link ValidationException} (client fault)
57
75
  * <p>The request isn't valid. Check the syntax and try again.</p>
58
76
  *
77
+ * @throws {@link ConnectCasesServiceException}
78
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
59
79
  *
60
80
  */
61
81
  export declare class GetCaseEventConfigurationCommand extends $Command<GetCaseEventConfigurationCommandInput, GetCaseEventConfigurationCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -31,6 +31,17 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
31
31
  * };
32
32
  * const command = new GetDomainCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDomainResponse
35
+ * // domainId: "STRING_VALUE", // required
36
+ * // domainArn: "STRING_VALUE", // required
37
+ * // name: "STRING_VALUE", // required
38
+ * // createdTime: new Date("TIMESTAMP"), // required
39
+ * // domainStatus: "STRING_VALUE", // required
40
+ * // tags: { // Tags
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetDomainCommandInput - {@link GetDomainCommandInput}
@@ -56,6 +67,8 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
56
67
  * @throws {@link ValidationException} (client fault)
57
68
  * <p>The request isn't valid. Check the syntax and try again.</p>
58
69
  *
70
+ * @throws {@link ConnectCasesServiceException}
71
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
59
72
  *
60
73
  */
61
74
  export declare class GetDomainCommand extends $Command<GetDomainCommandInput, GetDomainCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -32,6 +32,47 @@ export interface GetLayoutCommandOutput extends GetLayoutResponse, __MetadataBea
32
32
  * };
33
33
  * const command = new GetLayoutCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetLayoutResponse
36
+ * // layoutId: "STRING_VALUE", // required
37
+ * // layoutArn: "STRING_VALUE", // required
38
+ * // name: "STRING_VALUE", // required
39
+ * // content: { // LayoutContent Union: only one key present
40
+ * // basic: { // BasicLayout
41
+ * // topPanel: { // LayoutSections
42
+ * // sections: [ // SectionsList
43
+ * // { // Section Union: only one key present
44
+ * // fieldGroup: { // FieldGroup
45
+ * // name: "STRING_VALUE",
46
+ * // fields: [ // FieldList // required
47
+ * // { // FieldItem
48
+ * // id: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // },
55
+ * // moreInfo: {
56
+ * // sections: [
57
+ * // {// Union: only one key present
58
+ * // fieldGroup: {
59
+ * // name: "STRING_VALUE",
60
+ * // fields: [ // required
61
+ * // {
62
+ * // id: "STRING_VALUE", // required
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // },
70
+ * // },
71
+ * // tags: { // Tags
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // };
75
+ *
35
76
  * ```
36
77
  *
37
78
  * @param GetLayoutCommandInput - {@link GetLayoutCommandInput}
@@ -57,6 +98,8 @@ export interface GetLayoutCommandOutput extends GetLayoutResponse, __MetadataBea
57
98
  * @throws {@link ValidationException} (client fault)
58
99
  * <p>The request isn't valid. Check the syntax and try again.</p>
59
100
  *
101
+ * @throws {@link ConnectCasesServiceException}
102
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
60
103
  *
61
104
  */
62
105
  export declare class GetLayoutCommand extends $Command<GetLayoutCommandInput, GetLayoutCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface GetTemplateCommandOutput extends GetTemplateResponse, __Metadat
32
32
  * };
33
33
  * const command = new GetTemplateCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetTemplateResponse
36
+ * // templateId: "STRING_VALUE", // required
37
+ * // templateArn: "STRING_VALUE", // required
38
+ * // name: "STRING_VALUE", // required
39
+ * // description: "STRING_VALUE",
40
+ * // layoutConfiguration: { // LayoutConfiguration
41
+ * // defaultLayout: "STRING_VALUE",
42
+ * // },
43
+ * // requiredFields: [ // RequiredFieldList
44
+ * // { // RequiredField
45
+ * // fieldId: "STRING_VALUE", // required
46
+ * // },
47
+ * // ],
48
+ * // tags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // status: "STRING_VALUE", // required
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param GetTemplateCommandInput - {@link GetTemplateCommandInput}
@@ -57,6 +76,8 @@ export interface GetTemplateCommandOutput extends GetTemplateResponse, __Metadat
57
76
  * @throws {@link ValidationException} (client fault)
58
77
  * <p>The request isn't valid. Check the syntax and try again.</p>
59
78
  *
79
+ * @throws {@link ConnectCasesServiceException}
80
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
60
81
  *
61
82
  */
62
83
  export declare class GetTemplateCommand extends $Command<GetTemplateCommandInput, GetTemplateCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -34,6 +34,16 @@ export interface ListCasesForContactCommandOutput extends ListCasesForContactRes
34
34
  * };
35
35
  * const command = new ListCasesForContactCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListCasesForContactResponse
38
+ * // cases: [ // CaseSummaryList // required
39
+ * // { // CaseSummary
40
+ * // caseId: "STRING_VALUE", // required
41
+ * // templateId: "STRING_VALUE", // required
42
+ * // },
43
+ * // ],
44
+ * // nextToken: "STRING_VALUE",
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param ListCasesForContactCommandInput - {@link ListCasesForContactCommandInput}
@@ -59,6 +69,8 @@ export interface ListCasesForContactCommandOutput extends ListCasesForContactRes
59
69
  * @throws {@link ValidationException} (client fault)
60
70
  * <p>The request isn't valid. Check the syntax and try again.</p>
61
71
  *
72
+ * @throws {@link ConnectCasesServiceException}
73
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
62
74
  *
63
75
  */
64
76
  export declare class ListCasesForContactCommand extends $Command<ListCasesForContactCommandInput, ListCasesForContactCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat
33
33
  * };
34
34
  * const command = new ListDomainsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListDomainsResponse
37
+ * // domains: [ // DomainSummaryList // required
38
+ * // { // DomainSummary
39
+ * // domainId: "STRING_VALUE", // required
40
+ * // domainArn: "STRING_VALUE", // required
41
+ * // name: "STRING_VALUE", // required
42
+ * // },
43
+ * // ],
44
+ * // nextToken: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param ListDomainsCommandInput - {@link ListDomainsCommandInput}
@@ -54,6 +65,8 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat
54
65
  * @throws {@link ValidationException} (client fault)
55
66
  * <p>The request isn't valid. Check the syntax and try again.</p>
56
67
  *
68
+ * @throws {@link ConnectCasesServiceException}
69
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
57
70
  *
58
71
  */
59
72
  export declare class ListDomainsCommand extends $Command<ListDomainsCommandInput, ListDomainsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -37,6 +37,17 @@ export interface ListFieldOptionsCommandOutput extends ListFieldOptionsResponse,
37
37
  * };
38
38
  * const command = new ListFieldOptionsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListFieldOptionsResponse
41
+ * // options: [ // FieldOptionsList // required
42
+ * // { // FieldOption
43
+ * // name: "STRING_VALUE", // required
44
+ * // value: "STRING_VALUE", // required
45
+ * // active: true || false, // required
46
+ * // },
47
+ * // ],
48
+ * // nextToken: "STRING_VALUE",
49
+ * // };
50
+ *
40
51
  * ```
41
52
  *
42
53
  * @param ListFieldOptionsCommandInput - {@link ListFieldOptionsCommandInput}
@@ -62,6 +73,8 @@ export interface ListFieldOptionsCommandOutput extends ListFieldOptionsResponse,
62
73
  * @throws {@link ValidationException} (client fault)
63
74
  * <p>The request isn't valid. Check the syntax and try again.</p>
64
75
  *
76
+ * @throws {@link ConnectCasesServiceException}
77
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
65
78
  *
66
79
  */
67
80
  export declare class ListFieldOptionsCommand extends $Command<ListFieldOptionsCommandInput, ListFieldOptionsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListFieldsCommandOutput extends ListFieldsResponse, __MetadataB
33
33
  * };
34
34
  * const command = new ListFieldsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListFieldsResponse
37
+ * // fields: [ // FieldSummaryList // required
38
+ * // { // FieldSummary
39
+ * // fieldId: "STRING_VALUE", // required
40
+ * // fieldArn: "STRING_VALUE", // required
41
+ * // name: "STRING_VALUE", // required
42
+ * // type: "STRING_VALUE", // required
43
+ * // namespace: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListFieldsCommandInput - {@link ListFieldsCommandInput}
@@ -58,6 +71,8 @@ export interface ListFieldsCommandOutput extends ListFieldsResponse, __MetadataB
58
71
  * @throws {@link ValidationException} (client fault)
59
72
  * <p>The request isn't valid. Check the syntax and try again.</p>
60
73
  *
74
+ * @throws {@link ConnectCasesServiceException}
75
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
61
76
  *
62
77
  */
63
78
  export declare class ListFieldsCommand extends $Command<ListFieldsCommandInput, ListFieldsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -34,6 +34,17 @@ export interface ListLayoutsCommandOutput extends ListLayoutsResponse, __Metadat
34
34
  * };
35
35
  * const command = new ListLayoutsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListLayoutsResponse
38
+ * // layouts: [ // LayoutSummaryList // required
39
+ * // { // LayoutSummary
40
+ * // layoutId: "STRING_VALUE", // required
41
+ * // layoutArn: "STRING_VALUE", // required
42
+ * // name: "STRING_VALUE", // required
43
+ * // },
44
+ * // ],
45
+ * // nextToken: "STRING_VALUE",
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param ListLayoutsCommandInput - {@link ListLayoutsCommandInput}
@@ -59,6 +70,8 @@ export interface ListLayoutsCommandOutput extends ListLayoutsResponse, __Metadat
59
70
  * @throws {@link ValidationException} (client fault)
60
71
  * <p>The request isn't valid. Check the syntax and try again.</p>
61
72
  *
73
+ * @throws {@link ConnectCasesServiceException}
74
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
62
75
  *
63
76
  */
64
77
  export declare class ListLayoutsCommand extends $Command<ListLayoutsCommandInput, ListLayoutsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // Tags
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -56,6 +62,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
56
62
  * @throws {@link ValidationException} (client fault)
57
63
  * <p>The request isn't valid. Check the syntax and try again.</p>
58
64
  *
65
+ * @throws {@link ConnectCasesServiceException}
66
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
59
67
  *
60
68
  */
61
69
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -37,6 +37,18 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
37
37
  * };
38
38
  * const command = new ListTemplatesCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListTemplatesResponse
41
+ * // templates: [ // TemplateSummaryList // required
42
+ * // { // TemplateSummary
43
+ * // templateId: "STRING_VALUE", // required
44
+ * // templateArn: "STRING_VALUE", // required
45
+ * // name: "STRING_VALUE", // required
46
+ * // status: "STRING_VALUE", // required
47
+ * // },
48
+ * // ],
49
+ * // nextToken: "STRING_VALUE",
50
+ * // };
51
+ *
40
52
  * ```
41
53
  *
42
54
  * @param ListTemplatesCommandInput - {@link ListTemplatesCommandInput}
@@ -62,6 +74,8 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
62
74
  * @throws {@link ValidationException} (client fault)
63
75
  * <p>The request isn't valid. Check the syntax and try again.</p>
64
76
  *
77
+ * @throws {@link ConnectCasesServiceException}
78
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
65
79
  *
66
80
  */
67
81
  export declare class ListTemplatesCommand extends $Command<ListTemplatesCommandInput, ListTemplatesCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface PutCaseEventConfigurationCommandOutput extends PutCaseEventConf
46
46
  * };
47
47
  * const command = new PutCaseEventConfigurationCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param PutCaseEventConfigurationCommandInput - {@link PutCaseEventConfigurationCommandInput}
@@ -71,6 +73,8 @@ export interface PutCaseEventConfigurationCommandOutput extends PutCaseEventConf
71
73
  * @throws {@link ValidationException} (client fault)
72
74
  * <p>The request isn't valid. Check the syntax and try again.</p>
73
75
  *
76
+ * @throws {@link ConnectCasesServiceException}
77
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
74
78
  *
75
79
  */
76
80
  export declare class PutCaseEventConfigurationCommand extends $Command<PutCaseEventConfigurationCommandInput, PutCaseEventConfigurationCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -113,6 +113,29 @@ export interface SearchCasesCommandOutput extends SearchCasesResponse, __Metadat
113
113
  * };
114
114
  * const command = new SearchCasesCommand(input);
115
115
  * const response = await client.send(command);
116
+ * // { // SearchCasesResponse
117
+ * // nextToken: "STRING_VALUE",
118
+ * // cases: [ // SearchCasesResponseItemList // required
119
+ * // { // SearchCasesResponseItem
120
+ * // caseId: "STRING_VALUE", // required
121
+ * // templateId: "STRING_VALUE", // required
122
+ * // fields: [ // FieldValueList // required
123
+ * // { // FieldValue
124
+ * // id: "STRING_VALUE", // required
125
+ * // value: { // FieldValueUnion Union: only one key present
126
+ * // stringValue: "STRING_VALUE",
127
+ * // doubleValue: Number("double"),
128
+ * // booleanValue: true || false,
129
+ * // },
130
+ * // },
131
+ * // ],
132
+ * // tags: { // Tags
133
+ * // "<keys>": "STRING_VALUE",
134
+ * // },
135
+ * // },
136
+ * // ],
137
+ * // };
138
+ *
116
139
  * ```
117
140
  *
118
141
  * @param SearchCasesCommandInput - {@link SearchCasesCommandInput}
@@ -138,6 +161,8 @@ export interface SearchCasesCommandOutput extends SearchCasesResponse, __Metadat
138
161
  * @throws {@link ValidationException} (client fault)
139
162
  * <p>The request isn't valid. Check the syntax and try again.</p>
140
163
  *
164
+ * @throws {@link ConnectCasesServiceException}
165
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
141
166
  *
142
167
  */
143
168
  export declare class SearchCasesCommand extends $Command<SearchCasesCommandInput, SearchCasesCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -49,6 +49,31 @@ export interface SearchRelatedItemsCommandOutput extends SearchRelatedItemsRespo
49
49
  * };
50
50
  * const command = new SearchRelatedItemsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // SearchRelatedItemsResponse
53
+ * // nextToken: "STRING_VALUE",
54
+ * // relatedItems: [ // SearchRelatedItemsResponseItemList // required
55
+ * // { // SearchRelatedItemsResponseItem
56
+ * // relatedItemId: "STRING_VALUE", // required
57
+ * // type: "STRING_VALUE", // required
58
+ * // associationTime: new Date("TIMESTAMP"), // required
59
+ * // content: { // RelatedItemContent Union: only one key present
60
+ * // contact: { // ContactContent
61
+ * // contactArn: "STRING_VALUE", // required
62
+ * // channel: "STRING_VALUE", // required
63
+ * // connectedToSystemTime: new Date("TIMESTAMP"), // required
64
+ * // },
65
+ * // comment: { // CommentContent
66
+ * // body: "STRING_VALUE", // required
67
+ * // contentType: "STRING_VALUE", // required
68
+ * // },
69
+ * // },
70
+ * // tags: { // Tags
71
+ * // "<keys>": "STRING_VALUE",
72
+ * // },
73
+ * // },
74
+ * // ],
75
+ * // };
76
+ *
52
77
  * ```
53
78
  *
54
79
  * @param SearchRelatedItemsCommandInput - {@link SearchRelatedItemsCommandInput}
@@ -74,6 +99,8 @@ export interface SearchRelatedItemsCommandOutput extends SearchRelatedItemsRespo
74
99
  * @throws {@link ValidationException} (client fault)
75
100
  * <p>The request isn't valid. Check the syntax and try again.</p>
76
101
  *
102
+ * @throws {@link ConnectCasesServiceException}
103
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
77
104
  *
78
105
  */
79
106
  export declare class SearchRelatedItemsCommand extends $Command<SearchRelatedItemsCommandInput, SearchRelatedItemsCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -59,6 +61,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
59
61
  * @throws {@link ValidationException} (client fault)
60
62
  * <p>The request isn't valid. Check the syntax and try again.</p>
61
63
  *
64
+ * @throws {@link ConnectCasesServiceException}
65
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
62
66
  *
63
67
  */
64
68
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -59,6 +61,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
59
61
  * @throws {@link ValidationException} (client fault)
60
62
  * <p>The request isn't valid. Check the syntax and try again.</p>
61
63
  *
64
+ * @throws {@link ConnectCasesServiceException}
65
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
62
66
  *
63
67
  */
64
68
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataB
45
45
  * };
46
46
  * const command = new UpdateCaseCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param UpdateCaseCommandInput - {@link UpdateCaseCommandInput}
@@ -70,6 +72,8 @@ export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataB
70
72
  * @throws {@link ValidationException} (client fault)
71
73
  * <p>The request isn't valid. Check the syntax and try again.</p>
72
74
  *
75
+ * @throws {@link ConnectCasesServiceException}
76
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
73
77
  *
74
78
  */
75
79
  export declare class UpdateCaseCommand extends $Command<UpdateCaseCommandInput, UpdateCaseCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UpdateFieldCommandOutput extends UpdateFieldResponse, __Metadat
34
34
  * };
35
35
  * const command = new UpdateFieldCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UpdateFieldCommandInput - {@link UpdateFieldCommandInput}
@@ -64,6 +66,8 @@ export interface UpdateFieldCommandOutput extends UpdateFieldResponse, __Metadat
64
66
  * @throws {@link ValidationException} (client fault)
65
67
  * <p>The request isn't valid. Check the syntax and try again.</p>
66
68
  *
69
+ * @throws {@link ConnectCasesServiceException}
70
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
67
71
  *
68
72
  */
69
73
  export declare class UpdateFieldCommand extends $Command<UpdateFieldCommandInput, UpdateFieldCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -73,6 +73,8 @@ export interface UpdateLayoutCommandOutput extends UpdateLayoutResponse, __Metad
73
73
  * };
74
74
  * const command = new UpdateLayoutCommand(input);
75
75
  * const response = await client.send(command);
76
+ * // {};
77
+ *
76
78
  * ```
77
79
  *
78
80
  * @param UpdateLayoutCommandInput - {@link UpdateLayoutCommandInput}
@@ -107,6 +109,8 @@ export interface UpdateLayoutCommandOutput extends UpdateLayoutResponse, __Metad
107
109
  * @throws {@link ValidationException} (client fault)
108
110
  * <p>The request isn't valid. Check the syntax and try again.</p>
109
111
  *
112
+ * @throws {@link ConnectCasesServiceException}
113
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
110
114
  *
111
115
  */
112
116
  export declare class UpdateLayoutCommand extends $Command<UpdateLayoutCommandInput, UpdateLayoutCommandOutput, ConnectCasesClientResolvedConfig> {
@@ -47,6 +47,8 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
47
47
  * };
48
48
  * const command = new UpdateTemplateCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // {};
51
+ *
50
52
  * ```
51
53
  *
52
54
  * @param UpdateTemplateCommandInput - {@link UpdateTemplateCommandInput}
@@ -77,6 +79,8 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
77
79
  * @throws {@link ValidationException} (client fault)
78
80
  * <p>The request isn't valid. Check the syntax and try again.</p>
79
81
  *
82
+ * @throws {@link ConnectCasesServiceException}
83
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
80
84
  *
81
85
  */
82
86
  export declare class UpdateTemplateCommand extends $Command<UpdateTemplateCommandInput, UpdateTemplateCommandOutput, ConnectCasesClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connectcases",
3
3
  "description": "AWS SDK for JavaScript Connectcases Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",