aws-sdk-connectcases 1.18.0 → 1.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8fddee1708b2446c0b5ad50ca7e93445d1b4ce0c62563429a4cd8455c4496065
4
- data.tar.gz: 1a75a65bea3da29abefa63e8b44fee5973570348c2be713acf3a46b0cef8c83a
3
+ metadata.gz: 5dacce0dcd1e1d7af519081c9d82db95ff470105ae2895818f66295b011abe76
4
+ data.tar.gz: 1400be916da96bae518c518f88e3573ecce08e60651aa63d92e3547efa1aafdc
5
5
  SHA512:
6
- metadata.gz: 61d56a08b7c10f08eec1f6b3c8db7fd27d7bbd21df1fe388ec2f118dc63ba953035ebf251c17f369d3bb74f543e70ff2d5b101d5e57f39c97ad91333967a8a81
7
- data.tar.gz: b29c96da83e10fd83b7de47f8e641ec2d485c05e06b7cfcba82f5d16e97d44a05a1a819e20f20c8f2921139faf7c237c314295349e06ab2ce87e9538caee2816
6
+ metadata.gz: a4dae8dd162609b53c410c4621498e4c51e2086be6bb2787b6f26461c34775a45a5a44d8d3f65f8e7e9caa201bd94cfc044422a8af017e0d23ad06583a083e41
7
+ data.tar.gz: 6b03afec0371fdbf8433b790e668a335e28ed83d4e5bbd0358578ecb827e0345b413171c79dc461da704e8c0393ca03bdcc6533520063656db6c6abf93e43322
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.19.0 (2024-01-22)
5
+ ------------------
6
+
7
+ * Feature - This release adds the ability to view audit history on a case and introduces a new parameter, performedBy, for CreateCase and UpdateCase API's.
8
+
4
9
  1.18.0 (2023-12-15)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.18.0
1
+ 1.19.0
@@ -427,7 +427,7 @@ module Aws::ConnectCases
427
427
  # resp.fields[0].namespace #=> String, one of "System", "Custom"
428
428
  # resp.fields[0].tags #=> Hash
429
429
  # resp.fields[0].tags["String"] #=> String
430
- # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url"
430
+ # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url", "User"
431
431
  #
432
432
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetField AWS API Documentation
433
433
  #
@@ -484,13 +484,17 @@ module Aws::ConnectCases
484
484
  req.send_request(options)
485
485
  end
486
486
 
487
- # Creates a case in the specified Cases domain. Case system and custom
488
- # fields are taken as an array id/value pairs with a declared data
489
- # types.
487
+ # <note markdown="1"> If you provide a value for `PerformedBy.UserArn` you must also have
488
+ # [connect:DescribeUser][1] permission on the User ARN resource that you
489
+ # provide
490
+ #
491
+ # </note>
492
+ #
493
+ # <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <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>
494
+ #
490
495
  #
491
- # The following fields are required when creating a case:
492
496
  #
493
- # <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>
497
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
494
498
  #
495
499
  # @option params [String] :client_token
496
500
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -512,6 +516,9 @@ module Aws::ConnectCases
512
516
  # An array of objects with field ID (matching ListFields/DescribeField)
513
517
  # and value union data.
514
518
  #
519
+ # @option params [Types::UserUnion] :performed_by
520
+ # Represents the identity of the person who performed the action.
521
+ #
515
522
  # @option params [required, String] :template_id
516
523
  # A unique identifier of a template.
517
524
  #
@@ -534,9 +541,13 @@ module Aws::ConnectCases
534
541
  # empty_value: {
535
542
  # },
536
543
  # string_value: "FieldValueUnionStringValueString",
544
+ # user_arn_value: "String",
537
545
  # },
538
546
  # },
539
547
  # ],
548
+ # performed_by: {
549
+ # user_arn: "UserArn",
550
+ # },
540
551
  # template_id: "TemplateId", # required
541
552
  # })
542
553
  #
@@ -631,7 +642,7 @@ module Aws::ConnectCases
631
642
  # description: "FieldDescription",
632
643
  # domain_id: "DomainId", # required
633
644
  # name: "FieldName", # required
634
- # type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect, Url
645
+ # type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect, Url, User
635
646
  # })
636
647
  #
637
648
  # @example Response structure
@@ -937,6 +948,7 @@ module Aws::ConnectCases
937
948
  # resp.fields[0].value.boolean_value #=> Boolean
938
949
  # resp.fields[0].value.double_value #=> Float
939
950
  # resp.fields[0].value.string_value #=> String
951
+ # resp.fields[0].value.user_arn_value #=> String
940
952
  # resp.next_token #=> String
941
953
  # resp.tags #=> Hash
942
954
  # resp.tags["String"] #=> String
@@ -951,6 +963,70 @@ module Aws::ConnectCases
951
963
  req.send_request(options)
952
964
  end
953
965
 
