postboost 1.20.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 208a6a8fa03237bf1289cac73580fe4a14111aa5ce852f961b533f8cec9d8bc2
-  data.tar.gz: 35c8bff6411dfe4f12eaf30b89d6ec2b482a6cb3471a2ae9dcb1a6eab5681cc2
+  metadata.gz: 06f22949d873ed0c342b6aec07e70c5d4f8ffc125eef31abaf9f62db24871612
+  data.tar.gz: 963d2e856a3ec76fbd8603cd1e157716aaa99a59fd573d0ed5753a7462872c8e
 SHA512:
-  metadata.gz: 94b3cc29903cb96d0649716447d49ef3fba2963f5f9724d969294de960c6619c051cd8fb599ff5723706a32994ff302306b7c5683bde7cbe4d8c3259e86aeb6a
-  data.tar.gz: ce9b2a03b6a82e4c89d9a9ffc4d995664eba885add58b61a9ca0bcbbbfd5d400551b405753e0f97427f68ca858d26fa0d8affc86a217679b840d53486da767f9
+  metadata.gz: fea1e572bdf9193808d2a096caac0da1351eed54206c1db269de07e020e298751da9a0348f54077c21fd4ccd27d34f19d9def629a45ac041f3f5de24a5ea1519
+  data.tar.gz: 151de7b194fde4af8bcc3a15fd08553c823bd8466e419c9cb74c7bf446e5fccfb4b93efcc40928a9cb81f8a591c7e7d4970439af915628610f05c699695da7ee

data/README.md

