aws-sdk-connectcases 1.36.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectcases/client.rb +456 -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 +149 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +175 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bb0acd1d42d370aa41bd5b1aee69b155230ccaead815801765ae77e10f21256e
|
4
|
+
data.tar.gz: 7b8a9f93aaf1cc3d3b04f6939aae02e2d04f6e856a01083000b94d8f72c1a945
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c80b650000b479c84d975892ba07ca939e8739da6a6e9f644ba6e5a2d421b699b7e013f728aa2672f5ff95976700c0c7b359fcd0e47a1bb683054e6b6b8a54a5
|
7
|
+
data.tar.gz: dc41792a8b77e9dcd0e4e2c8064ff58e051ebfcc710b05f3e01899291ca1bc041b53d2eee5968a6177415fc7a1ec0874d2d60f45fa6a75d649f52a2ec75cb62a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.38.0 (2025-02-06)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds the ability to conditionally require fields on a template. Check public documentation for more information.
|
8
|
+
|
9
|
+
1.37.0 (2025-01-15)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.36.0 (2024-11-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -257,11 +257,34 @@ module Aws::ConnectCases
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -447,6 +470,75 @@ module Aws::ConnectCases
|
|
447
470
|
|
448
471
|
# @!group API Operations
|
449
472
|
|
473
|
+
# Gets a batch of case rules. In the Amazon Connect admin website, case
|
474
|
+
# rules are known as *case field conditions*. For more information about
|
475
|
+
# case field conditions, see [Add case field conditions to a case
|
476
|
+
# template][1].
|
477
|
+
#
|
478
|
+
#
|
479
|
+
#
|
480
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
481
|
+
#
|
482
|
+
# @option params [required, Array<Types::CaseRuleIdentifier>] :case_rules
|
483
|
+
# List of case rule identifiers.
|
484
|
+
#
|
485
|
+
# @option params [required, String] :domain_id
|
486
|
+
# Unique identifier of a Cases domain.
|
487
|
+
#
|
488
|
+
# @return [Types::BatchGetCaseRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
489
|
+
#
|
490
|
+
# * {Types::BatchGetCaseRuleResponse#case_rules #case_rules} => Array<Types::GetCaseRuleResponse>
|
491
|
+
# * {Types::BatchGetCaseRuleResponse#errors #errors} => Array<Types::CaseRuleError>
|
492
|
+
#
|
493
|
+
# @example Request syntax with placeholder values
|
494
|
+
#
|
495
|
+
# resp = client.batch_get_case_rule({
|
496
|
+
# case_rules: [ # required
|
497
|
+
# {
|
498
|
+
# id: "CaseRuleId", # required
|
499
|
+
# },
|
500
|
+
# ],
|
501
|
+
# domain_id: "DomainId", # required
|
502
|
+
# })
|
503
|
+
#
|
504
|
+
# @example Response structure
|
505
|
+
#
|
506
|
+
# resp.case_rules #=> Array
|
507
|
+
# resp.case_rules[0].case_rule_arn #=> String
|
508
|
+
# resp.case_rules[0].case_rule_id #=> String
|
509
|
+
# resp.case_rules[0].created_time #=> Time
|
510
|
+
# resp.case_rules[0].deleted #=> Boolean
|
511
|
+
# resp.case_rules[0].description #=> String
|
512
|
+
# resp.case_rules[0].last_modified_time #=> Time
|
513
|
+
# resp.case_rules[0].name #=> String
|
514
|
+
# resp.case_rules[0].rule.required.conditions #=> Array
|
515
|
+
# resp.case_rules[0].rule.required.conditions[0].equal_to.operand_one.field_id #=> String
|
516
|
+
# resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.boolean_value #=> Boolean
|
517
|
+
# resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.double_value #=> Float
|
518
|
+
# resp.case_rules[0].rule.required.conditions[0].equal_to.operand_two.string_value #=> String
|
519
|
+
# resp.case_rules[0].rule.required.conditions[0].equal_to.result #=> Boolean
|
520
|
+
# resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_one.field_id #=> String
|
521
|
+
# resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.boolean_value #=> Boolean
|
522
|
+
# resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.double_value #=> Float
|
523
|
+
# resp.case_rules[0].rule.required.conditions[0].not_equal_to.operand_two.string_value #=> String
|
524
|
+
# resp.case_rules[0].rule.required.conditions[0].not_equal_to.result #=> Boolean
|
525
|
+
# resp.case_rules[0].rule.required.default_value #=> Boolean
|
526
|
+
# resp.case_rules[0].tags #=> Hash
|
527
|
+
# resp.case_rules[0].tags["String"] #=> String
|
528
|
+
# resp.errors #=> Array
|
529
|
+
# resp.errors[0].error_code #=> String
|
530
|
+
# resp.errors[0].id #=> String
|
531
|
+
# resp.errors[0].message #=> String
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetCaseRule AWS API Documentation
|
534
|
+
#
|
535
|
+
# @overload batch_get_case_rule(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def batch_get_case_rule(params = {}, options = {})
|
538
|
+
req = build_request(:batch_get_case_rule, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
450
542
|
# Returns the description for the list of fields in the request
|
451
543
|
# parameters.
|
452
544
|
#
|
@@ -552,7 +644,13 @@ module Aws::ConnectCases
|
|
552
644
|
#
|
553
645
|
# </note>
|
554
646
|
#
|
555
|
-
#
|
647
|
+
# Creates a case in the specified Cases domain. Case system and custom
|
648
|
+
# fields are taken as an array id/value pairs with a declared data
|
649
|
+
# types.
|
650
|
+
#
|
651
|
+
# The following fields are required when creating a case:
|
652
|
+
#
|
653
|
+
# <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>
|
556
654
|
#
|
557
655
|
#
|
558
656
|
#
|
@@ -627,6 +725,89 @@ module Aws::ConnectCases
|
|
627
725
|
req.send_request(options)
|
628
726
|
end
|
629
727
|
|
728
|
+
# Creates a new case rule. In the Amazon Connect admin website, case
|
729
|
+
# rules are known as *case field conditions*. For more information about
|
730
|
+
# case field conditions, see [Add case field conditions to a case
|
731
|
+
# template][1].
|
732
|
+
#
|
733
|
+
#
|
734
|
+
#
|
735
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
736
|
+
#
|
737
|
+
# @option params [String] :description
|
738
|
+
# The description of a case rule.
|
739
|
+
#
|
740
|
+
# @option params [required, String] :domain_id
|
741
|
+
# Unique identifier of a Cases domain.
|
742
|
+
#
|
743
|
+
# @option params [required, String] :name
|
744
|
+
# Name of the case rule.
|
745
|
+
#
|
746
|
+
# @option params [required, Types::CaseRuleDetails] :rule
|
747
|
+
# Represents what rule type should take place, under what conditions.
|
748
|
+
#
|
749
|
+
# @return [Types::CreateCaseRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
750
|
+
#
|
751
|
+
# * {Types::CreateCaseRuleResponse#case_rule_arn #case_rule_arn} => String
|
752
|
+
# * {Types::CreateCaseRuleResponse#case_rule_id #case_rule_id} => String
|
753
|
+
#
|
754
|
+
# @example Request syntax with placeholder values
|
755
|
+
#
|
756
|
+
# resp = client.create_case_rule({
|
757
|
+
# description: "CaseRuleDescription",
|
758
|
+
# domain_id: "DomainId", # required
|
759
|
+
# name: "CaseRuleName", # required
|
760
|
+
# rule: { # required
|
761
|
+
# required: {
|
762
|
+
# conditions: [ # required
|
763
|
+
# {
|
764
|
+
# equal_to: {
|
765
|
+
# operand_one: { # required
|
766
|
+
# field_id: "FieldId",
|
767
|
+
# },
|
768
|
+
# operand_two: { # required
|
769
|
+
# boolean_value: false,
|
770
|
+
# double_value: 1.0,
|
771
|
+
# empty_value: {
|
772
|
+
# },
|
773
|
+
# string_value: "OperandTwoStringValueString",
|
774
|
+
# },
|
775
|
+
# result: false, # required
|
776
|
+
# },
|
777
|
+
# not_equal_to: {
|
778
|
+
# operand_one: { # required
|
779
|
+
# field_id: "FieldId",
|
780
|
+
# },
|
781
|
+
# operand_two: { # required
|
782
|
+
# boolean_value: false,
|
783
|
+
# double_value: 1.0,
|
784
|
+
# empty_value: {
|
785
|
+
# },
|
786
|
+
# string_value: "OperandTwoStringValueString",
|
787
|
+
# },
|
788
|
+
# result: false, # required
|
789
|
+
# },
|
790
|
+
# },
|
791
|
+
# ],
|
792
|
+
# default_value: false, # required
|
793
|
+
# },
|
794
|
+
# },
|
795
|
+
# })
|
796
|
+
#
|
797
|
+
# @example Response structure
|
798
|
+
#
|
799
|
+
# resp.case_rule_arn #=> String
|
800
|
+
# resp.case_rule_id #=> String
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseRule AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload create_case_rule(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def create_case_rule(params = {}, options = {})
|
807
|
+
req = build_request(:create_case_rule, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
630
811
|
# Creates a domain, which is a container for all case data, such as
|
631
812
|
# cases, fields, templates and layouts. Each Amazon Connect instance can
|
632
813
|
# be associated with only one Cases domain.
|
@@ -815,7 +996,7 @@ module Aws::ConnectCases
|
|
815
996
|
# [DescribeUser][1] permission on the ARN of the user that you
|
816
997
|
# provide.
|
817
998
|
#
|
818
|
-
#
|
999
|
+
# * The `type` field is reserved for internal use only.
|
819
1000
|
#
|
820
1001
|
# </note>
|
821
1002
|
#
|
@@ -889,6 +1070,23 @@ module Aws::ConnectCases
|
|
889
1070
|
# Inactive, as indicated by its status. Inactive templates cannot be
|
890
1071
|
# used to create cases.
|
891
1072
|
#
|
1073
|
+
# Other template APIs are:
|
1074
|
+
#
|
1075
|
+
# * [DeleteTemplate][1]
|
1076
|
+
#
|
1077
|
+
# * [GetTemplate][2]
|
1078
|
+
#
|
1079
|
+
# * [ListTemplates][3]
|
1080
|
+
#
|
1081
|
+
# * [UpdateTemplate][4]
|
1082
|
+
#
|
1083
|
+
#
|
1084
|
+
#
|
1085
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html
|
1086
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html
|
1087
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
|
1088
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html
|
1089
|
+
#
|
892
1090
|
# @option params [String] :description
|
893
1091
|
# A brief description of the template.
|
894
1092
|
#
|
@@ -905,6 +1103,14 @@ module Aws::ConnectCases
|
|
905
1103
|
# A list of fields that must contain a value for a case to be
|
906
1104
|
# successfully created with this template.
|
907
1105
|
#
|
1106
|
+
# @option params [Array<Types::TemplateRule>] :rules
|
1107
|
+
# A list of case rules (also known as [case field conditions][1]) on a
|
1108
|
+
# template.
|
1109
|
+
#
|
1110
|
+
#
|
1111
|
+
#
|
1112
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1113
|
+
#
|
908
1114
|
# @option params [String] :status
|
909
1115
|
# The status of the template.
|
910
1116
|
#
|
@@ -927,6 +1133,12 @@ module Aws::ConnectCases
|
|
927
1133
|
# field_id: "FieldId", # required
|
928
1134
|
# },
|
929
1135
|
# ],
|
1136
|
+
# rules: [
|
1137
|
+
# {
|
1138
|
+
# case_rule_id: "CaseRuleId", # required
|
1139
|
+
# field_id: "FieldId", # required
|
1140
|
+
# },
|
1141
|
+
# ],
|
930
1142
|
# status: "Active", # accepts Active, Inactive
|
931
1143
|
# })
|
932
1144
|
#
|
@@ -944,6 +1156,39 @@ module Aws::ConnectCases
|
|
944
1156
|
req.send_request(options)
|
945
1157
|
end
|
946
1158
|
|
1159
|
+
# Deletes a case rule. In the Amazon Connect admin website, case rules
|
1160
|
+
# are known as *case field conditions*. For more information about case
|
1161
|
+
# field conditions, see [Add case field conditions to a case
|
1162
|
+
# template][1].
|
1163
|
+
#
|
1164
|
+
#
|
1165
|
+
#
|
1166
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1167
|
+
#
|
1168
|
+
# @option params [required, String] :case_rule_id
|
1169
|
+
# Unique identifier of a case rule.
|
1170
|
+
#
|
1171
|
+
# @option params [required, String] :domain_id
|
1172
|
+
# Unique identifier of a Cases domain.
|
1173
|
+
#
|
1174
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1175
|
+
#
|
1176
|
+
# @example Request syntax with placeholder values
|
1177
|
+
#
|
1178
|
+
# resp = client.delete_case_rule({
|
1179
|
+
# case_rule_id: "CaseRuleId", # required
|
1180
|
+
# domain_id: "DomainId", # required
|
1181
|
+
# })
|
1182
|
+
#
|
1183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseRule AWS API Documentation
|
1184
|
+
#
|
1185
|
+
# @overload delete_case_rule(params = {})
|
1186
|
+
# @param [Hash] params ({})
|
1187
|
+
def delete_case_rule(params = {}, options = {})
|
1188
|
+
req = build_request(:delete_case_rule, params)
|
1189
|
+
req.send_request(options)
|
1190
|
+
end
|
1191
|
+
|
947
1192
|
# Deletes a Cases domain.
|
948
1193
|
#
|
949
1194
|
# <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
|
@@ -1339,7 +1584,23 @@ module Aws::ConnectCases
|
|
1339
1584
|
req.send_request(options)
|
1340
1585
|
end
|
1341
1586
|
|
1342
|
-
# Returns the details for the requested template.
|
1587
|
+
# Returns the details for the requested template. Other template APIs
|
1588
|
+
# are:
|
1589
|
+
#
|
1590
|
+
# * [CreateTemplate][1]
|
1591
|
+
#
|
1592
|
+
# * [DeleteTemplate][2]
|
1593
|
+
#
|
1594
|
+
# * [ListTemplates][3]
|
1595
|
+
#
|
1596
|
+
# * [UpdateTemplate][4]
|
1597
|
+
#
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html
|
1601
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html
|
1602
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
|
1603
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html
|
1343
1604
|
#
|
1344
1605
|
# @option params [required, String] :domain_id
|
1345
1606
|
# The unique identifier of the Cases domain.
|
@@ -1356,6 +1617,7 @@ module Aws::ConnectCases
|
|
1356
1617
|
# * {Types::GetTemplateResponse#layout_configuration #layout_configuration} => Types::LayoutConfiguration
|
1357
1618
|
# * {Types::GetTemplateResponse#name #name} => String
|
1358
1619
|
# * {Types::GetTemplateResponse#required_fields #required_fields} => Array<Types::RequiredField>
|
1620
|
+
# * {Types::GetTemplateResponse#rules #rules} => Array<Types::TemplateRule>
|
1359
1621
|
# * {Types::GetTemplateResponse#status #status} => String
|
1360
1622
|
# * {Types::GetTemplateResponse#tags #tags} => Hash<String,String>
|
1361
1623
|
# * {Types::GetTemplateResponse#template_arn #template_arn} => String
|
@@ -1378,6 +1640,9 @@ module Aws::ConnectCases
|
|
1378
1640
|
# resp.name #=> String
|
1379
1641
|
# resp.required_fields #=> Array
|
1380
1642
|
# resp.required_fields[0].field_id #=> String
|
1643
|
+
# resp.rules #=> Array
|
1644
|
+
# resp.rules[0].case_rule_id #=> String
|
1645
|
+
# resp.rules[0].field_id #=> String
|
1381
1646
|
# resp.status #=> String, one of "Active", "Inactive"
|
1382
1647
|
# resp.tags #=> Hash
|
1383
1648
|
# resp.tags["String"] #=> String
|
@@ -1393,6 +1658,60 @@ module Aws::ConnectCases
|
|
1393
1658
|
req.send_request(options)
|
1394
1659
|
end
|
1395
1660
|
|
1661
|
+
# Lists all case rules in a Cases domain. In the Amazon Connect admin
|
1662
|
+
# website, case rules are known as *case field conditions*. For more
|
1663
|
+
# information about case field conditions, see [Add case field
|
1664
|
+
# conditions to a case template][1].
|
1665
|
+
#
|
1666
|
+
#
|
1667
|
+
#
|
1668
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
1669
|
+
#
|
1670
|
+
# @option params [required, String] :domain_id
|
1671
|
+
# Unique identifier of a Cases domain.
|
1672
|
+
#
|
1673
|
+
# @option params [Integer] :max_results
|
1674
|
+
# The maximum number of results to return per page.
|
1675
|
+
#
|
1676
|
+
# @option params [String] :next_token
|
1677
|
+
# The token for the next set of results. Use the value returned in the
|
1678
|
+
# previous response in the next request to retrieve the next set of
|
1679
|
+
# results.
|
1680
|
+
#
|
1681
|
+
# @return [Types::ListCaseRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1682
|
+
#
|
1683
|
+
# * {Types::ListCaseRulesResponse#case_rules #case_rules} => Array<Types::CaseRuleSummary>
|
1684
|
+
# * {Types::ListCaseRulesResponse#next_token #next_token} => String
|
1685
|
+
#
|
1686
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1687
|
+
#
|
1688
|
+
# @example Request syntax with placeholder values
|
1689
|
+
#
|
1690
|
+
# resp = client.list_case_rules({
|
1691
|
+
# domain_id: "DomainId", # required
|
1692
|
+
# max_results: 1,
|
1693
|
+
# next_token: "NextToken",
|
1694
|
+
# })
|
1695
|
+
#
|
1696
|
+
# @example Response structure
|
1697
|
+
#
|
1698
|
+
# resp.case_rules #=> Array
|
1699
|
+
# resp.case_rules[0].case_rule_arn #=> String
|
1700
|
+
# resp.case_rules[0].case_rule_id #=> String
|
1701
|
+
# resp.case_rules[0].description #=> String
|
1702
|
+
# resp.case_rules[0].name #=> String
|
1703
|
+
# resp.case_rules[0].rule_type #=> String, one of "Required"
|
1704
|
+
# resp.next_token #=> String
|
1705
|
+
#
|
1706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCaseRules AWS API Documentation
|
1707
|
+
#
|
1708
|
+
# @overload list_case_rules(params = {})
|
1709
|
+
# @param [Hash] params ({})
|
1710
|
+
def list_case_rules(params = {}, options = {})
|
1711
|
+
req = build_request(:list_case_rules, params)
|
1712
|
+
req.send_request(options)
|
1713
|
+
end
|
1714
|
+
|
1396
1715
|
# Lists cases for a given contact.
|
1397
1716
|
#
|
1398
1717
|
# @option params [required, String] :contact_arn
|
@@ -1661,6 +1980,23 @@ module Aws::ConnectCases
|
|
1661
1980
|
# Lists all of the templates in a Cases domain. Each list item is a
|
1662
1981
|
# condensed summary object of the template.
|
1663
1982
|
#
|
1983
|
+
# Other template APIs are:
|
1984
|
+
#
|
1985
|
+
# * [CreateTemplate][1]
|
1986
|
+
#
|
1987
|
+
# * [DeleteTemplate][2]
|
1988
|
+
#
|
1989
|
+
# * [GetTemplate][3]
|
1990
|
+
#
|
1991
|
+
# * [UpdateTemplate][4]
|
1992
|
+
#
|
1993
|
+
#
|
1994
|
+
#
|
1995
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html
|
1996
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html
|
1997
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html
|
1998
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html
|
1999
|
+
#
|
1664
2000
|
# @option params [required, String] :domain_id
|
1665
2001
|
# The unique identifier of the Cases domain.
|
1666
2002
|
#
|
@@ -2066,7 +2402,12 @@ module Aws::ConnectCases
|
|
2066
2402
|
#
|
2067
2403
|
# </note>
|
2068
2404
|
#
|
2069
|
-
#
|
2405
|
+
# Updates the values of fields on a case. Fields to be updated are
|
2406
|
+
# received as an array of id/value pairs identical to the `CreateCase`
|
2407
|
+
# input .
|
2408
|
+
#
|
2409
|
+
# If the action is successful, the service sends back an HTTP 200
|
2410
|
+
# response with an empty HTTP body.
|
2070
2411
|
#
|
2071
2412
|
#
|
2072
2413
|
#
|
@@ -2119,6 +2460,85 @@ module Aws::ConnectCases
|
|
2119
2460
|
req.send_request(options)
|
2120
2461
|
end
|
2121
2462
|
|
2463
|
+
# Updates a case rule. In the Amazon Connect admin website, case rules
|
2464
|
+
# are known as *case field conditions*. For more information about case
|
2465
|
+
# field conditions, see [Add case field conditions to a case
|
2466
|
+
# template][1].
|
2467
|
+
#
|
2468
|
+
#
|
2469
|
+
#
|
2470
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2471
|
+
#
|
2472
|
+
# @option params [required, String] :case_rule_id
|
2473
|
+
# Unique identifier of a case rule.
|
2474
|
+
#
|
2475
|
+
# @option params [String] :description
|
2476
|
+
# Description of a case rule.
|
2477
|
+
#
|
2478
|
+
# @option params [required, String] :domain_id
|
2479
|
+
# Unique identifier of a Cases domain.
|
2480
|
+
#
|
2481
|
+
# @option params [String] :name
|
2482
|
+
# Name of the case rule.
|
2483
|
+
#
|
2484
|
+
# @option params [Types::CaseRuleDetails] :rule
|
2485
|
+
# Represents what rule type should take place, under what conditions.
|
2486
|
+
#
|
2487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2488
|
+
#
|
2489
|
+
# @example Request syntax with placeholder values
|
2490
|
+
#
|
2491
|
+
# resp = client.update_case_rule({
|
2492
|
+
# case_rule_id: "CaseRuleId", # required
|
2493
|
+
# description: "CaseRuleDescription",
|
2494
|
+
# domain_id: "DomainId", # required
|
2495
|
+
# name: "CaseRuleName",
|
2496
|
+
# rule: {
|
2497
|
+
# required: {
|
2498
|
+
# conditions: [ # required
|
2499
|
+
# {
|
2500
|
+
# equal_to: {
|
2501
|
+
# operand_one: { # required
|
2502
|
+
# field_id: "FieldId",
|
2503
|
+
# },
|
2504
|
+
# operand_two: { # required
|
2505
|
+
# boolean_value: false,
|
2506
|
+
# double_value: 1.0,
|
2507
|
+
# empty_value: {
|
2508
|
+
# },
|
2509
|
+
# string_value: "OperandTwoStringValueString",
|
2510
|
+
# },
|
2511
|
+
# result: false, # required
|
2512
|
+
# },
|
2513
|
+
# not_equal_to: {
|
2514
|
+
# operand_one: { # required
|
2515
|
+
# field_id: "FieldId",
|
2516
|
+
# },
|
2517
|
+
# operand_two: { # required
|
2518
|
+
# boolean_value: false,
|
2519
|
+
# double_value: 1.0,
|
2520
|
+
# empty_value: {
|
2521
|
+
# },
|
2522
|
+
# string_value: "OperandTwoStringValueString",
|
2523
|
+
# },
|
2524
|
+
# result: false, # required
|
2525
|
+
# },
|
2526
|
+
# },
|
2527
|
+
# ],
|
2528
|
+
# default_value: false, # required
|
2529
|
+
# },
|
2530
|
+
# },
|
2531
|
+
# })
|
2532
|
+
#
|
2533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRule AWS API Documentation
|
2534
|
+
#
|
2535
|
+
# @overload update_case_rule(params = {})
|
2536
|
+
# @param [Hash] params ({})
|
2537
|
+
def update_case_rule(params = {}, options = {})
|
2538
|
+
req = build_request(:update_case_rule, params)
|
2539
|
+
req.send_request(options)
|
2540
|
+
end
|
2541
|
+
|
2122
2542
|
# Updates the properties of an existing field.
|
2123
2543
|
#
|
2124
2544
|
# @option params [String] :description
|
@@ -2237,6 +2657,23 @@ module Aws::ConnectCases
|
|
2237
2657
|
# given attribute, that attribute is ignored and its current value is
|
2238
2658
|
# preserved.
|
2239
2659
|
#
|
2660
|
+
# Other template APIs are:
|
2661
|
+
#
|
2662
|
+
# * [CreateTemplate][1]
|
2663
|
+
#
|
2664
|
+
# * [DeleteTemplate][2]
|
2665
|
+
#
|
2666
|
+
# * [GetTemplate][3]
|
2667
|
+
#
|
2668
|
+
# * [ListTemplates][4]
|
2669
|
+
#
|
2670
|
+
#
|
2671
|
+
#
|
2672
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html
|
2673
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html
|
2674
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html
|
2675
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html
|
2676
|
+
#
|
2240
2677
|
# @option params [String] :description
|
2241
2678
|
# A brief description of the template.
|
2242
2679
|
#
|
@@ -2253,6 +2690,14 @@ module Aws::ConnectCases
|
|
2253
2690
|
# A list of fields that must contain a value for a case to be
|
2254
2691
|
# successfully created with this template.
|
2255
2692
|
#
|
2693
|
+
# @option params [Array<Types::TemplateRule>] :rules
|
2694
|
+
# A list of case rules (also known as [case field conditions][1]) on a
|
2695
|
+
# template.
|
2696
|
+
#
|
2697
|
+
#
|
2698
|
+
#
|
2699
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html
|
2700
|
+
#
|
2256
2701
|
# @option params [String] :status
|
2257
2702
|
# The status of the template.
|
2258
2703
|
#
|
@@ -2275,6 +2720,12 @@ module Aws::ConnectCases
|
|
2275
2720
|
# field_id: "FieldId", # required
|
2276
2721
|
# },
|
2277
2722
|
# ],
|
2723
|
+
# rules: [
|
2724
|
+
# {
|
2725
|
+
# case_rule_id: "CaseRuleId", # required
|
2726
|
+
# field_id: "FieldId", # required
|
2727
|
+
# },
|
2728
|
+
# ],
|
2278
2729
|
# status: "Active", # accepts Active, Inactive
|
2279
2730
|
# template_id: "TemplateId", # required
|
2280
2731
|
# })
|
@@ -2306,7 +2757,7 @@ module Aws::ConnectCases
|
|
2306
2757
|
tracer: tracer
|
2307
2758
|
)
|
2308
2759
|
context[:gem_name] = 'aws-sdk-connectcases'
|
2309
|
-
context[:gem_version] = '1.
|
2760
|
+
context[:gem_version] = '1.38.0'
|
2310
2761
|
Seahorse::Client::Request.new(handlers, context)
|
2311
2762
|
end
|
2312
2763
|
|