postboost 1.0.0 → 1.14.0

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
+)
+```
+

data/docs/RetryPostAccountResult.md

@@ -0,0 +1,22 @@
+# PostBoost::RetryPostAccountResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **status** | [**PostStatus**](PostStatus.md) |  |  |
+| **publish_progress** | [**PublishProgress**](PublishProgress.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RetryPostAccountResult.new(
+  success: null,
+  status: null,
+  publish_progress: null
+)
+```
+

data/docs/RssFeed.md

@@ -0,0 +1,38 @@
+# PostBoost::RssFeed
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **url** | **String** |  |  |
+| **name** | **String** |  |  |
+| **account_ids** | **Array<Integer>** |  |  |
+| **mode** | **String** |  |  |
+| **template** | **String** |  |  |
+| **max_items_per_run** | **Integer** |  |  |
+| **active** | **Boolean** |  |  |
+| **last_polled_at** | **Time** |  |  |
+| **last_error** | **String** | Error of the last check; after 5 failures in a row the feed is checked every 6 hours. |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RssFeed.new(
+  uuid: null,
+  url: null,
+  name: null,
+  account_ids: null,
+  mode: null,
+  template: null,
+  max_items_per_run: null,
+  active: null,
+  last_polled_at: null,
+  last_error: null,
+  created_at: null
+)
+```
+

data/docs/RssFeedInput.md

@@ -0,0 +1,30 @@
+# PostBoost::RssFeedInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Public http(s) URL of an RSS 2.0 or Atom feed. |  |
+| **name** | **String** |  | [optional] |
+| **account_ids** | **Array<Integer>** |  |  |
+| **mode** | **String** |  | [optional][default to 'draft'] |
+| **template** | **String** | Post text. Placeholders: `{title}`, `{link}`, `{summary}` (up to 280 characters). Default `{title}` + blank line + `{link}`. | [optional] |
+| **max_items_per_run** | **Integer** |  | [optional][default to 3] |
+| **active** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RssFeedInput.new(
+  url: null,
+  name: null,
+  account_ids: null,
+  mode: null,
+  template: null,
+  max_items_per_run: null,
+  active: null
+)
+```
+

data/docs/RssFeedUpdate.md

@@ -0,0 +1,30 @@
+# PostBoost::RssFeedUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **account_ids** | **Array<Integer>** |  | [optional] |
+| **mode** | **String** |  | [optional] |
+| **template** | **String** |  | [optional] |
+| **max_items_per_run** | **Integer** |  | [optional] |
+| **active** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RssFeedUpdate.new(
+  url: null,
+  name: null,
+  account_ids: null,
+  mode: null,
+  template: null,
+  max_items_per_run: null,
+  active: null
+)
+```
+

data/docs/RunAgent202Response.md

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

data/docs/SchedulePostRequest.md

@@ -5,6 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **post_now** | **Boolean** |  |  |
+| **date** | **Date** | New date for the post (Y-m-d). Use together with `time`. | [optional] |
+| **time** | **String** | New time for the post (H:i). | [optional] |
+| **timezone** | **String** | Timezone `date`, `time` and `accounts_schedule` are read in. Defaults to the workspace timezone. | [optional] |
+| **accounts_schedule** | [**Array<AccountSchedule>**](AccountSchedule.md) | Per-account departure times. When omitted, accounts keep their offsets from the post time. | [optional] |
 
 ## Example
 
@@ -12,7 +16,11 @@
 require 'postboost'
 
 instance = PostBoost::SchedulePostRequest.new(
-  post_now: null
+  post_now: null,
+  date: 2026-11-01,
+  time: 10:00,
+  timezone: America/New_York,
+  accounts_schedule: null
 )
 ```
 

data/docs/ScheduleResult.md

@@ -4,8 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **success** | **Boolean** |  | [optional] |
+| **success** | **Boolean** |  |  |
 | **scheduled_at** | **Time** |  | [optional] |
