twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/proxy/v1/service.rb

@@ -18,12 +18,14 @@ module Twilio
         class Proxy < ProxyBase
             class V1 < Version
                 class ServiceList < ListResource
+                
                     ##
                     # Initialize the ServiceList
                     # @param [Version] version Version that contains the resource
                     # @return [ServiceList] ServiceList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Services"
@@ -41,14 +43,14 @@ module Twilio
                     # @param [String] chat_instance_sid The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
                     # @return [ServiceInstance] Created ServiceInstance
                     def create(
-                        unique_name: nil, 
-                        default_ttl: :unset, 
-                        callback_url: :unset, 
-                        geo_match_level: :unset, 
-                        number_selection_behavior: :unset, 
-                        intercept_callback_url: :unset, 
-                        out_of_session_callback_url: :unset, 
-                        chat_instance_sid: :unset
+                      unique_name: nil, 
+                      default_ttl: :unset, 
+                      callback_url: :unset, 
+                      geo_match_level: :unset, 
+                      number_selection_behavior: :unset, 
+                      intercept_callback_url: :unset, 
+                      out_of_session_callback_url: :unset, 
+                      chat_instance_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -62,13 +64,71 @@ module Twilio
                             'ChatInstanceSid' => chat_instance_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)
                         ServiceInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the ServiceInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**
+                    # @param [String] default_ttl The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.
+                    # @param [String] callback_url The URL we should call when the interaction status changes.
+                    # @param [GeoMatchLevel] geo_match_level 
+                    # @param [NumberSelectionBehavior] number_selection_behavior 
+                    # @param [String] intercept_callback_url The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.
+                    # @param [String] out_of_session_callback_url The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.
+                    # @param [String] chat_instance_sid The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
+                    # @return [ServiceInstance] Created ServiceInstance
+                    def create_with_metadata(
+                      unique_name: nil, 
+                      default_ttl: :unset, 
+                      callback_url: :unset, 
+                      geo_match_level: :unset, 
+                      number_selection_behavior: :unset, 
+                      intercept_callback_url: :unset, 
+                      out_of_session_callback_url: :unset, 
+                      chat_instance_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'DefaultTtl' => default_ttl,
+                            'CallbackUrl' => callback_url,
+                            'GeoMatchLevel' => geo_match_level,
+                            'NumberSelectionBehavior' => number_selection_behavior,
+                            'InterceptCallbackUrl' => intercept_callback_url,
+                            'OutOfSessionCallbackUrl' => out_of_session_callback_url,
+                            'ChatInstanceSid' => chat_instance_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        service_instance = ServiceInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ServiceInstanceMetadata.new(
+                            @version,
+                            service_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ServiceInstance 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 ServicePageMetadata 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)
+
+                        ServicePageMetadata.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 ServiceInstance
-                    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)
 
                         ServicePage.new(@version, response, @solution)
                     end
@@ -163,8 +256,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class ServiceContext < InstanceContext
                     ##
                     # Initialize the ServiceContext
@@ -173,6 +264,7 @@ module Twilio
                     # @return [ServiceContext] ServiceContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -180,7 +272,6 @@ module Twilio
 
                         # Dependents
                         @sessions = nil
-                        @short_codes = nil
                         @phone_numbers = nil
                     end
                     ##
