peal 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f15146919ca1c1c411d43732a78c9ca022c87c26a297d858ecc630f35b58a9c
-  data.tar.gz: f81b7474914469dcaa5f70aab30e674e00fffddf364c23f34369c8f687380bb2
+  metadata.gz: b60e4d0780daa46864ad224fb011c4a80a0a10d1bd47eb99cc8970d5ef893b5d
+  data.tar.gz: 9e9e2122338f09c0d78517ac95db585b45c561e674d31c3dc5ee57e88a9f2e26
 SHA512:
-  metadata.gz: 065751ace2416af1cb135c16837d80bc545ee63f7c6800fe741953e718072d583731f78e433769d7a63a9cc3fac5ac11a4d632e720e949553147d63d59e09cac
-  data.tar.gz: 27744086de518e05aa2b64f02194e8f66f63933d1564393fb1caa64859cca54ad23faeb4557ad29502bb901fd744cc5e24cd1134e78a6474b06922323e51b2c5
+  metadata.gz: 60146ac0b41fdfe8e4280bf5a7653afb55276446c4206e4f1a9360507f36dffb13065e360a29a76f5c8f236c9ce4c96f8d834afbf1ff5dcc48f27d83b1fa64ca
+  data.tar.gz: e5a3fb5a74c3ae685f74fa0c8d5b82bc405833858fde48cede737436e70c192071b91da5b8be1921c0b4a9e49296c06bb862ff04dfce37f98e158f4afa7bf307

data/README.md

@@ -1,354 +1,205 @@
-# peal
+# Peal Ruby Library
 
-Peal - the Ruby gem for the Peal API
 
-Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
+The Peal Ruby library provides convenient access to the Peal APIs from Ruby.
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Table of Contents
 
