twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/intelligence/v2/service.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [ServiceList] ServiceList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Services"
@@ -41,6 +42,7 @@ module Twilio
                     # @param [Boolean] media_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
                     # @param [String] webhook_url The URL Twilio will request when executing the Webhook.
                     # @param [HttpMethod] webhook_http_method 
+                    # @param [String] encryption_credential_sid The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
                     # @return [ServiceInstance] Created ServiceInstance
                     def create(
                         unique_name: nil, 
@@ -51,7 +53,8 @@ module Twilio
                         auto_redaction: :unset, 
                         media_redaction: :unset, 
                         webhook_url: :unset, 
-                        webhook_http_method: :unset
+                        webhook_http_method: :unset, 
+                        encryption_credential_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -64,10 +67,15 @@ module Twilio
                             'MediaRedaction' => media_redaction,
                             'WebhookUrl' => webhook_url,
                             'WebhookHttpMethod' => webhook_http_method,
+                            'EncryptionCredentialSid' => encryption_credential_sid,
                         })
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         ServiceInstance.new(
                             @version,
@@ -75,6 +83,64 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ServiceInstanceMetadata
+                    # @param [String] unique_name Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
+                    # @param [Boolean] auto_transcribe Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
+                    # @param [Boolean] data_logging Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @param [String] language_code The language code set during Service creation determines the Transcription language for all call recordings processed by that Service. The default is en-US if no language code is set. A Service can only support one language code, and it cannot be updated once it's set.
+                    # @param [Boolean] auto_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
+                    # @param [Boolean] media_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
+                    # @param [String] webhook_url The URL Twilio will request when executing the Webhook.
+                    # @param [HttpMethod] webhook_http_method 
+                    # @param [String] encryption_credential_sid The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
+                    # @return [ServiceInstance] Created ServiceInstance
+                    def create_with_metadata(
+                      unique_name: nil, 
+                      auto_transcribe: :unset, 
+                      data_logging: :unset, 
+                      friendly_name: :unset, 
+                      language_code: :unset, 
+                      auto_redaction: :unset, 
+                      media_redaction: :unset, 
+                      webhook_url: :unset, 
+                      webhook_http_method: :unset, 
+                      encryption_credential_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'AutoTranscribe' => auto_transcribe,
+                            'DataLogging' => data_logging,
+                            'FriendlyName' => friendly_name,
+                            'LanguageCode' => language_code,
+                            'AutoRedaction' => auto_redaction,
+                            'MediaRedaction' => media_redaction,
+                            'WebhookUrl' => webhook_url,
+                            'WebhookHttpMethod' => webhook_http_method,
+                            'EncryptionCredentialSid' => encryption_credential_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.
@@ -114,6 +180,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     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
+
                     ##
                     # When passed a block, yields ServiceInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -135,14 +223,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
@@ -177,6 +268,7 @@ module Twilio
                     # @return [ServiceContext] ServiceContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -191,9 +283,31 @@ module Twilio
 
                         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
+
                     ##
                     # Fetch the ServiceInstance
                     # @return [ServiceInstance] Fetched ServiceInstance
@@ -201,6 +315,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         ServiceInstance.new(
                             @version,
@@ -209,6 +327,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 [Boolean] auto_transcribe Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
@@ -219,6 +362,7 @@ module Twilio
                     # @param [Boolean] media_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
                     # @param [String] webhook_url The URL Twilio will request when executing the Webhook.
                     # @param [HttpMethod] webhook_http_method 
+                    # @param [String] encryption_credential_sid The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
                     # @param [String] if_match The If-Match HTTP request header
                     # @return [ServiceInstance] Updated ServiceInstance
                     def update(
@@ -230,6 +374,7 @@ module Twilio
                         media_redaction: :unset, 
                         webhook_url: :unset, 
                         webhook_http_method: :unset, 
+                        encryption_credential_sid: :unset, 
                         if_match: :unset
                     )
 
@@ -242,10 +387,15 @@ module Twilio
                             'MediaRedaction' => media_redaction,
                             'WebhookUrl' => webhook_url,
                             'WebhookHttpMethod' => webhook_http_method,
+                            'EncryptionCredentialSid' => encryption_credential_sid,
                         })
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         ServiceInstance.new(
                             @version,
@@ -254,6 +404,64 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ServiceInstanceMetadata
+                    # @param [Boolean] auto_transcribe Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
+                    # @param [Boolean] data_logging Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @param [String] unique_name Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
+                    # @param [Boolean] auto_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
+                    # @param [Boolean] media_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
+                    # @param [String] webhook_url The URL Twilio will request when executing the Webhook.
+                    # @param [HttpMethod] webhook_http_method 
+                    # @param [String] encryption_credential_sid The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
+                    # @param [String] if_match The If-Match HTTP request header
+                    # @return [ServiceInstance] Updated ServiceInstance
+                    def update_with_metadata(
+                      auto_transcribe: :unset, 
+                      data_logging: :unset, 
+                      friendly_name: :unset, 
+                      unique_name: :unset, 
+                      auto_redaction: :unset, 
+                      media_redaction: :unset, 
+                      webhook_url: :unset, 
+                      webhook_http_method: :unset, 
+                      encryption_credential_sid: :unset, 
+                      if_match: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AutoTranscribe' => auto_transcribe,
+                            'DataLogging' => data_logging,
+                            'FriendlyName' => friendly_name,
+                            'UniqueName' => unique_name,
+                            'AutoRedaction' => auto_redaction,
+                            'MediaRedaction' => media_redaction,
+                            'WebhookUrl' => webhook_url,
+                            'WebhookHttpMethod' => webhook_http_method,
+                            'EncryptionCredentialSid' => encryption_credential_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        
+                        
+                        
+                        
+                        
+                        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
+
 
                     ##
                     # Provide a user friendly representation
@@ -270,6 +478,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
@@ -279,6 +534,7 @@ module Twilio
                     # @return [ServicePage] ServicePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -298,6 +554,66 @@ module Twilio
                         '<Twilio.Intelligence.V2.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::Intelligence::V2PageMetadata>';
+                    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
@@ -311,6 +627,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -329,6 +646,7 @@ module Twilio
                             'webhook_http_method' => payload['webhook_http_method'],
                             'read_only_attached_operator_sids' => payload['read_only_attached_operator_sids'],
                             'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
+                            'encryption_credential_sid' => payload['encryption_credential_sid'],
                         }
 
                         # Context
@@ -443,6 +761,12 @@ module Twilio
                         @properties['version']
                     end
                     
+                    ##
+                    # @return [String] The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
+                    def encryption_credential_sid
+                        @properties['encryption_credential_sid']
+                    end
+                    
                     ##
                     # Delete the ServiceInstance
                     # @return [Boolean] True if delete succeeds, false otherwise
@@ -469,6 +793,7 @@ module Twilio
                     # @param [Boolean] media_redaction Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
                     # @param [String] webhook_url The URL Twilio will request when executing the Webhook.
                     # @param [HttpMethod] webhook_http_method 
+                    # @param [String] encryption_credential_sid The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
                     # @param [String] if_match The If-Match HTTP request header
                     # @return [ServiceInstance] Updated ServiceInstance
                     def update(
@@ -480,6 +805,7 @@ module Twilio
                         media_redaction: :unset, 
                         webhook_url: :unset, 
                         webhook_http_method: :unset, 
+                        encryption_credential_sid: :unset, 
                         if_match: :unset
                     )
 
@@ -492,6 +818,7 @@ module Twilio
                             media_redaction: media_redaction, 
                             webhook_url: webhook_url, 
                             webhook_http_method: webhook_http_method, 
+                            encryption_credential_sid: encryption_credential_sid, 
                             if_match: if_match, 
                         )
                     end