postboost 1.0.0 → 1.8.0

data/docs/MentionIdentityInput.md

@@ -0,0 +1,26 @@
+# PostBoost::MentionIdentityInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | Mention provider key. One identity per provider. |  |
+| **handle** | **String** | Profile handle; a leading `@` is stripped. |  |
+| **label** | **String** |  | [optional] |
+| **token** | **String** | Sealed lookup result that names the profile's network ID. | [optional] |
+| **account_uuid** | **String** | A connected account of this workspace that names the profile. Wins over `token` when both are sent. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MentionIdentityInput.new(
+  provider: null,
+  handle: null,
+  label: null,
+  token: null,
+  account_uuid: null
+)
+```
+

data/docs/MentionInput.md

@@ -0,0 +1,22 @@
+# PostBoost::MentionInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **avatar** | **String** |  | [optional] |
+| **identities** | [**Array<MentionIdentityInput>**](MentionIdentityInput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MentionInput.new(
+  name: null,
+  avatar: null,
+  identities: null
+)
+```
+

data/docs/MentionsApi.md

@@ -0,0 +1,375 @@
+# PostBoost::MentionsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_mention**](MentionsApi.md#create_mention) | **POST** /{workspaceUuid}/mentions | Create mention |
+| [**delete_mention**](MentionsApi.md#delete_mention) | **DELETE** /{workspaceUuid}/mentions/{mentionId} | Delete mention |
+| [**get_mention**](MentionsApi.md#get_mention) | **GET** /{workspaceUuid}/mentions/{mentionId} | Get mention |
+| [**list_mentions**](MentionsApi.md#list_mentions) | **GET** /{workspaceUuid}/mentions | List mentions |
+| [**update_mention**](MentionsApi.md#update_mention) | **PUT** /{workspaceUuid}/mentions/{mentionId} | Update mention |
+
+
+## create_mention
+
+> <CreateMention201Response> create_mention(workspace_uuid, mention_input)
+
+Create mention
+
+Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`). 
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_input = PostBoost::MentionInput.new({name: 'name_example'}) # MentionInput | 
+
+begin
+  # Create mention
+  result = api_instance.create_mention(workspace_uuid, mention_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->create_mention: #{e}"
+end
+```
+
+#### Using the create_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> create_mention_with_http_info(workspace_uuid, mention_input)
+
+```ruby
+begin
+  # Create mention
+  data, status_code, headers = api_instance.create_mention_with_http_info(workspace_uuid, mention_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->create_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_input** | [**MentionInput**](MentionInput.md) |  |  |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_mention
+
+> Object delete_mention(workspace_uuid, mention_id)
+
+Delete mention
+
+Removes a mention from the mention book. `success` is false when nothing was deleted.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+
+begin
+  # Delete mention
+  result = api_instance.delete_mention(workspace_uuid, mention_id)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->delete_mention: #{e}"
+end
+```
+
+#### Using the delete_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_mention_with_http_info(workspace_uuid, mention_id)
+
+```ruby
+begin
+  # Delete mention
+  data, status_code, headers = api_instance.delete_mention_with_http_info(workspace_uuid, mention_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->delete_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_mention
+
+> <CreateMention201Response> get_mention(workspace_uuid, mention_id)
+
+Get mention
+
+Returns a single mention with its identities.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+
+begin
+  # Get mention
+  result = api_instance.get_mention(workspace_uuid, mention_id)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->get_mention: #{e}"
+end
+```
+
+#### Using the get_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> get_mention_with_http_info(workspace_uuid, mention_id)
+
+```ruby
+begin
+  # Get mention
+  data, status_code, headers = api_instance.get_mention_with_http_info(workspace_uuid, mention_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->get_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_mentions
+
+> <ListMentions200Response> list_mentions(workspace_uuid, opts)
+
+List mentions
+
+Returns a paginated list of the workspace's mention book, ranked, with each entry's network identities.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  q: 'q_example', # String | Search keyword.
+  per_page: 56, # Integer | 
+  page: 56 # Integer | 
+}
+
+begin
+  # List mentions
+  result = api_instance.list_mentions(workspace_uuid, opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->list_mentions: #{e}"
+end
+```
+
+#### Using the list_mentions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListMentions200Response>, Integer, Hash)> list_mentions_with_http_info(workspace_uuid, opts)
+
+```ruby
+begin
+  # List mentions
+  data, status_code, headers = api_instance.list_mentions_with_http_info(workspace_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListMentions200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->list_mentions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **q** | **String** | Search keyword. | [optional] |
+| **per_page** | **Integer** |  | [optional][default to 25] |
+| **page** | **Integer** |  | [optional][default to 1] |
+
+### Return type
+
+[**ListMentions200Response**](ListMentions200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_mention
+
+> <CreateMention201Response> update_mention(workspace_uuid, mention_id, mention_input)
+
+Update mention
+
+Replaces the mention's name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns `422`.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+mention_input = PostBoost::MentionInput.new({name: 'name_example'}) # MentionInput | 
+
+begin
+  # Update mention
+  result = api_instance.update_mention(workspace_uuid, mention_id, mention_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->update_mention: #{e}"
+end
+```
+
+#### Using the update_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> update_mention_with_http_info(workspace_uuid, mention_id, mention_input)
+
+```ruby
+begin
+  # Update mention
+  data, status_code, headers = api_instance.update_mention_with_http_info(workspace_uuid, mention_id, mention_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->update_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+| **mention_input** | [**MentionInput**](MentionInput.md) |  |  |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Post.md

@@ -4,16 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **uuid** | **String** |  | [optional] |
-| **status** | [**PostStatus**](PostStatus.md) |  | [optional] |
-| **accounts** | [**Array<Account>**](Account.md) |  | [optional] |
-| **versions** | [**Array<PostVersion>**](PostVersion.md) |  | [optional] |
-| **tags** | [**Array<Tag>**](Tag.md) |  | [optional] |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **status** | [**PostStatus**](PostStatus.md) |  |  |
+| **publish_progress** | [**PublishProgress**](PublishProgress.md) | Only present while the post is publishing. | [optional] |
+| **accounts** | [**Array<Account>**](Account.md) |  |  |
+| **versions** | [**Array<PostVersion>**](PostVersion.md) |  |  |
+| **tags** | [**Array<Tag>**](Tag.md) |  |  |
 | **scheduled_at** | **Time** |  | [optional] |
 | **published_at** | **Time** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
-| **trashed** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **trashed** | **Boolean** |  |  |
 
 ## Example
 
@@ -24,6 +25,7 @@ instance = PostBoost::Post.new(
   id: null,
   uuid: null,
   status: null,
+  publish_progress: null,
   accounts: null,
   versions: null,
   tags: null,

data/docs/PostAnalytics.md

@@ -0,0 +1,22 @@
+# PostBoost::PostAnalytics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **summary** | **Hash<String, Object>** | Totals (views, likes, comments, shares), trends, engagement rate, breakdown, funnel and peak day across the post's accounts. Empty when nothing is published yet. |  |
+| **winner** | **Object** |  | [optional] |
+| **accounts** | **Array<Hash<String, Object>>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostAnalytics.new(
+  summary: null,
+  winner: null,
+  accounts: null
+)
+```
+

data/docs/PostInput.md

@@ -9,7 +9,8 @@
 | **tags** | **Array<Integer>** | Tag IDs to attach. | [optional] |
 | **date** | **Date** |  | [optional] |
 | **time** | **String** |  | [optional] |
-| **timezone** | **String** |  | [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 on update, accounts keep their offsets from the post time. | [optional] |
 | **schedule** | **Boolean** | Schedule the post for the given date/time. | [optional] |
 | **schedule_now** | **Boolean** | Publish immediately. | [optional] |
 | **queue** | **Boolean** | Add to the smart publishing queue. | [optional] |
@@ -26,6 +27,7 @@ instance = PostBoost::PostInput.new(
   date: 2025-06-01,
   time: 10:00,
   timezone: America/New_York,
+  accounts_schedule: null,
   schedule: null,
   schedule_now: null,
   queue: null

data/docs/PostVersion.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **account_id** | **Integer** | Use `0` for the original/default version. |  |
 | **is_original** | **Boolean** | Must be `true` for the first version. |  |
+| **synced_with** | **Integer** | Account ID of the version this version follows (`0` = the original), or null when it is edited independently. Ignored on the original version. | [optional] |
 | **content** | [**Array<PostContent>**](PostContent.md) |  |  |
 | **options** | **Object** | Platform-specific publishing options. | [optional] |
 
@@ -17,6 +18,7 @@ require 'postboost'
 instance = PostBoost::PostVersion.new(
   account_id: null,
   is_original: null,
+  synced_with: null,
   content: null,
   options: null
 )

data/docs/PostingTimeSlot.md

@@ -0,0 +1,22 @@
+# PostBoost::PostingTimeSlot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Integer** |  |  |
+| **samples** | **Integer** |  |  |
+| **confidence** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostingTimeSlot.new(
+  score: null,
+  samples: null,
+  confidence: null
+)
+```
+

data/docs/PostingTimes.md

@@ -0,0 +1,32 @@
+# PostBoost::PostingTimes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_data** | **Boolean** |  |  |
+| **timezone** | **String** |  |  |
+| **offset_hours** | **Integer** |  |  |
+| **accounts** | **Integer** | Accounts that contributed scores. |  |
+| **samples** | **Integer** |  |  |
+| **days** | [**Array<PostingTimesDaysInner>**](PostingTimesDaysInner.md) | One entry per weekday (`day` 0 = Sunday). |  |
+| **day_intervals** | **Array<Array<PostingTimesDayIntervalsInnerInner>>** | Per weekday, 2-hour intervals. |  |
+| **best** | [**Array<PostingTimesBestInner>**](PostingTimesBestInner.md) | Up to three recommended slots, at most one per weekday. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostingTimes.new(
+  has_data: null,
+  timezone: Europe/Istanbul,
+  offset_hours: null,
+  accounts: null,
+  samples: null,
+  days: null,
+  day_intervals: null,
+  best: null
+)
+```
+

data/docs/PostingTimesBestInner.md

@@ -0,0 +1,24 @@
+# PostBoost::PostingTimesBestInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **day** | **Integer** |  |  |
+| **hour** | **Integer** |  |  |
+| **score** | **Integer** |  |  |
+| **samples** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostingTimesBestInner.new(
+  day: null,
+  hour: null,
+  score: null,
+  samples: null
+)
+```
+

data/docs/PostingTimesDayIntervalsInnerInner.md

@@ -0,0 +1,28 @@
+# PostBoost::PostingTimesDayIntervalsInnerInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Integer** |  |  |
+| **samples** | **Integer** |  |  |
+| **confidence** | **String** |  |  |
+| **start_hour** | **Integer** |  |  |
+| **end_hour** | **Integer** |  |  |
+| **best_hour** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostingTimesDayIntervalsInnerInner.new(
+  score: null,
+  samples: null,
+  confidence: null,
+  start_hour: null,
+  end_hour: null,
+  best_hour: null
+)
+```
+

data/docs/PostingTimesDaysInner.md

@@ -0,0 +1,24 @@
+# PostBoost::PostingTimesDaysInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Integer** |  |  |
+| **samples** | **Integer** |  |  |
+| **confidence** | **String** |  |  |
+| **day** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostingTimesDaysInner.new(
+  score: null,
+  samples: null,
+  confidence: null,
+  day: null
+)
+```
+