966
+ # Returns the audit history about a specific case if it exists.
967
+ #
968
+ # @option params [required, String] :case_id
969
+ # A unique identifier of the case.
970
+ #
971
+ # @option params [required, String] :domain_id
972
+ # The unique identifier of the Cases domain.
973
+ #
974
+ # @option params [Integer] :max_results
975
+ # The maximum number of audit events to return. The current maximum
976
+ # supported value is 25. This is also the default when no other value is
977
+ # provided.
978
+ #
979
+ # @option params [String] :next_token
980
+ # The token for the next set of results. Use the value returned in the
981
+ # previous response in the next request to retrieve the next set of
982
+ # results.
983
+ #
984
+ # @return [Types::GetCaseAuditEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
985
+ #
986
+ # * {Types::GetCaseAuditEventsResponse#audit_events #audit_events} => Array&lt;Types::AuditEvent&gt;
987
+ # * {Types::GetCaseAuditEventsResponse#next_token #next_token} => String
988
+ #
989
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
990
+ #
991
+ # @example Request syntax with placeholder values
992
+ #
993
+ # resp = client.get_case_audit_events({
994
+ # case_id: "CaseId", # required
995
+ # domain_id: "DomainId", # required
996
+ # max_results: 1,
997
+ # next_token: "NextToken",
998
+ # })
999
+ #
1000
+ # @example Response structure
1001
+ #
1002
+ # resp.audit_events #=> Array
1003
+ # resp.audit_events[0].event_id #=> String
1004
+ # resp.audit_events[0].fields #=> Array
1005
+ # resp.audit_events[0].fields[0].event_field_id #=> String
1006
+ # resp.audit_events[0].fields[0].new_value.boolean_value #=> Boolean
1007
+ # resp.audit_events[0].fields[0].new_value.double_value #=> Float
1008
+ # resp.audit_events[0].fields[0].new_value.string_value #=> String
1009
+ # resp.audit_events[0].fields[0].new_value.user_arn_value #=> String
1010
+ # resp.audit_events[0].fields[0].old_value.boolean_value #=> Boolean
1011
+ # resp.audit_events[0].fields[0].old_value.double_value #=> Float
1012
+ # resp.audit_events[0].fields[0].old_value.string_value #=> String
1013
+ # resp.audit_events[0].fields[0].old_value.user_arn_value #=> String
1014
+ # resp.audit_events[0].performed_by.iam_principal_arn #=> String
1015
+ # resp.audit_events[0].performed_by.user.user_arn #=> String
1016
+ # resp.audit_events[0].performed_time #=> Time
1017
+ # resp.audit_events[0].related_item_type #=> String, one of "Contact", "Comment"
1018
+ # resp.audit_events[0].type #=> String, one of "Case.Created", "Case.Updated", "RelatedItem.Created"
1019
+ # resp.next_token #=> String
1020
+ #
1021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEvents AWS API Documentation
1022
+ #
1023
+ # @overload get_case_audit_events(params = {})
1024
+ # @param [Hash] params ({})
1025
+ def get_case_audit_events(params = {}, options = {})
1026
+ req = build_request(:get_case_audit_events, params)
1027
+ req.send_request(options)
1028
+ end
1029
+
954
1030
  # Returns the case event publishing configuration.
955
1031
  #
956
1032
  # @option params [required, String] :domain_id
@@ -1295,7 +1371,7 @@ module Aws::ConnectCases
1295
1371
  # resp.fields[0].field_id #=> String
1296
1372
  # resp.fields[0].name #=> String
1297
1373
  # resp.fields[0].namespace #=> String, one of "System", "Custom"
1298
- # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url"
1374
+ # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url", "User"
1299
1375
  # resp.next_token #=> String
1300
1376
  #
1301
1377
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFields AWS API Documentation
@@ -1546,6 +1622,7 @@ module Aws::ConnectCases
1546
1622
  # empty_value: {
1547
1623
  # },
1548
1624
  # string_value: "FieldValueUnionStringValueString",
1625
+ # user_arn_value: "String",
1549
1626
  # },
1550
1627
  # },
1551
1628
  # equal_to: {
@@ -1556,6 +1633,7 @@ module Aws::ConnectCases
1556
1633
  # empty_value: {
1557
1634
  # },
1558
1635
  # string_value: "FieldValueUnionStringValueString",
1636
+ # user_arn_value: "String",
1559
1637
  # },
1560
1638
  # },
1561
1639
  # greater_than: {
@@ -1566,6 +1644,7 @@ module Aws::ConnectCases
1566
1644
  # empty_value: {
1567
1645
  # },
1568
1646
  # string_value: "FieldValueUnionStringValueString",
1647
+ # user_arn_value: "String",
1569
1648
  # },
1570
1649
  # },
1571
1650
  # greater_than_or_equal_to: {
@@ -1576,6 +1655,7 @@ module Aws::ConnectCases
1576
1655
  # empty_value: {
