twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class SipList < ListResource
 
                      class DomainList < ListResource
+                
                     ##
                     # Initialize the DomainList
                     # @param [Version] version Version that contains the resource
                     # @return [DomainList] DomainList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains.json"
@@ -49,19 +51,19 @@ module Twilio
                     # @param [String] emergency_caller_sid Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
                     # @return [DomainInstance] Created DomainInstance
                     def create(
-                        domain_name: nil, 
-                        friendly_name: :unset, 
-                        voice_url: :unset, 
-                        voice_method: :unset, 
-                        voice_fallback_url: :unset, 
-                        voice_fallback_method: :unset, 
-                        voice_status_callback_url: :unset, 
-                        voice_status_callback_method: :unset, 
-                        sip_registration: :unset, 
-                        emergency_calling_enabled: :unset, 
-                        secure: :unset, 
-                        byoc_trunk_sid: :unset, 
-                        emergency_caller_sid: :unset
+                      domain_name: nil, 
+                      friendly_name: :unset, 
+                      voice_url: :unset, 
+                      voice_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_status_callback_url: :unset, 
+                      voice_status_callback_method: :unset, 
+                      sip_registration: :unset, 
+                      emergency_calling_enabled: :unset, 
+                      secure: :unset, 
+                      byoc_trunk_sid: :unset, 
+                      emergency_caller_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -80,7 +82,13 @@ module Twilio
                             'EmergencyCallerSid' => emergency_caller_sid,
                         })
 
