aws-sdk-connectcases 1.44.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5349ccdbb82298ca55b6026794c655a347f20a179fb16efa0e54b0b4dd99676
-  data.tar.gz: ab1677baae3327d6397c4fbceaeace60ebaba0a0eef01bf395379eb1f8abb7ba
+  metadata.gz: 844f5505fbdaeab8c497ad25093073f328056a47b65b634bf9b3cad4814c7d8c
+  data.tar.gz: 863f041f9235c8a6cb445440946ff86bd2f8fa1af445b7aabf739ef727299ca1
 SHA512:
-  metadata.gz: f758a1bf35be4813b24065f8ff84e062769f5d7bcbb6e3d0d38b116b3ec4771f7f81831911e656f569d95a488bbd5a14a91f338e9f944812b89e2650cfd1b1ae
-  data.tar.gz: 9d4e47b44ede3ab8952d45451421a245a93ead40c041378b975e7c496534a7f5f7d15d9e26d54005b52dbb62c90b875e703f58b46f8fc4fbbdf93370e28d67f1
+  metadata.gz: 7c105c39d393d565d64aa546ef859bb810e5172819521b45870ccfaf362e6121a856f71c2770cce2eb2972fcfc5b54f302958b65caa9b3d9e4740b7d2f2fc057
+  data.tar.gz: b987d876c7e4c0f6a26ca62e4a94996447cb2c31b5ca321308b986d251b2db1a34c5e277e9e891a76fc7fba7d63b7be2305499865be07e93320cf48ed8f5ea0d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.45.0 (2025-07-02)
+------------------
+
+* Feature - This release adds DeleteCase and DeleteRelatedItem APIs, which enable deleting cases and comments, undoing contact association, and removing service level agreements (SLAs) from cases. Contact center admins can use these APIs to delete cases when requested by customers and correct agent errors.
+
 1.44.0 (2025-06-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.44.0
+1.45.0

data/lib/aws-sdk-connectcases/client.rb

@@ -637,19 +637,20 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
-    # <note markdown="1"> If you provide a value for `PerformedBy.UserArn` you must also have
+    # <note markdown="1"> If you provide a value for `PerformedBy.UserArn`
+    # you must also have
     # [connect:DescribeUser][1] permission on the User ARN resource that you
     # provide
     #
     #  </note>
     #
-    # Creates a case in the specified Cases domain. Case system and custom
+    #  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.
     #
-    # The following fields are required when creating a case:
+    #  The following fields are required when creating a case:
     #
-    # * `customer_id` - You must provide the full customer profile ARN in
+    #  * `customer_id` - You must provide the full customer profile ARN in
     #   this format: `arn:aws:profile:your_AWS_Region:your_AWS_account
     #   ID:domains/your_profiles_domain_name/profiles/profile_ID`
     #
@@ -1175,6 +1176,43 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
+    # The DeleteCase API permanently deletes a case and all its associated
+    # resources from the cases data store. After a successful deletion, you
+    # cannot:
+    #
+    # * Retrieve related items
+    #
+    # * Access audit history
+    #
+    # * Perform any operations that require the CaseID
+    #
+    # This action is irreversible. Once you delete a case, you cannot
+    # recover its data.
+    #
+    # @option params [required, String] :case_id
+    #   A unique identifier of the case.
+    #
+    # @option params [required, String] :domain_id
+    #   A unique identifier of the Cases domain.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_case({
+    #     case_id: "CaseId", # required
+    #     domain_id: "DomainId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCase AWS API Documentation
+    #
+    # @overload delete_case(params = {})
+    # @param [Hash] params ({})
+    def delete_case(params = {}, options = {})
+      req = build_request(:delete_case, params)
+      req.send_request(options)
+    end
+
     # Deletes a case rule. In the Amazon Connect admin website, case rules
     # are known as *case field conditions*. For more information about case
     # field conditions, see [Add case field conditions to a case
@@ -1342,6 +1380,45 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
+    # Deletes the related item resource under a case.
+    #
+    # <note markdown="1"> This API cannot be used on a FILE type related attachment. To delete
+    # this type of file, use the [DeleteAttachedFile][1] API
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html
+    #
+    # @option params [required, String] :case_id
+    #   A unique identifier of the case.
+    #
+    # @option params [required, String] :domain_id
+    #   A unique identifier of the Cases domain.
+    #
+    # @option params [required, String] :related_item_id
+    #   A unique identifier of a related item.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_related_item({
+    #     case_id: "CaseId", # required
+    #     domain_id: "DomainId", # required
+    #     related_item_id: "RelatedItemId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteRelatedItem AWS API Documentation
+    #
+    # @overload delete_related_item(params = {})
+    # @param [Hash] params ({})
+    def delete_related_item(params = {}, options = {})
+      req = build_request(:delete_related_item, params)
+      req.send_request(options)
+    end
+
     # Deletes a cases template. You can delete up to 100 templates per
     # domain.
     #
@@ -2456,17 +2533,18 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
-    # <note markdown="1"> If you provide a value for `PerformedBy.UserArn` you must also have
+    # <note markdown="1"> If you provide a value for `PerformedBy.UserArn`
+    # you must also have
     # [connect:DescribeUser][1] permission on the User ARN resource that you
     # provide
     #
     #  </note>
     #
-    # Updates the values of fields on a case. Fields to be updated are
+    #  Updates the values of fields on a case. Fields to be updated are
     # received as an array of id/value pairs identical to the `CreateCase`
     # input .
     #
-    # If the action is successful, the service sends back an HTTP 200
+    #  If the action is successful, the service sends back an HTTP 200
     # response with an empty HTTP body.
     #
     #
@@ -2818,7 +2896,7 @@ module Aws::ConnectCases
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-connectcases'
-      context[:gem_version] = '1.44.0'
+      context[:gem_version] = '1.45.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-connectcases/client_api.rb

@@ -92,6 +92,8 @@ module Aws::ConnectCases
     CreateTemplateResponse = Shapes::StructureShape.new(name: 'CreateTemplateResponse')
     CreatedTime = Shapes::TimestampShape.new(name: 'CreatedTime', timestampFormat: "iso8601")
     CustomEntity = Shapes::StringShape.new(name: 'CustomEntity')
+    DeleteCaseRequest = Shapes::StructureShape.new(name: 'DeleteCaseRequest')
+    DeleteCaseResponse = Shapes::StructureShape.new(name: 'DeleteCaseResponse')
     DeleteCaseRuleRequest = Shapes::StructureShape.new(name: 'DeleteCaseRuleRequest')
     DeleteCaseRuleResponse = Shapes::StructureShape.new(name: 'DeleteCaseRuleResponse')
     DeleteDomainRequest = Shapes::StructureShape.new(name: 'DeleteDomainRequest')
@@ -100,6 +102,8 @@ module Aws::ConnectCases
     DeleteFieldResponse = Shapes::StructureShape.new(name: 'DeleteFieldResponse')
     DeleteLayoutRequest = Shapes::StructureShape.new(name: 'DeleteLayoutRequest')
     DeleteLayoutResponse = Shapes::StructureShape.new(name: 'DeleteLayoutResponse')
+    DeleteRelatedItemRequest = Shapes::StructureShape.new(name: 'DeleteRelatedItemRequest')
+    DeleteRelatedItemResponse = Shapes::StructureShape.new(name: 'DeleteRelatedItemResponse')
     DeleteTemplateRequest = Shapes::StructureShape.new(name: 'DeleteTemplateRequest')
     DeleteTemplateResponse = Shapes::StructureShape.new(name: 'DeleteTemplateResponse')
     Deleted = Shapes::BooleanShape.new(name: 'Deleted')
@@ -513,6 +517,12 @@ module Aws::ConnectCases
     CreateTemplateResponse.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
     CreateTemplateResponse.struct_class = Types::CreateTemplateResponse
 
+    DeleteCaseRequest.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location: "uri", location_name: "caseId"))
+    DeleteCaseRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
+    DeleteCaseRequest.struct_class = Types::DeleteCaseRequest
+
+    DeleteCaseResponse.struct_class = Types::DeleteCaseResponse
+
     DeleteCaseRuleRequest.add_member(:case_rule_id, Shapes::ShapeRef.new(shape: CaseRuleId, required: true, location: "uri", location_name: "caseRuleId"))
     DeleteCaseRuleRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
     DeleteCaseRuleRequest.struct_class = Types::DeleteCaseRuleRequest
