trieve_ruby_client 0.8.2 → 0.10.7

data/lib/trieve_ruby_client/api/chunk_group_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.8.2
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -20,7 +20,7 @@ module TrieveRubyClient
       @api_client = api_client
     end
     # Add Chunk to Group
-    # Add Chunk to Group  Route to add a chunk to a group.
+    # Add Chunk to Group  Route to add a chunk to a group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -32,7 +32,7 @@ module TrieveRubyClient
     end
 
     # Add Chunk to Group
-    # Add Chunk to Group  Route to add a chunk to a group.
+    # Add Chunk to Group  Route to add a chunk to a group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -101,7 +101,7 @@ module TrieveRubyClient
     end
 
     # Add Chunk to Group by Tracking ID
-    # Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id.
+    # Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -113,7 +113,7 @@ module TrieveRubyClient
     end
 
     # Add Chunk to Group by Tracking ID
-    # Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id.
+    # Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -182,23 +182,23 @@ module TrieveRubyClient
     end
 
     # Create Chunk Group
-    # Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
+    # Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
+    # @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
     # @param [Hash] opts the optional parameters
     # @return [ChunkGroup]
-    def create_chunk_group(tr_dataset, create_chunk_group_data, opts = {})
-      data, _status_code, _headers = create_chunk_group_with_http_info(tr_dataset, create_chunk_group_data, opts)
+    def create_chunk_group(tr_dataset, create_chunk_group_req_payload, opts = {})
+      data, _status_code, _headers = create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload, opts)
       data
     end
 
     # Create Chunk Group
-    # Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
+    # Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
+    # @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
     # @param [Hash] opts the optional parameters
     # @return [Array<(ChunkGroup, Integer, Hash)>] ChunkGroup data, response status code and response headers
-    def create_chunk_group_with_http_info(tr_dataset, create_chunk_group_data, opts = {})
+    def create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.create_chunk_group ...'
       end
@@ -206,9 +206,9 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.create_chunk_group"
       end
-      # verify the required parameter 'create_chunk_group_data' is set
-      if @api_client.config.client_side_validation && create_chunk_group_data.nil?
-        fail ArgumentError, "Missing the required parameter 'create_chunk_group_data' when calling ChunkGroupApi.create_chunk_group"
+      # verify the required parameter 'create_chunk_group_req_payload' is set
+      if @api_client.config.client_side_validation && create_chunk_group_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'create_chunk_group_req_payload' when calling ChunkGroupApi.create_chunk_group"
       end
       # resource path
       local_var_path = '/api/chunk_group'
@@ -231,7 +231,7 @@ module TrieveRubyClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_group_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_group_req_payload)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ChunkGroup'
@@ -257,7 +257,7 @@ module TrieveRubyClient
     end
 
     # Delete Group
-    # Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
+    # Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group you want to fetch.
     # @param delete_chunks [Boolean] Delete the chunks within the group
@@ -269,7 +269,7 @@ module TrieveRubyClient
     end
 
     # Delete Group
-    # Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
+    # Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group you want to fetch.
     # @param delete_chunks [Boolean] Delete the chunks within the group
@@ -334,23 +334,25 @@ module TrieveRubyClient
     end
 
     # Delete Group by Tracking ID
-    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
+    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to delete
+    # @param delete_chunks [Boolean] Delete the chunks within the group
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_group_by_tracking_id(tr_dataset, tracking_id, opts = {})
-      delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
+    def delete_group_by_tracking_id(tr_dataset, tracking_id, delete_chunks, opts = {})
+      delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks, opts)
       nil
     end
 
     # Delete Group by Tracking ID
-    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
+    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to delete
+    # @param delete_chunks [Boolean] Delete the chunks within the group
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
+    def delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.delete_group_by_tracking_id ...'
       end
@@ -362,11 +364,16 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tracking_id.nil?
         fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ChunkGroupApi.delete_group_by_tracking_id"
       end
