@aws-sdk/client-connectcases 3.839.0 → 3.842.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 (62) hide show
  1. package/README.md +17 -19
  2. package/dist-cjs/index.js +77 -0
  3. package/dist-es/ConnectCases.js +4 -0
  4. package/dist-es/commands/DeleteCaseCommand.js +22 -0
  5. package/dist-es/commands/DeleteRelatedItemCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/protocols/Aws_restJson1.js +41 -0
  8. package/dist-types/ConnectCases.d.ts +15 -19
  9. package/dist-types/ConnectCasesClient.d.ts +5 -21
  10. package/dist-types/commands/BatchGetCaseRuleCommand.d.ts +3 -7
  11. package/dist-types/commands/BatchGetFieldCommand.d.ts +2 -4
  12. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +4 -8
  13. package/dist-types/commands/CreateCaseCommand.d.ts +4 -27
  14. package/dist-types/commands/CreateCaseRuleCommand.d.ts +5 -12
  15. package/dist-types/commands/CreateDomainCommand.d.ts +4 -17
  16. package/dist-types/commands/CreateFieldCommand.d.ts +5 -11
  17. package/dist-types/commands/CreateLayoutCommand.d.ts +5 -23
  18. package/dist-types/commands/CreateRelatedItemCommand.d.ts +4 -26
  19. package/dist-types/commands/CreateTemplateCommand.d.ts +5 -38
  20. package/dist-types/commands/DeleteCaseCommand.d.ts +86 -0
  21. package/dist-types/commands/DeleteCaseRuleCommand.d.ts +4 -10
  22. package/dist-types/commands/DeleteDomainCommand.d.ts +4 -12
  23. package/dist-types/commands/DeleteFieldCommand.d.ts +5 -62
  24. package/dist-types/commands/DeleteLayoutCommand.d.ts +4 -22
  25. package/dist-types/commands/DeleteRelatedItemCommand.d.ts +87 -0
  26. package/dist-types/commands/DeleteTemplateCommand.d.ts +4 -23
  27. package/dist-types/commands/GetCaseAuditEventsCommand.d.ts +2 -4
  28. package/dist-types/commands/GetCaseCommand.d.ts +2 -4
  29. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +2 -4
  30. package/dist-types/commands/GetDomainCommand.d.ts +2 -4
  31. package/dist-types/commands/GetLayoutCommand.d.ts +2 -4
  32. package/dist-types/commands/GetTemplateCommand.d.ts +3 -27
  33. package/dist-types/commands/ListCaseRulesCommand.d.ts +3 -7
  34. package/dist-types/commands/ListCasesForContactCommand.d.ts +2 -4
  35. package/dist-types/commands/ListDomainsCommand.d.ts +2 -4
  36. package/dist-types/commands/ListFieldOptionsCommand.d.ts +2 -4
  37. package/dist-types/commands/ListFieldsCommand.d.ts +2 -4
  38. package/dist-types/commands/ListLayoutsCommand.d.ts +3 -6
  39. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
  40. package/dist-types/commands/ListTemplatesCommand.d.ts +3 -29
  41. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +4 -11
  42. package/dist-types/commands/SearchCasesCommand.d.ts +3 -11
  43. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +3 -9
  44. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  45. package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
  46. package/dist-types/commands/UpdateCaseCommand.d.ts +3 -11
  47. package/dist-types/commands/UpdateCaseRuleCommand.d.ts +4 -10
  48. package/dist-types/commands/UpdateFieldCommand.d.ts +3 -7
  49. package/dist-types/commands/UpdateLayoutCommand.d.ts +5 -18
  50. package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -35
  51. package/dist-types/commands/index.d.ts +2 -0
  52. package/dist-types/index.d.ts +1 -19
  53. package/dist-types/models/models_0.d.ts +107 -159
  54. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  55. package/dist-types/ts3.4/ConnectCases.d.ts +34 -0
  56. package/dist-types/ts3.4/ConnectCasesClient.d.ts +12 -0
  57. package/dist-types/ts3.4/commands/DeleteCaseCommand.d.ts +47 -0
  58. package/dist-types/ts3.4/commands/DeleteRelatedItemCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  60. package/dist-types/ts3.4/models/models_0.d.ts +11 -0
  61. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  62. package/package.json +12 -12
