aws-sdk-connect 1.188.0 → 1.189.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +110 -1
- data/lib/aws-sdk-connect/client_api.rb +59 -0
- data/lib/aws-sdk-connect/types.rb +120 -0
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +30 -0
- data/sig/types.rbs +32 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8b41c265f8efcc3cb255c2834b55bf9a9f43a07ad46be651a352de96bf845ca5
|
4
|
+
data.tar.gz: 19cd31d76a986bd4d90d832b64f4e95232e784c5ff92a26f024ff4f5d01cef60
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e1a41619c4caeab1dbb7cf2068f7bf4cc4630d1c9326977c4aa57e080e067c16cc0bc9287f9a03a9d51bfb2eb743aa85566f70ef9b31d6e2a9f523a6bbffbad1
|
7
|
+
data.tar.gz: d7a45de2d07a65517611540a1298f1afe9551010fc5c735dd7abb9b7eb1ebf83b661265ede9bfd88531a7cde6ead7691c3c47f293271cfd5747287e00157c65a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.189.0 (2024-12-10)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add support for Push Notifications for Amazon Connect chat. With Push Notifications enabled an alert could be sent to customers about new messages even when they aren't actively using the mobile application.
|
8
|
+
|
4
9
|
1.188.0 (2024-12-02)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.189.0
|
@@ -2746,6 +2746,80 @@ module Aws::Connect
|
|
2746
2746
|
req.send_request(options)
|
2747
2747
|
end
|
2748
2748
|
|
2749
|
+
# Creates registration for a device token and a chat contact to receive
|
2750
|
+
# real-time push notifications. For more information about push
|
2751
|
+
# notifications, see [Set up push notifications in Amazon Connect for
|
2752
|
+
# mobile chat][1] in the *Amazon Connect Administrator Guide*.
|
2753
|
+
#
|
2754
|
+
#
|
2755
|
+
#
|
2756
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-up-push-notifications-for-mobile-chat.html
|
2757
|
+
#
|
2758
|
+
# @option params [required, String] :instance_id
|
2759
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2760
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2761
|
+
#
|
2762
|
+
#
|
2763
|
+
#
|
2764
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2765
|
+
#
|
2766
|
+
# @option params [String] :client_token
|
2767
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2768
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2769
|
+
# SDK populates this field. For more information about idempotency, see
|
2770
|
+
# [Making retries safe with idempotent APIs][1].
|
2771
|
+
#
|
2772
|
+
# **A suitable default value is auto-generated.** You should normally
|
2773
|
+
# not need to pass this option.**
|
2774
|
+
#
|
2775
|
+
#
|
2776
|
+
#
|
2777
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2778
|
+
#
|
2779
|
+
# @option params [required, String] :pinpoint_app_arn
|
2780
|
+
# The Amazon Resource Name (ARN) of the Pinpoint application.
|
2781
|
+
#
|
2782
|
+
# @option params [required, String] :device_token
|
2783
|
+
# The push notification token issued by the Apple or Google gateways.
|
2784
|
+
#
|
2785
|
+
# @option params [required, String] :device_type
|
2786
|
+
# The device type to use when sending the message.
|
2787
|
+
#
|
2788
|
+
# @option params [required, Types::ContactConfiguration] :contact_configuration
|
2789
|
+
# The contact configuration for push notification registration.
|
2790
|
+
#
|
2791
|
+
# @return [Types::CreatePushNotificationRegistrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2792
|
+
#
|
2793
|
+
# * {Types::CreatePushNotificationRegistrationResponse#registration_id #registration_id} => String
|
2794
|
+
#
|
2795
|
+
# @example Request syntax with placeholder values
|
2796
|
+
#
|
2797
|
+
# resp = client.create_push_notification_registration({
|
2798
|
+
# instance_id: "InstanceId", # required
|
2799
|
+
# client_token: "ClientToken",
|
2800
|
+
# pinpoint_app_arn: "ARN", # required
|
2801
|
+
# device_token: "DeviceToken", # required
|
2802
|
+
# device_type: "GCM", # required, accepts GCM, APNS, APNS_SANDBOX
|
2803
|
+
# contact_configuration: { # required
|
2804
|
+
# contact_id: "ContactId", # required
|
2805
|
+
# participant_role: "AGENT", # accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT, SUPERVISOR
|
2806
|
+
# include_raw_message: false,
|
2807
|
+
# },
|
2808
|
+
# })
|
2809
|
+
#
|
2810
|
+
# @example Response structure
|
2811
|
+
#
|
2812
|
+
# resp.registration_id #=> String
|
2813
|
+
#
|
2814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePushNotificationRegistration AWS API Documentation
|
2815
|
+
#
|
2816
|
+
# @overload create_push_notification_registration(params = {})
|
2817
|
+
# @param [Hash] params ({})
|
2818
|
+
def create_push_notification_registration(params = {}, options = {})
|
2819
|
+
req = build_request(:create_push_notification_registration, params)
|
2820
|
+
req.send_request(options)
|
2821
|
+
end
|
2822
|
+
|
2749
2823
|
# This API is in preview release for Amazon Connect and is subject to
|
2750
2824
|
# change.
|
2751
2825
|
#
|
@@ -4377,6 +4451,41 @@ module Aws::Connect
|
|
4377
4451
|
req.send_request(options)
|
4378
4452
|
end
|
4379
4453
|
|
4454
|
+
# Deletes registration for a device token and a chat contact.
|
4455
|
+
#
|
4456
|
+
# @option params [required, String] :instance_id
|
4457
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
4458
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
4459
|
+
#
|
4460
|
+
#
|
4461
|
+
#
|
4462
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
4463
|
+
#
|
4464
|
+
# @option params [required, String] :registration_id
|
4465
|
+
# The identifier for the registration.
|
4466
|
+
#
|
4467
|
+
# @option params [required, String] :contact_id
|
4468
|
+
# The identifier of the contact within the Amazon Connect instance.
|
4469
|
+
#
|
4470
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4471
|
+
#
|
4472
|
+
# @example Request syntax with placeholder values
|
4473
|
+
#
|
4474
|
+
# resp = client.delete_push_notification_registration({
|
4475
|
+
# instance_id: "InstanceId", # required
|
4476
|
+
# registration_id: "RegistrationId", # required
|
4477
|
+
# contact_id: "ContactId", # required
|
4478
|
+
# })
|
4479
|
+
#
|
4480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeletePushNotificationRegistration AWS API Documentation
|
4481
|
+
#
|
4482
|
+
# @overload delete_push_notification_registration(params = {})
|
4483
|
+
# @param [Hash] params ({})
|
4484
|
+
def delete_push_notification_registration(params = {}, options = {})
|
4485
|
+
req = build_request(:delete_push_notification_registration, params)
|
4486
|
+
req.send_request(options)
|
4487
|
+
end
|
4488
|
+
|
4380
4489
|
# Deletes a queue. It isn't possible to delete a queue by using the
|
4381
4490
|
# Amazon Connect admin website.
|
4382
4491
|
#
|
@@ -19960,7 +20069,7 @@ module Aws::Connect
|
|
19960
20069
|
tracer: tracer
|
19961
20070
|
)
|
19962
20071
|
context[:gem_name] = 'aws-sdk-connect'
|
19963
|
-
context[:gem_version] = '1.
|
20072
|
+
context[:gem_version] = '1.189.0'
|
19964
20073
|
Seahorse::Client::Request.new(handlers, context)
|
19965
20074
|
end
|
19966
20075
|
|
@@ -178,6 +178,7 @@ module Aws::Connect
|
|
178
178
|
ConnectionData = Shapes::StructureShape.new(name: 'ConnectionData')
|
179
179
|
Contact = Shapes::StructureShape.new(name: 'Contact')
|
180
180
|
ContactAnalysis = Shapes::StructureShape.new(name: 'ContactAnalysis')
|
181
|
+
ContactConfiguration = Shapes::StructureShape.new(name: 'ContactConfiguration')
|
181
182
|
ContactDataRequest = Shapes::StructureShape.new(name: 'ContactDataRequest')
|
182
183
|
ContactDataRequestList = Shapes::ListShape.new(name: 'ContactDataRequestList')
|
183
184
|
ContactFilter = Shapes::StructureShape.new(name: 'ContactFilter')
|
@@ -262,6 +263,8 @@ module Aws::Connect
|
|
262
263
|
CreatePredefinedAttributeRequest = Shapes::StructureShape.new(name: 'CreatePredefinedAttributeRequest')
|
263
264
|
CreatePromptRequest = Shapes::StructureShape.new(name: 'CreatePromptRequest')
|
264
265
|
CreatePromptResponse = Shapes::StructureShape.new(name: 'CreatePromptResponse')
|
266
|
+
CreatePushNotificationRegistrationRequest = Shapes::StructureShape.new(name: 'CreatePushNotificationRegistrationRequest')
|
267
|
+
CreatePushNotificationRegistrationResponse = Shapes::StructureShape.new(name: 'CreatePushNotificationRegistrationResponse')
|
265
268
|
CreateQueueRequest = Shapes::StructureShape.new(name: 'CreateQueueRequest')
|
266
269
|
CreateQueueResponse = Shapes::StructureShape.new(name: 'CreateQueueResponse')
|
267
270
|
CreateQuickConnectRequest = Shapes::StructureShape.new(name: 'CreateQuickConnectRequest')
|
@@ -328,6 +331,8 @@ module Aws::Connect
|
|
328
331
|
DeleteIntegrationAssociationRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationAssociationRequest')
|
329
332
|
DeletePredefinedAttributeRequest = Shapes::StructureShape.new(name: 'DeletePredefinedAttributeRequest')
|
330
333
|
DeletePromptRequest = Shapes::StructureShape.new(name: 'DeletePromptRequest')
|
334
|
+
DeletePushNotificationRegistrationRequest = Shapes::StructureShape.new(name: 'DeletePushNotificationRegistrationRequest')
|
335
|
+
DeletePushNotificationRegistrationResponse = Shapes::StructureShape.new(name: 'DeletePushNotificationRegistrationResponse')
|
331
336
|
DeleteQueueRequest = Shapes::StructureShape.new(name: 'DeleteQueueRequest')
|
332
337
|
DeleteQuickConnectRequest = Shapes::StructureShape.new(name: 'DeleteQuickConnectRequest')
|
333
338
|
DeleteRoutingProfileRequest = Shapes::StructureShape.new(name: 'DeleteRoutingProfileRequest')
|
@@ -403,6 +408,8 @@ module Aws::Connect
|
|
403
408
|
DestinationId = Shapes::StringShape.new(name: 'DestinationId')
|
404
409
|
DestinationNotAllowedException = Shapes::StructureShape.new(name: 'DestinationNotAllowedException')
|
405
410
|
DeviceInfo = Shapes::StructureShape.new(name: 'DeviceInfo')
|
411
|
+
DeviceToken = Shapes::StringShape.new(name: 'DeviceToken')
|
412
|
+
DeviceType = Shapes::StringShape.new(name: 'DeviceType')
|
406
413
|
Dimensions = Shapes::StructureShape.new(name: 'Dimensions')
|
407
414
|
DimensionsV2Key = Shapes::StringShape.new(name: 'DimensionsV2Key')
|
408
415
|
DimensionsV2Map = Shapes::MapShape.new(name: 'DimensionsV2Map')
|
@@ -639,6 +646,7 @@ module Aws::Connect
|
|
639
646
|
InboundMessageSourceType = Shapes::StringShape.new(name: 'InboundMessageSourceType')
|
640
647
|
InboundRawMessage = Shapes::StructureShape.new(name: 'InboundRawMessage')
|
641
648
|
InboundSubject = Shapes::StringShape.new(name: 'InboundSubject')
|
649
|
+
IncludeRawMessage = Shapes::BooleanShape.new(name: 'IncludeRawMessage')
|
642
650
|
Index = Shapes::IntegerShape.new(name: 'Index')
|
643
651
|
InitiateAs = Shapes::StringShape.new(name: 'InitiateAs')
|
644
652
|
InitiationMethodList = Shapes::ListShape.new(name: 'InitiationMethodList')
|
@@ -1027,6 +1035,7 @@ module Aws::Connect
|
|
1027
1035
|
ReferenceValue = Shapes::StringShape.new(name: 'ReferenceValue')
|
1028
1036
|
RefreshTokenDuration = Shapes::IntegerShape.new(name: 'RefreshTokenDuration')
|
1029
1037
|
RegionName = Shapes::StringShape.new(name: 'RegionName')
|
1038
|
+
RegistrationId = Shapes::StringShape.new(name: 'RegistrationId')
|
1030
1039
|
RehydrationType = Shapes::StringShape.new(name: 'RehydrationType')
|
1031
1040
|
ReleasePhoneNumberRequest = Shapes::StructureShape.new(name: 'ReleasePhoneNumberRequest')
|
1032
1041
|
ReplicateInstanceRequest = Shapes::StructureShape.new(name: 'ReplicateInstanceRequest')
|
@@ -1963,6 +1972,11 @@ module Aws::Connect
|
|
1963
1972
|
ContactAnalysis.add_member(:transcript, Shapes::ShapeRef.new(shape: Transcript, location_name: "Transcript"))
|
1964
1973
|
ContactAnalysis.struct_class = Types::ContactAnalysis
|
1965
1974
|
|
1975
|
+
ContactConfiguration.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
|
1976
|
+
ContactConfiguration.add_member(:participant_role, Shapes::ShapeRef.new(shape: ParticipantRole, location_name: "ParticipantRole"))
|
1977
|
+
ContactConfiguration.add_member(:include_raw_message, Shapes::ShapeRef.new(shape: IncludeRawMessage, location_name: "IncludeRawMessage"))
|
1978
|
+
ContactConfiguration.struct_class = Types::ContactConfiguration
|
1979
|
+
|
1966
1980
|
ContactDataRequest.add_member(:system_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "SystemEndpoint"))
|
1967
1981
|
ContactDataRequest.add_member(:customer_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "CustomerEndpoint"))
|
1968
1982
|
ContactDataRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
|
@@ -2289,6 +2303,17 @@ module Aws::Connect
|
|
2289
2303
|
CreatePromptResponse.add_member(:prompt_id, Shapes::ShapeRef.new(shape: PromptId, location_name: "PromptId"))
|
2290
2304
|
CreatePromptResponse.struct_class = Types::CreatePromptResponse
|
2291
2305
|
|
2306
|
+
CreatePushNotificationRegistrationRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
2307
|
+
CreatePushNotificationRegistrationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
2308
|
+
CreatePushNotificationRegistrationRequest.add_member(:pinpoint_app_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "PinpointAppArn"))
|
2309
|
+
CreatePushNotificationRegistrationRequest.add_member(:device_token, Shapes::ShapeRef.new(shape: DeviceToken, required: true, location_name: "DeviceToken"))
|
2310
|
+
CreatePushNotificationRegistrationRequest.add_member(:device_type, Shapes::ShapeRef.new(shape: DeviceType, required: true, location_name: "DeviceType"))
|
2311
|
+
CreatePushNotificationRegistrationRequest.add_member(:contact_configuration, Shapes::ShapeRef.new(shape: ContactConfiguration, required: true, location_name: "ContactConfiguration"))
|
2312
|
+
CreatePushNotificationRegistrationRequest.struct_class = Types::CreatePushNotificationRegistrationRequest
|
2313
|
+
|
2314
|
+
CreatePushNotificationRegistrationResponse.add_member(:registration_id, Shapes::ShapeRef.new(shape: RegistrationId, required: true, location_name: "RegistrationId"))
|
2315
|
+
CreatePushNotificationRegistrationResponse.struct_class = Types::CreatePushNotificationRegistrationResponse
|
2316
|
+
|
2292
2317
|
CreateQueueRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
2293
2318
|
CreateQueueRequest.add_member(:name, Shapes::ShapeRef.new(shape: CommonNameLength127, required: true, location_name: "Name"))
|
2294
2319
|
CreateQueueRequest.add_member(:description, Shapes::ShapeRef.new(shape: QueueDescription, location_name: "Description"))
|
@@ -2584,6 +2609,13 @@ module Aws::Connect
|
|
2584
2609
|
DeletePromptRequest.add_member(:prompt_id, Shapes::ShapeRef.new(shape: PromptId, required: true, location: "uri", location_name: "PromptId"))
|
2585
2610
|
DeletePromptRequest.struct_class = Types::DeletePromptRequest
|
2586
2611
|
|
2612
|
+
DeletePushNotificationRegistrationRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
2613
|
+
DeletePushNotificationRegistrationRequest.add_member(:registration_id, Shapes::ShapeRef.new(shape: RegistrationId, required: true, location: "uri", location_name: "RegistrationId"))
|
2614
|
+
DeletePushNotificationRegistrationRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location: "querystring", location_name: "contactId"))
|
2615
|
+
DeletePushNotificationRegistrationRequest.struct_class = Types::DeletePushNotificationRegistrationRequest
|
2616
|
+
|
2617
|
+
DeletePushNotificationRegistrationResponse.struct_class = Types::DeletePushNotificationRegistrationResponse
|
2618
|
+
|
2587
2619
|
DeleteQueueRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
2588
2620
|
DeleteQueueRequest.add_member(:queue_id, Shapes::ShapeRef.new(shape: QueueId, required: true, location: "uri", location_name: "QueueId"))
|
2589
2621
|
DeleteQueueRequest.struct_class = Types::DeleteQueueRequest
|
@@ -6833,6 +6865,20 @@ module Aws::Connect
|
|
6833
6865
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
6834
6866
|
end)
|
6835
6867
|
|
6868
|
+
api.add_operation(:create_push_notification_registration, Seahorse::Model::Operation.new.tap do |o|
|
6869
|
+
o.name = "CreatePushNotificationRegistration"
|
6870
|
+
o.http_method = "PUT"
|
6871
|
+
o.http_request_uri = "/push-notification/{InstanceId}/registrations"
|
6872
|
+
o.input = Shapes::ShapeRef.new(shape: CreatePushNotificationRegistrationRequest)
|
6873
|
+
o.output = Shapes::ShapeRef.new(shape: CreatePushNotificationRegistrationResponse)
|
6874
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
6875
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
6876
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
6877
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
6878
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
6879
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
6880
|
+
end)
|
6881
|
+
|
6836
6882
|
api.add_operation(:create_queue, Seahorse::Model::Operation.new.tap do |o|
|
6837
6883
|
o.name = "CreateQueue"
|
6838
6884
|
o.http_method = "PUT"
|
@@ -7187,6 +7233,19 @@ module Aws::Connect
|
|
7187
7233
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
7188
7234
|
end)
|
7189
7235
|
|
7236
|
+
api.add_operation(:delete_push_notification_registration, Seahorse::Model::Operation.new.tap do |o|
|
7237
|
+
o.name = "DeletePushNotificationRegistration"
|
7238
|
+
o.http_method = "DELETE"
|
7239
|
+
o.http_request_uri = "/push-notification/{InstanceId}/registrations/{RegistrationId}"
|
7240
|
+
o.input = Shapes::ShapeRef.new(shape: DeletePushNotificationRegistrationRequest)
|
7241
|
+
o.output = Shapes::ShapeRef.new(shape: DeletePushNotificationRegistrationResponse)
|
7242
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
7243
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
7244
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
7245
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
7246
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
7247
|
+
end)
|
7248
|
+
|
7190
7249
|
api.add_operation(:delete_queue, Seahorse::Model::Operation.new.tap do |o|
|
7191
7250
|
o.name = "DeleteQueue"
|
7192
7251
|
o.http_method = "DELETE"
|
@@ -2524,6 +2524,31 @@ module Aws::Connect
|
|
2524
2524
|
include Aws::Structure
|
2525
2525
|
end
|
2526
2526
|
|
2527
|
+
# The contact configuration for push notification registration.
|
2528
|
+
#
|
2529
|
+
# @!attribute [rw] contact_id
|
2530
|
+
# The identifier of the contact within the Amazon Connect instance.
|
2531
|
+
# @return [String]
|
2532
|
+
#
|
2533
|
+
# @!attribute [rw] participant_role
|
2534
|
+
# The role of the participant in the chat conversation.
|
2535
|
+
# @return [String]
|
2536
|
+
#
|
2537
|
+
# @!attribute [rw] include_raw_message
|
2538
|
+
# Whether to include raw connect message in the push notification
|
2539
|
+
# payload. Default is `False`.
|
2540
|
+
# @return [Boolean]
|
2541
|
+
#
|
2542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactConfiguration AWS API Documentation
|
2543
|
+
#
|
2544
|
+
class ContactConfiguration < Struct.new(
|
2545
|
+
:contact_id,
|
2546
|
+
:participant_role,
|
2547
|
+
:include_raw_message)
|
2548
|
+
SENSITIVE = []
|
2549
|
+
include Aws::Structure
|
2550
|
+
end
|
2551
|
+
|
2527
2552
|
# Request object with information to create a contact.
|
2528
2553
|
#
|
2529
2554
|
# @!attribute [rw] system_endpoint
|
@@ -4262,6 +4287,70 @@ module Aws::Connect
|
|
4262
4287
|
include Aws::Structure
|
4263
4288
|
end
|
4264
4289
|
|
4290
|
+
# @!attribute [rw] instance_id
|
4291
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
4292
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
4293
|
+
#
|
4294
|
+
#
|
4295
|
+
#
|
4296
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
4297
|
+
# @return [String]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] client_token
|
4300
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
4301
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
4302
|
+
# SDK populates this field. For more information about idempotency,
|
4303
|
+
# see [Making retries safe with idempotent APIs][1].
|
4304
|
+
#
|
4305
|
+
# **A suitable default value is auto-generated.** You should normally
|
4306
|
+
# not need to pass this option.
|
4307
|
+
#
|
4308
|
+
#
|
4309
|
+
#
|
4310
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
4311
|
+
# @return [String]
|
4312
|
+
#
|
4313
|
+
# @!attribute [rw] pinpoint_app_arn
|
4314
|
+
# The Amazon Resource Name (ARN) of the Pinpoint application.
|
4315
|
+
# @return [String]
|
4316
|
+
#
|
4317
|
+
# @!attribute [rw] device_token
|
4318
|
+
# The push notification token issued by the Apple or Google gateways.
|
4319
|
+
# @return [String]
|
4320
|
+
#
|
4321
|
+
# @!attribute [rw] device_type
|
4322
|
+
# The device type to use when sending the message.
|
4323
|
+
# @return [String]
|
4324
|
+
#
|
4325
|
+
# @!attribute [rw] contact_configuration
|
4326
|
+
# The contact configuration for push notification registration.
|
4327
|
+
# @return [Types::ContactConfiguration]
|
4328
|
+
#
|
4329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePushNotificationRegistrationRequest AWS API Documentation
|
4330
|
+
#
|
4331
|
+
class CreatePushNotificationRegistrationRequest < Struct.new(
|
4332
|
+
:instance_id,
|
4333
|
+
:client_token,
|
4334
|
+
:pinpoint_app_arn,
|
4335
|
+
:device_token,
|
4336
|
+
:device_type,
|
4337
|
+
:contact_configuration)
|
4338
|
+
SENSITIVE = []
|
4339
|
+
include Aws::Structure
|
4340
|
+
end
|
4341
|
+
|
4342
|
+
# @!attribute [rw] registration_id
|
4343
|
+
# The identifier for the registration.
|
4344
|
+
# @return [String]
|
4345
|
+
#
|
4346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePushNotificationRegistrationResponse AWS API Documentation
|
4347
|
+
#
|
4348
|
+
class CreatePushNotificationRegistrationResponse < Struct.new(
|
4349
|
+
:registration_id)
|
4350
|
+
SENSITIVE = []
|
4351
|
+
include Aws::Structure
|
4352
|
+
end
|
4353
|
+
|
4265
4354
|
# @!attribute [rw] instance_id
|
4266
4355
|
# The identifier of the Amazon Connect instance. You can [find the
|
4267
4356
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -5826,6 +5915,37 @@ module Aws::Connect
|
|
5826
5915
|
include Aws::Structure
|
5827
5916
|
end
|
5828
5917
|
|
5918
|
+
# @!attribute [rw] instance_id
|
5919
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5920
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5921
|
+
#
|
5922
|
+
#
|
5923
|
+
#
|
5924
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5925
|
+
# @return [String]
|
5926
|
+
#
|
5927
|
+
# @!attribute [rw] registration_id
|
5928
|
+
# The identifier for the registration.
|
5929
|
+
# @return [String]
|
5930
|
+
#
|
5931
|
+
# @!attribute [rw] contact_id
|
5932
|
+
# The identifier of the contact within the Amazon Connect instance.
|
5933
|
+
# @return [String]
|
5934
|
+
#
|
5935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeletePushNotificationRegistrationRequest AWS API Documentation
|
5936
|
+
#
|
5937
|
+
class DeletePushNotificationRegistrationRequest < Struct.new(
|
5938
|
+
:instance_id,
|
5939
|
+
:registration_id,
|
5940
|
+
:contact_id)
|
5941
|
+
SENSITIVE = []
|
5942
|
+
include Aws::Structure
|
5943
|
+
end
|
5944
|
+
|
5945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeletePushNotificationRegistrationResponse AWS API Documentation
|
5946
|
+
#
|
5947
|
+
class DeletePushNotificationRegistrationResponse < Aws::EmptyStructure; end
|
5948
|
+
|
5829
5949
|
# @!attribute [rw] instance_id
|
5830
5950
|
# The identifier of the Amazon Connect instance. You can [find the
|
5831
5951
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -692,6 +692,25 @@ module Aws
|
|
692
692
|
) -> _CreatePromptResponseSuccess
|
693
693
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePromptResponseSuccess
|
694
694
|
|
695
|
+
interface _CreatePushNotificationRegistrationResponseSuccess
|
696
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreatePushNotificationRegistrationResponse]
|
697
|
+
def registration_id: () -> ::String
|
698
|
+
end
|
699
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#create_push_notification_registration-instance_method
|
700
|
+
def create_push_notification_registration: (
|
701
|
+
instance_id: ::String,
|
702
|
+
?client_token: ::String,
|
703
|
+
pinpoint_app_arn: ::String,
|
704
|
+
device_token: ::String,
|
705
|
+
device_type: ("GCM" | "APNS" | "APNS_SANDBOX"),
|
706
|
+
contact_configuration: {
|
707
|
+
contact_id: ::String,
|
708
|
+
participant_role: ("AGENT" | "CUSTOMER" | "SYSTEM" | "CUSTOM_BOT" | "SUPERVISOR")?,
|
709
|
+
include_raw_message: bool?
|
710
|
+
}
|
711
|
+
) -> _CreatePushNotificationRegistrationResponseSuccess
|
712
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePushNotificationRegistrationResponseSuccess
|
713
|
+
|
695
714
|
interface _CreateQueueResponseSuccess
|
696
715
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateQueueResponse]
|
697
716
|
def queue_arn: () -> ::String
|
@@ -1177,6 +1196,17 @@ module Aws
|
|
1177
1196
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
1178
1197
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
1179
1198
|
|
1199
|
+
interface _DeletePushNotificationRegistrationResponseSuccess
|
1200
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeletePushNotificationRegistrationResponse]
|
1201
|
+
end
|
1202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#delete_push_notification_registration-instance_method
|
1203
|
+
def delete_push_notification_registration: (
|
1204
|
+
instance_id: ::String,
|
1205
|
+
registration_id: ::String,
|
1206
|
+
contact_id: ::String
|
1207
|
+
) -> _DeletePushNotificationRegistrationResponseSuccess
|
1208
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeletePushNotificationRegistrationResponseSuccess
|
1209
|
+
|
1180
1210
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#delete_queue-instance_method
|
1181
1211
|
def delete_queue: (
|
1182
1212
|
instance_id: ::String,
|
data/sig/types.rbs
CHANGED
@@ -600,6 +600,13 @@ module Aws::Connect
|
|
600
600
|
SENSITIVE: []
|
601
601
|
end
|
602
602
|
|
603
|
+
class ContactConfiguration
|
604
|
+
attr_accessor contact_id: ::String
|
605
|
+
attr_accessor participant_role: ("AGENT" | "CUSTOMER" | "SYSTEM" | "CUSTOM_BOT" | "SUPERVISOR")
|
606
|
+
attr_accessor include_raw_message: bool
|
607
|
+
SENSITIVE: []
|
608
|
+
end
|
609
|
+
|
603
610
|
class ContactDataRequest
|
604
611
|
attr_accessor system_endpoint: Types::Endpoint
|
605
612
|
attr_accessor customer_endpoint: Types::Endpoint
|
@@ -989,6 +996,21 @@ module Aws::Connect
|
|
989
996
|
SENSITIVE: []
|
990
997
|
end
|
991
998
|
|
999
|
+
class CreatePushNotificationRegistrationRequest
|
1000
|
+
attr_accessor instance_id: ::String
|
1001
|
+
attr_accessor client_token: ::String
|
1002
|
+
attr_accessor pinpoint_app_arn: ::String
|
1003
|
+
attr_accessor device_token: ::String
|
1004
|
+
attr_accessor device_type: ("GCM" | "APNS" | "APNS_SANDBOX")
|
1005
|
+
attr_accessor contact_configuration: Types::ContactConfiguration
|
1006
|
+
SENSITIVE: []
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
class CreatePushNotificationRegistrationResponse
|
1010
|
+
attr_accessor registration_id: ::String
|
1011
|
+
SENSITIVE: []
|
1012
|
+
end
|
1013
|
+
|
992
1014
|
class CreateQueueRequest
|
993
1015
|
attr_accessor instance_id: ::String
|
994
1016
|
attr_accessor name: ::String
|
@@ -1382,6 +1404,16 @@ module Aws::Connect
|
|
1382
1404
|
SENSITIVE: []
|
1383
1405
|
end
|
1384
1406
|
|
1407
|
+
class DeletePushNotificationRegistrationRequest
|
1408
|
+
attr_accessor instance_id: ::String
|
1409
|
+
attr_accessor registration_id: ::String
|
1410
|
+
attr_accessor contact_id: ::String
|
1411
|
+
SENSITIVE: []
|
1412
|
+
end
|
1413
|
+
|
1414
|
+
class DeletePushNotificationRegistrationResponse < Aws::EmptyStructure
|
1415
|
+
end
|
1416
|
+
|
1385
1417
|
class DeleteQueueRequest
|
1386
1418
|
attr_accessor instance_id: ::String
|
1387
1419
|
attr_accessor queue_id: ::String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.189.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: 2024-12-
|
11
|
+
date: 2024-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|