+      # verify the required parameter 'delete_chunks' is set
+      if @api_client.config.client_side_validation && delete_chunks.nil?
+        fail ArgumentError, "Missing the required parameter 'delete_chunks' when calling ChunkGroupApi.delete_group_by_tracking_id"
+      end
       # resource path
       local_var_path = '/api/chunk_group/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'delete_chunks'] = delete_chunks
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -775,7 +782,7 @@ module TrieveRubyClient
     end
 
     # Get Recommended Groups
-    # Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
+    # Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
@@ -786,7 +793,7 @@ module TrieveRubyClient
     end
 
     # Get Recommended Groups
-    # Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
+    # Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
@@ -926,25 +933,25 @@ module TrieveRubyClient
     end
 
     # Remove Chunk from Group
-    # Remove Chunk from Group  Route to remove a chunk from a group.
+    # Remove Chunk from Group  Route to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
-    # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
+    # @param group_id [String] Id of the group you want to remove the chunk from.
+    # @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def remove_chunk_from_group(tr_dataset, group_id, create_chunk_group_data, opts = {})
-      remove_chunk_from_group_with_http_info(tr_dataset, group_id, create_chunk_group_data, opts)
+    def remove_chunk_from_group(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts = {})
+      remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts)
       nil
     end
 
     # Remove Chunk from Group
-    # Remove Chunk from Group  Route to remove a chunk from a group.
+    # Remove Chunk from Group  Route to remove a chunk from a group. Auth&#39;ed user or api key must be an admin or owner of the dataset&#39;s organization to remove a chunk from a group.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
-    # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
+    # @param group_id [String] Id of the group you want to remove the chunk from.
+    # @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def remove_chunk_from_group_with_http_info(tr_dataset, group_id, create_chunk_group_data, opts = {})
+    def remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.remove_chunk_from_group ...'
       end
@@ -956,9 +963,9 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && group_id.nil?
         fail ArgumentError, "Missing the required parameter 'group_id' when calling ChunkGroupApi.remove_chunk_from_group"
       end
-      # verify the required parameter 'create_chunk_group_data' is set
-      if @api_client.config.client_side_validation && create_chunk_group_data.nil?
-        fail ArgumentError, "Missing the required parameter 'create_chunk_group_data' when calling ChunkGroupApi.remove_chunk_from_group"
+      # verify the required parameter 'remove_chunk_from_group_req_payload' is set
+      if @api_client.config.client_side_validation && remove_chunk_from_group_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'remove_chunk_from_group_req_payload' when calling ChunkGroupApi.remove_chunk_from_group"
       end
       # resource path
       local_var_path = '/api/chunk_group/chunk/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
@@ -981,7 +988,7 @@ module TrieveRubyClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_group_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(remove_chunk_from_group_req_payload)
 
       # return_type
       return_type = opts[:debug_return_type]
@@ -1157,7 +1164,7 @@ module TrieveRubyClient
     end
 
     # Update Group
-    # Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
+    # Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -1168,7 +1175,7 @@ module TrieveRubyClient
     end
 
     # Update Group
-    # Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
+    # Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -1232,25 +1239,25 @@ module TrieveRubyClient
     end
 
     # Update Group by Tracking ID
-    # Update Group by Tracking ID  Update a chunk_group with the given tracking id.
+    # Update Group by Tracking ID  Update a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to update
-    # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup
+    # @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_data, opts = {})
-      update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_data, opts)
+    def update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts = {})
+      update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts)
       nil
     end
 
     # Update Group by Tracking ID
-    # Update Group by Tracking ID  Update a chunk_group with the given tracking id.
+    # Update Group by Tracking ID  Update a chunk_group with the given tracking id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to update
-    # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup
+    # @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_data, opts = {})
+    def update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.update_group_by_tracking_id ...'
       end
@@ -1262,9 +1269,9 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tracking_id.nil?
         fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ChunkGroupApi.update_group_by_tracking_id"
       end
