RubyGems - postboost - Versions diffs - 1.45.0 → 1.49.0 - Mend

postboost 1.45.0 → 1.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (792) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae71bec81cbbf9e54be21792870376d677426fc24491c3ce6f553b752fcc038
-  data.tar.gz: 07a212103c642ba48456a076cc8230105931707463a57555df52eb219afdbe97
+  metadata.gz: 307e6c2de79b61ce640802709a099a9ed63d538e9c3e9d55ab50940cee0454ca
+  data.tar.gz: 61ca1a396705c01e72dde3bb75bb197869c9ea56f79155c5b7771de06c7d6227
 SHA512:
-  metadata.gz: a16fc850d07ba80429608616684b45143e7e66a240170a141eb5c7dec86e8d66131303ff7f50030e2393782efab9ea22293a9b196f75605b1dca9b2635b5cd43
-  data.tar.gz: 9ffd26768eda0e535adefabd09d71e43b0fa53e823dad622e74971b8e809be610ab9c27d20e2d2b78d782046b0f03b7019225401deb51c8de985d28376815860
+  metadata.gz: 0c0e9c214a9d08feb0d1af9d8860088cfabc6f1576d574efe597f21e298f4aadffc51634889e3198d3b2734a5d4dbc1be21230d7231973baee7a65ac3d426513
+  data.tar.gz: 31ee23090dceb578adb7a710b02067afc586853352f00063f8ba24b5cc43cb3c67641483f71dda644b7eef1c02ec316df4abf9730c2a1d59816cc6e30497831c

data/README.md CHANGED Viewed

@@ -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.45.0 |
+| **Version** | v1.49.0 |
 ## Quick start
@@ -23,8 +23,8 @@ require 'postboost'
 PostBoost.configure { |c| c.access_token = ENV['POSTBOOST_API_TOKEN'] }
 api = PostBoost::PostsApi.new
-posts = api.list_posts('YOUR_WORKSPACE_UUID')
-posts.each { |p| puts p.uuid }
+resp = api.list_posts('YOUR_WORKSPACE_UUID')
+(resp.data || []).each { |p| puts p.uuid }
 ```
 ---
@@ -90,8 +90,11 @@ Class | Method | HTTP request | Description
 *PostBoost::FreeToolsApi* | [**calculate_aspect_ratio**](docs/FreeToolsApi.md#calculate_aspect_ratio) | **POST** /tools/aspect-ratio-calculator | Calculate an aspect ratio, or the missing side of an image at a given ratio
 *PostBoost::FreeToolsApi* | [**calculate_crop**](docs/FreeToolsApi.md#calculate_crop) | **POST** /tools/social-media-image-sizes/crop | Calculate the crop box that fits an image to a social media size
 *PostBoost::FreeToolsApi* | [**calculate_engagement_rate**](docs/FreeToolsApi.md#calculate_engagement_rate) | **POST** /tools/engagement-rate-calculator | Calculate an engagement rate
+*PostBoost::FreeToolsApi* | [**calculate_social_roi**](docs/FreeToolsApi.md#calculate_social_roi) | **POST** /tools/social-media-roi-calculator | Calculate social media ROI
+*PostBoost::FreeToolsApi* | [**calculate_x_api_cost**](docs/FreeToolsApi.md#calculate_x_api_cost) | **POST** /tools/x-api-cost-calculator | Calculate the monthly X API cost
 *PostBoost::FreeToolsApi* | [**check_link_preview**](docs/FreeToolsApi.md#check_link_preview) | **POST** /tools/link-preview-checker | Check how a link previews on X, LinkedIn, Facebook and chat apps (Open Graph and Twitter card tags)
 *PostBoost::FreeToolsApi* | [**check_post**](docs/FreeToolsApi.md#check_post) | **POST** /tools/social-media-post-checker | Check a post against each network's publishing rules
+*PostBoost::FreeToolsApi* | [**check_readability**](docs/FreeToolsApi.md#check_readability) | **POST** /tools/post-readability-checker | Check the readability of a post: Flesch scores, long sentences and passive hints
 *PostBoost::FreeToolsApi* | [**check_youtube_thumbnail**](docs/FreeToolsApi.md#check_youtube_thumbnail) | **POST** /tools/youtube-thumbnail-size-checker | Check a YouTube thumbnail's ratio, width, file size and format against YouTube's requirements
 *PostBoost::FreeToolsApi* | [**clean_text**](docs/FreeToolsApi.md#clean_text) | **POST** /tools/ai-text-cleaner | Clean AI-written text: dashes, quotes, invisible characters, markdown
 *PostBoost::FreeToolsApi* | [**count_characters**](docs/FreeToolsApi.md#count_characters) | **POST** /tools/social-media-character-counter | Count characters as each network counts them
@@ -110,6 +113,7 @@ Class | Method | HTTP request | Description
 *PostBoost::FreeToolsApi* | [**list_free_tools**](docs/FreeToolsApi.md#list_free_tools) | **GET** /tools | List the free tools
 *PostBoost::FreeToolsApi* | [**plan_content_calendar**](docs/FreeToolsApi.md#plan_content_calendar) | **POST** /tools/social-media-content-calendar-generator | Plan a social media content calendar and get it as CSV and ICS
 *PostBoost::FreeToolsApi* | [**preview_post**](docs/FreeToolsApi.md#preview_post) | **POST** /tools/social-media-post-preview | Preview where a post folds and when its image is cropped on Instagram, X, LinkedIn and Facebook
+*PostBoost::FreeToolsApi* | [**search_emoji**](docs/FreeToolsApi.md#search_emoji) | **POST** /tools/social-media-emoji-picker | Search emoji by name or keyword, to copy and paste into a post
 *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

data/docs/FreeToolCalculateSocialRoiRequest.md ADDED Viewed

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolCalculateSocialRoiRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revenue** | **Float** | Revenue attributed to social media in the period, in USD. |  |
+| **costs** | [**FreeToolCalculateSocialRoiRequestCosts**](FreeToolCalculateSocialRoiRequestCosts.md) |  | [optional] |
+| **period** | **String** | Optional label for the period, e.g. \&quot;Q3 2026\&quot;. | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateSocialRoiRequest.new(
+  revenue: null,
+  costs: null,
+  period: null
+)
+```

