@aws-sdk/client-connectcases 3.921.0 → 3.922.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/dist-cjs/index.js CHANGED
@@ -380,10 +380,16 @@ exports.CaseRuleDetails = void 0;
380
380
  CaseRuleDetails.visit = (value, visitor) => {
381
381
  if (value.required !== undefined)
382
382
  return visitor.required(value.required);
383
+ if (value.fieldOptions !== undefined)
384
+ return visitor.fieldOptions(value.fieldOptions);
385
+ if (value.hidden !== undefined)
386
+ return visitor.hidden(value.hidden);
383
387
  return visitor._(value.$unknown[0], value.$unknown[1]);
384
388
  };
385
389
  })(exports.CaseRuleDetails || (exports.CaseRuleDetails = {}));
386
390
  const RuleType = {
391
+ FIELD_OPTIONS: "FieldOptions",
392
+ HIDDEN: "Hidden",
387
393
  REQUIRED: "Required",
388
394
  };
389
395
  const DomainStatus = {
@@ -1203,6 +1209,7 @@ const de_BatchGetCaseRuleCommand = async (output, context) => {
1203
1209
  const doc = smithyClient.take(data, {
1204
1210
  caseRules: (_) => de_BatchGetCaseRuleList(_),
1205
1211
  errors: smithyClient._json,
1212
+ unprocessedCaseRules: smithyClient._json,
1206
1213
  });
1207
1214
  Object.assign(contents, doc);
1208
1215
  return contents;
@@ -1939,6 +1946,8 @@ const se_CaseFilterList = (input, context) => {
1939
1946
  };
1940
1947
  const se_CaseRuleDetails = (input, context) => {
1941
1948
  return exports.CaseRuleDetails.visit(input, {
1949
+ fieldOptions: (value) => ({ fieldOptions: smithyClient._json(value) }),
1950
+ hidden: (value) => ({ hidden: se_HiddenCaseRule(value) }),
1942
1951
  required: (value) => ({ required: se_RequiredCaseRule(value) }),
1943
1952
  _: (name, value) => ({ [name]: value }),
1944
1953
  });
@@ -2003,6 +2012,12 @@ const se_FieldValueUnion = (input, context) => {
2003
2012
  _: (name, value) => ({ [name]: value }),
2004
2013
  });
2005
2014
  };
2015
+ const se_HiddenCaseRule = (input, context) => {
2016
+ return smithyClient.take(input, {
2017
+ conditions: (_) => se_BooleanConditionList(_),
2018
+ defaultValue: [],
2019
+ });
2020
+ };
2006
2021
  const se_OperandTwo = (input, context) => {
2007
2022
  return exports.OperandTwo.visit(input, {
2008
2023
  booleanValue: (value) => ({ booleanValue: value }),
@@ -2179,6 +2194,16 @@ const de_BooleanOperands = (output, context) => {
2179
2194
  });
2180
2195
  };
2181
2196
  const de_CaseRuleDetails = (output, context) => {
2197
+ if (output.fieldOptions != null) {
2198
+ return {
2199
+ fieldOptions: smithyClient._json(output.fieldOptions),
2200
+ };
2201
+ }
2202
+ if (output.hidden != null) {
2203
+ return {
2204
+ hidden: de_HiddenCaseRule(output.hidden),
2205
+ };
2206
+ }
2182
2207
  if (output.required != null) {
2183
2208
  return {
2184
2209
  required: de_RequiredCaseRule(output.required),
@@ -2259,6 +2284,12 @@ const de_GetFieldResponse = (output, context) => {
2259
2284
  type: smithyClient.expectString,
2260
2285
  });
2261
2286
  };
2287
+ const de_HiddenCaseRule = (output, context) => {
2288
+ return smithyClient.take(output, {
2289
+ conditions: (_) => de_BooleanConditionList(_),
2290
+ defaultValue: smithyClient.expectBoolean,
2291
+ });
2292
+ };
2262
2293
  const de_OperandTwo = (output, context) => {
2263
2294
  if (smithyClient.expectBoolean(output.booleanValue) !== undefined) {
2264
2295
  return { booleanValue: smithyClient.expectBoolean(output.booleanValue) };
@@ -262,10 +262,16 @@ export var CaseRuleDetails;
262
262
  CaseRuleDetails.visit = (value, visitor) => {
263
263
  if (value.required !== undefined)
264
264
  return visitor.required(value.required);
265
+ if (value.fieldOptions !== undefined)
266
+ return visitor.fieldOptions(value.fieldOptions);
267
+ if (value.hidden !== undefined)
268
+ return visitor.hidden(value.hidden);
265
269
  return visitor._(value.$unknown[0], value.$unknown[1]);
266
270
  };
267
271
  })(CaseRuleDetails || (CaseRuleDetails = {}));
268
272
  export const RuleType = {
273
+ FIELD_OPTIONS: "FieldOptions",
274
+ HIDDEN: "Hidden",
269
275
  REQUIRED: "Required",
270
276
  };
271
277
  export const DomainStatus = {
@@ -594,6 +594,7 @@ export const de_BatchGetCaseRuleCommand = async (output, context) => {
594
594
  const doc = take(data, {
595
595
  caseRules: (_) => de_BatchGetCaseRuleList(_, context),
596
596
  errors: _json,
597
+ unprocessedCaseRules: _json,
597
598
  });
598
599
  Object.assign(contents, doc);
599
600
  return contents;
@@ -1330,6 +1331,8 @@ const se_CaseFilterList = (input, context) => {
1330
1331
  };
1331
1332
  const se_CaseRuleDetails = (input, context) => {
1332
1333
  return CaseRuleDetails.visit(input, {
1334
+ fieldOptions: (value) => ({ fieldOptions: _json(value) }),
1335
+ hidden: (value) => ({ hidden: se_HiddenCaseRule(value, context) }),
1333
1336
  required: (value) => ({ required: se_RequiredCaseRule(value, context) }),
1334
1337
  _: (name, value) => ({ [name]: value }),
1335
1338
  });
@@ -1394,6 +1397,12 @@ const se_FieldValueUnion = (input, context) => {
1394
1397
  _: (name, value) => ({ [name]: value }),
1395
1398
  });
1396
1399
  };
1400
+ const se_HiddenCaseRule = (input, context) => {
1401
+ return take(input, {
1402
+ conditions: (_) => se_BooleanConditionList(_, context),
1403
+ defaultValue: [],
1404
+ });
1405
+ };
1397
1406
  const se_OperandTwo = (input, context) => {
1398
1407
  return OperandTwo.visit(input, {
1399
1408
  booleanValue: (value) => ({ booleanValue: value }),
@@ -1570,6 +1579,16 @@ const de_BooleanOperands = (output, context) => {
1570
1579
  });
1571
1580
  };
1572
1581
  const de_CaseRuleDetails = (output, context) => {
1582
+ if (output.fieldOptions != null) {
1583
+ return {
1584
+ fieldOptions: _json(output.fieldOptions),
1585
+ };
1586
+ }
1587
+ if (output.hidden != null) {
1588
+ return {
1589
+ hidden: de_HiddenCaseRule(output.hidden, context),
1590
+ };
1591
+ }
1573
1592
  if (output.required != null) {
1574
1593
  return {
1575
1594
  required: de_RequiredCaseRule(output.required, context),
@@ -1650,6 +1669,12 @@ const de_GetFieldResponse = (output, context) => {
1650
1669
  type: __expectString,
1651
1670
  });
1652
1671
  };
1672
+ const de_HiddenCaseRule = (output, context) => {
1673
+ return take(output, {
1674
+ conditions: (_) => de_BooleanConditionList(_, context),
1675
+ defaultValue: __expectBoolean,
1676
+ });
1677
+ };
1653
1678
  const de_OperandTwo = (output, context) => {
1654
1679
  if (__expectBoolean(output.booleanValue) !== undefined) {
1655
1680
  return { booleanValue: __expectBoolean(output.booleanValue) };
@@ -84,6 +84,49 @@ declare const BatchGetCaseRuleCommand_base: {
84
84
  * // },
85
85
  * // ],
86
86
  * // },
87
+ * // fieldOptions: { // FieldOptionsCaseRule
88
+ * // parentFieldId: "STRING_VALUE",
89
+ * // childFieldId: "STRING_VALUE",
90
+ * // parentChildFieldOptionsMappings: [ // ParentChildFieldOptionsMappingList // required
91
+ * // { // ParentChildFieldOptionsMapping
92
+ * // parentFieldOptionValue: "STRING_VALUE", // required
93
+ * // childFieldOptionValues: [ // ParentChildFieldOptionValueList // required
94
+ * // "STRING_VALUE",
95
+ * // ],
96
+ * // },
97
+ * // ],
98
+ * // },
99
+ * // hidden: { // HiddenCaseRule
100
+ * // defaultValue: true || false, // required
101
+ * // conditions: [ // required
102
+ * // {// Union: only one key present
103
+ * // equalTo: {
104
+ * // operandOne: {// Union: only one key present
105
+ * // fieldId: "STRING_VALUE",
106
+ * // },
107
+ * // operandTwo: {// Union: only one key present
108
+ * // stringValue: "STRING_VALUE",
109
+ * // booleanValue: true || false,
110
+ * // doubleValue: Number("double"),
111
+ * // emptyValue: {},
112
+ * // },
113
+ * // result: true || false, // required
114
+ * // },
115
+ * // notEqualTo: {
116
+ * // operandOne: {// Union: only one key present
117
+ * // fieldId: "STRING_VALUE",
118
+ * // },
119
+ * // operandTwo: {// Union: only one key present
120
+ * // stringValue: "STRING_VALUE",
121
+ * // booleanValue: true || false,
122
+ * // doubleValue: Number("double"),
123
+ * // emptyValue: {},
124
+ * // },
125
+ * // result: true || false, // required
126
+ * // },
127
+ * // },
128
+ * // ],
129
+ * // },
87
130
  * // },
88
131
  * // description: "STRING_VALUE",
89
132
  * // deleted: true || false,
@@ -101,6 +144,9 @@ declare const BatchGetCaseRuleCommand_base: {
101
144
  * // message: "STRING_VALUE",
102
145
  * // },
103
146
  * // ],
147
+ * // unprocessedCaseRules: [ // BatchGetCaseRuleUnprocessedList
148
+ * // "STRING_VALUE",
149
+ * // ],
104
150
  * // };
105
151
  *
106
152
  * ```
@@ -72,6 +72,49 @@ declare const CreateCaseRuleCommand_base: {
72
72
  * },
73
73
  * ],
74
74
  * },
75
+ * fieldOptions: { // FieldOptionsCaseRule
76
+ * parentFieldId: "STRING_VALUE",
77
+ * childFieldId: "STRING_VALUE",
78
+ * parentChildFieldOptionsMappings: [ // ParentChildFieldOptionsMappingList // required
79
+ * { // ParentChildFieldOptionsMapping
80
+ * parentFieldOptionValue: "STRING_VALUE", // required
81
+ * childFieldOptionValues: [ // ParentChildFieldOptionValueList // required
82
+ * "STRING_VALUE",
83
+ * ],
84
+ * },
85
+ * ],
86
+ * },
87
+ * hidden: { // HiddenCaseRule
88
+ * defaultValue: true || false, // required
89
+ * conditions: [ // required
90
+ * {// Union: only one key present
91
+ * equalTo: {
92
+ * operandOne: {// Union: only one key present
93
+ * fieldId: "STRING_VALUE",
94
+ * },
95
+ * operandTwo: {// Union: only one key present
96
+ * stringValue: "STRING_VALUE",
97
+ * booleanValue: true || false,
98
+ * doubleValue: Number("double"),
99
+ * emptyValue: {},
100
+ * },
101
+ * result: true || false, // required
102
+ * },
103
+ * notEqualTo: {
104
+ * operandOne: {// Union: only one key present
105
+ * fieldId: "STRING_VALUE",
106
+ * },
107
+ * operandTwo: {// Union: only one key present
108
+ * stringValue: "STRING_VALUE",
109
+ * booleanValue: true || false,
110
+ * doubleValue: Number("double"),
111
+ * emptyValue: {},
112
+ * },
113
+ * result: true || false, // required
114
+ * },
115
+ * },
116
+ * ],
117
+ * },
75
118
  * },
76
119
  * };
77
120
  * const command = new CreateCaseRuleCommand(input);
@@ -27,7 +27,7 @@ declare const CreateRelatedItemCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <note> <ul> <li> <p>A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a <code>contactArn</code>). All Related Items have their own internal identifier, the <code>relatedItemArn</code>. Examples of related items include <code>comments</code> and <code>contacts</code>.</p> </li> <li> <p>If you provide a value for <code>performedBy.userArn</code> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">DescribeUser</a> permission on the ARN of the user that you provide.</p> </li> <li> <p>The <code>type</code> field is reserved for internal use only.</p> </li> </ul> </note>
30
+ * <p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <p>There's a quota for the number of fields allowed in a Custom type related item. See <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas">Amazon Connect Cases quotas</a>.</p> <p> <b>Use cases</b> </p> <p>Following are examples of related items that you may want to associate with a case:</p> <ul> <li> <p>Related contacts, such as calls, chats, emails tasks</p> </li> <li> <p>Comments, for agent notes</p> </li> <li> <p>SLAs, to capture target resolution goals</p> </li> <li> <p>Cases, to capture related Amazon Connect Cases</p> </li> <li> <p>Files, such as policy documentation or customer-provided attachments</p> </li> <li> <p>Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more</p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>If you are associating a contact to a case by passing in <code>Contact</code> for a <code>type</code>, you must have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeContact.html">DescribeContact</a> permission on the ARN of the contact that you provide in <code>content.contact.contactArn</code>.</p> </li> <li> <p>A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a <code>contactArn</code>). All Related Items have their own internal identifier, the <code>relatedItemArn</code>. Examples of related items include <code>comments</code> and <code>contacts</code>.</p> </li> <li> <p>If you provide a value for <code>performedBy.userArn</code> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">DescribeUser</a> permission on the ARN of the user that you provide.</p> </li> <li> <p>The <code>type</code> field is reserved for internal use only.</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
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -52,7 +52,7 @@ declare const CreateTemplateCommand_base: {
52
52
  * rules: [ // TemplateCaseRuleList
53
53
  * { // TemplateRule
54
54
  * caseRuleId: "STRING_VALUE", // required
55
- * fieldId: "STRING_VALUE", // required
55
+ * fieldId: "STRING_VALUE",
56
56
  * },
57
57
  * ],
58
58
  * };
@@ -27,7 +27,7 @@ declare const DeleteFieldCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a field from a cases template. You can delete up to 100 fields per domain.</p> <p>After a field is deleted:</p> <ul> <li> <p>You can still retrieve the field by calling <code>BatchGetField</code>.</p> </li> <li> <p>You cannot update a deleted field by calling <code>UpdateField</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted fields are not included in the <code>ListFields</code> response.</p> </li> <li> <p>Calling <code>CreateCase</code> with a deleted field throws a <code>ValidationException</code> denoting which field IDs in the request have been deleted.</p> </li> <li> <p>Calling <code>GetCase</code> with a deleted field ID returns the deleted field's value if one exists.</p> </li> <li> <p>Calling <code>UpdateCase</code> with a deleted field ID throws a <code>ValidationException</code> if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using <code>emptyValue: \{\}</code>) the field's value from the case.</p> </li> <li> <p> <code>GetTemplate</code> does not return field IDs for deleted fields.</p> </li> <li> <p> <code>GetLayout</code> does not return field IDs for deleted fields.</p> </li> <li> <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.</p> </li> <li> <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a deleted field's value on a case returns the case in the response.</p> </li> <li> <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a <code>ValidationException</code>.</p> </li> <li> <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted fields.</p> </li> </ul>
30
+ * <p>Deletes a field from a cases template. You can delete up to 100 fields per domain.</p> <p>After a field is deleted:</p> <ul> <li> <p>You can still retrieve the field by calling <code>BatchGetField</code>.</p> </li> <li> <p>You cannot update a deleted field by calling <code>UpdateField</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted fields are not included in the <code>ListFields</code> response.</p> </li> <li> <p>Calling <code>CreateCase</code> with a deleted field throws a <code>ValidationException</code> denoting which field identifiers in the request have been deleted.</p> </li> <li> <p>Calling <code>GetCase</code> with a deleted field identifier returns the deleted field's value if one exists.</p> </li> <li> <p>Calling <code>UpdateCase</code> with a deleted field ID throws a <code>ValidationException</code> if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using <code>emptyValue: \{\}</code>) the field's value from the case.</p> </li> <li> <p> <code>GetTemplate</code> does not return field IDs for deleted fields.</p> </li> <li> <p> <code>GetLayout</code> does not return field IDs for deleted fields.</p> </li> <li> <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.</p> </li> <li> <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a deleted field's value on a case returns the case in the response.</p> </li> <li> <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a <code>ValidationException</code>.</p> </li> <li> <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted fields.</p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -65,7 +65,7 @@ declare const GetTemplateCommand_base: {
65
65
  * // rules: [ // TemplateCaseRuleList
66
66
  * // { // TemplateRule
67
67
  * // caseRuleId: "STRING_VALUE", // required
68
- * // fieldId: "STRING_VALUE", // required
68
+ * // fieldId: "STRING_VALUE",
69
69
  * // },
70
70
  * // ],
71
71
  * // };
@@ -27,7 +27,7 @@ declare const SearchAllRelatedItemsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
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>
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 identifiers, 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
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -73,6 +73,49 @@ declare const UpdateCaseRuleCommand_base: {
73
73
  * },
74
74
  * ],
75
75
  * },
76
+ * fieldOptions: { // FieldOptionsCaseRule
77
+ * parentFieldId: "STRING_VALUE",
78
+ * childFieldId: "STRING_VALUE",
79
+ * parentChildFieldOptionsMappings: [ // ParentChildFieldOptionsMappingList // required
80
+ * { // ParentChildFieldOptionsMapping
81
+ * parentFieldOptionValue: "STRING_VALUE", // required
82
+ * childFieldOptionValues: [ // ParentChildFieldOptionValueList // required
83
+ * "STRING_VALUE",
84
+ * ],
85
+ * },
86
+ * ],
87
+ * },
88
+ * hidden: { // HiddenCaseRule
89
+ * defaultValue: true || false, // required
90
+ * conditions: [ // required
91
+ * {// Union: only one key present
92
+ * equalTo: {
93
+ * operandOne: {// Union: only one key present
94
+ * fieldId: "STRING_VALUE",
95
+ * },
96
+ * operandTwo: {// Union: only one key present
97
+ * stringValue: "STRING_VALUE",
98
+ * booleanValue: true || false,
99
+ * doubleValue: Number("double"),
100
+ * emptyValue: {},
101
+ * },
102
+ * result: true || false, // required
103
+ * },
104
+ * notEqualTo: {
105
+ * operandOne: {// Union: only one key present
106
+ * fieldId: "STRING_VALUE",
107
+ * },
108
+ * operandTwo: {// Union: only one key present
109
+ * stringValue: "STRING_VALUE",
110
+ * booleanValue: true || false,
111
+ * doubleValue: Number("double"),
112
+ * emptyValue: {},
113
+ * },
114
+ * result: true || false, // required
115
+ * },
116
+ * },
117
+ * ],
118
+ * },
76
119
  * },
77
120
  * };
78
121
  * const command = new UpdateCaseRuleCommand(input);
@@ -99,6 +142,9 @@ declare const UpdateCaseRuleCommand_base: {
99
142
  * @throws {@link ResourceNotFoundException} (client fault)
100
143
  * <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>
101
144
  *
145
+ * @throws {@link ServiceQuotaExceededException} (client fault)
146
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
147
+ *
102
148
  * @throws {@link ThrottlingException} (client fault)
103
149
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
104
150
  *
@@ -53,7 +53,7 @@ declare const UpdateTemplateCommand_base: {
53
53
  * rules: [ // TemplateCaseRuleList
54
54
  * { // TemplateRule
55
55
  * caseRuleId: "STRING_VALUE", // required
56
- * fieldId: "STRING_VALUE", // required
56
+ * fieldId: "STRING_VALUE",
57
57
  * },
58
58
  * ],
59
59
  * };
@@ -81,6 +81,9 @@ declare const UpdateTemplateCommand_base: {
81
81
  * @throws {@link ResourceNotFoundException} (client fault)
82
82
  * <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>
83
83
  *
84
+ * @throws {@link ServiceQuotaExceededException} (client fault)
85
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
86
+ *
84
87
  * @throws {@link ThrottlingException} (client fault)
85
88
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
86
89
  *
@@ -1552,11 +1552,48 @@ export interface BatchGetCaseRuleRequest {
1552
1552
  */
1553
1553
  domainId: string | undefined;
1554
1554
  /**
1555
- * <p>List of case rule identifiers.</p>
1555
+ * <p>A list of case rule identifiers.</p>
1556
1556
  * @public
1557
1557
  */
1558
1558
  caseRules: CaseRuleIdentifier[] | undefined;
1559
1559
  }
1560
+ /**
1561
+ * <p>A mapping between a parent field option value and child field option values.</p>
1562
+ * @public
1563
+ */
1564
+ export interface ParentChildFieldOptionsMapping {
1565
+ /**
1566
+ * <p>The value in the parent field.</p>
1567
+ * @public
1568
+ */
1569
+ parentFieldOptionValue: string | undefined;
1570
+ /**
1571
+ * <p>A list of allowed values in the child field.</p>
1572
+ * @public
1573
+ */
1574
+ childFieldOptionValues: string[] | undefined;
1575
+ }
1576
+ /**
1577
+ * <p>Rules that control which options are available in a child field based on the selected value in a parent field.</p>
1578
+ * @public
1579
+ */
1580
+ export interface FieldOptionsCaseRule {
1581
+ /**
1582
+ * <p>The identifier of the parent field that controls options.</p>
1583
+ * @public
1584
+ */
1585
+ parentFieldId?: string | undefined;
1586
+ /**
1587
+ * <p>The identifier of the child field whose options are controlled.</p>
1588
+ * @public
1589
+ */
1590
+ childFieldId?: string | undefined;
1591
+ /**
1592
+ * <p>A mapping between a parent field option value and child field option values.</p>
1593
+ * @public
1594
+ */
1595
+ parentChildFieldOptionsMappings: ParentChildFieldOptionsMapping[] | undefined;
1596
+ }
1560
1597
  /**
1561
1598
  * <p>Represents the left hand operand in the condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
1562
1599
  * @public
@@ -1728,6 +1765,22 @@ export declare namespace BooleanCondition {
1728
1765
  }
1729
1766
  const visit: <T>(value: BooleanCondition, visitor: Visitor<T>) => T;
1730
1767
  }
1768
+ /**
1769
+ * <p>A rule that controls field visibility based on conditions. Fields can be shown or hidden dynamically based on values in other fields.</p>
1770
+ * @public
1771
+ */
1772
+ export interface HiddenCaseRule {
1773
+ /**
1774
+ * <p>Whether the field is hidden when no conditions match.</p>
1775
+ * @public
1776
+ */
1777
+ defaultValue: boolean | undefined;
1778
+ /**
1779
+ * <p>A list of conditions that determine field visibility.</p>
1780
+ * @public
1781
+ */
1782
+ conditions: BooleanCondition[] | undefined;
1783
+ }
1731
1784
  /**
1732
1785
  * <p>Required rule type, used to indicate whether a field is required. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
1733
1786
  * @public
@@ -1748,7 +1801,7 @@ export interface RequiredCaseRule {
1748
1801
  * <p>Represents what rule type should take place, under what conditions. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
1749
1802
  * @public
1750
1803
  */
1751
- export type CaseRuleDetails = CaseRuleDetails.RequiredMember | CaseRuleDetails.$UnknownMember;
1804
+ export type CaseRuleDetails = CaseRuleDetails.FieldOptionsMember | CaseRuleDetails.HiddenMember | CaseRuleDetails.RequiredMember | CaseRuleDetails.$UnknownMember;
1752
1805
  /**
1753
1806
  * @public
1754
1807
  */
@@ -1759,6 +1812,28 @@ export declare namespace CaseRuleDetails {
1759
1812
  */
1760
1813
  interface RequiredMember {
1761
1814
  required: RequiredCaseRule;
1815
+ fieldOptions?: never;
1816
+ hidden?: never;
1817
+ $unknown?: never;
1818
+ }
1819
+ /**
1820
+ * <p>Which options are available in a child field based on the selected value in a parent field.</p>
1821
+ * @public
1822
+ */
1823
+ interface FieldOptionsMember {
1824
+ required?: never;
1825
+ fieldOptions: FieldOptionsCaseRule;
1826
+ hidden?: never;
1827
+ $unknown?: never;
1828
+ }
1829
+ /**
1830
+ * <p>Whether a field is visible, based on values in other fields.</p>
1831
+ * @public
1832
+ */
1833
+ interface HiddenMember {
1834
+ required?: never;
1835
+ fieldOptions?: never;
1836
+ hidden: HiddenCaseRule;
1762
1837
  $unknown?: never;
1763
1838
  }
1764
1839
  /**
@@ -1766,10 +1841,14 @@ export declare namespace CaseRuleDetails {
1766
1841
  */
1767
1842
  interface $UnknownMember {
1768
1843
  required?: never;
1844
+ fieldOptions?: never;
1845
+ hidden?: never;
1769
1846
  $unknown: [string, any];
1770
1847
  }
1771
1848
  interface Visitor<T> {
1772
1849
  required: (value: RequiredCaseRule) => T;
1850
+ fieldOptions: (value: FieldOptionsCaseRule) => T;
1851
+ hidden: (value: HiddenCaseRule) => T;
1773
1852
  _: (name: string, value: any) => T;
1774
1853
  }
1775
1854
  const visit: <T>(value: CaseRuleDetails, visitor: Visitor<T>) => T;
@@ -1851,15 +1930,20 @@ export interface CaseRuleError {
1851
1930
  */
1852
1931
  export interface BatchGetCaseRuleResponse {
1853
1932
  /**
1854
- * <p>List of detailed case rule information.</p>
1933
+ * <p>A list of detailed case rule information.</p>
1855
1934
  * @public
1856
1935
  */
1857
1936
  caseRules: GetCaseRuleResponse[] | undefined;
1858
1937
  /**
1859
- * <p>List of case rule errors.</p>
1938
+ * <p>A list of case rule errors.</p>
1860
1939
  * @public
1861
1940
  */
1862
1941
  errors: CaseRuleError[] | undefined;
1942
+ /**
1943
+ * <p>A list of unprocessed case rule identifiers.</p>
1944
+ * @public
1945
+ */
1946
+ unprocessedCaseRules?: string[] | undefined;
1863
1947
  }
1864
1948
  /**
1865
1949
  * @public
@@ -1946,6 +2030,8 @@ export interface ListCaseRulesRequest {
1946
2030
  * @enum
1947
2031
  */
1948
2032
  export declare const RuleType: {
2033
+ readonly FIELD_OPTIONS: "FieldOptions";
2034
+ readonly HIDDEN: "Hidden";
1949
2035
  readonly REQUIRED: "Required";
1950
2036
  };
1951
2037
  /**
@@ -3160,7 +3246,7 @@ export interface TemplateRule {
3160
3246
  * <p>Unique identifier of a field.</p>
3161
3247
  * @public
3162
3248
  */
3163
- fieldId: string | undefined;
3249
+ fieldId?: string | undefined;
3164
3250
  }
3165
3251
  /**
3166
3252
  * @public
@@ -711,6 +711,15 @@ export interface BatchGetCaseRuleRequest {
711
711
  domainId: string | undefined;
712
712
  caseRules: CaseRuleIdentifier[] | undefined;
713
713
  }
714
+ export interface ParentChildFieldOptionsMapping {
715
+ parentFieldOptionValue: string | undefined;
716
+ childFieldOptionValues: string[] | undefined;
717
+ }
718
+ export interface FieldOptionsCaseRule {
719
+ parentFieldId?: string | undefined;
720
+ childFieldId?: string | undefined;
721
+ parentChildFieldOptionsMappings: ParentChildFieldOptionsMapping[] | undefined;
722
+ }
714
723
  export type OperandOne = OperandOne.FieldIdMember | OperandOne.$UnknownMember;
715
724
  export declare namespace OperandOne {
716
725
  interface FieldIdMember {
@@ -811,24 +820,48 @@ export declare namespace BooleanCondition {
811
820
  }
812
821
  const visit: <T>(value: BooleanCondition, visitor: Visitor<T>) => T;
813
822
  }
823
+ export interface HiddenCaseRule {
824
+ defaultValue: boolean | undefined;
825
+ conditions: BooleanCondition[] | undefined;
826
+ }
814
827
  export interface RequiredCaseRule {
815
828
  defaultValue: boolean | undefined;
816
829
  conditions: BooleanCondition[] | undefined;
817
830
  }
818
831
  export type CaseRuleDetails =
832
+ | CaseRuleDetails.FieldOptionsMember
833
+ | CaseRuleDetails.HiddenMember
819
834
  | CaseRuleDetails.RequiredMember
820
835
  | CaseRuleDetails.$UnknownMember;
821
836
  export declare namespace CaseRuleDetails {
822
837
  interface RequiredMember {
823
838
  required: RequiredCaseRule;
839
+ fieldOptions?: never;
840
+ hidden?: never;
841
+ $unknown?: never;
842
+ }
843
+ interface FieldOptionsMember {
844
+ required?: never;
845
+ fieldOptions: FieldOptionsCaseRule;
846
+ hidden?: never;
847
+ $unknown?: never;
848
+ }
849
+ interface HiddenMember {
850
+ required?: never;
851
+ fieldOptions?: never;
852
+ hidden: HiddenCaseRule;
824
853
  $unknown?: never;
825
854
  }
826
855
  interface $UnknownMember {
827
856
  required?: never;
857
+ fieldOptions?: never;
858
+ hidden?: never;
828
859
  $unknown: [string, any];
829
860
  }
830
861
  interface Visitor<T> {
831
862
  required: (value: RequiredCaseRule) => T;
863
+ fieldOptions: (value: FieldOptionsCaseRule) => T;
864
+ hidden: (value: HiddenCaseRule) => T;
832
865
  _: (name: string, value: any) => T;
833
866
  }
834
867
  const visit: <T>(value: CaseRuleDetails, visitor: Visitor<T>) => T;
@@ -852,6 +885,7 @@ export interface CaseRuleError {
852
885
  export interface BatchGetCaseRuleResponse {
853
886
  caseRules: GetCaseRuleResponse[] | undefined;
854
887
  errors: CaseRuleError[] | undefined;
888
+ unprocessedCaseRules?: string[] | undefined;
855
889
  }
856
890
  export interface CreateCaseRuleRequest {
857
891
  domainId: string | undefined;
@@ -874,6 +908,8 @@ export interface ListCaseRulesRequest {
874
908
  nextToken?: string | undefined;
875
909
  }
876
910
  export declare const RuleType: {
911
+ readonly FIELD_OPTIONS: "FieldOptions";
912
+ readonly HIDDEN: "Hidden";
877
913
  readonly REQUIRED: "Required";
878
914
  };
879
915
  export type RuleType = (typeof RuleType)[keyof typeof RuleType];
@@ -1209,7 +1245,7 @@ export interface RequiredField {
1209
1245
  }
1210
1246
  export interface TemplateRule {
1211
1247
  caseRuleId: string | undefined;
1212
- fieldId: string | undefined;
1248
+ fieldId?: string | undefined;
1213
1249
  }
1214
1250
  export declare const TemplateStatus: {
1215
1251
  readonly ACTIVE: "Active";
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.921.0",
4
+ "version": "3.922.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-connectcases",
@@ -20,17 +20,17 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.921.0",
24
- "@aws-sdk/credential-provider-node": "3.921.0",
25
- "@aws-sdk/middleware-host-header": "3.921.0",
26
- "@aws-sdk/middleware-logger": "3.921.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.921.0",
28
- "@aws-sdk/middleware-user-agent": "3.921.0",
29
- "@aws-sdk/region-config-resolver": "3.921.0",
30
- "@aws-sdk/types": "3.921.0",
31
- "@aws-sdk/util-endpoints": "3.921.0",
32
- "@aws-sdk/util-user-agent-browser": "3.921.0",
33
- "@aws-sdk/util-user-agent-node": "3.921.0",
23
+ "@aws-sdk/core": "3.922.0",
24
+ "@aws-sdk/credential-provider-node": "3.922.0",
25
+ "@aws-sdk/middleware-host-header": "3.922.0",
26
+ "@aws-sdk/middleware-logger": "3.922.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.922.0",
28
+ "@aws-sdk/middleware-user-agent": "3.922.0",
29
+ "@aws-sdk/region-config-resolver": "3.922.0",
30
+ "@aws-sdk/types": "3.922.0",
31
+ "@aws-sdk/util-endpoints": "3.922.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.922.0",
33
+ "@aws-sdk/util-user-agent-node": "3.922.0",
34
34
  "@smithy/config-resolver": "^4.4.1",
35
35
  "@smithy/core": "^3.17.2",
36
36
  "@smithy/fetch-http-handler": "^5.3.5",