1577
1656
  # },
1578
1657
  # string_value: "FieldValueUnionStringValueString",
1658
+ # user_arn_value: "String",
1579
1659
  # },
1580
1660
  # },
1581
1661
  # less_than: {
@@ -1586,6 +1666,7 @@ module Aws::ConnectCases
1586
1666
  # empty_value: {
1587
1667
  # },
1588
1668
  # string_value: "FieldValueUnionStringValueString",
1669
+ # user_arn_value: "String",
1589
1670
  # },
1590
1671
  # },
1591
1672
  # less_than_or_equal_to: {
@@ -1596,6 +1677,7 @@ module Aws::ConnectCases
1596
1677
  # empty_value: {
1597
1678
  # },
1598
1679
  # string_value: "FieldValueUnionStringValueString",
1680
+ # user_arn_value: "String",
1599
1681
  # },
1600
1682
  # },
1601
1683
  # },
@@ -1628,6 +1710,7 @@ module Aws::ConnectCases
1628
1710
  # resp.cases[0].fields[0].value.boolean_value #=> Boolean
1629
1711
  # resp.cases[0].fields[0].value.double_value #=> Float
1630
1712
  # resp.cases[0].fields[0].value.string_value #=> String
1713
+ # resp.cases[0].fields[0].value.user_arn_value #=> String
1631
1714
  # resp.cases[0].tags #=> Hash
1632
1715
  # resp.cases[0].tags["String"] #=> String
1633
1716
  # resp.cases[0].template_id #=> String
@@ -1773,12 +1856,17 @@ module Aws::ConnectCases
1773
1856
  req.send_request(options)
1774
1857
  end
1775
1858
 
1776
- # Updates the values of fields on a case. Fields to be updated are
1777
- # received as an array of id/value pairs identical to the `CreateCase`
1778
- # input .
1859
+ # <note markdown="1"> If you provide a value for `PerformedBy.UserArn` you must also have
1860
+ # [connect:DescribeUser][1] permission on the User ARN resource that you
1861
+ # provide
1862
+ #
1863
+ # </note>
1864
+ #
1865
+ # <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
1866
+ #
1779
1867
  #
1780
- # If the action is successful, the service sends back an HTTP 200
1781
- # response with an empty HTTP body.
1868
+ #
1869
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html
1782
1870
  #
1783
1871
  # @option params [required, String] :case_id
1784
1872
  # A unique identifier of the case.
@@ -1790,6 +1878,9 @@ module Aws::ConnectCases
1790
1878
  # An array of objects with `fieldId` (matching ListFields/DescribeField)
1791
1879
  # and value union data, structured identical to `CreateCase`.
1792
1880
  #
1881
+ # @option params [Types::UserUnion] :performed_by
1882
+ # Represents the identity of the person who performed the action.
1883
+ #
1793
1884
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1794
1885
  #
1795
1886
  # @example Request syntax with placeholder values
@@ -1806,9 +1897,13 @@ module Aws::ConnectCases
1806
1897
  # empty_value: {
1807
1898
  # },
1808
1899
  # string_value: "FieldValueUnionStringValueString",
1900
+ # user_arn_value: "String",
1809
1901
  # },
1810
1902
  # },
1811
1903
  # ],
1904
+ # performed_by: {
1905
+ # user_arn: "UserArn",
1906
+ # },
1812
1907
  # })
1813
1908
  #
1814
1909
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCase AWS API Documentation
@@ -2002,7 +2097,7 @@ module Aws::ConnectCases
2002
2097
  params: params,
2003
2098
  config: config)
2004
2099
  context[:gem_name] = 'aws-sdk-connectcases'
2005
- context[:gem_version] = '1.18.0'
2100
+ context[:gem_version] = '1.19.0'
2006
2101
  Seahorse::Client::Request.new(handlers, context)
2007
2102
  end
2008
2103
 
@@ -16,6 +16,16 @@ module Aws::ConnectCases
16
16
  AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
17
17
  Arn = Shapes::StringShape.new(name: 'Arn')
18
18
  AssociationTime = Shapes::TimestampShape.new(name: 'AssociationTime', timestampFormat: "iso8601")
19
+ AuditEvent = Shapes::StructureShape.new(name: 'AuditEvent')
20
+ AuditEventDateTime = Shapes::TimestampShape.new(name: 'AuditEventDateTime', timestampFormat: "iso8601")
21
+ AuditEventField = Shapes::StructureShape.new(name: 'AuditEventField')
22
+ AuditEventFieldId = Shapes::StringShape.new(name: 'AuditEventFieldId')
23
+ AuditEventFieldList = Shapes::ListShape.new(name: 'AuditEventFieldList')
24
+ AuditEventFieldValueUnion = Shapes::UnionShape.new(name: 'AuditEventFieldValueUnion')
25
+ AuditEventFieldValueUnionStringValueString = Shapes::StringShape.new(name: 'AuditEventFieldValueUnionStringValueString')
26
+ AuditEventId = Shapes::StringShape.new(name: 'AuditEventId')
27
+ AuditEventPerformedBy = Shapes::StructureShape.new(name: 'AuditEventPerformedBy')
28
+ AuditEventType = Shapes::StringShape.new(name: 'AuditEventType')
19
29
  BasicLayout = Shapes::StructureShape.new(name: 'BasicLayout')
