spatio-sdk 0.0.2

data/lib/spatio-sdk/api/conversations_api.rb

@@ -0,0 +1,612 @@
+=begin
+#SpatioAPI
+
+#The REST API that owns every resource in your Spatio workspace: notes, sheets, slides, tasks, calendar events, mail, chat, files, and contacts. SpatioMCP wraps this API; Spatio Desktop reads from it. You can call it directly from your own code.  All requests must be authenticated with a Personal Access Token (`Authorization: Bearer pat_...`) or an OAuth 2.1 access token, and use HTTPS.  Official SDKs (MIT, generated from this spec on every release):  - TypeScript: https://github.com/spatio-labs/spatio-ts (`npm install @spatio-labs/spatio-ts`) - Python: https://github.com/spatio-labs/spatio-py (`pip install spatio-sdk`) - Go: https://github.com/spatio-labs/spatio-go (`go get github.com/spatio-labs/spatio-go`)  This specification is generated from the platform-service Go source on every push to `main`. The spec, not hand-written documentation, is the source of truth: server stubs and SDKs are generated from it, and any drift between the spec and the running service fails CI. 
+
+The version of the OpenAPI document: v1
+Contact: hello@spatio.app
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module Spatio
+  class ConversationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Persist a new LLM conversation.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateConversationRequest] :create_conversation_request 
+    # @return [Conversation]
+    def create_conversation(opts = {})
+      data, _status_code, _headers = create_conversation_with_http_info(opts)
+      data
+    end
+
+    # Persist a new LLM conversation.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateConversationRequest] :create_conversation_request 
+    # @return [Array<(Conversation, Integer, Hash)>] Conversation data, response status code and response headers
+    def create_conversation_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.create_conversation ...'
+      end
+      # resource path
+      local_var_path = '/v1/conversations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_conversation_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Conversation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.create_conversation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#create_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Soft-delete a conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_conversation(id, opts = {})
+      delete_conversation_with_http_info(id, opts)
+      nil
+    end
+
+    # Soft-delete a conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_conversation_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.delete_conversation ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.delete_conversation"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.delete_conversation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#delete_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch one conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Conversation]
+    def get_conversation(id, opts = {})
+      data, _status_code, _headers = get_conversation_with_http_info(id, opts)
+      data
+    end
+
+    # Fetch one conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Conversation, Integer, Hash)>] Conversation data, response status code and response headers
+    def get_conversation_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.get_conversation ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.get_conversation"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Conversation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.get_conversation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch the most recently active conversation for a given context tag.
+    # @param context [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Conversation]
+    def get_latest_conversation_for_context(context, opts = {})
+      data, _status_code, _headers = get_latest_conversation_for_context_with_http_info(context, opts)
+      data
+    end
+
+    # Fetch the most recently active conversation for a given context tag.
+    # @param context [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Conversation, Integer, Hash)>] Conversation data, response status code and response headers
+    def get_latest_conversation_for_context_with_http_info(context, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.get_latest_conversation_for_context ...'
+      end
+      # verify the required parameter 'context' is set
+      if @api_client.config.client_side_validation && context.nil?
+        fail ArgumentError, "Missing the required parameter 'context' when calling ConversationsApi.get_latest_conversation_for_context"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/latest'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'context'] = context
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Conversation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.get_latest_conversation_for_context",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#get_latest_conversation_for_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List messages in a conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @option opts [String] :before 
+    # @return [Array<ConversationMessage>]
+    def list_conversation_messages(id, opts = {})
+      data, _status_code, _headers = list_conversation_messages_with_http_info(id, opts)
+      data
+    end
+
+    # List messages in a conversation.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @option opts [String] :before 
+    # @return [Array<(Array<ConversationMessage>, Integer, Hash)>] Array<ConversationMessage> data, response status code and response headers
+    def list_conversation_messages_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.list_conversation_messages ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.list_conversation_messages"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}/messages'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ConversationMessage>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.list_conversation_messages",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#list_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List the caller's persisted LLM conversations.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :context 
+    # @option opts [Integer] :limit 
+    # @return [Array<Conversation>]
+    def list_conversations(opts = {})
+      data, _status_code, _headers = list_conversations_with_http_info(opts)
+      data
+    end
+
+    # List the caller&#39;s persisted LLM conversations.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :context 
+    # @option opts [Integer] :limit 
+    # @return [Array<(Array<Conversation>, Integer, Hash)>] Array<Conversation> data, response status code and response headers
+    def list_conversations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.list_conversations ...'
+      end
+      # resource path
+      local_var_path = '/v1/conversations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Conversation>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.list_conversations",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#list_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Append a message to a conversation.
+    # @param id [String] 
+    # @param save_message_request [SaveMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMessage]
+    def save_conversation_message(id, save_message_request, opts = {})
+      data, _status_code, _headers = save_conversation_message_with_http_info(id, save_message_request, opts)
+      data
+    end
+
+    # Append a message to a conversation.
+    # @param id [String] 
+    # @param save_message_request [SaveMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMessage, Integer, Hash)>] ConversationMessage data, response status code and response headers
+    def save_conversation_message_with_http_info(id, save_message_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.save_conversation_message ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.save_conversation_message"
+      end
+      # verify the required parameter 'save_message_request' is set
+      if @api_client.config.client_side_validation && save_message_request.nil?
+        fail ArgumentError, "Missing the required parameter 'save_message_request' when calling ConversationsApi.save_conversation_message"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}/messages'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(save_message_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.save_conversation_message",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#save_conversation_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update conversation metadata (title, context, cwd, session_id, pinned).
+    # @param id [String] 
+    # @param update_conversation_request [UpdateConversationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Conversation]
+    def update_conversation(id, update_conversation_request, opts = {})
+      data, _status_code, _headers = update_conversation_with_http_info(id, update_conversation_request, opts)
+      data
+    end
+
+    # Update conversation metadata (title, context, cwd, session_id, pinned).
+    # @param id [String] 
+    # @param update_conversation_request [UpdateConversationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Conversation, Integer, Hash)>] Conversation data, response status code and response headers
+    def update_conversation_with_http_info(id, update_conversation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.update_conversation ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.update_conversation"
+      end
+      # verify the required parameter 'update_conversation_request' is set
+      if @api_client.config.client_side_validation && update_conversation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_conversation_request' when calling ConversationsApi.update_conversation"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_conversation_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Conversation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.update_conversation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#update_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Patch metadata on an existing message. Body must include the message id (path is the conversation id, not the message). 
+    # @param id [String] 
+    # @param update_message_metadata_request [UpdateMessageMetadataRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMessage]
+    def update_conversation_message_metadata(id, update_message_metadata_request, opts = {})
+      data, _status_code, _headers = update_conversation_message_metadata_with_http_info(id, update_message_metadata_request, opts)
+      data
+    end
+
+    # Patch metadata on an existing message. Body must include the message id (path is the conversation id, not the message). 
+    # @param id [String] 
+    # @param update_message_metadata_request [UpdateMessageMetadataRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMessage, Integer, Hash)>] ConversationMessage data, response status code and response headers
+    def update_conversation_message_metadata_with_http_info(id, update_message_metadata_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.update_conversation_message_metadata ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.update_conversation_message_metadata"
+      end
+      # verify the required parameter 'update_message_metadata_request' is set
+      if @api_client.config.client_side_validation && update_message_metadata_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_message_metadata_request' when calling ConversationsApi.update_conversation_message_metadata"
+      end
+      # resource path
+      local_var_path = '/v1/conversations/{id}/messages'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_message_metadata_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMessage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversationsApi.update_conversation_message_metadata",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#update_conversation_message_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end