postboost 1.0.0 → 1.8.0

data/docs/PostsApi.md

@@ -10,18 +10,20 @@ All URIs are relative to *https://postboost.co/app/api*
 | [**delete_post**](PostsApi.md#delete_post) | **DELETE** /{workspaceUuid}/posts/{postUuid} | Delete post |
 | [**delete_posts_bulk**](PostsApi.md#delete_posts_bulk) | **DELETE** /{workspaceUuid}/posts | Delete posts (bulk) |
 | [**get_post**](PostsApi.md#get_post) | **GET** /{workspaceUuid}/posts/{postUuid} | Get post |
+| [**get_post_analytics**](PostsApi.md#get_post_analytics) | **GET** /{workspaceUuid}/posts/{postUuid}/analytics | Get post analytics |
 | [**list_posts**](PostsApi.md#list_posts) | **GET** /{workspaceUuid}/posts | List posts |
+| [**retry_post_account**](PostsApi.md#retry_post_account) | **POST** /{workspaceUuid}/posts/retry/{postUuid}/{accountUuid} | Retry publishing to one account |
 | [**schedule_post**](PostsApi.md#schedule_post) | **POST** /{workspaceUuid}/posts/schedule/{postUuid} | Schedule post |
 | [**update_post**](PostsApi.md#update_post) | **PUT** /{workspaceUuid}/posts/{postUuid} | Update post |
 
 
 ## add_post_to_queue
 
-> <ScheduleResult> add_post_to_queue(workspace_uuid, post_uuid)
+> <ScheduleResult> add_post_to_queue(workspace_uuid, post_uuid, opts)
 
 Add post to queue
 
-Add an existing post to the smart publishing queue.
+Add an existing post to the smart publishing queue. Each account of the post gets its own next free queue slot. Returns `422` when the post has no accounts, the posting schedule has no available times, or provider requirements are not met. 
 
 ### Examples
 
@@ -37,10 +39,13 @@ end
 api_instance = PostBoost::PostsApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
 post_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the post.
+opts = {
+  add_post_to_queue_request: PostBoost::AddPostToQueueRequest.new # AddPostToQueueRequest | 
+}
 
 begin
   # Add post to queue
-  result = api_instance.add_post_to_queue(workspace_uuid, post_uuid)
+  result = api_instance.add_post_to_queue(workspace_uuid, post_uuid, opts)
   p result
 rescue PostBoost::ApiError => e
   puts "Error when calling PostsApi->add_post_to_queue: #{e}"
@@ -51,12 +56,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ScheduleResult>, Integer, Hash)> add_post_to_queue_with_http_info(workspace_uuid, post_uuid)
+> <Array(<ScheduleResult>, Integer, Hash)> add_post_to_queue_with_http_info(workspace_uuid, post_uuid, opts)
 
 ```ruby
 begin
   # Add post to queue
-  data, status_code, headers = api_instance.add_post_to_queue_with_http_info(workspace_uuid, post_uuid)
+  data, status_code, headers = api_instance.add_post_to_queue_with_http_info(workspace_uuid, post_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ScheduleResult>
@@ -71,6 +76,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** | UUID of the workspace. |  |
 | **post_uuid** | **String** | UUID of the post. |  |
+| **add_post_to_queue_request** | [**AddPostToQueueRequest**](AddPostToQueueRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -82,17 +88,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
 ## approve_post
 
-> <ScheduleResult> approve_post(workspace_uuid, post_uuid)
+> <ScheduleResult> approve_post(workspace_uuid, post_uuid, opts)
 
 Approve post
 
-Approve a post that is pending review.
+Approve a post that is pending review. The approver may move the post with `date`/`time` (read in `timezone`) and set per-account times with `accounts_schedule`; without them the post keeps the time it was submitted with. Provider requirements are validated and reported as `422`. 
 
 ### Examples
 
@@ -108,10 +114,13 @@ end
 api_instance = PostBoost::PostsApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
 post_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the post.
+opts = {
+  approve_post_request: PostBoost::ApprovePostRequest.new # ApprovePostRequest | 
+}
 
 begin
   # Approve post
-  result = api_instance.approve_post(workspace_uuid, post_uuid)
+  result = api_instance.approve_post(workspace_uuid, post_uuid, opts)
   p result
 rescue PostBoost::ApiError => e
   puts "Error when calling PostsApi->approve_post: #{e}"
@@ -122,12 +131,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ScheduleResult>, Integer, Hash)> approve_post_with_http_info(workspace_uuid, post_uuid)
+> <Array(<ScheduleResult>, Integer, Hash)> approve_post_with_http_info(workspace_uuid, post_uuid, opts)
 
 ```ruby
 begin
   # Approve post
-  data, status_code, headers = api_instance.approve_post_with_http_info(workspace_uuid, post_uuid)
+  data, status_code, headers = api_instance.approve_post_with_http_info(workspace_uuid, post_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ScheduleResult>
@@ -142,6 +151,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** | UUID of the workspace. |  |
 | **post_uuid** | **String** | UUID of the post. |  |
+| **approve_post_request** | [**ApprovePostRequest**](ApprovePostRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -153,7 +163,7 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -163,7 +173,7 @@ end
 
 Create post
 
-Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue. 
+Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue (each account gets its own queue slot).  `date`, `time` and `accounts_schedule` are read in `timezone` when given, otherwise in the workspace timezone. Use `accounts_schedule` to give individual accounts their own departure time.  Post bodies may reference mentions with `{{mention:<reference>}}` (see the Mentions endpoints). When the post is scheduled, provider requirements (for example a network that requires media) are validated up front and reported as `422`. 
 
 ### Examples
 
@@ -234,6 +244,8 @@ end
 
 Delete post
 
+Deletes a post. Use `delete_mode` to control whether to also remove the published content from social platforms.
+
 ### Examples
 
 ```ruby
@@ -378,6 +390,8 @@ end
 
 Get post
 
+Returns a single post with all its versions and associated accounts.
+
 ### Examples
 
 ```ruby
@@ -441,6 +455,77 @@ end
 - **Accept**: application/json
 
 
+## get_post_analytics
+
+> <PostAnalytics> get_post_analytics(workspace_uuid, post_uuid)
+
+Get post analytics
+
+Engagement metrics for a published post across its accounts (also works for trashed posts), with totals, trends and the best-performing account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::PostsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+post_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the post.
+
+begin
+  # Get post analytics
+  result = api_instance.get_post_analytics(workspace_uuid, post_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling PostsApi->get_post_analytics: #{e}"
+end
+```
+
+#### Using the get_post_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostAnalytics>, Integer, Hash)> get_post_analytics_with_http_info(workspace_uuid, post_uuid)
+
+```ruby
+begin
+  # Get post analytics
+  data, status_code, headers = api_instance.get_post_analytics_with_http_info(workspace_uuid, post_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostAnalytics>
+rescue PostBoost::ApiError => e
+  puts "Error when calling PostsApi->get_post_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **post_uuid** | **String** | UUID of the post. |  |
+
+### Return type
+
+[**PostAnalytics**](PostAnalytics.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_posts
 
 > <ListPosts200Response> list_posts(workspace_uuid, opts)
@@ -514,13 +599,86 @@ end
 - **Accept**: application/json
 
 
+## retry_post_account
+
+> <RetryPostAccountResult> retry_post_account(workspace_uuid, post_uuid, account_uuid)
+
+Retry publishing to one account
+
+Re-publishes a post to a single account whose publishing failed. Returns `422` when the account is not on the post, the post is still publishing, or the account did not fail.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::PostsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+post_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the post.
+account_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the social media account.
+
+begin
+  # Retry publishing to one account
+  result = api_instance.retry_post_account(workspace_uuid, post_uuid, account_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling PostsApi->retry_post_account: #{e}"
+end
+```
+
+#### Using the retry_post_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RetryPostAccountResult>, Integer, Hash)> retry_post_account_with_http_info(workspace_uuid, post_uuid, account_uuid)
+
+```ruby
+begin
+  # Retry publishing to one account
+  data, status_code, headers = api_instance.retry_post_account_with_http_info(workspace_uuid, post_uuid, account_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RetryPostAccountResult>
+rescue PostBoost::ApiError => e
+  puts "Error when calling PostsApi->retry_post_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **post_uuid** | **String** | UUID of the post. |  |
+| **account_uuid** | **String** | UUID of the social media account. |  |
+
+### Return type
+
+[**RetryPostAccountResult**](RetryPostAccountResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## schedule_post
 
 > <ScheduleResult> schedule_post(workspace_uuid, post_uuid, schedule_post_request)
 
 Schedule post
 
-Schedule an existing post. Set `postNow: true` to publish immediately.
+Schedule an existing post. Optionally move it with `date`/`time` (read in `timezone`) and give accounts their own times with `accounts_schedule`. Set `postNow: true` to publish immediately; publishing starts within the request and any per-account times are dropped. Provider requirements are validated and reported as `422`. 
 
 ### Examples
 
@@ -593,6 +751,8 @@ end
 
 Update post
 
+Replaces a post's versions, accounts, tags, and scheduling options. The post must not be in a published state. `timezone` is honoured: `date`, `time` and `accounts_schedule` are read in it. When the post stays scheduled, provider requirements are validated and reported as `422`. 
+
 ### Examples
 
 ```ruby

data/docs/PublicWorkspace.md

@@ -0,0 +1,24 @@
+# PostBoost::PublicWorkspace
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **pivot** | [**PublicWorkspacePivot**](PublicWorkspacePivot.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PublicWorkspace.new(
+  id: null,
+  uuid: null,
+  name: Acme Marketing,
+  pivot: null
+)
+```
+

data/docs/PublicWorkspacePivot.md

@@ -0,0 +1,22 @@
+# PostBoost::PublicWorkspacePivot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | **String** |  | [optional] |
+| **can_approve** | **Boolean** |  | [optional] |
+| **joined_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PublicWorkspacePivot.new(
+  role: null,
+  can_approve: null,
+  joined_at: 2026-05-01 09:30:00
+)
+```
+

data/docs/PublishProgress.md

@@ -0,0 +1,22 @@
+# PostBoost::PublishProgress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Number of accounts the post goes to. |  |
+| **published** | **Integer** |  |  |
+| **failed** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PublishProgress.new(
+  total: null,
+  published: null,
+  failed: null
+)
+```
+

data/docs/Receipt.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **uuid** | **String** |  | [optional] |
-| **transaction_id** | **String** |  | [optional] |
-| **invoice_number** | **String** |  | [optional] |
-| **amount** | **Float** |  | [optional] |
-| **tax** | **Float** |  | [optional] |
-| **currency** | **String** |  | [optional] |
+| **uuid** | **String** |  |  |
+| **transaction_id** | **String** |  |  |
+| **invoice_number** | **String** |  |  |
+| **amount** | **Float** |  |  |
+| **tax** | **Float** |  |  |
+| **currency** | **String** |  |  |
 | **receipt_url** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
-| **paid_at** | **Time** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
+| **paid_at** | **Time** |  |  |
+| **created_at** | **Time** |  |  |
 
 ## Example
 

data/docs/ReceiptsApi.md

@@ -18,6 +18,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Create receipt
 
+Creates a billing receipt record for a workspace. Admin only.
+
 ### Examples
 
 ```ruby
@@ -85,6 +87,8 @@ end
 
 Delete receipt
 
+Permanently deletes a single receipt. Admin only.
+
 ### Examples
 
 ```ruby
@@ -152,6 +156,8 @@ end
 
 Delete receipts (bulk)
 
+Permanently deletes one or more receipt records. Admin only.
+
 ### Examples
 
 ```ruby
@@ -219,6 +225,8 @@ end
 
 Get receipt
 
+Returns a single receipt by UUID. Admin only.
+
 ### Examples
 
 ```ruby
@@ -286,6 +294,8 @@ end
 
 List receipts
 
+Returns a paginated list of billing receipts. Filter by workspace UUID or invoice number. Admin only.
+
 ### Examples
 
 ```ruby
@@ -300,7 +310,8 @@ end
 api_instance = PostBoost::ReceiptsApi.new
 opts = {
   workspace_uuid: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
-  invoice_number: 'invoice_number_example' # String | 
+  invoice_number: 'invoice_number_example', # String | 
+  page: 56 # Integer | Page number (15 items per page).
 }
 
 begin
@@ -336,6 +347,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** |  | [optional] |
 | **invoice_number** | **String** |  | [optional] |
+| **page** | **Integer** | Page number (15 items per page). | [optional][default to 1] |
 
 ### Return type
 
@@ -357,6 +369,8 @@ end
 
 Update receipt
 
+Updates a receipt's transaction details, amount, or payment date. Admin only.
+
 ### Examples
 
 ```ruby

data/docs/RemoveGenericSubscription422Response.md

@@ -0,0 +1,18 @@
+# PostBoost::RemoveGenericSubscription422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::RemoveGenericSubscription422Response.new(
+  message: The workspace has no generic subscription.
+)
+```
+

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/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] |