aws-sdk-pinpoint 1.60.0 → 1.64.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 +106 -3
- data/lib/aws-sdk-pinpoint/client_api.rb +80 -0
- data/lib/aws-sdk-pinpoint/types.rb +222 -0
- 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: fda296de244a60166c900af6217db56729601c67a09f7ab8c8d64935e0f22cca
|
4
|
+
data.tar.gz: f539298bb14cb90dc4b4470728fbe4fc824ec2fd347b279787d87e73bdcca078
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 850640418a5a2e67741383cb321bee9e94f2858d351198283336ca92f00c7447ed95c9acd0a07327d8edda8dfdac017ee8567edc40f8cb9642fe143bdf300cb9
|
7
|
+
data.tar.gz: edf76bba8385cda70aaee17d470fda21d3eef84bb42a2cf192d2f274946f947ca040b2dfd922863f477e45590bdd67b2c862b6e99018c7e4b7e4b888776c76dd
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.64.0 (2022-01-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds JourneyChannelSettings to WriteJourneyRequest
|
8
|
+
|
9
|
+
1.63.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.62.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.61.0 (2021-11-26)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* 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
|
23
|
+
|
4
24
|
1.60.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.64.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Pinpoint
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Pinpoint
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Pinpoint
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -295,7 +303,7 @@ module Aws::Pinpoint
|
|
295
303
|
# seconds to wait when opening a HTTP session before raising a
|
296
304
|
# `Timeout::Error`.
|
297
305
|
#
|
298
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
307
|
# number of seconds to wait for response data. This value can
|
300
308
|
# safely be set per-request on the session.
|
301
309
|
#
|
@@ -311,6 +319,9 @@ module Aws::Pinpoint
|
|
311
319
|
# disables this behaviour. This value can safely be set per
|
312
320
|
# request on the session.
|
313
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
314
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
326
|
# HTTP debug output will be sent to the `:logger`.
|
316
327
|
#
|
@@ -8640,6 +8651,63 @@ module Aws::Pinpoint
|
|
8640
8651
|
req.send_request(options)
|
8641
8652
|
end
|
8642
8653
|
|
8654
|
+
# Send an OTP message
|
8655
|
+
#
|
8656
|
+
# @option params [required, String] :application_id
|
8657
|
+
#
|
8658
|
+
# @option params [required, Types::SendOTPMessageRequestParameters] :send_otp_message_request_parameters
|
8659
|
+
# Send OTP message request parameters.
|
8660
|
+
#
|
8661
|
+
# @return [Types::SendOTPMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8662
|
+
#
|
8663
|
+
# * {Types::SendOTPMessageResponse#message_response #message_response} => Types::MessageResponse
|
8664
|
+
#
|
8665
|
+
# @example Request syntax with placeholder values
|
8666
|
+
#
|
8667
|
+
# resp = client.send_otp_message({
|
8668
|
+
# application_id: "__string", # required
|
8669
|
+
# send_otp_message_request_parameters: { # required
|
8670
|
+
# allowed_attempts: 1,
|
8671
|
+
# brand_name: "__string", # required
|
8672
|
+
# channel: "__string", # required
|
8673
|
+
# code_length: 1,
|
8674
|
+
# destination_identity: "__string", # required
|
8675
|
+
# entity_id: "__string",
|
8676
|
+
# language: "__string",
|
8677
|
+
# origination_identity: "__string", # required
|
8678
|
+
# reference_id: "__string", # required
|
8679
|
+
# template_id: "__string",
|
8680
|
+
# validity_period: 1,
|
8681
|
+
# },
|
8682
|
+
# })
|
8683
|
+
#
|
8684
|
+
# @example Response structure
|
8685
|
+
#
|
8686
|
+
# resp.message_response.application_id #=> String
|
8687
|
+
# resp.message_response.endpoint_result #=> Hash
|
8688
|
+
# resp.message_response.endpoint_result["__string"].address #=> String
|
8689
|
+
# resp.message_response.endpoint_result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8690
|
+
# resp.message_response.endpoint_result["__string"].message_id #=> String
|
8691
|
+
# resp.message_response.endpoint_result["__string"].status_code #=> Integer
|
8692
|
+
# resp.message_response.endpoint_result["__string"].status_message #=> String
|
8693
|
+
# resp.message_response.endpoint_result["__string"].updated_token #=> String
|
8694
|
+
# resp.message_response.request_id #=> String
|
8695
|
+
# resp.message_response.result #=> Hash
|
8696
|
+
# resp.message_response.result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8697
|
+
# resp.message_response.result["__string"].message_id #=> String
|
8698
|
+
# resp.message_response.result["__string"].status_code #=> Integer
|
8699
|
+
# resp.message_response.result["__string"].status_message #=> String
|
8700
|
+
# resp.message_response.result["__string"].updated_token #=> String
|
8701
|
+
#
|
8702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessage AWS API Documentation
|
8703
|
+
#
|
8704
|
+
# @overload send_otp_message(params = {})
|
8705
|
+
# @param [Hash] params ({})
|
8706
|
+
def send_otp_message(params = {}, options = {})
|
8707
|
+
req = build_request(:send_otp_message, params)
|
8708
|
+
req.send_request(options)
|
8709
|
+
end
|
8710
|
+
|
8643
8711
|
# Creates and sends a message to a list of users.
|
8644
8712
|
#
|
8645
8713
|
# @option params [required, String] :application_id
|
@@ -11932,6 +12000,41 @@ module Aws::Pinpoint
|
|
11932
12000
|
req.send_request(options)
|
11933
12001
|
end
|
11934
12002
|
|
12003
|
+
# Verify an OTP
|
12004
|
+
#
|
12005
|
+
# @option params [required, String] :application_id
|
12006
|
+
#
|
12007
|
+
# @option params [required, Types::VerifyOTPMessageRequestParameters] :verify_otp_message_request_parameters
|
12008
|
+
# Verify OTP message request.
|
12009
|
+
#
|
12010
|
+
# @return [Types::VerifyOTPMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12011
|
+
#
|
12012
|
+
# * {Types::VerifyOTPMessageResponse#verification_response #verification_response} => Types::VerificationResponse
|
12013
|
+
#
|
12014
|
+
# @example Request syntax with placeholder values
|
12015
|
+
#
|
12016
|
+
# resp = client.verify_otp_message({
|
12017
|
+
# application_id: "__string", # required
|
12018
|
+
# verify_otp_message_request_parameters: { # required
|
12019
|
+
# destination_identity: "__string", # required
|
12020
|
+
# otp: "__string", # required
|
12021
|
+
# reference_id: "__string", # required
|
12022
|
+
# },
|
12023
|
+
# })
|
12024
|
+
#
|
12025
|
+
# @example Response structure
|
12026
|
+
#
|
12027
|
+
# resp.verification_response.valid #=> Boolean
|
12028
|
+
#
|
12029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessage AWS API Documentation
|
12030
|
+
#
|
12031
|
+
# @overload verify_otp_message(params = {})
|
12032
|
+
# @param [Hash] params ({})
|
12033
|
+
def verify_otp_message(params = {}, options = {})
|
12034
|
+
req = build_request(:verify_otp_message, params)
|
12035
|
+
req.send_request(options)
|
12036
|
+
end
|
12037
|
+
|
11935
12038
|
# @!endgroup
|
11936
12039
|
|
11937
12040
|
# @param params ({})
|
@@ -11945,7 +12048,7 @@ module Aws::Pinpoint
|
|
11945
12048
|
params: params,
|
11946
12049
|
config: config)
|
11947
12050
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
11948
|
-
context[:gem_version] = '1.
|
12051
|
+
context[:gem_version] = '1.64.0'
|
11949
12052
|
Seahorse::Client::Request.new(handlers, context)
|
11950
12053
|
end
|
11951
12054
|
|
@@ -425,6 +425,9 @@ module Aws::Pinpoint
|
|
425
425
|
SegmentsResponse = Shapes::StructureShape.new(name: 'SegmentsResponse')
|
426
426
|
SendMessagesRequest = Shapes::StructureShape.new(name: 'SendMessagesRequest')
|
427
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')
|
428
431
|
SendUsersMessageRequest = Shapes::StructureShape.new(name: 'SendUsersMessageRequest')
|
429
432
|
SendUsersMessageResponse = Shapes::StructureShape.new(name: 'SendUsersMessageResponse')
|
430
433
|
SendUsersMessagesRequest = Shapes::StructureShape.new(name: 'SendUsersMessagesRequest')
|
@@ -502,6 +505,10 @@ module Aws::Pinpoint
|
|
502
505
|
UpdateVoiceChannelResponse = Shapes::StructureShape.new(name: 'UpdateVoiceChannelResponse')
|
503
506
|
UpdateVoiceTemplateRequest = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateRequest')
|
504
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')
|
505
512
|
VoiceChannelRequest = Shapes::StructureShape.new(name: 'VoiceChannelRequest')
|
506
513
|
VoiceChannelResponse = Shapes::StructureShape.new(name: 'VoiceChannelResponse')
|
507
514
|
VoiceMessage = Shapes::StructureShape.new(name: 'VoiceMessage')
|
@@ -2756,6 +2763,30 @@ module Aws::Pinpoint
|
|
2756
2763
|
SendMessagesResponse[:payload] = :message_response
|
2757
2764
|
SendMessagesResponse[:payload_member] = SendMessagesResponse.member(:message_response)
|
2758
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
|
+
|
2759
2790
|
SendUsersMessageRequest.add_member(:context, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "Context"))
|
2760
2791
|
SendUsersMessageRequest.add_member(:message_configuration, Shapes::ShapeRef.new(shape: DirectMessageConfiguration, required: true, location_name: "MessageConfiguration"))
|
2761
2792
|
SendUsersMessageRequest.add_member(:template_configuration, Shapes::ShapeRef.new(shape: TemplateConfiguration, location_name: "TemplateConfiguration"))
|
@@ -3178,6 +3209,25 @@ module Aws::Pinpoint
|
|
3178
3209
|
UpdateVoiceTemplateResponse[:payload] = :message_body
|
3179
3210
|
UpdateVoiceTemplateResponse[:payload_member] = UpdateVoiceTemplateResponse.member(:message_body)
|
3180
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
|
+
|
3181
3231
|
VoiceChannelRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
|
3182
3232
|
VoiceChannelRequest.struct_class = Types::VoiceChannelRequest
|
3183
3233
|
|
@@ -4640,6 +4690,21 @@ module Aws::Pinpoint
|
|
4640
4690
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4641
4691
|
end)
|
4642
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
|
+
|
4643
4708
|
api.add_operation(:send_users_messages, Seahorse::Model::Operation.new.tap do |o|
|
4644
4709
|
o.name = "SendUsersMessages"
|
4645
4710
|
o.http_method = "POST"
|
@@ -5031,6 +5096,21 @@ module Aws::Pinpoint
|
|
5031
5096
|
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
5032
5097
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
5033
5098
|
end)
|
5099
|
+
|
5100
|
+
api.add_operation(:verify_otp_message, Seahorse::Model::Operation.new.tap do |o|
|
5101
|
+
o.name = "VerifyOTPMessage"
|
5102
|
+
o.http_method = "POST"
|
5103
|
+
o.http_request_uri = "/v1/apps/{application-id}/verify-otp"
|
5104
|
+
o.input = Shapes::ShapeRef.new(shape: VerifyOTPMessageRequest)
|
5105
|
+
o.output = Shapes::ShapeRef.new(shape: VerifyOTPMessageResponse)
|
5106
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
5107
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
5108
|
+
o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
|
5109
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
5110
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
5111
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
5112
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
5113
|
+
end)
|
5034
5114
|
end
|
5035
5115
|
|
5036
5116
|
end
|
@@ -16109,6 +16109,141 @@ module Aws::Pinpoint
|
|
16109
16109
|
include Aws::Structure
|
16110
16110
|
end
|
16111
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
|
+
|
16112
16247
|
# Specifies the configuration and other settings for a message to send
|
16113
16248
|
# to all the endpoints that are associated with a list of users.
|
16114
16249
|
#
|
@@ -19861,6 +19996,93 @@ module Aws::Pinpoint
|
|
19861
19996
|
include Aws::Structure
|
19862
19997
|
end
|
19863
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
|
+
# @note When making an API call, you may pass VerifyOTPMessageRequest
|
20014
|
+
# data as a hash:
|
20015
|
+
#
|
20016
|
+
# {
|
20017
|
+
# application_id: "__string", # required
|
20018
|
+
# verify_otp_message_request_parameters: { # required
|
20019
|
+
# destination_identity: "__string", # required
|
20020
|
+
# otp: "__string", # required
|
20021
|
+
# reference_id: "__string", # required
|
20022
|
+
# },
|
20023
|
+
# }
|
20024
|
+
#
|
20025
|
+
# @!attribute [rw] application_id
|
20026
|
+
# @return [String]
|
20027
|
+
#
|
20028
|
+
# @!attribute [rw] verify_otp_message_request_parameters
|
20029
|
+
# Verify OTP message request.
|
20030
|
+
# @return [Types::VerifyOTPMessageRequestParameters]
|
20031
|
+
#
|
20032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequest AWS API Documentation
|
20033
|
+
#
|
20034
|
+
class VerifyOTPMessageRequest < Struct.new(
|
20035
|
+
:application_id,
|
20036
|
+
:verify_otp_message_request_parameters)
|
20037
|
+
SENSITIVE = []
|
20038
|
+
include Aws::Structure
|
20039
|
+
end
|
20040
|
+
|
20041
|
+
# Verify OTP message request.
|
20042
|
+
#
|
20043
|
+
# @note When making an API call, you may pass VerifyOTPMessageRequestParameters
|
20044
|
+
# data as a hash:
|
20045
|
+
#
|
20046
|
+
# {
|
20047
|
+
# destination_identity: "__string", # required
|
20048
|
+
# otp: "__string", # required
|
20049
|
+
# reference_id: "__string", # required
|
20050
|
+
# }
|
20051
|
+
#
|
20052
|
+
# @!attribute [rw] destination_identity
|
20053
|
+
# The destination identity to send OTP to.
|
20054
|
+
# @return [String]
|
20055
|
+
#
|
20056
|
+
# @!attribute [rw] otp
|
20057
|
+
# The OTP the end user provided for verification.
|
20058
|
+
# @return [String]
|
20059
|
+
#
|
20060
|
+
# @!attribute [rw] reference_id
|
20061
|
+
# The reference identifier provided when the OTP was previously sent.
|
20062
|
+
# @return [String]
|
20063
|
+
#
|
20064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequestParameters AWS API Documentation
|
20065
|
+
#
|
20066
|
+
class VerifyOTPMessageRequestParameters < Struct.new(
|
20067
|
+
:destination_identity,
|
20068
|
+
:otp,
|
20069
|
+
:reference_id)
|
20070
|
+
SENSITIVE = []
|
20071
|
+
include Aws::Structure
|
20072
|
+
end
|
20073
|
+
|
20074
|
+
# @!attribute [rw] verification_response
|
20075
|
+
# Verify OTP Message Response.
|
20076
|
+
# @return [Types::VerificationResponse]
|
20077
|
+
#
|
20078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageResponse AWS API Documentation
|
20079
|
+
#
|
20080
|
+
class VerifyOTPMessageResponse < Struct.new(
|
20081
|
+
:verification_response)
|
20082
|
+
SENSITIVE = []
|
20083
|
+
include Aws::Structure
|
20084
|
+
end
|
20085
|
+
|
19864
20086
|
# Specifies the status and settings of the voice channel for an
|
19865
20087
|
# application.
|
19866
20088
|
#
|
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.64.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:
|
11
|
+
date: 2022-01-13 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.125.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.125.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|