20
30
  BatchGetFieldIdentifierList = Shapes::ListShape.new(name: 'BatchGetFieldIdentifierList')
21
31
  BatchGetFieldRequest = Shapes::StructureShape.new(name: 'BatchGetFieldRequest')
@@ -96,6 +106,10 @@ module Aws::ConnectCases
96
106
  FieldValue = Shapes::StructureShape.new(name: 'FieldValue')
97
107
  FieldValueUnion = Shapes::UnionShape.new(name: 'FieldValueUnion')
98
108
  FieldValueUnionStringValueString = Shapes::StringShape.new(name: 'FieldValueUnionStringValueString')
109
+ GetCaseAuditEventsRequest = Shapes::StructureShape.new(name: 'GetCaseAuditEventsRequest')
110
+ GetCaseAuditEventsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'GetCaseAuditEventsRequestMaxResultsInteger')
111
+ GetCaseAuditEventsResponse = Shapes::StructureShape.new(name: 'GetCaseAuditEventsResponse')
112
+ GetCaseAuditEventsResponseAuditEventsList = Shapes::ListShape.new(name: 'GetCaseAuditEventsResponseAuditEventsList')
99
113
  GetCaseEventConfigurationRequest = Shapes::StructureShape.new(name: 'GetCaseEventConfigurationRequest')
100
114
  GetCaseEventConfigurationResponse = Shapes::StructureShape.new(name: 'GetCaseEventConfigurationResponse')
101
115
  GetCaseRequest = Shapes::StructureShape.new(name: 'GetCaseRequest')
@@ -109,6 +123,7 @@ module Aws::ConnectCases
109
123
  GetLayoutResponse = Shapes::StructureShape.new(name: 'GetLayoutResponse')
110
124
  GetTemplateRequest = Shapes::StructureShape.new(name: 'GetTemplateRequest')
111
125
  GetTemplateResponse = Shapes::StructureShape.new(name: 'GetTemplateResponse')
126
+ IamPrincipalArn = Shapes::StringShape.new(name: 'IamPrincipalArn')
112
127
  Integer = Shapes::IntegerShape.new(name: 'Integer')
113
128
  InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
114
129
  LayoutArn = Shapes::StringShape.new(name: 'LayoutArn')
@@ -204,6 +219,39 @@ module Aws::ConnectCases
204
219
  AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
205
220
  AccessDeniedException.struct_class = Types::AccessDeniedException
206
221
 
222
+ AuditEvent.add_member(:event_id, Shapes::ShapeRef.new(shape: AuditEventId, required: true, location_name: "eventId"))
223
+ AuditEvent.add_member(:fields, Shapes::ShapeRef.new(shape: AuditEventFieldList, required: true, location_name: "fields"))
224
+ AuditEvent.add_member(:performed_by, Shapes::ShapeRef.new(shape: AuditEventPerformedBy, location_name: "performedBy"))
225
+ AuditEvent.add_member(:performed_time, Shapes::ShapeRef.new(shape: AuditEventDateTime, required: true, location_name: "performedTime"))
226
+ AuditEvent.add_member(:related_item_type, Shapes::ShapeRef.new(shape: RelatedItemType, location_name: "relatedItemType"))
227
+ AuditEvent.add_member(:type, Shapes::ShapeRef.new(shape: AuditEventType, required: true, location_name: "type"))
228
+ AuditEvent.struct_class = Types::AuditEvent
229
+
230
+ AuditEventField.add_member(:event_field_id, Shapes::ShapeRef.new(shape: AuditEventFieldId, required: true, location_name: "eventFieldId"))
231
+ AuditEventField.add_member(:new_value, Shapes::ShapeRef.new(shape: AuditEventFieldValueUnion, required: true, location_name: "newValue"))
232
+ AuditEventField.add_member(:old_value, Shapes::ShapeRef.new(shape: AuditEventFieldValueUnion, location_name: "oldValue"))
233
+ AuditEventField.struct_class = Types::AuditEventField
234
+
235
+ AuditEventFieldList.member = Shapes::ShapeRef.new(shape: AuditEventField)
236
+
237
+ AuditEventFieldValueUnion.add_member(:boolean_value, Shapes::ShapeRef.new(shape: Boolean, location_name: "booleanValue"))
238
+ AuditEventFieldValueUnion.add_member(:double_value, Shapes::ShapeRef.new(shape: Double, location_name: "doubleValue"))
239
+ AuditEventFieldValueUnion.add_member(:empty_value, Shapes::ShapeRef.new(shape: EmptyFieldValue, location_name: "emptyValue"))
240
+ AuditEventFieldValueUnion.add_member(:string_value, Shapes::ShapeRef.new(shape: AuditEventFieldValueUnionStringValueString, location_name: "stringValue"))
241
+ AuditEventFieldValueUnion.add_member(:user_arn_value, Shapes::ShapeRef.new(shape: String, location_name: "userArnValue"))
242
+ AuditEventFieldValueUnion.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
243
+ AuditEventFieldValueUnion.add_member_subclass(:boolean_value, Types::AuditEventFieldValueUnion::BooleanValue)
244
+ AuditEventFieldValueUnion.add_member_subclass(:double_value, Types::AuditEventFieldValueUnion::DoubleValue)
245
+ AuditEventFieldValueUnion.add_member_subclass(:empty_value, Types::AuditEventFieldValueUnion::EmptyValue)
246
+ AuditEventFieldValueUnion.add_member_subclass(:string_value, Types::AuditEventFieldValueUnion::StringValue)
247
+ AuditEventFieldValueUnion.add_member_subclass(:user_arn_value, Types::AuditEventFieldValueUnion::UserArnValue)
248
+ AuditEventFieldValueUnion.add_member_subclass(:unknown, Types::AuditEventFieldValueUnion::Unknown)
249
+ AuditEventFieldValueUnion.struct_class = Types::AuditEventFieldValueUnion
250
+
251
+ AuditEventPerformedBy.add_member(:iam_principal_arn, Shapes::ShapeRef.new(shape: IamPrincipalArn, required: true, location_name: "iamPrincipalArn"))
252
+ AuditEventPerformedBy.add_member(:user, Shapes::ShapeRef.new(shape: UserUnion, location_name: "user"))
253
+ AuditEventPerformedBy.struct_class = Types::AuditEventPerformedBy
254
+
207
255
  BasicLayout.add_member(:more_info, Shapes::ShapeRef.new(shape: LayoutSections, location_name: "moreInfo"))
