twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,9 @@ module Twilio
               ##
               # Initialize the TollFreeList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the 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 [TollFreeList] TollFreeList
               def initialize(version, account_sid: nil)
                 super(version)
@@ -29,10 +32,15 @@ module Twilio
               # Lists TollFreeInstance 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 The beta
-              # @param [String] friendly_name The friendly_name
-              # @param [String] phone_number The phone_number
-              # @param [String] origin The origin
+              # @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
@@ -55,10 +63,15 @@ module Twilio
               # Streams TollFreeInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Boolean] beta The beta
-              # @param [String] friendly_name The friendly_name
-              # @param [String] phone_number The phone_number
-              # @param [String] origin The origin
+              # @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
@@ -87,7 +100,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -97,10 +110,15 @@ module Twilio
               ##
               # Retrieve a single page of TollFreeInstance records from the API.
               # Request is executed immediately.
-              # @param [Boolean] beta The beta
-              # @param [String] friendly_name The friendly_name
-              # @param [String] phone_number The phone_number
-              # @param [String] origin The origin
+              # @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
@@ -115,11 +133,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 TollFreePage.new(@version, response, @solution)
               end
 
@@ -137,28 +153,71 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of TollFreeInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] phone_number The phone_number
-              # @param [String] api_version The api_version
-              # @param [String] friendly_name The friendly_name
-              # @param [String] sms_application_sid The sms_application_sid
-              # @param [String] sms_fallback_method The sms_fallback_method
-              # @param [String] sms_fallback_url The sms_fallback_url
-              # @param [String] sms_method The sms_method
-              # @param [String] sms_url The sms_url
-              # @param [String] status_callback The status_callback
-              # @param [String] status_callback_method The status_callback_method
-              # @param [String] voice_application_sid The voice_application_sid
-              # @param [Boolean] voice_caller_id_lookup The voice_caller_id_lookup
-              # @param [String] voice_fallback_method The voice_fallback_method
-              # @param [String] voice_fallback_url The voice_fallback_url
-              # @param [String] voice_method The voice_method
-              # @param [String] voice_url The voice_url
-              # @param [String] identity_sid The identity_sid
-              # @param [String] address_sid The address_sid
-              # @return [TollFreeInstance] Newly created TollFreeInstance
-              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 TollFreeInstance
+              # @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 `sms_*_url` values and use those of 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 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 [toll_free.EmergencyStatus] emergency_status The configuration status
+              #   parameter that determines whether the new phone number is enabled for emergency
+              #   calling.
+              # @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 [toll_free.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 [TollFreeInstance] Created TollFreeInstance
+              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,
@@ -178,15 +237,16 @@ 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)
 
-                TollFreeInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                TollFreeInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -215,7 +275,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [TollFreeInstance] TollFreeInstance
               def get_instance(payload)
-                TollFreeInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                TollFreeInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -230,8 +290,9 @@ module Twilio
               # Initialize the TollFreeInstance
               # @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 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 [TollFreeInstance] TollFreeInstance
               def initialize(version, payload, account_sid: nil)
                 super(version)
@@ -260,183 +321,218 @@ 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'],
+                    'bundle_sid' => payload['bundle_sid'],
+                    'status' => payload['status'],
                 }
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The address_sid
+              # @return [String] The SID of the Address resource associated with the phone number
               def address_sid
                 @properties['address_sid']
               end
 
               ##
-              # @return [toll_free.AddressRequirement] The address_requirements
+              # @return [toll_free.AddressRequirement] Whether the phone number requires an Address registered with Twilio.
               def address_requirements
                 @properties['address_requirements']
               end
 
               ##
-              # @return [String] The api_version
+              # @return [String] The API version used to start a new TwiML session
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [Boolean] The beta
+              # @return [Boolean] Whether the phone number is new to the Twilio platform
               def beta
                 @properties['beta']
               end
 
               ##
-              # @return [String] The capabilities
+              # @return [String] Indicate if a phone can receive calls or messages
               def capabilities
                 @properties['capabilities']
               end
 
               ##
-              # @return [Time] The date_created
+              # @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_updated
+              # @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] The friendly_name
+              # @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 phone_number
+              # @return [String] The phone number in E.164 format
               def phone_number
                 @properties['phone_number']
               end
 
               ##
-              # @return [String] The origin
+              # @return [String] The phone number's origin. Can be twilio or hosted.
               def origin
                 @properties['origin']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The sms_application_sid
+              # @return [String] The SID of the application that handles SMS messages sent to the phone number
               def sms_application_sid
                 @properties['sms_application_sid']
               end
 
               ##
-              # @return [String] The sms_fallback_method
+              # @return [String] The HTTP method used with sms_fallback_url
               def sms_fallback_method
                 @properties['sms_fallback_method']
               end
 
               ##
-              # @return [String] The sms_fallback_url
+              # @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 sms_method
+              # @return [String] The HTTP method to use with sms_url
               def sms_method
                 @properties['sms_method']
               end
 
               ##
-              # @return [String] The sms_url
+              # @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 status_callback
+              # @return [String] The URL to send status information to your application
               def status_callback
                 @properties['status_callback']
               end
 
               ##
-              # @return [String] The status_callback_method
+              # @return [String] The HTTP method we use to call status_callback
               def status_callback_method
                 @properties['status_callback_method']
               end
 
               ##
-              # @return [String] The trunk_sid
+              # @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
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [String] The voice_application_sid
+              # @return [toll_free.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] The voice_caller_id_lookup
+              # @return [Boolean] Whether to lookup the caller's name
               def voice_caller_id_lookup
                 @properties['voice_caller_id_lookup']
               end
 
               ##
-              # @return [String] The voice_fallback_method
+              # @return [String] The HTTP method used with voice_fallback_url
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
 
               ##
-              # @return [String] The voice_fallback_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 voice_method
+              # @return [String] The HTTP method used with the voice_url
               def voice_method
                 @properties['voice_method']
               end
 
               ##
-              # @return [String] The voice_url
+              # @return [String] The URL we call when the phone number receives a call
               def voice_url
                 @properties['voice_url']
               end
 
+              ##
+              # @return [toll_free.EmergencyStatus] Whether the phone number is enabled for emergency calling
+              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 [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