-      # verify the required parameter 'update_group_by_tracking_id_data' is set
-      if @api_client.config.client_side_validation && update_group_by_tracking_id_data.nil?
-        fail ArgumentError, "Missing the required parameter 'update_group_by_tracking_id_data' when calling ChunkGroupApi.update_group_by_tracking_id"
+      # verify the required parameter 'update_group_by_tracking_id_req_payload' is set
+      if @api_client.config.client_side_validation && update_group_by_tracking_id_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'update_group_by_tracking_id_req_payload' when calling ChunkGroupApi.update_group_by_tracking_id"
       end
       # resource path
       local_var_path = '/api/chunk_group/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_id.to_s))
@@ -1287,7 +1294,7 @@ module TrieveRubyClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_group_by_tracking_id_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_group_by_tracking_id_req_payload)
 
       # return_type
       return_type = opts[:debug_return_type]

data/lib/trieve_ruby_client/api/dataset_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.8.2
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,6 +19,76 @@ module TrieveRubyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Clear Dataset
+    # Clear Dataset  Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param dataset_id [String] The id of the dataset you want to clear.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def clear_dataset(tr_dataset, dataset_id, opts = {})
+      clear_dataset_with_http_info(tr_dataset, dataset_id, opts)
+      nil
+    end
+
+    # Clear Dataset
+    # Clear Dataset  Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param dataset_id [String] The id of the dataset you want to clear.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def clear_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatasetApi.clear_dataset ...'
+      end
+      # verify the required parameter 'tr_dataset' is set
+      if @api_client.config.client_side_validation && tr_dataset.nil?
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.clear_dataset"
+      end
+      # verify the required parameter 'dataset_id' is set
+      if @api_client.config.client_side_validation && dataset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.clear_dataset"
+      end
+      # resource path
+      local_var_path = '/api/dataset/clear/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_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'])
+      header_params[:'TR-Dataset'] = tr_dataset
+
+      # 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] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatasetApi.clear_dataset",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatasetApi#clear_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create dataset
     # Create dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
     # @param tr_organization [String] The organization id to use for the request
@@ -164,6 +234,76 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Delete Dataset by Tracking ID
+    # Delete Dataset by Tracking ID  Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param tracking_id [String] The tracking id of the dataset you want to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_dataset_by_tracking_id(tr_dataset, tracking_id, opts = {})
+      delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
+      nil
+    end
+
+    # Delete Dataset by Tracking ID
+    # Delete Dataset by Tracking ID  Delete a dataset by its tracking id. The auth&#39;ed user must be an owner of the organization to delete a dataset.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param tracking_id [String] The tracking id of the dataset you want to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatasetApi.delete_dataset_by_tracking_id ...'
+      end
+      # verify the required parameter 'tr_dataset' is set
+      if @api_client.config.client_side_validation && tr_dataset.nil?
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.delete_dataset_by_tracking_id"
+      end
+      # verify the required parameter 'tracking_id' is set
+      if @api_client.config.client_side_validation && tracking_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tracking_id' when calling DatasetApi.delete_dataset_by_tracking_id"
+      end
+      # resource path
+      local_var_path = '/api/dataset/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_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'])
+      header_params[:'TR-Dataset'] = tr_dataset
+
+      # 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] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatasetApi.delete_dataset_by_tracking_id",
+        :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: DatasetApi#delete_dataset_by_tracking_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Client Configuration
     # Get Client Configuration  Get the client configuration for a dataset. Will use the TR-D
     # @param tr_dataset [String] The dataset id to use for the request
@@ -229,32 +369,26 @@ module TrieveRubyClient
     end
 
     # Get Dataset
-    # Get Dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
-    # @param tr_organization [String] The organization id to use for the request
+    # Get Dataset  Get a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset you want to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [Dataset]
-    def get_dataset(tr_organization, tr_dataset, dataset_id, opts = {})
-      data, _status_code, _headers = get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id, opts)
+    def get_dataset(tr_dataset, dataset_id, opts = {})
+      data, _status_code, _headers = get_dataset_with_http_info(tr_dataset, dataset_id, opts)
       data
     end
 
     # Get Dataset