208
256
  BasicLayout.add_member(:top_panel, Shapes::ShapeRef.new(shape: LayoutSections, location_name: "topPanel"))
209
257
  BasicLayout.struct_class = Types::BasicLayout
@@ -285,6 +333,7 @@ module Aws::ConnectCases
285
333
  CreateCaseRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: CreateCaseRequestClientTokenString, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
286
334
  CreateCaseRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
287
335
  CreateCaseRequest.add_member(:fields, Shapes::ShapeRef.new(shape: CreateCaseRequestFieldsList, required: true, location_name: "fields"))
336
+ CreateCaseRequest.add_member(:performed_by, Shapes::ShapeRef.new(shape: UserUnion, location_name: "performedBy"))
288
337
  CreateCaseRequest.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
289
338
  CreateCaseRequest.struct_class = Types::CreateCaseRequest
290
339
 
@@ -426,14 +475,28 @@ module Aws::ConnectCases
426
475
  FieldValueUnion.add_member(:double_value, Shapes::ShapeRef.new(shape: Double, location_name: "doubleValue"))
427
476
  FieldValueUnion.add_member(:empty_value, Shapes::ShapeRef.new(shape: EmptyFieldValue, location_name: "emptyValue"))
428
477
  FieldValueUnion.add_member(:string_value, Shapes::ShapeRef.new(shape: FieldValueUnionStringValueString, location_name: "stringValue"))
478
+ FieldValueUnion.add_member(:user_arn_value, Shapes::ShapeRef.new(shape: String, location_name: "userArnValue"))
429
479
  FieldValueUnion.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
430
480
  FieldValueUnion.add_member_subclass(:boolean_value, Types::FieldValueUnion::BooleanValue)
431
481
  FieldValueUnion.add_member_subclass(:double_value, Types::FieldValueUnion::DoubleValue)
432
482
  FieldValueUnion.add_member_subclass(:empty_value, Types::FieldValueUnion::EmptyValue)
433
483
  FieldValueUnion.add_member_subclass(:string_value, Types::FieldValueUnion::StringValue)
484
+ FieldValueUnion.add_member_subclass(:user_arn_value, Types::FieldValueUnion::UserArnValue)
434
485
  FieldValueUnion.add_member_subclass(:unknown, Types::FieldValueUnion::Unknown)
435
486
  FieldValueUnion.struct_class = Types::FieldValueUnion
436
487
 
