aws-sdk-connectcases 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d39eb59969aeffd71467b23c91a607be674225fcd0725defa130239186e82d
-  data.tar.gz: c322bc3db20f83bdf5a560940309e788661744b690d33f979d7fafac7c450ba8
+  metadata.gz: f5abb1319813710115c2dee34bf2f5a26fe66e6c93fa2d85f614f2ac9b2fef3a
+  data.tar.gz: 407df09c832c1befecfaaf3e3a1e9c1b61a970335b79ac94b40c6af5a38a0e66
 SHA512:
-  metadata.gz: 8af3eadd04102901827062326030fceecef876f1406159a084eeeabfc553ba9b4ac1e0b3f664a1c8a2e7425984ecbde0ab2747dbbc7a4921760c387795e94901
-  data.tar.gz: 9f7f96360d7370556bc73aace7b9d63b6353c2d9767d127399f40d57720ee724abb4b3e8bed70f8fcb6c60cb98b3b605665310b86923c89ff20db30c70e9b905
+  metadata.gz: 97cd5203bc7a04d5ec5594105020e8fe5425182557f003beb50bd8bbc924d6fcec451de2f0d3a1d04626c09fc5cb64c9ee05bdfff70636351680fee8e3681a0c
+  data.tar.gz: bf00a2db526d4b7e963aab707d77f7c2990ee810b5b4b8edf890039b5965382c4f2171b7ef4c4a4c1c60d9fc4f5d9e6302915271955968ed3ea17fcad81a174a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2022-11-09)
+------------------
+
+* Feature - This release adds the ability to disable templates through the UpdateTemplate API. Disabling templates prevents customers from creating cases using the template. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html
+
 1.1.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

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

@@ -474,11 +474,17 @@ module Aws::ConnectCases
     #
     # @option params [String] :client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
-    #   idempotency of the request.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency, see
+    #   [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
     #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
+    #
     # @option params [required, String] :domain_id
     #   The unique identifier of the Cases domain.
     #
@@ -754,11 +760,13 @@ module Aws::ConnectCases
     end
 
     # Creates a template in the Cases domain. This template is used to
-    # define the case object model (that is, define what data can be
+    # define the case object model (that is, to define what data can be
     # captured on cases) in a Cases domain. A template must have a unique
     # name within a domain, and it must reference existing field IDs and
     # layout IDs. Additionally, multiple fields with same IDs are not
-    # allowed within the same Template.
+    # allowed within the same Template. A template can be either Active or
+    # Inactive, as indicated by its status. Inactive templates cannot be
+    # used to create cases.
     #
     # @option params [String] :description
     #   A brief description of the template.
@@ -776,6 +784,9 @@ module Aws::ConnectCases
     #   A list of fields that must contain a value for a case to be
     #   successfully created with this template.
     #
+    # @option params [String] :status
+    #   The status of the template.
+    #
     # @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateTemplateResponse#template_arn #template_arn} => String
@@ -795,6 +806,7 @@ module Aws::ConnectCases
     #         field_id: "FieldId", # required
     #       },
     #     ],
+    #     status: "Active", # accepts Active, Inactive
     #   })
     #
     # @example Response structure
@@ -1002,6 +1014,7 @@ module Aws::ConnectCases
     #   * {Types::GetTemplateResponse#layout_configuration #layout_configuration} => Types::LayoutConfiguration
     #   * {Types::GetTemplateResponse#name #name} => String
     #   * {Types::GetTemplateResponse#required_fields #required_fields} => Array<Types::RequiredField>
+    #   * {Types::GetTemplateResponse#status #status} => String
     #   * {Types::GetTemplateResponse#tags #tags} => Hash<String,String>
     #   * {Types::GetTemplateResponse#template_arn #template_arn} => String
     #   * {Types::GetTemplateResponse#template_id #template_id} => String
@@ -1020,6 +1033,7 @@ module Aws::ConnectCases
     #   resp.name #=> String
     #   resp.required_fields #=> Array
     #   resp.required_fields[0].field_id #=> String
+    #   resp.status #=> String, one of "Active", "Inactive"
     #   resp.tags #=> Hash
     #   resp.tags["String"] #=> String
     #   resp.template_arn #=> String
@@ -1313,6 +1327,9 @@ module Aws::ConnectCases
     #   previous response in the next request to retrieve the next set of
     #   results.
     #
+    # @option params [Array<String>] :status
+    #   A list of status values to filter on.
+    #
     # @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListTemplatesResponse#next_token #next_token} => String
@@ -1326,6 +1343,7 @@ module Aws::ConnectCases
     #     domain_id: "DomainId", # required
     #     max_results: 1,
     #     next_token: "NextToken",
+    #     status: ["Active"], # accepts Active, Inactive
     #   })
     #
     # @example Response structure
@@ -1333,6 +1351,7 @@ module Aws::ConnectCases
     #   resp.next_token #=> String
     #   resp.templates #=> Array
     #   resp.templates[0].name #=> String
