twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/intelligence/v2/transcript/encrypted_operator_results.rb

@@ -0,0 +1,359 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Intelligence
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Intelligence < IntelligenceBase
+            class V2 < Version
+                class TranscriptContext < InstanceContext
+
+                     class EncryptedOperatorResultsList < ListResource
+                
+                    ##
+                    # Initialize the EncryptedOperatorResultsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [EncryptedOperatorResultsList] EncryptedOperatorResultsList
+                    def initialize(version, transcript_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { transcript_sid: transcript_sid }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Intelligence.V2.EncryptedOperatorResultsList>'
+                    end
+                end
+
+
+                class EncryptedOperatorResultsContext < InstanceContext
+                    ##
+                    # Initialize the EncryptedOperatorResultsContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] transcript_sid The unique SID identifier of the Transcript.
+                    # @return [EncryptedOperatorResultsContext] EncryptedOperatorResultsContext
+                    def initialize(version, transcript_sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { transcript_sid: transcript_sid,  }
+                        @uri = "/Transcripts/#{@solution[:transcript_sid]}/OperatorResults/Encrypted"
+
+                        
+                    end
+                    ##
+                    # Fetch the EncryptedOperatorResultsInstance
+                    # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Operator Results. If redaction is enabled, the default is `true` to access redacted operator results.
+                    # @return [EncryptedOperatorResultsInstance] Fetched EncryptedOperatorResultsInstance
+                    def fetch(
+                        redacted: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        EncryptedOperatorResultsInstance.new(
+                            @version,
+                            payload,
+                            transcript_sid: @solution[:transcript_sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the EncryptedOperatorResultsInstanceMetadata
+                    # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Operator Results. If redaction is enabled, the default is `true` to access redacted operator results.
+                    # @return [EncryptedOperatorResultsInstance] Fetched EncryptedOperatorResultsInstance
+                    def fetch_with_metadata(
+                      redacted: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        encrypted_operator_results_instance = EncryptedOperatorResultsInstance.new(
+                            @version,
+                            response.body,
+                            transcript_sid: @solution[:transcript_sid],
+                        )
+                        EncryptedOperatorResultsInstanceMetadata.new(
+                            @version,
+                            encrypted_operator_results_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V2.EncryptedOperatorResultsContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V2.EncryptedOperatorResultsContext #{context}>"
+                    end
+                end
+
+                class EncryptedOperatorResultsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EncryptedOperatorResultsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EncryptedOperatorResultsInstance] encrypted_operator_results_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 [EncryptedOperatorResultsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, encrypted_operator_results_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @encrypted_operator_results_instance = encrypted_operator_results_instance
+                    end
+
+                    def encrypted_operator_results
+                        @encrypted_operator_results_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EncryptedOperatorResultsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EncryptedOperatorResultsListResponse < InstanceListResource
+                    # @param [Array<EncryptedOperatorResultsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @encrypted_operator_results_instance = payload.body[key].map do |data|
+                        EncryptedOperatorResultsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def encrypted_operator_results_instance
+                          @instance
+                      end
+                  end
+
+                class EncryptedOperatorResultsPage < Page
+                    ##
+                    # Initialize the EncryptedOperatorResultsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [EncryptedOperatorResultsPage] EncryptedOperatorResultsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of EncryptedOperatorResultsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [EncryptedOperatorResultsInstance] EncryptedOperatorResultsInstance
+                    def get_instance(payload)
+                        EncryptedOperatorResultsInstance.new(@version, payload, transcript_sid: @solution[:transcript_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Intelligence.V2.EncryptedOperatorResultsPage>'
+                    end
+                end
+
+                class EncryptedOperatorResultsPageMetadata < PageMetadata
+                    attr_reader :encrypted_operator_results_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @encrypted_operator_results_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @encrypted_operator_results_page << EncryptedOperatorResultsListResponse.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
+                        @encrypted_operator_results_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Intelligence::V2PageMetadata>';
+                    end
+                end
+                class EncryptedOperatorResultsListResponse < InstanceListResource
+
+                    # @param [Array<EncryptedOperatorResultsInstance>] 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
+                      @encrypted_operator_results = data_list.map do |data|
+                        EncryptedOperatorResultsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def encrypted_operator_results
+                        @encrypted_operator_results
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class EncryptedOperatorResultsInstance < InstanceResource
+                    ##
+                    # Initialize the EncryptedOperatorResultsInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this EncryptedOperatorResults
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [EncryptedOperatorResultsInstance] EncryptedOperatorResultsInstance
+                    def initialize(version, payload , transcript_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'locations' => payload['locations'],
+                            'transcript_sid' => payload['transcript_sid'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'transcript_sid' => transcript_sid  || @properties['transcript_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [EncryptedOperatorResultsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = EncryptedOperatorResultsContext.new(@version , @params['transcript_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The locations of the encrypted operator results.
+                    def locations
+                        @properties['locations']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def transcript_sid
+                        @properties['transcript_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the EncryptedOperatorResultsInstance
+                    # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Operator Results. If redaction is enabled, the default is `true` to access redacted operator results.
+                    # @return [EncryptedOperatorResultsInstance] Fetched EncryptedOperatorResultsInstance
+                    def fetch(
+                        redacted: :unset
+                    )
+
+                        context.fetch(
+                            redacted: redacted, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V2.EncryptedOperatorResultsInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V2.EncryptedOperatorResultsInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+