twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,910 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class IncomingPhoneNumberList < ListResource
+            ##
+            # Initialize the IncomingPhoneNumberList
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
+            #   IncomingPhoneNumber resource.
+            # @return [IncomingPhoneNumberList] IncomingPhoneNumberList
+            def initialize(version, account_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {account_sid: account_sid}
+              @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers.json"
+
+              # Components
+              @local = nil
+              @mobile = nil
+              @toll_free = nil
+            end
+
+            ##
+            # Lists IncomingPhoneNumberInstance 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 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 IncomingPhoneNumber
+            #   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
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  beta: beta,
+                  friendly_name: friendly_name,
+                  phone_number: phone_number,
+                  origin: origin,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
+            end
+
+            ##
+            # Streams IncomingPhoneNumberInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @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 IncomingPhoneNumber
+            #   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
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(
+                  beta: beta,
+                  friendly_name: friendly_name,
+                  phone_number: phone_number,
+                  origin: origin,
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields IncomingPhoneNumberInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
+            # Request is executed immediately.
+            # @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 IncomingPhoneNumber
+            #   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
+            # @return [Page] Page of IncomingPhoneNumberInstance
+            def page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'Beta' => beta,
+                  'FriendlyName' => friendly_name,
+                  'PhoneNumber' => phone_number,
+                  'Origin' => origin,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              IncomingPhoneNumberPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of IncomingPhoneNumberInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              IncomingPhoneNumberPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Create the IncomingPhoneNumberInstance
+            # @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 new 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 [incoming_phone_number.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 [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 [incoming_phone_number.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.
+            # @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] area_code The desired area code for your new incoming phone
+            #   number. Can be any three-digit, US or Canada area code. We will provision an
+            #   available phone number within this area code for you. **You must provide an
+            #   `area_code` or a `phone_number`.** (US and Canada only).
+            # @return [IncomingPhoneNumberInstance] Created IncomingPhoneNumberInstance
+            def create(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, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, identity_sid: :unset, address_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset, phone_number: :unset, area_code: :unset)
+              data = Twilio::Values.of({
+                  'PhoneNumber' => phone_number,
+                  'AreaCode' => area_code,
+                  'ApiVersion' => api_version,
+                  'FriendlyName' => friendly_name,
+                  'SmsApplicationSid' => sms_application_sid,
+                  'SmsFallbackMethod' => sms_fallback_method,
+                  'SmsFallbackUrl' => sms_fallback_url,
+                  'SmsMethod' => sms_method,
+                  'SmsUrl' => sms_url,
+                  'StatusCallback' => status_callback,
+                  'StatusCallbackMethod' => status_callback_method,
+                  'VoiceApplicationSid' => voice_application_sid,
+                  'VoiceCallerIdLookup' => voice_caller_id_lookup,
+                  'VoiceFallbackMethod' => voice_fallback_method,
+                  'VoiceFallbackUrl' => voice_fallback_url,
+                  'VoiceMethod' => voice_method,
+                  'VoiceUrl' => voice_url,
+                  'EmergencyStatus' => emergency_status,
+                  'EmergencyAddressSid' => emergency_address_sid,
+                  'TrunkSid' => trunk_sid,
+                  'IdentitySid' => identity_sid,
+                  'AddressSid' => address_sid,
+                  'VoiceReceiveMode' => voice_receive_mode,
+                  'BundleSid' => bundle_sid,
+              })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              IncomingPhoneNumberInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Access the local
+            # @return [LocalList]
+            # @return [LocalContext]
+            def local
+              @local ||= LocalList.new(@version, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Access the mobile
+            # @return [MobileList]
+            # @return [MobileContext]
+            def mobile
+              @mobile ||= MobileList.new(@version, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Access the toll_free
+            # @return [TollFreeList]
+            # @return [TollFreeContext]
+            def toll_free
+              @toll_free ||= TollFreeList.new(@version, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.IncomingPhoneNumberList>'
+            end
+          end
+
+          class IncomingPhoneNumberPage < Page
+            ##
+            # Initialize the IncomingPhoneNumberPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [IncomingPhoneNumberPage] IncomingPhoneNumberPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of IncomingPhoneNumberInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
+            def get_instance(payload)
+              IncomingPhoneNumberInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.IncomingPhoneNumberPage>'
+            end
+          end
+
+          class IncomingPhoneNumberContext < InstanceContext
+            ##
+            # Initialize the IncomingPhoneNumberContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   IncomingPhoneNumber resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   IncomingPhoneNumber resource to fetch.
+            # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext
+            def initialize(version, account_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {account_sid: account_sid, sid: sid, }
+              @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:sid]}.json"
+
+              # Dependents
+              @assigned_add_ons = nil
+            end
+
+            ##
+            # Update the IncomingPhoneNumberInstance
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   IncomingPhoneNumber resource to update.  For more information, see {Exchanging
+            #   Numbers Between
+            #   Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers].
+            # @param [String] api_version The API version to use for incoming calls made to
+            #   the phone number. The default is `2010-04-01`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this 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 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 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 phone calls to the 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
+            #   phone number. The `voice_url` will not be called if a `voice_application_sid` or
+            #   a `trunk_sid` is set.
+            # @param [incoming_phone_number.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 this phone number.
+            # @param [String] trunk_sid The SID of the Trunk we should use to handle phone
+            #   calls to the 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 [incoming_phone_number.VoiceReceiveMode] voice_receive_mode The
+            #   configuration parameter for the phone number to receive incoming voice calls or
+            #   faxes. Can be: `fax` or `voice` and defaults to `voice`.
+            # @param [String] identity_sid The SID of the Identity resource that we should
+            #   associate with the 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 phone number. Some regions require addresses to meet local regulations.
+            # @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 [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
+            def update(account_sid: :unset, 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, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset)
+              data = Twilio::Values.of({
+                  'AccountSid' => account_sid,
+                  'ApiVersion' => api_version,
+                  'FriendlyName' => friendly_name,
+                  'SmsApplicationSid' => sms_application_sid,
+                  'SmsFallbackMethod' => sms_fallback_method,
+                  'SmsFallbackUrl' => sms_fallback_url,
+                  'SmsMethod' => sms_method,
+                  'SmsUrl' => sms_url,
+                  'StatusCallback' => status_callback,
+                  'StatusCallbackMethod' => status_callback_method,
+                  'VoiceApplicationSid' => voice_application_sid,
+                  'VoiceCallerIdLookup' => voice_caller_id_lookup,
+                  'VoiceFallbackMethod' => voice_fallback_method,
+                  'VoiceFallbackUrl' => voice_fallback_url,
+                  'VoiceMethod' => voice_method,
+                  'VoiceUrl' => voice_url,
+                  'EmergencyStatus' => emergency_status,
+                  'EmergencyAddressSid' => emergency_address_sid,
+                  'TrunkSid' => trunk_sid,
+                  'VoiceReceiveMode' => voice_receive_mode,
+                  'IdentitySid' => identity_sid,
+                  'AddressSid' => address_sid,
+                  'BundleSid' => bundle_sid,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              IncomingPhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Fetch the IncomingPhoneNumberInstance
+            # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              IncomingPhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Delete the IncomingPhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Access the assigned_add_ons
+            # @return [AssignedAddOnList]
+            # @return [AssignedAddOnContext] if sid was passed.
+            def assigned_add_ons(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return AssignedAddOnContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @assigned_add_ons
+                @assigned_add_ons = AssignedAddOnList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    resource_sid: @solution[:sid],
+                )
+              end
+
+              @assigned_add_ons
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
+            end
+          end
+
+          class IncomingPhoneNumberInstance < InstanceResource
+            ##
+            # Initialize the IncomingPhoneNumberInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this
+            #   IncomingPhoneNumber resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   IncomingPhoneNumber resource to fetch.
+            # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
+            def initialize(version, payload, account_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'address_sid' => payload['address_sid'],
+                  'address_requirements' => payload['address_requirements'],
+                  'api_version' => payload['api_version'],
+                  'beta' => payload['beta'],
+                  'capabilities' => payload['capabilities'],
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                  'friendly_name' => payload['friendly_name'],
+                  'identity_sid' => payload['identity_sid'],
+                  'phone_number' => payload['phone_number'],
+                  'origin' => payload['origin'],
+                  'sid' => payload['sid'],
+                  'sms_application_sid' => payload['sms_application_sid'],
+                  'sms_fallback_method' => payload['sms_fallback_method'],
+                  'sms_fallback_url' => payload['sms_fallback_url'],
+                  'sms_method' => payload['sms_method'],
+                  'sms_url' => payload['sms_url'],
+                  'status_callback' => payload['status_callback'],
+                  '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'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext for this IncomingPhoneNumberInstance
+            def context
+              unless @instance_context
+                @instance_context = IncomingPhoneNumberContext.new(@version, @params['account_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The SID of the Address resource associated with the phone number
+            def address_sid
+              @properties['address_sid']
+            end
+
+            ##
+            # @return [incoming_phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio.
+            def address_requirements
+              @properties['address_requirements']
+            end
+
+            ##
+            # @return [String] The API version used to start a new TwiML session
+            def api_version
+              @properties['api_version']
+            end
+
+            ##
+            # @return [Boolean] Whether the phone number is new to the Twilio platform
+            def beta
+              @properties['beta']
+            end
+
+            ##
+            # @return [String] Indicate if a phone can receive calls or messages
+            def capabilities
+              @properties['capabilities']
+            end
+
+            ##
+            # @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 RFC 2822 date and time in GMT that the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The string that you assigned to describe the resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The SID of the Identity resource associated with number
+            def identity_sid
+              @properties['identity_sid']
+            end
+
+            ##
+            # @return [String] The phone number in E.164 format
+            def phone_number
+              @properties['phone_number']
+            end
+
+            ##
+            # @return [String] The phone number's origin. Can be twilio or hosted.
+            def origin
+              @properties['origin']
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @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 HTTP method used with sms_fallback_url
+            def sms_fallback_method
+              @properties['sms_fallback_method']
+            end
+
+            ##
+            # @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 to use with sms_url
+            def sms_method
+              @properties['sms_method']
+            end
+
+            ##
+            # @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 to send status information to your application
+            def status_callback
+              @properties['status_callback']
+            end
+
+            ##
+            # @return [String] The HTTP method we use to call status_callback
+            def status_callback_method
+              @properties['status_callback_method']
+            end
+
+            ##
+            # @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 of the resource, relative to `https://api.twilio.com`
+            def uri
+              @properties['uri']
+            end
+
+            ##
+            # @return [incoming_phone_number.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] Whether to lookup the caller's name
+            def voice_caller_id_lookup
+              @properties['voice_caller_id_lookup']
+            end
+
+            ##
+            # @return [String] The HTTP method used with voice_fallback_url
+            def voice_fallback_method
+              @properties['voice_fallback_method']
+            end
+
+            ##
+            # @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 used with the voice_url
+            def voice_method
+              @properties['voice_method']
+            end
+
+            ##
+            # @return [String] The URL we call when the phone number receives a call
+            def voice_url
+              @properties['voice_url']
+            end
+
+            ##
+            # @return [incoming_phone_number.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 [incoming_phone_number.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
+
+            ##
+            # Update the IncomingPhoneNumberInstance
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   IncomingPhoneNumber resource to update.  For more information, see {Exchanging
+            #   Numbers Between
+            #   Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers].
+            # @param [String] api_version The API version to use for incoming calls made to
+            #   the phone number. The default is `2010-04-01`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this 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 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 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 phone calls to the 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
+            #   phone number. The `voice_url` will not be called if a `voice_application_sid` or
+            #   a `trunk_sid` is set.
+            # @param [incoming_phone_number.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 this phone number.
+            # @param [String] trunk_sid The SID of the Trunk we should use to handle phone
+            #   calls to the 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 [incoming_phone_number.VoiceReceiveMode] voice_receive_mode The
+            #   configuration parameter for the phone number to receive incoming voice calls or
+            #   faxes. Can be: `fax` or `voice` and defaults to `voice`.
+            # @param [String] identity_sid The SID of the Identity resource that we should
+            #   associate with the 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 phone number. Some regions require addresses to meet local regulations.
+            # @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 [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
+            def update(account_sid: :unset, 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, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset)
+              context.update(
+                  account_sid: account_sid,
+                  api_version: api_version,
+                  friendly_name: friendly_name,
+                  sms_application_sid: sms_application_sid,
+                  sms_fallback_method: sms_fallback_method,
+                  sms_fallback_url: sms_fallback_url,
+                  sms_method: sms_method,
+                  sms_url: sms_url,
+                  status_callback: status_callback,
+                  status_callback_method: status_callback_method,
+                  voice_application_sid: voice_application_sid,
+                  voice_caller_id_lookup: voice_caller_id_lookup,
+                  voice_fallback_method: voice_fallback_method,
+                  voice_fallback_url: voice_fallback_url,
+                  voice_method: voice_method,
+                  voice_url: voice_url,
+                  emergency_status: emergency_status,
+                  emergency_address_sid: emergency_address_sid,
+                  trunk_sid: trunk_sid,
+                  voice_receive_mode: voice_receive_mode,
+                  identity_sid: identity_sid,
+                  address_sid: address_sid,
+                  bundle_sid: bundle_sid,
+              )
+            end
+
+            ##
+            # Fetch the IncomingPhoneNumberInstance
+            # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Delete the IncomingPhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Access the assigned_add_ons
+            # @return [assigned_add_ons] assigned_add_ons
+            def assigned_add_ons
+              context.assigned_add_ons
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end