twilio-ruby 5.19.0 → 5.77.0

data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,9 +16,9 @@ module Twilio
               ##
               # Initialize the LocalList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
-              #   phone number.
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
+              #   IncomingPhoneNumber resource.
               # @return [LocalList] LocalList
               def initialize(version, account_sid: nil)
                 super(version)
@@ -32,16 +32,15 @@ module Twilio
               # Lists LocalInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
-              #   values are either `true` or `false`. Default is `true`.
-              # @param [String] friendly_name Only show the incoming phone number resources with
-              #   friendly names that exactly match this name.
-              # @param [String] phone_number Only show the incoming phone number resources that
-              #   match this pattern. You can specify partial numbers and use '*' as a wildcard
-              #   for any digit.
-              # @param [String] origin Include phone numbers based on the origin, by default,
-              #   phone numbers of all origin are included. Possible values are either `twilio` or
-              #   `hosted`.
+              # @param [Boolean] beta Whether to include phone numbers new to the Twilio
+              #   platform. Can be: `true` or `false` and the default is `true`.
+              # @param [String] friendly_name A string that identifies the resources to read.
+              # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
+              #   resources to read. You can specify partial numbers and use '*' as a wildcard for
+              #   any digit.
+              # @param [String] origin Whether to include phone numbers based on their origin.
+              #   Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
+              #   included.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -64,16 +63,15 @@ module Twilio
               # Streams LocalInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
-              #   values are either `true` or `false`. Default is `true`.
-              # @param [String] friendly_name Only show the incoming phone number resources with
-              #   friendly names that exactly match this name.
-              # @param [String] phone_number Only show the incoming phone number resources that
-              #   match this pattern. You can specify partial numbers and use '*' as a wildcard
-              #   for any digit.
-              # @param [String] origin Include phone numbers based on the origin, by default,
-              #   phone numbers of all origin are included. Possible values are either `twilio` or
-              #   `hosted`.
+              # @param [Boolean] beta Whether to include phone numbers new to the Twilio
+              #   platform. Can be: `true` or `false` and the default is `true`.
+              # @param [String] friendly_name A string that identifies the resources to read.
+              # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
+              #   resources to read. You can specify partial numbers and use '*' as a wildcard for
+              #   any digit.
+              # @param [String] origin Whether to include phone numbers based on their origin.
+              #   Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
+              #   included.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -112,16 +110,15 @@ module Twilio
               ##
               # Retrieve a single page of LocalInstance records from the API.
               # Request is executed immediately.
-              # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
-              #   values are either `true` or `false`. Default is `true`.
-              # @param [String] friendly_name Only show the incoming phone number resources with
-              #   friendly names that exactly match this name.
-              # @param [String] phone_number Only show the incoming phone number resources that
-              #   match this pattern. You can specify partial numbers and use '*' as a wildcard
-              #   for any digit.
-              # @param [String] origin Include phone numbers based on the origin, by default,
-              #   phone numbers of all origin are included. Possible values are either `twilio` or
-              #   `hosted`.
+              # @param [Boolean] beta Whether to include phone numbers new to the Twilio
+              #   platform. Can be: `true` or `false` and the default is `true`.
+              # @param [String] friendly_name A string that identifies the resources to read.
+              # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
+              #   resources to read. You can specify partial numbers and use '*' as a wildcard for
+              #   any digit.
+              # @param [String] origin Whether to include phone numbers based on their origin.
+              #   Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
+              #   included.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -136,11 +133,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 LocalPage.new(@version, response, @solution)
               end
 
