twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/trunking/v1/trunk.rb

@@ -18,12 +18,14 @@ module Twilio
         class Trunking < TrunkingBase
             class V1 < Version
                 class TrunkList < ListResource
+                
                     ##
                     # Initialize the TrunkList
                     # @param [Version] version Version that contains the resource
                     # @return [TrunkList] TrunkList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Trunks"
@@ -41,14 +43,14 @@ module Twilio
                     # @param [TransferCallerId] transfer_caller_id 
                     # @return [TrunkInstance] Created TrunkInstance
                     def create(
-                        friendly_name: :unset, 
-                        domain_name: :unset, 
-                        disaster_recovery_url: :unset, 
-                        disaster_recovery_method: :unset, 
-                        transfer_mode: :unset, 
-                        secure: :unset, 
-                        cnam_lookup_enabled: :unset, 
-                        transfer_caller_id: :unset
+                      friendly_name: :unset, 
+                      domain_name: :unset, 
+                      disaster_recovery_url: :unset, 
+                      disaster_recovery_method: :unset, 
+                      transfer_mode: :unset, 
+                      secure: :unset, 
+                      cnam_lookup_enabled: :unset, 
+                      transfer_caller_id: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -62,13 +64,71 @@ module Twilio
                             'TransferCallerId' => transfer_caller_id,
                         })
 
