trieve_ruby_client 0.3.4

data/spec/api/file_api_spec.rb

@@ -0,0 +1,89 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::FileApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FileApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::FileApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FileApi' do
+    it 'should create an instance of FileApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::FileApi)
+    end
+  end
+
+  # unit tests for delete_file_handler
+  # delete_file
+  # delete_file  Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
+  # @param tr_dataset The dataset id to use for the request
+  # @param file_id The id of the file to delete
+  # @param delete_chunks Whether or not to delete the chunks associated with the file
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_file_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_dataset_files_handler
+  # get_dataset_files
+  # get_dataset_files  Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
+  # @param tr_dataset The dataset id to use for the request
+  # @param dataset_id The id of the dataset to fetch files for.
+  # @param page The page number of files you wish to fetch. Each page contains at most 10 files.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<File>]
+  describe 'get_dataset_files_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_file_handler
+  # get_file
+  # get_file  Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
+  # @param tr_dataset The dataset id to use for the request
+  # @param file_id The id of the file to fetch
+  # @param [Hash] opts the optional parameters
+  # @return [FileDTO]
+  describe 'get_file_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for upload_file_handler
+  # upload_file
+  # upload_file  Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR&#39;ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth&#39;ed user must be an admin or owner of the dataset&#39;s organization to upload a file.
+  # @param tr_dataset The dataset id to use for the request
+  # @param upload_file_data JSON request payload to upload a file
+  # @param [Hash] opts the optional parameters
+  # @return [UploadFileResult]
+  describe 'upload_file_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/health_api_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::HealthApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'HealthApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::HealthApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of HealthApi' do
+    it 'should create an instance of HealthApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::HealthApi)
+    end
+  end
+
+  # unit tests for health_check
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'health_check test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/invitation_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::InvitationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'InvitationApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::InvitationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InvitationApi' do
+    it 'should create an instance of InvitationApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::InvitationApi)
+    end
+  end
+
+  # unit tests for post_invitation
+  # send_invitation
+  # send_invitation  Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
+  # @param tr_organization The organization id to use for the request
+  # @param invitation_data JSON request payload to send an invitation
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_invitation test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/message_api_spec.rb

@@ -0,0 +1,87 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::MessageApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MessageApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::MessageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MessageApi' do
+    it 'should create an instance of MessageApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::MessageApi)
+    end
+  end
+
+  # unit tests for create_message_completion_handler
+  # create_message
+  # create_message  Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+  # @param tr_dataset The dataset id to use for the request
+  # @param create_message_data JSON request payload to create a message completion
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'create_message_completion_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for edit_message_handler
+  # edit_message
+  # edit_message  Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+  # @param tr_dataset The dataset id to use for the request
+  # @param edit_message_data JSON request payload to edit a message and get a new stream
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'edit_message_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_topic_messages
+  # get_all_messages
+  # get_all_messages  Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+  # @param tr_dataset The dataset id to use for the request
+  # @param messages_topic_id The ID of the topic to get messages for.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Message>]
+  describe 'get_all_topic_messages test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for regenerate_message_handler
+  # regenerate_message
+  # regenerate_message  Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like &#x60;[chunks]||mesage&#x60;. See docs.trieve.ai for more information.
+  # @param tr_dataset The dataset id to use for the request
+  # @param regenerate_message_data JSON request payload to delete an agent message then regenerate it in a strem
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'regenerate_message_handler test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/organization_api_spec.rb

@@ -0,0 +1,112 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::OrganizationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrganizationApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::OrganizationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationApi' do
+    it 'should create an instance of OrganizationApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::OrganizationApi)
+    end
+  end
+
+  # unit tests for create_organization
+  # create_organization
+  # create_organization  Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
+  # @param create_organization_data The organization data that you want to create
+  # @param [Hash] opts the optional parameters
+  # @return [Organization]
+  describe 'create_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_organization_by_id
+  # delete_organization
+  # delete_organization  Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
+  # @param tr_organization The organization id to use for the request
+  # @param organization_id The id of the organization you want to fetch.
+  # @param [Hash] opts the optional parameters
+  # @return [Organization]
+  describe 'delete_organization_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_organization_by_id
+  # get_organization
+  # get_organization  Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+  # @param tr_organization The organization id to use for the request
+  # @param organization_id The id of the organization you want to fetch.
+  # @param [Hash] opts the optional parameters
+  # @return [Organization]
+  describe 'get_organization_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_organization_usage
+  # get_organization_usage
+  # get_organization_usage  Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+  # @param tr_organization The organization id to use for the request
+  # @param organization_id The id of the organization you want to fetch the usage of.
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationUsageCount]
+  describe 'get_organization_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_organization_users
+  # get_organization_users
+  # get_organization_users  Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+  # @param tr_organization The organization id to use for the request
+  # @param organization_id The id of the organization you want to fetch the users of.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<SlimUser>]
+  describe 'get_organization_users test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_organization
+  # update_organization
+  # update_organization  Update an organization. Only the owner of the organization can update it.
+  # @param tr_organization The organization id to use for the request
+  # @param update_organization_data The organization data that you want to update
+  # @param [Hash] opts the optional parameters
+  # @return [Organization]
+  describe 'update_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/stripe_api_spec.rb

@@ -0,0 +1,78 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::StripeApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'StripeApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::StripeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StripeApi' do
+    it 'should create an instance of StripeApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::StripeApi)
+    end
+  end
+
+  # unit tests for cancel_subscription
+  # @param tr_organization The organization id to use for the request
+  # @param subscription_id id of the subscription you want to cancel
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'cancel_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for direct_to_payment_link
+  # @param plan_id id of the plan you want to subscribe to
+  # @param organization_id id of the organization you want to subscribe to the plan
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'direct_to_payment_link test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_plans
+  # @param [Hash] opts the optional parameters
+  # @return [Array<StripePlan>]
+  describe 'get_all_plans test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_subscription_plan
+  # @param tr_organization The organization id to use for the request
+  # @param subscription_id id of the subscription you want to update
+  # @param plan_id id of the plan you want to subscribe to
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_subscription_plan test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/topic_api_spec.rb

@@ -0,0 +1,87 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::TopicApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TopicApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::TopicApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TopicApi' do
+    it 'should create an instance of TopicApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::TopicApi)
+    end
+  end
+
+  # unit tests for create_topic
+  # create_topic
+  # create_topic  Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
+  # @param tr_dataset The dataset id to use for the request
+  # @param create_topic_data JSON request payload to create chat topic
+  # @param [Hash] opts the optional parameters
+  # @return [Topic]
+  describe 'create_topic test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_topic
+  # delete_topic
+  # delete_topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
+  # @param tr_dataset The dataset id to use for the request
+  # @param delete_topic_data JSON request payload to delete a chat topic
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_topic test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_topics_for_user
+  # get_all_topics_for_user
+  # get_all_topics_for_user  Get all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.
+  # @param user_id The id of the user to get topics for
+  # @param tr_dataset The dataset id to use for the request
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Topic>]
+  describe 'get_all_topics_for_user test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_topic
+  # update_topic
+  # update_topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
+  # @param tr_dataset The dataset id to use for the request
+  # @param update_topic_data JSON request payload to update a chat topic
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_topic test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/user_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::UserApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::UserApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserApi' do
+    it 'should create an instance of UserApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::UserApi)
+    end
+  end
+
+  # unit tests for delete_user_api_key
+  # delete_user_api_key
+  # delete_user_api_key  Delete an api key for the auth'ed user.
+  # @param delete_user_api_key_request JSON request payload to delete a user api key
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ApiKeyDTO>]
+  describe 'delete_user_api_key test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for set_user_api_key
+  # set_user_api_key
+  # set_user_api_key  Create a new api key for the auth&#39;ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth&#39;ed user who calls this endpoint.
+  # @param set_user_api_key_request JSON request payload to create a new user api key
+  # @param [Hash] opts the optional parameters
+  # @return [SetUserApiKeyResponse]
+  describe 'set_user_api_key test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_user
+  # update_user
+  # update_user  Update a user&#39;s information. If the user_id is not provided, the auth&#39;ed user will be updated. If the user_id is provided, the auth&#39;ed user must be an admin (1) or owner (2) of the organization.
+  # @param update_user_data JSON request payload to update user information for the auth&#39;ed user
+  # @param [Hash] opts the optional parameters
+  # @return [SlimUser]
+  describe 'update_user test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/add_chunk_to_group_data_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#trieve-server
+
+#Trieve REST API OpenAPI Documentation
+
+The version of the OpenAPI document: 0.3.3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OpenapiClient::AddChunkToGroupData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OpenapiClient::AddChunkToGroupData do
+  let(:instance) { OpenapiClient::AddChunkToGroupData.new }
+
+  describe 'test an instance of AddChunkToGroupData' do
+    it 'should create an instance of AddChunkToGroupData' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(OpenapiClient::AddChunkToGroupData)
+    end
+  end
+
+  describe 'test attribute "chunk_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end