twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb

@@ -18,12 +18,14 @@ module Twilio
         class Numbers < NumbersBase
             class V2 < Version
                 class HostedNumberOrderList < ListResource
+                
                     ##
                     # Initialize the HostedNumberOrderList
                     # @param [Version] version Version that contains the resource
                     # @return [HostedNumberOrderList] HostedNumberOrderList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/HostedNumber/Orders"
@@ -49,22 +51,22 @@ module Twilio
                     # @param [String] contact_title The title of the person authorized to sign the Authorization Document for this phone number.
                     # @return [HostedNumberOrderInstance] Created HostedNumberOrderInstance
                     def create(
-                        phone_number: nil, 
-                        contact_phone_number: nil, 
-                        address_sid: nil, 
-                        email: nil, 
-                        account_sid: :unset, 
-                        friendly_name: :unset, 
-                        cc_emails: :unset, 
-                        sms_url: :unset, 
-                        sms_method: :unset, 
-                        sms_fallback_url: :unset, 
-                        sms_capability: :unset, 
-                        sms_fallback_method: :unset, 
-                        status_callback_url: :unset, 
-                        status_callback_method: :unset, 
-                        sms_application_sid: :unset, 
-                        contact_title: :unset
+                      phone_number: nil, 
+                      contact_phone_number: nil, 
+                      address_sid: nil, 
+                      email: nil, 
+                      account_sid: :unset, 
+                      friendly_name: :unset, 
+                      cc_emails: :unset, 
+                      sms_url: :unset, 
+                      sms_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_capability: :unset, 
+                      sms_fallback_method: :unset, 
+                      status_callback_url: :unset, 
+                      status_callback_method: :unset, 
+                      sms_application_sid: :unset, 
+                      contact_title: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -86,13 +88,95 @@ module Twilio
                             'ContactTitle' => contact_title,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         HostedNumberOrderInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the HostedNumberOrderInstanceMetadata
+                    # @param [String] phone_number The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
+                    # @param [String] contact_phone_number The contact phone number of the person authorized to sign the Authorization Document.
+                    # @param [String] address_sid Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
+                    # @param [String] email Optional. Email of the owner of this phone number that is being hosted.
+                    # @param [String] account_sid This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.
+                    # @param [String] friendly_name A 128 character string that is a human readable text that describes this resource.
+                    # @param [Array[String]] cc_emails Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
+                    # @param [String] sms_url The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] sms_method The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`.  This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] sms_fallback_url A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [Boolean] sms_capability Used to specify that the SMS capability will be hosted on Twilio's platform.
+                    # @param [String] sms_fallback_method The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] status_callback_url Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
+                    # @param [String] status_callback_method Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
+                    # @param [String] sms_application_sid Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
+                    # @param [String] contact_title The title of the person authorized to sign the Authorization Document for this phone number.
+                    # @return [HostedNumberOrderInstance] Created HostedNumberOrderInstance
+                    def create_with_metadata(
+                      phone_number: nil, 
+                      contact_phone_number: nil, 
+                      address_sid: nil, 
+                      email: nil, 
+                      account_sid: :unset, 
+                      friendly_name: :unset, 
+                      cc_emails: :unset, 
+                      sms_url: :unset, 
+                      sms_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_capability: :unset, 
+                      sms_fallback_method: :unset, 
+                      status_callback_url: :unset, 
+                      status_callback_method: :unset, 
+                      sms_application_sid: :unset, 
+                      contact_title: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                            'ContactPhoneNumber' => contact_phone_number,
+                            'AddressSid' => address_sid,
+                            'Email' => email,
+                            'AccountSid' => account_sid,
+                            'FriendlyName' => friendly_name,
+                            'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
+                            'SmsUrl' => sms_url,
+                            'SmsMethod' => sms_method,
+                            'SmsFallbackUrl' => sms_fallback_url,
+                            'SmsCapability' => sms_capability,
+                            'SmsFallbackMethod' => sms_fallback_method,
+                            'StatusCallbackUrl' => status_callback_url,
+                            'StatusCallbackMethod' => status_callback_method,
+                            'SmsApplicationSid' => sms_application_sid,
+                            'ContactTitle' => contact_title,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        hosted_number_order_instance = HostedNumberOrderInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        HostedNumberOrderInstanceMetadata.new(
+                            @version,
+                            hosted_number_order_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists HostedNumberOrderInstance records from the API as a list.
@@ -149,7 +233,43 @@ module Twilio
                             friendly_name: friendly_name,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists HostedNumberOrderPageMetadata records from the API as a list.
+                      # @param [Status] status The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
+                      # @param [Boolean] sms_capability Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.
+                      # @param [String] phone_number An E164 formatted phone number hosted by this HostedNumberOrder.
+                      # @param [String] incoming_phone_number_sid A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
+                      # @param [String] friendly_name A human readable description of this resource, up to 128 characters.
+                    # @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(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Status' => status,
+                            'SmsCapability' => sms_capability,
+                            'PhoneNumber' => phone_number,
+                            'IncomingPhoneNumberSid' => incoming_phone_number_sid,
+                            'FriendlyName' => friendly_name,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        HostedNumberOrderPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -161,9 +281,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -178,7 +302,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 HostedNumberOrderInstance
-                    def page(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Status' => status,
                             'SmsCapability' => sms_capability,
@@ -189,8 +313,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         HostedNumberOrderPage.new(@version, response, @solution)
                     end
@@ -217,16 +344,15 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class HostedNumberOrderContext < InstanceContext
                     ##
                     # Initialize the HostedNumberOrderContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] sid A 34 character string that uniquely identifies this HostedNumberOrder.
+                    # @param [String] sid The SID of the HostedNumberOrder resource to update.
                     # @return [HostedNumberOrderContext] HostedNumberOrderContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -239,7 +365,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the HostedNumberOrderInstanceMetadata
+                    # @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)
+                          hostedNumberOrder_instance = HostedNumberOrderInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          HostedNumberOrderInstanceMetadata.new(@version, hostedNumberOrder_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -247,7 +397,13 @@ module Twilio
                     # @return [HostedNumberOrderInstance] Fetched HostedNumberOrderInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         HostedNumberOrderInstance.new(
                             @version,
                             payload,
@@ -255,6 +411,101 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the HostedNumberOrderInstanceMetadata
+                    # @return [HostedNumberOrderInstance] Fetched HostedNumberOrderInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        hosted_number_order_instance = HostedNumberOrderInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        HostedNumberOrderInstanceMetadata.new(
+                            @version,
+                            hosted_number_order_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the HostedNumberOrderInstance
+                    # @param [Status] status 
+                    # @param [String] verification_call_delay The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
+                    # @param [String] verification_call_extension The numerical extension to dial when making the ownership verification call.
+                    # @return [HostedNumberOrderInstance] Updated HostedNumberOrderInstance
+                    def update(
+                      status: nil, 
+                      verification_call_delay: :unset, 
+                      verification_call_extension: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                            'VerificationCallDelay' => verification_call_delay,
+                            'VerificationCallExtension' => verification_call_extension,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        HostedNumberOrderInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the HostedNumberOrderInstanceMetadata
+                    # @param [Status] status 
+                    # @param [String] verification_call_delay The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
+                    # @param [String] verification_call_extension The numerical extension to dial when making the ownership verification call.
+                    # @return [HostedNumberOrderInstance] Updated HostedNumberOrderInstance
+                    def update_with_metadata(
+                      status: nil, 
+                      verification_call_delay: :unset, 
+                      verification_call_extension: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                            'VerificationCallDelay' => verification_call_delay,
+                            'VerificationCallExtension' => verification_call_extension,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        hosted_number_order_instance = HostedNumberOrderInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        HostedNumberOrderInstanceMetadata.new(
+                            @version,
+                            hosted_number_order_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -271,6 +522,53 @@ module Twilio
                     end
                 end
 
+                class HostedNumberOrderInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new HostedNumberOrderInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}HostedNumberOrderInstance] hosted_number_order_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 [HostedNumberOrderInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, hosted_number_order_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @hosted_number_order_instance = hosted_number_order_instance
+                    end
+
+                    def hosted_number_order
+                        @hosted_number_order_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.HostedNumberOrderInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class HostedNumberOrderListResponse < InstanceListResource
+                    # @param [Array<HostedNumberOrderInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @hosted_number_order_instance = payload.body[key].map do |data|
+                        HostedNumberOrderInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def hosted_number_order_instance
+                          @instance
+                      end
+                  end
+
                 class HostedNumberOrderPage < Page
                     ##
                     # Initialize the HostedNumberOrderPage
@@ -280,6 +578,7 @@ module Twilio
                     # @return [HostedNumberOrderPage] HostedNumberOrderPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -299,6 +598,66 @@ module Twilio
                         '<Twilio.Numbers.V2.HostedNumberOrderPage>'
                     end
                 end
+
+                class HostedNumberOrderPageMetadata < PageMetadata
+                    attr_reader :hosted_number_order_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @hosted_number_order_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @hosted_number_order_page << HostedNumberOrderListResponse.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
+                        @hosted_number_order_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class HostedNumberOrderListResponse < InstanceListResource
+
+                    # @param [Array<HostedNumberOrderInstance>] 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
+                      @hosted_number_order = data_list.map do |data|
+                        HostedNumberOrderInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def hosted_number_order
+                        @hosted_number_order
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class HostedNumberOrderInstance < InstanceResource
                     ##
                     # Initialize the HostedNumberOrderInstance
@@ -312,6 +671,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -333,6 +693,12 @@ module Twilio
                             'contact_phone_number' => payload['contact_phone_number'],
                             'bulk_hosting_request_sid' => payload['bulk_hosting_request_sid'],
                             'next_step' => payload['next_step'],
+                            'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i,
+                            'verification_call_sids' => payload['verification_call_sids'],
+                            'verification_call_delay' => payload['verification_call_delay'] == nil ? payload['verification_call_delay'] : payload['verification_call_delay'].to_i,
+                            'verification_call_extension' => payload['verification_call_extension'],
+                            'verification_code' => payload['verification_code'],
+                            'verification_type' => payload['verification_type'],
                         }
 
                         # Context
@@ -465,6 +831,42 @@ module Twilio
                         @properties['next_step']
                     end
                     
+                    ##
+                    # @return [String] The number of attempts made to verify ownership via a call for the hosted phone number.
+                    def verification_attempts
+                        @properties['verification_attempts']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The Call SIDs that identify the calls placed to verify ownership.
+                    def verification_call_sids
+                        @properties['verification_call_sids']
+                    end
+                    
+                    ##
+                    # @return [String] The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
+                    def verification_call_delay
+                        @properties['verification_call_delay']
+                    end
+                    
+                    ##
+                    # @return [String] The numerical extension to dial when making the ownership verification call.
+                    def verification_call_extension
+                        @properties['verification_call_extension']
+                    end
+                    
+                    ##
+                    # @return [String] The digits the user must pass in the ownership verification call.
+                    def verification_code
+                        @properties['verification_code']
+                    end
+                    
+                    ##
+                    # @return [VerificationType] 
+                    def verification_type
+                        @properties['verification_type']
+                    end
+                    
                     ##
                     # Delete the HostedNumberOrderInstance
                     # @return [Boolean] True if delete succeeds, false otherwise
@@ -481,6 +883,25 @@ module Twilio
                         context.fetch
                     end
 
+                    ##
+                    # Update the HostedNumberOrderInstance
+                    # @param [Status] status 
+                    # @param [String] verification_call_delay The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
+                    # @param [String] verification_call_extension The numerical extension to dial when making the ownership verification call.
+                    # @return [HostedNumberOrderInstance] Updated HostedNumberOrderInstance
+                    def update(
+                      status: nil, 
+                      verification_call_delay: :unset, 
+                      verification_call_extension: :unset
+                    )
+
+                        context.update(
+                            status: status, 
+                            verification_call_delay: verification_call_delay, 
+                            verification_call_extension: verification_call_extension, 
+                        )
+                    end
+
                     ##
                     # Provide a user friendly representation
                     def to_s