twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/knowledge/v1/knowledge/knowledge_status.rb

@@ -0,0 +1,349 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Knowledge
+#    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 Knowledge < KnowledgeBase
+            class V1 < Version
+                class Knowledge < InstanceContext
+
+                     class KnowledgeStatusList < ListResource
+                
+                    ##
+                    # Initialize the KnowledgeStatusList
+                    # @param [Version] version Version that contains the resource
+                    # @return [KnowledgeStatusList] KnowledgeStatusList
+                    def initialize(version, id: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { id: id }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V1.KnowledgeStatusList>'
+                    end
+                end
+
+
+                class KnowledgeStatusContext < InstanceContext
+                    ##
+                    # Initialize the KnowledgeStatusContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id the Knowledge ID.
+                    # @return [KnowledgeStatusContext] KnowledgeStatusContext
+                    def initialize(version, id)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { id: id,  }
+                        @uri = "/Knowledge/#{@solution[:id]}/Status"
+
+                        
+                    end
+                    ##
+                    # Fetch the KnowledgeStatusInstance
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        KnowledgeStatusInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the KnowledgeStatusInstanceMetadata
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        knowledge_status_instance = KnowledgeStatusInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeStatusInstanceMetadata.new(
+                            @version,
+                            knowledge_status_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.V1.KnowledgeStatusContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V1.KnowledgeStatusContext #{context}>"
+                    end
+                end
+
+                class KnowledgeStatusInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new KnowledgeStatusInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}KnowledgeStatusInstance] knowledge_status_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 [KnowledgeStatusInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, knowledge_status_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @knowledge_status_instance = knowledge_status_instance
+                    end
+
+                    def knowledge_status
+                        @knowledge_status_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.KnowledgeStatusInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class KnowledgeStatusListResponse < InstanceListResource
+                    # @param [Array<KnowledgeStatusInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @knowledge_status_instance = payload.body[key].map do |data|
+                        KnowledgeStatusInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def knowledge_status_instance
+                          @instance
+                      end
+                  end
+
+                class KnowledgeStatusPage < Page
+                    ##
+                    # Initialize the KnowledgeStatusPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [KnowledgeStatusPage] KnowledgeStatusPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of KnowledgeStatusInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [KnowledgeStatusInstance] KnowledgeStatusInstance
+                    def get_instance(payload)
+                        KnowledgeStatusInstance.new(@version, payload, id: @solution[:id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V1.KnowledgeStatusPage>'
+                    end
+                end
+
+                class KnowledgeStatusPageMetadata < PageMetadata
+                    attr_reader :knowledge_status_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @knowledge_status_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @knowledge_status_page << KnowledgeStatusListResponse.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
+                        @knowledge_status_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Knowledge::V1PageMetadata>';
+                    end
+                end
+                class KnowledgeStatusListResponse < InstanceListResource
+
+                    # @param [Array<KnowledgeStatusInstance>] 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
+                      @knowledge_status = data_list.map do |data|
+                        KnowledgeStatusInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def knowledge_status
+                        @knowledge_status
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class KnowledgeStatusInstance < InstanceResource
+                    ##
+                    # Initialize the KnowledgeStatusInstance
+                    # @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 KnowledgeStatus
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [KnowledgeStatusInstance] KnowledgeStatusInstance
+                    def initialize(version, payload , id: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'status' => payload['status'],
+                            'last_status' => payload['last_status'],
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id' => id  || @properties['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 [KnowledgeStatusContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = KnowledgeStatusContext.new(@version , @params['id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The last status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def last_status
+                        @properties['last_status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Fetch the KnowledgeStatusInstance
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V1.KnowledgeStatusInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V1.KnowledgeStatusInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+