twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/knowledge/v2/operation.rb

@@ -0,0 +1,376 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Knowledge API
+#    APIs for managing knowledge bases and knowledge content for AI-powered applications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Knowledge < KnowledgeBase
+            class V2 < Version
+                class OperationList < ListResource
+                
+                    ##
+                    # Initialize the OperationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OperationList] OperationList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V2.OperationList>'
+                    end
+                end
+
+
+                class OperationContext < InstanceContext
+                    ##
+                    # Initialize the OperationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] operation_id The operation ID returned from a write endpoint.
+                    # @return [OperationContext] OperationContext
+                    def initialize(version, operation_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { operation_id: operation_id,  }
+                        @uri = "/ControlPlane/Operations/#{@solution[:operation_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the OperationInstance
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        OperationInstance.new(
+                            @version,
+                            payload,
+                            operation_id: @solution[:operation_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the OperationInstanceMetadata
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        operation_instance = OperationInstance.new(
+                            @version,
+                            response.body,
+                            operation_id: @solution[:operation_id],
+                        )
+                        OperationInstanceMetadata.new(
+                            @version,
+                            operation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V2.OperationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V2.OperationContext #{context}>"
+                    end
+                end
+
+                class OperationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new OperationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}OperationInstance] operation_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 [OperationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, operation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @operation_instance = operation_instance
+                    end
+
+                    def operation
+                        @operation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.OperationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class OperationListResponse < InstanceListResource
+                    # @param [Array<OperationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @operation_instance = payload.body[key].map do |data|
+                        OperationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def operation_instance
+                          @instance
+                      end
+                  end
+
+                class OperationPage < TokenPage
+                    ##
+                    # Initialize the OperationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OperationPage] OperationPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OperationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OperationInstance] OperationInstance
+                    def get_instance(payload)
+                        OperationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V2.OperationPage>'
+                    end
+                end
+
+                class OperationPageMetadata < PageMetadata
+                    attr_reader :operation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @operation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @operation_page << OperationListResponse.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
+                        @operation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Knowledge::V2PageMetadata>';
+                    end
+                end
+                class OperationListResponse < InstanceListResource
+
+                    # @param [Array<OperationInstance>] 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
+                      @operation = data_list.map do |data|
+                        OperationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def operation
+                        @operation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class OperationInstance < InstanceResource
+                    ##
+                    # Initialize the OperationInstance
+                    # @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 Operation
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OperationInstance] OperationInstance
+                    def initialize(version, payload , operation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'operation_id' => payload['operation_id'],
+                            'status' => payload['status'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'status_url' => payload['status_url'],
+                            'completed_at' => Twilio.deserialize_iso8601_datetime(payload['completed_at']),
+                            'result' => payload['result'],
+                            'error' => payload['error'],
+                            'result_url' => payload['result_url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'operation_id' => operation_id  || @properties['operation_id']  , }
+                    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 [OperationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = OperationContext.new(@version , @params['operation_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier for this operation.
+                    def operation_id
+                        @properties['operation_id']
+                    end
+                    
+                    ##
+                    # @return [String] The current status of the operation.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] When the operation was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [String] URI to check operation status.
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [Time] When the operation completed or failed.
+                    def completed_at
+                        @properties['completed_at']
+                    end
+                    
+                    ##
+                    # @return [OperationResultResourceId] 
+                    def result
+                        @properties['result']
+                    end
+                    
+                    ##
+                    # @return [OperationStatusError] 
+                    def error
+                        @properties['error']
+                    end
+                    
+                    ##
+                    # @return [String] URL to fetch the resulting resource.
+                    def result_url
+                        @properties['result_url']
+                    end
+                    
+                    ##
+                    # Fetch the OperationInstance
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.OperationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.OperationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end