@@ -188,7 +279,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 ServiceInstanceMetadata
+                    # @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)
+                          service_instance = ServiceInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ServiceInstanceMetadata.new(@version, service_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -196,7 +311,13 @@ module Twilio
                     # @return [ServiceInstance] Fetched ServiceInstance
                     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)
                         ServiceInstance.new(
                             @version,
                             payload,
@@ -204,6 +325,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ServiceInstanceMetadata
+                    # @return [ServiceInstance] Fetched ServiceInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        service_instance = ServiceInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ServiceInstanceMetadata.new(
+                            @version,
+                            service_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ServiceInstance
                     # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**
@@ -216,14 +362,14 @@ module Twilio
                     # @param [String] chat_instance_sid The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
                     # @return [ServiceInstance] Updated ServiceInstance
                     def update(
-                        unique_name: :unset, 
-                        default_ttl: :unset, 
-                        callback_url: :unset, 
-                        geo_match_level: :unset, 
-                        number_selection_behavior: :unset, 
-                        intercept_callback_url: :unset, 
-                        out_of_session_callback_url: :unset, 
-                        chat_instance_sid: :unset
+                      unique_name: :unset, 
+                      default_ttl: :unset, 
+                      callback_url: :unset, 
+                      geo_match_level: :unset, 
+                      number_selection_behavior: :unset, 
+                      intercept_callback_url: :unset, 
+                      out_of_session_callback_url: :unset, 
+                      chat_instance_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -237,7 +383,13 @@ module Twilio
                             'ChatInstanceSid' => chat_instance_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)
                         ServiceInstance.new(
                             @version,
                             payload,
@@ -245,6 +397,59 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ServiceInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**
+                    # @param [String] default_ttl The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.
+                    # @param [String] callback_url The URL we should call when the interaction status changes.
+                    # @param [GeoMatchLevel] geo_match_level 
+                    # @param [NumberSelectionBehavior] number_selection_behavior 
+                    # @param [String] intercept_callback_url The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.
+                    # @param [String] out_of_session_callback_url The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.
+                    # @param [String] chat_instance_sid The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
+                    # @return [ServiceInstance] Updated ServiceInstance
+                    def update_with_metadata(
+                      unique_name: :unset, 
+                      default_ttl: :unset, 
+                      callback_url: :unset, 
+                      geo_match_level: :unset, 
+                      number_selection_behavior: :unset, 
+                      intercept_callback_url: :unset, 
+                      out_of_session_callback_url: :unset, 
+                      chat_instance_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'DefaultTtl' => default_ttl,
+                            'CallbackUrl' => callback_url,
+                            'GeoMatchLevel' => geo_match_level,
+                            'NumberSelectionBehavior' => number_selection_behavior,
+                            'InterceptCallbackUrl' => intercept_callback_url,
+                            'OutOfSessionCallbackUrl' => out_of_session_callback_url,
+                            'ChatInstanceSid' => chat_instance_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        service_instance = ServiceInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ServiceInstanceMetadata.new(
+                            @version,
+                            service_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the sessions
                     # @return [SessionList]
@@ -265,25 +470,6 @@ module Twilio
                      @sessions
                     end
                     ##
-                    # Access the short_codes
-                    # @return [ShortCodeList]
-                    # @return [ShortCodeContext] if sid was passed.
-                    def short_codes(sid=:unset)
-
-                        raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-                        if sid != :unset
-                            return ShortCodeContext.new(@version, @solution[:sid],sid )
-                        end
-
-                        unless @short_codes
-                            @short_codes = ShortCodeList.new(
-                                @version, service_sid: @solution[:sid], )
-                        end
-
-                     @short_codes
-                    end
-                    ##
                     # Access the phone_numbers
                     # @return [PhoneNumberList]
                     # @return [PhoneNumberContext] if sid was passed.
@@ -318,6 +504,53 @@ module Twilio
                     end
                 end
 
+                class ServiceInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ServiceInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ServiceInstance] service_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 [ServiceInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, service_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @service_instance = service_instance
+                    end
+
+                    def service
+                        @service_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ServiceInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ServiceListResponse < InstanceListResource
+                    # @param [Array<ServiceInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @service_instance = payload.body[key].map do |data|
+                        ServiceInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def service_instance
+                          @instance
+                      end
+                  end
+
                 class ServicePage < Page
                     ##
                     # Initialize the ServicePage
@@ -327,6 +560,7 @@ module Twilio
                     # @return [ServicePage] ServicePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -346,6 +580,66 @@ module Twilio
                         '<Twilio.Proxy.V1.ServicePage>'
                     end
                 end
+
+                class ServicePageMetadata < PageMetadata
+                    attr_reader :service_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @service_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @service_page << ServiceListResponse.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
+                        @service_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Proxy::V1PageMetadata>';
+                    end
+                end
+                class ServiceListResponse < InstanceListResource
+
+                    # @param [Array<ServiceInstance>] 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
+                      @service = data_list.map do |data|
+                        ServiceInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def service
+                        @service
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ServiceInstance < InstanceResource
                     ##
                     # Initialize the ServiceInstance
@@ -359,6 +653,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -505,14 +800,14 @@ module Twilio
                     # @param [String] chat_instance_sid The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
                     # @return [ServiceInstance] Updated ServiceInstance
                     def update(
-                        unique_name: :unset, 
-                        default_ttl: :unset, 
-                        callback_url: :unset, 
-                        geo_match_level: :unset, 
-                        number_selection_behavior: :unset, 
-                        intercept_callback_url: :unset, 
-                        out_of_session_callback_url: :unset, 
-                        chat_instance_sid: :unset
+                      unique_name: :unset, 
+                      default_ttl: :unset, 
+                      callback_url: :unset, 
+                      geo_match_level: :unset, 
+                      number_selection_behavior: :unset, 
+                      intercept_callback_url: :unset, 
+                      out_of_session_callback_url: :unset, 
+                      chat_instance_sid: :unset
                     )
 
                         context.update(
@@ -534,13 +829,6 @@ module Twilio
                         context.sessions
                     end
 
-                    ##
-                    # Access the short_codes
-                    # @return [short_codes] short_codes
-                    def short_codes
-                        context.short_codes
-                    end
-
                     ##
                     # Access the phone_numbers
                     # @return [phone_numbers] phone_numbers

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

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