-- API version: 0.0.1
-- Package version: 0.2.0
-- Generator version: 7.27.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://peal.social](https://peal.social)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Errors](#errors)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query Parameters](#additional-query-parameters)
+  - [Additional Body Properties](#additional-body-properties)
+- [Contributing](#contributing)
 
 ## Installation
 
-### Build a gem
+```sh
+gem install peal
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```ruby
+require "peal"
+
+client = Peal::Client.new(token: "<token>")
+
+client.api_keys.create(
+  workspace_id: "workspaceId",
+  name: "name",
+  permissions: ["analytics:read"]
+)
+```
 
-To build the Ruby code into a gem:
+## Environments
 
-```shell
-gem build peal.gemspec
+This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
+### Environments
+```ruby
+require "peal"
+
+peal = Peal::Client.new(
+    base_url: Peal::Environment::DEFAULT
+)
 ```
 
-Then either install the gem locally:
+### Custom URL
+```ruby
+require "peal"
 
-```shell
-gem install ./peal-0.2.0.gem
+client = Peal::Client.new(
+    base_url: "https://example.com"
+)
 ```
 
-(for development, run `gem install --dev ./peal-0.2.0.gem` to install the development dependencies)
+## Errors
+
+Failed API calls will raise errors that can be rescued from granularly.
+
+```ruby
+require "peal"
+
+client = Peal::Client.new(
+    base_url: "https://example.com"
+)
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+begin
+    result = client.api_keys.create
+rescue Peal::Errors::TimeoutError
+    puts "API didn't respond before our timeout elapsed"
+rescue Peal::Errors::ConnectionError => e
+    puts "Could not reach the API (connection refused, reset, DNS or TLS failure): #{e.message}"
+rescue Peal::Errors::ServiceUnavailableError
+    puts "API returned status 503, is probably overloaded, try again later"
+rescue Peal::Errors::ServerError
+    puts "API returned some other 5xx status, this is probably a bug"
+rescue Peal::Errors::ResponseError => e
+    puts "API returned an unexpected status other than 5xx: #{e.code} #{e.message}"
+rescue Peal::Errors::ApiError => e
+    puts "Some other error occurred when calling the API: #{e.message}"
+end
+```
 
-Finally add this to the Gemfile:
+## Advanced
 
-    gem 'peal', '~> 0.2.0'
+### Retries
 
-### Install from Git
+The SDK is instrumented with automatic retries. A request will be retried as long as the request is deemed
+retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
 
-If the Ruby gem is hosted at a git repository: https://github.com/peal-social/peal, then add the following in the Gemfile:
+A request is deemed retryable when any of the following HTTP status codes is returned:
 
-    gem 'peal', :git => 'https://github.com/peal-social/peal.git'
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (Internal Server Error)
 
-### Include the Ruby code directly
+The `retryStatusCodes` configuration controls which [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) status codes are retried:
 
-Include the Ruby code directly using `-I` as follows:
+- `legacy` (default): Retries `408`, `429`, `500`, `502`, `503`, `504`, `521`, `522`, `524`
+- `recommended`: Retries `408`, `429`, `502`, `503`, `504` only (excludes `500 Internal Server Error` to avoid retrying non-idempotent failures)
 
-```shell
-ruby -Ilib script.rb
+Use the `max_retries` option to configure this behavior.
+
+```ruby
+require "peal"
+
+client = Peal::Client.new(
+    base_url: "https://example.com",
+    max_retries: 3  # Configure max retries (default is 2)
+)
 ```
 
-## Getting Started
+### Timeouts
 
-Please follow the [installation](#installation) procedure and then run the following code:
+The SDK defaults to a 60 second timeout. Use the `timeout` option to configure this behavior.
 
 ```ruby
-# Load the gem
-require 'peal'
-
-# Setup authorization
-Peal.configure do |config|
-  # Configure Bearer authorization: bearer
-  config.access_token = 'YOUR_BEARER_TOKEN'
-  # Configure a proc to get access tokens in lieu of the static access_token configuration
-  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
-  # Configure faraday connection
-  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
-end
+require "peal"
+
+# Set the default timeout (in seconds) for every request made by the client.
+client = Peal::Client.new(
+    base_url: "https://example.com",
+    timeout: 30
+)
+
+# Override the timeout for an individual request.
+response = client.api_keys.create(
+    ...,
+    request_options: { timeout_in_seconds: 10 }
+)
+```
 
-api_instance = Peal::AnalyticsApi.new
-workspace_id = 'workspace_id_example' # String | 
-post_id = 'post_id_example' # String | 
+### Additional Headers
 
-begin
-  #Get a post's analytics
-  result = api_instance.analytics_post(workspace_id, post_id)
-  p result
-rescue Peal::ApiError => e
-  puts "Exception when calling AnalyticsApi->analytics_post: #{e}"
-end
+If you would like to send additional headers as part of the request, use the `additional_headers` request option.
 
+```ruby
+require "peal"
+
+response = client.api_keys.create(
+    ...,
+    request_options: {
+        additional_headers: {
+            "X-Custom-Header" => "custom-value"
+        }
+    }
+)
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://app.peal.social*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*Peal::AnalyticsApi* | [**analytics_post**](docs/AnalyticsApi.md#analytics_post) | **GET** /api/workspaces/{workspaceId}/analytics/posts/{postId} | Get a post's analytics
-*Peal::AnalyticsApi* | [**analytics_summary**](docs/AnalyticsApi.md#analytics_summary) | **GET** /api/workspaces/{workspaceId}/analytics/summary | Summarize the workspace's analytics
-*Peal::ApiKeysApi* | [**api_keys_create**](docs/ApiKeysApi.md#api_keys_create) | **POST** /api/workspaces/{workspaceId}/api-keys | Create an API key
-*Peal::ApiKeysApi* | [**api_keys_list**](docs/ApiKeysApi.md#api_keys_list) | **GET** /api/workspaces/{workspaceId}/api-keys | List API keys
-*Peal::ApiKeysApi* | [**api_keys_revoke**](docs/ApiKeysApi.md#api_keys_revoke) | **DELETE** /api/workspaces/{workspaceId}/api-keys/{apiKeyId} | Revoke an API key
-*Peal::AssistantApi* | [**assistant_status**](docs/AssistantApi.md#assistant_status) | **GET** /api/workspaces/{workspaceId}/assistant | Get the assistant's status
-*Peal::AssistantApi* | [**assistant_suggest**](docs/AssistantApi.md#assistant_suggest) | **POST** /api/workspaces/{workspaceId}/assistant/suggestions | Suggest a change to a post's text
-*Peal::BillingApi* | [**billing_get**](docs/BillingApi.md#billing_get) | **GET** /api/workspaces/{workspaceId}/billing | Get the workspace's billing
-*Peal::ChannelsApi* | [**channels_choose_accounts**](docs/ChannelsApi.md#channels_choose_accounts) | **POST** /api/workspaces/{workspaceId}/channels/connect/{platform}/accounts | Choose the accounts to connect
-*Peal::ChannelsApi* | [**channels_complete_connect**](docs/ChannelsApi.md#channels_complete_connect) | **POST** /api/workspaces/{workspaceId}/channels/connect/{platform}/callback | Complete connecting an account
-*Peal::ChannelsApi* | [**channels_connect**](docs/ChannelsApi.md#channels_connect) | **POST** /api/workspaces/{workspaceId}/channels/connect/{platform} | Start connecting an account
-*Peal::ChannelsApi* | [**channels_disconnect**](docs/ChannelsApi.md#channels_disconnect) | **DELETE** /api/workspaces/{workspaceId}/channels/{channelId} | Disconnect a channel
-*Peal::ChannelsApi* | [**channels_list**](docs/ChannelsApi.md#channels_list) | **GET** /api/workspaces/{workspaceId}/channels | List channels
-*Peal::ChannelsApi* | [**channels_platforms**](docs/ChannelsApi.md#channels_platforms) | **GET** /api/workspaces/{workspaceId}/channels/platforms | List connectable platforms
-*Peal::ChannelsApi* | [**channels_reconnect**](docs/ChannelsApi.md#channels_reconnect) | **POST** /api/workspaces/{workspaceId}/channels/{channelId}/reconnect | Start reconnecting a channel
-*Peal::InvitationsApi* | [**invitations_create**](docs/InvitationsApi.md#invitations_create) | **POST** /api/workspaces/{workspaceId}/invitations | Invite someone
-*Peal::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /api/workspaces/{workspaceId}/invitations | List invitations
-*Peal::InvitationsApi* | [**invitations_revoke**](docs/InvitationsApi.md#invitations_revoke) | **DELETE** /api/workspaces/{workspaceId}/invitations/{invitationId} | Revoke an invitation
-*Peal::MediaApi* | [**media_complete**](docs/MediaApi.md#media_complete) | **POST** /api/workspaces/{workspaceId}/media/{mediaId}/complete | Complete an upload
-*Peal::MediaApi* | [**media_create**](docs/MediaApi.md#media_create) | **POST** /api/workspaces/{workspaceId}/media | Start an upload
-*Peal::MediaApi* | [**media_delete**](docs/MediaApi.md#media_delete) | **DELETE** /api/workspaces/{workspaceId}/media/{mediaId} | Delete media
-*Peal::MediaApi* | [**media_describe**](docs/MediaApi.md#media_describe) | **PATCH** /api/workspaces/{workspaceId}/media/{mediaId} | Describe media
-*Peal::MediaApi* | [**media_get**](docs/MediaApi.md#media_get) | **GET** /api/workspaces/{workspaceId}/media/{mediaId} | Get media
-*Peal::MediaApi* | [**media_list**](docs/MediaApi.md#media_list) | **GET** /api/workspaces/{workspaceId}/media | List media
-*Peal::MediaApi* | [**media_usage**](docs/MediaApi.md#media_usage) | **GET** /api/workspaces/{workspaceId}/media/{mediaId}/usage | Get where media is used
-*Peal::MembersApi* | [**members_list**](docs/MembersApi.md#members_list) | **GET** /api/workspaces/{workspaceId}/members | List members
-*Peal::NoticesApi* | [**notices_list**](docs/NoticesApi.md#notices_list) | **GET** /api/me/notices | List notices
-*Peal::NoticesApi* | [**notices_mark_all_read**](docs/NoticesApi.md#notices_mark_all_read) | **POST** /api/me/notices/read-all | Mark all notices read
-*Peal::NoticesApi* | [**notices_mark_read**](docs/NoticesApi.md#notices_mark_read) | **POST** /api/me/notices/read | Mark notices read
-*Peal::NoticesApi* | [**notices_unread**](docs/NoticesApi.md#notices_unread) | **GET** /api/me/notices/unread | Count unread notices
-*Peal::NotificationPreferencesApi* | [**notification_preferences_get**](docs/NotificationPreferencesApi.md#notification_preferences_get) | **GET** /api/me/notification-preferences | Get notification preferences
-*Peal::NotificationPreferencesApi* | [**notification_preferences_update**](docs/NotificationPreferencesApi.md#notification_preferences_update) | **PATCH** /api/me/notification-preferences | Change notification preferences
-*Peal::PostsApi* | [**posts_attempts**](docs/PostsApi.md#posts_attempts) | **GET** /api/workspaces/{workspaceId}/posts/{postId}/attempts | List a post's attempts
-*Peal::PostsApi* | [**posts_cancel**](docs/PostsApi.md#posts_cancel) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/cancel | Cancel a post
-*Peal::PostsApi* | [**posts_confirm**](docs/PostsApi.md#posts_confirm) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/targets/{targetId}/confirm | Confirm a post on a channel
-*Peal::PostsApi* | [**posts_create**](docs/PostsApi.md#posts_create) | **POST** /api/workspaces/{workspaceId}/posts | Create a draft
-*Peal::PostsApi* | [**posts_discard**](docs/PostsApi.md#posts_discard) | **DELETE** /api/workspaces/{workspaceId}/posts/{postId} | Discard a draft
-*Peal::PostsApi* | [**posts_drafts**](docs/PostsApi.md#posts_drafts) | **GET** /api/workspaces/{workspaceId}/posts/drafts | List drafts
-*Peal::PostsApi* | [**posts_get**](docs/PostsApi.md#posts_get) | **GET** /api/workspaces/{workspaceId}/posts/{postId} | Get a post
-*Peal::PostsApi* | [**posts_list**](docs/PostsApi.md#posts_list) | **GET** /api/workspaces/{workspaceId}/posts | List scheduled posts
-*Peal::PostsApi* | [**posts_repost**](docs/PostsApi.md#posts_repost) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/targets/{targetId}/repost | Repost on a channel
-*Peal::PostsApi* | [**posts_reschedule**](docs/PostsApi.md#posts_reschedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/reschedule | Reschedule a post
-*Peal::PostsApi* | [**posts_schedule**](docs/PostsApi.md#posts_schedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/schedule | Schedule a draft
-*Peal::PostsApi* | [**posts_unschedule**](docs/PostsApi.md#posts_unschedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/unschedule | Unschedule a post
-*Peal::PostsApi* | [**posts_update**](docs/PostsApi.md#posts_update) | **PUT** /api/workspaces/{workspaceId}/posts/{postId} | Update a draft
-*Peal::SessionApi* | [**session_me**](docs/SessionApi.md#session_me) | **GET** /api/me | Get the signed-in user
-*Peal::SystemApi* | [**health**](docs/SystemApi.md#health) | **GET** /api/health | Check that the server is up
-*Peal::SystemApi* | [**ready**](docs/SystemApi.md#ready) | **GET** /api/ready | Check that the server can take traffic
-*Peal::TiktokApi* | [**tiktok_creator**](docs/TiktokApi.md#tiktok_creator) | **GET** /api/workspaces/{workspaceId}/channels/{channelId}/tiktok-creator | Read a TikTok channel's creator
-
-
-## Documentation for Models
-
- - [Peal::AlreadyMemberEncoded](docs/AlreadyMemberEncoded.md)
- - [Peal::AltTextTooLongEncoded](docs/AltTextTooLongEncoded.md)
- - [Peal::AnalyticsSummary](docs/AnalyticsSummary.md)
- - [Peal::ApiKey](docs/ApiKey.md)
- - [Peal::ApiKeyNotFoundEncoded](docs/ApiKeyNotFoundEncoded.md)
- - [Peal::ApiKeysRevoke404Response](docs/ApiKeysRevoke404Response.md)
- - [Peal::AssistantAction](docs/AssistantAction.md)
- - [Peal::AssistantActionAnyOf](docs/AssistantActionAnyOf.md)
- - [Peal::AssistantActionAnyOf1](docs/AssistantActionAnyOf1.md)
- - [Peal::AssistantActionAnyOf2](docs/AssistantActionAnyOf2.md)
- - [Peal::AssistantActionAnyOf3](docs/AssistantActionAnyOf3.md)
- - [Peal::AssistantFailedEncoded](docs/AssistantFailedEncoded.md)
- - [Peal::AssistantInputRejectedEncoded](docs/AssistantInputRejectedEncoded.md)
- - [Peal::AssistantQuotaExceededEncoded](docs/AssistantQuotaExceededEncoded.md)
- - [Peal::AssistantStatus](docs/AssistantStatus.md)
- - [Peal::AssistantTone](docs/AssistantTone.md)
- - [Peal::AssistantUnavailableEncoded](docs/AssistantUnavailableEncoded.md)
- - [Peal::AttemptResult](docs/AttemptResult.md)
- - [Peal::Authorization](docs/Authorization.md)
- - [Peal::Billing](docs/Billing.md)
- - [Peal::BillingSubscription](docs/BillingSubscription.md)
- - [Peal::Channel](docs/Channel.md)
- - [Peal::ChannelCannotPostEncoded](docs/ChannelCannotPostEncoded.md)
- - [Peal::ChannelMetrics](docs/ChannelMetrics.md)
- - [Peal::ChannelNotFoundEncoded](docs/ChannelNotFoundEncoded.md)
- - [Peal::ChannelOptions](docs/ChannelOptions.md)
- - [Peal::ChannelStatus](docs/ChannelStatus.md)
- - [Peal::ChannelStatusAnyOf](docs/ChannelStatusAnyOf.md)
- - [Peal::ChannelStatusAnyOf1](docs/ChannelStatusAnyOf1.md)
- - [Peal::ChannelStatusAnyOf2](docs/ChannelStatusAnyOf2.md)
- - [Peal::ChannelsCompleteConnect404Response](docs/ChannelsCompleteConnect404Response.md)
- - [Peal::ChoosableAccount](docs/ChoosableAccount.md)
- - [Peal::ChooseAccounts](docs/ChooseAccounts.md)
- - [Peal::ConnectCallback](docs/ConnectCallback.md)
- - [Peal::ConnectChannel](docs/ConnectChannel.md)
- - [Peal::ConnectFailedEncoded](docs/ConnectFailedEncoded.md)
- - [Peal::ConnectFailureReason](docs/ConnectFailureReason.md)
- - [Peal::ConnectOutcome](docs/ConnectOutcome.md)
- - [Peal::ConnectOutcomeAnyOf](docs/ConnectOutcomeAnyOf.md)
- - [Peal::ConnectOutcomeAnyOf1](docs/ConnectOutcomeAnyOf1.md)
- - [Peal::ConnectablePlatforms](docs/ConnectablePlatforms.md)
- - [Peal::ContentViolation](docs/ContentViolation.md)
- - [Peal::ContentViolationAnyOf](docs/ContentViolationAnyOf.md)
- - [Peal::ContentViolationAnyOf1](docs/ContentViolationAnyOf1.md)
- - [Peal::ContentViolationAnyOf10](docs/ContentViolationAnyOf10.md)
- - [Peal::ContentViolationAnyOf11](docs/ContentViolationAnyOf11.md)
- - [Peal::ContentViolationAnyOf12](docs/ContentViolationAnyOf12.md)
- - [Peal::ContentViolationAnyOf13](docs/ContentViolationAnyOf13.md)
- - [Peal::ContentViolationAnyOf14](docs/ContentViolationAnyOf14.md)
- - [Peal::ContentViolationAnyOf15](docs/ContentViolationAnyOf15.md)
- - [Peal::ContentViolationAnyOf16](docs/ContentViolationAnyOf16.md)
- - [Peal::ContentViolationAnyOf17](docs/ContentViolationAnyOf17.md)
- - [Peal::ContentViolationAnyOf18](docs/ContentViolationAnyOf18.md)
- - [Peal::ContentViolationAnyOf19](docs/ContentViolationAnyOf19.md)
- - [Peal::ContentViolationAnyOf2](docs/ContentViolationAnyOf2.md)
- - [Peal::ContentViolationAnyOf20](docs/ContentViolationAnyOf20.md)
- - [Peal::ContentViolationAnyOf21](docs/ContentViolationAnyOf21.md)
- - [Peal::ContentViolationAnyOf22](docs/ContentViolationAnyOf22.md)
- - [Peal::ContentViolationAnyOf23](docs/ContentViolationAnyOf23.md)
- - [Peal::ContentViolationAnyOf24](docs/ContentViolationAnyOf24.md)
- - [Peal::ContentViolationAnyOf24Maximum](docs/ContentViolationAnyOf24Maximum.md)
- - [Peal::ContentViolationAnyOf25](docs/ContentViolationAnyOf25.md)
- - [Peal::ContentViolationAnyOf3](docs/ContentViolationAnyOf3.md)
- - [Peal::ContentViolationAnyOf4](docs/ContentViolationAnyOf4.md)
- - [Peal::ContentViolationAnyOf5](docs/ContentViolationAnyOf5.md)
- - [Peal::ContentViolationAnyOf6](docs/ContentViolationAnyOf6.md)
- - [Peal::ContentViolationAnyOf7](docs/ContentViolationAnyOf7.md)
- - [Peal::ContentViolationAnyOf8](docs/ContentViolationAnyOf8.md)
- - [Peal::ContentViolationAnyOf9](docs/ContentViolationAnyOf9.md)
- - [Peal::CreatedApiKey](docs/CreatedApiKey.md)
- - [Peal::DatabaseUnavailableEncoded](docs/DatabaseUnavailableEncoded.md)
- - [Peal::DraftPage](docs/DraftPage.md)
- - [Peal::EffectHttpApiErrorBadRequestEncoded](docs/EffectHttpApiErrorBadRequestEncoded.md)
- - [Peal::EngagementDay](docs/EngagementDay.md)
- - [Peal::FailureReason](docs/FailureReason.md)
- - [Peal::ForbiddenEncoded](docs/ForbiddenEncoded.md)
- - [Peal::InvalidDateRangeEncoded](docs/InvalidDateRangeEncoded.md)
- - [Peal::InvalidTimeRangeEncoded](docs/InvalidTimeRangeEncoded.md)
- - [Peal::InvalidTimeZoneEncoded](docs/InvalidTimeZoneEncoded.md)
- - [Peal::Invitation](docs/Invitation.md)
- - [Peal::InvitationNotFoundEncoded](docs/InvitationNotFoundEncoded.md)
- - [Peal::InvitationsCreate409Response](docs/InvitationsCreate409Response.md)
- - [Peal::InvitationsRevoke404Response](docs/InvitationsRevoke404Response.md)
- - [Peal::MarkNoticesRead](docs/MarkNoticesRead.md)
- - [Peal::Me](docs/Me.md)
- - [Peal::MeUser](docs/MeUser.md)
- - [Peal::Media](docs/Media.md)
- - [Peal::MediaAttachment](docs/MediaAttachment.md)
- - [Peal::MediaContentType](docs/MediaContentType.md)
- - [Peal::MediaCreate422Response](docs/MediaCreate422Response.md)
- - [Peal::MediaDescription](docs/MediaDescription.md)
- - [Peal::MediaDimensions](docs/MediaDimensions.md)
- - [Peal::MediaGet404Response](docs/MediaGet404Response.md)
- - [Peal::MediaInUseEncoded](docs/MediaInUseEncoded.md)
- - [Peal::MediaKind](docs/MediaKind.md)
- - [Peal::MediaNotFoundEncoded](docs/MediaNotFoundEncoded.md)
- - [Peal::MediaPage](docs/MediaPage.md)
- - [Peal::MediaStatus](docs/MediaStatus.md)
- - [Peal::MediaStatusAnyOf](docs/MediaStatusAnyOf.md)
- - [Peal::MediaStatusAnyOf1](docs/MediaStatusAnyOf1.md)
- - [Peal::MediaStatusAnyOf2](docs/MediaStatusAnyOf2.md)
- - [Peal::MediaStatusAnyOf3](docs/MediaStatusAnyOf3.md)
- - [Peal::MediaStoreUnavailableEncoded](docs/MediaStoreUnavailableEncoded.md)
- - [Peal::MediaTooLargeEncoded](docs/MediaTooLargeEncoded.md)
- - [Peal::MediaUsage](docs/MediaUsage.md)
- - [Peal::Membership](docs/Membership.md)
- - [Peal::MetricTotals](docs/MetricTotals.md)
- - [Peal::MetricsSnapshot](docs/MetricsSnapshot.md)
- - [Peal::NewApiKey](docs/NewApiKey.md)
- - [Peal::NewInvitation](docs/NewInvitation.md)
- - [Peal::NewUpload](docs/NewUpload.md)
- - [Peal::NonFiniteNumber](docs/NonFiniteNumber.md)
- - [Peal::Notice](docs/Notice.md)
- - [Peal::NoticeChannel](docs/NoticeChannel.md)
- - [Peal::NoticeEvent](docs/NoticeEvent.md)
- - [Peal::NoticeEventAnyOf](docs/NoticeEventAnyOf.md)
- - [Peal::NoticeEventAnyOf1](docs/NoticeEventAnyOf1.md)
- - [Peal::NoticeEventAnyOf2](docs/NoticeEventAnyOf2.md)
- - [Peal::NoticeEventAnyOf3](docs/NoticeEventAnyOf3.md)
- - [Peal::NoticeEventAnyOf4](docs/NoticeEventAnyOf4.md)
- - [Peal::NoticePage](docs/NoticePage.md)
- - [Peal::NotificationPreferences](docs/NotificationPreferences.md)
- - [Peal::NotificationPreferencesChange](docs/NotificationPreferencesChange.md)
- - [Peal::NotificationPreferencesChangeEmail](docs/NotificationPreferencesChangeEmail.md)
- - [Peal::NotificationPreferencesEmail](docs/NotificationPreferencesEmail.md)
- - [Peal::PaidPlan](docs/PaidPlan.md)
- - [Peal::PeriodUsage](docs/PeriodUsage.md)
- - [Peal::Permission](docs/Permission.md)
- - [Peal::Plan](docs/Plan.md)
- - [Peal::PlanAllowances](docs/PlanAllowances.md)
- - [Peal::PlanLimit](docs/PlanLimit.md)
- - [Peal::PlanLimitReachedEncoded](docs/PlanLimitReachedEncoded.md)
- - [Peal::PlanOffer](docs/PlanOffer.md)
- - [Peal::Platform](docs/Platform.md)
- - [Peal::PlatformUnreachableEncoded](docs/PlatformUnreachableEncoded.md)
- - [Peal::Post](docs/Post.md)
- - [Peal::PostAnalytics](docs/PostAnalytics.md)
- - [Peal::PostContent](docs/PostContent.md)
- - [Peal::PostContentInvalidEncoded](docs/PostContentInvalidEncoded.md)
- - [Peal::PostDraft](docs/PostDraft.md)
- - [Peal::PostMetrics](docs/PostMetrics.md)
- - [Peal::PostNotFoundEncoded](docs/PostNotFoundEncoded.md)
- - [Peal::PostOutcome](docs/PostOutcome.md)
- - [Peal::PostSchedule](docs/PostSchedule.md)
- - [Peal::PostStatus](docs/PostStatus.md)
- - [Peal::PostStatusConflictEncoded](docs/PostStatusConflictEncoded.md)
- - [Peal::PostTarget](docs/PostTarget.md)
- - [Peal::PostTargetStatus](docs/PostTargetStatus.md)
- - [Peal::PostsCreate422Response](docs/PostsCreate422Response.md)
- - [Peal::PostsGet404Response](docs/PostsGet404Response.md)
- - [Peal::PostsRepost409Response](docs/PostsRepost409Response.md)
- - [Peal::PostsSchedule422Response](docs/PostsSchedule422Response.md)
- - [Peal::PreparedUpload](docs/PreparedUpload.md)
- - [Peal::ProbeState](docs/ProbeState.md)
- - [Peal::PublicationAttempt](docs/PublicationAttempt.md)
- - [Peal::RejectionReason](docs/RejectionReason.md)
- - [Peal::Role](docs/Role.md)
- - [Peal::ScheduleInPastEncoded](docs/ScheduleInPastEncoded.md)
- - [Peal::SchedulePost](docs/SchedulePost.md)
- - [Peal::SignedRequest](docs/SignedRequest.md)
- - [Peal::SubscriptionStatus](docs/SubscriptionStatus.md)
- - [Peal::Suggestion](docs/Suggestion.md)
- - [Peal::SuggestionAnyOf](docs/SuggestionAnyOf.md)
- - [Peal::SuggestionAnyOf1](docs/SuggestionAnyOf1.md)
- - [Peal::SuggestionRequest](docs/SuggestionRequest.md)
- - [Peal::TargetConfirmation](docs/TargetConfirmation.md)
- - [Peal::TargetConfirmationAnyOf](docs/TargetConfirmationAnyOf.md)
- - [Peal::TargetConfirmationAnyOf1](docs/TargetConfirmationAnyOf1.md)
- - [Peal::TargetMetrics](docs/TargetMetrics.md)
- - [Peal::TargetOptions](docs/TargetOptions.md)
- - [Peal::TargetStatusConflictEncoded](docs/TargetStatusConflictEncoded.md)
- - [Peal::TextOverride](docs/TextOverride.md)
- - [Peal::TextUnit](docs/TextUnit.md)
- - [Peal::TikTokAccount](docs/TikTokAccount.md)
- - [Peal::TikTokAccountPosting](docs/TikTokAccountPosting.md)
- - [Peal::TikTokAccountPostingAnyOf](docs/TikTokAccountPostingAnyOf.md)
- - [Peal::TikTokAccountPostingAnyOf1](docs/TikTokAccountPostingAnyOf1.md)
- - [Peal::TikTokBlock](docs/TikTokBlock.md)
- - [Peal::TikTokCreator](docs/TikTokCreator.md)
- - [Peal::TikTokOptions](docs/TikTokOptions.md)
- - [Peal::TikTokPrivacyLevel](docs/TikTokPrivacyLevel.md)
- - [Peal::TooManyInvitationsEncoded](docs/TooManyInvitationsEncoded.md)
- - [Peal::TopPost](docs/TopPost.md)
- - [Peal::TranslationLanguage](docs/TranslationLanguage.md)
- - [Peal::UnauthenticatedEncoded](docs/UnauthenticatedEncoded.md)
- - [Peal::UnconfirmedReason](docs/UnconfirmedReason.md)
- - [Peal::UnknownChannelsEncoded](docs/UnknownChannelsEncoded.md)
- - [Peal::UnknownMediaEncoded](docs/UnknownMediaEncoded.md)
- - [Peal::UnreadNotices](docs/UnreadNotices.md)
- - [Peal::UnsupportedMediaTypeEncoded](docs/UnsupportedMediaTypeEncoded.md)
- - [Peal::UploadIncompleteEncoded](docs/UploadIncompleteEncoded.md)
- - [Peal::UploadPart](docs/UploadPart.md)
- - [Peal::UploadRejectedEncoded](docs/UploadRejectedEncoded.md)
- - [Peal::UploadTarget](docs/UploadTarget.md)
- - [Peal::UploadTargetAnyOf](docs/UploadTargetAnyOf.md)
- - [Peal::UploadTargetAnyOf1](docs/UploadTargetAnyOf1.md)
- - [Peal::Usage](docs/Usage.md)
- - [Peal::WorkspaceMember](docs/WorkspaceMember.md)
- - [Peal::WorkspaceNotFoundEncoded](docs/WorkspaceNotFoundEncoded.md)
- - [Peal::YouTubeOptions](docs/YouTubeOptions.md)
- - [Peal::YouTubePrivacy](docs/YouTubePrivacy.md)
-
-
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-### bearer
-
-- **Type**: Bearer authentication
+### Additional Query Parameters
+
+If you would like to send additional query parameters as part of the request, use the `additional_query_parameters` request option.
+
+```ruby
+require "peal"
+
+response = client.api_keys.create(
+    ...,
+    request_options: {
+        additional_query_parameters: {
+            "custom_param" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional Body Properties
+
+If you would like to send additional body properties as part of the request, use the `additional_body_parameters` request option.
+Properties are merged into the serialized request body using their API (wire-format) names and override any field the SDK sets with the same name. If the endpoint has no body, one is created from these properties, except for GET and HEAD requests, which are always sent without a body (the properties are ignored).
+This applies to JSON and form-urlencoded requests; it is not applied to multipart (file upload) requests.
+
+```ruby
+require "peal"
+
+response = client.api_keys.create(
+    ...,
+    request_options: {
+        additional_body_parameters: {
+            "custom_field" => "custom-value"
+        }
+    }
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
 
+On the other hand, contributions to the README are always very welcome!