peal 0.1.0

data/docs/ApiKeysApi.md

@@ -0,0 +1,220 @@
+# Peal::ApiKeysApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_keys_create**](ApiKeysApi.md#api_keys_create) | **POST** /api/workspaces/{workspaceId}/api-keys | Create an API key |
+| [**api_keys_list**](ApiKeysApi.md#api_keys_list) | **GET** /api/workspaces/{workspaceId}/api-keys | List API keys |
+| [**api_keys_revoke**](ApiKeysApi.md#api_keys_revoke) | **DELETE** /api/workspaces/{workspaceId}/api-keys/{apiKeyId} | Revoke an API key |
+
+
+## api_keys_create
+
+> <CreatedApiKey> api_keys_create(workspace_id, new_api_key)
+
+Create an API key
+
+Creates an API key for the workspace with some of the caller's permissions, and answers with the key itself, which is not shown again. Needs apiKey:create, and a signed-in member: API keys cannot create keys.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+# setup authorization
+Peal.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Peal::ApiKeysApi.new
+workspace_id = 'workspace_id_example' # String | 
+new_api_key = Peal::NewApiKey.new({name: 'name_example', permissions: ['analytics:read']}) # NewApiKey | 
+
+begin
+  # Create an API key
+  result = api_instance.api_keys_create(workspace_id, new_api_key)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_create: #{e}"
+end
+```
+
+#### Using the api_keys_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatedApiKey>, Integer, Hash)> api_keys_create_with_http_info(workspace_id, new_api_key)
+
+```ruby
+begin
+  # Create an API key
+  data, status_code, headers = api_instance.api_keys_create_with_http_info(workspace_id, new_api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatedApiKey>
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **new_api_key** | [**NewApiKey**](NewApiKey.md) |  |  |
+
+### Return type
+
+[**CreatedApiKey**](CreatedApiKey.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## api_keys_list
+
+> <Array<ApiKey>> api_keys_list(workspace_id)
+
+List API keys
+
+Lists the workspace's API keys. Needs apiKey:read.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+# setup authorization
+Peal.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Peal::ApiKeysApi.new
+workspace_id = 'workspace_id_example' # String | 
+
+begin
+  # List API keys
+  result = api_instance.api_keys_list(workspace_id)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_list: #{e}"
+end
+```
+
+#### Using the api_keys_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ApiKey>>, Integer, Hash)> api_keys_list_with_http_info(workspace_id)
+
+```ruby
+begin
+  # List API keys
+  data, status_code, headers = api_instance.api_keys_list_with_http_info(workspace_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ApiKey>>
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;ApiKey&gt;**](ApiKey.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_keys_revoke
+
+> api_keys_revoke(workspace_id, api_key_id)
+
+Revoke an API key
+
+Revokes an API key of the workspace: it stops working at once. Needs apiKey:delete.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+# setup authorization
+Peal.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Peal::ApiKeysApi.new
+workspace_id = 'workspace_id_example' # String | 
+api_key_id = 'api_key_id_example' # String | 
+
+begin
+  # Revoke an API key
+  api_instance.api_keys_revoke(workspace_id, api_key_id)
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_revoke: #{e}"
+end
+```
+
+#### Using the api_keys_revoke_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> api_keys_revoke_with_http_info(workspace_id, api_key_id)
+
+```ruby
+begin
+  # Revoke an API key
+  data, status_code, headers = api_instance.api_keys_revoke_with_http_info(workspace_id, api_key_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Peal::ApiError => e
+  puts "Error when calling ApiKeysApi->api_keys_revoke_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **api_key_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiKeysRevoke404Response.md

@@ -0,0 +1,18 @@
+# Peal::ApiKeysRevoke404Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::ApiKeysRevoke404Response.new(
+  _tag: null
+)
+```
+

data/docs/AssistantAction.md

@@ -0,0 +1,24 @@
+# Peal::AssistantAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **tone** | [**AssistantTone**](AssistantTone.md) |  |  |
+| **platform** | [**Platform**](Platform.md) |  |  |
+| **language** | [**TranslationLanguage**](TranslationLanguage.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantAction.new(
+  _tag: null,
+  tone: null,
+  platform: null,
+  language: null
+)
+```
+

data/docs/AssistantActionAnyOf.md

@@ -0,0 +1,20 @@
+# Peal::AssistantActionAnyOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **tone** | [**AssistantTone**](AssistantTone.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantActionAnyOf.new(
+  _tag: null,
+  tone: null
+)
+```
+

data/docs/AssistantActionAnyOf1.md

@@ -0,0 +1,20 @@
+# Peal::AssistantActionAnyOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **platform** | [**Platform**](Platform.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantActionAnyOf1.new(
+  _tag: null,
+  platform: null
+)
+```
+

data/docs/AssistantActionAnyOf2.md

@@ -0,0 +1,20 @@
+# Peal::AssistantActionAnyOf2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **language** | [**TranslationLanguage**](TranslationLanguage.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantActionAnyOf2.new(
+  _tag: null,
+  language: null
+)
+```
+

data/docs/AssistantActionAnyOf3.md

@@ -0,0 +1,18 @@
+# Peal::AssistantActionAnyOf3
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantActionAnyOf3.new(
+  _tag: null
+)
+```
+

data/docs/AssistantApi.md

@@ -0,0 +1,149 @@
+# Peal::AssistantApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**assistant_status**](AssistantApi.md#assistant_status) | **GET** /api/workspaces/{workspaceId}/assistant | Get the assistant's status |
+| [**assistant_suggest**](AssistantApi.md#assistant_suggest) | **POST** /api/workspaces/{workspaceId}/assistant/suggestions | Suggest a change to a post's text |
+
+
+## assistant_status
+
+> <AssistantStatus> assistant_status(workspace_id)
+
+Get the assistant's status
+
+Tells whether the server has a language model, so clients show the assistant or hide it, and how many requests the workspace has left today. Needs assistant:use.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+# setup authorization
+Peal.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Peal::AssistantApi.new
+workspace_id = 'workspace_id_example' # String | 
+
+begin
+  # Get the assistant's status
+  result = api_instance.assistant_status(workspace_id)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling AssistantApi->assistant_status: #{e}"
+end
+```
+
+#### Using the assistant_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AssistantStatus>, Integer, Hash)> assistant_status_with_http_info(workspace_id)
+
+```ruby
+begin
+  # Get the assistant's status
+  data, status_code, headers = api_instance.assistant_status_with_http_info(workspace_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AssistantStatus>
+rescue Peal::ApiError => e
+  puts "Error when calling AssistantApi->assistant_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+
+### Return type
+
+[**AssistantStatus**](AssistantStatus.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## assistant_suggest
+
+> <Suggestion> assistant_suggest(workspace_id, suggestion_request)
+
+Suggest a change to a post's text
+
+Asks the language model to rewrite, shorten or translate a post's text, or to suggest hashtags for it, and answers once the whole suggestion is checked. The text is sent to the model as data, never as instructions. Each request counts toward the workspace's daily quota, unless the model's provider could not be reached. Needs assistant:use.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+# setup authorization
+Peal.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Peal::AssistantApi.new
+workspace_id = 'workspace_id_example' # String | 
+suggestion_request = Peal::SuggestionRequest.new({action: Peal::AssistantAction.new({_tag: 'hashtags', tone: Peal::AssistantTone::PROFESSIONAL, platform: Peal::Platform::X, language: Peal::TranslationLanguage::EN}), text: 'text_example'}) # SuggestionRequest | 
+
+begin
+  # Suggest a change to a post's text
+  result = api_instance.assistant_suggest(workspace_id, suggestion_request)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling AssistantApi->assistant_suggest: #{e}"
+end
+```
+
+#### Using the assistant_suggest_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suggestion>, Integer, Hash)> assistant_suggest_with_http_info(workspace_id, suggestion_request)
+
+```ruby
+begin
+  # Suggest a change to a post's text
+  data, status_code, headers = api_instance.assistant_suggest_with_http_info(workspace_id, suggestion_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suggestion>
+rescue Peal::ApiError => e
+  puts "Error when calling AssistantApi->assistant_suggest_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **suggestion_request** | [**SuggestionRequest**](SuggestionRequest.md) |  |  |
+
+### Return type
+
+[**Suggestion**](Suggestion.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AssistantFailedEncoded.md

@@ -0,0 +1,20 @@
+# Peal::AssistantFailedEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **reason** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantFailedEncoded.new(
+  _tag: null,
+  reason: null
+)
+```
+

data/docs/AssistantInputRejectedEncoded.md

@@ -0,0 +1,22 @@
+# Peal::AssistantInputRejectedEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **max_length** | **Integer** |  |  |
+| **reason** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantInputRejectedEncoded.new(
+  _tag: null,
+  max_length: null,
+  reason: null
+)
+```
+

data/docs/AssistantQuotaExceededEncoded.md

@@ -0,0 +1,22 @@
+# Peal::AssistantQuotaExceededEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **daily_limit** | **Integer** |  |  |
+| **resets_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantQuotaExceededEncoded.new(
+  _tag: null,
+  daily_limit: null,
+  resets_at: null
+)
+```
+

data/docs/AssistantStatus.md

@@ -0,0 +1,26 @@
+# Peal::AssistantStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Boolean** |  |  |
+| **daily_limit** | **Integer** |  |  |
+| **max_text_length** | **Integer** |  |  |
+| **remaining** | **Integer** |  |  |
+| **resets_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantStatus.new(
+  available: null,
+  daily_limit: null,
+  max_text_length: null,
+  remaining: null,
+  resets_at: null
+)
+```
+

data/docs/AssistantTone.md

@@ -0,0 +1,15 @@
+# Peal::AssistantTone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantTone.new()
+```
+

data/docs/AssistantUnavailableEncoded.md

@@ -0,0 +1,18 @@
+# Peal::AssistantUnavailableEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AssistantUnavailableEncoded.new(
+  _tag: null
+)
+```
+

data/docs/AttemptResult.md

@@ -0,0 +1,15 @@
+# Peal::AttemptResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AttemptResult.new()
+```
+

data/docs/Authorization.md

@@ -0,0 +1,18 @@
+# Peal::Authorization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Authorization.new(
+  authorization_url: null
+)
+```
+

data/docs/Billing.md

@@ -0,0 +1,28 @@
+# Peal::Billing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowances** | [**PlanAllowances**](PlanAllowances.md) |  |  |
+| **enabled** | **Boolean** |  |  |
+| **plan** | [**Plan**](Plan.md) |  |  |
+| **plans** | [**Array<PlanOffer>**](PlanOffer.md) |  |  |
+| **subscription** | [**BillingSubscription**](BillingSubscription.md) |  |  |
+| **usage** | [**Usage**](Usage.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Billing.new(
+  allowances: null,
+  enabled: null,
+  plan: null,
+  plans: null,
+  subscription: null,
+  usage: null
+)
+```
+