trieve_ruby_client 0.3.4 → 0.4.0

data/docs/TopicApi.md

@@ -1,22 +1,22 @@
 # TrieveRubyClient::TopicApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | create_topic |
-| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | delete_topic |
-| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | get_all_topics_for_user |
-| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | update_topic |
+| [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | Create Topic |
+| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic |
+| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User |
+| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic |
 
 
 ## create_topic
 
 > <Topic> create_topic(tr_dataset, create_topic_data)
 
-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.
+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.
 
 ### Examples
 
@@ -25,11 +25,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -41,7 +36,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 create_topic_data = TrieveRubyClient::CreateTopicData.new # CreateTopicData | JSON request payload to create chat topic
 
 begin
-  # create_topic
+  # Create Topic
   result = api_instance.create_topic(tr_dataset, create_topic_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -57,7 +52,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_topic
+  # Create Topic
   data, status_code, headers = api_instance.create_topic_with_http_info(tr_dataset, create_topic_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -80,7 +75,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -92,9 +87,9 @@ end
 
 > delete_topic(tr_dataset, delete_topic_data)
 
-delete_topic
+Delete Topic
 
-delete_topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
+Delete Topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
 
 ### Examples
 
@@ -103,11 +98,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -119,7 +109,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 delete_topic_data = TrieveRubyClient::DeleteTopicData.new({topic_id: 'topic_id_example'}) # DeleteTopicData | JSON request payload to delete a chat topic
 
 begin
-  # delete_topic
+  # Delete Topic
   api_instance.delete_topic(tr_dataset, delete_topic_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->delete_topic: #{e}"
@@ -134,7 +124,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # delete_topic
+  # Delete Topic
   data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, delete_topic_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -157,7 +147,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -169,9 +159,9 @@ nil (empty response body)
 
 > <Array<Topic>> get_all_topics_for_user(user_id, tr_dataset)
 
-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.
+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.
 
 ### Examples
 
@@ -180,11 +170,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -196,7 +181,7 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the user t
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 
 begin
-  # get_all_topics_for_user
+  # Get All Topics for User
   result = api_instance.get_all_topics_for_user(user_id, tr_dataset)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -212,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_all_topics_for_user
+  # Get All Topics for User
   data, status_code, headers = api_instance.get_all_topics_for_user_with_http_info(user_id, tr_dataset)
   p status_code # => 2xx
   p headers # => { ... }
@@ -235,7 +220,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -247,9 +232,9 @@ end
 
 > update_topic(tr_dataset, update_topic_data)
 
-update_topic
+Update Topic
 
-update_topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
+Update Topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
 
 ### Examples
 
@@ -258,11 +243,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -274,7 +254,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 update_topic_data = TrieveRubyClient::UpdateTopicData.new({name: 'name_example', topic_id: 'topic_id_example'}) # UpdateTopicData | JSON request payload to update a chat topic
 
 begin
-  # update_topic
+  # Update Topic
   api_instance.update_topic(tr_dataset, update_topic_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->update_topic: #{e}"
@@ -289,7 +269,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # update_topic
+  # Update Topic
   data, status_code, headers = api_instance.update_topic_with_http_info(tr_dataset, update_topic_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -312,7 +292,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 

data/docs/UserApi.md

@@ -1,21 +1,21 @@
 # TrieveRubyClient::UserApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | delete_user_api_key |
-| [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | set_user_api_key |
-| [**update_user**](UserApi.md#update_user) | **PUT** /api/user | update_user |
+| [**delete_user_api_key**](UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key |
+| [**set_user_api_key**](UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key |
+| [**update_user**](UserApi.md#update_user) | **PUT** /api/user | Update User |
 
 
 ## delete_user_api_key
 
 > <Array<ApiKeyDTO>> delete_user_api_key(delete_user_api_key_request)
 
-delete_user_api_key
+Delete User Api Key
 
-delete_user_api_key  Delete an api key for the auth'ed user.
+Delete User Api Key  Delete an api key for the auth'ed user.
 
 ### Examples
 
@@ -24,11 +24,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -39,7 +34,7 @@ api_instance = TrieveRubyClient::UserApi.new
 delete_user_api_key_request = TrieveRubyClient::DeleteUserApiKeyRequest.new({api_key_id: 'api_key_id_example'}) # DeleteUserApiKeyRequest | JSON request payload to delete a user api key
 
 begin
-  # delete_user_api_key
+  # Delete User Api Key
   result = api_instance.delete_user_api_key(delete_user_api_key_request)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -55,7 +50,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # delete_user_api_key
+  # Delete User Api Key
   data, status_code, headers = api_instance.delete_user_api_key_with_http_info(delete_user_api_key_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -77,7 +72,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -89,9 +84,9 @@ end
 
 > <SetUserApiKeyResponse> set_user_api_key(set_user_api_key_request)
 
-set_user_api_key
+Set User Api Key
 
-set_user_api_key  Create a new api key for the auth'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'ed user who calls this endpoint.
+Set User Api Key  Create a new api key for the auth'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'ed user who calls this endpoint.
 
 ### Examples
 
@@ -100,11 +95,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -115,7 +105,7 @@ api_instance = TrieveRubyClient::UserApi.new
 set_user_api_key_request = TrieveRubyClient::SetUserApiKeyRequest.new({name: 'name_example', role: 37}) # SetUserApiKeyRequest | JSON request payload to create a new user api key
 
 begin
-  # set_user_api_key
+  # Set User Api Key
   result = api_instance.set_user_api_key(set_user_api_key_request)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -131,7 +121,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # set_user_api_key
+  # Set User Api Key
   data, status_code, headers = api_instance.set_user_api_key_with_http_info(set_user_api_key_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -153,7 +143,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -165,9 +155,9 @@ end
 
 > <SlimUser> update_user(update_user_data)
 
-update_user
+Update User
 
-update_user  Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
+Update User  Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
 
 ### Examples
 
@@ -176,11 +166,6 @@ require 'time'
 require 'trieve_ruby_client'
 # setup authorization
 TrieveRubyClient.configure do |config|
-  # Configure API key authorization: Cookie
-  config.api_key['Cookie'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Cookie'] = 'Bearer'
-
   # Configure API key authorization: ApiKey
   config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@@ -191,7 +176,7 @@ api_instance = TrieveRubyClient::UserApi.new
 update_user_data = TrieveRubyClient::UpdateUserData.new({organization_id: 'organization_id_example'}) # UpdateUserData | JSON request payload to update user information for the auth'ed user
 
 begin
-  # update_user
+  # Update User
   result = api_instance.update_user(update_user_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -207,7 +192,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # update_user
+  # Update User
   data, status_code, headers = api_instance.update_user_with_http_info(update_user_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -229,7 +214,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 

data/lib/trieve_ruby_client/api/auth_api.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.3.4
+The version of the OpenAPI document: 0.4.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,8 +19,8 @@ module TrieveRubyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # openid_callback
-    # openid_callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
+    # OpenID Connect callback
+    # OpenID Connect callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
     # @param [Hash] opts the optional parameters
     # @return [SlimUser]
     def callback(opts = {})
@@ -28,8 +28,8 @@ module TrieveRubyClient
       data
     end
 
-    # openid_callback
-    # openid_callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
+    # OpenID Connect callback
+    # OpenID Connect callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SlimUser, Integer, Hash)>] SlimUser data, response status code and response headers
     def callback_with_http_info(opts = {})
@@ -76,8 +76,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_me
-    # get_me  Get the user corresponding to your current auth credentials.
+    # Get Me
+    # Get Me  Get the user corresponding to your current auth credentials.
     # @param [Hash] opts the optional parameters
     # @return [SlimUser]
     def get_me(opts = {})
@@ -85,8 +85,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_me
-    # get_me  Get the user corresponding to your current auth credentials.
+    # Get Me
+    # Get Me  Get the user corresponding to your current auth credentials.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SlimUser, Integer, Hash)>] SlimUser data, response status code and response headers
     def get_me_with_http_info(opts = {})
@@ -114,7 +114,7 @@ module TrieveRubyClient
       return_type = opts[:debug_return_type] || 'SlimUser'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
 
       new_options = opts.merge(
         :operation => :"AuthApi.get_me",
@@ -133,50 +133,43 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # login
-    # login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+    # Login
+    # Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+    # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
-    # @option opts [String] :organization_id ID of organization to authenticate into
-    # @option opts [String] :redirect_uri URL to redirect to after successful login
     # @return [nil]
-    def login(opts = {})
-      login_with_http_info(opts)
+    def login(content, opts = {})
+      login_with_http_info(content, opts)
       nil
     end
 
-    # login
-    # login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+    # Login
+    # Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+    # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
-    # @option opts [String] :organization_id ID of organization to authenticate into
-    # @option opts [String] :redirect_uri URL to redirect to after successful login
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def login_with_http_info(opts = {})
+    def login_with_http_info(content, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthApi.login ...'
       end
+      # verify the required parameter 'content' is set
+      if @api_client.config.client_side_validation && content.nil?
+        fail ArgumentError, "Missing the required parameter 'content' when calling AuthApi.login"
+      end
       # resource path
       local_var_path = '/api/auth'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'content'] = content
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
 
       # form parameters
       form_params = opts[:form_params] || {}
-      form_params['inv_code'] = opts[:'inv_code'] if !opts[:'inv_code'].nil?
-      form_params['organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
-      form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]
@@ -204,8 +197,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # logout
-    # logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
+    # Logout
+    # Logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def logout(opts = {})
@@ -213,8 +206,8 @@ module TrieveRubyClient
       nil
     end
 
-    # logout
-    # logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
+    # Logout
+    # Logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def logout_with_http_info(opts = {})