+    #   resp.templates[0].status #=> String, one of "Active", "Inactive"
     #   resp.templates[0].template_arn #=> String
     #   resp.templates[0].template_id #=> String
     #
@@ -1813,9 +1832,10 @@ module Aws::ConnectCases
 
     # Updates the attributes of an existing template. The template
     # attributes that can be modified include `name`, `description`,
-    # `layouts`, and `requiredFields`. At least one of these attributes must
-    # not be null. If a null value is provided for a given attribute, that
-    # attribute is ignored and its current value is preserved.
+    # `layoutConfiguration`, `requiredFields`, and `status`. At least one of
+    # these attributes must not be null. If a null value is provided for a
+    # given attribute, that attribute is ignored and its current value is
+    # preserved.
     #
     # @option params [String] :description
     #   A brief description of the template.
@@ -1833,6 +1853,9 @@ module Aws::ConnectCases
     #   A list of fields that must contain a value for a case to be
     #   successfully created with this template.
     #
+    # @option params [String] :status
+    #   The status of the template.
+    #
     # @option params [required, String] :template_id
     #   A unique identifier for the template.
     #
@@ -1852,6 +1875,7 @@ module Aws::ConnectCases
     #         field_id: "FieldId", # required
     #       },
     #     ],
+    #     status: "Active", # accepts Active, Inactive
     #     template_id: "TemplateId", # required
     #   })
     #
@@ -1877,7 +1901,7 @@ module Aws::ConnectCases
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connectcases'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -177,6 +177,8 @@ module Aws::ConnectCases
     TemplateDescription = Shapes::StringShape.new(name: 'TemplateDescription')
     TemplateId = Shapes::StringShape.new(name: 'TemplateId')
     TemplateName = Shapes::StringShape.new(name: 'TemplateName')
+    TemplateStatus = Shapes::StringShape.new(name: 'TemplateStatus')
+    TemplateStatusFilters = Shapes::ListShape.new(name: 'TemplateStatusFilters')
     TemplateSummary = Shapes::StructureShape.new(name: 'TemplateSummary')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
@@ -324,6 +326,7 @@ module Aws::ConnectCases
     CreateTemplateRequest.add_member(:layout_configuration, Shapes::ShapeRef.new(shape: LayoutConfiguration, location_name: "layoutConfiguration"))
     CreateTemplateRequest.add_member(:name, Shapes::ShapeRef.new(shape: TemplateName, required: true, location_name: "name"))
     CreateTemplateRequest.add_member(:required_fields, Shapes::ShapeRef.new(shape: RequiredFieldList, location_name: "requiredFields"))
+    CreateTemplateRequest.add_member(:status, Shapes::ShapeRef.new(shape: TemplateStatus, location_name: "status"))
     CreateTemplateRequest.struct_class = Types::CreateTemplateRequest
 
     CreateTemplateResponse.add_member(:template_arn, Shapes::ShapeRef.new(shape: TemplateArn, required: true, location_name: "templateArn"))
@@ -472,6 +475,7 @@ module Aws::ConnectCases
     GetTemplateResponse.add_member(:layout_configuration, Shapes::ShapeRef.new(shape: LayoutConfiguration, location_name: "layoutConfiguration"))
     GetTemplateResponse.add_member(:name, Shapes::ShapeRef.new(shape: TemplateName, required: true, location_name: "name"))
     GetTemplateResponse.add_member(:required_fields, Shapes::ShapeRef.new(shape: RequiredFieldList, location_name: "requiredFields"))
+    GetTemplateResponse.add_member(:status, Shapes::ShapeRef.new(shape: TemplateStatus, required: true, location_name: "status"))
     GetTemplateResponse.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
     GetTemplateResponse.add_member(:template_arn, Shapes::ShapeRef.new(shape: TemplateArn, required: true, location_name: "templateArn"))
     GetTemplateResponse.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
@@ -560,6 +564,7 @@ module Aws::ConnectCases
     ListTemplatesRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
     ListTemplatesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListTemplatesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListTemplatesRequest.add_member(:status, Shapes::ShapeRef.new(shape: TemplateStatusFilters, location: "querystring", location_name: "status"))
     ListTemplatesRequest.struct_class = Types::ListTemplatesRequest
 
     ListTemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
@@ -684,7 +689,10 @@ module Aws::ConnectCases
     Tags.key = Shapes::ShapeRef.new(shape: String)
     Tags.value = Shapes::ShapeRef.new(shape: String)
 
+    TemplateStatusFilters.member = Shapes::ShapeRef.new(shape: TemplateStatus)
+
     TemplateSummary.add_member(:name, Shapes::ShapeRef.new(shape: TemplateName, required: true, location_name: "name"))
