postboost 1.8.0 → 1.14.0

data/docs/PreflightResult.md

@@ -0,0 +1,26 @@
+# PostBoost::PreflightResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | True when create-post with the same body would succeed. |  |
+| **errors** | **Hash<String, Array<String>>** | Validation and network-requirement errors keyed by field, as create-post would report them in a `422`. |  |
+| **issues** | [**Array<GuardrailError>**](GuardrailError.md) | Guardrail problems, in the order create-post would report the first of them. |  |
+| **publish_at** | **Time** | UTC time the post would publish at; null for a draft. |  |
+| **accounts** | [**Array<AccountHealth>**](AccountHealth.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PreflightResult.new(
+  valid: null,
+  errors: null,
+  issues: null,
+  publish_at: null,
+  accounts: null
+)
+```
+

data/docs/QueueSlots.md

@@ -0,0 +1,20 @@
+# PostBoost::QueueSlots
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slots** | **Array<Hash<String, Object>>** | Upcoming posting times and scheduled posts, in order. |  |
+| **next_cursor** | **String** | Pass as `after` for the next page; null at the end. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::QueueSlots.new(
+  slots: null,
+  next_cursor: null
+)
+```
+

data/docs/RecommendedPostingTimes.md

@@ -0,0 +1,26 @@
+# PostBoost::RecommendedPostingTimes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_data** | **Boolean** |  |  |
+| **timezone** | **String** |  | [optional] |
+| **slots_per_day** | **Integer** |  |  |
+| **samples** | **Integer** | Number of past posts the recommendation is based on. |  |
+| **times** | **Array<Hash<String, Object>>** | Recommended times per weekday. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecommendedPostingTimes.new(
+  has_data: null,
+  timezone: null,
+  slots_per_day: null,
+  samples: null,
+  times: null
+)
+```
+

data/docs/ReconnectLink.md

@@ -0,0 +1,22 @@
+# PostBoost::ReconnectLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Single-use link to forward to the account owner. |  |
+| **expires_at** | **Time** |  |  |
+| **account_uuid** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReconnectLink.new(
+  url: null,
+  expires_at: null,
+  account_uuid: null
+)
+```
+

data/docs/RecyclingRule.md

@@ -0,0 +1,42 @@
+# PostBoost::RecyclingRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **type** | **String** |  |  |
+| **post_uuid** | **String** |  |  |
+| **tag_uuid** | **String** |  |  |
+| **account_ids** | **Array<Integer>** |  |  |
+| **interval_days** | **Integer** |  |  |
+| **max_runs** | **Integer** |  |  |
+| **runs_done** | **Integer** | Copies created so far. |  |
+| **placement** | **String** |  |  |
+| **active** | **Boolean** |  |  |
+| **next_run_at** | **Time** |  |  |
+| **last_run_at** | **Time** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecyclingRule.new(
+  uuid: null,
+  type: null,
+  post_uuid: null,
+  tag_uuid: null,
+  account_ids: null,
+  interval_days: null,
+  max_runs: null,
+  runs_done: null,
+  placement: null,
+  active: null,
+  next_run_at: null,
+  last_run_at: null,
+  created_at: null
+)
+```
+

data/docs/RecyclingRuleInput.md

@@ -0,0 +1,34 @@
+# PostBoost::RecyclingRuleInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval_days** | **Integer** | Days between copies. |  |
+| **max_runs** | **Integer** | Copies to create before the rule stops; null = no limit. | [optional] |
+| **placement** | **String** | `queue`: each account's next free queue slot (skipped when the queue is full for 14 days). `same_time`: the source post's time of day. `draft`: a draft only. | [optional][default to 'queue'] |
+| **account_ids** | **Array<Integer>** | Accounts for the copies; default the source post's accounts. For a tag pool, limits each picked post's accounts. | [optional] |
+| **start_at** | **Time** | First run; default one interval from now. | [optional] |
+| **active** | **Boolean** |  | [optional][default to true] |
+| **type** | **String** | Defaults to `post` when `post_uuid` is sent, else `tag_pool`. | [optional] |
+| **post_uuid** | **String** | The post to recycle (type `post`). | [optional] |
+| **tag_uuid** | **String** | The tag whose published posts are recycled, least recently recycled first (type `tag_pool`). | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecyclingRuleInput.new(
+  interval_days: null,
+  max_runs: null,
+  placement: null,
+  account_ids: null,
+  start_at: null,
+  active: null,
+  type: null,
+  post_uuid: null,
+  tag_uuid: null
+)
+```
+

data/docs/RecyclingRuleSettings.md

@@ -0,0 +1,28 @@
+# PostBoost::RecyclingRuleSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval_days** | **Integer** | Days between copies. |  |
+| **max_runs** | **Integer** | Copies to create before the rule stops; null = no limit. | [optional] |
+| **placement** | **String** | `queue`: each account's next free queue slot (skipped when the queue is full for 14 days). `same_time`: the source post's time of day. `draft`: a draft only. | [optional][default to 'queue'] |
+| **account_ids** | **Array<Integer>** | Accounts for the copies; default the source post's accounts. For a tag pool, limits each picked post's accounts. | [optional] |
+| **start_at** | **Time** | First run; default one interval from now. | [optional] |
+| **active** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecyclingRuleSettings.new(
+  interval_days: null,
+  max_runs: null,
+  placement: null,
+  account_ids: null,
+  start_at: null,
+  active: null
+)
+```
+

data/docs/RecyclingRuleUpdate.md

@@ -0,0 +1,28 @@
+# PostBoost::RecyclingRuleUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval_days** | **Integer** |  | [optional] |
+| **max_runs** | **Integer** |  | [optional] |
+| **placement** | **String** |  | [optional] |
+| **account_ids** | **Array<Integer>** |  | [optional] |
+| **start_at** | **Time** | Next run. | [optional] |
+| **active** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecyclingRuleUpdate.new(
+  interval_days: null,
+  max_runs: null,
+  placement: null,
+  account_ids: null,
+  start_at: null,
+  active: null
+)
+```
+

data/docs/RecyclingRun.md

@@ -0,0 +1,28 @@
+# PostBoost::RecyclingRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **status** | **String** |  |  |
+| **reason** | **String** | Why the run skipped or failed; on `created`, a note such as `x_skipped_identical_text`. |  |
+| **source_post_uuid** | **String** |  |  |
+| **created_post_uuid** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RecyclingRun.new(
+  id: null,
+  status: null,
+  reason: null,
+  source_post_uuid: null,
+  created_post_uuid: null,
+  created_at: null
+)
+```
+

data/docs/ReportBranding.md

@@ -0,0 +1,28 @@
+# PostBoost::ReportBranding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** |  |  |
+| **primary_color** | **String** |  |  |
+| **footer_text** | **String** |  |  |
+| **show_powered_by** | **Boolean** |  |  |
+| **has_logo** | **Boolean** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReportBranding.new(
+  display_name: null,
+  primary_color: null,
+  footer_text: null,
+  show_powered_by: null,
+  has_logo: null,
+  updated_at: null
+)
+```
+

data/docs/ReportBrandingInput.md

@@ -0,0 +1,24 @@
+# PostBoost::ReportBrandingInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | Name in the report header; default the workspace name. | [optional] |
+| **primary_color** | **String** |  | [optional] |
+| **footer_text** | **String** |  | [optional] |
+| **show_powered_by** | **Boolean** | Show \"Generated with PostBoost\" in the footer. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReportBrandingInput.new(
+  display_name: null,
+  primary_color: null,
+  footer_text: null,
+  show_powered_by: null
+)
+```
+

data/docs/ReportExport.md

@@ -0,0 +1,42 @@
+# PostBoost::ReportExport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **format** | **String** |  |  |
+| **dataset** | **String** |  |  |
+| **period** | **String** |  |  |
+| **date_from** | **Date** |  |  |
+| **date_to** | **Date** |  |  |
+| **account_ids** | **Array<Integer>** |  |  |
+| **status** | **String** |  |  |
+| **error** | **String** |  |  |
+| **bytes** | **Integer** |  |  |
+| **download_url** | **String** | Authenticated download URL while the file is available. |  |
+| **created_at** | **Time** |  |  |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReportExport.new(
+  uuid: null,
+  format: null,
+  dataset: null,
+  period: null,
+  date_from: null,
+  date_to: null,
+  account_ids: null,
+  status: null,
+  error: null,
+  bytes: null,
+  download_url: null,
+  created_at: null,
+  expires_at: null
+)
+```
+

data/docs/ReportExportInput.md

@@ -0,0 +1,28 @@
+# PostBoost::ReportExportInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **format** | **String** |  |  |
+| **dataset** | **String** | CSV rows; default `posts`. Ignored for PDF. | [optional] |
+| **period** | **String** | Default `last_month`. Ignored when `date_from` and `date_to` are sent. | [optional] |
+| **date_from** | **Date** |  | [optional] |
+| **date_to** | **Date** | At most 366 days after `date_from`. | [optional] |
+| **account_ids** | **Array<Integer>** | Limit the report to these accounts; default all. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReportExportInput.new(
+  format: null,
+  dataset: null,
+  period: null,
+  date_from: null,
+  date_to: null,
+  account_ids: null
+)
+```
+

data/docs/RepurposeContent200Response.md

@@ -0,0 +1,20 @@
+# PostBoost::RepurposeContent200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**RepurposeResult**](RepurposeResult.md) |  |  |
+| **meta** | [**BrandVoiceMeta**](BrandVoiceMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeContent200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/RepurposeInput.md

@@ -0,0 +1,54 @@
+# PostBoost::RepurposeInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | **String** |  |  |
+| **url** | **String** | Article URL (`url`) or YouTube video URL (`youtube`). For `text`, an optional link to mention. | [optional] |
+| **pdf_url** | **String** | Public URL of a PDF (`pdf`), at most 20 MB. | [optional] |
+| **title** | **String** | Required for `text`. For `youtube`, overrides the video title. | [optional] |
+| **text** | **String** | Required for `text`. Long sources are cut to about 12,000 characters. | [optional] |
+| **transcript** | **String** | Video transcript for `youtube`. | [optional] |
+| **platforms** | **Array<String>** | Limit to connected accounts of these networks. Ignored when `account_ids` is set. | [optional] |
+| **account_ids** | **Array<Integer>** | Target accounts. Default is every connected account. | [optional] |
+| **tone** | **String** |  | [optional][default to 'engaging'] |
+| **content_length** | **String** |  | [optional][default to 'medium'] |
+| **hashtags** | **String** |  | [optional][default to 'few'] |
+| **cta** | **String** |  | [optional][default to 'none'] |
+| **language** | **String** |  | [optional][default to 'auto'] |
+| **custom_instructions** | **String** |  | [optional] |
+| **carousel** | **Boolean** | Render carousel slides (one extra AI credit for the outline). | [optional][default to true] |
+| **slide_count** | **Integer** | Total slides including the hook and call-to-action slides. | [optional][default to 7] |
+| **theme** | [**RepurposeInputTheme**](RepurposeInputTheme.md) |  | [optional] |
+| **create_post** | **Boolean** | Create the draft post. `false` returns captions and slides only. | [optional][default to true] |
+| **use_brand_voice** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeInput.new(
+  source_type: null,
+  url: null,
+  pdf_url: null,
+  title: null,
+  text: null,
+  transcript: null,
+  platforms: null,
+  account_ids: null,
+  tone: null,
+  content_length: null,
+  hashtags: null,
+  cta: null,
+  language: null,
+  custom_instructions: null,
+  carousel: null,
+  slide_count: null,
+  theme: null,
+  create_post: null,
+  use_brand_voice: null
+)
+```
+

