aws-sdk-pinpoint 1.60.0 → 1.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f41f2c83eab05e97f1ec57caee4bbb5d0cdfe4658c09e6327e1bc24c232be2
-  data.tar.gz: c3b313540147d7951e5ed87e429bed54649146e77d5c7fcddeeb5b3d29682e9d
+  metadata.gz: 554a7270be976f8cf524196593a0e34b6af030a99da5794c5a97a765912131e6
+  data.tar.gz: 149ca183170cdd9f9de34375bca3694f62c1d9ac5d6a6d14b75b77b175e077c6
 SHA512:
-  metadata.gz: bdd2cef666f1558e87952290868086c24cc4863de3d7f7f8311126691cee701768f8100d659ee04629fb67bace5eb0e247751b13e6a529dd42fb7e6e0a04f3b4
-  data.tar.gz: e3ab10ed7b155452566eaa0fd0800e1bed6649bf4606a3f9c2ade3ab326541125df28c49b0f3e4f37f1d170b40a96989430f4bd66f15d8cad5fd7d5e1f1c5bf4
+  metadata.gz: 03f79660a87d1a01b0936e3ed44cbcb308c20cfcb9467a450561c5982be6d882d7a0a7c20325d6df79b95354f23304795ef14f99bf1b3cfe89a226a3db26119c
+  data.tar.gz: a0be23480ea10ef14e82e9a8289fc237152314f4655449b1647973164345dfce5fbe60794e32d8bd7b0ac38748f80ca3858ba1e6b4d64aa705d04510b298b753

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.61.0 (2021-11-26)
+------------------
+
+* 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
+
 1.60.0 (2021-11-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.60.0
+1.61.0

data/lib/aws-sdk-pinpoint/client.rb

@@ -8640,6 +8640,63 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
+    # Send an OTP message
+    #
+    # @option params [required, String] :application_id
+    #
+    # @option params [required, Types::SendOTPMessageRequestParameters] :send_otp_message_request_parameters
+    #   Send OTP message request parameters.
+    #
+    # @return [Types::SendOTPMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SendOTPMessageResponse#message_response #message_response} => Types::MessageResponse
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.send_otp_message({
+    #     application_id: "__string", # required
+    #     send_otp_message_request_parameters: { # required
+    #       allowed_attempts: 1,
+    #       brand_name: "__string", # required
+    #       channel: "__string", # required
+    #       code_length: 1,
+    #       destination_identity: "__string", # required
+    #       entity_id: "__string",
+    #       language: "__string",
+    #       origination_identity: "__string", # required
+    #       reference_id: "__string", # required
+    #       template_id: "__string",
+    #       validity_period: 1,
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.message_response.application_id #=> String
+    #   resp.message_response.endpoint_result #=> Hash
+    #   resp.message_response.endpoint_result["__string"].address #=> String
+    #   resp.message_response.endpoint_result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
+    #   resp.message_response.endpoint_result["__string"].message_id #=> String
+    #   resp.message_response.endpoint_result["__string"].status_code #=> Integer
+    #   resp.message_response.endpoint_result["__string"].status_message #=> String
+    #   resp.message_response.endpoint_result["__string"].updated_token #=> String
+    #   resp.message_response.request_id #=> String
+    #   resp.message_response.result #=> Hash
+    #   resp.message_response.result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
+    #   resp.message_response.result["__string"].message_id #=> String
+    #   resp.message_response.result["__string"].status_code #=> Integer
+    #   resp.message_response.result["__string"].status_message #=> String
+    #   resp.message_response.result["__string"].updated_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessage AWS API Documentation
+    #
+    # @overload send_otp_message(params = {})
+    # @param [Hash] params ({})
+    def send_otp_message(params = {}, options = {})
+      req = build_request(:send_otp_message, params)
+      req.send_request(options)
+    end
+
     # Creates and sends a message to a list of users.
     #
     # @option params [required, String] :application_id
@@ -11945,7 +12002,7 @@ module Aws::Pinpoint
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-pinpoint'
-      context[:gem_version] = '1.60.0'
+      context[:gem_version] = '1.61.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-pinpoint/client_api.rb

@@ -425,6 +425,9 @@ module Aws::Pinpoint
     SegmentsResponse = Shapes::StructureShape.new(name: 'SegmentsResponse')
     SendMessagesRequest = Shapes::StructureShape.new(name: 'SendMessagesRequest')
     SendMessagesResponse = Shapes::StructureShape.new(name: 'SendMessagesResponse')
+    SendOTPMessageRequest = Shapes::StructureShape.new(name: 'SendOTPMessageRequest')
+    SendOTPMessageRequestParameters = Shapes::StructureShape.new(name: 'SendOTPMessageRequestParameters')
+    SendOTPMessageResponse = Shapes::StructureShape.new(name: 'SendOTPMessageResponse')
     SendUsersMessageRequest = Shapes::StructureShape.new(name: 'SendUsersMessageRequest')
     SendUsersMessageResponse = Shapes::StructureShape.new(name: 'SendUsersMessageResponse')
     SendUsersMessagesRequest = Shapes::StructureShape.new(name: 'SendUsersMessagesRequest')
@@ -502,6 +505,10 @@ module Aws::Pinpoint
     UpdateVoiceChannelResponse = Shapes::StructureShape.new(name: 'UpdateVoiceChannelResponse')
     UpdateVoiceTemplateRequest = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateRequest')
     UpdateVoiceTemplateResponse = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateResponse')
+    VerificationResponse = Shapes::StructureShape.new(name: 'VerificationResponse')
+    VerifyOTPMessageRequest = Shapes::StructureShape.new(name: 'VerifyOTPMessageRequest')
+    VerifyOTPMessageRequestParameters = Shapes::StructureShape.new(name: 'VerifyOTPMessageRequestParameters')
+    VerifyOTPMessageResponse = Shapes::StructureShape.new(name: 'VerifyOTPMessageResponse')
     VoiceChannelRequest = Shapes::StructureShape.new(name: 'VoiceChannelRequest')
     VoiceChannelResponse = Shapes::StructureShape.new(name: 'VoiceChannelResponse')
     VoiceMessage = Shapes::StructureShape.new(name: 'VoiceMessage')
@@ -2756,6 +2763,30 @@ module Aws::Pinpoint
     SendMessagesResponse[:payload] = :message_response
     SendMessagesResponse[:payload_member] = SendMessagesResponse.member(:message_response)
 
+    SendOTPMessageRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
+    SendOTPMessageRequest.add_member(:send_otp_message_request_parameters, Shapes::ShapeRef.new(shape: SendOTPMessageRequestParameters, required: true, location_name: "SendOTPMessageRequestParameters"))
+    SendOTPMessageRequest.struct_class = Types::SendOTPMessageRequest
+    SendOTPMessageRequest[:payload] = :send_otp_message_request_parameters
+    SendOTPMessageRequest[:payload_member] = SendOTPMessageRequest.member(:send_otp_message_request_parameters)
+
+    SendOTPMessageRequestParameters.add_member(:allowed_attempts, Shapes::ShapeRef.new(shape: __integer, location_name: "AllowedAttempts"))
+    SendOTPMessageRequestParameters.add_member(:brand_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "BrandName"))
+    SendOTPMessageRequestParameters.add_member(:channel, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Channel"))
+    SendOTPMessageRequestParameters.add_member(:code_length, Shapes::ShapeRef.new(shape: __integer, location_name: "CodeLength"))
+    SendOTPMessageRequestParameters.add_member(:destination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DestinationIdentity"))
+    SendOTPMessageRequestParameters.add_member(:entity_id, Shapes::ShapeRef.new(shape: __string, location_name: "EntityId"))
+    SendOTPMessageRequestParameters.add_member(:language, Shapes::ShapeRef.new(shape: __string, location_name: "Language"))
+    SendOTPMessageRequestParameters.add_member(:origination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "OriginationIdentity"))
+    SendOTPMessageRequestParameters.add_member(:reference_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ReferenceId"))
+    SendOTPMessageRequestParameters.add_member(:template_id, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateId"))
+    SendOTPMessageRequestParameters.add_member(:validity_period, Shapes::ShapeRef.new(shape: __integer, location_name: "ValidityPeriod"))
+    SendOTPMessageRequestParameters.struct_class = Types::SendOTPMessageRequestParameters
+
+    SendOTPMessageResponse.add_member(:message_response, Shapes::ShapeRef.new(shape: MessageResponse, required: true, location_name: "MessageResponse"))
+    SendOTPMessageResponse.struct_class = Types::SendOTPMessageResponse
+    SendOTPMessageResponse[:payload] = :message_response
+    SendOTPMessageResponse[:payload_member] = SendOTPMessageResponse.member(:message_response)
+
     SendUsersMessageRequest.add_member(:context, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "Context"))
     SendUsersMessageRequest.add_member(:message_configuration, Shapes::ShapeRef.new(shape: DirectMessageConfiguration, required: true, location_name: "MessageConfiguration"))
     SendUsersMessageRequest.add_member(:template_configuration, Shapes::ShapeRef.new(shape: TemplateConfiguration, location_name: "TemplateConfiguration"))
@@ -3178,6 +3209,25 @@ module Aws::Pinpoint
     UpdateVoiceTemplateResponse[:payload] = :message_body
     UpdateVoiceTemplateResponse[:payload_member] = UpdateVoiceTemplateResponse.member(:message_body)
 
+    VerificationResponse.add_member(:valid, Shapes::ShapeRef.new(shape: __boolean, location_name: "Valid"))
+    VerificationResponse.struct_class = Types::VerificationResponse
+
+    VerifyOTPMessageRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
+    VerifyOTPMessageRequest.add_member(:verify_otp_message_request_parameters, Shapes::ShapeRef.new(shape: VerifyOTPMessageRequestParameters, required: true, location_name: "VerifyOTPMessageRequestParameters"))
+    VerifyOTPMessageRequest.struct_class = Types::VerifyOTPMessageRequest
+    VerifyOTPMessageRequest[:payload] = :verify_otp_message_request_parameters
+    VerifyOTPMessageRequest[:payload_member] = VerifyOTPMessageRequest.member(:verify_otp_message_request_parameters)
+
+    VerifyOTPMessageRequestParameters.add_member(:destination_identity, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DestinationIdentity"))
+    VerifyOTPMessageRequestParameters.add_member(:otp, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Otp"))
+    VerifyOTPMessageRequestParameters.add_member(:reference_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ReferenceId"))
+    VerifyOTPMessageRequestParameters.struct_class = Types::VerifyOTPMessageRequestParameters
+
+    VerifyOTPMessageResponse.add_member(:verification_response, Shapes::ShapeRef.new(shape: VerificationResponse, required: true, location_name: "VerificationResponse"))
+    VerifyOTPMessageResponse.struct_class = Types::VerifyOTPMessageResponse
+    VerifyOTPMessageResponse[:payload] = :verification_response
+    VerifyOTPMessageResponse[:payload_member] = VerifyOTPMessageResponse.member(:verification_response)
+
     VoiceChannelRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
     VoiceChannelRequest.struct_class = Types::VoiceChannelRequest
 
@@ -4640,6 +4690,21 @@ module Aws::Pinpoint
         o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
       end)
 
+      api.add_operation(:send_otp_message, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "SendOTPMessage"
+        o.http_method = "POST"
+        o.http_request_uri = "/v1/apps/{application-id}/otp"
+        o.input = Shapes::ShapeRef.new(shape: SendOTPMessageRequest)
+        o.output = Shapes::ShapeRef.new(shape: SendOTPMessageResponse)
+        o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
+        o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
+        o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
+        o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+      end)
+
       api.add_operation(:send_users_messages, Seahorse::Model::Operation.new.tap do |o|
         o.name = "SendUsersMessages"
         o.http_method = "POST"

data/lib/aws-sdk-pinpoint/types.rb

@@ -16109,6 +16109,141 @@ module Aws::Pinpoint
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass SendOTPMessageRequest
+    #   data as a hash:
+    #
+    #       {
+    #         application_id: "__string", # required
+    #         send_otp_message_request_parameters: { # required
+    #           allowed_attempts: 1,
+    #           brand_name: "__string", # required
+    #           channel: "__string", # required
+    #           code_length: 1,
+    #           destination_identity: "__string", # required
+    #           entity_id: "__string",
+    #           language: "__string",
+    #           origination_identity: "__string", # required
+    #           reference_id: "__string", # required
+    #           template_id: "__string",
+    #           validity_period: 1,
+    #         },
+    #       }
+    #
+    # @!attribute [rw] application_id
+    #   @return [String]
+    #
+    # @!attribute [rw] send_otp_message_request_parameters
+    #   Send OTP message request parameters.
+    #   @return [Types::SendOTPMessageRequestParameters]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageRequest AWS API Documentation
+    #
+    class SendOTPMessageRequest < Struct.new(
+      :application_id,
+      :send_otp_message_request_parameters)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Send OTP message request parameters.
+    #
+    # @note When making an API call, you may pass SendOTPMessageRequestParameters
+    #   data as a hash:
+    #
+    #       {
+    #         allowed_attempts: 1,
+    #         brand_name: "__string", # required
+    #         channel: "__string", # required
+    #         code_length: 1,
+    #         destination_identity: "__string", # required
+    #         entity_id: "__string",
+    #         language: "__string",
+    #         origination_identity: "__string", # required
+    #         reference_id: "__string", # required
+    #         template_id: "__string",
+    #         validity_period: 1,
+    #       }
+    #
+    # @!attribute [rw] allowed_attempts
+    #   The attempts allowed to validate an OTP.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] brand_name
+    #   The brand name that will be substituted into the OTP message body.
+    #   Should be owned by calling AWS account.
+    #   @return [String]
+    #
+    # @!attribute [rw] channel
+    #   Channel type for the OTP message. Supported values: \[SMS\].
+    #   @return [String]
+    #
+    # @!attribute [rw] code_length
+    #   The number of characters in the generated OTP.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] destination_identity
+    #   The destination identity to send OTP to.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_id
+    #   A unique Entity ID received from DLT after entity registration is
+    #   approved.
+    #   @return [String]
+    #
+    # @!attribute [rw] language
+    #   The language to be used for the outgoing message body containing the
+    #   OTP.
+    #   @return [String]
+    #
+    # @!attribute [rw] origination_identity
+    #   The origination identity used to send OTP from.
+    #   @return [String]
+    #
+    # @!attribute [rw] reference_id
+    #   Developer-specified reference identifier. Required to match during
+    #   OTP verification.
+    #   @return [String]
+    #
+    # @!attribute [rw] template_id
+    #   A unique Template ID received from DLT after entity registration is
+    #   approved.
+    #   @return [String]
+    #
+    # @!attribute [rw] validity_period
+    #   The time in minutes before the OTP is no longer valid.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageRequestParameters AWS API Documentation
+    #
+    class SendOTPMessageRequestParameters < Struct.new(
+      :allowed_attempts,
+      :brand_name,
+      :channel,
+      :code_length,
+      :destination_identity,
+      :entity_id,
+      :language,
+      :origination_identity,
+      :reference_id,
+      :template_id,
+      :validity_period)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] message_response
+    #   Provides information about the results of a request to send a
+    #   message to an endpoint address.
+    #   @return [Types::MessageResponse]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessageResponse AWS API Documentation
+    #
+    class SendOTPMessageResponse < Struct.new(
+      :message_response)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the configuration and other settings for a message to send
     # to all the endpoints that are associated with a list of users.
     #
@@ -19861,6 +19996,72 @@ module Aws::Pinpoint
       include Aws::Structure
     end
 
+    # Verify OTP Message Response.
+    #
+    # @!attribute [rw] valid
+    #   Specifies whether the OTP is valid or not.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerificationResponse AWS API Documentation
+    #
+    class VerificationResponse < Struct.new(
+      :valid)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] application_id
+    #   @return [String]
+    #
+    # @!attribute [rw] verify_otp_message_request_parameters
+    #   Verify OTP message request.
+    #   @return [Types::VerifyOTPMessageRequestParameters]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequest AWS API Documentation
+    #
+    class VerifyOTPMessageRequest < Struct.new(
+      :application_id,
+      :verify_otp_message_request_parameters)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Verify OTP message request.
+    #
+    # @!attribute [rw] destination_identity
+    #   The destination identity to send OTP to.
+    #   @return [String]
+    #
+    # @!attribute [rw] otp
+    #   The OTP the end user provided for verification.
+    #   @return [String]
+    #
+    # @!attribute [rw] reference_id
+    #   The reference identifier provided when the OTP was previously sent.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageRequestParameters AWS API Documentation
+    #
+    class VerifyOTPMessageRequestParameters < Struct.new(
+      :destination_identity,
+      :otp,
+      :reference_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] verification_response
+    #   Verify OTP Message Response.
+    #   @return [Types::VerificationResponse]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessageResponse AWS API Documentation
+    #
+    class VerifyOTPMessageResponse < Struct.new(
+      :verification_response)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the status and settings of the voice channel for an
     # application.
     #

data/lib/aws-sdk-pinpoint.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-pinpoint/customizations'
 # @!group service
 module Aws::Pinpoint
 
-  GEM_VERSION = '1.60.0'
+  GEM_VERSION = '1.61.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pinpoint
 version: !ruby/object:Gem::Version
-  version: 1.60.0
+  version: 1.61.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core