+| **needs_approval** | **Boolean** | True when the post now waits for approval instead of being scheduled (not returned by approve). | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'postboost'
 
 instance = PostBoost::ScheduleResult.new(
   success: null,
-  scheduled_at: 2025-06-01T10:00:00Z
+  scheduled_at: 2025-06-01T10:00:00Z,
+  needs_approval: null
 )
 ```
 

data/docs/Subscription.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **platform_subscription_id** | **String** |  | [optional] |
-| **platform_plan_id** | **String** |  | [optional] |
-| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  | [optional] |
-| **recurring** | **Boolean** |  | [optional] |
+| **name** | **String** |  |  |
+| **platform_subscription_id** | **String** |  |  |
+| **platform_plan_id** | **String** |  |  |
+| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  |  |
+| **recurring** | **Boolean** |  |  |
 | **trial_ends_at** | **Time** |  | [optional] |
 | **paused_from** | **Time** |  | [optional] |
 | **ends_at** | **Time** |  | [optional] |

data/docs/SubscriptionsApi.md

@@ -22,6 +22,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Add generic subscription
 
+Assigns a non-Stripe (generic) subscription plan to the workspace, optionally granting a trial period. Used for AppSumo-style lifetime deals. Admin only.
+
 ### Examples
 
 ```ruby
@@ -87,10 +89,12 @@ end
 
 ## cancel_subscription
 
-> Object cancel_subscription(workspace_uuid)
+> Object cancel_subscription(workspace_uuid, opts)
 
 Cancel subscription
 
+Cancels the workspace's Stripe subscription at the end of the current billing period, or right away with `immediately: true`. Works for active and past-due subscriptions. Admin only. 
+
 ### Examples
 
 ```ruby
@@ -104,10 +108,13 @@ end
 
 api_instance = PostBoost::SubscriptionsApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  cancel_subscription_request: PostBoost::CancelSubscriptionRequest.new # CancelSubscriptionRequest | 
+}
 
 begin
   # Cancel subscription
-  result = api_instance.cancel_subscription(workspace_uuid)
+  result = api_instance.cancel_subscription(workspace_uuid, opts)
   p result
 rescue PostBoost::ApiError => e
   puts "Error when calling SubscriptionsApi->cancel_subscription: #{e}"
@@ -118,12 +125,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> cancel_subscription_with_http_info(workspace_uuid)
+> <Array(Object, Integer, Hash)> cancel_subscription_with_http_info(workspace_uuid, opts)
 
 ```ruby
 begin
   # Cancel subscription
