aws-sdk-pinpoint 1.57.0 → 1.61.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +99 -1
- data/lib/aws-sdk-pinpoint/client_api.rb +77 -0
- data/lib/aws-sdk-pinpoint/types.rb +298 -3
- data/lib/aws-sdk-pinpoint.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 554a7270be976f8cf524196593a0e34b6af030a99da5794c5a97a765912131e6
|
4
|
+
data.tar.gz: 149ca183170cdd9f9de34375bca3694f62c1d9ac5d6a6d14b75b77b175e077c6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 03f79660a87d1a01b0936e3ed44cbcb308c20cfcb9467a450561c5982be6d882d7a0a7c20325d6df79b95354f23304795ef14f99bf1b3cfe89a226a3db26119c
|
7
|
+
data.tar.gz: a0be23480ea10ef14e82e9a8289fc237152314f4655449b1647973164345dfce5fbe60794e32d8bd7b0ac38748f80ca3858ba1e6b4d64aa705d04510b298b753
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.61.0 (2021-11-26)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added a One-Time Password (OTP) management feature. You can use the Amazon Pinpoint API to generate OTP codes and send them to your users as SMS messages. Your apps can then call the API to verify the OTP codes that your users input
|
8
|
+
|
9
|
+
1.60.0 (2021-11-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.59.0 (2021-10-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.58.0 (2021-09-27)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Added support for journey with contact center activity
|
23
|
+
|
4
24
|
1.57.0 (2021-09-16)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.61.0
|
@@ -275,6 +275,15 @@ module Aws::Pinpoint
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -1700,6 +1709,9 @@ module Aws::Pinpoint
|
|
1700
1709
|
# wait_until: "__string",
|
1701
1710
|
# },
|
1702
1711
|
# },
|
1712
|
+
# contact_center: {
|
1713
|
+
# next_activity: "__string",
|
1714
|
+
# },
|
1703
1715
|
# },
|
1704
1716
|
# },
|
1705
1717
|
# creation_date: "__string",
|
@@ -1756,6 +1768,10 @@ module Aws::Pinpoint
|
|
1756
1768
|
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
1757
1769
|
# wait_for_quiet_time: false,
|
1758
1770
|
# refresh_on_segment_update: false,
|
1771
|
+
# journey_channel_settings: {
|
1772
|
+
# connect_campaign_arn: "__string",
|
1773
|
+
# connect_campaign_execution_role_arn: "__string",
|
1774
|
+
# },
|
1759
1775
|
# },
|
1760
1776
|
# })
|
1761
1777
|
#
|
@@ -1903,6 +1919,7 @@ module Aws::Pinpoint
|
|
1903
1919
|
# resp.journey_response.activities["__string"].wait.next_activity #=> String
|
1904
1920
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
|
1905
1921
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
|
1922
|
+
# resp.journey_response.activities["__string"].contact_center.next_activity #=> String
|
1906
1923
|
# resp.journey_response.application_id #=> String
|
1907
1924
|
# resp.journey_response.creation_date #=> String
|
1908
1925
|
# resp.journey_response.id #=> String
|
@@ -1937,6 +1954,8 @@ module Aws::Pinpoint
|
|
1937
1954
|
# resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
1938
1955
|
# resp.journey_response.tags #=> Hash
|
1939
1956
|
# resp.journey_response.tags["__string"] #=> String
|
1957
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_arn #=> String
|
1958
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
1940
1959
|
#
|
1941
1960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateJourney AWS API Documentation
|
1942
1961
|
#
|
@@ -3460,6 +3479,7 @@ module Aws::Pinpoint
|
|
3460
3479
|
# resp.journey_response.activities["__string"].wait.next_activity #=> String
|
3461
3480
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
|
3462
3481
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
|
3482
|
+
# resp.journey_response.activities["__string"].contact_center.next_activity #=> String
|
3463
3483
|
# resp.journey_response.application_id #=> String
|
3464
3484
|
# resp.journey_response.creation_date #=> String
|
3465
3485
|
# resp.journey_response.id #=> String
|
@@ -3494,6 +3514,8 @@ module Aws::Pinpoint
|
|
3494
3514
|
# resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
3495
3515
|
# resp.journey_response.tags #=> Hash
|
3496
3516
|
# resp.journey_response.tags["__string"] #=> String
|
3517
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_arn #=> String
|
3518
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
3497
3519
|
#
|
3498
3520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteJourney AWS API Documentation
|
3499
3521
|
#
|
@@ -6562,6 +6584,7 @@ module Aws::Pinpoint
|
|
6562
6584
|
# resp.journey_response.activities["__string"].wait.next_activity #=> String
|
6563
6585
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
|
6564
6586
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
|
6587
|
+
# resp.journey_response.activities["__string"].contact_center.next_activity #=> String
|
6565
6588
|
# resp.journey_response.application_id #=> String
|
6566
6589
|
# resp.journey_response.creation_date #=> String
|
6567
6590
|
# resp.journey_response.id #=> String
|
@@ -6596,6 +6619,8 @@ module Aws::Pinpoint
|
|
6596
6619
|
# resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
6597
6620
|
# resp.journey_response.tags #=> Hash
|
6598
6621
|
# resp.journey_response.tags["__string"] #=> String
|
6622
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_arn #=> String
|
6623
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
6599
6624
|
#
|
6600
6625
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney AWS API Documentation
|
6601
6626
|
#
|
@@ -7960,6 +7985,7 @@ module Aws::Pinpoint
|
|
7960
7985
|
# resp.journeys_response.item[0].activities["__string"].wait.next_activity #=> String
|
7961
7986
|
# resp.journeys_response.item[0].activities["__string"].wait.wait_time.wait_for #=> String
|
7962
7987
|
# resp.journeys_response.item[0].activities["__string"].wait.wait_time.wait_until #=> String
|
7988
|
+
# resp.journeys_response.item[0].activities["__string"].contact_center.next_activity #=> String
|
7963
7989
|
# resp.journeys_response.item[0].application_id #=> String
|
7964
7990
|
# resp.journeys_response.item[0].creation_date #=> String
|
7965
7991
|
# resp.journeys_response.item[0].id #=> String
|
@@ -7994,6 +8020,8 @@ module Aws::Pinpoint
|
|
7994
8020
|
# resp.journeys_response.item[0].state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
7995
8021
|
# resp.journeys_response.item[0].tags #=> Hash
|
7996
8022
|
# resp.journeys_response.item[0].tags["__string"] #=> String
|
8023
|
+
# resp.journeys_response.item[0].journey_channel_settings.connect_campaign_arn #=> String
|
8024
|
+
# resp.journeys_response.item[0].journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
7997
8025
|
# resp.journeys_response.next_token #=> String
|
7998
8026
|
#
|
7999
8027
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListJourneys AWS API Documentation
|
@@ -8612,6 +8640,63 @@ module Aws::Pinpoint
|
|
8612
8640
|
req.send_request(options)
|
8613
8641
|
end
|
8614
8642
|
|
8643
|
+
# Send an OTP message
|
8644
|
+
#
|
8645
|
+
# @option params [required, String] :application_id
|
8646
|
+
#
|
8647
|
+
# @option params [required, Types::SendOTPMessageRequestParameters] :send_otp_message_request_parameters
|
8648
|
+
# Send OTP message request parameters.
|
8649
|
+
#
|
8650
|
+
# @return [Types::SendOTPMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8651
|
+
#
|
8652
|
+
# * {Types::SendOTPMessageResponse#message_response #message_response} => Types::MessageResponse
|
8653
|
+
#
|
8654
|
+
# @example Request syntax with placeholder values
|
8655
|
+
#
|
8656
|
+
# resp = client.send_otp_message({
|
8657
|
+
# application_id: "__string", # required
|
8658
|
+
# send_otp_message_request_parameters: { # required
|
8659
|
+
# allowed_attempts: 1,
|
8660
|
+
# brand_name: "__string", # required
|
8661
|
+
# channel: "__string", # required
|
8662
|
+
# code_length: 1,
|
8663
|
+
# destination_identity: "__string", # required
|
8664
|
+
# entity_id: "__string",
|
8665
|
+
# language: "__string",
|
8666
|
+
# origination_identity: "__string", # required
|
8667
|
+
# reference_id: "__string", # required
|
8668
|
+
# template_id: "__string",
|
8669
|
+
# validity_period: 1,
|
8670
|
+
# },
|
8671
|
+
# })
|
8672
|
+
#
|
8673
|
+
# @example Response structure
|
8674
|
+
#
|
8675
|
+
# resp.message_response.application_id #=> String
|
8676
|
+
# resp.message_response.endpoint_result #=> Hash
|
8677
|
+
# resp.message_response.endpoint_result["__string"].address #=> String
|
8678
|
+
# resp.message_response.endpoint_result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8679
|
+
# resp.message_response.endpoint_result["__string"].message_id #=> String
|
8680
|
+
# resp.message_response.endpoint_result["__string"].status_code #=> Integer
|
8681
|
+
# resp.message_response.endpoint_result["__string"].status_message #=> String
|
8682
|
+
# resp.message_response.endpoint_result["__string"].updated_token #=> String
|
8683
|
+
# resp.message_response.request_id #=> String
|
8684
|
+
# resp.message_response.result #=> Hash
|
8685
|
+
# resp.message_response.result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8686
|
+
# resp.message_response.result["__string"].message_id #=> String
|
8687
|
+
# resp.message_response.result["__string"].status_code #=> Integer
|
8688
|
+
# resp.message_response.result["__string"].status_message #=> String
|
8689
|
+
# resp.message_response.result["__string"].updated_token #=> String
|
8690
|
+
#
|
8691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessage AWS API Documentation
|
8692
|
+
#
|
8693
|
+
# @overload send_otp_message(params = {})
|
8694
|
+
# @param [Hash] params ({})
|
8695
|
+
def send_otp_message(params = {}, options = {})
|
8696
|
+
req = build_request(:send_otp_message, params)
|
8697
|
+
req.send_request(options)
|
8698
|
+
end
|
8699
|
+
|
8615
8700
|
# Creates and sends a message to a list of users.
|
8616
8701
|
#
|
8617
8702
|
# @option params [required, String] :application_id
|
@@ -10763,6 +10848,9 @@ module Aws::Pinpoint
|
|
10763
10848
|
# wait_until: "__string",
|
10764
10849
|
# },
|
10765
10850
|
# },
|
10851
|
+
# contact_center: {
|
10852
|
+
# next_activity: "__string",
|
10853
|
+
# },
|
10766
10854
|
# },
|
10767
10855
|
# },
|
10768
10856
|
# creation_date: "__string",
|
@@ -10819,6 +10907,10 @@ module Aws::Pinpoint
|
|
10819
10907
|
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
10820
10908
|
# wait_for_quiet_time: false,
|
10821
10909
|
# refresh_on_segment_update: false,
|
10910
|
+
# journey_channel_settings: {
|
10911
|
+
# connect_campaign_arn: "__string",
|
10912
|
+
# connect_campaign_execution_role_arn: "__string",
|
10913
|
+
# },
|
10822
10914
|
# },
|
10823
10915
|
# })
|
10824
10916
|
#
|
@@ -10966,6 +11058,7 @@ module Aws::Pinpoint
|
|
10966
11058
|
# resp.journey_response.activities["__string"].wait.next_activity #=> String
|
10967
11059
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
|
10968
11060
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
|
11061
|
+
# resp.journey_response.activities["__string"].contact_center.next_activity #=> String
|
10969
11062
|
# resp.journey_response.application_id #=> String
|
10970
11063
|
# resp.journey_response.creation_date #=> String
|
10971
11064
|
# resp.journey_response.id #=> String
|
@@ -11000,6 +11093,8 @@ module Aws::Pinpoint
|
|
11000
11093
|
# resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
11001
11094
|
# resp.journey_response.tags #=> Hash
|
11002
11095
|
# resp.journey_response.tags["__string"] #=> String
|
11096
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_arn #=> String
|
11097
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
11003
11098
|
#
|
11004
11099
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourney AWS API Documentation
|
11005
11100
|
#
|
@@ -11177,6 +11272,7 @@ module Aws::Pinpoint
|
|
11177
11272
|
# resp.journey_response.activities["__string"].wait.next_activity #=> String
|
11178
11273
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
|
11179
11274
|
# resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
|
11275
|
+
# resp.journey_response.activities["__string"].contact_center.next_activity #=> String
|
11180
11276
|
# resp.journey_response.application_id #=> String
|
11181
11277
|
# resp.journey_response.creation_date #=> String
|
11182
11278
|
# resp.journey_response.id #=> String
|
@@ -11211,6 +11307,8 @@ module Aws::Pinpoint
|
|
11211
11307
|
# resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
|
11212
11308
|
# resp.journey_response.tags #=> Hash
|
11213
11309
|
# resp.journey_response.tags["__string"] #=> String
|
11310
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_arn #=> String
|
11311
|
+
# resp.journey_response.journey_channel_settings.connect_campaign_execution_role_arn #=> String
|
11214
11312
|
#
|
11215
11313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyState AWS API Documentation
|
11216
11314
|
#
|
@@ -11904,7 +12002,7 @@ module Aws::Pinpoint
|
|
11904
12002
|
params: params,
|
11905
12003
|
config: config)
|
11906
12004
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
11907
|
-
context[:gem_version] = '1.
|
12005
|
+
context[:gem_version] = '1.61.0'
|
11908
12006
|
Seahorse::Client::Request.new(handlers, context)
|
11909
12007
|
end
|
11910
12008
|
|
@@ -64,6 +64,7 @@ module Aws::Pinpoint
|
|
64
64
|
Condition = Shapes::StructureShape.new(name: 'Condition')
|
65
65
|
ConditionalSplitActivity = Shapes::StructureShape.new(name: 'ConditionalSplitActivity')
|
66
66
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
67
|
+
ContactCenterActivity = Shapes::StructureShape.new(name: 'ContactCenterActivity')
|
67
68
|
CreateAppRequest = Shapes::StructureShape.new(name: 'CreateAppRequest')
|
68
69
|
CreateAppResponse = Shapes::StructureShape.new(name: 'CreateAppResponse')
|
69
70
|
CreateApplicationRequest = Shapes::StructureShape.new(name: 'CreateApplicationRequest')
|
@@ -298,6 +299,7 @@ module Aws::Pinpoint
|
|
298
299
|
InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
|
299
300
|
ItemResponse = Shapes::StructureShape.new(name: 'ItemResponse')
|
300
301
|
JobStatus = Shapes::StringShape.new(name: 'JobStatus')
|
302
|
+
JourneyChannelSettings = Shapes::StructureShape.new(name: 'JourneyChannelSettings')
|
301
303
|
JourneyCustomMessage = Shapes::StructureShape.new(name: 'JourneyCustomMessage')
|
302
304
|
JourneyDateRangeKpiResponse = Shapes::StructureShape.new(name: 'JourneyDateRangeKpiResponse')
|
303
305
|
JourneyEmailMessage = Shapes::StructureShape.new(name: 'JourneyEmailMessage')
|
@@ -423,6 +425,9 @@ module Aws::Pinpoint
|
|
423
425
|
SegmentsResponse = Shapes::StructureShape.new(name: 'SegmentsResponse')
|
424
426
|
SendMessagesRequest = Shapes::StructureShape.new(name: 'SendMessagesRequest')
|
425
427
|
SendMessagesResponse = Shapes::StructureShape.new(name: 'SendMessagesResponse')
|
428
|
+
SendOTPMessageRequest = Shapes::StructureShape.new(name: 'SendOTPMessageRequest')
|
429
|
+
SendOTPMessageRequestParameters = Shapes::StructureShape.new(name: 'SendOTPMessageRequestParameters')
|
430
|
+
SendOTPMessageResponse = Shapes::StructureShape.new(name: 'SendOTPMessageResponse')
|
426
431
|
SendUsersMessageRequest = Shapes::StructureShape.new(name: 'SendUsersMessageRequest')
|
427
432
|
SendUsersMessageResponse = Shapes::StructureShape.new(name: 'SendUsersMessageResponse')
|
428
433
|
SendUsersMessagesRequest = Shapes::StructureShape.new(name: 'SendUsersMessagesRequest')
|
@@ -500,6 +505,10 @@ module Aws::Pinpoint
|
|
500
505
|
UpdateVoiceChannelResponse = Shapes::StructureShape.new(name: 'UpdateVoiceChannelResponse')
|
501
506
|
UpdateVoiceTemplateRequest = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateRequest')
|
502
507
|
UpdateVoiceTemplateResponse = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateResponse')
|
508
|
+
VerificationResponse = Shapes::StructureShape.new(name: 'VerificationResponse')
|
509
|
+
VerifyOTPMessageRequest = Shapes::StructureShape.new(name: 'VerifyOTPMessageRequest')
|
510
|
+
VerifyOTPMessageRequestParameters = Shapes::StructureShape.new(name: 'VerifyOTPMessageRequestParameters')
|
511
|
+
VerifyOTPMessageResponse = Shapes::StructureShape.new(name: 'VerifyOTPMessageResponse')
|
503
512
|
VoiceChannelRequest = Shapes::StructureShape.new(name: 'VoiceChannelRequest')
|
504
513
|
VoiceChannelResponse = Shapes::StructureShape.new(name: 'VoiceChannelResponse')
|
505
514
|
VoiceMessage = Shapes::StructureShape.new(name: 'VoiceMessage')
|
@@ -697,6 +706,7 @@ module Aws::Pinpoint
|
|
697
706
|
Activity.add_member(:random_split, Shapes::ShapeRef.new(shape: RandomSplitActivity, location_name: "RandomSplit"))
|
698
707
|
Activity.add_member(:sms, Shapes::ShapeRef.new(shape: SMSMessageActivity, location_name: "SMS"))
|
699
708
|
Activity.add_member(:wait, Shapes::ShapeRef.new(shape: WaitActivity, location_name: "Wait"))
|
709
|
+
Activity.add_member(:contact_center, Shapes::ShapeRef.new(shape: ContactCenterActivity, location_name: "ContactCenter"))
|
700
710
|
Activity.struct_class = Types::Activity
|
701
711
|
|
702
712
|
ActivityResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
@@ -918,6 +928,9 @@ module Aws::Pinpoint
|
|
918
928
|
ConflictException.add_member(:request_id, Shapes::ShapeRef.new(shape: __string, location_name: "RequestID"))
|
919
929
|
ConflictException.struct_class = Types::ConflictException
|
920
930
|
|
931
|
+
ContactCenterActivity.add_member(:next_activity, Shapes::ShapeRef.new(shape: __string, location_name: "NextActivity"))
|
932
|
+
ContactCenterActivity.struct_class = Types::ContactCenterActivity
|
933
|
+
|
921
934
|
CreateAppRequest.add_member(:create_application_request, Shapes::ShapeRef.new(shape: CreateApplicationRequest, required: true, location_name: "CreateApplicationRequest"))
|
922
935
|
CreateAppRequest.struct_class = Types::CreateAppRequest
|
923
936
|
CreateAppRequest[:payload] = :create_application_request
|
@@ -2149,6 +2162,10 @@ module Aws::Pinpoint
|
|
2149
2162
|
ItemResponse.add_member(:events_item_response, Shapes::ShapeRef.new(shape: MapOfEventItemResponse, location_name: "EventsItemResponse"))
|
2150
2163
|
ItemResponse.struct_class = Types::ItemResponse
|
2151
2164
|
|
2165
|
+
JourneyChannelSettings.add_member(:connect_campaign_arn, Shapes::ShapeRef.new(shape: __string, location_name: "ConnectCampaignArn"))
|
2166
|
+
JourneyChannelSettings.add_member(:connect_campaign_execution_role_arn, Shapes::ShapeRef.new(shape: __string, location_name: "ConnectCampaignExecutionRoleArn"))
|
2167
|
+
JourneyChannelSettings.struct_class = Types::JourneyChannelSettings
|
2168
|
+
|
2152
2169
|
JourneyCustomMessage.add_member(:data, Shapes::ShapeRef.new(shape: __string, location_name: "Data"))
|
2153
2170
|
JourneyCustomMessage.struct_class = Types::JourneyCustomMessage
|
2154
2171
|
|
@@ -2202,6 +2219,7 @@ module Aws::Pinpoint
|
|
2202
2219
|
JourneyResponse.add_member(:start_condition, Shapes::ShapeRef.new(shape: StartCondition, location_name: "StartCondition"))
|
2203
2220
|
JourneyResponse.add_member(:state, Shapes::ShapeRef.new(shape: State, location_name: "State"))
|
2204
2221
|
JourneyResponse.add_member(:tags, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "tags"))
|
2222
|
+
JourneyResponse.add_member(:journey_channel_settings, Shapes::ShapeRef.new(shape: JourneyChannelSettings, location_name: "JourneyChannelSettings"))
|
2205
2223
|
JourneyResponse.struct_class = Types::JourneyResponse
|
2206
2224
|
|
2207
2225
|
JourneySMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
@@ -2745,6 +2763,30 @@ module Aws::Pinpoint
|
|
2745
2763
|
SendMessagesResponse[:payload] = :message_response
|
2746
2764
|
SendMessagesResponse[:payload_member] = SendMessagesResponse.member(:message_response)
|
2747
2765
|
|
2766
|
+
SendOTPMessageRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
2767
|
+
SendOTPMessageRequest.add_member(:send_otp_message_request_parameters, Shapes::ShapeRef.new(shape: SendOTPMessageRequestParameters, required: true, location_name: "SendOTPMessageRequestParameters"))
|
2768
|
+
SendOTPMessageRequest.struct_class = Types::SendOTPMessageRequest
|
2769
|
+
SendOTPMessageRequest[:payload] = :send_otp_message_request_parameters
|
2770
|
+
SendOTPMessageRequest[:payload_member] = SendOTPMessageRequest.member(:send_otp_message_request_parameters)
|
2771
|
+
|
2772
|
+
SendOTPMessageRequestParameters.add_member(:allowed_attempts, Shapes::ShapeRef.new(shape: __integer, location_name: "AllowedAttempts"))
|
2773
|
+
SendOTPMessageRequestParameters.add_member(:brand_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "BrandName"))
|
2774
|
+
SendOTPMessageRequestParameters.add_member(:channel, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Channel"))
|
2775
|
+
SendOTPMessageRequestParameters.add_member(:code_length, Shapes::ShapeRef.new(shape: __integer, location_name: "CodeLength"))
|
2776
|
+
SendOTPMessageRequestParameters.add_member(:destination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DestinationIdentity"))
|
2777
|
+
SendOTPMessageRequestParameters.add_member(:entity_id, Shapes::ShapeRef.new(shape: __string, location_name: "EntityId"))
|
2778
|
+
SendOTPMessageRequestParameters.add_member(:language, Shapes::ShapeRef.new(shape: __string, location_name: "Language"))
|
2779
|
+
SendOTPMessageRequestParameters.add_member(:origination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "OriginationIdentity"))
|
2780
|
+
SendOTPMessageRequestParameters.add_member(:reference_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ReferenceId"))
|
2781
|
+
SendOTPMessageRequestParameters.add_member(:template_id, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateId"))
|
2782
|
+
SendOTPMessageRequestParameters.add_member(:validity_period, Shapes::ShapeRef.new(shape: __integer, location_name: "ValidityPeriod"))
|
2783
|
+
SendOTPMessageRequestParameters.struct_class = Types::SendOTPMessageRequestParameters
|
2784
|
+
|
2785
|
+
SendOTPMessageResponse.add_member(:message_response, Shapes::ShapeRef.new(shape: MessageResponse, required: true, location_name: "MessageResponse"))
|
2786
|
+
SendOTPMessageResponse.struct_class = Types::SendOTPMessageResponse
|
2787
|
+
SendOTPMessageResponse[:payload] = :message_response
|
2788
|
+
SendOTPMessageResponse[:payload_member] = SendOTPMessageResponse.member(:message_response)
|
2789
|
+
|
2748
2790
|
SendUsersMessageRequest.add_member(:context, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "Context"))
|
2749
2791
|
SendUsersMessageRequest.add_member(:message_configuration, Shapes::ShapeRef.new(shape: DirectMessageConfiguration, required: true, location_name: "MessageConfiguration"))
|
2750
2792
|
SendUsersMessageRequest.add_member(:template_configuration, Shapes::ShapeRef.new(shape: TemplateConfiguration, location_name: "TemplateConfiguration"))
|
@@ -3167,6 +3209,25 @@ module Aws::Pinpoint
|
|
3167
3209
|
UpdateVoiceTemplateResponse[:payload] = :message_body
|
3168
3210
|
UpdateVoiceTemplateResponse[:payload_member] = UpdateVoiceTemplateResponse.member(:message_body)
|
3169
3211
|
|
3212
|
+
VerificationResponse.add_member(:valid, Shapes::ShapeRef.new(shape: __boolean, location_name: "Valid"))
|
3213
|
+
VerificationResponse.struct_class = Types::VerificationResponse
|
3214
|
+
|
3215
|
+
VerifyOTPMessageRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
3216
|
+
VerifyOTPMessageRequest.add_member(:verify_otp_message_request_parameters, Shapes::ShapeRef.new(shape: VerifyOTPMessageRequestParameters, required: true, location_name: "VerifyOTPMessageRequestParameters"))
|
3217
|
+
VerifyOTPMessageRequest.struct_class = Types::VerifyOTPMessageRequest
|
3218
|
+
VerifyOTPMessageRequest[:payload] = :verify_otp_message_request_parameters
|
3219
|
+
VerifyOTPMessageRequest[:payload_member] = VerifyOTPMessageRequest.member(:verify_otp_message_request_parameters)
|
3220
|
+
|
3221
|
+
VerifyOTPMessageRequestParameters.add_member(:destination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DestinationIdentity"))
|
3222
|
+
VerifyOTPMessageRequestParameters.add_member(:otp, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Otp"))
|
3223
|
+
VerifyOTPMessageRequestParameters.add_member(:reference_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ReferenceId"))
|
3224
|
+
VerifyOTPMessageRequestParameters.struct_class = Types::VerifyOTPMessageRequestParameters
|
3225
|
+
|
3226
|
+
VerifyOTPMessageResponse.add_member(:verification_response, Shapes::ShapeRef.new(shape: VerificationResponse, required: true, location_name: "VerificationResponse"))
|
3227
|
+
VerifyOTPMessageResponse.struct_class = Types::VerifyOTPMessageResponse
|
3228
|
+
VerifyOTPMessageResponse[:payload] = :verification_response
|
3229
|
+
VerifyOTPMessageResponse[:payload_member] = VerifyOTPMessageResponse.member(:verification_response)
|
3230
|
+
|
3170
3231
|
VoiceChannelRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
|
3171
3232
|
VoiceChannelRequest.struct_class = Types::VoiceChannelRequest
|
3172
3233
|
|
@@ -3262,6 +3323,7 @@ module Aws::Pinpoint
|
|
3262
3323
|
WriteJourneyRequest.add_member(:state, Shapes::ShapeRef.new(shape: State, location_name: "State"))
|
3263
3324
|
WriteJourneyRequest.add_member(:wait_for_quiet_time, Shapes::ShapeRef.new(shape: __boolean, location_name: "WaitForQuietTime"))
|
3264
3325
|
WriteJourneyRequest.add_member(:refresh_on_segment_update, Shapes::ShapeRef.new(shape: __boolean, location_name: "RefreshOnSegmentUpdate"))
|
3326
|
+
WriteJourneyRequest.add_member(:journey_channel_settings, Shapes::ShapeRef.new(shape: JourneyChannelSettings, location_name: "JourneyChannelSettings"))
|
3265
3327
|
WriteJourneyRequest.struct_class = Types::WriteJourneyRequest
|
3266
3328
|
|
3267
3329
|
WriteSegmentRequest.add_member(:dimensions, Shapes::ShapeRef.new(shape: SegmentDimensions, location_name: "Dimensions"))
|
@@ -4628,6 +4690,21 @@ module Aws::Pinpoint
|
|
4628
4690
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4629
4691
|
end)
|
4630
4692
|
|
4693
|
+
api.add_operation(:send_otp_message, Seahorse::Model::Operation.new.tap do |o|
|
4694
|
+
o.name = "SendOTPMessage"
|
4695
|
+
o.http_method = "POST"
|
4696
|
+
o.http_request_uri = "/v1/apps/{application-id}/otp"
|
4697
|
+
o.input = Shapes::ShapeRef.new(shape: SendOTPMessageRequest)
|
4698
|
+
o.output = Shapes::ShapeRef.new(shape: SendOTPMessageResponse)
|
4699
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
4700
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
4701
|
+
o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
|
4702
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
4703
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
4704
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
4705
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4706
|
+
end)
|
4707
|
+
|
4631
4708
|
api.add_operation(:send_users_messages, Seahorse::Model::Operation.new.tap do |o|
|
4632
4709
|
o.name = "SendUsersMessages"
|
4633
4710
|
o.http_method = "POST"
|
@@ -1515,6 +1515,9 @@ module Aws::Pinpoint
|
|
1515
1515
|
# wait_until: "__string",
|
1516
1516
|
# },
|
1517
1517
|
# },
|
1518
|
+
# contact_center: {
|
1519
|
+
# next_activity: "__string",
|
1520
|
+
# },
|
1518
1521
|
# }
|
1519
1522
|
#
|
1520
1523
|
# @!attribute [rw] custom
|
@@ -1573,6 +1576,11 @@ module Aws::Pinpoint
|
|
1573
1576
|
# moving participants to the next activity in a journey.
|
1574
1577
|
# @return [Types::WaitActivity]
|
1575
1578
|
#
|
1579
|
+
# @!attribute [rw] contact_center
|
1580
|
+
# The settings for a connect activity. This type of activity initiates
|
1581
|
+
# a contact center call to participants.
|
1582
|
+
# @return [Types::ContactCenterActivity]
|
1583
|
+
#
|
1576
1584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Activity AWS API Documentation
|
1577
1585
|
#
|
1578
1586
|
class Activity < Struct.new(
|
@@ -1585,7 +1593,8 @@ module Aws::Pinpoint
|
|
1585
1593
|
:push,
|
1586
1594
|
:random_split,
|
1587
1595
|
:sms,
|
1588
|
-
:wait
|
1596
|
+
:wait,
|
1597
|
+
:contact_center)
|
1589
1598
|
SENSITIVE = []
|
1590
1599
|
include Aws::Structure
|
1591
1600
|
end
|
@@ -3368,6 +3377,29 @@ module Aws::Pinpoint
|
|
3368
3377
|
include Aws::Structure
|
3369
3378
|
end
|
3370
3379
|
|
3380
|
+
# The settings for a connect activity. This type of activity initiates a
|
3381
|
+
# contact center call to participants.
|
3382
|
+
#
|
3383
|
+
# @note When making an API call, you may pass ContactCenterActivity
|
3384
|
+
# data as a hash:
|
3385
|
+
#
|
3386
|
+
# {
|
3387
|
+
# next_activity: "__string",
|
3388
|
+
# }
|
3389
|
+
#
|
3390
|
+
# @!attribute [rw] next_activity
|
3391
|
+
# The unique identifier for the next activity to perform after the
|
3392
|
+
# this activity.
|
3393
|
+
# @return [String]
|
3394
|
+
#
|
3395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ContactCenterActivity AWS API Documentation
|
3396
|
+
#
|
3397
|
+
class ContactCenterActivity < Struct.new(
|
3398
|
+
:next_activity)
|
3399
|
+
SENSITIVE = []
|
3400
|
+
include Aws::Structure
|
3401
|
+
end
|
3402
|
+
|
3371
3403
|
# Provides information about an API request or response.
|
3372
3404
|
#
|
3373
3405
|
# @!attribute [rw] message
|
@@ -4465,6 +4497,9 @@ module Aws::Pinpoint
|
|
4465
4497
|
# wait_until: "__string",
|
4466
4498
|
# },
|
4467
4499
|
# },
|
4500
|
+
# contact_center: {
|
4501
|
+
# next_activity: "__string",
|
4502
|
+
# },
|
4468
4503
|
# },
|
4469
4504
|
# },
|
4470
4505
|
# creation_date: "__string",
|
@@ -4521,6 +4556,10 @@ module Aws::Pinpoint
|
|
4521
4556
|
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
4522
4557
|
# wait_for_quiet_time: false,
|
4523
4558
|
# refresh_on_segment_update: false,
|
4559
|
+
# journey_channel_settings: {
|
4560
|
+
# connect_campaign_arn: "__string",
|
4561
|
+
# connect_campaign_execution_role_arn: "__string",
|
4562
|
+
# },
|
4524
4563
|
# },
|
4525
4564
|
# }
|
4526
4565
|
#
|
@@ -11565,6 +11604,8 @@ module Aws::Pinpoint
|
|
11565
11604
|
# }
|
11566
11605
|
#
|
11567
11606
|
# @!attribute [rw] data
|
11607
|
+
# The message content that's passed to an AWS Lambda function or to a
|
11608
|
+
# web hook.
|
11568
11609
|
# @return [String]
|
11569
11610
|
#
|
11570
11611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyCustomMessage AWS API Documentation
|
@@ -11850,6 +11891,34 @@ module Aws::Pinpoint
|
|
11850
11891
|
include Aws::Structure
|
11851
11892
|
end
|
11852
11893
|
|
11894
|
+
# The channel-specific configurations for the journey.
|
11895
|
+
#
|
11896
|
+
# @note When making an API call, you may pass JourneyChannelSettings
|
11897
|
+
# data as a hash:
|
11898
|
+
#
|
11899
|
+
# {
|
11900
|
+
# connect_campaign_arn: "__string",
|
11901
|
+
# connect_campaign_execution_role_arn: "__string",
|
11902
|
+
# }
|
11903
|
+
#
|
11904
|
+
# @!attribute [rw] connect_campaign_arn
|
11905
|
+
# Amazon Resource Name (ARN) of the Connect Campaign.
|
11906
|
+
# @return [String]
|
11907
|
+
#
|
11908
|
+
# @!attribute [rw] connect_campaign_execution_role_arn
|
11909
|
+
# IAM role ARN to be assumed when invoking Connect campaign execution
|
11910
|
+
# APIs for dialing.
|
11911
|
+
# @return [String]
|
11912
|
+
#
|
11913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyChannelSettings AWS API Documentation
|
11914
|
+
#
|
11915
|
+
class JourneyChannelSettings < Struct.new(
|
11916
|
+
:connect_campaign_arn,
|
11917
|
+
:connect_campaign_execution_role_arn)
|
11918
|
+
SENSITIVE = []
|
11919
|
+
include Aws::Structure
|
11920
|
+
end
|
11921
|
+
|
11853
11922
|
# Provides information about the status, configuration, and other
|
11854
11923
|
# settings for a journey.
|
11855
11924
|
#
|
@@ -11968,6 +12037,10 @@ module Aws::Pinpoint
|
|
11968
12037
|
# This object is not used or supported.
|
11969
12038
|
# @return [Hash<String,String>]
|
11970
12039
|
#
|
12040
|
+
# @!attribute [rw] journey_channel_settings
|
12041
|
+
# Amazon Resource Name (ARN) of the Connect Campaign.
|
12042
|
+
# @return [Types::JourneyChannelSettings]
|
12043
|
+
#
|
11971
12044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyResponse AWS API Documentation
|
11972
12045
|
#
|
11973
12046
|
class JourneyResponse < Struct.new(
|
@@ -11985,7 +12058,8 @@ module Aws::Pinpoint
|
|
11985
12058
|
:start_activity,
|
11986
12059
|
:start_condition,
|
11987
12060
|
:state,
|
11988
|
-
:tags
|
12061
|
+
:tags,
|
12062
|
+
:journey_channel_settings)
|
11989
12063
|
SENSITIVE = []
|
11990
12064
|
include Aws::Structure
|
11991
12065
|
end
|
@@ -16035,6 +16109,141 @@ module Aws::Pinpoint
|
|
16035
16109
|
include Aws::Structure
|
16036
16110
|
end
|
16037
16111
|
|
16112
|
+
# @note When making an API call, you may pass SendOTPMessageRequest
|
16113
|
+
# data as a hash:
|
16114
|
+
#
|
16115
|
+
# {
|
16116
|
+
# application_id: "__string", # required
|
16117
|
+
# send_otp_message_request_parameters: { # required
|
16118
|
+
# allowed_attempts: 1,
|
16119
|
+
# brand_name: "__string", # required
|
16120
|
+
# channel: "__string", # required
|
16121
|
+
# code_length: 1,
|
16122
|
+
# destination_identity: "__string", # required
|
16123
|
+
# entity_id: "__string",
|
16124
|
+
# language: "__string",
|
16125
|
+
# origination_identity: "__string", # required
|
16126
|
+
# reference_id: "__string", # required
|
16127
|
+
# template_id: "__string",
|
16128
|
+
# validity_period: 1,
|
16129
|
+
# },
|
16130
|
+
# }
|
16131
|
+
#
|
16132
|
+
# @!attribute [rw] application_id
|
16133
|
+
# @return [String]
|
16134
|
+
#
|
16135
|
+
# @!attribute [rw] send_otp_message_request_parameters
|
16136
|
+
# Send OTP message request parameters.
|
16137
|
+
# @return [Types::SendOTPMessageRequestParameters]
|
16138
|
+
#
|
16139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageRequest AWS API Documentation
|
16140
|
+
#
|
16141
|
+
class SendOTPMessageRequest < Struct.new(
|
16142
|
+
:application_id,
|
16143
|
+
:send_otp_message_request_parameters)
|
16144
|
+
SENSITIVE = []
|
16145
|
+
include Aws::Structure
|
16146
|
+
end
|
16147
|
+
|
16148
|
+
# Send OTP message request parameters.
|
16149
|
+
#
|
16150
|
+
# @note When making an API call, you may pass SendOTPMessageRequestParameters
|
16151
|
+
# data as a hash:
|
16152
|
+
#
|
16153
|
+
# {
|
16154
|
+
# allowed_attempts: 1,
|
16155
|
+
# brand_name: "__string", # required
|
16156
|
+
# channel: "__string", # required
|
16157
|
+
# code_length: 1,
|
16158
|
+
# destination_identity: "__string", # required
|
16159
|
+
# entity_id: "__string",
|
16160
|
+
# language: "__string",
|
16161
|
+
# origination_identity: "__string", # required
|
16162
|
+
# reference_id: "__string", # required
|
16163
|
+
# template_id: "__string",
|
16164
|
+
# validity_period: 1,
|
16165
|
+
# }
|
16166
|
+
#
|
16167
|
+
# @!attribute [rw] allowed_attempts
|
16168
|
+
# The attempts allowed to validate an OTP.
|
16169
|
+
# @return [Integer]
|
16170
|
+
#
|
16171
|
+
# @!attribute [rw] brand_name
|
16172
|
+
# The brand name that will be substituted into the OTP message body.
|
16173
|
+
# Should be owned by calling AWS account.
|
16174
|
+
# @return [String]
|
16175
|
+
#
|
16176
|
+
# @!attribute [rw] channel
|
16177
|
+
# Channel type for the OTP message. Supported values: \[SMS\].
|
16178
|
+
# @return [String]
|
16179
|
+
#
|
16180
|
+
# @!attribute [rw] code_length
|
16181
|
+
# The number of characters in the generated OTP.
|
16182
|
+
# @return [Integer]
|
16183
|
+
#
|
16184
|
+
# @!attribute [rw] destination_identity
|
16185
|
+
# The destination identity to send OTP to.
|
16186
|
+
# @return [String]
|
16187
|
+
#
|
16188
|
+
# @!attribute [rw] entity_id
|
16189
|
+
# A unique Entity ID received from DLT after entity registration is
|
16190
|
+
# approved.
|
16191
|
+
# @return [String]
|
16192
|
+
#
|
16193
|
+
# @!attribute [rw] language
|
16194
|
+
# The language to be used for the outgoing message body containing the
|
16195
|
+
# OTP.
|
16196
|
+
# @return [String]
|
16197
|
+
#
|
16198
|
+
# @!attribute [rw] origination_identity
|
16199
|
+
# The origination identity used to send OTP from.
|
16200
|
+
# @return [String]
|
16201
|
+
#
|
16202
|
+
# @!attribute [rw] reference_id
|
16203
|
+
# Developer-specified reference identifier. Required to match during
|
16204
|
+
# OTP verification.
|
16205
|
+
# @return [String]
|
16206
|
+
#
|
16207
|
+
# @!attribute [rw] template_id
|
16208
|
+
# A unique Template ID received from DLT after entity registration is
|
16209
|
+
# approved.
|
16210
|
+
# @return [String]
|
16211
|
+
#
|
16212
|
+
# @!attribute [rw] validity_period
|
16213
|
+
# The time in minutes before the OTP is no longer valid.
|
16214
|
+
# @return [Integer]
|
16215
|
+
#
|
16216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageRequestParameters AWS API Documentation
|
16217
|
+
#
|
16218
|
+
class SendOTPMessageRequestParameters < Struct.new(
|
16219
|
+
:allowed_attempts,
|
16220
|
+
:brand_name,
|
16221
|
+
:channel,
|
16222
|
+
:code_length,
|
16223
|
+
:destination_identity,
|
16224
|
+
:entity_id,
|
16225
|
+
:language,
|
16226
|
+
:origination_identity,
|
16227
|
+
:reference_id,
|
16228
|
+
:template_id,
|
16229
|
+
:validity_period)
|
16230
|
+
SENSITIVE = []
|
16231
|
+
include Aws::Structure
|
16232
|
+
end
|
16233
|
+
|
16234
|
+
# @!attribute [rw] message_response
|
16235
|
+
# Provides information about the results of a request to send a
|
16236
|
+
# message to an endpoint address.
|
16237
|
+
# @return [Types::MessageResponse]
|
16238
|
+
#
|
16239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageResponse AWS API Documentation
|
16240
|
+
#
|
16241
|
+
class SendOTPMessageResponse < Struct.new(
|
16242
|
+
:message_response)
|
16243
|
+
SENSITIVE = []
|
16244
|
+
include Aws::Structure
|
16245
|
+
end
|
16246
|
+
|
16038
16247
|
# Specifies the configuration and other settings for a message to send
|
16039
16248
|
# to all the endpoints that are associated with a list of users.
|
16040
16249
|
#
|
@@ -18912,6 +19121,9 @@ module Aws::Pinpoint
|
|
18912
19121
|
# wait_until: "__string",
|
18913
19122
|
# },
|
18914
19123
|
# },
|
19124
|
+
# contact_center: {
|
19125
|
+
# next_activity: "__string",
|
19126
|
+
# },
|
18915
19127
|
# },
|
18916
19128
|
# },
|
18917
19129
|
# creation_date: "__string",
|
@@ -18968,6 +19180,10 @@ module Aws::Pinpoint
|
|
18968
19180
|
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
18969
19181
|
# wait_for_quiet_time: false,
|
18970
19182
|
# refresh_on_segment_update: false,
|
19183
|
+
# journey_channel_settings: {
|
19184
|
+
# connect_campaign_arn: "__string",
|
19185
|
+
# connect_campaign_execution_role_arn: "__string",
|
19186
|
+
# },
|
18971
19187
|
# },
|
18972
19188
|
# }
|
18973
19189
|
#
|
@@ -19780,6 +19996,72 @@ module Aws::Pinpoint
|
|
19780
19996
|
include Aws::Structure
|
19781
19997
|
end
|
19782
19998
|
|
19999
|
+
# Verify OTP Message Response.
|
20000
|
+
#
|
20001
|
+
# @!attribute [rw] valid
|
20002
|
+
# Specifies whether the OTP is valid or not.
|
20003
|
+
# @return [Boolean]
|
20004
|
+
#
|
20005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerificationResponse AWS API Documentation
|
20006
|
+
#
|
20007
|
+
class VerificationResponse < Struct.new(
|
20008
|
+
:valid)
|
20009
|
+
SENSITIVE = []
|
20010
|
+
include Aws::Structure
|
20011
|
+
end
|
20012
|
+
|
20013
|
+
# @!attribute [rw] application_id
|
20014
|
+
# @return [String]
|
20015
|
+
#
|
20016
|
+
# @!attribute [rw] verify_otp_message_request_parameters
|
20017
|
+
# Verify OTP message request.
|
20018
|
+
# @return [Types::VerifyOTPMessageRequestParameters]
|
20019
|
+
#
|
20020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequest AWS API Documentation
|
20021
|
+
#
|
20022
|
+
class VerifyOTPMessageRequest < Struct.new(
|
20023
|
+
:application_id,
|
20024
|
+
:verify_otp_message_request_parameters)
|
20025
|
+
SENSITIVE = []
|
20026
|
+
include Aws::Structure
|
20027
|
+
end
|
20028
|
+
|
20029
|
+
# Verify OTP message request.
|
20030
|
+
#
|
20031
|
+
# @!attribute [rw] destination_identity
|
20032
|
+
# The destination identity to send OTP to.
|
20033
|
+
# @return [String]
|
20034
|
+
#
|
20035
|
+
# @!attribute [rw] otp
|
20036
|
+
# The OTP the end user provided for verification.
|
20037
|
+
# @return [String]
|
20038
|
+
#
|
20039
|
+
# @!attribute [rw] reference_id
|
20040
|
+
# The reference identifier provided when the OTP was previously sent.
|
20041
|
+
# @return [String]
|
20042
|
+
#
|
20043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequestParameters AWS API Documentation
|
20044
|
+
#
|
20045
|
+
class VerifyOTPMessageRequestParameters < Struct.new(
|
20046
|
+
:destination_identity,
|
20047
|
+
:otp,
|
20048
|
+
:reference_id)
|
20049
|
+
SENSITIVE = []
|
20050
|
+
include Aws::Structure
|
20051
|
+
end
|
20052
|
+
|
20053
|
+
# @!attribute [rw] verification_response
|
20054
|
+
# Verify OTP Message Response.
|
20055
|
+
# @return [Types::VerificationResponse]
|
20056
|
+
#
|
20057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageResponse AWS API Documentation
|
20058
|
+
#
|
20059
|
+
class VerifyOTPMessageResponse < Struct.new(
|
20060
|
+
:verification_response)
|
20061
|
+
SENSITIVE = []
|
20062
|
+
include Aws::Structure
|
20063
|
+
end
|
20064
|
+
|
19783
20065
|
# Specifies the status and settings of the voice channel for an
|
19784
20066
|
# application.
|
19785
20067
|
#
|
@@ -21146,6 +21428,9 @@ module Aws::Pinpoint
|
|
21146
21428
|
# wait_until: "__string",
|
21147
21429
|
# },
|
21148
21430
|
# },
|
21431
|
+
# contact_center: {
|
21432
|
+
# next_activity: "__string",
|
21433
|
+
# },
|
21149
21434
|
# },
|
21150
21435
|
# },
|
21151
21436
|
# creation_date: "__string",
|
@@ -21202,6 +21487,10 @@ module Aws::Pinpoint
|
|
21202
21487
|
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
21203
21488
|
# wait_for_quiet_time: false,
|
21204
21489
|
# refresh_on_segment_update: false,
|
21490
|
+
# journey_channel_settings: {
|
21491
|
+
# connect_campaign_arn: "__string",
|
21492
|
+
# connect_campaign_execution_role_arn: "__string",
|
21493
|
+
# },
|
21205
21494
|
# }
|
21206
21495
|
#
|
21207
21496
|
# @!attribute [rw] activities
|
@@ -21302,6 +21591,11 @@ module Aws::Pinpoint
|
|
21302
21591
|
# @!attribute [rw] refresh_on_segment_update
|
21303
21592
|
# @return [Boolean]
|
21304
21593
|
#
|
21594
|
+
# @!attribute [rw] journey_channel_settings
|
21595
|
+
# IAM role ARN to be assumed when invoking Connect campaign execution
|
21596
|
+
# APIs for dialing.
|
21597
|
+
# @return [Types::JourneyChannelSettings]
|
21598
|
+
#
|
21305
21599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteJourneyRequest AWS API Documentation
|
21306
21600
|
#
|
21307
21601
|
class WriteJourneyRequest < Struct.new(
|
@@ -21318,7 +21612,8 @@ module Aws::Pinpoint
|
|
21318
21612
|
:start_condition,
|
21319
21613
|
:state,
|
21320
21614
|
:wait_for_quiet_time,
|
21321
|
-
:refresh_on_segment_update
|
21615
|
+
:refresh_on_segment_update,
|
21616
|
+
:journey_channel_settings)
|
21322
21617
|
SENSITIVE = []
|
21323
21618
|
include Aws::Structure
|
21324
21619
|
end
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-pinpoint
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.61.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: 2021-
|
11
|
+
date: 2021-11-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.122.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.122.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|