@@ -13,7 +13,7 @@ gem install postboost
 | **RubyGems** | [rubygems.org/gems/postboost](https://rubygems.org/gems/postboost) |
 | **GitHub** | [postboost-co/postboost-ruby](https://github.com/postboost-co/postboost-ruby) |
 | **Docs** | [postboost.co/docs/api](https://postboost.co/docs/api) |
-| **Version** | v1.20.0 |
+| **Version** | v1.22.0 |
 
 ## Quick start
 
@@ -85,6 +85,13 @@ Class | Method | HTTP request | Description
 *PostBoost::CompetitorsApi* | [**delete_competitor**](docs/CompetitorsApi.md#delete_competitor) | **DELETE** /{workspaceUuid}/competitors/{competitorId} | Stop tracking a competitor
 *PostBoost::CompetitorsApi* | [**get_competitor**](docs/CompetitorsApi.md#get_competitor) | **GET** /{workspaceUuid}/competitors/{competitorId} | Get a competitor
 *PostBoost::CompetitorsApi* | [**list_competitors**](docs/CompetitorsApi.md#list_competitors) | **GET** /{workspaceUuid}/competitors | List competitors
+*PostBoost::FreeToolsApi* | [**build_utm_url**](docs/FreeToolsApi.md#build_utm_url) | **POST** /tools/utm-builder | Build a UTM-tagged campaign URL
+*PostBoost::FreeToolsApi* | [**calculate_engagement_rate**](docs/FreeToolsApi.md#calculate_engagement_rate) | **POST** /tools/engagement-rate-calculator | Calculate an engagement rate
+*PostBoost::FreeToolsApi* | [**count_characters**](docs/FreeToolsApi.md#count_characters) | **POST** /tools/social-media-character-counter | Count characters as each network counts them
+*PostBoost::FreeToolsApi* | [**format_linked_in_post**](docs/FreeToolsApi.md#format_linked_in_post) | **POST** /tools/linkedin-post-formatter | Format a LinkedIn post with bold, italic and lists
+*PostBoost::FreeToolsApi* | [**generate_fancy_text**](docs/FreeToolsApi.md#generate_fancy_text) | **POST** /tools/fancy-text-generator | Convert text to fancy Unicode styles
+*PostBoost::FreeToolsApi* | [**list_free_tools**](docs/FreeToolsApi.md#list_free_tools) | **GET** /tools | List the free tools
+*PostBoost::FreeToolsApi* | [**split_thread**](docs/FreeToolsApi.md#split_thread) | **POST** /tools/x-thread-maker | Split long text into a thread
 *PostBoost::HashtagGroupsApi* | [**create_hashtag_group**](docs/HashtagGroupsApi.md#create_hashtag_group) | **POST** /{workspaceUuid}/hashtag-groups | Create a hashtag group
 *PostBoost::HashtagGroupsApi* | [**delete_hashtag_group**](docs/HashtagGroupsApi.md#delete_hashtag_group) | **DELETE** /{workspaceUuid}/hashtag-groups/{hashtagGroupId} | Delete a hashtag group
 *PostBoost::HashtagGroupsApi* | [**get_hashtag_group**](docs/HashtagGroupsApi.md#get_hashtag_group) | **GET** /{workspaceUuid}/hashtag-groups/{hashtagGroupId} | Get a hashtag group

data/docs/AgentProposal.md

@@ -8,10 +8,10 @@
 | **run_uuid** | **String** |  | [optional] |
 | **post_uuid** | **String** |  | [optional] |
 | **account_id** | **Integer** |  | [optional] |
-| **kind** | **String** | `hold_post` moves the post back to draft; `edit_caption` replaces one caption. |  |
+| **kind** | **String** | `hold_post` moves the post back to draft; `edit_caption` replaces one caption; `retry_account` publishes one failed account again; `reconnect_account` asks to reconnect the account first.  |  |
 | **severity** | **String** |  |  |
 | **reason** | **String** |  |  |
-| **payload** | **Hash<String, Object>** | The proposed change. `hold_post`: `reasons[]` (`code`, `account_id`, `message`, `severity`) and `scheduled_at`. `edit_caption`: `version_account_id` (0 = original), `item_index`, `before`, `after`. Both carry `post_updated_at`.  |  |
+| **payload** | **Hash<String, Object>** | The proposed change. `hold_post`: `reasons[]` (`code`, `account_id`, `message`, `severity`) and `scheduled_at`. `edit_caption`: `version_account_id` (0 = original), `item_index`, `before`, `after`. `retry_account`: `error` (up to 300 characters) and, for a shortened caption, `source_account_id` (the version it was taken from, 0 = original), `item_index`, `before`, `after`. `reconnect_account`: `error`, `reconnect_url`. All carry `post_updated_at`.  |  |
 | **status** | **String** |  |  |
 | **decided_at** | **Time** |  | [optional] |
 | **applied_at** | **Time** |  | [optional] |

data/docs/AgentsApi.md

@@ -22,7 +22,7 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Approve and apply an agent proposal
 
-Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption. When the post was edited, deleted or left the schedule since the proposal was made, nothing changes and the proposal becomes `stale`. Admins and members only. 
+Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption, `retry_account` saves the shortened caption (if any) on that account's version and publishes that account again, `reconnect_account` only records the decision. When the post was edited, deleted or left the schedule since the proposal was made (for `retry_account`: the account is no longer failed, the post is publishing, or the plan does not allow scheduling), nothing changes and the proposal becomes `stale`. Admins and members only. 
 
 ### Examples
 
@@ -97,7 +97,7 @@ end
 
 Switch on a background agent
 
-Creates an agent (one per type per workspace). It first runs within five minutes, then on its `schedule`. **Pre-publish checker** looks at posts scheduled in the next `horizon_hours` and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop `banned_phrases`. With `ai_review: true` it also asks AI to review up to `max_ai_reviews_per_run` posts per run (one AI credit each). Admins and members only. 
+Creates an agent (one per type per workspace). It first runs within five minutes, then on its `schedule`. **Pre-publish checker** looks at posts scheduled in the next `horizon_hours` and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop `banned_phrases`. With `ai_review: true` it also asks AI to review up to `max_ai_reviews_per_run` posts per run (one AI credit each). **Failed-post fixer** looks at posts that failed on an account in the last `lookback_hours` and proposes, per post and account, `reconnect_account` (the account's token expired), or `retry_account`, with a caption trimmed to the network limit when the text is over it. One open proposal per post and account. It uses no AI. Admins and members only. 
 
 ### Examples
 
@@ -462,7 +462,7 @@ end
 
 List background agents
 
-Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available type: `pre_publish_checker`. 
+Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available types: `pre_publish_checker`, `failed_post_fixer`. 
 
 ### Examples
 

data/docs/FreeToolBuildUtmUrlRequest.md

@@ -0,0 +1,30 @@
+# PostBoost::FreeToolBuildUtmUrlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The http(s) page URL. |  |
+| **utm_source** | **String** |  | [optional] |
+| **utm_medium** | **String** |  | [optional] |
+| **utm_campaign** | **String** |  | [optional] |
+| **utm_term** | **String** |  | [optional] |
+| **utm_content** | **String** |  | [optional] |
+| **utm_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolBuildUtmUrlRequest.new(
+  url: null,
+  utm_source: null,
+  utm_medium: null,
+  utm_campaign: null,
+  utm_term: null,
+  utm_content: null,
+  utm_id: null
+)
+```
+

data/docs/FreeToolBuildUtmUrlResponse.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolBuildUtmUrlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+| **warnings** | **Array<String>** | Missing GA4 keys and values with capitals, spaces or mixed - and _. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolBuildUtmUrlResponse.new(
+  url: null,
+  warnings: null
+)
+```
+

data/docs/FreeToolCalculateEngagementRateRequest.md

@@ -0,0 +1,32 @@
+# PostBoost::FreeToolCalculateEngagementRateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **likes** | **Integer** |  | [optional][default to 0] |
+| **comments** | **Integer** |  | [optional][default to 0] |
+| **shares** | **Integer** |  | [optional][default to 0] |
+| **saves** | **Integer** |  | [optional][default to 0] |
+| **clicks** | **Integer** |  | [optional][default to 0] |
+| **method** | **String** | What to divide by. | [optional][default to 'followers'] |
+| **base** | **Integer** | Followers, or the total reach or impressions of the posts. |  |
+| **posts** | **Integer** | Number of posts the engagements come from. | [optional][default to 1] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolCalculateEngagementRateRequest.new(
+  likes: null,
+  comments: null,
+  shares: null,
+  saves: null,
+  clicks: null,
+  method: null,
+  base: null,
+  posts: null
+)
+```
+

data/docs/FreeToolCalculateEngagementRateResponse.md

@@ -0,0 +1,24 @@
+# PostBoost::FreeToolCalculateEngagementRateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **engagements** | **Integer** |  | [optional] |
+| **posts** | **Integer** |  | [optional] |
+| **rate** | **Float** | Percent, 2 decimals. | [optional] |
+| **formula** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolCalculateEngagementRateResponse.new(
+  engagements: null,
+  posts: null,
+  rate: null,
+  formula: null
+)
+```
+

data/docs/FreeToolCountCharactersRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolCountCharactersRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The post text, up to 10,000 characters (twice the longest network limit). | [optional][default to ''] |
+| **network** | **String** | Count for one network only; all networks when omitted. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolCountCharactersRequest.new(
+  text: null,
+  network: null
+)
+```
+

data/docs/FreeToolCountCharactersResponse.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolCountCharactersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hashtags** | **Integer** | Hashtags in the text (Instagram allows 5 per post in PostBoost). | [optional] |
+| **networks** | [**Array<FreeToolCountCharactersResponseNetworksInner>**](FreeToolCountCharactersResponseNetworksInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolCountCharactersResponse.new(
+  hashtags: null,
+  networks: null
+)
+```
+

data/docs/FreeToolCountCharactersResponseNetworksInner.md

@@ -0,0 +1,28 @@
+# PostBoost::FreeToolCountCharactersResponseNetworksInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **remaining** | **Integer** |  | [optional] |
+| **over** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolCountCharactersResponseNetworksInner.new(
+  key: null,
+  label: null,
+  limit: null,
+  count: null,
+  remaining: null,
+  over: null
+)
+```
+

data/docs/FreeToolError.md

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

data/docs/FreeToolFormatLinkedInPostRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolFormatLinkedInPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  |  |
+| **style** | **String** | Unicode style for the whole text, e.g. bold. | [optional] |
+| **list** | **String** | Prefix every non-empty line with \"• \" or \"1. \", \"2. \" (plain digits). | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolFormatLinkedInPostRequest.new(
+  text: null,
+  style: null,
+  list: null
+)
+```
+

data/docs/FreeToolFormatLinkedInPostResponse.md

@@ -0,0 +1,26 @@
+# PostBoost::FreeToolFormatLinkedInPostResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **preview** | **String** | What the feed shows before \"…see more\" (about 3 lines or 210 characters; varies by device). | [optional] |
+| **folded** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolFormatLinkedInPostResponse.new(
+  text: null,
+  count: null,
+  limit: null,
+  preview: null,
+  folded: null
+)
+```
+

data/docs/FreeToolGenerateFancyTextRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolGenerateFancyTextRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  |  |
+| **style** | **String** | One style only; every style when omitted. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolGenerateFancyTextRequest.new(
+  text: null,
+  style: null
+)
+```
+

data/docs/FreeToolGenerateFancyTextResponse.md

@@ -0,0 +1,18 @@
+# PostBoost::FreeToolGenerateFancyTextResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **styles** | [**Array<FreeToolGenerateFancyTextResponseStylesInner>**](FreeToolGenerateFancyTextResponseStylesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolGenerateFancyTextResponse.new(
+  styles: null
+)
+```
+

data/docs/FreeToolGenerateFancyTextResponseStylesInner.md

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolGenerateFancyTextResponseStylesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **text** | **String** | Characters with no styled form (accents, emoji) pass through unchanged. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolGenerateFancyTextResponseStylesInner.new(
+  key: null,
+  label: null,
+  text: null
+)
+```
+

data/docs/FreeToolList.md

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

data/docs/FreeToolListItem.md

@@ -0,0 +1,30 @@
+# PostBoost::FreeToolListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+| **name** | **String** |  |  |
+| **operation_id** | **String** |  |  |
+| **kind** | **String** |  |  |
+| **limits** | **String** | Limit profile: std, fetch or ai. |  |
+| **page_url** | **String** |  |  |
+| **docs_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolListItem.new(
+  slug: x-thread-maker,
+  name: null,
+  operation_id: splitThread,
+  kind: null,
+  limits: null,
+  page_url: null,
+  docs_url: null
+)
+```
+

data/docs/FreeToolSplitThreadRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolSplitThreadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The long text, up to 10,000 characters. A line with only --- forces a new post. | [optional][default to ''] |
+| **network** | **String** |  | [optional][default to 'x'] |
+| **numbering** | **Boolean** | End each post with \" k/n\". | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolSplitThreadRequest.new(
+  text: null,
+  network: null,
+  numbering: null
+)
+```
+

data/docs/FreeToolSplitThreadResponse.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolSplitThreadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **posts** | [**Array<FreeToolSplitThreadResponsePostsInner>**](FreeToolSplitThreadResponsePostsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolSplitThreadResponse.new(
+  limit: null,
+  posts: null
+)
+```
+

data/docs/FreeToolSplitThreadResponsePostsInner.md

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolSplitThreadResponsePostsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  | [optional] |
+| **count** | **Integer** | Length as the network counts it; a single word longer than the limit stays whole. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::FreeToolSplitThreadResponsePostsInner.new(
+  text: null,
+  count: null
+)
+```
+