aws-sdk-pinpointsmsvoicev2 1.64.0 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08e85f46298f4357881ef3291fc0d525aa7edf19655ca4814e910da1f9a28d5
-  data.tar.gz: 780ba76efa0cd65ba9fa37f15d1eb3352f10e9e431400ddcc1b5d3fcac9a7f21
+  metadata.gz: 13f6d9b33cdb464488019d363f5776b37f043673c0d427424c1e0c3954b6a7e7
+  data.tar.gz: 3c3acecfdd106495d3e9c9c079aef708aeee78c6d2a726a7dc34d0a6b4412381
 SHA512:
-  metadata.gz: 29bba2d6d922f8df20282ff8f9a31d8836b94d748fe3b98a8440df9410bfc83d2ff2d48d994c7db40a336ae1faf0ff6cd5a628398de870a89ea8ca902a684096
-  data.tar.gz: a2bbd9dfa5b0b310da601f19d0ffcac445948a4780b4d7856309ed091e7298dc0e5a19fa5fbcade1381099ab965a5051d3bf64c9a216e4f17416d22778c614a8
+  metadata.gz: e411b72485d809d2e9385d48a387cd3fae711a067fd66af3f63b93b437594122aad252987ffbbe458b5792c299f185223f4a2b026bd477b66028c65e54f7b658
+  data.tar.gz: 060f94e34acf6ccb34e7fd7c3de144f0524d7908939eed9c68252fc9203628d9c7c2f9c53cbd8b35a5503f470059204ad2581e3b7486b91835897191673a889f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.65.0 (2026-10-02)
+------------------
+
+* Feature - AWS End User Messaging SMS CarrierLookup API now supports phone number cleansing on customer opt-in. when selected, the response includes the additional field "OriginalPhoneNumber". It can also return additional PhoneNumberType enums, VOIP and PREPAID.
+
 1.64.0 (2026-09-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.64.0
+1.65.0

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

@@ -614,6 +614,14 @@ module Aws::PinpointSMSVoiceV2
     #   and commas. The service automatically converts the input to E164
     #   format for processing.
     #
+    # @option params [Boolean] :enable_cleansing
+    #   Specifies whether the service cleanses the phone number that you
+    #   provide. When set to `true`, the service normalizes the phone number
+    #   according to the destination country's national numbering plan and
+    #   dialing rules. The service returns the cleansed number in E.164 format
+    #   in the `E164PhoneNumber` field and returns the number that you
+    #   provided in the `OriginalPhoneNumber` field.
+    #
     # @return [Types::CarrierLookupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CarrierLookupResult#e164_phone_number #e164_phone_number} => String
@@ -624,6 +632,7 @@ module Aws::PinpointSMSVoiceV2
     #   * {Types::CarrierLookupResult#mnc #mnc} => String
     #   * {Types::CarrierLookupResult#carrier #carrier} => String
     #   * {Types::CarrierLookupResult#phone_number_type #phone_number_type} => String
+    #   * {Types::CarrierLookupResult#original_phone_number #original_phone_number} => String
     #
     #
     # @example Example: Use CarrierLookup
@@ -651,6 +660,7 @@ module Aws::PinpointSMSVoiceV2
     #
     #   resp = client.carrier_lookup({
     #     phone_number: "CarrierLookupInputPhoneNumberType", # required
+    #     enable_cleansing: false,
     #   })
     #
     # @example Response structure
@@ -662,7 +672,8 @@ module Aws::PinpointSMSVoiceV2
     #   resp.mcc #=> String
     #   resp.mnc #=> String
     #   resp.carrier #=> String
-    #   resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "OTHER", "INVALID"
+    #   resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "VOIP", "PREPAID", "OTHER", "INVALID"
+    #   resp.original_phone_number #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookup AWS API Documentation
     #
@@ -4594,11 +4605,14 @@ module Aws::PinpointSMSVoiceV2
       req.send_request(options)
     end
 
-    # Search available phone numbers from aggregator inventory, optionally
-    # filtered by pattern. If NumberPreference is omitted, returns
-    # unfiltered available numbers. Returns empty list (not an exception)
-    # when no numbers match. ResourceNotFoundException is thrown only for
-    # invalid RegistrationId (campaign not found).
+    # Retrieves a list of phone numbers that are available to request, based
+    # on the country, capabilities, and number type that you specify. You
+    # can optionally provide a number preference to return only numbers that
+    # match a specific digit pattern.
+    #
+    # If no numbers match your search, this operation returns an empty list
+    # rather than an error. This operation currently supports only `TEN_DLC`
+    # number types in the `US`.
     #
     # @option params [required, String] :iso_country_code
     #   The two-character code, in ISO 3166-1 alpha-2 format, for the country
@@ -4621,8 +4635,11 @@ module Aws::PinpointSMSVoiceV2
     #   * The Amazon Resource Name (ARN) of the registration.
     #
     # @option params [Array<Types::NumberPreferenceItem>] :number_preference
-    #   Optional. If omitted, returns unfiltered available numbers. Max 1
-    #   element for List API.
+    #   An optional selection preference used to return only phone numbers
+    #   that match a specific digit pattern, such as numbers that start with,
+    #   end with, or contain a particular sequence. You can specify at most
+    #   one preference. Number preferences apply only to `TEN_DLC` numbers in
+    #   the `US`.
     #
     # @option params [String] :next_token
     #   The token returned from a previous request to retrieve the next page
@@ -7808,7 +7825,7 @@ module Aws::PinpointSMSVoiceV2
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
-      context[:gem_version] = '1.64.0'
+      context[:gem_version] = '1.65.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -667,6 +667,7 @@ module Aws::PinpointSMSVoiceV2
     AvailablePhoneNumberList.member = Shapes::ShapeRef.new(shape: PhoneNumber)
 
     CarrierLookupRequest.add_member(:phone_number, Shapes::ShapeRef.new(shape: CarrierLookupInputPhoneNumberType, required: true, location_name: "PhoneNumber"))
+    CarrierLookupRequest.add_member(:enable_cleansing, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableCleansing"))
     CarrierLookupRequest.struct_class = Types::CarrierLookupRequest
 
     CarrierLookupResult.add_member(:e164_phone_number, Shapes::ShapeRef.new(shape: E164PhoneNumberType, required: true, location_name: "E164PhoneNumber"))
@@ -677,6 +678,7 @@ module Aws::PinpointSMSVoiceV2
     CarrierLookupResult.add_member(:mnc, Shapes::ShapeRef.new(shape: MNCType, location_name: "MNC"))
     CarrierLookupResult.add_member(:carrier, Shapes::ShapeRef.new(shape: String, location_name: "Carrier"))
     CarrierLookupResult.add_member(:phone_number_type, Shapes::ShapeRef.new(shape: PhoneNumberType, required: true, location_name: "PhoneNumberType"))
+    CarrierLookupResult.add_member(:original_phone_number, Shapes::ShapeRef.new(shape: CarrierLookupInputPhoneNumberType, location_name: "OriginalPhoneNumber"))
     CarrierLookupResult.struct_class = Types::CarrierLookupResult
 
     CarrierStatusInformation.add_member(:carrier_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "CarrierName"))

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

@@ -214,10 +214,20 @@ module Aws::PinpointSMSVoiceV2
     #   format for processing.
     #   @return [String]
     #
+    # @!attribute [rw] enable_cleansing
+    #   Specifies whether the service cleanses the phone number that you
+    #   provide. When set to `true`, the service normalizes the phone number
+    #   according to the destination country's national numbering plan and
+    #   dialing rules. The service returns the cleansed number in E.164
+    #   format in the `E164PhoneNumber` field and returns the number that
+    #   you provided in the `OriginalPhoneNumber` field.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookupRequest AWS API Documentation
     #
     class CarrierLookupRequest < Struct.new(
-      :phone_number)
+      :phone_number,
+      :enable_cleansing)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -259,9 +269,16 @@ module Aws::PinpointSMSVoiceV2
     #
     # @!attribute [rw] phone_number_type
     #   Describes the type of phone number. Valid values are: MOBILE,
