peal 0.1.0

data/docs/ContentViolationAnyOf5.md

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

data/docs/ContentViolationAnyOf6.md

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

data/docs/ContentViolationAnyOf7.md

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

data/docs/ContentViolationAnyOf8.md

@@ -0,0 +1,28 @@
+# Peal::ContentViolationAnyOf8
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **channel_id** | **String** |  |  |
+| **platform** | [**Platform**](Platform.md) |  |  |
+| **length** | **Integer** |  |  |
+| **maximum** | **Integer** |  |  |
+| **unit** | [**TextUnit**](TextUnit.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::ContentViolationAnyOf8.new(
+  _tag: null,
+  channel_id: null,
+  platform: null,
+  length: null,
+  maximum: null,
+  unit: null
+)
+```
+

data/docs/ContentViolationAnyOf9.md

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

data/docs/CreatedApiKey.md

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

data/docs/DatabaseUnavailableEncoded.md

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

data/docs/DraftPage.md

@@ -0,0 +1,20 @@
+# Peal::DraftPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<Post>**](Post.md) |  |  |
+| **next_cursor** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::DraftPage.new(
+  items: null,
+  next_cursor: null
+)
+```
+

data/docs/EffectHttpApiErrorBadRequestEncoded.md

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

data/docs/EngagementDay.md

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

data/docs/FailureReason.md

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

data/docs/ForbiddenEncoded.md

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

data/docs/InvalidDateRangeEncoded.md

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

data/docs/InvalidTimeRangeEncoded.md

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

data/docs/InvalidTimeZoneEncoded.md

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

data/docs/Invitation.md

@@ -0,0 +1,28 @@
+# Peal::Invitation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  |  |
+| **email** | **String** |  |  |
+| **expires_at** | **String** |  |  |
+| **id** | **String** |  |  |
+| **inviter_id** | **String** |  |  |
+| **role** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Invitation.new(
+  created_at: null,
+  email: null,
+  expires_at: null,
+  id: null,
+  inviter_id: null,
+  role: null
+)
+```
+

data/docs/InvitationNotFoundEncoded.md

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

data/docs/InvitationsApi.md

@@ -0,0 +1,220 @@
+# Peal::InvitationsApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**invitations_create**](InvitationsApi.md#invitations_create) | **POST** /api/workspaces/{workspaceId}/invitations | Invite someone |
+| [**invitations_list**](InvitationsApi.md#invitations_list) | **GET** /api/workspaces/{workspaceId}/invitations | List invitations |
+| [**invitations_revoke**](InvitationsApi.md#invitations_revoke) | **DELETE** /api/workspaces/{workspaceId}/invitations/{invitationId} | Revoke an invitation |
+
+
+## invitations_create
+
+> <Invitation> invitations_create(workspace_id, new_invitation)
+
+Invite someone
+
+Invites someone to the workspace with a role: Peal emails them a link that works for 7 days, in their language when they have an account, in the inviter's otherwise. A pending invitation to the same address is revoked, and its link stops working. Only owners invite owners. On a server that bills, the members and the other pending invitations must leave room in the workspace's plan (PlanLimitReached). Needs invitation:create, and a member in person: not an API key, nor staff impersonating one.
+
+### 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::InvitationsApi.new
+workspace_id = 'workspace_id_example' # String | 
+new_invitation = Peal::NewInvitation.new({email: 'email_example', role: Peal::Role::OWNER}) # NewInvitation | 
+
+begin
+  # Invite someone
+  result = api_instance.invitations_create(workspace_id, new_invitation)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_create: #{e}"
+end
+```
+
+#### Using the invitations_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Invitation>, Integer, Hash)> invitations_create_with_http_info(workspace_id, new_invitation)
+
+```ruby
+begin
+  # Invite someone
+  data, status_code, headers = api_instance.invitations_create_with_http_info(workspace_id, new_invitation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Invitation>
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **new_invitation** | [**NewInvitation**](NewInvitation.md) |  |  |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## invitations_list
+
+> <Array<Invitation>> invitations_list(workspace_id)
+
+List invitations
+
+Lists the workspace's pending invitations, oldest first, expired ones included. Needs invitation:create, as an invitation's id opens its link, and a member rather than an API key; invitations to the owner role are listed to owners only.
+
+### 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::InvitationsApi.new
+workspace_id = 'workspace_id_example' # String | 
+
+begin
+  # List invitations
+  result = api_instance.invitations_list(workspace_id)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_list: #{e}"
+end
+```
+
+#### Using the invitations_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Invitation>>, Integer, Hash)> invitations_list_with_http_info(workspace_id)
+
+```ruby
+begin
+  # List invitations
+  data, status_code, headers = api_instance.invitations_list_with_http_info(workspace_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Invitation>>
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;Invitation&gt;**](Invitation.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invitations_revoke
+
+> invitations_revoke(workspace_id, invitation_id)
+
+Revoke an invitation
+
+Revokes a pending invitation of the workspace: its link stops working at once. Needs invitation:cancel, and a member in person: not an API key, nor staff impersonating one.
+
+### 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::InvitationsApi.new
+workspace_id = 'workspace_id_example' # String | 
+invitation_id = 'invitation_id_example' # String | 
+
+begin
+  # Revoke an invitation
+  api_instance.invitations_revoke(workspace_id, invitation_id)
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_revoke: #{e}"
+end
+```
+
+#### Using the invitations_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)> invitations_revoke_with_http_info(workspace_id, invitation_id)
+
+```ruby
+begin
+  # Revoke an invitation
+  data, status_code, headers = api_instance.invitations_revoke_with_http_info(workspace_id, invitation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Peal::ApiError => e
+  puts "Error when calling InvitationsApi->invitations_revoke_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **invitation_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/InvitationsCreate409Response.md

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

data/docs/InvitationsRevoke404Response.md

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

data/docs/MarkNoticesRead.md

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

data/docs/Me.md

@@ -0,0 +1,22 @@
+# Peal::Me
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **impersonated_by** | **String** |  |  |
+| **user** | [**MeUser**](MeUser.md) |  |  |
+| **workspaces** | [**Array<Membership>**](Membership.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Me.new(
+  impersonated_by: null,
+  user: null,
+  workspaces: null
+)
+```
+