-                        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)
                         DomainInstance.new(
                             @version,
                             payload,
@@ -88,6 +96,74 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the DomainInstanceMetadata
+                    # @param [String] domain_name The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`.
+                    # @param [String] friendly_name A descriptive string that you created to describe the resource. It can be up to 64 characters long.
+                    # @param [String] voice_url The URL we should when the domain receives a call.
+                    # @param [String] voice_method The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.
+                    # @param [String] voice_fallback_url The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`.
+                    # @param [String] voice_fallback_method The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
+                    # @param [String] voice_status_callback_url The URL that we should call to pass status parameters (such as call ended) to your application.
+                    # @param [String] voice_status_callback_method The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.
+                    # @param [Boolean] sip_registration Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.
+                    # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
+                    # @param [Boolean] secure Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
+                    # @param [String] byoc_trunk_sid The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
+                    # @param [String] emergency_caller_sid Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
+                    # @return [DomainInstance] Created DomainInstance
+                    def create_with_metadata(
+                      domain_name: nil, 
+                      friendly_name: :unset, 
+                      voice_url: :unset, 
+                      voice_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_status_callback_url: :unset, 
+                      voice_status_callback_method: :unset, 
+                      sip_registration: :unset, 
+                      emergency_calling_enabled: :unset, 
+                      secure: :unset, 
+                      byoc_trunk_sid: :unset, 
+                      emergency_caller_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'DomainName' => domain_name,
+                            'FriendlyName' => friendly_name,
+                            'VoiceUrl' => voice_url,
+                            'VoiceMethod' => voice_method,
+                            'VoiceFallbackUrl' => voice_fallback_url,
+                            'VoiceFallbackMethod' => voice_fallback_method,
+                            'VoiceStatusCallbackUrl' => voice_status_callback_url,
+                            'VoiceStatusCallbackMethod' => voice_status_callback_method,
+                            'SipRegistration' => sip_registration,
+                            'EmergencyCallingEnabled' => emergency_calling_enabled,
+                            'Secure' => secure,
+                            'ByocTrunkSid' => byoc_trunk_sid,
+                            'EmergencyCallerSid' => emergency_caller_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        domain_instance = DomainInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        DomainInstanceMetadata.new(
+                            @version,
+                            domain_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists DomainInstance records from the API as a list.
@@ -124,7 +200,33 @@ module Twilio
                         page = self.page(
                             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 DomainPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        DomainPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -136,9 +238,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
 
                     ##
@@ -148,14 +254,17 @@ 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 DomainInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             '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)
 
                         DomainPage.new(@version, response, @solution)
                     end
@@ -191,6 +300,7 @@ module Twilio
                     # @return [DomainContext] DomainContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -206,7 +316,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 DomainInstanceMetadata
+                    # @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)
+                          domain_instance = DomainInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          DomainInstanceMetadata.new(@version, domain_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -214,7 +348,13 @@ module Twilio
                     # @return [DomainInstance] Fetched DomainInstance
                     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)
                         DomainInstance.new(
                             @version,
                             payload,
@@ -223,6 +363,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the DomainInstanceMetadata
+                    # @return [DomainInstance] Fetched DomainInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        domain_instance = DomainInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        DomainInstanceMetadata.new(
+                            @version,
+                            domain_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the DomainInstance
                     # @param [String] friendly_name A descriptive string that you created to describe the resource. It can be up to 64 characters long.
@@ -240,19 +406,19 @@ module Twilio
                     # @param [String] emergency_caller_sid Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
                     # @return [DomainInstance] Updated DomainInstance
                     def update(
-                        friendly_name: :unset, 
-                        voice_fallback_method: :unset, 
-                        voice_fallback_url: :unset, 
-                        voice_method: :unset, 
-                        voice_status_callback_method: :unset, 
-                        voice_status_callback_url: :unset, 
-                        voice_url: :unset, 
-                        sip_registration: :unset, 
-                        domain_name: :unset, 
-                        emergency_calling_enabled: :unset, 
-                        secure: :unset, 
-                        byoc_trunk_sid: :unset, 
-                        emergency_caller_sid: :unset
+                      friendly_name: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_status_callback_method: :unset, 
+                      voice_status_callback_url: :unset, 
+                      voice_url: :unset, 
+                      sip_registration: :unset, 
+                      domain_name: :unset, 
+                      emergency_calling_enabled: :unset, 
+                      secure: :unset, 
+                      byoc_trunk_sid: :unset, 
+                      emergency_caller_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -271,7 +437,13 @@ module Twilio
                             'EmergencyCallerSid' => emergency_caller_sid,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         DomainInstance.new(
                             @version,
                             payload,
@@ -280,6 +452,75 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the DomainInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you created to describe the resource. It can be up to 64 characters long.
+                    # @param [String] voice_fallback_method The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
+                    # @param [String] voice_fallback_url The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`.
+                    # @param [String] voice_method The HTTP method we should use to call `voice_url`
+                    # @param [String] voice_status_callback_method The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.
+                    # @param [String] voice_status_callback_url The URL that we should call to pass status parameters (such as call ended) to your application.
+                    # @param [String] voice_url The URL we should call when the domain receives a call.
+                    # @param [Boolean] sip_registration Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.
+                    # @param [String] domain_name The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`.
+                    # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
+                    # @param [Boolean] secure Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
+                    # @param [String] byoc_trunk_sid The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
+                    # @param [String] emergency_caller_sid Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
+                    # @return [DomainInstance] Updated DomainInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_status_callback_method: :unset, 
+                      voice_status_callback_url: :unset, 
+                      voice_url: :unset, 
+                      sip_registration: :unset, 
+                      domain_name: :unset, 
+                      emergency_calling_enabled: :unset, 
+                      secure: :unset, 
+                      byoc_trunk_sid: :unset, 
+                      emergency_caller_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'VoiceFallbackMethod' => voice_fallback_method,
+                            'VoiceFallbackUrl' => voice_fallback_url,
+                            'VoiceMethod' => voice_method,
+                            'VoiceStatusCallbackMethod' => voice_status_callback_method,
+                            'VoiceStatusCallbackUrl' => voice_status_callback_url,
+                            'VoiceUrl' => voice_url,
+                            'SipRegistration' => sip_registration,
+                            'DomainName' => domain_name,
+                            'EmergencyCallingEnabled' => emergency_calling_enabled,
+                            'Secure' => secure,
+                            'ByocTrunkSid' => byoc_trunk_sid,
+                            'EmergencyCallerSid' => emergency_caller_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        domain_instance = DomainInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        DomainInstanceMetadata.new(
+                            @version,
+                            domain_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the auth
                     # @return [AuthTypesList]
@@ -345,6 +586,53 @@ module Twilio
                     end
                 end
 
+                class DomainInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DomainInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DomainInstance] domain_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 [DomainInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, domain_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @domain_instance = domain_instance
+                    end
+
+                    def domain
+                        @domain_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DomainInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DomainListResponse < InstanceListResource
+                    # @param [Array<DomainInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @domain_instance = payload.body[key].map do |data|
+                        DomainInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def domain_instance
+                          @instance
+                      end
+                  end
+
                 class DomainPage < Page
                     ##
                     # Initialize the DomainPage
@@ -354,6 +642,7 @@ module Twilio
                     # @return [DomainPage] DomainPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -373,6 +662,66 @@ module Twilio
                         '<Twilio.Api.V2010.DomainPage>'
                     end
                 end
+
+                class DomainPageMetadata < PageMetadata
+                    attr_reader :domain_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @domain_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @domain_page << DomainListResponse.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
+                        @domain_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class DomainListResponse < InstanceListResource
+
+                    # @param [Array<DomainInstance>] 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
+                      @domain = data_list.map do |data|
+                        DomainInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def domain
+                        @domain
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DomainInstance < InstanceResource
                     ##
                     # Initialize the DomainInstance
@@ -386,6 +735,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -586,19 +936,19 @@ module Twilio
                     # @param [String] emergency_caller_sid Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
                     # @return [DomainInstance] Updated DomainInstance
                     def update(
-                        friendly_name: :unset, 
-                        voice_fallback_method: :unset, 
-                        voice_fallback_url: :unset, 
-                        voice_method: :unset, 
-                        voice_status_callback_method: :unset, 
-                        voice_status_callback_url: :unset, 
-                        voice_url: :unset, 
-                        sip_registration: :unset, 
-                        domain_name: :unset, 
-                        emergency_calling_enabled: :unset, 
-                        secure: :unset, 
-                        byoc_trunk_sid: :unset, 
-                        emergency_caller_sid: :unset
+                      friendly_name: :unset, 
+                      voice_fallback_method: :unset, 
+                      voice_fallback_url: :unset, 
+                      voice_method: :unset, 
+                      voice_status_callback_method: :unset, 
+                      voice_status_callback_url: :unset, 
+                      voice_url: :unset, 
+                      sip_registration: :unset, 
+                      domain_name: :unset, 
+                      emergency_calling_enabled: :unset, 
+                      secure: :unset, 
+                      byoc_trunk_sid: :unset, 
+                      emergency_caller_sid: :unset
                     )
 
                         context.update(