aws-sdk-pinpointsmsvoicev2 1.64.0 → 1.66.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f08e85f46298f4357881ef3291fc0d525aa7edf19655ca4814e910da1f9a28d5
4
- data.tar.gz: 780ba76efa0cd65ba9fa37f15d1eb3352f10e9e431400ddcc1b5d3fcac9a7f21
3
+ metadata.gz: 1ed631a138ca81f062a9740725f028b1d43300cc8f3beef063e9082e1a5daaa1
4
+ data.tar.gz: 624eb905693c12d3d1f8b6321e077aada484ea1b701c85246a07eb9ee2c4c40b
5
5
  SHA512:
6
- metadata.gz: 29bba2d6d922f8df20282ff8f9a31d8836b94d748fe3b98a8440df9410bfc83d2ff2d48d994c7db40a336ae1faf0ff6cd5a628398de870a89ea8ca902a684096
7
- data.tar.gz: a2bbd9dfa5b0b310da601f19d0ffcac445948a4780b4d7856309ed091e7298dc0e5a19fa5fbcade1381099ab965a5051d3bf64c9a216e4f17416d22778c614a8
6
+ metadata.gz: 39713fbdb40988fbc0bfa48e234ecf105589be60c6943c4d78e90dd50cfba3333ba1fcd6c51ef0a8df3981f65a4ace184c92e6abe77de9f27e63cb15f6805f55
7
+ data.tar.gz: 9daa3f8941307f005eab2a0e645194ccb03536a25b4fa9e5c9702e1fe827e0527d7272f28f792e34ca90a98d056d97dc4d63ca339a5e070165e976b7cf3f7d30
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.66.0 (2026-10-12)
5
+ ------------------
6
+
7
+ * Feature - DescribePhoneNumbers and DescribeSenderIds now return an optional PricingTier field that indicates whether a phone number, sender ID, short code, or long code is classified as Domestic or International, enabling customers to identify origination identities eligible for local pricing.
8
+
9
+ 1.65.0 (2026-10-02)
10
+ ------------------
11
+
12
+ * 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.
13
+
4
14
  1.64.0 (2026-09-11)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.64.0
1
+ 1.66.0
@@ -614,6 +614,14 @@ module Aws::PinpointSMSVoiceV2
614
614
  # and commas. The service automatically converts the input to E164
615
615
  # format for processing.
616
616
  #
617
+ # @option params [Boolean] :enable_cleansing
618
+ # Specifies whether the service cleanses the phone number that you
619
+ # provide. When set to `true`, the service normalizes the phone number
620
+ # according to the destination country's national numbering plan and
621
+ # dialing rules. The service returns the cleansed number in E.164 format
622
+ # in the `E164PhoneNumber` field and returns the number that you
623
+ # provided in the `OriginalPhoneNumber` field.
624
+ #
617
625
  # @return [Types::CarrierLookupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
618
626
  #
619
627
  # * {Types::CarrierLookupResult#e164_phone_number #e164_phone_number} => String
@@ -624,6 +632,7 @@ module Aws::PinpointSMSVoiceV2
624
632
  # * {Types::CarrierLookupResult#mnc #mnc} => String
625
633
  # * {Types::CarrierLookupResult#carrier #carrier} => String
626
634
  # * {Types::CarrierLookupResult#phone_number_type #phone_number_type} => String
635
+ # * {Types::CarrierLookupResult#original_phone_number #original_phone_number} => String
627
636
  #
628
637
  #
629
638
  # @example Example: Use CarrierLookup
@@ -651,6 +660,7 @@ module Aws::PinpointSMSVoiceV2
651
660
  #
652
661
  # resp = client.carrier_lookup({
653
662
  # phone_number: "CarrierLookupInputPhoneNumberType", # required
663
+ # enable_cleansing: false,
654
664
  # })
655
665
  #
656
666
  # @example Response structure
@@ -662,7 +672,8 @@ module Aws::PinpointSMSVoiceV2
662
672
  # resp.mcc #=> String