-    #   LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to
-    #   INVALID phone numbers, as these numbers are unlikely to belong to
-    #   actual recipients.
+    #   LANDLINE, VOIP, PREPAID, OTHER, and INVALID. Avoid sending SMS or
+    #   voice messages to INVALID phone numbers, as these numbers are
+    #   unlikely to belong to actual recipients.
+    #   @return [String]
+    #
+    # @!attribute [rw] original_phone_number
+    #   The phone number exactly as you supplied it in the request. This
+    #   field is returned only when you set `EnableCleansing` to `true`, the
+    #   phone number was cleansed, and a normalized E.164 phone number was
+    #   returned in the `E164PhoneNumber` field.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookupResult AWS API Documentation
@@ -274,7 +291,8 @@ module Aws::PinpointSMSVoiceV2
       :mcc,
       :mnc,
       :carrier,
-      :phone_number_type)
+      :phone_number_type,
+      :original_phone_number)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4618,8 +4636,11 @@ module Aws::PinpointSMSVoiceV2
     #   @return [String]
     #
     # @!attribute [rw] number_preference
-    #   Optional. If omitted, returns unfiltered available numbers. Max 1
-    #   element for List API.
+    #   An optional selection preference used to return only phone numbers
+    #   that match a specific digit pattern, such as numbers that start
+    #   with, end with, or contain a particular sequence. You can specify at
+    #   most one preference. Number preferences apply only to `TEN_DLC`
+    #   numbers in the `US`.
     #   @return [Array<Types::NumberPreferenceItem>]
     #
     # @!attribute [rw] next_token
