trieve_ruby_client 0.3.4 → 0.4.0

data/docs/OrganizationApi.md

@@ -1,24 +1,24 @@
 # TrieveRubyClient::OrganizationApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_organization**](OrganizationApi.md#create_organization) | **POST** /api/organization | create_organization |
-| [**delete_organization_by_id**](OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | delete_organization |
-| [**get_organization_by_id**](OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | get_organization |
-| [**get_organization_usage**](OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | get_organization_usage |
-| [**get_organization_users**](OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | get_organization_users |
-| [**update_organization**](OrganizationApi.md#update_organization) | **PUT** /api/organization | update_organization |
+| [**create_organization**](OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization |
+| [**delete_organization_by_id**](OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization |
+| [**get_organization_by_id**](OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization |
+| [**get_organization_usage**](OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage |
+| [**get_organization_users**](OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users |
+| [**update_organization**](OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization |
 
 
 ## create_organization
 
 > <Organization> create_organization(create_organization_data)
 
-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.
+Create Organization  Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
 
 ### Examples
 
@@ -27,11 +27,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)
@@ -42,7 +37,7 @@ api_instance = TrieveRubyClient::OrganizationApi.new
 create_organization_data = TrieveRubyClient::CreateOrganizationData.new({name: 'name_example'}) # CreateOrganizationData | The organization data that you want to create
 
 begin
-  # create_organization
+  # Create Organization
   result = api_instance.create_organization(create_organization_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -58,7 +53,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_organization
+  # Create Organization
   data, status_code, headers = api_instance.create_organization_with_http_info(create_organization_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
 
 > <Organization> delete_organization_by_id(tr_organization, organization_id)
 
-delete_organization
+Delete Organization
 
-delete_organization  Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
+Delete Organization  Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
 
 ### 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_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch.
 
 begin
-  # delete_organization
+  # Delete Organization
   result = api_instance.delete_organization_by_id(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -135,7 +125,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # delete_organization
+  # Delete Organization
   data, status_code, headers = api_instance.delete_organization_by_id_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -158,7 +148,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -170,9 +160,9 @@ end
 
 > <Organization> get_organization_by_id(tr_organization, organization_id)
 
-get_organization
+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.
+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.
 
 ### Examples
 
@@ -181,11 +171,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)
@@ -197,7 +182,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch.
 
 begin
-  # get_organization
+  # Get Organization
   result = api_instance.get_organization_by_id(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -213,7 +198,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization
+  # Get Organization
   data, status_code, headers = api_instance.get_organization_by_id_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -236,7 +221,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -248,9 +233,9 @@ end
 
 > <OrganizationUsageCount> get_organization_usage(tr_organization, organization_id)
 
-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.
+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.
 
 ### Examples
 
@@ -259,11 +244,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)
@@ -275,7 +255,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch the usage of.
 
 begin
-  # get_organization_usage
+  # Get Organization Usage
   result = api_instance.get_organization_usage(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -291,7 +271,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization_usage
+  # Get Organization Usage
   data, status_code, headers = api_instance.get_organization_usage_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -314,7 +294,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -326,9 +306,9 @@ end
 
 > <Array<SlimUser>> get_organization_users(tr_organization, organization_id)
 
-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.
+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.
 
 ### Examples
 
@@ -337,11 +317,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)
@@ -353,7 +328,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch the users of.
 
 begin
-  # get_organization_users
+  # Get Organization Users
   result = api_instance.get_organization_users(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -369,7 +344,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization_users
+  # Get Organization Users
   data, status_code, headers = api_instance.get_organization_users_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -392,7 +367,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -404,9 +379,9 @@ end
 
 > <Organization> update_organization(tr_organization, update_organization_data)
 
-update_organization
+Update Organization
 
-update_organization  Update an organization. Only the owner of the organization can update it.
+Update Organization  Update an organization. Only the owner of the organization can update it.
 
 ### Examples
 
@@ -415,11 +390,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)
@@ -431,7 +401,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 update_organization_data = TrieveRubyClient::UpdateOrganizationData.new({organization_id: 'organization_id_example'}) # UpdateOrganizationData | The organization data that you want to update
 
 begin
-  # update_organization
+  # Update Organization
   result = api_instance.update_organization(tr_organization, update_organization_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -447,7 +417,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # update_organization
+  # Update Organization
   data, status_code, headers = api_instance.update_organization_with_http_info(tr_organization, update_organization_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -470,7 +440,7 @@ end
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 

data/docs/ReturnQueuedChunk.md

@@ -1,20 +1,49 @@
 # TrieveRubyClient::ReturnQueuedChunk
 
-## Properties
+## Class instance methods
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chunk_metadata** | [**ChunkMetadata**](ChunkMetadata.md) |  |  |
-| **pos_in_queue** | **Integer** |  |  |
+### `openapi_one_of`
 
-## Example
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ReturnQueuedChunk.openapi_one_of
+# =>
+# [
+#   :'BatchQueuedChunkResponse',
+#   :'SingleQueuedChunkResponse'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
 
 ```ruby
 require 'trieve_ruby_client'
 
-instance = TrieveRubyClient::ReturnQueuedChunk.new(
-  chunk_metadata: null,
-  pos_in_queue: null
-)
+TrieveRubyClient::ReturnQueuedChunk.build(data)
+# => #<BatchQueuedChunkResponse:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ReturnQueuedChunk.build(data_that_doesnt_match)
+# => nil
 ```
 
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BatchQueuedChunkResponse`
+- `SingleQueuedChunkResponse`
+- `nil` (if no type matches)
+

data/docs/SingleQueuedChunkResponse.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SingleQueuedChunkResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_metadata** | [**ChunkMetadata**](ChunkMetadata.md) |  |  |
+| **pos_in_queue** | **Integer** | The current position the last access item is in the queue |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SingleQueuedChunkResponse.new(
+  chunk_metadata: null,
+  pos_in_queue: null
+)
+```
+

data/docs/StripeApi.md

@@ -1,20 +1,22 @@
 # TrieveRubyClient::StripeApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} |  |
-| [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} |  |
-| [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans |  |
-| [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} |  |
+| [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription |
+| [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout |
+| [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans |
+| [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan |
 
 
 ## cancel_subscription
 
 > cancel_subscription(tr_organization, subscription_id)
 
+Cancel Subscription
 
+Cancel Subscription  Cancel a subscription by its id
 
 ### Examples
 
@@ -23,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)
@@ -39,7 +36,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the subscription you want to cancel
 
 begin
-  
+  # Cancel Subscription
   api_instance.cancel_subscription(tr_organization, subscription_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->cancel_subscription: #{e}"
@@ -54,7 +51,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Cancel Subscription
   data, status_code, headers = api_instance.cancel_subscription_with_http_info(tr_organization, subscription_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -77,7 +74,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -89,7 +86,9 @@ nil (empty response body)
 
 > direct_to_payment_link(plan_id, organization_id)
 
+Checkout
 
+Checkout  Get a direct link to the stripe checkout page for the plan and organization
 
 ### Examples
 
@@ -102,7 +101,7 @@ plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you w
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to subscribe to the plan
 
 begin
-  
+  # Checkout
   api_instance.direct_to_payment_link(plan_id, organization_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->direct_to_payment_link: #{e}"
@@ -117,7 +116,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Checkout
   data, status_code, headers = api_instance.direct_to_payment_link_with_http_info(plan_id, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -152,7 +151,9 @@ No authorization required
 
 > <Array<StripePlan>> get_all_plans
 
+Get All Plans
 
+Get All Plans  Get a list of all plans
 
 ### Examples
 
@@ -163,7 +164,7 @@ require 'trieve_ruby_client'
 api_instance = TrieveRubyClient::StripeApi.new
 
 begin
-  
+  # Get All Plans
   result = api_instance.get_all_plans
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -179,7 +180,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Get All Plans
   data, status_code, headers = api_instance.get_all_plans_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -211,7 +212,9 @@ No authorization required
 
 > update_subscription_plan(tr_organization, subscription_id, plan_id)
 
+Update Subscription Plan
 
+Update Subscription Plan  Update a subscription to a new plan
 
 ### Examples
 
@@ -220,11 +223,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)
@@ -237,7 +235,7 @@ subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the su
 plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you want to subscribe to
 
 begin
-  
+  # Update Subscription Plan
   api_instance.update_subscription_plan(tr_organization, subscription_id, plan_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->update_subscription_plan: #{e}"
@@ -252,7 +250,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Update Subscription Plan
   data, status_code, headers = api_instance.update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -276,7 +274,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers