peal 0.1.0 → 0.2.0

data/docs/TargetOptions.md

@@ -1,48 +0,0 @@
-# Peal::TargetOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **category_id** | **String** |  | [optional] |
-| **contains_synthetic_media** | **Boolean** |  | [optional] |
-| **made_for_kids** | **Boolean** |  | [optional] |
-| **notify_subscribers** | **Boolean** |  | [optional] |
-| **platform** | **String** |  |  |
-| **privacy** | [**YouTubePrivacy**](YouTubePrivacy.md) |  | [optional] |
-| **tags** | **Array<String>** |  | [optional] |
-| **title** | **String** |  | [optional] |
-| **ai_generated** | **Boolean** |  | [optional] |
-| **brand_content** | **Boolean** |  | [optional] |
-| **brand_organic** | **Boolean** |  | [optional] |
-| **commercial_content** | **Boolean** |  | [optional] |
-| **disable_comment** | **Boolean** |  | [optional] |
-| **disable_duet** | **Boolean** |  | [optional] |
-| **disable_stitch** | **Boolean** |  | [optional] |
-| **privacy_level** | [**TikTokPrivacyLevel**](TikTokPrivacyLevel.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::TargetOptions.new(
-  category_id: null,
-  contains_synthetic_media: null,
-  made_for_kids: null,
-  notify_subscribers: null,
-  platform: null,
-  privacy: null,
-  tags: null,
-  title: null,
-  ai_generated: null,
-  brand_content: null,
-  brand_organic: null,
-  commercial_content: null,
-  disable_comment: null,
-  disable_duet: null,
-  disable_stitch: null,
-  privacy_level: null
-)
-```
-

data/docs/TargetStatusConflictEncoded.md

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

data/docs/TextOverride.md

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

data/docs/TextUnit.md

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

data/docs/TikTokAccount.md

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

data/docs/TikTokAccountPosting.md

@@ -1,22 +0,0 @@
-# Peal::TikTokAccountPosting
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_tag** | **String** |  |  |
-| **creator** | [**TikTokCreator**](TikTokCreator.md) |  |  |
-| **reason** | [**TikTokBlock**](TikTokBlock.md) |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::TikTokAccountPosting.new(
-  _tag: null,
-  creator: null,
-  reason: null
-)
-```
-

data/docs/TikTokAccountPostingAnyOf.md

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

data/docs/TikTokAccountPostingAnyOf1.md

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

data/docs/TikTokBlock.md

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

data/docs/TikTokCreator.md

@@ -1,32 +0,0 @@
-# Peal::TikTokCreator
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **avatar_url** | **String** |  |  |
-| **comment_disabled** | **Boolean** |  |  |
-| **duet_disabled** | **Boolean** |  |  |
-| **max_video_duration_ms** | **Integer** |  |  |
-| **nickname** | **String** |  |  |
-| **privacy_levels** | [**Array<TikTokPrivacyLevel>**](TikTokPrivacyLevel.md) |  |  |
-| **stitch_disabled** | **Boolean** |  |  |
-| **username** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::TikTokCreator.new(
-  avatar_url: null,
-  comment_disabled: null,
-  duet_disabled: null,
-  max_video_duration_ms: null,
-  nickname: null,
-  privacy_levels: null,
-  stitch_disabled: null,
-  username: null
-)
-```
-

data/docs/TikTokOptions.md

@@ -1,34 +0,0 @@
-# Peal::TikTokOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ai_generated** | **Boolean** |  | [optional] |
-| **brand_content** | **Boolean** |  | [optional] |
-| **brand_organic** | **Boolean** |  | [optional] |
-| **commercial_content** | **Boolean** |  | [optional] |
-| **disable_comment** | **Boolean** |  | [optional] |
-| **disable_duet** | **Boolean** |  | [optional] |
-| **disable_stitch** | **Boolean** |  | [optional] |
-| **platform** | **String** |  |  |
-| **privacy_level** | [**TikTokPrivacyLevel**](TikTokPrivacyLevel.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::TikTokOptions.new(
-  ai_generated: null,
-  brand_content: null,
-  brand_organic: null,
-  commercial_content: null,
-  disable_comment: null,
-  disable_duet: null,
-  disable_stitch: null,
-  platform: null,
-  privacy_level: null
-)
-```
-

data/docs/TikTokPrivacyLevel.md

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

data/docs/TiktokApi.md

@@ -1,79 +0,0 @@
-# Peal::TiktokApi
-
-All URIs are relative to *https://app.peal.social*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**tiktok_creator**](TiktokApi.md#tiktok_creator) | **GET** /api/workspaces/{workspaceId}/channels/{channelId}/tiktok-creator | Read a TikTok channel's creator |
-
-
-## tiktok_creator
-
-> <TikTokAccount> tiktok_creator(channel_id, workspace_id)
-
-Read a TikTok channel's creator
-
-Reads a TikTok channel's creator from TikTok: their nickname, the audiences the account offers, the interactions they turned off and the longest video they may post, or why they cannot post now. A channel that is not TikTok's is ChannelNotFound. Needs post:create.
-
-### 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::TiktokApi.new
-channel_id = 'channel_id_example' # String | 
-workspace_id = 'workspace_id_example' # String | 
-
-begin
-  # Read a TikTok channel's creator
-  result = api_instance.tiktok_creator(channel_id, workspace_id)
-  p result
-rescue Peal::ApiError => e
-  puts "Error when calling TiktokApi->tiktok_creator: #{e}"
-end
-```
-
-#### Using the tiktok_creator_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<TikTokAccount>, Integer, Hash)> tiktok_creator_with_http_info(channel_id, workspace_id)
-
-```ruby
-begin
-  # Read a TikTok channel's creator
-  data, status_code, headers = api_instance.tiktok_creator_with_http_info(channel_id, workspace_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TikTokAccount>
-rescue Peal::ApiError => e
-  puts "Error when calling TiktokApi->tiktok_creator_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **channel_id** | **String** |  |  |
-| **workspace_id** | **String** |  |  |
-
-### Return type
-
-[**TikTokAccount**](TikTokAccount.md)
-
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/TooManyInvitationsEncoded.md

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

data/docs/TopPost.md

@@ -1,30 +0,0 @@
-# Peal::TopPost
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **channel_id** | **String** |  |  |
-| **engagement** | **Integer** |  |  |
-| **metrics** | [**PostMetrics**](PostMetrics.md) |  |  |
-| **permalink** | **String** |  |  |
-| **post_id** | **String** |  |  |
-| **published_at** | **String** |  |  |
-| **target_id** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::TopPost.new(
-  channel_id: null,
-  engagement: null,
-  metrics: null,
-  permalink: null,
-  post_id: null,
-  published_at: null,
-  target_id: null
-)
-```
-

data/docs/TranslationLanguage.md

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

data/docs/UnauthenticatedEncoded.md

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

data/docs/UnconfirmedReason.md

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

data/docs/UnknownChannelsEncoded.md

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

data/docs/UnknownMediaEncoded.md

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

data/docs/UnreadNotices.md

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

data/docs/UnsupportedMediaTypeEncoded.md

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

data/docs/UploadIncompleteEncoded.md

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

data/docs/UploadPart.md

@@ -1,22 +0,0 @@
-# Peal::UploadPart
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **byte_size** | **Integer** |  |  |
-| **part_number** | **Integer** |  |  |
-| **request** | [**SignedRequest**](SignedRequest.md) |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::UploadPart.new(
-  byte_size: null,
-  part_number: null,
-  request: null
-)
-```
-

data/docs/UploadRejectedEncoded.md

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

data/docs/UploadTarget.md

@@ -1,26 +0,0 @@
-# Peal::UploadTarget
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_tag** | **String** |  |  |
-| **expires_at** | **String** |  |  |
-| **request** | [**SignedRequest**](SignedRequest.md) |  |  |
-| **part_size** | **Integer** |  |  |
-| **parts** | [**Array<UploadPart>**](UploadPart.md) |  |  |
-
-## Example
-
-```ruby
-require 'peal'
-
-instance = Peal::UploadTarget.new(
-  _tag: null,
-  expires_at: null,
-  request: null,
-  part_size: null,
-  parts: null
-)
-```
-

data/docs/UploadTargetAnyOf.md

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