488
+ GetCaseAuditEventsRequest.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location: "uri", location_name: "caseId"))
489
+ GetCaseAuditEventsRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
490
+ GetCaseAuditEventsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: GetCaseAuditEventsRequestMaxResultsInteger, location_name: "maxResults"))
491
+ GetCaseAuditEventsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
492
+ GetCaseAuditEventsRequest.struct_class = Types::GetCaseAuditEventsRequest
493
+
494
+ GetCaseAuditEventsResponse.add_member(:audit_events, Shapes::ShapeRef.new(shape: GetCaseAuditEventsResponseAuditEventsList, required: true, location_name: "auditEvents"))
495
+ GetCaseAuditEventsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
496
+ GetCaseAuditEventsResponse.struct_class = Types::GetCaseAuditEventsResponse
497
+
498
+ GetCaseAuditEventsResponseAuditEventsList.member = Shapes::ShapeRef.new(shape: AuditEvent)
499
+
437
500
  GetCaseEventConfigurationRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
438
501
  GetCaseEventConfigurationRequest.struct_class = Types::GetCaseEventConfigurationRequest
439
502
 
@@ -728,6 +791,7 @@ module Aws::ConnectCases
728
791
  UpdateCaseRequest.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location: "uri", location_name: "caseId"))
729
792
  UpdateCaseRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
730
793
  UpdateCaseRequest.add_member(:fields, Shapes::ShapeRef.new(shape: UpdateCaseRequestFieldsList, required: true, location_name: "fields"))
794
+ UpdateCaseRequest.add_member(:performed_by, Shapes::ShapeRef.new(shape: UserUnion, location_name: "performedBy"))
731
795
  UpdateCaseRequest.struct_class = Types::UpdateCaseRequest
732
796
 
733
797
  UpdateCaseRequestFieldsList.member = Shapes::ShapeRef.new(shape: FieldValue)
@@ -937,6 +1001,25 @@ module Aws::ConnectCases
937
1001
  )
938
1002
  end)
939
1003
 
