aws-sdk-connectcases 1.3.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4b3b2bd995d3790404f84b3e8639cc4bb96bb33ea240e821b09a1fca0d1eeabd
4
- data.tar.gz: 3a83f01d32de88f58398397490850a1e1e75869d2b9f3a417e1f7f25f935c617
3
+ metadata.gz: bae60b651cdc5dbac606cb2f7fbe9f64bad4c008170ce5753978aa5b1aad2147
4
+ data.tar.gz: 91ca88b0d9cf9900f88f3d323536059d178b059bec9ee8d3389eda31a0c67940
5
5
  SHA512:
6
- metadata.gz: 346c22bb9bba90a7c767811f68dda4ef54e32788a660867a4cd67e5dfb3b43058663a805bc359766363d4edf4556f40afbfef41608b38b46ddfcdc8b49c6044b
7
- data.tar.gz: d2d33bc298def662c7de0d3c8da28241b9969b99a14f68e5e8c566fbab08561a991b5614c47aac75103a0b46cddcafb062fa5f80f90254ef5c5c0a4164e92d6f
6
+ metadata.gz: 1dd51fcf6cbcb6d80ffd5fe1f8f62b96d281e1285aa901dbd565cb5900a4291e79aebc70e709e7c866e2dab3e20ad8221eb114fb96d9b51765519f5254fad01b
7
+ data.tar.gz: 45def1a29db4dfe2021e365da7479a4079bfad7f41348a74901cf440fa23f8d6046ef3943835778a49f911691c90ca95413bca518ca4cf6fe00f35e36700d25c
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.5.0 (2023-05-19)
5
+ ------------------
6
+
7
+ * Feature - This release adds the ability to create fields with type Url through the CreateField API. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html
8
+
9
+ 1.4.0 (2023-02-24)
10
+ ------------------
11
+
12
+ * 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
13
+
4
14
  1.3.0 (2023-01-18)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.3.0
1
+ 1.5.0
@@ -407,7 +407,7 @@ module Aws::ConnectCases
407
407
  # resp.fields[0].namespace #=> String, one of "System", "Custom"
408
408
  # resp.fields[0].tags #=> Hash
409
409
  # resp.fields[0].tags["String"] #=> String
410
- # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect"
410
+ # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url"
411
411
  #
412
412
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetField AWS API Documentation
413
413
  #
@@ -468,7 +468,9 @@ module Aws::ConnectCases
468
468
  # fields are taken as an array id/value pairs with a declared data
469
469
  # types.
470
470
  #
471
- # <note markdown="1"> `customer_id` is a required field when creating a case.
471
+ # <note markdown="1"> The following fields are required when creating a case:
472
+ #
473
+ # <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>
472
474
  #
473
475
  # </note>
474
476
  #
@@ -538,10 +540,13 @@ module Aws::ConnectCases
538
540
  #
539
541
  # This will not associate your connect instance to Cases domain.
540
542
  # Instead, use the Amazon Connect [CreateIntegrationAssociation][1] API.
543
+ # You need specific IAM permissions to successfully associate the Cases
544
+ # domain. For more information, see [Onboard to Cases][2].
541
545
  #
542
546
  #
543
547
  #
544
548
  # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html
549
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam
545
550
  #
546
551
  # @option params [required, String] :name
547
552
  # The name for your Cases domain. It must be unique for your Amazon Web
@@ -602,7 +607,7 @@ module Aws::ConnectCases
602
607
  # description: "FieldDescription",
603
608
  # domain_id: "DomainId", # required
604
609
  # name: "FieldName", # required
605
- # type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect
610
+ # type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect, Url
606
611
  # })
607
612
  #
608
613
  # @example Response structure
@@ -823,6 +828,28 @@ module Aws::ConnectCases
823
828
  req.send_request(options)
824
829
  end
825
830
 
