peal 0.1.0

data/README.md

@@ -0,0 +1,353 @@
+# peal
+
+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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.0.1
+- Package version: 0.1.0
+- Generator version: 7.27.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://peal.social](https://peal.social)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build peal.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./peal-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./peal-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'peal', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/peal-social/peal, then add the following in the Gemfile:
+
+    gem 'peal', :git => 'https://github.com/peal-social/peal.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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
+
+api_instance = Peal::AnalyticsApi.new
+workspace_id = 'workspace_id_example' # String | 
+post_id = 'post_id_example' # String | 
+
+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
+
+```
+
+## 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::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
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AlreadyMemberEncoded.md

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

data/docs/AltTextTooLongEncoded.md

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

data/docs/AnalyticsApi.md

@@ -0,0 +1,155 @@
+# Peal::AnalyticsApi
+
+All URIs are relative to *https://app.peal.social*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**analytics_post**](AnalyticsApi.md#analytics_post) | **GET** /api/workspaces/{workspaceId}/analytics/posts/{postId} | Get a post's analytics |
+| [**analytics_summary**](AnalyticsApi.md#analytics_summary) | **GET** /api/workspaces/{workspaceId}/analytics/summary | Summarize the workspace's analytics |
+
+
+## analytics_post
+
+> <PostAnalytics> analytics_post(workspace_id, post_id)
+
+Get a post's analytics
+
+Answers with the counts of a post on each channel it went live on, over time. A post not published yet, or whose counts were not read yet, has no targets. Needs analytics: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::AnalyticsApi.new
+workspace_id = 'workspace_id_example' # String | 
+post_id = 'post_id_example' # String | 
+
+begin
+  # Get a post's analytics
+  result = api_instance.analytics_post(workspace_id, post_id)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_post: #{e}"
+end
+```
+
+#### Using the analytics_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostAnalytics>, Integer, Hash)> analytics_post_with_http_info(workspace_id, post_id)
+
+```ruby
+begin
+  # Get a post's analytics
+  data, status_code, headers = api_instance.analytics_post_with_http_info(workspace_id, post_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostAnalytics>
+rescue Peal::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **post_id** | **String** |  |  |
+
+### Return type
+
+[**PostAnalytics**](PostAnalytics.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## analytics_summary
+
+> <AnalyticsSummary> analytics_summary(workspace_id, from, time_zone, to)
+
+Summarize the workspace's analytics
+
+Sums up the posts published from `from` to `to`, both included and at most 366 days, as days run in `timeZone` (an IANA zone such as Europe/Paris): their latest counts in all and by channel, what they gained each day, and the five with the most engagement (likes, reposts, replies and quotes). Counts are read from the platforms every hour for 48 hours after a post goes live, then every day until it is 30 days old. Needs analytics: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::AnalyticsApi.new
+workspace_id = 'workspace_id_example' # String | 
+from = 'from_example' # String | 
+time_zone = 'time_zone_example' # String | 
+to = 'to_example' # String | 
+
+begin
+  # Summarize the workspace's analytics
+  result = api_instance.analytics_summary(workspace_id, from, time_zone, to)
+  p result
+rescue Peal::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_summary: #{e}"
+end
+```
+
+#### Using the analytics_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AnalyticsSummary>, Integer, Hash)> analytics_summary_with_http_info(workspace_id, from, time_zone, to)
+
+```ruby
+begin
+  # Summarize the workspace's analytics
+  data, status_code, headers = api_instance.analytics_summary_with_http_info(workspace_id, from, time_zone, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AnalyticsSummary>
+rescue Peal::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_summary_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** |  |  |
+| **from** | **String** |  |  |
+| **time_zone** | **String** |  |  |
+| **to** | **String** |  |  |
+
+### Return type
+
+[**AnalyticsSummary**](AnalyticsSummary.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AnalyticsSummary.md

@@ -0,0 +1,30 @@
+# Peal::AnalyticsSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | [**Array<ChannelMetrics>**](ChannelMetrics.md) |  |  |
+| **days** | [**Array<EngagementDay>**](EngagementDay.md) |  |  |
+| **from** | **String** |  |  |
+| **time_zone** | **String** |  |  |
+| **to** | **String** |  |  |
+| **top_posts** | [**Array<TopPost>**](TopPost.md) |  |  |
+| **totals** | [**MetricTotals**](MetricTotals.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::AnalyticsSummary.new(
+  channels: null,
+  days: null,
+  from: null,
+  time_zone: null,
+  to: null,
+  top_posts: null,
+  totals: null
+)
+```
+

data/docs/ApiKey.md

@@ -0,0 +1,28 @@
+# Peal::ApiKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  |  |
+| **expires_at** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **permissions** | **Array<String>** |  |  |
+| **start** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::ApiKey.new(
+  created_at: null,
+  expires_at: null,
+  id: null,
+  name: null,
+  permissions: null,
+  start: null
+)
+```
+

data/docs/ApiKeyNotFoundEncoded.md

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