peal 0.1.0

data/docs/NoticePage.md

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

data/docs/NoticesApi.md

@@ -0,0 +1,285 @@
+# Peal::NoticesApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**notices_list**](NoticesApi.md#notices_list) | **GET** /api/me/notices | List notices |
+| [**notices_mark_all_read**](NoticesApi.md#notices_mark_all_read) | **POST** /api/me/notices/read-all | Mark all notices read |
+| [**notices_mark_read**](NoticesApi.md#notices_mark_read) | **POST** /api/me/notices/read | Mark notices read |
+| [**notices_unread**](NoticesApi.md#notices_unread) | **GET** /api/me/notices/unread | Count unread notices |
+
+
+## notices_list
+
+> <NoticePage> notices_list(opts)
+
+List notices
+
+Lists the user's notices, newest first, 20 a page unless `limit` (at most 100) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Each notice is data, for the client to write in the reader's language.
+
+### 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::NoticesApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  limit: 'limit_example' # String | 
+}
+
+begin
+  # List notices
+  result = api_instance.notices_list(opts)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_list: #{e}"
+end
+```
+
+#### Using the notices_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NoticePage>, Integer, Hash)> notices_list_with_http_info(opts)
+
+```ruby
+begin
+  # List notices
+  data, status_code, headers = api_instance.notices_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NoticePage>
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **String** |  | [optional] |
+
+### Return type
+
+[**NoticePage**](NoticePage.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notices_mark_all_read
+
+> <UnreadNotices> notices_mark_all_read
+
+Mark all notices read
+
+Marks every notice of the user 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::NoticesApi.new
+
+begin
+  # Mark all notices read
+  result = api_instance.notices_mark_all_read
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_mark_all_read: #{e}"
+end
+```
+
+#### Using the notices_mark_all_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnreadNotices>, Integer, Hash)> notices_mark_all_read_with_http_info
+
+```ruby
+begin
+  # Mark all notices read
+  data, status_code, headers = api_instance.notices_mark_all_read_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnreadNotices>
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_mark_all_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UnreadNotices**](UnreadNotices.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notices_mark_read
+
+> <UnreadNotices> notices_mark_read(mark_notices_read)
+
+Mark notices read
+
+Marks up to 100 of the user's notices read, and answers with how many stay unread. Ids that name none of the user's notices, and notices already read, are left as they are.
+
+### 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::NoticesApi.new
+mark_notices_read = Peal::MarkNoticesRead.new({ids: ['ids_example']}) # MarkNoticesRead | 
+
+begin
+  # Mark notices read
+  result = api_instance.notices_mark_read(mark_notices_read)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_mark_read: #{e}"
+end
+```
+
+#### Using the notices_mark_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnreadNotices>, Integer, Hash)> notices_mark_read_with_http_info(mark_notices_read)
+
+```ruby
+begin
+  # Mark notices read
+  data, status_code, headers = api_instance.notices_mark_read_with_http_info(mark_notices_read)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnreadNotices>
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_mark_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mark_notices_read** | [**MarkNoticesRead**](MarkNoticesRead.md) |  |  |
+
+### Return type
+
+[**UnreadNotices**](UnreadNotices.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## notices_unread
+
+> <UnreadNotices> notices_unread
+
+Count unread notices
+
+Counts the user's unread notices.
+
+### 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::NoticesApi.new
+
+begin
+  # Count unread notices
+  result = api_instance.notices_unread
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_unread: #{e}"
+end
+```
+
+#### Using the notices_unread_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnreadNotices>, Integer, Hash)> notices_unread_with_http_info
+
+```ruby
+begin
+  # Count unread notices
+  data, status_code, headers = api_instance.notices_unread_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnreadNotices>
+rescue Peal::ApiError => e
+  puts "Error when calling NoticesApi->notices_unread_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UnreadNotices**](UnreadNotices.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/NotificationPreferences.md

@@ -0,0 +1,20 @@
+# Peal::NotificationPreferences
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | [**NotificationPreferencesEmail**](NotificationPreferencesEmail.md) |  |  |
+| **every_post** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::NotificationPreferences.new(
+  email: null,
+  every_post: null
+)
+```
+

data/docs/NotificationPreferencesApi.md

@@ -0,0 +1,144 @@
+# Peal::NotificationPreferencesApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**notification_preferences_get**](NotificationPreferencesApi.md#notification_preferences_get) | **GET** /api/me/notification-preferences | Get notification preferences |
+| [**notification_preferences_update**](NotificationPreferencesApi.md#notification_preferences_update) | **PATCH** /api/me/notification-preferences | Change notification preferences |
+
+
+## notification_preferences_get
+
+> <NotificationPreferences> notification_preferences_get
+
+Get notification preferences
+
+Answers with which notices the user receives by email, and whether they hear about every post. Until they change it: failed and unconfirmed posts, and channels to reconnect, but not published posts, are emailed; and they hear only about the posts they wrote.
+
+### 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::NotificationPreferencesApi.new
+
+begin
+  # Get notification preferences
+  result = api_instance.notification_preferences_get
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NotificationPreferencesApi->notification_preferences_get: #{e}"
+end
+```
+
+#### Using the notification_preferences_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NotificationPreferences>, Integer, Hash)> notification_preferences_get_with_http_info
+
+```ruby
+begin
+  # Get notification preferences
+  data, status_code, headers = api_instance.notification_preferences_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NotificationPreferences>
+rescue Peal::ApiError => e
+  puts "Error when calling NotificationPreferencesApi->notification_preferences_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**NotificationPreferences**](NotificationPreferences.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notification_preferences_update
+
+> <NotificationPreferences> notification_preferences_update(notification_preferences_change)
+
+Change notification preferences
+
+Changes the preferences given, keeps the others, and answers with them all. Staff impersonating the user may not change them.
+
+### 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::NotificationPreferencesApi.new
+notification_preferences_change = Peal::NotificationPreferencesChange.new # NotificationPreferencesChange | 
+
+begin
+  # Change notification preferences
+  result = api_instance.notification_preferences_update(notification_preferences_change)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling NotificationPreferencesApi->notification_preferences_update: #{e}"
+end
+```
+
+#### Using the notification_preferences_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NotificationPreferences>, Integer, Hash)> notification_preferences_update_with_http_info(notification_preferences_change)
+
+```ruby
+begin
+  # Change notification preferences
+  data, status_code, headers = api_instance.notification_preferences_update_with_http_info(notification_preferences_change)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NotificationPreferences>
+rescue Peal::ApiError => e
+  puts "Error when calling NotificationPreferencesApi->notification_preferences_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notification_preferences_change** | [**NotificationPreferencesChange**](NotificationPreferencesChange.md) |  |  |
+
+### Return type
+
+[**NotificationPreferences**](NotificationPreferences.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/NotificationPreferencesChange.md

@@ -0,0 +1,20 @@
+# Peal::NotificationPreferencesChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | [**NotificationPreferencesChangeEmail**](NotificationPreferencesChangeEmail.md) |  | [optional] |
+| **every_post** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::NotificationPreferencesChange.new(
+  email: null,
+  every_post: null
+)
+```
+

data/docs/NotificationPreferencesChangeEmail.md

@@ -0,0 +1,24 @@
+# Peal::NotificationPreferencesChangeEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_reconnect** | **Boolean** |  | [optional] |
+| **post_failed** | **Boolean** |  | [optional] |
+| **post_published** | **Boolean** |  | [optional] |
+| **post_unconfirmed** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::NotificationPreferencesChangeEmail.new(
+  channel_reconnect: null,
+  post_failed: null,
+  post_published: null,
+  post_unconfirmed: null
+)
+```
+

data/docs/NotificationPreferencesEmail.md

@@ -0,0 +1,24 @@
+# Peal::NotificationPreferencesEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_reconnect** | **Boolean** |  |  |
+| **post_failed** | **Boolean** |  |  |
+| **post_published** | **Boolean** |  |  |
+| **post_unconfirmed** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::NotificationPreferencesEmail.new(
+  channel_reconnect: null,
+  post_failed: null,
+  post_published: null,
+  post_unconfirmed: null
+)
+```
+

data/docs/PaidPlan.md

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

data/docs/PeriodUsage.md

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

data/docs/Plan.md

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

data/docs/PlanAllowances.md

@@ -0,0 +1,24 @@
+# Peal::PlanAllowances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assistant_requests** | **Integer** |  |  |
+| **channels** | **Integer** |  |  |
+| **members** | **Integer** |  |  |
+| **scheduled_posts** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PlanAllowances.new(
+  assistant_requests: null,
+  channels: null,
+  members: null,
+  scheduled_posts: null
+)
+```
+

data/docs/PlanLimit.md

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

data/docs/PlanLimitReachedEncoded.md

@@ -0,0 +1,22 @@
+# Peal::PlanLimitReachedEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **allowed** | **Integer** |  |  |
+| **limit** | [**PlanLimit**](PlanLimit.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PlanLimitReachedEncoded.new(
+  _tag: null,
+  allowed: null,
+  limit: null
+)
+```
+

data/docs/PlanOffer.md

@@ -0,0 +1,20 @@
+# Peal::PlanOffer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowances** | [**PlanAllowances**](PlanAllowances.md) |  |  |
+| **plan** | [**Plan**](Plan.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::PlanOffer.new(
+  allowances: null,
+  plan: null
+)
+```
+

data/docs/Platform.md

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