1004
+ api.add_operation(:get_case_audit_events, Seahorse::Model::Operation.new.tap do |o|
1005
+ o.name = "GetCaseAuditEvents"
1006
+ o.http_method = "POST"
1007
+ o.http_request_uri = "/domains/{domainId}/cases/{caseId}/audit-history"
1008
+ o.input = Shapes::ShapeRef.new(shape: GetCaseAuditEventsRequest)
1009
+ o.output = Shapes::ShapeRef.new(shape: GetCaseAuditEventsResponse)
1010
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1011
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1012
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1013
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1014
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1015
+ o[:pager] = Aws::Pager.new(
1016
+ limit_key: "max_results",
1017
+ tokens: {
1018
+ "next_token" => "next_token"
1019
+ }
1020
+ )
1021
+ end)
1022
+
940
1023
  api.add_operation(:get_case_event_configuration, Seahorse::Model::Operation.new.tap do |o|
941
1024
  o.name = "GetCaseEventConfiguration"
942
1025
  o.http_method = "POST"
@@ -152,6 +152,20 @@ module Aws::ConnectCases
152
152
  end
153
153
  end
154
154
 
155
+ class GetCaseAuditEvents
156
+ def self.build(context)
157
+ unless context.config.regional_endpoint
158
+ endpoint = context.config.endpoint.to_s
159
+ end
160
+ Aws::ConnectCases::EndpointParameters.new(
161
+ region: context.config.region,
162
+ use_dual_stack: context.config.use_dualstack_endpoint,
163
+ use_fips: context.config.use_fips_endpoint,
164
+ endpoint: endpoint,
165
+ )
166
+ end
167
+ end
168
+
155
169
  class GetCaseEventConfiguration
156
170
  def self.build(context)
157
171
  unless context.config.regional_endpoint
@@ -77,6 +77,8 @@ module Aws::ConnectCases
77
77
  Aws::ConnectCases::Endpoints::DeleteDomain.build(context)
78
78
  when :get_case
79
79
  Aws::ConnectCases::Endpoints::GetCase.build(context)
80
+ when :get_case_audit_events
81
+ Aws::ConnectCases::Endpoints::GetCaseAuditEvents.build(context)
80
82
  when :get_case_event_configuration
81
83
  Aws::ConnectCases::Endpoints::GetCaseEventConfiguration.build(context)
82
84
  when :get_domain
@@ -23,6 +23,144 @@ module Aws::ConnectCases
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # Represents the content of a particular audit event.
27
+ #
28
+ # @!attribute [rw] event_id
29
+ # Unique identifier of a case audit history event.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] fields
33
+ # A list of Case Audit History event fields.
34
+ # @return [Array<Types::AuditEventField>]
35
+ #
36
+ # @!attribute [rw] performed_by
37
+ # Information of the user which performed the audit.
38
+ # @return [Types::AuditEventPerformedBy]
39
+ #
40
+ # @!attribute [rw] performed_time
41
+ # Time at which an Audit History event took place.
42
+ # @return [Time]
43
+ #
44
+ # @!attribute [rw] related_item_type
45
+ # The Type of the related item.
46
+ # @return [String]
47
+ #
48
+ # @!attribute [rw] type
49
+ # The Type of an audit history event.
50
+ # @return [String]
51
+ #
52
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEvent AWS API Documentation
53
+ #
54
+ class AuditEvent < Struct.new(
55
+ :event_id,
56
+ :fields,
57
+ :performed_by,
58
+ :performed_time,
59
+ :related_item_type,
60
+ :type)
61
+ SENSITIVE = []
62
+ include Aws::Structure
63
+ end
64
+
65
+ # Fields for audit event.
66
+ #
67
+ # @!attribute [rw] event_field_id
68
+ # Unique identifier of field in an Audit History entry.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] new_value
72
+ # Union of potential field value types.
73
+ # @return [Types::AuditEventFieldValueUnion]
74
+ #
75
+ # @!attribute [rw] old_value
76
+ # Union of potential field value types.
77
+ # @return [Types::AuditEventFieldValueUnion]
78
+ #
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventField AWS API Documentation
80
+ #
81
+ class AuditEventField < Struct.new(
82
+ :event_field_id,
83
+ :new_value,
84
+ :old_value)
85
+ SENSITIVE = []
86
+ include Aws::Structure
87
+ end
88
+
89
+ # Object to store union of Field values.
90
+ #
91
+ # This data type is a UNION, so only one of the following members can be
92
+ # specified when used or returned.
93
+ #
94
+ # @note AuditEventFieldValueUnion is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AuditEventFieldValueUnion corresponding to the set member.
95
+ #
96
+ # @!attribute [rw] boolean_value
97
+ # Can be either null, or have a Boolean value type. Only one value can
98
+ # be provided.
99
+ # @return [Boolean]
100
+ #
101
+ # @!attribute [rw] double_value
102
+ # Can be either null, or have a Double value type. Only one value can
103
+ # be provided.
104
+ # @return [Float]
105
+ #
106
+ # @!attribute [rw] empty_value
107
+ # An empty value. You cannot set `EmptyFieldValue` on a field that is
108
+ # required on a case template.
109
+ #
110
+ # This structure will never have any data members. It signifies an
111
+ # empty value on a case field.
112
+ # @return [Types::EmptyFieldValue]
113
+ #
114
+ # @!attribute [rw] string_value
115
+ # Can be either null, or have a String value type. Only one value can
116
+ # be provided.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] user_arn_value
120
+ # Can be either null, or have a String value type formatted as an ARN.
121
+ # Only one value can be provided.
122
+ # @return [String]
123
+ #
124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventFieldValueUnion AWS API Documentation
125
+ #
126
+ class AuditEventFieldValueUnion < Struct.new(
127
+ :boolean_value,
128
+ :double_value,
129
+ :empty_value,
130
+ :string_value,
131
+ :user_arn_value,
132
+ :unknown)
133
+ SENSITIVE = []
134
+ include Aws::Structure
135
+ include Aws::Structure::Union
136
+
137
+ class BooleanValue < AuditEventFieldValueUnion; end
138
+ class DoubleValue < AuditEventFieldValueUnion; end
139
+ class EmptyValue < AuditEventFieldValueUnion; end
140
+ class StringValue < AuditEventFieldValueUnion; end
141
+ class UserArnValue < AuditEventFieldValueUnion; end
142
+ class Unknown < AuditEventFieldValueUnion; end
143
+ end
144
+
145
+ # Information of the user which performed the audit.
146
+ #
147
+ # @!attribute [rw] iam_principal_arn
148
+ # Unique identifier of an IAM role.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] user
152
+ # Represents the identity of the person who performed the action.
153
+ # @return [Types::UserUnion]
154
+ #
155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AuditEventPerformedBy AWS API Documentation
156
+ #
157
+ class AuditEventPerformedBy < Struct.new(
158
+ :iam_principal_arn,
159
+ :user)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
26
164
  # Content specific to `BasicLayout` type. It configures fields in the
27
165
  # top panel and More Info tab of agent application.
28
166
  #
@@ -308,6 +446,10 @@ module Aws::ConnectCases
308
446
  # ListFields/DescribeField) and value union data.
309
447
  # @return [Array<Types::FieldValue>]
310
448
  #
449
+ # @!attribute [rw] performed_by
450
+ # Represents the identity of the person who performed the action.
451
+ # @return [Types::UserUnion]
452
+ #
311
453
  # @!attribute [rw] template_id
312
454
  # A unique identifier of a template.
313
455
  # @return [String]
@@ -318,6 +460,7 @@ module Aws::ConnectCases
318
460
  :client_token,
319
461
  :domain_id,
320
462
  :fields,
463
+ :performed_by,
321
464
  :template_id)
322
465
  SENSITIVE = []
323
466
  include Aws::Structure
@@ -886,6 +1029,11 @@ module Aws::ConnectCases
886
1029
 
887
1030
  # Object to store union of Field values.
888
1031
  #
1032
+ # <note markdown="1"> The `Summary` system field accepts 1500 characters while all other
1033
+ # fields accept 500 characters.
1034
+ #
1035
+ # </note>
1036
+ #
889
1037
  # @note FieldValueUnion is a union - when making an API calls you must set exactly one of the members.
