aws-sdk-connectcases 1.37.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectcases/client.rb +433 -5
- data/lib/aws-sdk-connectcases/client_api.rb +238 -0
- data/lib/aws-sdk-connectcases/endpoint_provider.rb +13 -17
- data/lib/aws-sdk-connectcases/types.rb +600 -1
- data/lib/aws-sdk-connectcases.rb +2 -2
- data/sig/client.rbs +147 -0
- data/sig/types.rbs +175 -0
- metadata +2 -2
@@ -178,6 +178,40 @@ module Aws::ConnectCases
|
|
178
178
|
include Aws::Structure
|
179
179
|
end
|
180
180
|
|
181
|
+
# @!attribute [rw] case_rules
|
182
|
+
# List of case rule identifiers.
|
183
|
+
# @return [Array<Types::CaseRuleIdentifier>]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] domain_id
|
186
|
+
# Unique identifier of a Cases domain.
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetCaseRuleRequest AWS API Documentation
|
190
|
+
#
|
191
|
+
class BatchGetCaseRuleRequest < Struct.new(
|
192
|
+
:case_rules,
|
193
|
+
:domain_id)
|
194
|
+
SENSITIVE = []
|
195
|
+
include Aws::Structure
|
196
|
+
end
|
197
|
+
|
198
|
+
# @!attribute [rw] case_rules
|
199
|
+
# List of detailed case rule information.
|
200
|
+
# @return [Array<Types::GetCaseRuleResponse>]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] errors
|
203
|
+
# List of case rule errors.
|
204
|
+
# @return [Array<Types::CaseRuleError>]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetCaseRuleResponse AWS API Documentation
|
207
|
+
#
|
208
|
+
class BatchGetCaseRuleResponse < Struct.new(
|
209
|
+
:case_rules,
|
210
|
+
:errors)
|
211
|
+
SENSITIVE = []
|
212
|
+
include Aws::Structure
|
213
|
+
end
|
214
|
+
|
181
215
|
# @!attribute [rw] domain_id
|
182
216
|
# The unique identifier of the Cases domain.
|
183
217
|
# @return [String]
|
@@ -246,6 +280,73 @@ module Aws::ConnectCases
|
|
246
280
|
include Aws::Structure
|
247
281
|
end
|
248
282
|
|
283
|
+
# Boolean condition for a rule. In the Amazon Connect admin website,
|
284
|
+
# case rules are known as *case field conditions*. For more information
|
285
|
+
# about case field conditions, see [Add case field conditions to a case
|
286
|
+
# template][1].
|
287
|
+
#
|
288
|
+
#
|
289
|
+
#
|
290
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
291
|
+
#
|
292
|
+
# @note BooleanCondition is a union - when making an API calls you must set exactly one of the members.
|
293
|
+
#
|
294
|
+
# @note BooleanCondition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of BooleanCondition corresponding to the set member.
|
295
|
+
#
|
296
|
+
# @!attribute [rw] equal_to
|
297
|
+
# Tests that operandOne is equal to operandTwo.
|
298
|
+
# @return [Types::BooleanOperands]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] not_equal_to
|
301
|
+
# Tests that operandOne is not equal to operandTwo.
|
302
|
+
# @return [Types::BooleanOperands]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BooleanCondition AWS API Documentation
|
305
|
+
#
|
306
|
+
class BooleanCondition < Struct.new(
|
307
|
+
:equal_to,
|
308
|
+
:not_equal_to,
|
309
|
+
:unknown)
|
310
|
+
SENSITIVE = []
|
311
|
+
include Aws::Structure
|
312
|
+
include Aws::Structure::Union
|
313
|
+
|
314
|
+
class EqualTo < BooleanCondition; end
|
315
|
+
class NotEqualTo < BooleanCondition; end
|
316
|
+
class Unknown < BooleanCondition; end
|
317
|
+
end
|
318
|
+
|
319
|
+
# Boolean operands for a condition. In the Amazon Connect admin website,
|
320
|
+
# case rules are known as *case field conditions*. For more information
|
321
|
+
# about case field conditions, see [Add case field conditions to a case
|
322
|
+
# template][1].
|
323
|
+
#
|
324
|
+
#
|
325
|
+
#
|
326
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
327
|
+
#
|
328
|
+
# @!attribute [rw] operand_one
|
329
|
+
# Represents the left hand operand in the condition.
|
330
|
+
# @return [Types::OperandOne]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] operand_two
|
333
|
+
# Represents the right hand operand in the condition.
|
334
|
+
# @return [Types::OperandTwo]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] result
|
337
|
+
# The value of the outer rule if the condition evaluates to true.
|
338
|
+
# @return [Boolean]
|
339
|
+
#
|
340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BooleanOperands AWS API Documentation
|
341
|
+
#
|
342
|
+
class BooleanOperands < Struct.new(
|
343
|
+
:operand_one,
|
344
|
+
:operand_two,
|
345
|
+
:result)
|
346
|
+
SENSITIVE = []
|
347
|
+
include Aws::Structure
|
348
|
+
end
|
349
|
+
|
249
350
|
# Details of what case data is published through the case event stream.
|
250
351
|
#
|
251
352
|
# @!attribute [rw] fields
|
@@ -299,6 +400,122 @@ module Aws::ConnectCases
|
|
299
400
|
class Unknown < CaseFilter; end
|
300
401
|
end
|
301
402
|
|
403
|
+
# Represents what rule type should take place, under what conditions. In
|
404
|
+
# the Amazon Connect admin website, case rules are known as *case field
|
405
|
+
# conditions*. For more information about case field conditions, see
|
406
|
+
# [Add case field conditions to a case template][1].
|
407
|
+
#
|
408
|
+
#
|
409
|
+
#
|
410
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
411
|
+
#
|
412
|
+
# @note CaseRuleDetails is a union - when making an API calls you must set exactly one of the members.
|
413
|
+
#
|
414
|
+
# @note CaseRuleDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CaseRuleDetails corresponding to the set member.
|
415
|
+
#
|
416
|
+
# @!attribute [rw] required
|
417
|
+
# Required rule type, used to indicate whether a field is required.
|
418
|
+
# @return [Types::RequiredCaseRule]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseRuleDetails AWS API Documentation
|
421
|
+
#
|
422
|
+
class CaseRuleDetails < Struct.new(
|
423
|
+
:required,
|
424
|
+
:unknown)
|
425
|
+
SENSITIVE = []
|
426
|
+
include Aws::Structure
|
427
|
+
include Aws::Structure::Union
|
428
|
+
|
429
|
+
class Required < CaseRuleDetails; end
|
430
|
+
class Unknown < CaseRuleDetails; end
|
431
|
+
end
|
432
|
+
|
433
|
+
# Error for batch describe case rules API failure. In the Amazon Connect
|
434
|
+
# admin website, case rules are known as *case field conditions*. For
|
435
|
+
# more information about case field conditions, see [Add case field
|
436
|
+
# conditions to a case template][1].
|
437
|
+
#
|
438
|
+
#
|
439
|
+
#
|
440
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
441
|
+
#
|
442
|
+
# @!attribute [rw] error_code
|
443
|
+
# Error code from getting a case rule.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] id
|
447
|
+
# The case rule identifier that caused the error.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] message
|
451
|
+
# Error message from getting a case rule.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseRuleError AWS API Documentation
|
455
|
+
#
|
456
|
+
class CaseRuleError < Struct.new(
|
457
|
+
:error_code,
|
458
|
+
:id,
|
459
|
+
:message)
|
460
|
+
SENSITIVE = []
|
461
|
+
include Aws::Structure
|
462
|
+
end
|
463
|
+
|
464
|
+
# Object containing case rule identifier information.
|
465
|
+
#
|
466
|
+
# @!attribute [rw] id
|
467
|
+
# Unique identifier of a case rule.
|
468
|
+
# @return [String]
|
469
|
+
#
|
470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseRuleIdentifier AWS API Documentation
|
471
|
+
#
|
472
|
+
class CaseRuleIdentifier < Struct.new(
|
473
|
+
:id)
|
474
|
+
SENSITIVE = []
|
475
|
+
include Aws::Structure
|
476
|
+
end
|
477
|
+
|
478
|
+
# Summary information of this case rule. In the Amazon Connect admin
|
479
|
+
# website, case rules are known as *case field conditions*. For more
|
480
|
+
# information about case field conditions, see [Add case field
|
481
|
+
# conditions to a case template][1].
|
482
|
+
#
|
483
|
+
#
|
484
|
+
#
|
485
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
486
|
+
#
|
487
|
+
# @!attribute [rw] case_rule_arn
|
488
|
+
# The Amazon Resource Name (ARN) of the case rule.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] case_rule_id
|
492
|
+
# Unique identifier of a case rule.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] description
|
496
|
+
# Description of a case rule.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] name
|
500
|
+
# Name of the case rule.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] rule_type
|
504
|
+
# Possible types for a rule.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseRuleSummary AWS API Documentation
|
508
|
+
#
|
509
|
+
class CaseRuleSummary < Struct.new(
|
510
|
+
:case_rule_arn,
|
511
|
+
:case_rule_id,
|
512
|
+
:description,
|
513
|
+
:name,
|
514
|
+
:rule_type)
|
515
|
+
SENSITIVE = []
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
518
|
+
|
302
519
|
# Case summary information.
|
303
520
|
#
|
304
521
|
# @!attribute [rw] case_id
|
@@ -480,6 +697,50 @@ module Aws::ConnectCases
|
|
480
697
|
include Aws::Structure
|
481
698
|
end
|
482
699
|
|
700
|
+
# @!attribute [rw] description
|
701
|
+
# The description of a case rule.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] domain_id
|
705
|
+
# Unique identifier of a Cases domain.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] name
|
709
|
+
# Name of the case rule.
|
710
|
+
# @return [String]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] rule
|
713
|
+
# Represents what rule type should take place, under what conditions.
|
714
|
+
# @return [Types::CaseRuleDetails]
|
715
|
+
#
|
716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseRuleRequest AWS API Documentation
|
717
|
+
#
|
718
|
+
class CreateCaseRuleRequest < Struct.new(
|
719
|
+
:description,
|
720
|
+
:domain_id,
|
721
|
+
:name,
|
722
|
+
:rule)
|
723
|
+
SENSITIVE = []
|
724
|
+
include Aws::Structure
|
725
|
+
end
|
726
|
+
|
727
|
+
# @!attribute [rw] case_rule_arn
|
728
|
+
# The Amazon Resource Name (ARN) of a case rule.
|
729
|
+
# @return [String]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] case_rule_id
|
732
|
+
# Unique identifier of a case rule.
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseRuleResponse AWS API Documentation
|
736
|
+
#
|
737
|
+
class CreateCaseRuleResponse < Struct.new(
|
738
|
+
:case_rule_arn,
|
739
|
+
:case_rule_id)
|
740
|
+
SENSITIVE = []
|
741
|
+
include Aws::Structure
|
742
|
+
end
|
743
|
+
|
483
744
|
# @!attribute [rw] name
|
484
745
|
# The name for your Cases domain. It must be unique for your Amazon
|
485
746
|
# Web Services account.
|
@@ -670,6 +931,15 @@ module Aws::ConnectCases
|
|
670
931
|
# successfully created with this template.
|
671
932
|
# @return [Array<Types::RequiredField>]
|
672
933
|
#
|
934
|
+
# @!attribute [rw] rules
|
935
|
+
# A list of case rules (also known as [case field conditions][1]) on a
|
936
|
+
# template.
|
937
|
+
#
|
938
|
+
#
|
939
|
+
#
|
940
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
941
|
+
# @return [Array<Types::TemplateRule>]
|
942
|
+
#
|
673
943
|
# @!attribute [rw] status
|
674
944
|
# The status of the template.
|
675
945
|
# @return [String]
|
@@ -682,6 +952,7 @@ module Aws::ConnectCases
|
|
682
952
|
:layout_configuration,
|
683
953
|
:name,
|
684
954
|
:required_fields,
|
955
|
+
:rules,
|
685
956
|
:status)
|
686
957
|
SENSITIVE = []
|
687
958
|
include Aws::Structure
|
@@ -704,6 +975,27 @@ module Aws::ConnectCases
|
|
704
975
|
include Aws::Structure
|
705
976
|
end
|
706
977
|
|
978
|
+
# @!attribute [rw] case_rule_id
|
979
|
+
# Unique identifier of a case rule.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] domain_id
|
983
|
+
# Unique identifier of a Cases domain.
|
984
|
+
# @return [String]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseRuleRequest AWS API Documentation
|
987
|
+
#
|
988
|
+
class DeleteCaseRuleRequest < Struct.new(
|
989
|
+
:case_rule_id,
|
990
|
+
:domain_id)
|
991
|
+
SENSITIVE = []
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseRuleResponse AWS API Documentation
|
996
|
+
#
|
997
|
+
class DeleteCaseRuleResponse < Aws::EmptyStructure; end
|
998
|
+
|
707
999
|
# @!attribute [rw] domain_id
|
708
1000
|
# The unique identifier of the Cases domain.
|
709
1001
|
# @return [String]
|
@@ -819,6 +1111,21 @@ module Aws::ConnectCases
|
|
819
1111
|
#
|
820
1112
|
class EmptyFieldValue < Aws::EmptyStructure; end
|
821
1113
|
|
1114
|
+
# Represents an empty operand value. In the Amazon Connect admin
|
1115
|
+
# website, case rules are known as *case field conditions*. For more
|
1116
|
+
# information about case field conditions, see [Add case field
|
1117
|
+
# conditions to a case template][1].
|
1118
|
+
#
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1122
|
+
#
|
1123
|
+
# @api private
|
1124
|
+
#
|
1125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/EmptyOperandValue AWS API Documentation
|
1126
|
+
#
|
1127
|
+
class EmptyOperandValue < Aws::EmptyStructure; end
|
1128
|
+
|
822
1129
|
# Configuration to enable EventBridge case event delivery and determine
|
823
1130
|
# what data is delivered.
|
824
1131
|
#
|
@@ -1089,7 +1396,7 @@ module Aws::ConnectCases
|
|
1089
1396
|
|
1090
1397
|
# Object to store union of Field values.
|
1091
1398
|
#
|
1092
|
-
# <note markdown="1"> The `Summary` system field accepts
|
1399
|
+
# <note markdown="1"> The `Summary` system field accepts 3000 characters while all other
|
1093
1400
|
# fields accept 500 characters.
|
1094
1401
|
#
|
1095
1402
|
# </note>
|
@@ -1302,6 +1609,68 @@ module Aws::ConnectCases
|
|
1302
1609
|
include Aws::Structure
|
1303
1610
|
end
|
1304
1611
|
|
1612
|
+
# Detailed case rule information. In the Amazon Connect admin website,
|
1613
|
+
# case rules are known as *case field conditions*. For more information
|
1614
|
+
# about case field conditions, see [Add case field conditions to a case
|
1615
|
+
# template][1].
|
1616
|
+
#
|
1617
|
+
#
|
1618
|
+
#
|
1619
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] case_rule_arn
|
1622
|
+
# The Amazon Resource Name (ARN) of the case rule.
|
1623
|
+
# @return [String]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] case_rule_id
|
1626
|
+
# Unique identifier of a case rule.
|
1627
|
+
# @return [String]
|
1628
|
+
#
|
1629
|
+
# @!attribute [rw] created_time
|
1630
|
+
# Timestamp when the resource was created.
|
1631
|
+
# @return [Time]
|
1632
|
+
#
|
1633
|
+
# @!attribute [rw] deleted
|
1634
|
+
# Indicates whether the resource has been deleted.
|
1635
|
+
# @return [Boolean]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] description
|
1638
|
+
# Description of a case rule.
|
1639
|
+
# @return [String]
|
1640
|
+
#
|
1641
|
+
# @!attribute [rw] last_modified_time
|
1642
|
+
# Timestamp when the resource was created or last modified.
|
1643
|
+
# @return [Time]
|
1644
|
+
#
|
1645
|
+
# @!attribute [rw] name
|
1646
|
+
# Name of the case rule.
|
1647
|
+
# @return [String]
|
1648
|
+
#
|
1649
|
+
# @!attribute [rw] rule
|
1650
|
+
# Represents what rule type should take place, under what conditions.
|
1651
|
+
# @return [Types::CaseRuleDetails]
|
1652
|
+
#
|
1653
|
+
# @!attribute [rw] tags
|
1654
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1655
|
+
# are used to organize, track, or control access for this resource.
|
1656
|
+
# @return [Hash<String,String>]
|
1657
|
+
#
|
1658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseRuleResponse AWS API Documentation
|
1659
|
+
#
|
1660
|
+
class GetCaseRuleResponse < Struct.new(
|
1661
|
+
:case_rule_arn,
|
1662
|
+
:case_rule_id,
|
1663
|
+
:created_time,
|
1664
|
+
:deleted,
|
1665
|
+
:description,
|
1666
|
+
:last_modified_time,
|
1667
|
+
:name,
|
1668
|
+
:rule,
|
1669
|
+
:tags)
|
1670
|
+
SENSITIVE = []
|
1671
|
+
include Aws::Structure
|
1672
|
+
end
|
1673
|
+
|
1305
1674
|
# @!attribute [rw] domain_id
|
1306
1675
|
# The unique identifier of the Cases domain.
|
1307
1676
|
# @return [String]
|
@@ -1524,6 +1893,15 @@ module Aws::ConnectCases
|
|
1524
1893
|
# successfully created with this template.
|
1525
1894
|
# @return [Array<Types::RequiredField>]
|
1526
1895
|
#
|
1896
|
+
# @!attribute [rw] rules
|
1897
|
+
# A list of case rules (also known as [case field conditions][1]) on a
|
1898
|
+
# template.
|
1899
|
+
#
|
1900
|
+
#
|
1901
|
+
#
|
1902
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1903
|
+
# @return [Array<Types::TemplateRule>]
|
1904
|
+
#
|
1527
1905
|
# @!attribute [rw] status
|
1528
1906
|
# The status of the template.
|
1529
1907
|
# @return [String]
|
@@ -1551,6 +1929,7 @@ module Aws::ConnectCases
|
|
1551
1929
|
:layout_configuration,
|
1552
1930
|
:name,
|
1553
1931
|
:required_fields,
|
1932
|
+
:rules,
|
1554
1933
|
:status,
|
1555
1934
|
:tags,
|
1556
1935
|
:template_arn,
|
@@ -1656,6 +2035,48 @@ module Aws::ConnectCases
|
|
1656
2035
|
include Aws::Structure
|
1657
2036
|
end
|
1658
2037
|
|
2038
|
+
# @!attribute [rw] domain_id
|
2039
|
+
# Unique identifier of a Cases domain.
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] max_results
|
2043
|
+
# The maximum number of results to return per page.
|
2044
|
+
# @return [Integer]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] next_token
|
2047
|
+
# The token for the next set of results. Use the value returned in the
|
2048
|
+
# previous response in the next request to retrieve the next set of
|
2049
|
+
# results.
|
2050
|
+
# @return [String]
|
2051
|
+
#
|
2052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCaseRulesRequest AWS API Documentation
|
2053
|
+
#
|
2054
|
+
class ListCaseRulesRequest < Struct.new(
|
2055
|
+
:domain_id,
|
2056
|
+
:max_results,
|
2057
|
+
:next_token)
|
2058
|
+
SENSITIVE = []
|
2059
|
+
include Aws::Structure
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
# @!attribute [rw] case_rules
|
2063
|
+
# A list of field summary objects.
|
2064
|
+
# @return [Array<Types::CaseRuleSummary>]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] next_token
|
2067
|
+
# The token for the next set of results. This is null if there are no
|
2068
|
+
# more results to return.
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCaseRulesResponse AWS API Documentation
|
2072
|
+
#
|
2073
|
+
class ListCaseRulesResponse < Struct.new(
|
2074
|
+
:case_rules,
|
2075
|
+
:next_token)
|
2076
|
+
SENSITIVE = []
|
2077
|
+
include Aws::Structure
|
2078
|
+
end
|
2079
|
+
|
1659
2080
|
# @!attribute [rw] contact_arn
|
1660
2081
|
# A unique identifier of a contact in Amazon Connect.
|
1661
2082
|
# @return [String]
|
@@ -1948,6 +2369,84 @@ module Aws::ConnectCases
|
|
1948
2369
|
include Aws::Structure
|
1949
2370
|
end
|
1950
2371
|
|
2372
|
+
# Represents the left hand operand in the condition. In the Amazon
|
2373
|
+
# Connect admin website, case rules are known as *case field
|
2374
|
+
# conditions*. For more information about case field conditions, see
|
2375
|
+
# [Add case field conditions to a case template][1].
|
2376
|
+
#
|
2377
|
+
#
|
2378
|
+
#
|
2379
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2380
|
+
#
|
2381
|
+
# @note OperandOne is a union - when making an API calls you must set exactly one of the members.
|
2382
|
+
#
|
2383
|
+
# @note OperandOne is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OperandOne corresponding to the set member.
|
2384
|
+
#
|
2385
|
+
# @!attribute [rw] field_id
|
2386
|
+
# The field ID that this operand should take the value of.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/OperandOne AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class OperandOne < Struct.new(
|
2392
|
+
:field_id,
|
2393
|
+
:unknown)
|
2394
|
+
SENSITIVE = []
|
2395
|
+
include Aws::Structure
|
2396
|
+
include Aws::Structure::Union
|
2397
|
+
|
2398
|
+
class FieldId < OperandOne; end
|
2399
|
+
class Unknown < OperandOne; end
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Represents the right hand operand in the condition. In the Amazon
|
2403
|
+
# Connect admin website, case rules are known as *case field
|
2404
|
+
# conditions*. For more information about case field conditions, see
|
2405
|
+
# [Add case field conditions to a case template][1].
|
2406
|
+
#
|
2407
|
+
#
|
2408
|
+
#
|
2409
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2410
|
+
#
|
2411
|
+
# @note OperandTwo is a union - when making an API calls you must set exactly one of the members.
|
2412
|
+
#
|
2413
|
+
# @note OperandTwo is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OperandTwo corresponding to the set member.
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] boolean_value
|
2416
|
+
# Boolean value type.
|
2417
|
+
# @return [Boolean]
|
2418
|
+
#
|
2419
|
+
# @!attribute [rw] double_value
|
2420
|
+
# Double value type.
|
2421
|
+
# @return [Float]
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] empty_value
|
2424
|
+
# Empty value type.
|
2425
|
+
# @return [Types::EmptyOperandValue]
|
2426
|
+
#
|
2427
|
+
# @!attribute [rw] string_value
|
2428
|
+
# String value type.
|
2429
|
+
# @return [String]
|
2430
|
+
#
|
2431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/OperandTwo AWS API Documentation
|
2432
|
+
#
|
2433
|
+
class OperandTwo < Struct.new(
|
2434
|
+
:boolean_value,
|
2435
|
+
:double_value,
|
2436
|
+
:empty_value,
|
2437
|
+
:string_value,
|
2438
|
+
:unknown)
|
2439
|
+
SENSITIVE = []
|
2440
|
+
include Aws::Structure
|
2441
|
+
include Aws::Structure::Union
|
2442
|
+
|
2443
|
+
class BooleanValue < OperandTwo; end
|
2444
|
+
class DoubleValue < OperandTwo; end
|
2445
|
+
class EmptyValue < OperandTwo; end
|
2446
|
+
class StringValue < OperandTwo; end
|
2447
|
+
class Unknown < OperandTwo; end
|
2448
|
+
end
|
2449
|
+
|
1951
2450
|
# @!attribute [rw] domain_id
|
1952
2451
|
# The unique identifier of the Cases domain.
|
1953
2452
|
# @return [String]
|
@@ -2087,6 +2586,34 @@ module Aws::ConnectCases
|
|
2087
2586
|
class Unknown < RelatedItemTypeFilter; end
|
2088
2587
|
end
|
2089
2588
|
|
2589
|
+
# Required rule type, used to indicate whether a field is required. In
|
2590
|
+
# the Amazon Connect admin website, case rules are known as *case field
|
2591
|
+
# conditions*. For more information about case field conditions, see
|
2592
|
+
# [Add case field conditions to a case template][1].
|
2593
|
+
#
|
2594
|
+
#
|
2595
|
+
#
|
2596
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2597
|
+
#
|
2598
|
+
# @!attribute [rw] conditions
|
2599
|
+
# List of conditions for the required rule; the first condition to
|
2600
|
+
# evaluate to true dictates the value of the rule.
|
2601
|
+
# @return [Array<Types::BooleanCondition>]
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] default_value
|
2604
|
+
# The value of the rule (that is, whether the field is required)
|
2605
|
+
# should none of the conditions evaluate to true.
|
2606
|
+
# @return [Boolean]
|
2607
|
+
#
|
2608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RequiredCaseRule AWS API Documentation
|
2609
|
+
#
|
2610
|
+
class RequiredCaseRule < Struct.new(
|
2611
|
+
:conditions,
|
2612
|
+
:default_value)
|
2613
|
+
SENSITIVE = []
|
2614
|
+
include Aws::Structure
|
2615
|
+
end
|
2616
|
+
|
2090
2617
|
# List of fields that must have a value provided to create a case.
|
2091
2618
|
#
|
2092
2619
|
# @!attribute [rw] field_id
|
@@ -2395,6 +2922,32 @@ module Aws::ConnectCases
|
|
2395
2922
|
include Aws::Structure
|
2396
2923
|
end
|
2397
2924
|
|
2925
|
+
# An association representing a case rule acting upon a field. In the
|
2926
|
+
# Amazon Connect admin website, case rules are known as *case field
|
2927
|
+
# conditions*. For more information about case field conditions, see
|
2928
|
+
# [Add case field conditions to a case template][1].
|
2929
|
+
#
|
2930
|
+
#
|
2931
|
+
#
|
2932
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2933
|
+
#
|
2934
|
+
# @!attribute [rw] case_rule_id
|
2935
|
+
# Unique identifier of a case rule.
|
2936
|
+
# @return [String]
|
2937
|
+
#
|
2938
|
+
# @!attribute [rw] field_id
|
2939
|
+
# Unique identifier of a field.
|
2940
|
+
# @return [String]
|
2941
|
+
#
|
2942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/TemplateRule AWS API Documentation
|
2943
|
+
#
|
2944
|
+
class TemplateRule < Struct.new(
|
2945
|
+
:case_rule_id,
|
2946
|
+
:field_id)
|
2947
|
+
SENSITIVE = []
|
2948
|
+
include Aws::Structure
|
2949
|
+
end
|
2950
|
+
|
2398
2951
|
# Template summary information.
|
2399
2952
|
#
|
2400
2953
|
# @!attribute [rw] name
|
@@ -2488,6 +3041,42 @@ module Aws::ConnectCases
|
|
2488
3041
|
#
|
2489
3042
|
class UpdateCaseResponse < Aws::EmptyStructure; end
|
2490
3043
|
|
3044
|
+
# @!attribute [rw] case_rule_id
|
3045
|
+
# Unique identifier of a case rule.
|
3046
|
+
# @return [String]
|
3047
|
+
#
|
3048
|
+
# @!attribute [rw] description
|
3049
|
+
# Description of a case rule.
|
3050
|
+
# @return [String]
|
3051
|
+
#
|
3052
|
+
# @!attribute [rw] domain_id
|
3053
|
+
# Unique identifier of a Cases domain.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] name
|
3057
|
+
# Name of the case rule.
|
3058
|
+
# @return [String]
|
3059
|
+
#
|
3060
|
+
# @!attribute [rw] rule
|
3061
|
+
# Represents what rule type should take place, under what conditions.
|
3062
|
+
# @return [Types::CaseRuleDetails]
|
3063
|
+
#
|
3064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRuleRequest AWS API Documentation
|
3065
|
+
#
|
3066
|
+
class UpdateCaseRuleRequest < Struct.new(
|
3067
|
+
:case_rule_id,
|
3068
|
+
:description,
|
3069
|
+
:domain_id,
|
3070
|
+
:name,
|
3071
|
+
:rule)
|
3072
|
+
SENSITIVE = []
|
3073
|
+
include Aws::Structure
|
3074
|
+
end
|
3075
|
+
|
3076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRuleResponse AWS API Documentation
|
3077
|
+
#
|
3078
|
+
class UpdateCaseRuleResponse < Aws::EmptyStructure; end
|
3079
|
+
|
2491
3080
|
# @!attribute [rw] description
|
2492
3081
|
# The description of a field.
|
2493
3082
|
# @return [String]
|
@@ -2572,6 +3161,15 @@ module Aws::ConnectCases
|
|
2572
3161
|
# successfully created with this template.
|
2573
3162
|
# @return [Array<Types::RequiredField>]
|
2574
3163
|
#
|
3164
|
+
# @!attribute [rw] rules
|
3165
|
+
# A list of case rules (also known as [case field conditions][1]) on a
|
3166
|
+
# template.
|
3167
|
+
#
|
3168
|
+
#
|
3169
|
+
#
|
3170
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
3171
|
+
# @return [Array<Types::TemplateRule>]
|
3172
|
+
#
|
2575
3173
|
# @!attribute [rw] status
|
2576
3174
|
# The status of the template.
|
2577
3175
|
# @return [String]
|
@@ -2588,6 +3186,7 @@ module Aws::ConnectCases
|
|
2588
3186
|
:layout_configuration,
|
2589
3187
|
:name,
|
2590
3188
|
:required_fields,
|
3189
|
+
:rules,
|
2591
3190
|
:status,
|
2592
3191
|
:template_id)
|
2593
3192
|
SENSITIVE = []
|