-                        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)
                         TrunkInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the TrunkInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @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 `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
+                    # @param [String] disaster_recovery_url The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
+                    # @param [String] disaster_recovery_method The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.
+                    # @param [TransferSetting] transfer_mode 
+                    # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
+                    # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
+                    # @param [TransferCallerId] transfer_caller_id 
+                    # @return [TrunkInstance] Created TrunkInstance
+                    def create_with_metadata(
+                      friendly_name: :unset, 
+                      domain_name: :unset, 
+                      disaster_recovery_url: :unset, 
+                      disaster_recovery_method: :unset, 
+                      transfer_mode: :unset, 
+                      secure: :unset, 
+                      cnam_lookup_enabled: :unset, 
+                      transfer_caller_id: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'DomainName' => domain_name,
+                            'DisasterRecoveryUrl' => disaster_recovery_url,
+                            'DisasterRecoveryMethod' => disaster_recovery_method,
+                            'TransferMode' => transfer_mode,
+                            'Secure' => secure,
+                            'CnamLookupEnabled' => cnam_lookup_enabled,
+                            'TransferCallerId' => transfer_caller_id,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        trunk_instance = TrunkInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TrunkInstanceMetadata.new(
+                            @version,
+                            trunk_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists TrunkInstance records from the API as a list.
@@ -105,7 +165,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 TrunkPageMetadata 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)
+
+                        TrunkPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -117,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
 
                     ##
@@ -129,14 +219,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 TrunkInstance
-                    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)
 
                         TrunkPage.new(@version, response, @solution)
                     end
@@ -171,6 +264,7 @@ module Twilio
                     # @return [TrunkContext] TrunkContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -188,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 TrunkInstanceMetadata
+                    # @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)
+                          trunk_instance = TrunkInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TrunkInstanceMetadata.new(@version, trunk_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -196,7 +314,13 @@ module Twilio
                     # @return [TrunkInstance] Fetched TrunkInstance
                     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)
                         TrunkInstance.new(
                             @version,
                             payload,
@@ -204,6 +328,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TrunkInstanceMetadata
+                    # @return [TrunkInstance] Fetched TrunkInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        trunk_instance = TrunkInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        TrunkInstanceMetadata.new(
+                            @version,
+                            trunk_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the TrunkInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@@ -216,14 +365,14 @@ module Twilio
                     # @param [TransferCallerId] transfer_caller_id 
                     # @return [TrunkInstance] Updated TrunkInstance
                     def update(
-                        friendly_name: :unset, 
-                        domain_name: :unset, 
-                        disaster_recovery_url: :unset, 
-                        disaster_recovery_method: :unset, 
-                        transfer_mode: :unset, 
-                        secure: :unset, 
-                        cnam_lookup_enabled: :unset, 
-                        transfer_caller_id: :unset
+                      friendly_name: :unset, 
+                      domain_name: :unset, 
+                      disaster_recovery_url: :unset, 
+                      disaster_recovery_method: :unset, 
+                      transfer_mode: :unset, 
+                      secure: :unset, 
+                      cnam_lookup_enabled: :unset, 
+                      transfer_caller_id: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -237,7 +386,13 @@ module Twilio
                             'TransferCallerId' => transfer_caller_id,
                         })
 
-                        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)
                         TrunkInstance.new(
                             @version,
                             payload,
@@ -245,6 +400,59 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the TrunkInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @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 `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
+                    # @param [String] disaster_recovery_url The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
+                    # @param [String] disaster_recovery_method The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.
+                    # @param [TransferSetting] transfer_mode 
+                    # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
+                    # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
+                    # @param [TransferCallerId] transfer_caller_id 
+                    # @return [TrunkInstance] Updated TrunkInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      domain_name: :unset, 
+                      disaster_recovery_url: :unset, 
+                      disaster_recovery_method: :unset, 
+                      transfer_mode: :unset, 
+                      secure: :unset, 
+                      cnam_lookup_enabled: :unset, 
+                      transfer_caller_id: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'DomainName' => domain_name,
+                            'DisasterRecoveryUrl' => disaster_recovery_url,
+                            'DisasterRecoveryMethod' => disaster_recovery_method,
+                            'TransferMode' => transfer_mode,
+                            'Secure' => secure,
+                            'CnamLookupEnabled' => cnam_lookup_enabled,
+                            'TransferCallerId' => transfer_caller_id,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        trunk_instance = TrunkInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        TrunkInstanceMetadata.new(
+                            @version,
+                            trunk_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the recordings
                     # @return [RecordingList]
@@ -347,6 +555,53 @@ module Twilio
                     end
                 end
 
+                class TrunkInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TrunkInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TrunkInstance] trunk_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 [TrunkInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, trunk_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @trunk_instance = trunk_instance
+                    end
+
+                    def trunk
+                        @trunk_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TrunkInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TrunkListResponse < InstanceListResource
+                    # @param [Array<TrunkInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @trunk_instance = payload.body[key].map do |data|
+                        TrunkInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def trunk_instance
+                          @instance
+                      end
+                  end
+
                 class TrunkPage < Page
                     ##
                     # Initialize the TrunkPage
@@ -356,6 +611,7 @@ module Twilio
                     # @return [TrunkPage] TrunkPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -375,6 +631,66 @@ module Twilio
                         '<Twilio.Trunking.V1.TrunkPage>'
                     end
                 end
+
+                class TrunkPageMetadata < PageMetadata
+                    attr_reader :trunk_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @trunk_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @trunk_page << TrunkListResponse.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
+                        @trunk_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trunking::V1PageMetadata>';
+                    end
+                end
+                class TrunkListResponse < InstanceListResource
+
+                    # @param [Array<TrunkInstance>] 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
+                      @trunk = data_list.map do |data|
+                        TrunkInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def trunk
+                        @trunk
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TrunkInstance < InstanceResource
                     ##
                     # Initialize the TrunkInstance
@@ -388,6 +704,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -401,6 +718,7 @@ module Twilio
                             'transfer_caller_id' => payload['transfer_caller_id'],
                             'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
                             'auth_type' => payload['auth_type'],
+                            'symmetric_rtp_enabled' => payload['symmetric_rtp_enabled'],
                             'auth_type_set' => payload['auth_type_set'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
@@ -491,6 +809,12 @@ module Twilio
                         @properties['auth_type']
                     end
                     
+                    ##
+                    # @return [Boolean] Whether Symmetric RTP is enabled for the trunk. When Symmetric RTP is disabled, Twilio will send RTP to the destination negotiated in the SDP. Disabling Symmetric RTP is considered to be more secure and therefore recommended. See [Symmetric RTP](https://www.twilio.com/docs/sip-trunking#symmetric-rtp) for more information.
+                    def symmetric_rtp_enabled
+                        @properties['symmetric_rtp_enabled']
+                    end
+                    
                     ##
                     # @return [Array<String>] Reserved.
                     def auth_type_set
@@ -555,14 +879,14 @@ module Twilio
                     # @param [TransferCallerId] transfer_caller_id 
                     # @return [TrunkInstance] Updated TrunkInstance
                     def update(
-                        friendly_name: :unset, 
-                        domain_name: :unset, 
-                        disaster_recovery_url: :unset, 
-                        disaster_recovery_method: :unset, 
-                        transfer_mode: :unset, 
-                        secure: :unset, 
-                        cnam_lookup_enabled: :unset, 
-                        transfer_caller_id: :unset
+                      friendly_name: :unset, 
+                      domain_name: :unset, 
+                      disaster_recovery_url: :unset, 
+                      disaster_recovery_method: :unset, 
+                      transfer_mode: :unset, 
+                      secure: :unset, 
+                      cnam_lookup_enabled: :unset, 
+                      transfer_caller_id: :unset
                     )
 
                         context.update(

data/lib/twilio-ruby/rest/trunking/v1.rb

@@ -32,6 +32,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @trunks ||= TrunkList.new self
                     else