@@ -13,9 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * <p>The requested operation would cause a conflict with the current state of a service
17
- * resource associated with the request. Resolve the conflict before retrying this request. See
18
- * the accompanying error message for details.</p>
16
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
19
17
  * @public
20
18
  */
21
19
  export declare class ConflictException extends __BaseException {
@@ -27,20 +25,13 @@ export declare class ConflictException extends __BaseException {
27
25
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
28
26
  }
29
27
  /**
30
- * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on
31
- * a case template.</p>
32
- * <p>This structure will never have any data members. It signifies an empty value on a case
33
- * field.</p>
28
+ * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on a case template.</p> <p>This structure will never have any data members. It signifies an empty value on a case field.</p>
34
29
  * @public
35
30
  */
36
31
  export interface EmptyFieldValue {
37
32
  }
38
33
  /**
39
- * <p>Object to store union of Field values.</p>
40
- * <note>
41
- * <p>The <code>Summary</code> system field accepts 3000 characters while all other fields
42
- * accept 500 characters.</p>
43
- * </note>
34
+ * <p>Object to store union of Field values.</p> <note> <p>The <code>Summary</code> system field accepts 3000 characters while all other fields accept 500 characters.</p> </note>
44
35
  * @public
45
36
  */
46
37
  export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUnion.DoubleValueMember | FieldValueUnion.EmptyValueMember | FieldValueUnion.StringValueMember | FieldValueUnion.UserArnValueMember | FieldValueUnion.$UnknownMember;
@@ -61,8 +52,7 @@ export declare namespace FieldValueUnion {
61
52
  $unknown?: never;
62
53
  }
63
54
  /**
64
- * <p>Can be either null, or have a Double number value type. Only one value can be
65
- * provided.</p>
55
+ * <p>Can be either null, or have a Double number value type. Only one value can be provided.</p>
66
56
  * @public
67
57
  */
68
58
  interface DoubleValueMember {
@@ -203,16 +193,12 @@ export interface CreateCaseRequest {
203
193
  */
204
194
  templateId: string | undefined;
205
195
  /**
206
- * <p>An array of objects with field ID (matching ListFields/DescribeField) and value union
207
- * data.</p>
196
+ * <p>An array of objects with field ID (matching ListFields/DescribeField) and value union data.</p>
208
197
  * @public
209
198
  */
210
199
  fields: FieldValue[] | undefined;
211
200
  /**
212
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
213
- * request. If not provided, the Amazon Web Services
214
- * SDK populates this field. For more information about idempotency, see
215
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
201
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
216
202
  * @public
217
203
  */
218
204
  clientToken?: string | undefined;
@@ -238,8 +224,7 @@ export interface CreateCaseResponse {
238
224
  caseArn: string | undefined;
239
225
  }
240
226
  /**
241
- * <p>We couldn't process your request because of an issue with the server. Try again
242
- * later.</p>
227
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
243
228
  * @public
244
229
  */
245
230
  export declare class InternalServerException extends __BaseException {
@@ -257,8 +242,7 @@ export declare class InternalServerException extends __BaseException {
257
242
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
258
243
  }
259
244
  /**
260
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
261
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
245
+ * <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>
262
246
  * @public
263
247
  */
264
248
  export declare class ResourceNotFoundException extends __BaseException {
@@ -304,6 +288,26 @@ export declare class ValidationException extends __BaseException {
304
288
  */
305
289
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
306
290
  }
291
+ /**
292
+ * @public
293
+ */
294
+ export interface DeleteCaseRequest {
295
+ /**
296
+ * <p>A unique identifier of the Cases domain.</p>
297
+ * @public
298
+ */
299
+ domainId: string | undefined;
300
+ /**
301
+ * <p>A unique identifier of the case.</p>
302
+ * @public
303
+ */
304
+ caseId: string | undefined;
305
+ }
306
+ /**
307
+ * @public
308
+ */
309
+ export interface DeleteCaseResponse {
310
+ }
307
311
  /**
308
312
  * <p>Object for unique identifier of a field.</p>
309
313
  * @public
@@ -335,8 +339,7 @@ export interface GetCaseRequest {
335
339
  */
336
340
  fields: FieldIdentifier[] | undefined;
337
341
  /**
338
- * <p>The token for the next set of results. Use the value returned in the previous
339
- * response in the next request to retrieve the next set of results.</p>
342
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
340
343
  * @public
341
344
  */
342
345
  nextToken?: string | undefined;
@@ -381,14 +384,12 @@ export interface GetCaseAuditEventsRequest {
381
384
  */
382
385
  domainId: string | undefined;
383
386
  /**
384
- * <p>The maximum number of audit events to return. The current maximum supported value is 25.
385
- * This is also the default when no other value is provided.</p>
387
+ * <p>The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.</p>
386
388
  * @public
387
389
  */
388
390
  maxResults?: number | undefined;
389
391
  /**
390
- * <p>The token for the next set of results. Use the value returned in the previous response in
391
- * the next request to retrieve the next set of results.</p>
392
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
392
393
  * @public
393
394
  */
394
395
  nextToken?: string | undefined;
@@ -439,10 +440,7 @@ export declare namespace AuditEventFieldValueUnion {
439
440
  $unknown?: never;
440
441
  }
441
442
  /**
442
- * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on
443
- * a case template.</p>
444
- * <p>This structure will never have any data members. It signifies an empty value on a case
445
- * field.</p>
443
+ * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on a case template.</p> <p>This structure will never have any data members. It signifies an empty value on a case field.</p>
446
444
  * @public
447
445
  */
448
446
  interface EmptyValueMember {
@@ -454,8 +452,7 @@ export declare namespace AuditEventFieldValueUnion {
454
452
  $unknown?: never;
455
453
  }
456
454
  /**
457
- * <p>Can be either null, or have a String value type formatted as an ARN. Only one value can be
458
- * provided.</p>
455
+ * <p>Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.</p>
459
456
  * @public
460
457
  */
461
458
  interface UserArnValueMember {
@@ -592,8 +589,7 @@ export interface AuditEvent {
592
589
  */
593
590
  export interface GetCaseAuditEventsResponse {
594
591
  /**
595
- * <p>The token for the next set of results. This is null if there are no more results to
596
- * return.</p>
592
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
597
593
  * @public
598
594
  */
599
595
  nextToken?: string | undefined;
@@ -623,8 +619,7 @@ export interface ListCasesForContactRequest {
623
619
  */
624
620
  maxResults?: number | undefined;
625
621
  /**
626
- * <p>The token for the next set of results. Use the value returned in the previous
627
- * response in the next request to retrieve the next set of results.</p>
622
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
628
623
  * @public
629
624
  */
630
625
  nextToken?: string | undefined;
@@ -741,8 +736,7 @@ export interface SlaInputConfiguration {
741
736
  */
742
737
  fieldId?: string | undefined;
743
738
  /**
744
- * <p>Represents a list of target field values for the fieldId specified in SlaInputConfiguration.
745
- * The SLA is considered met if any one of these target field values matches the actual field value.</p>
739
+ * <p>Represents a list of target field values for the fieldId specified in SlaInputConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.</p>
746
740
  * @public
747
741
  */
748
742
  targetFieldValues?: FieldValueUnion[] | undefined;
@@ -900,8 +894,7 @@ export interface CreateRelatedItemResponse {
900
894
  relatedItemArn: string | undefined;
901
895
  }
902
896
  /**
903
- * <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
904
- * Administrator Guide</i>.</p>
897
+ * <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>
905
898
  * @public
906
899
  */
907
900
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -912,6 +905,31 @@ export declare class ServiceQuotaExceededException extends __BaseException {
912
905
  */
913
906
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
914
907
  }
908
+ /**
909
+ * @public
910
+ */
911
+ export interface DeleteRelatedItemRequest {
912
+ /**
913
+ * <p>A unique identifier of the Cases domain.</p>
914
+ * @public
915
+ */
916
+ domainId: string | undefined;
917
+ /**
918
+ * <p>A unique identifier of the case.</p>
919
+ * @public
920
+ */
921
+ caseId: string | undefined;
922
+ /**
923
+ * <p>A unique identifier of a related item.</p>
924
+ * @public
925
+ */
926
+ relatedItemId: string | undefined;
927
+ }
928
+ /**
929
+ * @public
930
+ */
931
+ export interface DeleteRelatedItemResponse {
932
+ }
915
933
  /**
916
934
  * <p>A filter for related items of type <code>Comment</code>.</p>
917
935
  * @public
@@ -1067,8 +1085,7 @@ export interface SearchRelatedItemsRequest {
1067
1085
  */
1068
1086
  maxResults?: number | undefined;
1069
1087
  /**
1070
- * <p>The token for the next set of results. Use the value returned in the previous
1071
- * response in the next request to retrieve the next set of results.</p>
1088
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
1072
1089
  * @public
1073
1090
  */
1074
1091
  nextToken?: string | undefined;
@@ -1094,8 +1111,7 @@ export interface ContactContent {
1094
1111
  */
1095
1112
  channel: string | undefined;
1096
1113
  /**
1097
- * <p>The difference between the <code>InitiationTimestamp</code> and the
1098
- * <code>DisconnectTimestamp</code> of the contact.</p>
1114
+ * <p>The difference between the <code>InitiationTimestamp</code> and the <code>DisconnectTimestamp</code> of the contact.</p>
1099
1115
  * @public
1100
1116
  */
1101
1117
  connectedToSystemTime: Date | undefined;
@@ -1449,8 +1465,7 @@ export interface SearchCasesResponse {
1449
1465
  */
1450
1466
  nextToken?: string | undefined;
1451
1467
  /**
1452
- * <p>A list of case documents where each case contains the properties <code>CaseId</code> and
1453
- * <code>Fields</code> where each field is a complex union structure. </p>
1468
+ * <p>A list of case documents where each case contains the properties <code>CaseId</code> and <code>Fields</code> where each field is a complex union structure. </p>
1454
1469
  * @public
1455
1470
  */
1456
1471
  cases: SearchCasesResponseItem[] | undefined;
@@ -1470,8 +1485,7 @@ export interface UpdateCaseRequest {
1470
1485
  */
1471
1486
  caseId: string | undefined;
1472
1487
  /**
1473
- * <p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and
1474
- * value union data, structured identical to <code>CreateCase</code>.</p>
1488
+ * <p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and value union data, structured identical to <code>CreateCase</code>.</p>
1475
1489
  * @public
1476
1490
  */
1477
1491
  fields: FieldValue[] | undefined;
@@ -1513,10 +1527,7 @@ export interface BatchGetCaseRuleRequest {
1513
1527
  caseRules: CaseRuleIdentifier[] | undefined;
1514
1528
  }
1515
1529
  /**
1516
- * <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>.
1517
- * For more
1518
- * 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
1519
- * case template</a>.</p>
1530
+ * <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>
1520
1531
  * @public
1521
1532
  */
1522
1533
  export type OperandOne = OperandOne.FieldIdMember | OperandOne.$UnknownMember;
@@ -1546,19 +1557,13 @@ export declare namespace OperandOne {
1546
1557
  const visit: <T>(value: OperandOne, visitor: Visitor<T>) => T;
1547
1558
  }
1548
1559
  /**
1549
- * <p>Represents an empty operand value. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1550
- * For more
1551
- * 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
1552
- * case template</a>.</p>
1560
+ * <p>Represents an empty operand value. 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>
1553
1561
  * @public
1554
1562
  */
1555
1563
  export interface EmptyOperandValue {
1556
1564
  }
1557
1565
  /**
1558
- * <p>Represents the right hand operand in the condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1559
- * For more
1560
- * 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
1561
- * case template</a>.</p>
1566
+ * <p>Represents the right 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
1567
  * @public
1563
1568
  */
1564
1569
  export type OperandTwo = OperandTwo.BooleanValueMember | OperandTwo.DoubleValueMember | OperandTwo.EmptyValueMember | OperandTwo.StringValueMember | OperandTwo.$UnknownMember;
@@ -1630,10 +1635,7 @@ export declare namespace OperandTwo {
1630
1635
  const visit: <T>(value: OperandTwo, visitor: Visitor<T>) => T;
1631
1636
  }
1632
1637
  /**
1633
- * <p>Boolean operands for a condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1634
- * For more
1635
- * 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
1636
- * case template</a>.</p>
1638
+ * <p>Boolean operands for a 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>
1637
1639
  * @public
1638
1640
  */
1639
1641
  export interface BooleanOperands {
@@ -1654,10 +1656,7 @@ export interface BooleanOperands {
1654
1656
  result: boolean | undefined;
1655
1657
  }
1656
1658
  /**
1657
- * <p>Boolean condition for a rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1658
- * For more
1659
- * 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
1660
- * case template</a>.</p>
1659
+ * <p>Boolean condition for a rule. 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>
1661
1660
  * @public
1662
1661
  */
1663
1662
  export type BooleanCondition = BooleanCondition.EqualToMember | BooleanCondition.NotEqualToMember | BooleanCondition.$UnknownMember;
@@ -1699,33 +1698,23 @@ export declare namespace BooleanCondition {
1699
1698
  const visit: <T>(value: BooleanCondition, visitor: Visitor<T>) => T;
1700
1699
  }
1701
1700
  /**
1702
- * <p>Required rule type, used to indicate whether a field is required.
1703
- * In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1704
- * For more
1705
- * 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
1706
- * case template</a>.</p>
1701
+ * <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>
1707
1702
  * @public
1708
1703
  */
1709
1704
  export interface RequiredCaseRule {
1710
1705
  /**
1711
- * <p>The value of the rule (that is, whether the field is required) should none of the conditions
1712
- * evaluate to true.</p>
1706
+ * <p>The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.</p>
1713
1707
  * @public
1714
1708
  */
1715
1709
  defaultValue: boolean | undefined;
1716
1710
  /**
1717
- * <p>List of conditions for the required rule; the first condition to evaluate to true dictates
1718
- * the value of the rule.</p>
1711
+ * <p>List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule.</p>
1719
1712
  * @public
1720
1713
  */
1721
1714
  conditions: BooleanCondition[] | undefined;
1722
1715
  }
1723
1716
  /**
1724
- * <p>Represents what rule type should take place, under what conditions.
1725
- * In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1726
- * For more
1727
- * 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
1728
- * case template</a>.</p>
1717
+ * <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>
1729
1718
  * @public
1730
1719
  */
1731
1720
  export type CaseRuleDetails = CaseRuleDetails.RequiredMember | CaseRuleDetails.$UnknownMember;
@@ -1755,10 +1744,7 @@ export declare namespace CaseRuleDetails {
1755
1744
  const visit: <T>(value: CaseRuleDetails, visitor: Visitor<T>) => T;
1756
1745
  }
1757
1746
  /**
1758
- * <p>Detailed case rule information. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1759
- * For more
1760
- * 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
1761
- * case template</a>.</p>
1747
+ * <p>Detailed case rule information. 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>
1762
1748
  * @public
1763
1749
  */
1764
1750
  export interface GetCaseRuleResponse {
@@ -1809,10 +1795,7 @@ export interface GetCaseRuleResponse {
1809
1795
  tags?: Record<string, string> | undefined;
1810
1796
  }
1811
1797
  /**
1812
- * <p>Error for batch describe case rules API failure. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1813
- * For more
1814
- * 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
1815
- * case template</a>.</p>
1798
+ * <p>Error for batch describe case rules API failure. 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>
1816
1799
  * @public
1817
1800
  */
1818
1801
  export interface CaseRuleError {
@@ -1922,8 +1905,7 @@ export interface ListCaseRulesRequest {
1922
1905
  */
1923
1906
  maxResults?: number | undefined;
1924
1907
  /**
1925
- * <p>The token for the next set of results. Use the value returned in the previous
1926
- * response in the next request to retrieve the next set of results.</p>
1908
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
1927
1909
  * @public
1928
1910
  */
1929
1911
  nextToken?: string | undefined;
@@ -1940,10 +1922,7 @@ export declare const RuleType: {
1940
1922
  */
1941
1923
  export type RuleType = (typeof RuleType)[keyof typeof RuleType];
1942
1924
  /**
1943
- * <p>Summary information of this case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
1944
- * For more
1945
- * 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
1946
- * case template</a>.</p>
1925
+ * <p>Summary information of this case rule. 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>
1947
1926
  * @public
1948
1927
  */
1949
1928
  export interface CaseRuleSummary {
@@ -2028,8 +2007,7 @@ export interface UpdateCaseRuleResponse {
2028
2007
  */
2029
2008
  export interface CreateDomainRequest {
2030
2009
  /**
2031
- * <p>The name for your Cases domain. It must be unique for your Amazon Web Services
2032
- * account.</p>
2010
+ * <p>The name for your Cases domain. It must be unique for your Amazon Web Services account.</p>
2033
2011
  * @public
2034
2012
  */
2035
2013
  name: string | undefined;
@@ -2115,8 +2093,7 @@ export interface RelatedItemEventIncludedData {
2115
2093
  includeContent: boolean | undefined;
2116
2094
  }
2117
2095
  /**
2118
- * <p>Details of what case and related item data is published through the case event
2119
- * stream.</p>
2096
+ * <p>Details of what case and related item data is published through the case event stream.</p>
2120
2097
  * @public
2121
2098
  */
2122
2099
  export interface EventIncludedData {
@@ -2132,8 +2109,7 @@ export interface EventIncludedData {
2132
2109
  relatedItemData?: RelatedItemEventIncludedData | undefined;
2133
2110
  }
2134
2111
  /**
2135
- * <p>Configuration to enable EventBridge case event delivery and determine what data is
2136
- * delivered.</p>
2112
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is delivered.</p>
2137
2113
  * @public
2138
2114
  */
2139
2115
  export interface EventBridgeConfiguration {
@@ -2143,8 +2119,7 @@ export interface EventBridgeConfiguration {
2143
2119
  */
2144
2120
  enabled: boolean | undefined;
2145
2121
  /**
2146
- * <p>Details of what case and related item data is published through the case event
2147
- * stream.</p>
2122
+ * <p>Details of what case and related item data is published through the case event stream.</p>
2148
2123
  * @public
2149
2124
  */
2150
2125
  includedData?: EventIncludedData | undefined;
@@ -2154,8 +2129,7 @@ export interface EventBridgeConfiguration {
2154
2129
  */
2155
2130
  export interface GetCaseEventConfigurationResponse {
2156
2131
  /**
2157
- * <p>Configuration to enable EventBridge case event delivery and determine what data is
2158
- * delivered.</p>
2132
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is delivered.</p>
2159
2133
  * @public
2160
2134
  */
2161
2135
  eventBridge: EventBridgeConfiguration | undefined;
@@ -2215,8 +2189,7 @@ export interface ListDomainsRequest {
2215
2189
  */
2216
2190
  maxResults?: number | undefined;
2217
2191
  /**
2218
- * <p>The token for the next set of results. Use the value returned in the previous
2219
- * response in the next request to retrieve the next set of results.</p>
2192
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2220
2193
  * @public
2221
2194
  */
2222
2195
  nextToken?: string | undefined;
@@ -2267,8 +2240,7 @@ export interface PutCaseEventConfigurationRequest {
2267
2240
  */
2268
2241
  domainId: string | undefined;
2269
2242
  /**
2270
- * <p>Configuration to enable EventBridge case event delivery and determine what data is
2271
- * delivered.</p>
2243
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is delivered.</p>
2272
2244
  * @public
2273
2245
  */
2274
2246
  eventBridge: EventBridgeConfiguration | undefined;
@@ -2420,15 +2392,12 @@ export interface BatchGetFieldResponse {
2420
2392
  */
2421
2393
  export interface FieldOption {
2422
2394
  /**
2423
- * <p>
2424
- * <code>FieldOptionName</code> has max length 100 and disallows trailing spaces.</p>
2395
+ * <p> <code>FieldOptionName</code> has max length 100 and disallows trailing spaces.</p>
2425
2396
  * @public
2426
2397
  */
2427
2398
  name: string | undefined;
2428
2399
  /**
2429
- * <p>
2430
- * <code>FieldOptionValue</code> has max length 100 and must be alphanumeric with hyphens and
2431
- * underscores.</p>
2400
+ * <p> <code>FieldOptionValue</code> has max length 100 and must be alphanumeric with hyphens and underscores.</p>
2432
2401
  * @public
2433
2402
  */
2434
2403
  value: string | undefined;
@@ -2569,14 +2538,12 @@ export interface ListFieldOptionsRequest {
2569
2538
  */
2570
2539
  maxResults?: number | undefined;
2571
2540
  /**
2572
- * <p>The token for the next set of results. Use the value returned in the previous
2573
- * response in the next request to retrieve the next set of results.</p>
2541
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2574
2542
  * @public
2575
2543
  */
2576
2544
  nextToken?: string | undefined;
2577
2545
  /**
2578
- * <p>A list of <code>FieldOption</code> values to filter on for
2579
- * <code>ListFieldOptions</code>.</p>
2546
+ * <p>A list of <code>FieldOption</code> values to filter on for <code>ListFieldOptions</code>.</p>
2580
2547
  * @public
2581
2548
  */
2582
2549
  values?: string[] | undefined;
@@ -2611,8 +2578,7 @@ export interface ListFieldsRequest {
2611
2578
  */
2612
2579
  maxResults?: number | undefined;
2613
2580
  /**
2614
- * <p>The token for the next set of results. Use the value returned in the previous
2615
- * response in the next request to retrieve the next set of results.</p>
2581
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2616
2582
  * @public
2617
2583
  */
2618
2584
  nextToken?: string | undefined;
@@ -2751,8 +2717,7 @@ export declare namespace Section {
2751
2717
  const visit: <T>(value: Section, visitor: Visitor<T>) => T;
2752
2718
  }
2753
2719
  /**
2754
- * <p>Ordered list containing different kinds of sections that can be added. A LayoutSections
2755
- * object can only contain one section.</p>
2720
+ * <p>Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.</p>
2756
2721
  * @public
2757
2722
  */
2758
2723
  export interface LayoutSections {
@@ -2763,8 +2728,7 @@ export interface LayoutSections {
2763
2728
  sections?: Section[] | undefined;
2764
2729
  }
2765
2730
  /**
2766
- * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
2767
- * and More Info tab of agent application. </p>
2731
+ * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel and More Info tab of agent application. </p>
2768
2732
  * @public
2769
2733
  */
2770
2734
  export interface BasicLayout {
@@ -2789,8 +2753,7 @@ export type LayoutContent = LayoutContent.BasicMember | LayoutContent.$UnknownMe
2789
2753
  */
2790
2754
  export declare namespace LayoutContent {
2791
2755
  /**
2792
- * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
2793
- * and More Info tab of Cases user interface.</p>
2756
+ * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel and More Info tab of Cases user interface.</p>
2794
2757
  * @public
2795
2758
  */
2796
2759
  interface BasicMember {
@@ -2825,8 +2788,7 @@ export interface CreateLayoutRequest {
2825
2788
  */
2826
2789
  name: string | undefined;
2827
2790
  /**
2828
- * <p>Information about which fields will be present in the layout, and information about the
2829
- * order of the fields.</p>
2791
+ * <p>Information about which fields will be present in the layout, and information about the order of the fields.</p>
2830
2792
  * @public
2831
2793
  */
2832
2794
  content: LayoutContent | undefined;
@@ -2901,8 +2863,7 @@ export interface GetLayoutResponse {
2901
2863
  */
2902
2864
  name: string | undefined;
2903
2865
  /**
2904
- * <p>Information about which fields will be present in the layout, the order of the fields, and
2905
- * read-only attribute of the field. </p>
2866
+ * <p>Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field. </p>
2906
2867
  * @public
2907
2868
  */
2908
2869
  content: LayoutContent | undefined;
@@ -2942,8 +2903,7 @@ export interface ListLayoutsRequest {
2942
2903
  */
2943
2904
  maxResults?: number | undefined;
2944
2905
  /**
2945
- * <p>The token for the next set of results. Use the value returned in the previous
2946
- * response in the next request to retrieve the next set of results.</p>
2906
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2947
2907
  * @public
2948
2908
  */
2949
2909
  nextToken?: string | undefined;
@@ -3004,8 +2964,7 @@ export interface UpdateLayoutRequest {
3004
2964
  */
3005
2965
  name?: string | undefined;
3006
2966
  /**
3007
- * <p>Information about which fields will be present in the layout, the order of the
3008
- * fields.</p>
2967
+ * <p>Information about which fields will be present in the layout, the order of the fields.</p>
3009
2968
  * @public
3010
2969
  */
3011
2970
  content?: LayoutContent | undefined;
@@ -3073,10 +3032,7 @@ export interface RequiredField {
3073
3032
  fieldId: string | undefined;
3074
3033
  }
3075
3034
  /**
3076
- * <p>An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.
3077
- * For more
3078
- * 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
3079
- * case template</a>.</p>
3035
+ * <p>An association representing a case rule acting upon a field. 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>
3080
3036
  * @public
3081
3037
  */
3082
3038
  export interface TemplateRule {
@@ -3128,8 +3084,7 @@ export interface CreateTemplateRequest {
3128
3084
  */
3129
3085
  layoutConfiguration?: LayoutConfiguration | undefined;
3130
3086
  /**
3131
- * <p>A list of fields that must contain a value for a case to be successfully created with this
3132
- * template.</p>
3087
+ * <p>A list of fields that must contain a value for a case to be successfully created with this template.</p>
3133
3088
  * @public
3134
3089
  */
3135
3090
  requiredFields?: RequiredField[] | undefined;
@@ -3139,8 +3094,7 @@ export interface CreateTemplateRequest {
3139
3094
  */
3140
3095
  status?: TemplateStatus | undefined;
3141
3096
  /**
3142
- * <p>A list of case rules (also known as <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">case field conditions</a>) on a template.
3143
- * </p>
3097
+ * <p>A list of case rules (also known as <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">case field conditions</a>) on a template. </p>
3144
3098
  * @public
3145
3099
  */
3146
3100
  rules?: TemplateRule[] | undefined;
@@ -3225,8 +3179,7 @@ export interface GetTemplateResponse {
3225
3179
  */
3226
3180
  layoutConfiguration?: LayoutConfiguration | undefined;
3227
3181
  /**
3228
- * <p>A list of fields that must contain a value for a case to be successfully created with this
3229
- * template.</p>
3182
+ * <p>A list of fields that must contain a value for a case to be successfully created with this template.</p>
3230
3183
  * @public
3231
3184
  */
3232
3185
  requiredFields?: RequiredField[] | undefined;
@@ -3276,8 +3229,7 @@ export interface ListTemplatesRequest {
3276
3229
  */
3277
3230
  maxResults?: number | undefined;
3278
3231
  /**
3279
- * <p>The token for the next set of results. Use the value returned in the previous
3280
- * response in the next request to retrieve the next set of results.</p>
3232
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
3281
3233
  * @public
3282
3234
  */
3283
3235
  nextToken?: string | undefined;
@@ -3358,8 +3310,7 @@ export interface UpdateTemplateRequest {
3358
3310
  */
3359
3311
  layoutConfiguration?: LayoutConfiguration | undefined;
3360
3312
  /**
3361
- * <p>A list of fields that must contain a value for a case to be successfully created with this
3362
- * template.</p>
3313
+ * <p>A list of fields that must contain a value for a case to be successfully created with this template.</p>
3363
3314
  * @public
3364
3315
  */
3365
3316
  requiredFields?: RequiredField[] | undefined;
@@ -3476,14 +3427,12 @@ export interface SearchCasesRequest {
3476
3427
  */
3477
3428
  domainId: string | undefined;
3478
3429
  /**
3479
- * <p>The maximum number of cases to return. The current maximum supported value is 25. This is
3480
- * also the default value when no other value is provided.</p>
3430
+ * <p>The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.</p>
3481
3431
  * @public
3482
3432
  */
3483
3433
  maxResults?: number | undefined;
3484
3434
  /**
3485
- * <p>The token for the next set of results. Use the value returned in the previous
3486
- * response in the next request to retrieve the next set of results.</p>
3435
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
3487
3436
  * @public
3488
3437
  */
3489
3438
  nextToken?: string | undefined;
@@ -3498,8 +3447,7 @@ export interface SearchCasesRequest {
3498
3447
  */
3499
3448
  filter?: CaseFilter | undefined;
3500
3449
  /**
3501
- * <p>A list of sorts where each sort specifies a field and their sort order to be applied to
3502
- * the results. </p>
3450
+ * <p>A list of sorts where each sort specifies a field and their sort order to be applied to the results. </p>
3503
3451
  * @public
3504
3452
  */
3505
3453
  sorts?: Sort[] | undefined;