+    TemplateSummary.add_member(:status, Shapes::ShapeRef.new(shape: TemplateStatus, required: true, location_name: "status"))
     TemplateSummary.add_member(:template_arn, Shapes::ShapeRef.new(shape: TemplateArn, required: true, location_name: "templateArn"))
     TemplateSummary.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
     TemplateSummary.struct_class = Types::TemplateSummary
@@ -726,6 +734,7 @@ module Aws::ConnectCases
     UpdateTemplateRequest.add_member(:layout_configuration, Shapes::ShapeRef.new(shape: LayoutConfiguration, location_name: "layoutConfiguration"))
     UpdateTemplateRequest.add_member(:name, Shapes::ShapeRef.new(shape: TemplateName, location_name: "name"))
     UpdateTemplateRequest.add_member(:required_fields, Shapes::ShapeRef.new(shape: RequiredFieldList, location_name: "requiredFields"))
+    UpdateTemplateRequest.add_member(:status, Shapes::ShapeRef.new(shape: TemplateStatus, location_name: "status"))
     UpdateTemplateRequest.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location: "uri", location_name: "templateId"))
     UpdateTemplateRequest.struct_class = Types::UpdateTemplateRequest
 
@@ -1181,6 +1190,7 @@ module Aws::ConnectCases
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
       api.add_operation(:update_template, Seahorse::Model::Operation.new.tap do |o|

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

@@ -395,10 +395,16 @@ module Aws::ConnectCases
     #
     # @!attribute [rw] client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
-    #   idempotency of the request.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] domain_id
@@ -696,6 +702,7 @@ module Aws::ConnectCases
     #             field_id: "FieldId", # required
     #           },
     #         ],
+    #         status: "Active", # accepts Active, Inactive
     #       }
     #
     # @!attribute [rw] description
@@ -719,6 +726,10 @@ module Aws::ConnectCases
     #   successfully created with this template.
     #   @return [Array<Types::RequiredField>]
     #
+    # @!attribute [rw] status
+    #   The status of the template.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateTemplateRequest AWS API Documentation
     #
     class CreateTemplateRequest < Struct.new(
@@ -726,7 +737,8 @@ module Aws::ConnectCases
       :domain_id,
       :layout_configuration,
       :name,
-      :required_fields)
+      :required_fields,
+      :status)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1466,6 +1478,10 @@ module Aws::ConnectCases
     #   successfully created with this template.
     #   @return [Array<Types::RequiredField>]
     #
+    # @!attribute [rw] status
+    #   The status of the template.
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   A map of of key-value pairs that represent tags on a resource. Tags
     #   are used to organize, track, or control access for this resource.
@@ -1486,6 +1502,7 @@ module Aws::ConnectCases
       :layout_configuration,
       :name,
       :required_fields,
+      :status,
       :tags,
       :template_arn,
       :template_id)
@@ -1921,6 +1938,7 @@ module Aws::ConnectCases
     #         domain_id: "DomainId", # required
     #         max_results: 1,
     #         next_token: "NextToken",
+    #         status: ["Active"], # accepts Active, Inactive
     #       }
     #
     # @!attribute [rw] domain_id
@@ -1937,12 +1955,17 @@ module Aws::ConnectCases
     #   results.
     #   @return [String]
     #
+    # @!attribute [rw] status
+    #   A list of status values to filter on.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTemplatesRequest AWS API Documentation
     #
     class ListTemplatesRequest < Struct.new(
       :domain_id,
       :max_results,
-      :next_token)
+      :next_token,
+      :status)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2550,6 +2573,10 @@ module Aws::ConnectCases
     #   The template name.
     #   @return [String]
     #
+    # @!attribute [rw] status
+    #   The status of the template.
+    #   @return [String]
+    #
     # @!attribute [rw] template_arn
     #   The Amazon Resource Name (ARN) of the template.
     #   @return [String]
@@ -2562,6 +2589,7 @@ module Aws::ConnectCases
     #
     class TemplateSummary < Struct.new(
       :name,
+      :status,
       :template_arn,
       :template_id)
       SENSITIVE = []
@@ -2782,6 +2810,7 @@ module Aws::ConnectCases
     #             field_id: "FieldId", # required
     #           },
     #         ],
+    #         status: "Active", # accepts Active, Inactive
     #         template_id: "TemplateId", # required
     #       }
     #
@@ -2806,6 +2835,10 @@ module Aws::ConnectCases
     #   successfully created with this template.
     #   @return [Array<Types::RequiredField>]
     #
+    # @!attribute [rw] status
+    #   The status of the template.
+    #   @return [String]
+    #
     # @!attribute [rw] template_id
     #   A unique identifier for the template.
     #   @return [String]
@@ -2818,6 +2851,7 @@ module Aws::ConnectCases
       :layout_configuration,
       :name,
       :required_fields,
+      :status,
       :template_id)
       SENSITIVE = []
       include Aws::Structure

data/lib/aws-sdk-connectcases.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectcases
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core