data/docs/RepurposeInputTheme.md

@@ -0,0 +1,22 @@
+# PostBoost::RepurposeInputTheme
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **background** | **String** |  | [optional] |
+| **foreground** | **String** |  | [optional] |
+| **accent** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeInputTheme.new(
+  background: null,
+  foreground: null,
+  accent: null
+)
+```
+

data/docs/RepurposeResult.md

@@ -0,0 +1,32 @@
+# PostBoost::RepurposeResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**RepurposeResultSource**](RepurposeResultSource.md) |  |  |
+| **captions** | [**Array<BlogToSocialCaption>**](BlogToSocialCaption.md) |  |  |
+| **slides** | [**Array<RepurposeSlide>**](RepurposeSlide.md) | Carousel slides in order (hook first, call to action last). Empty without a carousel. |  |
+| **media** | [**RepurposeResultMedia**](RepurposeResultMedia.md) |  | [optional] |
+| **post_uuid** | **String** | The draft post; null when `create_post` was false. |  |
+| **credits_used** | **Integer** |  |  |
+| **credits_remaining** | **Integer** | Null for unlimited plans. |  |
+| **warnings** | **Array<String>** | Parts that were skipped (for example a network that gets no carousel). |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeResult.new(
+  source: null,
+  captions: null,
+  slides: null,
+  media: null,
+  post_uuid: null,
+  credits_used: null,
+  credits_remaining: null,
+  warnings: null
+)
+```
+

data/docs/RepurposeResultMedia.md

@@ -0,0 +1,20 @@
+# PostBoost::RepurposeResultMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeResultMedia.new(
+  id: null,
+  url: null
+)
+```
+

data/docs/RepurposeResultSource.md

@@ -0,0 +1,22 @@
+# PostBoost::RepurposeResultSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **title** | **String** |  |  |
+| **url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeResultSource.new(
+  type: null,
+  title: null,
+  url: null
+)
+```
+

data/docs/RepurposeSlide.md

@@ -0,0 +1,20 @@
+# PostBoost::RepurposeSlide
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_id** | **Integer** | Media library ID; reuse it in post versions. |  |
+| **url** | **String** | Public URL of the image. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RepurposeSlide.new(
+  media_id: null,
+  url: null
+)
+```
+

data/docs/ResellerClient.md

@@ -0,0 +1,32 @@
+# PostBoost::ResellerClient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** | The client workspace UUID; use it as `workspaceUuid` for the client's own endpoints. |  |
+| **name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **accounts** | **Integer** |  |  |
+| **accounts_needing_reconnect** | **Integer** |  |  |
+| **members** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+| **archived_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ResellerClient.new(
+  uuid: null,
+  name: null,
+  status: null,
+  accounts: null,
+  accounts_needing_reconnect: null,
+  members: null,
+  created_at: null,
+  archived_at: null
+)
+```
+

data/docs/ResellerClientInput.md

@@ -0,0 +1,18 @@
+# PostBoost::ResellerClientInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ResellerClientInput.new(
+  name: null
+)
+```
+

data/docs/ResellerClientUsage.md

@@ -0,0 +1,20 @@
+# PostBoost::ResellerClientUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **used** | **Integer** | Active client workspaces. |  |
+| **limit** | **Integer** | Client workspaces the Reseller plan allows. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ResellerClientUsage.new(
+  used: null,
+  limit: null
+)
+```
+