data/docs/FreeToolCalculateSocialRoiRequestCosts.md ADDED Viewed

@@ -0,0 +1,28 @@
+# PostBoost::FreeToolCalculateSocialRoiRequestCosts
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_spend** | **Float** | Paid social ad spend. | [optional][default to 0] |
+| **tools** | **Float** | Tools and software subscriptions. | [optional][default to 0] |
+| **labor_hours** | **Float** | Hours spent on social media. | [optional][default to 0] |
+| **hourly_rate** | **Float** | Cost of one hour of that work. | [optional][default to 0] |
+| **content** | **Float** | Content production: design, video, photography, freelancers. | [optional][default to 0] |
+| **other** | **Float** | Anything else. | [optional][default to 0] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateSocialRoiRequestCosts.new(
+  ad_spend: null,
+  tools: null,
+  labor_hours: null,
+  hourly_rate: null,
+  content: null,
+  other: null
+)
+```

data/docs/FreeToolCalculateSocialRoiResponse.md ADDED Viewed

@@ -0,0 +1,32 @@
+# PostBoost::FreeToolCalculateSocialRoiResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period** | **String** |  | [optional] |
+| **revenue** | **Float** |  | [optional] |
+| **total_cost** | **Float** | Sum of every cost, labor &#x3D; hours × hourly rate. 2 decimals. | [optional] |
+| **net_return** | **Float** | Revenue minus total cost. 2 decimals. | [optional] |
+| **roi_percent** | **Float** | (revenue − total cost) ÷ total cost × 100, 1 decimal; null when the total cost is 0. | [optional] |
+| **cost_breakdown** | [**Array&lt;FreeToolCalculateSocialRoiResponseCostBreakdownInner&gt;**](FreeToolCalculateSocialRoiResponseCostBreakdownInner.md) | Every cost above 0, with its share of the total cost (percent, 1 decimal). | [optional] |
+| **warnings** | **Array&lt;String&gt;** |  | [optional] |
+| **formula** | **String** |  | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateSocialRoiResponse.new(
+  period: null,
+  revenue: null,
+  total_cost: null,
+  net_return: null,
+  roi_percent: null,
+  cost_breakdown: null,
+  warnings: null,
+  formula: null
+)
+```

