aws-sdk-connectcases 1.1.0 → 1.3.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 +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectcases/client.rb +31 -7
- data/lib/aws-sdk-connectcases/client_api.rb +10 -0
- data/lib/aws-sdk-connectcases/endpoint_provider.rb +35 -94
- data/lib/aws-sdk-connectcases/types.rb +34 -673
- data/lib/aws-sdk-connectcases.rb +1 -1
- metadata +2 -2
@@ -26,40 +26,6 @@ module Aws::ConnectCases
|
|
26
26
|
# Content specific to `BasicLayout` type. It configures fields in the
|
27
27
|
# top panel and More Info tab of agent application.
|
28
28
|
#
|
29
|
-
# @note When making an API call, you may pass BasicLayout
|
30
|
-
# data as a hash:
|
31
|
-
#
|
32
|
-
# {
|
33
|
-
# more_info: {
|
34
|
-
# sections: [
|
35
|
-
# {
|
36
|
-
# field_group: {
|
37
|
-
# fields: [ # required
|
38
|
-
# {
|
39
|
-
# id: "FieldId", # required
|
40
|
-
# },
|
41
|
-
# ],
|
42
|
-
# name: "FieldGroupNameString",
|
43
|
-
# },
|
44
|
-
# },
|
45
|
-
# ],
|
46
|
-
# },
|
47
|
-
# top_panel: {
|
48
|
-
# sections: [
|
49
|
-
# {
|
50
|
-
# field_group: {
|
51
|
-
# fields: [ # required
|
52
|
-
# {
|
53
|
-
# id: "FieldId", # required
|
54
|
-
# },
|
55
|
-
# ],
|
56
|
-
# name: "FieldGroupNameString",
|
57
|
-
# },
|
58
|
-
# },
|
59
|
-
# ],
|
60
|
-
# },
|
61
|
-
# }
|
62
|
-
#
|
63
29
|
# @!attribute [rw] more_info
|
64
30
|
# This represents sections in a tab of the page layout.
|
65
31
|
# @return [Types::LayoutSections]
|
@@ -77,18 +43,6 @@ module Aws::ConnectCases
|
|
77
43
|
include Aws::Structure
|
78
44
|
end
|
79
45
|
|
80
|
-
# @note When making an API call, you may pass BatchGetFieldRequest
|
81
|
-
# data as a hash:
|
82
|
-
#
|
83
|
-
# {
|
84
|
-
# domain_id: "DomainId", # required
|
85
|
-
# fields: [ # required
|
86
|
-
# {
|
87
|
-
# id: "FieldId", # required
|
88
|
-
# },
|
89
|
-
# ],
|
90
|
-
# }
|
91
|
-
#
|
92
46
|
# @!attribute [rw] domain_id
|
93
47
|
# The unique identifier of the Cases domain.
|
94
48
|
# @return [String]
|
@@ -123,21 +77,6 @@ module Aws::ConnectCases
|
|
123
77
|
include Aws::Structure
|
124
78
|
end
|
125
79
|
|
126
|
-
# @note When making an API call, you may pass BatchPutFieldOptionsRequest
|
127
|
-
# data as a hash:
|
128
|
-
#
|
129
|
-
# {
|
130
|
-
# domain_id: "DomainId", # required
|
131
|
-
# field_id: "FieldId", # required
|
132
|
-
# options: [ # required
|
133
|
-
# {
|
134
|
-
# active: false, # required
|
135
|
-
# name: "FieldOptionName", # required
|
136
|
-
# value: "FieldOptionValue", # required
|
137
|
-
# },
|
138
|
-
# ],
|
139
|
-
# }
|
140
|
-
#
|
141
80
|
# @!attribute [rw] domain_id
|
142
81
|
# The unique identifier of the Cases domain.
|
143
82
|
# @return [String]
|
@@ -174,17 +113,6 @@ module Aws::ConnectCases
|
|
174
113
|
|
175
114
|
# Details of what case data is published through the case event stream.
|
176
115
|
#
|
177
|
-
# @note When making an API call, you may pass CaseEventIncludedData
|
178
|
-
# data as a hash:
|
179
|
-
#
|
180
|
-
# {
|
181
|
-
# fields: [ # required
|
182
|
-
# {
|
183
|
-
# id: "FieldId", # required
|
184
|
-
# },
|
185
|
-
# ],
|
186
|
-
# }
|
187
|
-
#
|
188
116
|
# @!attribute [rw] fields
|
189
117
|
# List of field identifiers.
|
190
118
|
# @return [Array<Types::FieldIdentifier>]
|
@@ -251,14 +179,6 @@ module Aws::ConnectCases
|
|
251
179
|
|
252
180
|
# Represents the content of a `Comment` to be returned to agents.
|
253
181
|
#
|
254
|
-
# @note When making an API call, you may pass CommentContent
|
255
|
-
# data as a hash:
|
256
|
-
#
|
257
|
-
# {
|
258
|
-
# body: "CommentBody", # required
|
259
|
-
# content_type: "Text/Plain", # required, accepts Text/Plain
|
260
|
-
# }
|
261
|
-
#
|
262
182
|
# @!attribute [rw] body
|
263
183
|
# Text in the body of a `Comment` on a case.
|
264
184
|
# @return [String]
|
@@ -302,13 +222,6 @@ module Aws::ConnectCases
|
|
302
222
|
|
303
223
|
# An object that represents an Amazon Connect contact object.
|
304
224
|
#
|
305
|
-
# @note When making an API call, you may pass Contact
|
306
|
-
# data as a hash:
|
307
|
-
#
|
308
|
-
# {
|
309
|
-
# contact_arn: "ContactArn", # required
|
310
|
-
# }
|
311
|
-
#
|
312
225
|
# @!attribute [rw] contact_arn
|
313
226
|
# A unique identifier of a contact in Amazon Connect.
|
314
227
|
# @return [String]
|
@@ -349,14 +262,6 @@ module Aws::ConnectCases
|
|
349
262
|
|
350
263
|
# A filter for related items of type `Contact`.
|
351
264
|
#
|
352
|
-
# @note When making an API call, you may pass ContactFilter
|
353
|
-
# data as a hash:
|
354
|
-
#
|
355
|
-
# {
|
356
|
-
# channel: ["Channel"],
|
357
|
-
# contact_arn: "ContactArn",
|
358
|
-
# }
|
359
|
-
#
|
360
265
|
# @!attribute [rw] channel
|
361
266
|
# A list of channels to filter on for related items of type `Contact`.
|
362
267
|
# @return [Array<String>]
|
@@ -374,31 +279,18 @@ module Aws::ConnectCases
|
|
374
279
|
include Aws::Structure
|
375
280
|
end
|
376
281
|
|
377
|
-
# @note When making an API call, you may pass CreateCaseRequest
|
378
|
-
# data as a hash:
|
379
|
-
#
|
380
|
-
# {
|
381
|
-
# client_token: "CreateCaseRequestClientTokenString",
|
382
|
-
# domain_id: "DomainId", # required
|
383
|
-
# fields: [ # required
|
384
|
-
# {
|
385
|
-
# id: "FieldId", # required
|
386
|
-
# value: { # required
|
387
|
-
# boolean_value: false,
|
388
|
-
# double_value: 1.0,
|
389
|
-
# string_value: "FieldValueUnionStringValueString",
|
390
|
-
# },
|
391
|
-
# },
|
392
|
-
# ],
|
393
|
-
# template_id: "TemplateId", # required
|
394
|
-
# }
|
395
|
-
#
|
396
282
|
# @!attribute [rw] client_token
|
397
283
|
# A unique, case-sensitive identifier that you provide to ensure the
|
398
|
-
# idempotency of the request.
|
284
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
285
|
+
# SDK populates this field. For more information about idempotency,
|
286
|
+
# see [Making retries safe with idempotent APIs][1].
|
399
287
|
#
|
400
288
|
# **A suitable default value is auto-generated.** You should normally
|
401
289
|
# not need to pass this option.
|
290
|
+
#
|
291
|
+
#
|
292
|
+
#
|
293
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
402
294
|
# @return [String]
|
403
295
|
#
|
404
296
|
# @!attribute [rw] domain_id
|
@@ -442,13 +334,6 @@ module Aws::ConnectCases
|
|
442
334
|
include Aws::Structure
|
443
335
|
end
|
444
336
|
|
445
|
-
# @note When making an API call, you may pass CreateDomainRequest
|
446
|
-
# data as a hash:
|
447
|
-
#
|
448
|
-
# {
|
449
|
-
# name: "DomainName", # required
|
450
|
-
# }
|
451
|
-
#
|
452
337
|
# @!attribute [rw] name
|
453
338
|
# The name for your Cases domain. It must be unique for your Amazon
|
454
339
|
# Web Services account.
|
@@ -484,16 +369,6 @@ module Aws::ConnectCases
|
|
484
369
|
include Aws::Structure
|
485
370
|
end
|
486
371
|
|
487
|
-
# @note When making an API call, you may pass CreateFieldRequest
|
488
|
-
# data as a hash:
|
489
|
-
#
|
490
|
-
# {
|
491
|
-
# description: "FieldDescription",
|
492
|
-
# domain_id: "DomainId", # required
|
493
|
-
# name: "FieldName", # required
|
494
|
-
# type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect
|
495
|
-
# }
|
496
|
-
#
|
497
372
|
# @!attribute [rw] description
|
498
373
|
# The description of the field.
|
499
374
|
# @return [String]
|
@@ -539,46 +414,6 @@ module Aws::ConnectCases
|
|
539
414
|
include Aws::Structure
|
540
415
|
end
|
541
416
|
|
542
|
-
# @note When making an API call, you may pass CreateLayoutRequest
|
543
|
-
# data as a hash:
|
544
|
-
#
|
545
|
-
# {
|
546
|
-
# content: { # required
|
547
|
-
# basic: {
|
548
|
-
# more_info: {
|
549
|
-
# sections: [
|
550
|
-
# {
|
551
|
-
# field_group: {
|
552
|
-
# fields: [ # required
|
553
|
-
# {
|
554
|
-
# id: "FieldId", # required
|
555
|
-
# },
|
556
|
-
# ],
|
557
|
-
# name: "FieldGroupNameString",
|
558
|
-
# },
|
559
|
-
# },
|
560
|
-
# ],
|
561
|
-
# },
|
562
|
-
# top_panel: {
|
563
|
-
# sections: [
|
564
|
-
# {
|
565
|
-
# field_group: {
|
566
|
-
# fields: [ # required
|
567
|
-
# {
|
568
|
-
# id: "FieldId", # required
|
569
|
-
# },
|
570
|
-
# ],
|
571
|
-
# name: "FieldGroupNameString",
|
572
|
-
# },
|
573
|
-
# },
|
574
|
-
# ],
|
575
|
-
# },
|
576
|
-
# },
|
577
|
-
# },
|
578
|
-
# domain_id: "DomainId", # required
|
579
|
-
# name: "LayoutName", # required
|
580
|
-
# }
|
581
|
-
#
|
582
417
|
# @!attribute [rw] content
|
583
418
|
# Information about which fields will be present in the layout, and
|
584
419
|
# information about the order of the fields.
|
@@ -619,24 +454,6 @@ module Aws::ConnectCases
|
|
619
454
|
include Aws::Structure
|
620
455
|
end
|
621
456
|
|
622
|
-
# @note When making an API call, you may pass CreateRelatedItemRequest
|
623
|
-
# data as a hash:
|
624
|
-
#
|
625
|
-
# {
|
626
|
-
# case_id: "CaseId", # required
|
627
|
-
# content: { # required
|
628
|
-
# comment: {
|
629
|
-
# body: "CommentBody", # required
|
630
|
-
# content_type: "Text/Plain", # required, accepts Text/Plain
|
631
|
-
# },
|
632
|
-
# contact: {
|
633
|
-
# contact_arn: "ContactArn", # required
|
634
|
-
# },
|
635
|
-
# },
|
636
|
-
# domain_id: "DomainId", # required
|
637
|
-
# type: "Contact", # required, accepts Contact, Comment
|
638
|
-
# }
|
639
|
-
#
|
640
457
|
# @!attribute [rw] case_id
|
641
458
|
# A unique identifier of the case.
|
642
459
|
# @return [String]
|
@@ -681,23 +498,6 @@ module Aws::ConnectCases
|
|
681
498
|
include Aws::Structure
|
682
499
|
end
|
683
500
|
|
684
|
-
# @note When making an API call, you may pass CreateTemplateRequest
|
685
|
-
# data as a hash:
|
686
|
-
#
|
687
|
-
# {
|
688
|
-
# description: "TemplateDescription",
|
689
|
-
# domain_id: "DomainId", # required
|
690
|
-
# layout_configuration: {
|
691
|
-
# default_layout: "LayoutId",
|
692
|
-
# },
|
693
|
-
# name: "TemplateName", # required
|
694
|
-
# required_fields: [
|
695
|
-
# {
|
696
|
-
# field_id: "FieldId", # required
|
697
|
-
# },
|
698
|
-
# ],
|
699
|
-
# }
|
700
|
-
#
|
701
501
|
# @!attribute [rw] description
|
702
502
|
# A brief description of the template.
|
703
503
|
# @return [String]
|
@@ -719,6 +519,10 @@ module Aws::ConnectCases
|
|
719
519
|
# successfully created with this template.
|
720
520
|
# @return [Array<Types::RequiredField>]
|
721
521
|
#
|
522
|
+
# @!attribute [rw] status
|
523
|
+
# The status of the template.
|
524
|
+
# @return [String]
|
525
|
+
#
|
722
526
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateTemplateRequest AWS API Documentation
|
723
527
|
#
|
724
528
|
class CreateTemplateRequest < Struct.new(
|
@@ -726,7 +530,8 @@ module Aws::ConnectCases
|
|
726
530
|
:domain_id,
|
727
531
|
:layout_configuration,
|
728
532
|
:name,
|
729
|
-
:required_fields
|
533
|
+
:required_fields,
|
534
|
+
:status)
|
730
535
|
SENSITIVE = []
|
731
536
|
include Aws::Structure
|
732
537
|
end
|
@@ -775,25 +580,6 @@ module Aws::ConnectCases
|
|
775
580
|
# Configuration to enable EventBridge case event delivery and determine
|
776
581
|
# what data is delivered.
|
777
582
|
#
|
778
|
-
# @note When making an API call, you may pass EventBridgeConfiguration
|
779
|
-
# data as a hash:
|
780
|
-
#
|
781
|
-
# {
|
782
|
-
# enabled: false, # required
|
783
|
-
# included_data: {
|
784
|
-
# case_data: {
|
785
|
-
# fields: [ # required
|
786
|
-
# {
|
787
|
-
# id: "FieldId", # required
|
788
|
-
# },
|
789
|
-
# ],
|
790
|
-
# },
|
791
|
-
# related_item_data: {
|
792
|
-
# include_content: false, # required
|
793
|
-
# },
|
794
|
-
# },
|
795
|
-
# }
|
796
|
-
#
|
797
583
|
# @!attribute [rw] enabled
|
798
584
|
# Indicates whether the to broadcast case event data to the customer.
|
799
585
|
# @return [Boolean]
|
@@ -815,22 +601,6 @@ module Aws::ConnectCases
|
|
815
601
|
# Details of what case and related item data is published through the
|
816
602
|
# case event stream.
|
817
603
|
#
|
818
|
-
# @note When making an API call, you may pass EventIncludedData
|
819
|
-
# data as a hash:
|
820
|
-
#
|
821
|
-
# {
|
822
|
-
# case_data: {
|
823
|
-
# fields: [ # required
|
824
|
-
# {
|
825
|
-
# id: "FieldId", # required
|
826
|
-
# },
|
827
|
-
# ],
|
828
|
-
# },
|
829
|
-
# related_item_data: {
|
830
|
-
# include_content: false, # required
|
831
|
-
# },
|
832
|
-
# }
|
833
|
-
#
|
834
604
|
# @!attribute [rw] case_data
|
835
605
|
# Details of what case data is published through the case event
|
836
606
|
# stream.
|
@@ -927,18 +697,6 @@ module Aws::ConnectCases
|
|
927
697
|
|
928
698
|
# Object for a group of fields and associated properties.
|
929
699
|
#
|
930
|
-
# @note When making an API call, you may pass FieldGroup
|
931
|
-
# data as a hash:
|
932
|
-
#
|
933
|
-
# {
|
934
|
-
# fields: [ # required
|
935
|
-
# {
|
936
|
-
# id: "FieldId", # required
|
937
|
-
# },
|
938
|
-
# ],
|
939
|
-
# name: "FieldGroupNameString",
|
940
|
-
# }
|
941
|
-
#
|
942
700
|
# @!attribute [rw] fields
|
943
701
|
# Represents an ordered list containing field related information.
|
944
702
|
# @return [Array<Types::FieldItem>]
|
@@ -958,13 +716,6 @@ module Aws::ConnectCases
|
|
958
716
|
|
959
717
|
# Object for unique identifier of a field.
|
960
718
|
#
|
961
|
-
# @note When making an API call, you may pass FieldIdentifier
|
962
|
-
# data as a hash:
|
963
|
-
#
|
964
|
-
# {
|
965
|
-
# id: "FieldId", # required
|
966
|
-
# }
|
967
|
-
#
|
968
719
|
# @!attribute [rw] id
|
969
720
|
# Unique identifier of a field.
|
970
721
|
# @return [String]
|
@@ -979,13 +730,6 @@ module Aws::ConnectCases
|
|
979
730
|
|
980
731
|
# Object for field related information.
|
981
732
|
#
|
982
|
-
# @note When making an API call, you may pass FieldItem
|
983
|
-
# data as a hash:
|
984
|
-
#
|
985
|
-
# {
|
986
|
-
# id: "FieldId", # required
|
987
|
-
# }
|
988
|
-
#
|
989
733
|
# @!attribute [rw] id
|
990
734
|
# Unique identifier of a field.
|
991
735
|
# @return [String]
|
@@ -1000,15 +744,6 @@ module Aws::ConnectCases
|
|
1000
744
|
|
1001
745
|
# Object for field Options information.
|
1002
746
|
#
|
1003
|
-
# @note When making an API call, you may pass FieldOption
|
1004
|
-
# data as a hash:
|
1005
|
-
#
|
1006
|
-
# {
|
1007
|
-
# active: false, # required
|
1008
|
-
# name: "FieldOptionName", # required
|
1009
|
-
# value: "FieldOptionValue", # required
|
1010
|
-
# }
|
1011
|
-
#
|
1012
747
|
# @!attribute [rw] active
|
1013
748
|
# Describes whether the `FieldOption` is active (displayed) or
|
1014
749
|
# inactive.
|
@@ -1093,18 +828,6 @@ module Aws::ConnectCases
|
|
1093
828
|
|
1094
829
|
# Object for case field values.
|
1095
830
|
#
|
1096
|
-
# @note When making an API call, you may pass FieldValue
|
1097
|
-
# data as a hash:
|
1098
|
-
#
|
1099
|
-
# {
|
1100
|
-
# id: "FieldId", # required
|
1101
|
-
# value: { # required
|
1102
|
-
# boolean_value: false,
|
1103
|
-
# double_value: 1.0,
|
1104
|
-
# string_value: "FieldValueUnionStringValueString",
|
1105
|
-
# },
|
1106
|
-
# }
|
1107
|
-
#
|
1108
831
|
# @!attribute [rw] id
|
1109
832
|
# Unique identifier of a field.
|
1110
833
|
# @return [String]
|
@@ -1159,13 +882,6 @@ module Aws::ConnectCases
|
|
1159
882
|
class Unknown < FieldValueUnion; end
|
1160
883
|
end
|
1161
884
|
|
1162
|
-
# @note When making an API call, you may pass GetCaseEventConfigurationRequest
|
1163
|
-
# data as a hash:
|
1164
|
-
#
|
1165
|
-
# {
|
1166
|
-
# domain_id: "DomainId", # required
|
1167
|
-
# }
|
1168
|
-
#
|
1169
885
|
# @!attribute [rw] domain_id
|
1170
886
|
# The unique identifier of the Cases domain.
|
1171
887
|
# @return [String]
|
@@ -1191,20 +907,6 @@ module Aws::ConnectCases
|
|
1191
907
|
include Aws::Structure
|
1192
908
|
end
|
1193
909
|
|
1194
|
-
# @note When making an API call, you may pass GetCaseRequest
|
1195
|
-
# data as a hash:
|
1196
|
-
#
|
1197
|
-
# {
|
1198
|
-
# case_id: "CaseId", # required
|
1199
|
-
# domain_id: "DomainId", # required
|
1200
|
-
# fields: [ # required
|
1201
|
-
# {
|
1202
|
-
# id: "FieldId", # required
|
1203
|
-
# },
|
1204
|
-
# ],
|
1205
|
-
# next_token: "NextToken",
|
1206
|
-
# }
|
1207
|
-
#
|
1208
910
|
# @!attribute [rw] case_id
|
1209
911
|
# A unique identifier of the case.
|
1210
912
|
# @return [String]
|
@@ -1263,13 +965,6 @@ module Aws::ConnectCases
|
|
1263
965
|
include Aws::Structure
|
1264
966
|
end
|
1265
967
|
|
1266
|
-
# @note When making an API call, you may pass GetDomainRequest
|
1267
|
-
# data as a hash:
|
1268
|
-
#
|
1269
|
-
# {
|
1270
|
-
# domain_id: "DomainId", # required
|
1271
|
-
# }
|
1272
|
-
#
|
1273
968
|
# @!attribute [rw] domain_id
|
1274
969
|
# The unique identifier of the Cases domain.
|
1275
970
|
# @return [String]
|
@@ -1365,14 +1060,6 @@ module Aws::ConnectCases
|
|
1365
1060
|
include Aws::Structure
|
1366
1061
|
end
|
1367
1062
|
|
1368
|
-
# @note When making an API call, you may pass GetLayoutRequest
|
1369
|
-
# data as a hash:
|
1370
|
-
#
|
1371
|
-
# {
|
1372
|
-
# domain_id: "DomainId", # required
|
1373
|
-
# layout_id: "LayoutId", # required
|
1374
|
-
# }
|
1375
|
-
#
|
1376
1063
|
# @!attribute [rw] domain_id
|
1377
1064
|
# The unique identifier of the Cases domain.
|
1378
1065
|
# @return [String]
|
@@ -1424,14 +1111,6 @@ module Aws::ConnectCases
|
|
1424
1111
|
include Aws::Structure
|
1425
1112
|
end
|
1426
1113
|
|
1427
|
-
# @note When making an API call, you may pass GetTemplateRequest
|
1428
|
-
# data as a hash:
|
1429
|
-
#
|
1430
|
-
# {
|
1431
|
-
# domain_id: "DomainId", # required
|
1432
|
-
# template_id: "TemplateId", # required
|
1433
|
-
# }
|
1434
|
-
#
|
1435
1114
|
# @!attribute [rw] domain_id
|
1436
1115
|
# The unique identifier of the Cases domain.
|
1437
1116
|
# @return [String]
|
@@ -1466,6 +1145,10 @@ module Aws::ConnectCases
|
|
1466
1145
|
# successfully created with this template.
|
1467
1146
|
# @return [Array<Types::RequiredField>]
|
1468
1147
|
#
|
1148
|
+
# @!attribute [rw] status
|
1149
|
+
# The status of the template.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1469
1152
|
# @!attribute [rw] tags
|
1470
1153
|
# A map of of key-value pairs that represent tags on a resource. Tags
|
1471
1154
|
# are used to organize, track, or control access for this resource.
|
@@ -1486,6 +1169,7 @@ module Aws::ConnectCases
|
|
1486
1169
|
:layout_configuration,
|
1487
1170
|
:name,
|
1488
1171
|
:required_fields,
|
1172
|
+
:status,
|
1489
1173
|
:tags,
|
1490
1174
|
:template_arn,
|
1491
1175
|
:template_id)
|
@@ -1514,13 +1198,6 @@ module Aws::ConnectCases
|
|
1514
1198
|
|
1515
1199
|
# Object to store configuration of layouts associated to the template.
|
1516
1200
|
#
|
1517
|
-
# @note When making an API call, you may pass LayoutConfiguration
|
1518
|
-
# data as a hash:
|
1519
|
-
#
|
1520
|
-
# {
|
1521
|
-
# default_layout: "LayoutId",
|
1522
|
-
# }
|
1523
|
-
#
|
1524
1201
|
# @!attribute [rw] default_layout
|
1525
1202
|
# Unique identifier of a layout.
|
1526
1203
|
# @return [String]
|
@@ -1560,24 +1237,6 @@ module Aws::ConnectCases
|
|
1560
1237
|
# Ordered list containing different kinds of sections that can be added.
|
1561
1238
|
# A LayoutSections object can only contain one section.
|
1562
1239
|
#
|
1563
|
-
# @note When making an API call, you may pass LayoutSections
|
1564
|
-
# data as a hash:
|
1565
|
-
#
|
1566
|
-
# {
|
1567
|
-
# sections: [
|
1568
|
-
# {
|
1569
|
-
# field_group: {
|
1570
|
-
# fields: [ # required
|
1571
|
-
# {
|
1572
|
-
# id: "FieldId", # required
|
1573
|
-
# },
|
1574
|
-
# ],
|
1575
|
-
# name: "FieldGroupNameString",
|
1576
|
-
# },
|
1577
|
-
# },
|
1578
|
-
# ],
|
1579
|
-
# }
|
1580
|
-
#
|
1581
1240
|
# @!attribute [rw] sections
|
1582
1241
|
# Ordered list containing different kinds of sections that can be
|
1583
1242
|
# added.
|
@@ -1615,16 +1274,6 @@ module Aws::ConnectCases
|
|
1615
1274
|
include Aws::Structure
|
1616
1275
|
end
|
1617
1276
|
|
1618
|
-
# @note When making an API call, you may pass ListCasesForContactRequest
|
1619
|
-
# data as a hash:
|
1620
|
-
#
|
1621
|
-
# {
|
1622
|
-
# contact_arn: "ContactArn", # required
|
1623
|
-
# domain_id: "DomainId", # required
|
1624
|
-
# max_results: 1,
|
1625
|
-
# next_token: "NextToken",
|
1626
|
-
# }
|
1627
|
-
#
|
1628
1277
|
# @!attribute [rw] contact_arn
|
1629
1278
|
# A unique identifier of a contact in Amazon Connect.
|
1630
1279
|
# @return [String]
|
@@ -1672,14 +1321,6 @@ module Aws::ConnectCases
|
|
1672
1321
|
include Aws::Structure
|
1673
1322
|
end
|
1674
1323
|
|
1675
|
-
# @note When making an API call, you may pass ListDomainsRequest
|
1676
|
-
# data as a hash:
|
1677
|
-
#
|
1678
|
-
# {
|
1679
|
-
# max_results: 1,
|
1680
|
-
# next_token: "NextToken",
|
1681
|
-
# }
|
1682
|
-
#
|
1683
1324
|
# @!attribute [rw] max_results
|
1684
1325
|
# The maximum number of results to return per page.
|
1685
1326
|
# @return [Integer]
|
@@ -1717,17 +1358,6 @@ module Aws::ConnectCases
|
|
1717
1358
|
include Aws::Structure
|
1718
1359
|
end
|
1719
1360
|
|
1720
|
-
# @note When making an API call, you may pass ListFieldOptionsRequest
|
1721
|
-
# data as a hash:
|
1722
|
-
#
|
1723
|
-
# {
|
1724
|
-
# domain_id: "DomainId", # required
|
1725
|
-
# field_id: "FieldId", # required
|
1726
|
-
# max_results: 1,
|
1727
|
-
# next_token: "NextToken",
|
1728
|
-
# values: ["Value"],
|
1729
|
-
# }
|
1730
|
-
#
|
1731
1361
|
# @!attribute [rw] domain_id
|
1732
1362
|
# The unique identifier of the Cases domain.
|
1733
1363
|
# @return [String]
|
@@ -1780,15 +1410,6 @@ module Aws::ConnectCases
|
|
1780
1410
|
include Aws::Structure
|
1781
1411
|
end
|
1782
1412
|
|
1783
|
-
# @note When making an API call, you may pass ListFieldsRequest
|
1784
|
-
# data as a hash:
|
1785
|
-
#
|
1786
|
-
# {
|
1787
|
-
# domain_id: "DomainId", # required
|
1788
|
-
# max_results: 1,
|
1789
|
-
# next_token: "NextToken",
|
1790
|
-
# }
|
1791
|
-
#
|
1792
1413
|
# @!attribute [rw] domain_id
|
1793
1414
|
# The unique identifier of the Cases domain.
|
1794
1415
|
# @return [String]
|
@@ -1831,15 +1452,6 @@ module Aws::ConnectCases
|
|
1831
1452
|
include Aws::Structure
|
1832
1453
|
end
|
1833
1454
|
|
1834
|
-
# @note When making an API call, you may pass ListLayoutsRequest
|
1835
|
-
# data as a hash:
|
1836
|
-
#
|
1837
|
-
# {
|
1838
|
-
# domain_id: "DomainId", # required
|
1839
|
-
# max_results: 1,
|
1840
|
-
# next_token: "NextToken",
|
1841
|
-
# }
|
1842
|
-
#
|
1843
1455
|
# @!attribute [rw] domain_id
|
1844
1456
|
# The unique identifier of the Cases domain.
|
1845
1457
|
# @return [String]
|
@@ -1882,13 +1494,6 @@ module Aws::ConnectCases
|
|
1882
1494
|
include Aws::Structure
|
1883
1495
|
end
|
1884
1496
|
|
1885
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1886
|
-
# data as a hash:
|
1887
|
-
#
|
1888
|
-
# {
|
1889
|
-
# arn: "Arn", # required
|
1890
|
-
# }
|
1891
|
-
#
|
1892
1497
|
# @!attribute [rw] arn
|
1893
1498
|
# The Amazon Resource Name (ARN)
|
1894
1499
|
# @return [String]
|
@@ -1914,15 +1519,6 @@ module Aws::ConnectCases
|
|
1914
1519
|
include Aws::Structure
|
1915
1520
|
end
|
1916
1521
|
|
1917
|
-
# @note When making an API call, you may pass ListTemplatesRequest
|
1918
|
-
# data as a hash:
|
1919
|
-
#
|
1920
|
-
# {
|
1921
|
-
# domain_id: "DomainId", # required
|
1922
|
-
# max_results: 1,
|
1923
|
-
# next_token: "NextToken",
|
1924
|
-
# }
|
1925
|
-
#
|
1926
1522
|
# @!attribute [rw] domain_id
|
1927
1523
|
# The unique identifier of the Cases domain.
|
1928
1524
|
# @return [String]
|
@@ -1937,12 +1533,17 @@ module Aws::ConnectCases
|
|
1937
1533
|
# results.
|
1938
1534
|
# @return [String]
|
1939
1535
|
#
|
1536
|
+
# @!attribute [rw] status
|
1537
|
+
# A list of status values to filter on.
|
1538
|
+
# @return [Array<String>]
|
1539
|
+
#
|
1940
1540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTemplatesRequest AWS API Documentation
|
1941
1541
|
#
|
1942
1542
|
class ListTemplatesRequest < Struct.new(
|
1943
1543
|
:domain_id,
|
1944
1544
|
:max_results,
|
1945
|
-
:next_token
|
1545
|
+
:next_token,
|
1546
|
+
:status)
|
1946
1547
|
SENSITIVE = []
|
1947
1548
|
include Aws::Structure
|
1948
1549
|
end
|
@@ -1965,28 +1566,6 @@ module Aws::ConnectCases
|
|
1965
1566
|
include Aws::Structure
|
1966
1567
|
end
|
1967
1568
|
|
1968
|
-
# @note When making an API call, you may pass PutCaseEventConfigurationRequest
|
1969
|
-
# data as a hash:
|
1970
|
-
#
|
1971
|
-
# {
|
1972
|
-
# domain_id: "DomainId", # required
|
1973
|
-
# event_bridge: { # required
|
1974
|
-
# enabled: false, # required
|
1975
|
-
# included_data: {
|
1976
|
-
# case_data: {
|
1977
|
-
# fields: [ # required
|
1978
|
-
# {
|
1979
|
-
# id: "FieldId", # required
|
1980
|
-
# },
|
1981
|
-
# ],
|
1982
|
-
# },
|
1983
|
-
# related_item_data: {
|
1984
|
-
# include_content: false, # required
|
1985
|
-
# },
|
1986
|
-
# },
|
1987
|
-
# },
|
1988
|
-
# }
|
1989
|
-
#
|
1990
1569
|
# @!attribute [rw] domain_id
|
1991
1570
|
# The unique identifier of the Cases domain.
|
1992
1571
|
# @return [String]
|
@@ -2039,13 +1618,6 @@ module Aws::ConnectCases
|
|
2039
1618
|
# Details of what related item data is published through the case event
|
2040
1619
|
# stream.
|
2041
1620
|
#
|
2042
|
-
# @note When making an API call, you may pass RelatedItemEventIncludedData
|
2043
|
-
# data as a hash:
|
2044
|
-
#
|
2045
|
-
# {
|
2046
|
-
# include_content: false, # required
|
2047
|
-
# }
|
2048
|
-
#
|
2049
1621
|
# @!attribute [rw] include_content
|
2050
1622
|
# Details of what related item data is published through the case
|
2051
1623
|
# event stream.
|
@@ -2117,13 +1689,6 @@ module Aws::ConnectCases
|
|
2117
1689
|
|
2118
1690
|
# List of fields that must have a value provided to create a case.
|
2119
1691
|
#
|
2120
|
-
# @note When making an API call, you may pass RequiredField
|
2121
|
-
# data as a hash:
|
2122
|
-
#
|
2123
|
-
# {
|
2124
|
-
# field_id: "FieldId", # required
|
2125
|
-
# }
|
2126
|
-
#
|
2127
1692
|
# @!attribute [rw] field_id
|
2128
1693
|
# Unique identifier of a field.
|
2129
1694
|
# @return [String]
|
@@ -2161,87 +1726,6 @@ module Aws::ConnectCases
|
|
2161
1726
|
include Aws::Structure
|
2162
1727
|
end
|
2163
1728
|
|
2164
|
-
# @note When making an API call, you may pass SearchCasesRequest
|
2165
|
-
# data as a hash:
|
2166
|
-
#
|
2167
|
-
# {
|
2168
|
-
# domain_id: "DomainId", # required
|
2169
|
-
# fields: [
|
2170
|
-
# {
|
2171
|
-
# id: "FieldId", # required
|
2172
|
-
# },
|
2173
|
-
# ],
|
2174
|
-
# filter: {
|
2175
|
-
# and_all: [
|
2176
|
-
# {
|
2177
|
-
# # recursive CaseFilter
|
2178
|
-
# },
|
2179
|
-
# ],
|
2180
|
-
# field: {
|
2181
|
-
# contains: {
|
2182
|
-
# id: "FieldId", # required
|
2183
|
-
# value: { # required
|
2184
|
-
# boolean_value: false,
|
2185
|
-
# double_value: 1.0,
|
2186
|
-
# string_value: "FieldValueUnionStringValueString",
|
2187
|
-
# },
|
2188
|
-
# },
|
2189
|
-
# equal_to: {
|
2190
|
-
# id: "FieldId", # required
|
2191
|
-
# value: { # required
|
2192
|
-
# boolean_value: false,
|
2193
|
-
# double_value: 1.0,
|
2194
|
-
# string_value: "FieldValueUnionStringValueString",
|
2195
|
-
# },
|
2196
|
-
# },
|
2197
|
-
# greater_than: {
|
2198
|
-
# id: "FieldId", # required
|
2199
|
-
# value: { # required
|
2200
|
-
# boolean_value: false,
|
2201
|
-
# double_value: 1.0,
|
2202
|
-
# string_value: "FieldValueUnionStringValueString",
|
2203
|
-
# },
|
2204
|
-
# },
|
2205
|
-
# greater_than_or_equal_to: {
|
2206
|
-
# id: "FieldId", # required
|
2207
|
-
# value: { # required
|
2208
|
-
# boolean_value: false,
|
2209
|
-
# double_value: 1.0,
|
2210
|
-
# string_value: "FieldValueUnionStringValueString",
|
2211
|
-
# },
|
2212
|
-
# },
|
2213
|
-
# less_than: {
|
2214
|
-
# id: "FieldId", # required
|
2215
|
-
# value: { # required
|
2216
|
-
# boolean_value: false,
|
2217
|
-
# double_value: 1.0,
|
2218
|
-
# string_value: "FieldValueUnionStringValueString",
|
2219
|
-
# },
|
2220
|
-
# },
|
2221
|
-
# less_than_or_equal_to: {
|
2222
|
-
# id: "FieldId", # required
|
2223
|
-
# value: { # required
|
2224
|
-
# boolean_value: false,
|
2225
|
-
# double_value: 1.0,
|
2226
|
-
# string_value: "FieldValueUnionStringValueString",
|
2227
|
-
# },
|
2228
|
-
# },
|
2229
|
-
# },
|
2230
|
-
# not: {
|
2231
|
-
# # recursive CaseFilter
|
2232
|
-
# },
|
2233
|
-
# },
|
2234
|
-
# max_results: 1,
|
2235
|
-
# next_token: "NextToken",
|
2236
|
-
# search_term: "SearchCasesRequestSearchTermString",
|
2237
|
-
# sorts: [
|
2238
|
-
# {
|
2239
|
-
# field_id: "FieldId", # required
|
2240
|
-
# sort_order: "Asc", # required, accepts Asc, Desc
|
2241
|
-
# },
|
2242
|
-
# ],
|
2243
|
-
# }
|
2244
|
-
#
|
2245
1729
|
# @!attribute [rw] domain_id
|
2246
1730
|
# The unique identifier of the Cases domain.
|
2247
1731
|
# @return [String]
|
@@ -2339,26 +1823,6 @@ module Aws::ConnectCases
|
|
2339
1823
|
include Aws::Structure
|
2340
1824
|
end
|
2341
1825
|
|
2342
|
-
# @note When making an API call, you may pass SearchRelatedItemsRequest
|
2343
|
-
# data as a hash:
|
2344
|
-
#
|
2345
|
-
# {
|
2346
|
-
# case_id: "CaseId", # required
|
2347
|
-
# domain_id: "DomainId", # required
|
2348
|
-
# filters: [
|
2349
|
-
# {
|
2350
|
-
# comment: {
|
2351
|
-
# },
|
2352
|
-
# contact: {
|
2353
|
-
# channel: ["Channel"],
|
2354
|
-
# contact_arn: "ContactArn",
|
2355
|
-
# },
|
2356
|
-
# },
|
2357
|
-
# ],
|
2358
|
-
# max_results: 1,
|
2359
|
-
# next_token: "NextToken",
|
2360
|
-
# }
|
2361
|
-
#
|
2362
1826
|
# @!attribute [rw] case_id
|
2363
1827
|
# A unique identifier of the case.
|
2364
1828
|
# @return [String]
|
@@ -2491,14 +1955,6 @@ module Aws::ConnectCases
|
|
2491
1955
|
|
2492
1956
|
# A structured set of sort terms.
|
2493
1957
|
#
|
2494
|
-
# @note When making an API call, you may pass Sort
|
2495
|
-
# data as a hash:
|
2496
|
-
#
|
2497
|
-
# {
|
2498
|
-
# field_id: "FieldId", # required
|
2499
|
-
# sort_order: "Asc", # required, accepts Asc, Desc
|
2500
|
-
# }
|
2501
|
-
#
|
2502
1958
|
# @!attribute [rw] field_id
|
2503
1959
|
# Unique identifier of a field.
|
2504
1960
|
# @return [String]
|
@@ -2516,16 +1972,6 @@ module Aws::ConnectCases
|
|
2516
1972
|
include Aws::Structure
|
2517
1973
|
end
|
2518
1974
|
|
2519
|
-
# @note When making an API call, you may pass TagResourceRequest
|
2520
|
-
# data as a hash:
|
2521
|
-
#
|
2522
|
-
# {
|
2523
|
-
# arn: "Arn", # required
|
2524
|
-
# tags: { # required
|
2525
|
-
# "String" => "String",
|
2526
|
-
# },
|
2527
|
-
# }
|
2528
|
-
#
|
2529
1975
|
# @!attribute [rw] arn
|
2530
1976
|
# The Amazon Resource Name (ARN)
|
2531
1977
|
# @return [String]
|
@@ -2550,6 +1996,10 @@ module Aws::ConnectCases
|
|
2550
1996
|
# The template name.
|
2551
1997
|
# @return [String]
|
2552
1998
|
#
|
1999
|
+
# @!attribute [rw] status
|
2000
|
+
# The status of the template.
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
2553
2003
|
# @!attribute [rw] template_arn
|
2554
2004
|
# The Amazon Resource Name (ARN) of the template.
|
2555
2005
|
# @return [String]
|
@@ -2562,6 +2012,7 @@ module Aws::ConnectCases
|
|
2562
2012
|
#
|
2563
2013
|
class TemplateSummary < Struct.new(
|
2564
2014
|
:name,
|
2015
|
+
:status,
|
2565
2016
|
:template_arn,
|
2566
2017
|
:template_id)
|
2567
2018
|
SENSITIVE = []
|
@@ -2582,14 +2033,6 @@ module Aws::ConnectCases
|
|
2582
2033
|
include Aws::Structure
|
2583
2034
|
end
|
2584
2035
|
|
2585
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
2586
|
-
# data as a hash:
|
2587
|
-
#
|
2588
|
-
# {
|
2589
|
-
# arn: "Arn", # required
|
2590
|
-
# tag_keys: ["TagKey"], # required
|
2591
|
-
# }
|
2592
|
-
#
|
2593
2036
|
# @!attribute [rw] arn
|
2594
2037
|
# The Amazon Resource Name (ARN)
|
2595
2038
|
# @return [String]
|
@@ -2607,24 +2050,6 @@ module Aws::ConnectCases
|
|
2607
2050
|
include Aws::Structure
|
2608
2051
|
end
|
2609
2052
|
|
2610
|
-
# @note When making an API call, you may pass UpdateCaseRequest
|
2611
|
-
# data as a hash:
|
2612
|
-
#
|
2613
|
-
# {
|
2614
|
-
# case_id: "CaseId", # required
|
2615
|
-
# domain_id: "DomainId", # required
|
2616
|
-
# fields: [ # required
|
2617
|
-
# {
|
2618
|
-
# id: "FieldId", # required
|
2619
|
-
# value: { # required
|
2620
|
-
# boolean_value: false,
|
2621
|
-
# double_value: 1.0,
|
2622
|
-
# string_value: "FieldValueUnionStringValueString",
|
2623
|
-
# },
|
2624
|
-
# },
|
2625
|
-
# ],
|
2626
|
-
# }
|
2627
|
-
#
|
2628
2053
|
# @!attribute [rw] case_id
|
2629
2054
|
# A unique identifier of the case.
|
2630
2055
|
# @return [String]
|
@@ -2653,16 +2078,6 @@ module Aws::ConnectCases
|
|
2653
2078
|
#
|
2654
2079
|
class UpdateCaseResponse < Aws::EmptyStructure; end
|
2655
2080
|
|
2656
|
-
# @note When making an API call, you may pass UpdateFieldRequest
|
2657
|
-
# data as a hash:
|
2658
|
-
#
|
2659
|
-
# {
|
2660
|
-
# description: "FieldDescription",
|
2661
|
-
# domain_id: "DomainId", # required
|
2662
|
-
# field_id: "FieldId", # required
|
2663
|
-
# name: "FieldName",
|
2664
|
-
# }
|
2665
|
-
#
|
2666
2081
|
# @!attribute [rw] description
|
2667
2082
|
# The description of a field.
|
2668
2083
|
# @return [String]
|
@@ -2694,47 +2109,6 @@ module Aws::ConnectCases
|
|
2694
2109
|
#
|
2695
2110
|
class UpdateFieldResponse < Aws::EmptyStructure; end
|
2696
2111
|
|
2697
|
-
# @note When making an API call, you may pass UpdateLayoutRequest
|
2698
|
-
# data as a hash:
|
2699
|
-
#
|
2700
|
-
# {
|
2701
|
-
# content: {
|
2702
|
-
# basic: {
|
2703
|
-
# more_info: {
|
2704
|
-
# sections: [
|
2705
|
-
# {
|
2706
|
-
# field_group: {
|
2707
|
-
# fields: [ # required
|
2708
|
-
# {
|
2709
|
-
# id: "FieldId", # required
|
2710
|
-
# },
|
2711
|
-
# ],
|
2712
|
-
# name: "FieldGroupNameString",
|
2713
|
-
# },
|
2714
|
-
# },
|
2715
|
-
# ],
|
2716
|
-
# },
|
2717
|
-
# top_panel: {
|
2718
|
-
# sections: [
|
2719
|
-
# {
|
2720
|
-
# field_group: {
|
2721
|
-
# fields: [ # required
|
2722
|
-
# {
|
2723
|
-
# id: "FieldId", # required
|
2724
|
-
# },
|
2725
|
-
# ],
|
2726
|
-
# name: "FieldGroupNameString",
|
2727
|
-
# },
|
2728
|
-
# },
|
2729
|
-
# ],
|
2730
|
-
# },
|
2731
|
-
# },
|
2732
|
-
# },
|
2733
|
-
# domain_id: "DomainId", # required
|
2734
|
-
# layout_id: "LayoutId", # required
|
2735
|
-
# name: "LayoutName",
|
2736
|
-
# }
|
2737
|
-
#
|
2738
2112
|
# @!attribute [rw] content
|
2739
2113
|
# Information about which fields will be present in the layout, the
|
2740
2114
|
# order of the fields, and a read-only attribute of the field.
|
@@ -2767,24 +2141,6 @@ module Aws::ConnectCases
|
|
2767
2141
|
#
|
2768
2142
|
class UpdateLayoutResponse < Aws::EmptyStructure; end
|
2769
2143
|
|
2770
|
-
# @note When making an API call, you may pass UpdateTemplateRequest
|
2771
|
-
# data as a hash:
|
2772
|
-
#
|
2773
|
-
# {
|
2774
|
-
# description: "TemplateDescription",
|
2775
|
-
# domain_id: "DomainId", # required
|
2776
|
-
# layout_configuration: {
|
2777
|
-
# default_layout: "LayoutId",
|
2778
|
-
# },
|
2779
|
-
# name: "TemplateName",
|
2780
|
-
# required_fields: [
|
2781
|
-
# {
|
2782
|
-
# field_id: "FieldId", # required
|
2783
|
-
# },
|
2784
|
-
# ],
|
2785
|
-
# template_id: "TemplateId", # required
|
2786
|
-
# }
|
2787
|
-
#
|
2788
2144
|
# @!attribute [rw] description
|
2789
2145
|
# A brief description of the template.
|
2790
2146
|
# @return [String]
|
@@ -2806,6 +2162,10 @@ module Aws::ConnectCases
|
|
2806
2162
|
# successfully created with this template.
|
2807
2163
|
# @return [Array<Types::RequiredField>]
|
2808
2164
|
#
|
2165
|
+
# @!attribute [rw] status
|
2166
|
+
# The status of the template.
|
2167
|
+
# @return [String]
|
2168
|
+
#
|
2809
2169
|
# @!attribute [rw] template_id
|
2810
2170
|
# A unique identifier for the template.
|
2811
2171
|
# @return [String]
|
@@ -2818,6 +2178,7 @@ module Aws::ConnectCases
|
|
2818
2178
|
:layout_configuration,
|
2819
2179
|
:name,
|
2820
2180
|
:required_fields,
|
2181
|
+
:status,
|
2821
2182
|
:template_id)
|
2822
2183
|
SENSITIVE = []
|
2823
2184
|
include Aws::Structure
|