aws-sdk-pinpoint 1.58.0 → 1.62.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 +70 -2
- data/lib/aws-sdk-pinpoint/client_api.rb +65 -0
- data/lib/aws-sdk-pinpoint/types.rb +201 -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: 2f0b33b9eec8438a8e9745d8a11b2a73eb792d145010193c0a9267776bfe95f2
|
4
|
+
data.tar.gz: 0d59155b1de20c2e851a70f5b40af8f0163a7c33c385e043852e6cb4306b3b05
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 53d8450ebddd62b19e1e4ad2c4c9d18c7a2de5871130d5f6614dacdf3ed73767fbcfa3faf31c5df4fe26b48c53f0ccb0283ef99f4ffffb3c81e19d88e9a2db69
|
7
|
+
data.tar.gz: 5e88d40ce4b691ce2914c3cba410ad44aae63fd3bffb9025ff102119f6d22d282affa83846483d8e3ac0972450683c9091eadb3c8ccac5de3e47024da6dac4d3
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.62.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.61.0 (2021-11-26)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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
|
13
|
+
|
14
|
+
1.60.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.59.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.58.0 (2021-09-27)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.62.0
|
@@ -119,7 +119,9 @@ module Aws::Pinpoint
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::Pinpoint
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -8631,6 +8642,63 @@ module Aws::Pinpoint
|
|
8631
8642
|
req.send_request(options)
|
8632
8643
|
end
|
8633
8644
|
|
8645
|
+
# Send an OTP message
|
8646
|
+
#
|
8647
|
+
# @option params [required, String] :application_id
|
8648
|
+
#
|
8649
|
+
# @option params [required, Types::SendOTPMessageRequestParameters] :send_otp_message_request_parameters
|
8650
|
+
# Send OTP message request parameters.
|
8651
|
+
#
|
8652
|
+
# @return [Types::SendOTPMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8653
|
+
#
|
8654
|
+
# * {Types::SendOTPMessageResponse#message_response #message_response} => Types::MessageResponse
|
8655
|
+
#
|
8656
|
+
# @example Request syntax with placeholder values
|
8657
|
+
#
|
8658
|
+
# resp = client.send_otp_message({
|
8659
|
+
# application_id: "__string", # required
|
8660
|
+
# send_otp_message_request_parameters: { # required
|
8661
|
+
# allowed_attempts: 1,
|
8662
|
+
# brand_name: "__string", # required
|
8663
|
+
# channel: "__string", # required
|
8664
|
+
# code_length: 1,
|
8665
|
+
# destination_identity: "__string", # required
|
8666
|
+
# entity_id: "__string",
|
8667
|
+
# language: "__string",
|
8668
|
+
# origination_identity: "__string", # required
|
8669
|
+
# reference_id: "__string", # required
|
8670
|
+
# template_id: "__string",
|
8671
|
+
# validity_period: 1,
|
8672
|
+
# },
|
8673
|
+
# })
|
8674
|
+
#
|
8675
|
+
# @example Response structure
|
8676
|
+
#
|
8677
|
+
# resp.message_response.application_id #=> String
|
8678
|
+
# resp.message_response.endpoint_result #=> Hash
|
8679
|
+
# resp.message_response.endpoint_result["__string"].address #=> String
|
8680
|
+
# resp.message_response.endpoint_result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8681
|
+
# resp.message_response.endpoint_result["__string"].message_id #=> String
|
8682
|
+
# resp.message_response.endpoint_result["__string"].status_code #=> Integer
|
8683
|
+
# resp.message_response.endpoint_result["__string"].status_message #=> String
|
8684
|
+
# resp.message_response.endpoint_result["__string"].updated_token #=> String
|
8685
|
+
# resp.message_response.request_id #=> String
|
8686
|
+
# resp.message_response.result #=> Hash
|
8687
|
+
# resp.message_response.result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
|
8688
|
+
# resp.message_response.result["__string"].message_id #=> String
|
8689
|
+
# resp.message_response.result["__string"].status_code #=> Integer
|
8690
|
+
# resp.message_response.result["__string"].status_message #=> String
|
8691
|
+
# resp.message_response.result["__string"].updated_token #=> String
|
8692
|
+
#
|
8693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessage AWS API Documentation
|
8694
|
+
#
|
8695
|
+
# @overload send_otp_message(params = {})
|
8696
|
+
# @param [Hash] params ({})
|
8697
|
+
def send_otp_message(params = {}, options = {})
|
8698
|
+
req = build_request(:send_otp_message, params)
|
8699
|
+
req.send_request(options)
|
8700
|
+
end
|
8701
|
+
|
8634
8702
|
# Creates and sends a message to a list of users.
|
8635
8703
|
#
|
8636
8704
|
# @option params [required, String] :application_id
|
@@ -11936,7 +12004,7 @@ module Aws::Pinpoint
|
|
11936
12004
|
params: params,
|
11937
12005
|
config: config)
|
11938
12006
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
11939
|
-
context[:gem_version] = '1.
|
12007
|
+
context[:gem_version] = '1.62.0'
|
11940
12008
|
Seahorse::Client::Request.new(handlers, context)
|
11941
12009
|
end
|
11942
12010
|
|
@@ -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"
|
@@ -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,72 @@ 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
|
+
# @!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
|
+
|
19864
20065
|
# Specifies the status and settings of the voice channel for an
|
19865
20066
|
# application.
|
19866
20067
|
#
|
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.62.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-30 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
|