data/docs/FreeToolCalculateSocialRoiResponseCostBreakdownInner.md ADDED Viewed

@@ -0,0 +1,24 @@
+# PostBoost::FreeToolCalculateSocialRoiResponseCostBreakdownInner
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **amount** | **Float** |  | [optional] |
+| **share_percent** | **Float** |  | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateSocialRoiResponseCostBreakdownInner.new(
+  key: null,
+  label: null,
+  amount: null,
+  share_percent: null
+)
+```

data/docs/FreeToolCalculateXApiCostRequest.md ADDED Viewed

@@ -0,0 +1,28 @@
+# PostBoost::FreeToolCalculateXApiCostRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **posts** | **Integer** | Posts created per month, with or without a link. | [optional][default to 0] |
+| **link_share** | **Integer** | Percent of those posts that contain a URL (billed at the link-post price). | [optional][default to 0] |
+| **replies** | **Integer** | Summoned replies per month. | [optional][default to 0] |
+| **post_reads** | **Integer** | Posts read per month. | [optional][default to 0] |
+| **user_reads** | **Integer** | Users read per month. | [optional][default to 0] |
+| **owned_reads** | **Integer** | Owned resources read per month (your own posts, followers and so on). | [optional][default to 0] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateXApiCostRequest.new(
+  posts: null,
+  link_share: null,
+  replies: null,
+  post_reads: null,
+  user_reads: null,
+  owned_reads: null
+)
+```

data/docs/FreeToolCalculateXApiCostResponse.md ADDED Viewed

@@ -0,0 +1,28 @@
+# PostBoost::FreeToolCalculateXApiCostResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line_items** | [**Array&lt;FreeToolCalculateXApiCostResponseLineItemsInner&gt;**](FreeToolCalculateXApiCostResponseLineItemsInner.md) | One row per billed resource: count × unit price. | [optional] |
+| **total_usd** | **Float** | Sum of every line item. | [optional] |
+| **link_premium_usd** | **Float** | What the link posts cost on top of the plain post price. | [optional] |
+| **notes** | **Array&lt;String&gt;** |  | [optional] |
+| **prices_last_verified** | **Date** | When the prices were last checked against the source. | [optional] |
+| **source** | **String** |  | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateXApiCostResponse.new(
+  line_items: null,
+  total_usd: null,
+  link_premium_usd: null,
+  notes: null,
+  prices_last_verified: null,
+  source: null
+)
+```

data/docs/FreeToolCalculateXApiCostResponseLineItemsInner.md ADDED Viewed

@@ -0,0 +1,26 @@
+# PostBoost::FreeToolCalculateXApiCostResponseLineItemsInner
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **unit_usd** | **Float** |  | [optional] |
+| **cost_usd** | **Float** |  | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCalculateXApiCostResponseLineItemsInner.new(
+  key: null,
+  label: null,
+  count: null,
+  unit_usd: null,
+  cost_usd: null
+)
+```

