twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb

@@ -20,12 +20,14 @@ module Twilio
                 class AuthorizationDocumentContext < InstanceContext
 
                      class DependentHostedNumberOrderList < ListResource
+                
                     ##
                     # Initialize the DependentHostedNumberOrderList
                     # @param [Version] version Version that contains the resource
                     # @return [DependentHostedNumberOrderList] DependentHostedNumberOrderList
                     def initialize(version, signing_document_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { signing_document_sid: signing_document_sid }
                         @uri = "/HostedNumber/AuthorizationDocuments/#{@solution[:signing_document_sid]}/DependentHostedNumberOrders"
@@ -83,7 +85,41 @@ 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 DependentHostedNumberOrderPageMetadata records from the API as a list.
+                      # @param [Status] status Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
+                      # @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, 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,
+                            '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)
+
+                        DependentHostedNumberOrderPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -95,9 +131,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
 
                     ##
@@ -111,7 +151,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 DependentHostedNumberOrderInstance
-                    def page(status: :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, 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,
                             'PhoneNumber' => phone_number,
@@ -121,8 +161,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)
 
                         DependentHostedNumberOrderPage.new(@version, response, @solution)
                     end
@@ -157,6 +200,7 @@ module Twilio
                     # @return [DependentHostedNumberOrderPage] DependentHostedNumberOrderPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -176,6 +220,66 @@ module Twilio
                         '<Twilio.Numbers.V2.DependentHostedNumberOrderPage>'
                     end
                 end
+
+                class DependentHostedNumberOrderPageMetadata < PageMetadata
+                    attr_reader :dependent_hosted_number_order_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @dependent_hosted_number_order_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @dependent_hosted_number_order_page << DependentHostedNumberOrderListResponse.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
+                        @dependent_hosted_number_order_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class DependentHostedNumberOrderListResponse < InstanceListResource
+
+                    # @param [Array<DependentHostedNumberOrderInstance>] 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
+                      @dependent_hosted_number_order = data_list.map do |data|
+                        DependentHostedNumberOrderInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def dependent_hosted_number_order
+                        @dependent_hosted_number_order
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DependentHostedNumberOrderInstance < InstanceResource
                     ##
                     # Initialize the DependentHostedNumberOrderInstance
@@ -189,6 +293,7 @@ module Twilio
                     def initialize(version, payload , signing_document_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -18,12 +18,14 @@ module Twilio
         class Numbers < NumbersBase
             class V2 < Version
                 class AuthorizationDocumentList < ListResource
+                
                     ##
                     # Initialize the AuthorizationDocumentList
                     # @param [Version] version Version that contains the resource
                     # @return [AuthorizationDocumentList] AuthorizationDocumentList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/HostedNumber/AuthorizationDocuments"
@@ -39,12 +41,12 @@ module Twilio
                     # @param [Array[String]] cc_emails Email recipients who will be informed when an Authorization Document has been sent and signed.
                     # @return [AuthorizationDocumentInstance] Created AuthorizationDocumentInstance
                     def create(
-                        address_sid: nil, 
-                        email: nil, 
-                        contact_phone_number: nil, 
-                        hosted_number_order_sids: nil, 
-                        contact_title: :unset, 
-                        cc_emails: :unset
+                      address_sid: nil, 
+                      email: nil, 
+                      contact_phone_number: nil, 
+                      hosted_number_order_sids: nil, 
+                      contact_title: :unset, 
+                      cc_emails: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -56,13 +58,65 @@ module Twilio
                             'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
                         })
 
-                        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)
                         AuthorizationDocumentInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the AuthorizationDocumentInstanceMetadata
