trieve_ruby_client 0.3.4

data/docs/UserApi.md

@@ -0,0 +1,238 @@
+# TrieveRubyClient::UserApi
+
+All URIs are relative to *http://localhost*
+
+| 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
+
+> <Array<ApiKeyDTO>> delete_user_api_key(delete_user_api_key_request)
+
+delete_user_api_key
+
+delete_user_api_key  Delete an api key for the auth'ed user.
+
+### Examples
+
+```ruby
+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)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+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
+  result = api_instance.delete_user_api_key(delete_user_api_key_request)
+  p result
+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, status code and headers.
+
+> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(delete_user_api_key_request)
+
+```ruby
+begin
+  # 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 # => { ... }
+  p data # => <Array<ApiKeyDTO>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling UserApi->delete_user_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delete_user_api_key_request** | [**DeleteUserApiKeyRequest**](DeleteUserApiKeyRequest.md) | JSON request payload to delete a user api key |  |
+
+### Return type
+
+[**Array&lt;ApiKeyDTO&gt;**](ApiKeyDTO.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_user_api_key
+
+> <SetUserApiKeyResponse> 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
+
+```ruby
+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)
+  # 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.
+
+> <Array(<SetUserApiKeyResponse>, Integer, Hash)> set_user_api_key_with_http_info(set_user_api_key_request)
+
+```ruby
+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**](SetUserApiKeyRequest.md) | JSON request payload to create a new user api key |  |
+
+### Return type
+
+[**SetUserApiKeyResponse**](SetUserApiKeyResponse.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_user
+
+> <SlimUser> update_user(update_user_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 auth'ed user must be an admin (1) or owner (2) of the organization.
+
+### Examples
+
+```ruby
+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)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+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
+  result = api_instance.update_user(update_user_data)
+  p result
+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, status code and headers.
+
+> <Array(<SlimUser>, Integer, Hash)> update_user_with_http_info(update_user_data)
+
+```ruby
+begin
+  # update_user
+  data, status_code, headers = api_instance.update_user_with_http_info(update_user_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlimUser>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling UserApi->update_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_user_data** | [**UpdateUserData**](UpdateUserData.md) | JSON request payload to update user information for the auth&#39;ed user |  |
+
+### Return type
+
+[**SlimUser**](SlimUser.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UserOrganization.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::UserOrganization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **role** | **Integer** |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UserOrganization.new(
+  created_at: null,
+  id: null,
+  organization_id: null,
+  role: null,
+  updated_at: null,
+  user_id: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/trieve_ruby_client/api/auth_api.rb

@@ -0,0 +1,262 @@
+=begin
+#Trieve API
+
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
+
+The version of the OpenAPI document: 0.3.4
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'cgi'
+
+module TrieveRubyClient
+  class AuthApi
+    attr_accessor :api_client
+
+    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.
+    # @param [Hash] opts the optional parameters
+    # @return [SlimUser]
+    def callback(opts = {})
+      data, _status_code, _headers = callback_with_http_info(opts)
+      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.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.callback ...'
+      end
+      # resource path
+      local_var_path = '/api/auth/callback'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SlimUser'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthApi.callback",
+        :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: AuthApi#callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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 = {})
+      data, _status_code, _headers = get_me_with_http_info(opts)
+      data
+    end
+
+    # 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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.get_me ...'
+      end
+      # resource path
+      local_var_path = '/api/auth/me'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SlimUser'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Cookie', 'ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthApi.get_me",
+        :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: AuthApi#get_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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.
+    # @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)
+      nil
+    end
+
+    # login
+    # login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.login ...'
+      end
+      # resource path
+      local_var_path = '/api/auth'
+
+      # 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'])
+      # 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]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthApi.login",
+        :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: AuthApi#login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def logout(opts = {})
+      logout_with_http_info(opts)
+      nil
+    end
+
+    # 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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.logout ...'
+      end
+      # resource path
+      local_var_path = '/api/auth'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthApi.logout",
+        :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: AuthApi#logout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end