663
673
  # resp.mnc #=> String
664
674
  # resp.carrier #=> String
665
- # resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "OTHER", "INVALID"
675
+ # resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "VOIP", "PREPAID", "OTHER", "INVALID"
676
+ # resp.original_phone_number #=> String
666
677
  #
667
678
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookup AWS API Documentation
668
679
  #
@@ -3387,6 +3398,7 @@ module Aws::PinpointSMSVoiceV2
3387
3398
  # resp.phone_numbers[0].messaging_limits.rate_limits["String"] #=> Integer
3388
3399
  # resp.phone_numbers[0].messaging_limits.daily_message_caps #=> Hash
3389
3400
  # resp.phone_numbers[0].messaging_limits.daily_message_caps["String"] #=> Integer
3401
+ # resp.phone_numbers[0].pricing_tier #=> String
3390
3402
  # resp.phone_numbers[0].created_timestamp #=> Time
3391
3403
  # resp.next_token #=> String
3392
3404
  #
@@ -4241,6 +4253,7 @@ module Aws::PinpointSMSVoiceV2
4241
4253
  # resp.sender_ids[0].messaging_limits.rate_limits["String"] #=> Integer
4242
4254
  # resp.sender_ids[0].messaging_limits.daily_message_caps #=> Hash
4243
4255
  # resp.sender_ids[0].messaging_limits.daily_message_caps["String"] #=> Integer
4256
+ # resp.sender_ids[0].pricing_tier #=> String
4244
4257
  # resp.next_token #=> String
4245
4258
  #
4246
4259
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIds AWS API Documentation
@@ -4594,11 +4607,14 @@ module Aws::PinpointSMSVoiceV2
4594
4607
  req.send_request(options)
4595
4608
  end
4596
4609
 
4597
- # Search available phone numbers from aggregator inventory, optionally
4598
- # filtered by pattern. If NumberPreference is omitted, returns
4599
- # unfiltered available numbers. Returns empty list (not an exception)
4600
- # when no numbers match. ResourceNotFoundException is thrown only for
4601
- # invalid RegistrationId (campaign not found).
4610
+ # Retrieves a list of phone numbers that are available to request, based
4611
+ # on the country, capabilities, and number type that you specify. You
4612
+ # can optionally provide a number preference to return only numbers that
4613
+ # match a specific digit pattern.
4614
+ #
4615
+ # If no numbers match your search, this operation returns an empty list
4616
+ # rather than an error. This operation currently supports only `TEN_DLC`
4617
+ # number types in the `US`.
4602
4618
  #
4603
4619
  # @option params [required, String] :iso_country_code
4604
4620
  # The two-character code, in ISO 3166-1 alpha-2 format, for the country
@@ -4621,8 +4637,11 @@ module Aws::PinpointSMSVoiceV2
4621
4637
  # * The Amazon Resource Name (ARN) of the registration.
4622
4638
  #
4623
4639
  # @option params [Array<Types::NumberPreferenceItem>] :number_preference
4624
- # Optional. If omitted, returns unfiltered available numbers. Max 1
4625
- # element for List API.
4640
+ # An optional selection preference used to return only phone numbers
4641
+ # that match a specific digit pattern, such as numbers that start with,
4642
+ # end with, or contain a particular sequence. You can specify at most
4643
+ # one preference. Number preferences apply only to `TEN_DLC` numbers in
4644
+ # the `US`.
4626
4645
  #
4627
4646
  # @option params [String] :next_token
4628
4647
  # The token returned from a previous request to retrieve the next page
@@ -7808,7 +7827,7 @@ module Aws::PinpointSMSVoiceV2
7808
7827
  tracer: tracer
7809
7828
  )
7810
7829
  context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
7811
- context[:gem_version] = '1.64.0'
7830
+ context[:gem_version] = '1.66.0'
7812
7831
  Seahorse::Client::Request.new(handlers, context)
7813
7832
  end
7814
7833
 
