aws-sdk-connectcases 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3b2bd995d3790404f84b3e8639cc4bb96bb33ea240e821b09a1fca0d1eeabd
-  data.tar.gz: 3a83f01d32de88f58398397490850a1e1e75869d2b9f3a417e1f7f25f935c617
+  metadata.gz: 14654f0041956c4a85dbe90875a91712c3c4a28dbaab7b421c631d771bfea692
+  data.tar.gz: 3f719bd15c6aa85f4b3316a45bf0427a999f3c569b23e2100f5dca33fb3340f6
 SHA512:
-  metadata.gz: 346c22bb9bba90a7c767811f68dda4ef54e32788a660867a4cd67e5dfb3b43058663a805bc359766363d4edf4556f40afbfef41608b38b46ddfcdc8b49c6044b
-  data.tar.gz: d2d33bc298def662c7de0d3c8da28241b9969b99a14f68e5e8c566fbab08561a991b5614c47aac75103a0b46cddcafb062fa5f80f90254ef5c5c0a4164e92d6f
+  metadata.gz: ed27a200557023e0c4250568c116353b8a35714a9e6bc2c9ccb68d6f7a0fbb4064553f5ff1e9b71c4914522f2c9941a9b6f6db8d43b338fdd1d20ddc6b7a02c3
+  data.tar.gz: ca83b711bf0e8b5337ede0b626f2ad6d0b5bde3cb72cefd02e5daeacd93ad958cefc2ab576de3951fe28e0cd4876c5e1f6840ffa4407aff58474160079c4c72a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.4.0 (2023-02-24)
+------------------
+
+* Feature - This release adds the ability to delete domains through the DeleteDomain API. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html
+
 1.3.0 (2023-01-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

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

@@ -468,7 +468,9 @@ module Aws::ConnectCases
     # fields are taken as an array id/value pairs with a declared data
     # types.
     #
-    # <note markdown="1"> `customer_id` is a required field when creating a case.
+    # <note markdown="1"> The following fields are required when creating a case:
+    #
+    #       <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/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>
     #
     #  </note>
     #
@@ -538,10 +540,13 @@ module Aws::ConnectCases
     #
     # This will not associate your connect instance to Cases domain.
     # Instead, use the Amazon Connect [CreateIntegrationAssociation][1] API.
+    # You need specific IAM permissions to successfully associate the Cases
+    # domain. For more information, see [Onboard to Cases][2].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam
     #
     # @option params [required, String] :name
     #   The name for your Cases domain. It must be unique for your Amazon Web
@@ -823,6 +828,28 @@ module Aws::ConnectCases
       req.send_request(options)
     end
 
+    # Deletes a domain.
+    #
+    # @option params [required, String] :domain_id
+    #   The unique identifier of the Cases domain.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_domain({
+    #     domain_id: "DomainId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomain AWS API Documentation
+    #
+    # @overload delete_domain(params = {})
+    # @param [Hash] params ({})
+    def delete_domain(params = {}, options = {})
+      req = build_request(:delete_domain, params)
+      req.send_request(options)
+    end
+
     # Returns information about a specific case if it exists.
     #
     # @option params [required, String] :case_id
@@ -1408,6 +1435,12 @@ module Aws::ConnectCases
     # Searches for cases within their associated Cases domain. Search
     # results are returned as a paginated list of abridged case documents.
     #
+    # <note markdown="1"> For `customer_id` you must provide the full customer profile ARN in
+    # this format: ` arn:aws:profile:your AWS Region:your AWS account
+    # ID:domains/profiles domain name/profiles/profile ID`.
+    #
+    #  </note>
+    #
     # @option params [required, String] :domain_id
     #   The unique identifier of the Cases domain.
     #
@@ -1901,7 +1934,7 @@ module Aws::ConnectCases
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connectcases'
-      context[:gem_version] = '1.3.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -61,6 +61,8 @@ module Aws::ConnectCases
     CreateTemplateRequest = Shapes::StructureShape.new(name: 'CreateTemplateRequest')
     CreateTemplateResponse = Shapes::StructureShape.new(name: 'CreateTemplateResponse')
     CreatedTime = Shapes::TimestampShape.new(name: 'CreatedTime', timestampFormat: "iso8601")
+    DeleteDomainRequest = Shapes::StructureShape.new(name: 'DeleteDomainRequest')
+    DeleteDomainResponse = Shapes::StructureShape.new(name: 'DeleteDomainResponse')
     DomainArn = Shapes::StringShape.new(name: 'DomainArn')
     DomainId = Shapes::StringShape.new(name: 'DomainId')
     DomainName = Shapes::StringShape.new(name: 'DomainName')
@@ -333,6 +335,11 @@ module Aws::ConnectCases
     CreateTemplateResponse.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
     CreateTemplateResponse.struct_class = Types::CreateTemplateResponse
 
+    DeleteDomainRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
+    DeleteDomainRequest.struct_class = Types::DeleteDomainRequest
+
+    DeleteDomainResponse.struct_class = Types::DeleteDomainResponse
+
     DomainSummary.add_member(:domain_arn, Shapes::ShapeRef.new(shape: DomainArn, required: true, location_name: "domainArn"))
     DomainSummary.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId"))
     DomainSummary.add_member(:name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "name"))