@@ -158,58 +153,72 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of LocalInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] phone_number The phone number you want to purchase. The number
-              #   should be formatted starting with a '+' followed by the country code and the
-              #   number in [E.164](http://en.wikipedia.org/wiki/E.164) format e.g.,
-              #   '+15105555555'. **You must include either this or an `AreaCode` parameter to
-              #   have your POST succeed.**
-              # @param [String] api_version The Twilio REST API version to use for incoming
-              #   calls made to this number. If omitted, uses `2010-04-01`.
-              # @param [String] friendly_name A human readable description of the new incoming
-              #   phone number. Maximum 64 characters. Defaults to a formatted version of the
-              #   number.
-              # @param [String] sms_application_sid The 34 character sid of the application
-              #   Twilio should use to handle SMSs sent to the new number. If a
-              #   `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and
-              #   use those set on the application.
-              # @param [String] sms_fallback_method The HTTP method that should be used to
-              #   request the `SmsFallbackUrl`. Must be either `GET` or `POST`. Defaults to
-              #   `POST`.
-              # @param [String] sms_fallback_url A URL that Twilio will request if an error
-              #   occurs requesting or executing the TwiML defined by `SmsUrl`.
-              # @param [String] sms_method The HTTP method that should be used to request the
-              #   `SmsUrl`. Must be either `GET` or `POST`. Defaults to `POST`.
-              # @param [String] sms_url The URL that Twilio should request when somebody sends
-              #   an SMS to the phone number.
-              # @param [String] status_callback The URL that Twilio will request to pass status
-              #   parameters (such as call ended) to your application.
-              # @param [String] status_callback_method The HTTP method Twilio will use to make
-              #   requests to the `StatusCallback` URL. Either `GET` or `POST`. Defaults to
-              #   `POST`.
-              # @param [String] voice_application_sid The 34 character sid of the application
-              #   Twilio should use to handle phone calls to the new number. If a
-              #   `VoiceApplicationSid` is present, Twilio will ignore all of the voice urls above
-              #   and use those set on the application. Setting a `VoiceApplicationSid` will
-              #   automatically delete your `TrunkSid` and vice versa.
-              # @param [Boolean] voice_caller_id_lookup Do a lookup of a caller's name from the
-              #   CNAM database and post it to your app. Either `true` or `false`. Defaults to
-              #   `false`.
-              # @param [String] voice_fallback_method The HTTP method that should be used to
-              #   request the `VoiceFallbackUrl`. Either `GET` or `POST`. Defaults to `POST`.
-              # @param [String] voice_fallback_url A URL that Twilio will request if an error
-              #   occurs requesting or executing the TwiML at `Url`.
-              # @param [String] voice_method The HTTP method that should be used to request the
-              #   `VoiceUrl`. Must be either `GET` or `POST`. Defaults to `POST`.
-              # @param [String] voice_url The URL that Twilio should request when somebody dials
-              #   the new phone number. The VoiceURL will  no longer be used if a
-              #   `VoiceApplicationSid` or a `TrunkSid` is set.
-              # @param [String] identity_sid The identity_sid
-              # @param [String] address_sid The 34 character sid of the address Twilio should
-              #   associate with the number.
-              # @return [LocalInstance] Newly created LocalInstance
-              def create(phone_number: nil, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, identity_sid: :unset, address_sid: :unset)
+              # Create the LocalInstance
+              # @param [String] phone_number The phone number to purchase specified in
+              #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.  E.164 phone
+              #   numbers consist of a + followed by the country code and subscriber number
+              #   without punctuation characters. For example, +14155551234.
+              # @param [String] api_version The API version to use for incoming calls made to
+              #   the new phone number. The default is `2010-04-01`.
+              # @param [String] friendly_name A descriptive string that you created to describe
+              #   the new phone number. It can be up to 64 characters long. By default, this is a
+              #   formatted version of the phone number.
+              # @param [String] sms_application_sid The SID of the application that should
+              #   handle SMS messages sent to the new phone number. If an `sms_application_sid` is
+              #   present, we ignore all of the `sms_*_url` urls and use those set on the
+              #   application.
+              # @param [String] sms_fallback_method The HTTP method that we should use to call
+              #   `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
+              # @param [String] sms_fallback_url The URL that we should call when an error
+              #   occurs while requesting or executing the TwiML defined by `sms_url`.
+              # @param [String] sms_method The HTTP method that we should use to call `sms_url`.
+              #   Can be: `GET` or `POST` and defaults to `POST`.
+              # @param [String] sms_url The URL we should call when the new phone number
+              #   receives an incoming SMS message.
+              # @param [String] status_callback The URL we should call using the
+              #   `status_callback_method` to send status information to your application.
+              # @param [String] status_callback_method The HTTP method we should use to call
+              #   `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
+              # @param [String] voice_application_sid The SID of the application we should use
+              #   to handle calls to the new phone number. If a `voice_application_sid` is
+              #   present, we ignore all of the voice urls and use only those set on the
+              #   application. Setting a `voice_application_sid` will automatically delete your
+              #   `trunk_sid` and vice versa.
+              # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from
+              #   the CNAM database and post it to your app. Can be: `true` or `false` and
+              #   defaults to `false`.
+              # @param [String] voice_fallback_method The HTTP method that we should use to call
+              #   `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
+              # @param [String] voice_fallback_url The URL that we should call when an error
+              #   occurs retrieving or executing the TwiML requested by `url`.
+              # @param [String] voice_method The HTTP method that we should use to call
+              #   `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
+              # @param [String] voice_url The URL that we should call to answer a call to the
+              #   new phone number. The `voice_url` will not be called if a
+              #   `voice_application_sid` or a `trunk_sid` is set.
+              # @param [String] identity_sid The SID of the Identity resource that we should
+              #   associate with the new phone number. Some regions require an identity to meet
+              #   local regulations.
+              # @param [String] address_sid The SID of the Address resource we should associate
+              #   with the new phone number. Some regions require addresses to meet local
+              #   regulations.
+              # @param [local.EmergencyStatus] emergency_status The parameter displays if
+              #   emergency calling is enabled for this number. Active numbers may place emergency
+              #   calls by dialing valid emergency numbers for the country.
+              # @param [String] emergency_address_sid The SID of the emergency address
+              #   configuration to use for emergency calling from the new phone number.
+              # @param [String] trunk_sid The SID of the Trunk we should use to handle calls to
+              #   the new phone number. If a `trunk_sid` is present, we ignore all of the voice
+              #   urls and voice applications and use only those set on the Trunk. Setting a
+              #   `trunk_sid` will automatically delete your `voice_application_sid` and vice
+              #   versa.
+              # @param [local.VoiceReceiveMode] voice_receive_mode The configuration parameter
+              #   for the new phone number to receive incoming voice calls or faxes. Can be: `fax`
+              #   or `voice` and defaults to `voice`.
+              # @param [String] bundle_sid The SID of the Bundle resource that you associate
+              #   with the phone number. Some regions require a Bundle to meet local Regulations.
+              # @return [LocalInstance] Created LocalInstance
+              def create(phone_number: nil, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, identity_sid: :unset, address_sid: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset)
                 data = Twilio::Values.of({
                     'PhoneNumber' => phone_number,
                     'ApiVersion' => api_version,
@@ -229,13 +238,14 @@ module Twilio
                     'VoiceUrl' => voice_url,
                     'IdentitySid' => identity_sid,
                     'AddressSid' => address_sid,
+                    'EmergencyStatus' => emergency_status,
+                    'EmergencyAddressSid' => emergency_address_sid,
+                    'TrunkSid' => trunk_sid,
+                    'VoiceReceiveMode' => voice_receive_mode,
+                    'BundleSid' => bundle_sid,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 LocalInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
@@ -281,9 +291,9 @@ module Twilio
               # Initialize the LocalInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
-              #   phone number.
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
+              #   IncomingPhoneNumber resource.
               # @return [LocalInstance] LocalInstance
               def initialize(version, payload, account_sid: nil)
                 super(version)
@@ -312,183 +322,225 @@ module Twilio
                     'status_callback_method' => payload['status_callback_method'],
                     'trunk_sid' => payload['trunk_sid'],
                     'uri' => payload['uri'],
+                    'voice_receive_mode' => payload['voice_receive_mode'],
                     'voice_application_sid' => payload['voice_application_sid'],
                     'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
                     'voice_fallback_method' => payload['voice_fallback_method'],
                     'voice_fallback_url' => payload['voice_fallback_url'],
                     'voice_method' => payload['voice_method'],
                     'voice_url' => payload['voice_url'],
+                    'emergency_status' => payload['emergency_status'],
+                    'emergency_address_sid' => payload['emergency_address_sid'],
+                    'emergency_address_status' => payload['emergency_address_status'],
+                    'bundle_sid' => payload['bundle_sid'],
+                    'status' => payload['status'],
                 }
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this phone number.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The 34 character sid of the address associated with this number.
+              # @return [String] The SID of the Address resource associated with the phone number
               def address_sid
                 @properties['address_sid']
               end
 
               ##
-              # @return [local.AddressRequirement] This indicates whether the phone number requires you or your customer to have an Address registered with Twilio.
+              # @return [local.AddressRequirement] Whether the phone number requires an Address registered with Twilio.
               def address_requirements
                 @properties['address_requirements']
               end
 
               ##
-              # @return [String] Calls to this phone number will start a new TwiML session with this API version.
+              # @return [String] The API version used to start a new TwiML session
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [Boolean] Phone numbers new to the Twilio platform are marked as beta.
+              # @return [Boolean] Whether the phone number is new to the Twilio platform
               def beta
                 @properties['beta']
               end
 
               ##
-              # @return [String] This is a set of boolean properties that indicate whether a phone number can receive calls or messages.
+              # @return [String] Indicate if a phone can receive calls or messages
               def capabilities
                 @properties['capabilities']
               end
 
               ##
-              # @return [Time] The date that this resource was created, given as GMT RFC 2822 format.
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date that this resource was last updated, given as GMT RFC 2822 format.
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
+              # @return [String] The string that you assigned to describe the resource
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [String] The identity_sid
+              # @return [String] The SID of the Identity resource associated with number
               def identity_sid
                 @properties['identity_sid']
               end
 
               ##
-              # @return [String] The incoming phone number.
+              # @return [String] The phone number in E.164 format
               def phone_number
                 @properties['phone_number']
               end
 
               ##
-              # @return [String] Twilio owned phone numbers are marked as twilio while hosted phone numbers are marked as hosted.
+              # @return [String] The phone number's origin. Can be twilio or hosted.
               def origin
                 @properties['origin']
               end
 
               ##
-              # @return [String] A 34 character string that uniquely identifies this resource.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The 34 character sid of the application Twilio should use to handle SMSs sent to this number.
+              # @return [String] The SID of the Application resource to handle SMS messages
               def sms_application_sid
                 @properties['sms_application_sid']
               end
 
               ##
-              # @return [String] The HTTP method Twilio will use when requesting the above URL.
+              # @return [String] The HTTP method used with sms_fallback_url
               def sms_fallback_method
                 @properties['sms_fallback_method']
               end
 
               ##
-              # @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML from SmsUrl.
+              # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
               def sms_fallback_url
                 @properties['sms_fallback_url']
               end
 
               ##
-              # @return [String] The HTTP method Twilio will use when making requests to the SmsUrl.
+              # @return [String] The HTTP method to use with sms_url
               def sms_method
                 @properties['sms_method']
               end
 
               ##
-              # @return [String] The URL Twilio will request when receiving an incoming SMS message to this number.
+              # @return [String] The URL we call when the phone number receives an incoming SMS message
               def sms_url
                 @properties['sms_url']
               end
 
               ##
-              # @return [String] The URL that Twilio will request to pass status parameters to your application.
+              # @return [String] The URL to send status information to your application
               def status_callback
                 @properties['status_callback']
               end
 
               ##
-              # @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
+              # @return [String] The HTTP method we use to call status_callback
               def status_callback_method
                 @properties['status_callback_method']
               end
 
               ##
-              # @return [String] The 34 character sid of the Trunk Twilio should use to handle phone calls to this number.
+              # @return [String] The SID of the Trunk that handles calls to the phone number
               def trunk_sid
                 @properties['trunk_sid']
               end
 
               ##
-              # @return [String] The URI for this resource, relative to https://api.
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [String] The 34 character sid of the application Twilio should use to handle phone calls to this number.
+              # @return [local.VoiceReceiveMode] The voice_receive_mode
+              def voice_receive_mode
+                @properties['voice_receive_mode']
+              end
+
+              ##
+              # @return [String] The SID of the application that handles calls to the phone number
               def voice_application_sid
                 @properties['voice_application_sid']
               end
 
               ##
-              # @return [Boolean] Look up the caller's caller-ID name from the CNAM database.
+              # @return [Boolean] Whether to lookup the caller's name
               def voice_caller_id_lookup
                 @properties['voice_caller_id_lookup']
               end
 
               ##
-              # @return [String] The HTTP method Twilio will use when requesting the VoiceFallbackUrl.
+              # @return [String] The HTTP method used with voice_fallback_url
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
 
               ##
-              # @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.
+              # @return [String] The URL we call when an error occurs in TwiML
               def voice_fallback_url
                 @properties['voice_fallback_url']
               end
 
               ##
-              # @return [String] The HTTP method Twilio will use when requesting the above Url.
+              # @return [String] The HTTP method used with the voice_url
               def voice_method
                 @properties['voice_method']
               end
 
               ##
-              # @return [String] The URL Twilio will request when this phone number receives a call.
+              # @return [String] The URL we call when this phone number receives a call
               def voice_url
                 @properties['voice_url']
               end
 
+              ##
+              # @return [local.EmergencyStatus] Displays if emergency calling is enabled for this number.
+              def emergency_status
+                @properties['emergency_status']
+              end
+
+              ##
+              # @return [String] The emergency address configuration to use for emergency calling
+              def emergency_address_sid
+                @properties['emergency_address_sid']
+              end
+
+              ##
+              # @return [local.EmergencyAddressStatus] State of the emergency address configuration for the phone number
+              def emergency_address_status
+                @properties['emergency_address_status']
+              end
+
+              ##
+              # @return [String] The SID of the Bundle resource associated with number
+              def bundle_sid
+                @properties['bundle_sid']
+              end
+
+              ##
+              # @return [String] The status
+              def status
+                @properties['status']
+              end
+
               ##
               # Provide a user friendly representation
               def to_s