+                    # @param [String] address_sid A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
+                    # @param [String] email Email that this AuthorizationDocument will be sent to for signing.
+                    # @param [String] contact_phone_number The contact phone number of the person authorized to sign the Authorization Document.
+                    # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
+                    # @param [String] contact_title The title of the person authorized to sign the Authorization Document for this phone number.
+                    # @param [Array[String]] cc_emails Email recipients who will be informed when an Authorization Document has been sent and signed.
+                    # @return [AuthorizationDocumentInstance] Created AuthorizationDocumentInstance
+                    def create_with_metadata(
+                      address_sid: nil, 
+                      email: nil, 
+                      contact_phone_number: nil, 
+                      hosted_number_order_sids: nil, 
+                      contact_title: :unset, 
+                      cc_emails: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AddressSid' => address_sid,
+                            'Email' => email,
+                            'ContactPhoneNumber' => contact_phone_number,
+                            'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
+                            'ContactTitle' => contact_title,
+                            'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        authorization_document_instance = AuthorizationDocumentInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        AuthorizationDocumentInstanceMetadata.new(
+                            @version,
+                            authorization_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists AuthorizationDocumentInstance records from the API as a list.
@@ -107,7 +161,37 @@ module Twilio
                             status: status,
                             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 AuthorizationDocumentPageMetadata records from the API as a list.
+                      # @param [String] email Email that this AuthorizationDocument will be sent to for signing.
+                      # @param [Status] status Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
+                    # @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(email: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Email' => email,
+                            'Status' => status,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        AuthorizationDocumentPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -119,9 +203,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
 
                     ##
@@ -133,7 +221,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 AuthorizationDocumentInstance
-                    def page(email: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(email: :unset, status: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Email' => email,
                             'Status' => status,
@@ -141,8 +229,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)
 
                         AuthorizationDocumentPage.new(@version, response, @solution)
                     end
@@ -169,8 +260,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class AuthorizationDocumentContext < InstanceContext
                     ##
                     # Initialize the AuthorizationDocumentContext
@@ -179,6 +268,7 @@ module Twilio
                     # @return [AuthorizationDocumentContext] AuthorizationDocumentContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -192,7 +282,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 AuthorizationDocumentInstanceMetadata
+                    # @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)
+                          authorizationDocument_instance = AuthorizationDocumentInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          AuthorizationDocumentInstanceMetadata.new(@version, authorizationDocument_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -200,7 +314,13 @@ module Twilio
                     # @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance
                     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)
                         AuthorizationDocumentInstance.new(
                             @version,
                             payload,
@@ -208,6 +328,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AuthorizationDocumentInstanceMetadata
+                    # @return [AuthorizationDocumentInstance] Fetched AuthorizationDocumentInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        authorization_document_instance = AuthorizationDocumentInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        AuthorizationDocumentInstanceMetadata.new(
+                            @version,
+                            authorization_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the dependent_hosted_number_orders
                     # @return [DependentHostedNumberOrderList]
@@ -235,6 +380,53 @@ module Twilio
                     end
                 end
 
+                class AuthorizationDocumentInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AuthorizationDocumentInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AuthorizationDocumentInstance] authorization_document_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 [AuthorizationDocumentInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, authorization_document_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @authorization_document_instance = authorization_document_instance
+                    end
+
+                    def authorization_document
+                        @authorization_document_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AuthorizationDocumentInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AuthorizationDocumentListResponse < InstanceListResource
+                    # @param [Array<AuthorizationDocumentInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @authorization_document_instance = payload.body[key].map do |data|
+                        AuthorizationDocumentInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def authorization_document_instance
+                          @instance
+                      end
+                  end
+
                 class AuthorizationDocumentPage < Page
                     ##
                     # Initialize the AuthorizationDocumentPage
@@ -244,6 +436,7 @@ module Twilio
                     # @return [AuthorizationDocumentPage] AuthorizationDocumentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -263,6 +456,66 @@ module Twilio
                         '<Twilio.Numbers.V2.AuthorizationDocumentPage>'
                     end
                 end
+
+                class AuthorizationDocumentPageMetadata < PageMetadata
+                    attr_reader :authorization_document_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @authorization_document_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @authorization_document_page << AuthorizationDocumentListResponse.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
+                        @authorization_document_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class AuthorizationDocumentListResponse < InstanceListResource
+
+                    # @param [Array<AuthorizationDocumentInstance>] 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
+                      @authorization_document = data_list.map do |data|
+                        AuthorizationDocumentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def authorization_document
+                        @authorization_document
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AuthorizationDocumentInstance < InstanceResource
                     ##
                     # Initialize the AuthorizationDocumentInstance
@@ -276,6 +529,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],