@@ -536,6 +546,13 @@ module Aws::ConnectCases
 
     DeleteLayoutResponse.struct_class = Types::DeleteLayoutResponse
 
+    DeleteRelatedItemRequest.add_member(:case_id, Shapes::ShapeRef.new(shape: CaseId, required: true, location: "uri", location_name: "caseId"))
+    DeleteRelatedItemRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
+    DeleteRelatedItemRequest.add_member(:related_item_id, Shapes::ShapeRef.new(shape: RelatedItemId, required: true, location: "uri", location_name: "relatedItemId"))
+    DeleteRelatedItemRequest.struct_class = Types::DeleteRelatedItemRequest
+
+    DeleteRelatedItemResponse.struct_class = Types::DeleteRelatedItemResponse
+
     DeleteTemplateRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
     DeleteTemplateRequest.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location: "uri", location_name: "templateId"))
     DeleteTemplateRequest.struct_class = Types::DeleteTemplateRequest
@@ -1266,6 +1283,19 @@ module Aws::ConnectCases
         o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
+      api.add_operation(:delete_case, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteCase"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/domains/{domainId}/cases/{caseId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteCaseRequest)
+        o.output = Shapes::ShapeRef.new(shape: DeleteCaseResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:delete_case_rule, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteCaseRule"
         o.http_method = "DELETE"
@@ -1322,6 +1352,19 @@ module Aws::ConnectCases
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
       end)
 
+      api.add_operation(:delete_related_item, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteRelatedItem"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/domains/{domainId}/cases/{caseId}/related-items/{relatedItemId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteRelatedItemRequest)
+        o.output = Shapes::ShapeRef.new(shape: DeleteRelatedItemResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:delete_template, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteTemplate"
         o.http_method = "DELETE"

data/lib/aws-sdk-connectcases/types.rb

@@ -975,6 +975,27 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
+    # @!attribute [rw] case_id
+    #   A unique identifier of the case.
+    #   @return [String]
+    #
+    # @!attribute [rw] domain_id
+    #   A unique identifier of the Cases domain.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseRequest AWS API Documentation
+    #
+    class DeleteCaseRequest < Struct.new(
+      :case_id,
+      :domain_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteCaseResponse AWS API Documentation
+    #
+    class DeleteCaseResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] case_rule_id
     #   Unique identifier of a case rule.
     #   @return [String]
@@ -1054,6 +1075,32 @@ module Aws::ConnectCases
     #
     class DeleteLayoutResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] case_id
+    #   A unique identifier of the case.
+    #   @return [String]
+    #
+    # @!attribute [rw] domain_id
+    #   A unique identifier of the Cases domain.
+    #   @return [String]
+    #
+    # @!attribute [rw] related_item_id
+    #   A unique identifier of a related item.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteRelatedItemRequest AWS API Documentation
+    #
+    class DeleteRelatedItemRequest < Struct.new(
+      :case_id,
+      :domain_id,
+      :related_item_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteRelatedItemResponse AWS API Documentation
+    #
+    class DeleteRelatedItemResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] domain_id
     #   The unique identifier of the Cases domain.
     #   @return [String]

data/lib/aws-sdk-connectcases.rb

@@ -54,7 +54,7 @@ module Aws::ConnectCases
   autoload :EndpointProvider, 'aws-sdk-connectcases/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-connectcases/endpoints'
 
-  GEM_VERSION = '1.44.0'
+  GEM_VERSION = '1.45.0'
 
 end
 

data/sig/client.rbs

@@ -350,6 +350,16 @@ module Aws
                            ) -> _CreateTemplateResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateTemplateResponseSuccess
 
+      interface _DeleteCaseResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCaseResponse]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#delete_case-instance_method
+      def delete_case: (
+                         case_id: ::String,
+                         domain_id: ::String
+                       ) -> _DeleteCaseResponseSuccess
+                     | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCaseResponseSuccess
+
       interface _DeleteCaseRuleResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCaseRuleResponse]
       end