data/docs/FreeToolCheckReadabilityRequest.md ADDED Viewed

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolCheckReadabilityRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The post text. |  |
+| **language** | **String** | Language code. Only English (&#x60;en&#x60;) is scored; other languages return &#x60;supported: false&#x60; and no scores. | [optional][default to &#39;en&#39;] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCheckReadabilityRequest.new(
+  text: null,
+  language: null
+)
+```

data/docs/FreeToolCheckReadabilityResponse.md ADDED Viewed

@@ -0,0 +1,42 @@
+# PostBoost::FreeToolCheckReadabilityResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **supported** | **Boolean** | False for a language other than English: no scores, hints or suggestions. | [optional] |
+| **note** | **String** | Why the text was not scored, or null. | [optional] |
+| **flesch_reading_ease** | **Float** | Flesch reading ease, one decimal: higher is easier, 60-70 is plain English. Null when not scored. | [optional] |
+| **flesch_kincaid_grade** | **Float** | Flesch-Kincaid grade level, one decimal: the US school grade that can read the text. Null when not scored. | [optional] |
+| **sentences** | **Integer** | Sentences with at least one word. | [optional] |
+| **words** | **Integer** | Words, not counting hashtags, @mentions, links and emoji. | [optional] |
+| **syllables** | **Integer** | Syllables, by the heuristic described in the docs. | [optional] |
+| **avg_words_per_sentence** | **Float** | Words per sentence, one decimal. | [optional] |
+| **long_sentences** | [**Array&lt;FreeToolCheckReadabilityResponseLongSentencesInner&gt;**](FreeToolCheckReadabilityResponseLongSentencesInner.md) | Sentences of more than 25 words. | [optional] |
+| **passive_hints** | **Integer** | Possible passive phrases (\&quot;was written\&quot;, \&quot;is being reviewed\&quot;). A hint, not a grammar check. | [optional] |
+| **emoji_count** | **Integer** | Emoji (Extended_Pictographic characters). | [optional] |
+| **hashtag_count** | **Integer** | Hashtags. | [optional] |
+| **suggestions** | **Array&lt;String&gt;** | Plain fixes, e.g. which sentence to split. Empty when the text reads easily. | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCheckReadabilityResponse.new(
+  supported: null,
+  note: null,
+  flesch_reading_ease: null,
+  flesch_kincaid_grade: null,
+  sentences: null,
+  words: null,
+  syllables: null,
+  avg_words_per_sentence: null,
+  long_sentences: null,
+  passive_hints: null,
+  emoji_count: null,
+  hashtag_count: null,
+  suggestions: null
+)
+```

data/docs/FreeToolCheckReadabilityResponseLongSentencesInner.md ADDED Viewed

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolCheckReadabilityResponseLongSentencesInner
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | Sentence number, from 1. | [optional] |
+| **words** | **Integer** |  | [optional] |
+| **excerpt** | **String** | The first 8 words of the sentence. | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolCheckReadabilityResponseLongSentencesInner.new(
+  index: null,
+  words: null,
+  excerpt: null
+)
+```

data/docs/FreeToolSearchEmojiRequest.md ADDED Viewed

@@ -0,0 +1,22 @@
+# PostBoost::FreeToolSearchEmojiRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Words to look for in the emoji name and keywords, e.g. &#x60;fire&#x60; or &#x60;party&#x60;. Empty lists the category in Unicode order. | [optional][default to &#39;&#39;] |
+| **category** | **String** | Only emoji of this Unicode category. | [optional] |
+| **limit** | **Integer** |  | [optional][default to 30] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolSearchEmojiRequest.new(
+  query: null,
+  category: null,
+  limit: null
+)
+```

data/docs/FreeToolSearchEmojiResponse.md ADDED Viewed

@@ -0,0 +1,20 @@
+# PostBoost::FreeToolSearchEmojiResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array&lt;FreeToolSearchEmojiResponseResultsInner&gt;**](FreeToolSearchEmojiResponseResultsInner.md) |  | [optional] |
+| **total** | **Integer** | Matches before &#x60;limit&#x60;. | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolSearchEmojiResponse.new(
+  results: null,
+  total: null
+)
+```

data/docs/FreeToolSearchEmojiResponseResultsInner.md ADDED Viewed

@@ -0,0 +1,26 @@
+# PostBoost::FreeToolSearchEmojiResponseResultsInner
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emoji** | **String** |  | [optional] |
+| **name** | **String** | Unicode name (emoji-test.txt). | [optional] |
+| **keywords** | **Array&lt;String&gt;** | CLDR English keywords. | [optional] |
+| **category** | **String** |  | [optional] |
+| **unicode_version** | **String** | Emoji version the emoji was added in (emoji-test.txt, e.g. 0.6 &#x3D; Unicode 6.0, 15.1). | [optional] |
+## Example
+```ruby
+require 'postboost'
+instance = PostBoost::FreeToolSearchEmojiResponseResultsInner.new(
+  emoji: null,
+  name: null,
+  keywords: null,
+  category: null,
+  unicode_version: null
+)
+```