@@ -5200,8 +5221,9 @@ module Aws::PinpointSMSVoiceV2
       include Aws::Structure
     end
 
-    # A single number preference — specifies a pattern type and filter
-    # value.
+    # A single number preference that specifies how to match available phone
+    # numbers. Each preference pairs a match type with one or more filter
+    # values.
     #
     # @!attribute [rw] preference_type
     #   The type of match to apply to the filter values.

data/lib/aws-sdk-pinpointsmsvoicev2.rb

@@ -55,7 +55,7 @@ module Aws::PinpointSMSVoiceV2
   autoload :EndpointProvider, 'aws-sdk-pinpointsmsvoicev2/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-pinpointsmsvoicev2/endpoints'
 
-  GEM_VERSION = '1.64.0'
+  GEM_VERSION = '1.65.0'
 
 end
 

data/sig/client.rbs

@@ -119,11 +119,13 @@ module Aws
         def mcc: () -> ::String
         def mnc: () -> ::String
         def carrier: () -> ::String
-        def phone_number_type: () -> ("MOBILE" | "LANDLINE" | "OTHER" | "INVALID")
+        def phone_number_type: () -> ("MOBILE" | "LANDLINE" | "VOIP" | "PREPAID" | "OTHER" | "INVALID")
+        def original_phone_number: () -> ::String
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#carrier_lookup-instance_method
       def carrier_lookup: (
-                            phone_number: ::String
+                            phone_number: ::String,
+                            ?enable_cleansing: bool
                           ) -> _CarrierLookupResponseSuccess
                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CarrierLookupResponseSuccess
 

data/sig/types.rbs

@@ -60,6 +60,7 @@ module Aws::PinpointSMSVoiceV2
 
     class CarrierLookupRequest
       attr_accessor phone_number: ::String
+      attr_accessor enable_cleansing: bool
       SENSITIVE: []
     end
 
@@ -71,7 +72,8 @@ module Aws::PinpointSMSVoiceV2
       attr_accessor mcc: ::String
       attr_accessor mnc: ::String
       attr_accessor carrier: ::String
-      attr_accessor phone_number_type: ("MOBILE" | "LANDLINE" | "OTHER" | "INVALID")
+      attr_accessor phone_number_type: ("MOBILE" | "LANDLINE" | "VOIP" | "PREPAID" | "OTHER" | "INVALID")
+      attr_accessor original_phone_number: ::String
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pinpointsmsvoicev2
 version: !ruby/object:Gem::Version
-  version: 1.64.0
+  version: 1.65.0
 platform: ruby
 authors:
 - Amazon Web Services