-  data, status_code, headers = api_instance.cancel_subscription_with_http_info(workspace_uuid)
+  data, status_code, headers = api_instance.cancel_subscription_with_http_info(workspace_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Object
@@ -137,6 +144,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **cancel_subscription_request** | [**CancelSubscriptionRequest**](CancelSubscriptionRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -148,7 +156,7 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -158,6 +166,8 @@ end
 
 Change subscription plan
 
+Switches the workspace to a different Stripe plan. Optionally prorates the change and bills immediately. Admin only.
+
 ### Examples
 
 ```ruby
@@ -298,6 +308,8 @@ end
 
 Create subscription
 
+Manually creates a subscription record for the workspace (for external billing integrations). Admin only.
+
 ### Examples
 
 ```ruby
@@ -367,6 +379,8 @@ end
 
 Delete subscription
 
+Removes the subscription record from the workspace. Admin only.
+
 ### Examples
 
 ```ruby
@@ -434,6 +448,8 @@ end
 
 Get subscription
 
+Returns the active subscription for the workspace, or `null` if none exists. Admin only.
+
 ### Examples
 
 ```ruby
@@ -501,6 +517,8 @@ end
 
 Remove generic subscription
 
+Removes the generic (non-Stripe) subscription from the workspace. Returns `422` when the workspace has no generic subscription. Admin only.
+
 ### Examples
 
 ```ruby
@@ -568,6 +586,8 @@ end
 
 Resume subscription
 
+Resumes a previously canceled subscription before it expires. Admin only.
+
 ### Examples
 
 ```ruby
@@ -635,6 +655,8 @@ end
 
 Update subscription
 
+Updates the plan ID, status, or trial/pause dates of an existing subscription. Admin only.
+
 ### Examples
 
 ```ruby

data/docs/Tag.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **uuid** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **hex_color** | **String** |  | [optional] |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **hex_color** | **String** |  |  |
 
 ## Example
 

data/docs/TagsApi.md

@@ -13,10 +13,12 @@ All URIs are relative to *https://postboost.co/app/api*
 
 ## create_tag
 
-> <Tag> create_tag(workspace_uuid, tag_input)
+> <Tag> create_tag(workspace_uuid, tag_input, opts)
 
 Create tag
 
+Creates a new color-coded tag in the workspace for organizing posts.
+
 ### Examples
 
 ```ruby
@@ -31,10 +33,13 @@ end
 api_instance = PostBoost::TagsApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
 tag_input = PostBoost::TagInput.new({name: 'name_example', hex_color: '#3B82F6'}) # TagInput | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+}
 
 begin
   # Create tag
-  result = api_instance.create_tag(workspace_uuid, tag_input)
+  result = api_instance.create_tag(workspace_uuid, tag_input, opts)
   p result
 rescue PostBoost::ApiError => e
   puts "Error when calling TagsApi->create_tag: #{e}"
@@ -45,12 +50,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Tag>, Integer, Hash)> create_tag_with_http_info(workspace_uuid, tag_input)
+> <Array(<Tag>, Integer, Hash)> create_tag_with_http_info(workspace_uuid, tag_input, opts)
 
 ```ruby
 begin
   # Create tag
-  data, status_code, headers = api_instance.create_tag_with_http_info(workspace_uuid, tag_input)
+  data, status_code, headers = api_instance.create_tag_with_http_info(workspace_uuid, tag_input, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Tag>
@@ -65,6 +70,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** | UUID of the workspace. |  |
 | **tag_input** | [**TagInput**](TagInput.md) |  |  |
+| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.  | [optional] |
 
 ### Return type
 
@@ -86,6 +92,8 @@ end
 
 Delete tag
 
+Permanently deletes a tag. Posts that had this tag attached are unaffected.
+
 ### Examples
 
 ```ruby
@@ -155,6 +163,8 @@ end
 
 Get tag
 
+Returns a single tag by UUID.
+
 ### Examples
 
 ```ruby
@@ -224,6 +234,8 @@ end
 
 List tags
 
+Returns all tags defined in the workspace.
+
 ### Examples
 
 ```ruby
@@ -291,6 +303,8 @@ end
 
 Update tag
 
+Updates a tag's name or color.
+
 ### Examples
 
 ```ruby

data/docs/Template.md

@@ -0,0 +1,22 @@
+# PostBoost::Template
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Template UUID. |  |
+| **name** | **String** |  |  |
+| **content** | [**Array<TemplateContentItem>**](TemplateContentItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::Template.new(
+  id: null,
+  name: Product launch,
+  content: null
+)
+```
+

data/docs/TemplateContentItem.md

@@ -0,0 +1,20 @@
+# PostBoost::TemplateContentItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** |  |  |
+| **media** | **Array<Hash<String, Object>>** | Media items from the library (same shape as the media endpoints). |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::TemplateContentItem.new(
+  body: null,
+  media: null
+)
+```
+

data/docs/TemplateInput.md

@@ -0,0 +1,20 @@
+# PostBoost::TemplateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **content** | [**Array<TemplateInputContentInner>**](TemplateInputContentInner.md) | One item per post in a thread; usually one. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::TemplateInput.new(
+  name: null,
+  content: null
+)
+```
+