postboost 1.0.0 → 1.8.0

data/docs/BlogToSocial429Response.md

@@ -0,0 +1,18 @@
+# PostBoost::BlogToSocial429Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::BlogToSocial429Response.new(
+  message: Insufficient AI credits. You need 3 credits but only have 1 remaining this month.
+)
+```
+

data/docs/BlogToSocialCaption.md

@@ -0,0 +1,28 @@
+# PostBoost::BlogToSocialCaption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** | ID of the social account this caption was generated for. | [optional] |
+| **provider** | **String** | Social media platform identifier. | [optional] |
+| **content** | **String** | The generated caption text. `null` if generation failed for this account. | [optional] |
+| **character_count** | **Integer** | Character count of the generated content. `null` if generation failed. | [optional] |
+| **character_limit** | **Integer** | Maximum allowed character count for this platform. | [optional] |
+| **error** | **String** | Error message if caption generation failed for this account. `null` on success. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::BlogToSocialCaption.new(
+  account_id: 5,
+  provider: x,
+  content: Unlock better social media results with these 10 proven tips. #SocialMedia #Marketing,
+  character_count: 87,
+  character_limit: 280,
+  error: null
+)
+```
+

data/docs/BlogToSocialInput.md

@@ -0,0 +1,42 @@
+# PostBoost::BlogToSocialInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Blog post URL to scrape. Required if `title` and `excerpt` are not provided. | [optional] |
+| **title** | **String** | Blog post title. Required if `url` is not provided. | [optional] |
+| **excerpt** | **String** | Blog post summary or excerpt. Required if `url` is not provided. | [optional] |
+| **image_url** | **String** | Featured image URL for the blog post. When `create_post` is `true`, the image is imported into the workspace media library and attached to the draft post. If omitted in URL mode, the scraper attempts to extract the `og:image` meta tag.  | [optional] |
+| **platforms** | **Array<String>** | Target social media platforms. Only connected accounts matching these platforms are used. If omitted, all connected accounts in the workspace are targeted.  | [optional] |
+| **account_ids** | **Array<Integer>** | Specific account IDs to generate captions for. Takes precedence over `platforms` when both are provided.  | [optional] |
+| **tone** | **String** | Writing tone for all generated captions. | [optional][default to 'engaging'] |
+| **content_length** | **String** | Desired length of the generated captions. | [optional][default to 'medium'] |
+| **hashtags** | **String** | Hashtag quantity: none (0), few (1-3), some (3-5), many (5+). | [optional][default to 'few'] |
+| **cta** | **String** | Call-to-action type appended to each caption. | [optional][default to 'none'] |
+| **language** | **String** | Output language as an ISO 639-1 code (e.g. `en`, `de`, `fr`). Use `auto` to match the blog post's language automatically.  | [optional][default to 'auto'] |
+| **custom_instructions** | **String** | Additional instructions appended to the AI prompt (e.g. \"always mention our free tier\"). | [optional] |
+| **create_post** | **Boolean** | When `true`, creates a draft post in the workspace with per-account caption versions. If an image is available, it is imported and attached to the post.  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::BlogToSocialInput.new(
+  url: https://example.com/blog/my-post,
+  title: 10 Tips for Better Social Media,
+  excerpt: Social media success starts with consistency and knowing your audience...,
+  image_url: https://example.com/images/post-cover.jpg,
+  platforms: [twitter, linkedin],
+  account_ids: [5, 12],
+  tone: professional,
+  content_length: medium,
+  hashtags: few,
+  cta: link,
+  language: auto,
+  custom_instructions: Always mention that PostBoost supports 12+ platforms.,
+  create_post: null
+)
+```
+

data/docs/BlogToSocialMedia.md

@@ -0,0 +1,20 @@
+# PostBoost::BlogToSocialMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Media library ID of the imported image. | [optional] |
+| **url** | **String** | Public URL of the imported image in the workspace media library. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::BlogToSocialMedia.new(
+  id: 42,
+  url: https://postboost.co/storage/workspaces/1/blog-images/2026/04/cover.jpg
+)
+```
+

data/docs/BlogToSocialResponse.md

@@ -0,0 +1,30 @@
+# PostBoost::BlogToSocialResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_title** | **String** | The blog post title (scraped or provided directly). | [optional] |
+| **blog_excerpt** | **String** | A short excerpt from the blog post content. | [optional] |
+| **captions** | [**Array<BlogToSocialCaption>**](BlogToSocialCaption.md) | Generated captions, one per target account. | [optional] |
+| **post_uuid** | **String** | UUID of the created draft post. Only present when `create_post` was `true`. | [optional] |
+| **media** | [**BlogToSocialMedia**](BlogToSocialMedia.md) |  | [optional] |
+| **credits_used** | **Integer** | Number of AI credits consumed by this request (one per successful caption). | [optional] |
+| **credits_remaining** | **Integer** | Remaining AI credits for the current billing period. `null` for unlimited plans. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::BlogToSocialResponse.new(
+  blog_title: 10 Tips for Better Social Media,
+  blog_excerpt: Social media success starts with consistency...,
+  captions: null,
+  post_uuid: 01942c3d-1234-7abc-8ef0-1234567890ab,
+  media: null,
+  credits_used: 3,
+  credits_remaining: 37
+)
+```
+

data/docs/CancelSubscription422Response.md

@@ -0,0 +1,20 @@
+# PostBoost::CancelSubscription422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **errors** | [**CancelSubscription422ResponseErrors**](CancelSubscription422ResponseErrors.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CancelSubscription422Response.new(
+  message: null,
+  errors: null
+)
+```
+

data/docs/CancelSubscription422ResponseErrors.md

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

data/docs/CancelSubscriptionRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::CancelSubscriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **immediately** | **Boolean** | Cancel now instead of at the end of the billing period. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CancelSubscriptionRequest.new(
+  immediately: null
+)
+```
+

data/docs/CompleteChunkedUploadRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::CompleteChunkedUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alt_text** | **String** |  | [optional] |
+| **folder** | **String** | UUID of the media folder to file the item in. Omit or null for the library root. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CompleteChunkedUploadRequest.new(
+  alt_text: null,
+  folder: null
+)
+```
+

data/docs/CreateMediaFolderRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::CreateMediaFolderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Folder name; must be unique among its siblings (case-insensitive). |  |
+| **parent** | **String** | UUID of the parent folder, or null for the top level. Folders nest to a limited depth. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CreateMediaFolderRequest.new(
+  name: null,
+  parent: null
+)
+```
+

data/docs/CreateMention201Response.md

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

data/docs/DeleteMediaBulkRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **items** | **Array<Integer>** | Array of media IDs to delete. |  |
+| **items** | [**Array<DeleteMediaBulkRequestItemsInner>**](DeleteMediaBulkRequestItemsInner.md) | Array of media IDs or UUIDs to delete. |  |
 
 ## Example
 

data/docs/DeleteMediaBulkRequestItemsInner.md

@@ -0,0 +1,49 @@
+# PostBoost::DeleteMediaBulkRequestItemsInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'postboost'
+
+PostBoost::DeleteMediaBulkRequestItemsInner.openapi_one_of
+# =>
+# [
+#   :'Integer',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'postboost'
+
+PostBoost::DeleteMediaBulkRequestItemsInner.build(data)
+# => #<Integer:0x00007fdd4aab02a0>
+
+PostBoost::DeleteMediaBulkRequestItemsInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Integer`
+- `String`
+- `nil` (if no type matches)
+

data/docs/DeleteMediaFolderRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::DeleteMediaFolderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delete_media** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteMediaFolderRequest.new(
+  delete_media: null
+)
+```
+

data/docs/DeleteResult.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **deleted** | **Boolean** |  | [optional] |
-| **deleted_from_app** | **Boolean** |  | [optional] |
-| **to_trash** | **Boolean** |  | [optional] |
+| **deleted** | **Boolean** |  |  |
+| **deleted_from_app** | **Boolean** |  |  |
+| **to_trash** | **Boolean** |  |  |
 
 ## Example
 

data/docs/ImageAltText200Response.md

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

data/docs/ImageAltTextInput.md

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

data/docs/ImageAltTextResponse.md

@@ -0,0 +1,24 @@
+# PostBoost::ImageAltTextResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_uuid** | **String** |  |  |
+| **alt_text** | **String** |  |  |
+| **credits_used** | **Integer** |  |  |
+| **credits_remaining** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImageAltTextResponse.new(
+  media_uuid: null,
+  alt_text: A developer working at a standing desk with dual monitors in a bright modern office,
+  credits_used: 1,
+  credits_remaining: 49
+)
+```
+

data/docs/ImageEditInput.md

@@ -0,0 +1,28 @@
+# PostBoost::ImageEditInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_uuid** | **String** | UUID of the source media item to edit |  |
+| **prompt** | **String** | Describe what to change in the image |  |
+| **mask_uuid** | **String** | UUID of a mask image. Transparent areas will be edited. | [optional] |
+| **aspect_ratio** | **String** |  | [optional][default to '1:1'] |
+| **count** | **Integer** |  | [optional][default to 1] |
+| **quality** | **String** |  | [optional][default to 'standard'] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImageEditInput.new(
+  media_uuid: null,
+  prompt: Make the background a white studio backdrop,
+  mask_uuid: null,
+  aspect_ratio: null,
+  count: null,
+  quality: null
+)
+```
+

data/docs/ImageGenerate200Response.md

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

data/docs/ImageGenerate429Response.md

@@ -0,0 +1,18 @@
+# PostBoost::ImageGenerate429Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImageGenerate429Response.new(
+  message: Insufficient AI credits. You need 5 credits but only have 2 remaining this month.
+)
+```
+

data/docs/ImageGenerateInput.md

@@ -0,0 +1,36 @@
+# PostBoost::ImageGenerateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **caption** | **String** | Social media caption. Triggers standard mode. Takes priority over prompt. | [optional] |
+| **platform** | **String** | Required when caption is provided. | [optional] |
+| **template** | **String** |  | [optional] |
+| **style** | **String** |  | [optional] |
+| **brand_voice** | **String** |  | [optional] |
+| **custom_instructions** | **String** |  | [optional] |
+| **prompt** | **String** | Developer escape hatch. Bypasses internal prompt builder. Ignored if caption is present. | [optional] |
+| **aspect_ratio** | **String** |  | [optional][default to '1:1'] |
+| **count** | **Integer** |  | [optional][default to 1] |
+| **quality** | **String** |  | [optional][default to 'standard'] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImageGenerateInput.new(
+  caption: null,
+  platform: instagram,
+  template: null,
+  style: minimalist,
+  brand_voice: friendly,
+  custom_instructions: null,
+  prompt: null,
+  aspect_ratio: null,
+  count: null,
+  quality: null
+)
+```
+

data/docs/ImageGenerationResponse.md

@@ -0,0 +1,30 @@
+# PostBoost::ImageGenerationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **images** | [**Array<Media>**](Media.md) |  |  |
+| **prompt_used** | **String** |  |  |
+| **revised_prompt** | **String** |  | [optional] |
+| **aspect_ratio** | **String** |  |  |
+| **quality** | **String** |  |  |
+| **credits_used** | **Integer** |  |  |
+| **credits_remaining** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImageGenerationResponse.new(
+  images: null,
+  prompt_used: null,
+  revised_prompt: null,
+  aspect_ratio: 1:1,
+  quality: standard,
+  credits_used: 5,
+  credits_remaining: 45
+)
+```
+

data/docs/ImagePrompt200Response.md

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

data/docs/ImagePrompt429Response.md

@@ -0,0 +1,18 @@
+# PostBoost::ImagePrompt429Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImagePrompt429Response.new(
+  message: Insufficient AI credits. You need 1 credits but only have 0 remaining this month.
+)
+```
+

data/docs/ImagePromptInput.md

@@ -0,0 +1,28 @@
+# PostBoost::ImagePromptInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **caption** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **template** | **String** |  | [optional] |
+| **style** | **String** |  | [optional] |
+| **brand_voice** | **String** |  | [optional] |
+| **custom_instructions** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImagePromptInput.new(
+  caption: Our summer sale starts today, 30% off everything!,
+  platform: instagram,
+  template: null,
+  style: minimalist,
+  brand_voice: friendly,
+  custom_instructions: null
+)
+```
+

data/docs/ImagePromptResponse.md

@@ -0,0 +1,18 @@
+# PostBoost::ImagePromptResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ImagePromptResponse.new(
+  prompt: Create a vibrant, lifestyle-oriented social media image for Instagram...
+)
+```
+

data/docs/ImageVariations200Response.md

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