@@ -667,6 +667,7 @@ module Aws::PinpointSMSVoiceV2
667
667
  AvailablePhoneNumberList.member = Shapes::ShapeRef.new(shape: PhoneNumber)
668
668
 
669
669
  CarrierLookupRequest.add_member(:phone_number, Shapes::ShapeRef.new(shape: CarrierLookupInputPhoneNumberType, required: true, location_name: "PhoneNumber"))
670
+ CarrierLookupRequest.add_member(:enable_cleansing, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableCleansing"))
670
671
  CarrierLookupRequest.struct_class = Types::CarrierLookupRequest
671
672
 
672
673
  CarrierLookupResult.add_member(:e164_phone_number, Shapes::ShapeRef.new(shape: E164PhoneNumberType, required: true, location_name: "E164PhoneNumber"))
@@ -677,6 +678,7 @@ module Aws::PinpointSMSVoiceV2
677
678
  CarrierLookupResult.add_member(:mnc, Shapes::ShapeRef.new(shape: MNCType, location_name: "MNC"))
678
679
  CarrierLookupResult.add_member(:carrier, Shapes::ShapeRef.new(shape: String, location_name: "Carrier"))
679
680
  CarrierLookupResult.add_member(:phone_number_type, Shapes::ShapeRef.new(shape: PhoneNumberType, required: true, location_name: "PhoneNumberType"))
681
+ CarrierLookupResult.add_member(:original_phone_number, Shapes::ShapeRef.new(shape: CarrierLookupInputPhoneNumberType, location_name: "OriginalPhoneNumber"))
680
682
  CarrierLookupResult.struct_class = Types::CarrierLookupResult
681
683
 
682
684
  CarrierStatusInformation.add_member(:carrier_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "CarrierName"))
@@ -1742,6 +1744,7 @@ module Aws::PinpointSMSVoiceV2
1742
1744
  PhoneNumberInformation.add_member(:pool_id, Shapes::ShapeRef.new(shape: String, location_name: "PoolId"))
1743
1745
  PhoneNumberInformation.add_member(:registration_id, Shapes::ShapeRef.new(shape: String, location_name: "RegistrationId"))
1744
1746
  PhoneNumberInformation.add_member(:messaging_limits, Shapes::ShapeRef.new(shape: MessagingLimits, location_name: "MessagingLimits"))
1747
+ PhoneNumberInformation.add_member(:pricing_tier, Shapes::ShapeRef.new(shape: String, location_name: "PricingTier"))
1745
1748
  PhoneNumberInformation.add_member(:created_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreatedTimestamp"))
1746
1749
  PhoneNumberInformation.struct_class = Types::PhoneNumberInformation
1747
1750
 
@@ -2436,6 +2439,7 @@ module Aws::PinpointSMSVoiceV2
2436
2439
  SenderIdInformation.add_member(:registered, Shapes::ShapeRef.new(shape: PrimitiveBoolean, required: true, location_name: "Registered"))
2437
2440
  SenderIdInformation.add_member(:registration_id, Shapes::ShapeRef.new(shape: String, location_name: "RegistrationId"))
2438
2441
  SenderIdInformation.add_member(:messaging_limits, Shapes::ShapeRef.new(shape: MessagingLimits, location_name: "MessagingLimits"))
2442
+ SenderIdInformation.add_member(:pricing_tier, Shapes::ShapeRef.new(shape: String, location_name: "PricingTier"))
2439
2443
  SenderIdInformation.struct_class = Types::SenderIdInformation
2440
2444
 
2441
2445
  SenderIdInformationList.member = Shapes::ShapeRef.new(shape: SenderIdInformation)
@@ -214,10 +214,20 @@ module Aws::PinpointSMSVoiceV2
214
214
  # format for processing.
215
215
  # @return [String]
216
216
  #
217
+ # @!attribute [rw] enable_cleansing
218
+ # Specifies whether the service cleanses the phone number that you
219
+ # provide. When set to `true`, the service normalizes the phone number
220
+ # according to the destination country's national numbering plan and
221
+ # dialing rules. The service returns the cleansed number in E.164
222
+ # format in the `E164PhoneNumber` field and returns the number that
223
+ # you provided in the `OriginalPhoneNumber` field.
224
+ # @return [Boolean]
225
+ #
217
226
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookupRequest AWS API Documentation
218
227
  #
219
228
  class CarrierLookupRequest < Struct.new(
220
- :phone_number)
229
+ :phone_number,
230
+ :enable_cleansing)
221
231
  SENSITIVE = []