831
+ # Deletes a domain.
832
+ #
833
+ # @option params [required, String] :domain_id
834
+ # The unique identifier of the Cases domain.
835
+ #
836
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
837
+ #
838
+ # @example Request syntax with placeholder values
839
+ #
840
+ # resp = client.delete_domain({
841
+ # domain_id: "DomainId", # required
842
+ # })
843
+ #
844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomain AWS API Documentation
845
+ #
846
+ # @overload delete_domain(params = {})
847
+ # @param [Hash] params ({})
848
+ def delete_domain(params = {}, options = {})
849
+ req = build_request(:delete_domain, params)
850
+ req.send_request(options)
851
+ end
852
+
826
853
  # Returns information about a specific case if it exists.
827
854
  #
828
855
  # @option params [required, String] :case_id
@@ -1226,7 +1253,7 @@ module Aws::ConnectCases
1226
1253
  # resp.fields[0].field_id #=> String
1227
1254
  # resp.fields[0].name #=> String
1228
1255
  # resp.fields[0].namespace #=> String, one of "System", "Custom"
1229
- # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect"
1256
+ # resp.fields[0].type #=> String, one of "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url"
1230
1257
  # resp.next_token #=> String
1231
1258
  #
1232
1259
  # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFields AWS API Documentation
@@ -1408,6 +1435,12 @@ module Aws::ConnectCases
1408
1435
  # Searches for cases within their associated Cases domain. Search
1409
1436
  # results are returned as a paginated list of abridged case documents.
1410
1437
  #
1438
+ # <note markdown="1"> For `customer_id` you must provide the full customer profile ARN in
1439
+ # this format: ` arn:aws:profile:your AWS Region:your AWS account
1440
+ # ID:domains/profiles domain name/profiles/profile ID`.
1441
+ #
1442
+ # </note>
1443
+ #
1411
1444
  # @option params [required, String] :domain_id
1412
1445
  # The unique identifier of the Cases domain.
1413
1446
  #
@@ -1901,7 +1934,7 @@ module Aws::ConnectCases
1901
1934
  params: params,
1902
1935
  config: config)
1903
1936
  context[:gem_name] = 'aws-sdk-connectcases'
1904
- context[:gem_version] = '1.3.0'
1937
+ context[:gem_version] = '1.5.0'
1905
1938
  Seahorse::Client::Request.new(handlers, context)
1906
1939
  end
1907
1940
 
@@ -61,6 +61,8 @@ module Aws::ConnectCases
61
61
  CreateTemplateRequest = Shapes::StructureShape.new(name: 'CreateTemplateRequest')
62
62
  CreateTemplateResponse = Shapes::StructureShape.new(name: 'CreateTemplateResponse')
63
63
  CreatedTime = Shapes::TimestampShape.new(name: 'CreatedTime', timestampFormat: "iso8601")
64
+ DeleteDomainRequest = Shapes::StructureShape.new(name: 'DeleteDomainRequest')
65
+ DeleteDomainResponse = Shapes::StructureShape.new(name: 'DeleteDomainResponse')
64
66
  DomainArn = Shapes::StringShape.new(name: 'DomainArn')
65
67
  DomainId = Shapes::StringShape.new(name: 'DomainId')
66
68
  DomainName = Shapes::StringShape.new(name: 'DomainName')
@@ -333,6 +335,11 @@ module Aws::ConnectCases
333
335
  CreateTemplateResponse.add_member(:template_id, Shapes::ShapeRef.new(shape: TemplateId, required: true, location_name: "templateId"))
334
336
  CreateTemplateResponse.struct_class = Types::CreateTemplateResponse
335
337
 
338
+ DeleteDomainRequest.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainId"))
339
+ DeleteDomainRequest.struct_class = Types::DeleteDomainRequest
340
+
341
+ DeleteDomainResponse.struct_class = Types::DeleteDomainResponse
342
+
336
343
  DomainSummary.add_member(:domain_arn, Shapes::ShapeRef.new(shape: DomainArn, required: true, location_name: "domainArn"))
337
344
  DomainSummary.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId"))
338
345
  DomainSummary.add_member(:name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "name"))
@@ -878,6 +885,20 @@ module Aws::ConnectCases
878
885
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
879
886
  end)
880
887
 
