peal 0.1.0

data/docs/PostsCreate422Response.md

@@ -0,0 +1,24 @@
+# Peal::PostsCreate422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **violations** | [**Array<ContentViolation>**](ContentViolation.md) |  |  |
+| **channel_ids** | **Array<String>** |  |  |
+| **media_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PostsCreate422Response.new(
+  _tag: null,
+  violations: null,
+  channel_ids: null,
+  media_ids: null
+)
+```
+

data/docs/PostsGet404Response.md

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

data/docs/PostsRepost409Response.md

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

data/docs/PostsSchedule422Response.md

@@ -0,0 +1,26 @@
+# Peal::PostsSchedule422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **time_zone** | **String** |  |  |
+| **violations** | [**Array<ContentViolation>**](ContentViolation.md) |  |  |
+| **channel_ids** | **Array<String>** |  |  |
+| **media_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PostsSchedule422Response.new(
+  _tag: null,
+  time_zone: null,
+  violations: null,
+  channel_ids: null,
+  media_ids: null
+)
+```
+

data/docs/PreparedUpload.md

@@ -0,0 +1,20 @@
+# Peal::PreparedUpload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media** | [**Media**](Media.md) |  |  |
+| **upload** | [**UploadTarget**](UploadTarget.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PreparedUpload.new(
+  media: null,
+  upload: null
+)
+```
+

data/docs/ProbeState.md

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

data/docs/PublicationAttempt.md

@@ -0,0 +1,30 @@
+# Peal::PublicationAttempt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attempt** | **Integer** |  |  |
+| **finished_at** | **String** |  |  |
+| **result** | [**AttemptResult**](AttemptResult.md) |  |  |
+| **retry_at** | **String** |  |  |
+| **round** | **Integer** |  |  |
+| **started_at** | **String** |  |  |
+| **target_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PublicationAttempt.new(
+  attempt: null,
+  finished_at: null,
+  result: null,
+  retry_at: null,
+  round: null,
+  started_at: null,
+  target_id: null
+)
+```
+

data/docs/RejectionReason.md

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

data/docs/Role.md

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

data/docs/ScheduleInPastEncoded.md

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

data/docs/SchedulePost.md

@@ -0,0 +1,22 @@
+# Peal::SchedulePost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at** | **String** |  |  |
+| **channel_ids** | **Array<String>** |  |  |
+| **time_zone** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::SchedulePost.new(
+  at: null,
+  channel_ids: null,
+  time_zone: null
+)
+```
+

data/docs/SessionApi.md

@@ -0,0 +1,74 @@
+# Peal::SessionApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**session_me**](SessionApi.md#session_me) | **GET** /api/me | Get the signed-in user |
+
+
+## session_me
+
+> <Me> session_me
+
+Get the signed-in user
+
+Answers with the signed-in user and every workspace they belong to, with their role and permissions in each. API keys belong to a workspace, not a user, and get 403.
+
+### 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::SessionApi.new
+
+begin
+  # Get the signed-in user
+  result = api_instance.session_me
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling SessionApi->session_me: #{e}"
+end
+```
+
+#### Using the session_me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Me>, Integer, Hash)> session_me_with_http_info
+
+```ruby
+begin
+  # Get the signed-in user
+  data, status_code, headers = api_instance.session_me_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Me>
+rescue Peal::ApiError => e
+  puts "Error when calling SessionApi->session_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Me**](Me.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SignedRequest.md

@@ -0,0 +1,22 @@
+# Peal::SignedRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **headers** | **Hash<String, String>** |  |  |
+| **method** | **String** |  |  |
+| **url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::SignedRequest.new(
+  headers: null,
+  method: null,
+  url: null
+)
+```
+

data/docs/SubscriptionStatus.md

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

data/docs/Suggestion.md

@@ -0,0 +1,22 @@
+# Peal::Suggestion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **text** | **String** |  |  |
+| **hashtags** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Suggestion.new(
+  _tag: null,
+  text: null,
+  hashtags: null
+)
+```
+

data/docs/SuggestionAnyOf.md

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

data/docs/SuggestionAnyOf1.md

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

data/docs/SuggestionRequest.md

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

data/docs/SystemApi.md

@@ -0,0 +1,129 @@
+# Peal::SystemApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**health**](SystemApi.md#health) | **GET** /api/health | Check that the server is up |
+| [**ready**](SystemApi.md#ready) | **GET** /api/ready | Check that the server can take traffic |
+
+
+## health
+
+> health
+
+Check that the server is up
+
+Answers as soon as the server is up, whatever the state of its database. Use it as a liveness or container health check.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+
+api_instance = Peal::SystemApi.new
+
+begin
+  # Check that the server is up
+  api_instance.health
+rescue Peal::ApiError => e
+  puts "Error when calling SystemApi->health: #{e}"
+end
+```
+
+#### Using the health_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)> health_with_http_info
+
+```ruby
+begin
+  # Check that the server is up
+  data, status_code, headers = api_instance.health_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Peal::ApiError => e
+  puts "Error when calling SystemApi->health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## ready
+
+> ready
+
+Check that the server can take traffic
+
+Answers once the server can reach its database, and fails with DatabaseUnavailable while it cannot. Use it as a readiness check before sending traffic.
+
+### Examples
+
+```ruby
+require 'time'
+require 'peal'
+
+api_instance = Peal::SystemApi.new
+
+begin
+  # Check that the server can take traffic
+  api_instance.ready
+rescue Peal::ApiError => e
+  puts "Error when calling SystemApi->ready: #{e}"
+end
+```
+
+#### Using the ready_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)> ready_with_http_info
+
+```ruby
+begin
+  # Check that the server can take traffic
+  data, status_code, headers = api_instance.ready_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Peal::ApiError => e
+  puts "Error when calling SystemApi->ready_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TargetConfirmation.md

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

data/docs/TargetConfirmationAnyOf.md

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

data/docs/TargetConfirmationAnyOf1.md

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

data/docs/TargetMetrics.md

@@ -0,0 +1,32 @@
+# Peal::TargetMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** |  |  |
+| **collecting** | **Boolean** |  |  |
+| **last_collected_at** | **String** |  |  |
+| **latest** | [**PostMetrics**](PostMetrics.md) |  |  |
+| **permalink** | **String** |  |  |
+| **published_at** | **String** |  |  |
+| **snapshots** | [**Array<MetricsSnapshot>**](MetricsSnapshot.md) |  |  |
+| **target_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::TargetMetrics.new(
+  channel_id: null,
+  collecting: null,
+  last_collected_at: null,
+  latest: null,
+  permalink: null,
+  published_at: null,
+  snapshots: null,
+  target_id: null
+)
+```
+