@@ -389,6 +399,17 @@ module Aws
                          ) -> _DeleteLayoutResponseSuccess
                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteLayoutResponseSuccess
 
+      interface _DeleteRelatedItemResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRelatedItemResponse]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#delete_related_item-instance_method
+      def delete_related_item: (
+                                 case_id: ::String,
+                                 domain_id: ::String,
+                                 related_item_id: ::String
+                               ) -> _DeleteRelatedItemResponseSuccess
+                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRelatedItemResponseSuccess
+
       interface _DeleteTemplateResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteTemplateResponse]
       end

data/sig/types.rbs

@@ -317,6 +317,15 @@ module Aws::ConnectCases
       SENSITIVE: []
     end
 
+    class DeleteCaseRequest
+      attr_accessor case_id: ::String
+      attr_accessor domain_id: ::String
+      SENSITIVE: []
+    end
+
+    class DeleteCaseResponse < Aws::EmptyStructure
+    end
+
     class DeleteCaseRuleRequest
       attr_accessor case_rule_id: ::String
       attr_accessor domain_id: ::String
@@ -352,6 +361,16 @@ module Aws::ConnectCases
     class DeleteLayoutResponse < Aws::EmptyStructure
     end
 
+    class DeleteRelatedItemRequest
+      attr_accessor case_id: ::String
+      attr_accessor domain_id: ::String
+      attr_accessor related_item_id: ::String
+      SENSITIVE: []
+    end
+
+    class DeleteRelatedItemResponse < Aws::EmptyStructure
+    end
+
     class DeleteTemplateRequest
       attr_accessor domain_id: ::String
       attr_accessor template_id: ::String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectcases
 version: !ruby/object:Gem::Version
-  version: 1.44.0
+  version: 1.45.0
 platform: ruby
 authors:
 - Amazon Web Services