TrieveRubyClient::UserApi

All URIs are relative to https://api.trieve.ai

Method	HTTP request	Description
delete_user_api_key	DELETE /api/user/api_key/api_key_id	Delete User Api Key
set_user_api_key	POST /api/user/api_key	Set User Api Key
update_user	PUT /api/user	Update User

delete_user_api_key

delete_user_api_key(api_key_id)

Delete User Api Key

Delete User Api Key Delete an api key for the auth'ed user.

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # 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)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::UserApi.new
api_key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the api key to delete

begin
  # Delete User Api Key
  api_instance.delete_user_api_key(api_key_id)
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->delete_user_api_key: #{e}"
end

Using the delete_user_api_key_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

delete_user_api_key_with_http_info(api_key_id)

begin
  # Delete User Api Key
  data, status_code, headers = api_instance.delete_user_api_key_with_http_info(api_key_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->delete_user_api_key_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
api_key_id	String	The id of the api key to delete

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

set_user_api_key

set_user_api_key(set_user_api_key_request)

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.

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # 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)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

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
  result = api_instance.set_user_api_key(set_user_api_key_request)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->set_user_api_key: #{e}"
end

Using the set_user_api_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> set_user_api_key_with_http_info(set_user_api_key_request)

begin
  # 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 # => { ... }
  p data # => <SetUserApiKeyResponse>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->set_user_api_key_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
set_user_api_key_request	SetUserApiKeyRequest	JSON request payload to create a new user api key

Return type

SetUserApiKeyResponse

Authorization

ApiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

update_user

update_user(update_user_org_role_data)

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 role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # 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)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::UserApi.new
update_user_org_role_data = TrieveRubyClient::UpdateUserOrgRoleData.new({organization_id: 'organization_id_example', role: 37}) # UpdateUserOrgRoleData | JSON request payload to update user information for the auth'ed user

begin
  # Update User
  api_instance.update_user(update_user_org_role_data)
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->update_user: #{e}"
end

Using the update_user_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

update_user_with_http_info(update_user_org_role_data)

begin
  # Update User
  data, status_code, headers = api_instance.update_user_with_http_info(update_user_org_role_data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling UserApi->update_user_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
update_user_org_role_data	UpdateUserOrgRoleData	JSON request payload to update user information for the auth'ed user

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json