222
232
  include Aws::Structure
223
233
  end
@@ -259,9 +269,16 @@ module Aws::PinpointSMSVoiceV2
259
269
  #
260
270
  # @!attribute [rw] phone_number_type
261
271
  # Describes the type of phone number. Valid values are: MOBILE,
262
- # LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to
263
- # INVALID phone numbers, as these numbers are unlikely to belong to
264
- # actual recipients.
272
+ # LANDLINE, VOIP, PREPAID, OTHER, and INVALID. Avoid sending SMS or
273
+ # voice messages to INVALID phone numbers, as these numbers are
274
+ # unlikely to belong to actual recipients.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] original_phone_number
278
+ # The phone number exactly as you supplied it in the request. This
279
+ # field is returned only when you set `EnableCleansing` to `true`, the
280
+ # phone number was cleansed, and a normalized E.164 phone number was
281
+ # returned in the `E164PhoneNumber` field.
265
282
  # @return [String]
266
283
  #
267
284
  # @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
274
291
  :mcc,
275
292
  :mnc,
276
293
  :carrier,
277
- :phone_number_type)
294
+ :phone_number_type,
295
+ :original_phone_number)
278
296
  SENSITIVE = []
279
297
  include Aws::Structure
280
298
  end
@@ -4618,8 +4636,11 @@ module Aws::PinpointSMSVoiceV2
4618
4636
  # @return [String]
4619
4637
  #
4620
4638
  # @!attribute [rw] number_preference
4621
- # Optional. If omitted, returns unfiltered available numbers. Max 1
4622
- # element for List API.
4639
+ # An optional selection preference used to return only phone numbers
4640
+ # that match a specific digit pattern, such as numbers that start
4641
+ # with, end with, or contain a particular sequence. You can specify at
4642
+ # most one preference. Number preferences apply only to `TEN_DLC`
4643
+ # numbers in the `US`.
4623
4644
  # @return [Array<Types::NumberPreferenceItem>]
4624
4645
  #
4625
4646
  # @!attribute [rw] next_token
@@ -5200,8 +5221,9 @@ module Aws::PinpointSMSVoiceV2
5200
5221
  include Aws::Structure
5201
5222
  end
5202
5223
 
5203
- # A single number preference — specifies a pattern type and filter
5204
- # value.
5224
+ # A single number preference that specifies how to match available phone
5225
+ # numbers. Each preference pairs a match type with one or more filter
5226
+ # values.
5205
5227
  #
5206
5228
  # @!attribute [rw] preference_type
5207
5229
  # The type of match to apply to the filter values.
@@ -5464,6 +5486,10 @@ module Aws::PinpointSMSVoiceV2
5464
5486
  # message caps.
5465
5487
  # @return [Types::MessagingLimits]
5466
5488
  #
5489
+ # @!attribute [rw] pricing_tier
5490
+ # The pricing model.
5491
+ # @return [String]
5492
+ #
5467
5493
  # @!attribute [rw] created_timestamp
5468
5494
  # The time when the phone number was created, in [UNIX epoch time][1]
5469
5495
  # format.
@@ -5495,6 +5521,7 @@ module Aws::PinpointSMSVoiceV2
5495
5521
  :pool_id,
5496
5522
  :registration_id,
5497
5523
  :messaging_limits,
5524
+ :pricing_tier,
5498
5525
  :created_timestamp)
5499
5526
  SENSITIVE = []
5500
5527
  include Aws::Structure
@@ -8907,6 +8934,10 @@ module Aws::PinpointSMSVoiceV2
8907
8934
  # per-capability send rates.
