twilio-ruby 7.9.1 → 7.10.0

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

@@ -27,6 +27,7 @@ module Twilio
                     # @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"
@@ -130,6 +131,107 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the IncomingPhoneNumberInstanceMetadata
+                    # @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 [EmergencyStatus] emergency_status 
+                    # @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 [VoiceReceiveMode] voice_receive_mode 
+                    # @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_with_metadata(
+                      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({
+                            '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,
+                            'PhoneNumber' => phone_number,
+                            'AreaCode' => area_code,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        incoming_phone_number_instance = IncomingPhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        IncomingPhoneNumberInstanceMetadata.new(
+                            @version,
+                            incoming_phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists IncomingPhoneNumberInstance records from the API as a list.
@@ -185,6 +287,36 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists IncomingPhoneNumberPageMetadata records from the API as a list.
+                      # @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_with_metadata(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Beta' => beta,
+                            'FriendlyName' => friendly_name,
+                            'PhoneNumber' => phone_number,
+                            'Origin' => origin,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        IncomingPhoneNumberPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields IncomingPhoneNumberInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -210,7 +342,7 @@ module Twilio
                     # @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)
+                    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,
@@ -281,6 +413,7 @@ module Twilio
                     # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -298,9 +431,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the IncomingPhoneNumberInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          incomingPhoneNumber_instance = IncomingPhoneNumberInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          IncomingPhoneNumberInstanceMetadata.new(@version, incomingPhoneNumber_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the IncomingPhoneNumberInstance
                     # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
@@ -321,6 +474,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the IncomingPhoneNumberInstanceMetadata
+                    # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        incoming_phone_number_instance = IncomingPhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        IncomingPhoneNumberInstanceMetadata.new(
+                            @version,
+                            incoming_phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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).
@@ -414,6 +593,105 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the IncomingPhoneNumberInstanceMetadata
+                    # @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 [EmergencyStatus] emergency_status 
+                    # @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 [VoiceReceiveMode] voice_receive_mode 
+                    # @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_with_metadata(
+                      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,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        incoming_phone_number_instance = IncomingPhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        IncomingPhoneNumberInstanceMetadata.new(
+                            @version,
+                            incoming_phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the assigned_add_ons
                     # @return [AssignedAddOnList]
@@ -449,6 +727,53 @@ module Twilio
                     end
                 end
 
+                class IncomingPhoneNumberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new IncomingPhoneNumberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}IncomingPhoneNumberInstance] incoming_phone_number_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [IncomingPhoneNumberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, incoming_phone_number_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @incoming_phone_number_instance = incoming_phone_number_instance
+                    end
+
+                    def incoming_phone_number
+                        @incoming_phone_number_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.IncomingPhoneNumberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class IncomingPhoneNumberListResponse < InstanceListResource
+                    # @param [Array<IncomingPhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @incoming_phone_number_instance = payload.body[key].map do |data|
+                        IncomingPhoneNumberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def incoming_phone_number_instance
+                          @instance
+                      end
+                  end
+
                 class IncomingPhoneNumberPage < Page
                     ##
                     # Initialize the IncomingPhoneNumberPage
@@ -458,6 +783,7 @@ module Twilio
                     # @return [IncomingPhoneNumberPage] IncomingPhoneNumberPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -477,6 +803,66 @@ module Twilio
                         '<Twilio.Api.V2010.IncomingPhoneNumberPage>'
                     end
                 end
+
+                class IncomingPhoneNumberPageMetadata < PageMetadata
+                    attr_reader :incoming_phone_number_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @incoming_phone_number_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @incoming_phone_number_page << IncomingPhoneNumberListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @incoming_phone_number_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class IncomingPhoneNumberListResponse < InstanceListResource
+
+                    # @param [Array<IncomingPhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @incoming_phone_number = data_list.map do |data|
+                        IncomingPhoneNumberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def incoming_phone_number
+                        @incoming_phone_number
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class IncomingPhoneNumberInstance < InstanceResource
                     ##
                     # Initialize the IncomingPhoneNumberInstance
@@ -490,6 +876,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],