peal 0.1.0 → 0.2.0

data/docs/AssistantActionAnyOf1.md

@@ -1,20 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

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

data/docs/AssistantApi.md

@@ -1,149 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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

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

data/docs/AssistantUnavailableEncoded.md

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

data/docs/AttemptResult.md

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

data/docs/Authorization.md

@@ -1,18 +0,0 @@
-# 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

@@ -1,28 +0,0 @@
-# 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
-)
-```
-

data/docs/BillingApi.md

@@ -1,77 +0,0 @@
-# Peal::BillingApi
-
-All URIs are relative to *https://app.peal.social*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**billing_get**](BillingApi.md#billing_get) | **GET** /api/workspaces/{workspaceId}/billing | Get the workspace's billing |
-
-
-## billing_get
-
-> <Billing> billing_get(workspace_id)
-
-Get the workspace's billing
-
-Answers with the workspace's plan, the subscription that buys it, what each limit allows, how much of it the workspace uses, and every plan to compare. On a server that does not bill, nothing is limited. Needs billing: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::BillingApi.new
-workspace_id = 'workspace_id_example' # String | 
-
-begin
-  # Get the workspace's billing
-  result = api_instance.billing_get(workspace_id)
-  p result
-rescue Peal::ApiError => e
-  puts "Error when calling BillingApi->billing_get: #{e}"
-end
-```
-
-#### Using the billing_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Billing>, Integer, Hash)> billing_get_with_http_info(workspace_id)
-
-```ruby
-begin
-  # Get the workspace's billing
-  data, status_code, headers = api_instance.billing_get_with_http_info(workspace_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Billing>
-rescue Peal::ApiError => e
-  puts "Error when calling BillingApi->billing_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **workspace_id** | **String** |  |  |
-
-### Return type
-
-[**Billing**](Billing.md)
-
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/BillingSubscription.md

@@ -1,24 +0,0 @@
-# Peal::BillingSubscription
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **cancel_at_period_end** | **Boolean** |  |  |
-| **current_period_end** | **String** |  |  |
-| **plan** | [**PaidPlan**](PaidPlan.md) |  |  |
-| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::BillingSubscription.new(
-  cancel_at_period_end: null,
-  current_period_end: null,
-  plan: null,
-  status: null
-)
-```
-

data/docs/Channel.md

@@ -1,30 +0,0 @@
-# Peal::Channel
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **avatar_url** | **String** |  |  |
-| **display_name** | **String** |  |  |
-| **handle** | **String** |  |  |
-| **id** | **String** |  |  |
-| **platform** | [**Platform**](Platform.md) |  |  |
-| **status** | [**ChannelStatus**](ChannelStatus.md) |  |  |
-| **token_expires_at** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::Channel.new(
-  avatar_url: null,
-  display_name: null,
-  handle: null,
-  id: null,
-  platform: null,
-  status: null,
-  token_expires_at: null
-)
-```
-

data/docs/ChannelCannotPostEncoded.md

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

data/docs/ChannelMetrics.md

@@ -1,30 +0,0 @@
-# Peal::ChannelMetrics
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **impressions** | **Integer** |  |  |
-| **likes** | **Integer** |  |  |
-| **posts** | **Integer** |  |  |
-| **quotes** | **Integer** |  |  |
-| **replies** | **Integer** |  |  |
-| **reposts** | **Integer** |  |  |
-| **channel_id** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::ChannelMetrics.new(
-  impressions: null,
-  likes: null,
-  posts: null,
-  quotes: null,
-  replies: null,
-  reposts: null,
-  channel_id: null
-)
-```
-

data/docs/ChannelNotFoundEncoded.md

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

data/docs/ChannelOptions.md

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

data/docs/ChannelStatus.md

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

data/docs/ChannelStatusAnyOf.md

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

data/docs/ChannelStatusAnyOf1.md

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