@@ -878,6 +885,20 @@ module Aws::ConnectCases
         o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
+      api.add_operation(:delete_domain, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteDomain"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/domains/{domainId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteDomainRequest)
+        o.output = Shapes::ShapeRef.new(shape: DeleteDomainResponse)
+        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)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+      end)
+
       api.add_operation(:get_case, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetCase"
         o.http_method = "POST"

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

@@ -14,36 +14,39 @@ module Aws::ConnectCases
       use_dual_stack = parameters.use_dual_stack
       use_fips = parameters.use_fips
       endpoint = parameters.endpoint
-      if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
-        if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
-          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
-          end
-          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-            raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
-          end
-          return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
-        end
-        if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
-          end
-          raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
-        end
+      if Aws::Endpoints::Matchers.set?(endpoint)
         if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
-            return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
-          end
-          raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+          raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
         end
         if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+          raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
+        end
+        return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+      end
+      if Aws::Endpoints::Matchers.set?(region)
+        if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
+          end
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+              return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+          end
+          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
           end
-          raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
+          return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
         end
-        return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
       end
+      raise ArgumentError, "Invalid Configuration: Missing Region"
       raise ArgumentError, 'No endpoint could be resolved'
 
     end

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

@@ -123,6 +123,20 @@ module Aws::ConnectCases
       end
     end
 
+    class DeleteDomain
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::ConnectCases::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class GetCase
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-connectcases/plugins/endpoints.rb

@@ -72,6 +72,8 @@ module Aws::ConnectCases
             Aws::ConnectCases::Endpoints::CreateRelatedItem.build(context)
           when :create_template
             Aws::ConnectCases::Endpoints::CreateTemplate.build(context)
+          when :delete_domain
+            Aws::ConnectCases::Endpoints::DeleteDomain.build(context)
           when :get_case
             Aws::ConnectCases::Endpoints::GetCase.build(context)
           when :get_case_event_configuration

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

@@ -553,6 +553,22 @@ module Aws::ConnectCases
       include Aws::Structure
     end
 
+    # @!attribute [rw] domain_id
+    #   The unique identifier of the Cases domain.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomainRequest AWS API Documentation
+    #
+    class DeleteDomainRequest < Struct.new(
+      :domain_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomainResponse AWS API Documentation
+    #
+    class DeleteDomainResponse < Aws::EmptyStructure; end
+
     # Object for the summarized details of the domain.
     #
     # @!attribute [rw] domain_arn

data/lib/aws-sdk-connectcases.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connectcases/customizations'
 # @!group service
 module Aws::ConnectCases
 
-  GEM_VERSION = '1.3.0'
+  GEM_VERSION = '1.4.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectcases
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core