890
1038
  #
891
1039
  # @note FieldValueUnion is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FieldValueUnion corresponding to the set member.
@@ -908,6 +1056,10 @@ module Aws::ConnectCases
908
1056
  # String value type.
909
1057
  # @return [String]
910
1058
  #
1059
+ # @!attribute [rw] user_arn_value
1060
+ # Represents the user that performed the audit.
1061
+ # @return [String]
1062
+ #
911
1063
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldValueUnion AWS API Documentation
912
1064
  #
913
1065
  class FieldValueUnion < Struct.new(
@@ -915,6 +1067,7 @@ module Aws::ConnectCases
915
1067
  :double_value,
916
1068
  :empty_value,
917
1069
  :string_value,
1070
+ :user_arn_value,
918
1071
  :unknown)
919
1072
  SENSITIVE = []
920
1073
  include Aws::Structure
@@ -924,9 +1077,60 @@ module Aws::ConnectCases
924
1077
  class DoubleValue < FieldValueUnion; end
925
1078
  class EmptyValue < FieldValueUnion; end
926
1079
  class StringValue < FieldValueUnion; end
1080
+ class UserArnValue < FieldValueUnion; end
927
1081
  class Unknown < FieldValueUnion; end
928
1082
  end
929
1083
 
1084
+ # @!attribute [rw] case_id
1085
+ # A unique identifier of the case.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] domain_id
1089
+ # The unique identifier of the Cases domain.
1090
+ # @return [String]
1091
+ #
1092
+ # @!attribute [rw] max_results
1093
+ # The maximum number of audit events to return. The current maximum
1094
+ # supported value is 25. This is also the default when no other value
1095
+ # is provided.
1096
+ # @return [Integer]
1097
+ #
1098
+ # @!attribute [rw] next_token
1099
+ # The token for the next set of results. Use the value returned in the
1100
+ # previous response in the next request to retrieve the next set of
1101
+ # results.
1102
+ # @return [String]
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEventsRequest AWS API Documentation
1105
+ #
1106
+ class GetCaseAuditEventsRequest < Struct.new(
1107
+ :case_id,
1108
+ :domain_id,
1109
+ :max_results,
1110
+ :next_token)
1111
+ SENSITIVE = []
1112
+ include Aws::Structure
1113
+ end
1114
+
1115
+ # @!attribute [rw] audit_events
1116
+ # A list of case audits where each represents a particular edit of the
1117
+ # case.
1118
+ # @return [Array<Types::AuditEvent>]
1119
+ #
1120
+ # @!attribute [rw] next_token
1121
+ # The token for the next set of results. This is null if there are no
1122
+ # more results to return.
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseAuditEventsResponse AWS API Documentation
1126
+ #
1127
+ class GetCaseAuditEventsResponse < Struct.new(
1128
+ :audit_events,
1129
+ :next_token)
1130
+ SENSITIVE = []
1131
+ include Aws::Structure
1132
+ end
1133
+
930
1134
  # @!attribute [rw] domain_id
931
1135
  # The unique identifier of the Cases domain.
932
1136
  # @return [String]
@@ -2114,12 +2318,17 @@ module Aws::ConnectCases
2114
2318
  # to `CreateCase`.
2115
2319
  # @return [Array<Types::FieldValue>]
2116
2320
  #
2321
+ # @!attribute [rw] performed_by
2322
+ # Represents the identity of the person who performed the action.
2323
+ # @return [Types::UserUnion]
2324
+ #
2117
2325
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRequest AWS API Documentation
2118
2326
  #
2119
2327
  class UpdateCaseRequest < Struct.new(
2120
2328
  :case_id,
2121
2329
  :domain_id,
2122
- :fields)
2330
+ :fields,
2331
+ :performed_by)
2123
2332
  SENSITIVE = []
2124
2333
  include Aws::Structure
2125
2334
  end
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connectcases/customizations'
52
52
  # @!group service
53
53
  module Aws::ConnectCases
54
54
 
55
- GEM_VERSION = '1.18.0'
55
+ GEM_VERSION = '1.19.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connectcases
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.18.0
4
+ version: 1.19.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-12-15 00:00:00.000000000 Z
11
+ date: 2024-01-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -72,7 +72,7 @@ licenses:
72
72
  metadata:
73
73
  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-connectcases
74
74
  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-connectcases/CHANGELOG.md
75
- post_install_message:
75
+ post_install_message:
76
76
  rdoc_options: []
77
77
  require_paths:
78
78
  - lib
@@ -87,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
87
87
  - !ruby/object:Gem::Version
88
88
  version: '0'
89
89
  requirements: []
90
- rubygems_version: 3.1.6
91
- signing_key:
90
+ rubygems_version: 3.4.10
91
+ signing_key:
92
92
  specification_version: 4
93
93
  summary: AWS SDK for Ruby - ConnectCases
94
94
  test_files: []