888
+ api.add_operation(:delete_domain, Seahorse::Model::Operation.new.tap do |o|
889
+ o.name = "DeleteDomain"
890
+ o.http_method = "DELETE"
891
+ o.http_request_uri = "/domains/{domainId}"
892
+ o.input = Shapes::ShapeRef.new(shape: DeleteDomainRequest)
893
+ o.output = Shapes::ShapeRef.new(shape: DeleteDomainResponse)
894
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
895
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
896
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
897
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
898
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
899
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
900
+ end)
901
+
881
902
  api.add_operation(:get_case, Seahorse::Model::Operation.new.tap do |o|
882
903
  o.name = "GetCase"
883
904
  o.http_method = "POST"
@@ -14,36 +14,39 @@ module Aws::ConnectCases
14
14
  use_dual_stack = parameters.use_dual_stack
15
15
  use_fips = parameters.use_fips
16
16
  endpoint = parameters.endpoint
17
- if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
18
- if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
19
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
20
- raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
21
- end
22
- if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
23
- raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
24
- end
25
- return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
26
- end
27
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
28
- 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"))
29
- return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
30
- end
31
- raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
32
- end
17
+ if Aws::Endpoints::Matchers.set?(endpoint)
33
18
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
34
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
- return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
36
- end
37
- raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
19
+ raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
38
20
  end
39
21
  if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
40
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
41
- return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
22
+ raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
23
+ end
24
+ return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
25
+ end
26
+ if Aws::Endpoints::Matchers.set?(region)
27
+ if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
28
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
29
+ 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"))
30
+ return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
31
+ end
32
+ raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
+ end
34
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
36
+ return Aws::Endpoints::Endpoint.new(url: "https://cases-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
+ end
38
+ raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
39
+ end
40
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
41
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
42
+ return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
43
+ end
44
+ raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
42
45
  end
43
- raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
46
+ return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
44
47
  end
45
- return Aws::Endpoints::Endpoint.new(url: "https://cases.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
46
48
  end
49
+ raise ArgumentError, "Invalid Configuration: Missing Region"
47
50
  raise ArgumentError, 'No endpoint could be resolved'
48
51
 
49
52
  end
@@ -123,6 +123,20 @@ module Aws::ConnectCases
123
123
  end
124
124
  end
125
125
 
126
+ class DeleteDomain
127
+ def self.build(context)
128
+ unless context.config.regional_endpoint
129
+ endpoint = context.config.endpoint.to_s
130
+ end
131
+ Aws::ConnectCases::EndpointParameters.new(
132
+ region: context.config.region,
133
+ use_dual_stack: context.config.use_dualstack_endpoint,
134
+ use_fips: context.config.use_fips_endpoint,
135
+ endpoint: endpoint,
136
+ )
137
+ end
138
+ end
139
+
126
140
  class GetCase
127
141
  def self.build(context)
128
142
  unless context.config.regional_endpoint
@@ -72,6 +72,8 @@ module Aws::ConnectCases
72
72
  Aws::ConnectCases::Endpoints::CreateRelatedItem.build(context)
73
73
  when :create_template
74
74
  Aws::ConnectCases::Endpoints::CreateTemplate.build(context)
75
+ when :delete_domain
76
+ Aws::ConnectCases::Endpoints::DeleteDomain.build(context)
75
77
  when :get_case
76
78
  Aws::ConnectCases::Endpoints::GetCase.build(context)
77
79
  when :get_case_event_configuration
@@ -553,6 +553,22 @@ module Aws::ConnectCases
553
553
  include Aws::Structure
554
554
  end
555
555
 
556
+ # @!attribute [rw] domain_id
557
+ # The unique identifier of the Cases domain.
558
+ # @return [String]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomainRequest AWS API Documentation
561
+ #
562
+ class DeleteDomainRequest < Struct.new(
563
+ :domain_id)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DeleteDomainResponse AWS API Documentation
569
+ #
570
+ class DeleteDomainResponse < Aws::EmptyStructure; end
571
+
556
572
  # Object for the summarized details of the domain.
557
573
  #
558
574
  # @!attribute [rw] domain_arn
@@ -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.3.0'
55
+ GEM_VERSION = '1.5.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.3.0
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-18 00:00:00.000000000 Z
11
+ date: 2023-05-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core