-    # Get Dataset  Get a dataset by id. The auth&#39;ed user must be an admin or owner of the organization to get a dataset.
-    # @param tr_organization [String] The organization id to use for the request
+    # Get Dataset  Get a dataset by id. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset you want to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Dataset, Integer, Hash)>] Dataset data, response status code and response headers
-    def get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id, opts = {})
+    def get_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DatasetApi.get_dataset ...'
       end
-      # verify the required parameter 'tr_organization' is set
-      if @api_client.config.client_side_validation && tr_organization.nil?
-        fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.get_dataset"
-      end
       # verify the required parameter 'tr_dataset' is set
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_dataset"
@@ -273,7 +407,6 @@ module TrieveRubyClient
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      header_params[:'TR-Organization'] = tr_organization
       header_params[:'TR-Dataset'] = tr_dataset
 
       # form parameters
@@ -306,10 +439,12 @@ module TrieveRubyClient
     end
 
     # Get Datasets from Organization
-    # Get Datasets from Organization  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
+    # Get Datasets from Organization  Get all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_organization [String] The organization id to use for the request
     # @param organization_id [String] id of the organization you want to retrieve datasets for
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of records to return
+    # @option opts [Integer] :offset The number of records to skip
     # @return [Array<DatasetAndUsage>]
     def get_datasets_from_organization(tr_organization, organization_id, opts = {})
       data, _status_code, _headers = get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
@@ -317,10 +452,12 @@ module TrieveRubyClient
     end
 
     # Get Datasets from Organization
-    # Get Datasets from Organization  Get all datasets for an organization. The auth&#39;ed user must be an admin or owner of the organization to get its datasets.
+    # Get Datasets from Organization  Get all datasets for an organization. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_organization [String] The organization id to use for the request
     # @param organization_id [String] id of the organization you want to retrieve datasets for
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of records to return
+    # @option opts [Integer] :offset The number of records to skip
     # @return [Array<(Array<DatasetAndUsage>, Integer, Hash)>] Array<DatasetAndUsage> data, response status code and response headers
     def get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts = {})
       if @api_client.config.debugging
@@ -339,6 +476,8 @@ module TrieveRubyClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -375,6 +514,76 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Get Usage By Dataset ID
+    # Get Usage By Dataset ID  Get the usage for a dataset by its id.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param dataset_id [String] The id of the dataset you want to retrieve usage for.
+    # @param [Hash] opts the optional parameters
+    # @return [DatasetUsageCount]
+    def get_usage_by_dataset_id(tr_dataset, dataset_id, opts = {})
+      data, _status_code, _headers = get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id, opts)
+      data
+    end
+
+    # Get Usage By Dataset ID
+    # Get Usage By Dataset ID  Get the usage for a dataset by its id.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param dataset_id [String] The id of the dataset you want to retrieve usage for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DatasetUsageCount, Integer, Hash)>] DatasetUsageCount data, response status code and response headers
+    def get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatasetApi.get_usage_by_dataset_id ...'
+      end
+      # verify the required parameter 'tr_dataset' is set
+      if @api_client.config.client_side_validation && tr_dataset.nil?
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_usage_by_dataset_id"
+      end
+      # verify the required parameter 'dataset_id' is set
+      if @api_client.config.client_side_validation && dataset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.get_usage_by_dataset_id"
+      end
+      # resource path
+      local_var_path = '/api/dataset/usage/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_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'])
+      header_params[:'TR-Dataset'] = tr_dataset
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DatasetUsageCount'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatasetApi.get_usage_by_dataset_id",
+        :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: DatasetApi#get_usage_by_dataset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update Dataset
     # Update Dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
     # @param tr_organization [String] The organization id to use for the request

data/lib/trieve_ruby_client/api/events_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.8.2
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0