8908
8935
  # @return [Types::MessagingLimits]
8909
8936
  #
8937
+ # @!attribute [rw] pricing_tier
8938
+ # The pricing model.
8939
+ # @return [String]
8940
+ #
8910
8941
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SenderIdInformation AWS API Documentation
8911
8942
  #
8912
8943
  class SenderIdInformation < Struct.new(
@@ -8918,7 +8949,8 @@ module Aws::PinpointSMSVoiceV2
8918
8949
  :deletion_protection_enabled,
8919
8950
  :registered,
8920
8951
  :registration_id,
8921
- :messaging_limits)
8952
+ :messaging_limits,
8953
+ :pricing_tier)
8922
8954
  SENSITIVE = []
8923
8955
  include Aws::Structure
8924
8956
  end
@@ -55,7 +55,7 @@ module Aws::PinpointSMSVoiceV2
55
55
  autoload :EndpointProvider, 'aws-sdk-pinpointsmsvoicev2/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-pinpointsmsvoicev2/endpoints'
57
57
 
58
- GEM_VERSION = '1.64.0'
58
+ GEM_VERSION = '1.66.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -119,11 +119,13 @@ module Aws
119
119
  def mcc: () -> ::String
120
120
  def mnc: () -> ::String
121
121
  def carrier: () -> ::String
122
- def phone_number_type: () -> ("MOBILE" | "LANDLINE" | "OTHER" | "INVALID")
122
+ def phone_number_type: () -> ("MOBILE" | "LANDLINE" | "VOIP" | "PREPAID" | "OTHER" | "INVALID")
123
+ def original_phone_number: () -> ::String
123
124
  end
124
125
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#carrier_lookup-instance_method
125
126
  def carrier_lookup: (
126
- phone_number: ::String
127
+ phone_number: ::String,
128
+ ?enable_cleansing: bool
127
129
  ) -> _CarrierLookupResponseSuccess
128
130
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CarrierLookupResponseSuccess
129
131
 
data/sig/types.rbs CHANGED
@@ -60,6 +60,7 @@ module Aws::PinpointSMSVoiceV2
60
60
 
61
61
  class CarrierLookupRequest
62
62
  attr_accessor phone_number: ::String
63
+ attr_accessor enable_cleansing: bool
63
64
  SENSITIVE: []
64
65
  end
65
66
 
@@ -71,7 +72,8 @@ module Aws::PinpointSMSVoiceV2
71
72
  attr_accessor mcc: ::String
72
73
  attr_accessor mnc: ::String
73
74
  attr_accessor carrier: ::String
74
- attr_accessor phone_number_type: ("MOBILE" | "LANDLINE" | "OTHER" | "INVALID")
75
+ attr_accessor phone_number_type: ("MOBILE" | "LANDLINE" | "VOIP" | "PREPAID" | "OTHER" | "INVALID")
76
+ attr_accessor original_phone_number: ::String
75
77
  SENSITIVE: []
76
78
  end
77
79
 
@@ -1368,6 +1370,7 @@ module Aws::PinpointSMSVoiceV2
1368
1370
  attr_accessor pool_id: ::String
1369
1371
  attr_accessor registration_id: ::String
1370
1372
  attr_accessor messaging_limits: Types::MessagingLimits
1373
+ attr_accessor pricing_tier: ::String
1371
1374
  attr_accessor created_timestamp: ::Time
1372
1375
  SENSITIVE: []
1373
1376
  end
@@ -2167,6 +2170,7 @@ module Aws::PinpointSMSVoiceV2
2167
2170
  attr_accessor registered: bool
2168
2171
  attr_accessor registration_id: ::String
2169
2172
  attr_accessor messaging_limits: Types::MessagingLimits
2173
+ attr_accessor pricing_tier: ::String
2170
2174
  SENSITIVE: []
2171
2175
  end
2172
2176
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-pinpointsmsvoicev2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.64.0
4
+ version: 1.66.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services