postboost 1.0.0 → 1.14.0

data/docs/AICredits.md

@@ -0,0 +1,22 @@
+# PostBoost::AICredits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Boolean** | Whether the workspace can spend AI credits now. Always true when no balance is tracked. |  |
+| **balance** | **Float** | Remaining credit balance (2 decimals), or null when no balance is tracked. |  |
+| **low** | **Boolean** | True when the balance is above 0 and at most 10. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AICredits.new(
+  available: null,
+  balance: null,
+  low: null
+)
+```
+

data/docs/AIUsage.md

@@ -0,0 +1,20 @@
+# PostBoost::AIUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | [**AIUsageText**](AIUsageText.md) |  |  |
+| **image** | [**ImageCreditBalance**](ImageCreditBalance.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AIUsage.new(
+  text: null,
+  image: null
+)
+```
+

data/docs/AIUsageText.md

@@ -0,0 +1,24 @@
+# PostBoost::AIUsageText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **used** | **Integer** | `null` when the workspace has no text credit limit. |  |
+| **limit** | **Integer** |  |  |
+| **remaining** | **Integer** |  |  |
+| **cycle_started_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AIUsageText.new(
+  used: null,
+  limit: null,
+  remaining: null,
+  cycle_started_at: null
+)
+```
+

data/docs/Account.md

@@ -4,15 +4,20 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **uuid** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **username** | **String** |  | [optional] |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **username** | **String** |  |  |
 | **image** | **String** |  | [optional] |
-| **provider** | **String** |  | [optional] |
-| **data** | **Object** | Provider-specific metadata. | [optional] |
-| **authorized** | **Boolean** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
+| **provider** | **String** |  |  |
+| **data** | **Object** | Provider-specific metadata. |  |
+| **authorized** | **Boolean** |  |  |
+| **profile_url** | **String** | Public URL of the account's profile on the network, when known. | [optional] |
+| **publish_status** | **String** | Only present when the account is embedded in a post. Publishing state of this account for the post. | [optional] |
+| **published_parts** | **Integer** | Only present when the account is embedded in a post. How many parts (for example thread items or a first comment) are live on the network. | [optional] |
+| **external_url** | **String** | Only present when the account is embedded in a post. URL of the published post on the network, null until it is live. | [optional] |
+| **errors** | [**Array<AccountErrorsInner>**](AccountErrorsInner.md) | Only present when the account is embedded in a post. Why publishing to this account failed. A raw network error is stored as two entries: a readable line (`\"<Network>: <message> (code <code>)\"`) and an object `{platform, code, message, raw}` with the network's original response in `raw`. Other failures are a single readable string.  | [optional] |
+| **created_at** | **String** | UTC, formatted `Y-m-d H:i:s`. |  |
 
 ## Example
 
@@ -28,7 +33,12 @@ instance = PostBoost::Account.new(
   provider: null,
   data: null,
   authorized: null,
-  created_at: null
+  profile_url: null,
+  publish_status: null,
+  published_parts: null,
+  external_url: null,
+  errors: null,
+  created_at: 2026-10-11 09:30:00
 )
 ```
 

data/docs/AccountAnalytics.md

@@ -0,0 +1,28 @@
+# PostBoost::AccountAnalytics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | [**Account**](Account.md) |  |  |
+| **type** | **String** | The analytics tab returned. |  |
+| **tabs** | **Array<String>** | Tabs this account supports; any of them can be passed as `type`. |  |
+| **period** | [**AnalyticsPeriod**](AnalyticsPeriod.md) |  |  |
+| **initial_sync** | [**AccountAnalyticsInitialSync**](AccountAnalyticsInitialSync.md) |  |  |
+| **data** | **Hash<String, Object>** | Provider- and tab-specific metrics. Chart series are lists of `{date, value}` points. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountAnalytics.new(
+  account: null,
+  type: null,
+  tabs: null,
+  period: null,
+  initial_sync: null,
+  data: null
+)
+```
+

data/docs/AccountAnalyticsInitialSync.md

@@ -0,0 +1,20 @@
+# PostBoost::AccountAnalyticsInitialSync
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **in_progress** | **Boolean** |  |  |
+| **progress** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountAnalyticsInitialSync.new(
+  in_progress: null,
+  progress: null
+)
+```
+

data/docs/AccountConnectionHealth.md

@@ -0,0 +1,34 @@
+# PostBoost::AccountConnectionHealth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | `expired`: must be reconnected now. `expiring`: the connection hits its hard expiry within 7 days. `failing`: the latest publish attempt failed. `healthy`: none of these.  |  |
+| **expiry_kind** | **String** | What limits the connection: `access` (the access token), `refresh` (the refresh token), `expired`, `unknown` (refreshed automatically, no known hard limit) or `none` (the network's connections do not expire on a schedule).  |  |
+| **expires_at** | **Time** | When the connection stops working unless reconnected; null without a hard expiry. |  |
+| **days_left** | **Integer** | Whole days until `expires_at` (0 = less than a day). |  |
+| **refreshable** | **Boolean** | PostBoost refreshes the token automatically until the hard expiry. |  |
+| **note** | **String** | Plain-language explanation of the prediction. |  |
+| **last_success_at** | **Time** | When the account last published successfully. |  |
+| **last_error** | **String** | The error of the account's latest failed publish, shortened to 300 characters. |  |
+| **reconnect_url** | **String** | Where a workspace member reconnects the account. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountConnectionHealth.new(
+  status: null,
+  expiry_kind: null,
+  expires_at: null,
+  days_left: null,
+  refreshable: null,
+  note: null,
+  last_success_at: null,
+  last_error: null,
+  reconnect_url: null
+)
+```
+

data/docs/AccountErrorsInner.md

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

data/docs/AccountErrorsInnerOneOf.md

@@ -0,0 +1,24 @@
+# PostBoost::AccountErrorsInnerOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **raw** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountErrorsInnerOneOf.new(
+  platform: null,
+  code: null,
+  message: null,
+  raw: null
+)
+```
+

data/docs/AccountGroup.md

@@ -0,0 +1,24 @@
+# PostBoost::AccountGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **account_ids** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountGroup.new(
+  id: null,
+  uuid: null,
+  name: Client A,
+  account_ids: null
+)
+```
+

data/docs/AccountGroupInput.md

@@ -0,0 +1,20 @@
+# PostBoost::AccountGroupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **accounts** | **Array<Integer>** | Account `id`s of this workspace. Replaces the group's accounts. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountGroupInput.new(
+  name: null,
+  accounts: null
+)
+```
+

data/docs/AccountGroupsApi.md

@@ -0,0 +1,372 @@
+# PostBoost::AccountGroupsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_account_group**](AccountGroupsApi.md#create_account_group) | **POST** /{workspaceUuid}/account-groups | Create an account group |
+| [**delete_account_group**](AccountGroupsApi.md#delete_account_group) | **DELETE** /{workspaceUuid}/account-groups/{accountGroupUuid} | Delete an account group |
+| [**get_account_group**](AccountGroupsApi.md#get_account_group) | **GET** /{workspaceUuid}/account-groups/{accountGroupUuid} | Get an account group |
+| [**list_account_groups**](AccountGroupsApi.md#list_account_groups) | **GET** /{workspaceUuid}/account-groups | List account groups |
+| [**update_account_group**](AccountGroupsApi.md#update_account_group) | **PUT** /{workspaceUuid}/account-groups/{accountGroupUuid} | Update an account group |
+
+
+## create_account_group
+
+> <CreateAccountGroup201Response> create_account_group(workspace_uuid, account_group_input)
+
+Create an account group
+
+Creates a named set of accounts of this workspace. Admins and members only (not viewers). 
+
+### 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::AccountGroupsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_group_input = PostBoost::AccountGroupInput.new({name: 'name_example'}) # AccountGroupInput | 
+
+begin
+  # Create an account group
+  result = api_instance.create_account_group(workspace_uuid, account_group_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->create_account_group: #{e}"
+end
+```
+
+#### Using the create_account_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateAccountGroup201Response>, Integer, Hash)> create_account_group_with_http_info(workspace_uuid, account_group_input)
+
+```ruby
+begin
+  # Create an account group
+  data, status_code, headers = api_instance.create_account_group_with_http_info(workspace_uuid, account_group_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateAccountGroup201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->create_account_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_group_input** | [**AccountGroupInput**](AccountGroupInput.md) |  |  |
+
+### Return type
+
+[**CreateAccountGroup201Response**](CreateAccountGroup201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_account_group
+
+> delete_account_group(workspace_uuid, account_group_uuid)
+
+Delete an account group
+
+Deletes the group, not its accounts. Admins and members only (not viewers). 
+
+### 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::AccountGroupsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_group_uuid = 'account_group_uuid_example' # String | The account group `uuid`.
+
+begin
+  # Delete an account group
+  api_instance.delete_account_group(workspace_uuid, account_group_uuid)
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->delete_account_group: #{e}"
+end
+```
+
+#### Using the delete_account_group_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_account_group_with_http_info(workspace_uuid, account_group_uuid)
+
+```ruby
+begin
+  # Delete an account group
+  data, status_code, headers = api_instance.delete_account_group_with_http_info(workspace_uuid, account_group_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->delete_account_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_group_uuid** | **String** | The account group &#x60;uuid&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_account_group
+
+> <CreateAccountGroup201Response> get_account_group(workspace_uuid, account_group_uuid)
+
+Get an account group
+
+One account group. 
+
+### 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::AccountGroupsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_group_uuid = 'account_group_uuid_example' # String | The account group `uuid`.
+
+begin
+  # Get an account group
+  result = api_instance.get_account_group(workspace_uuid, account_group_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->get_account_group: #{e}"
+end
+```
+
+#### Using the get_account_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateAccountGroup201Response>, Integer, Hash)> get_account_group_with_http_info(workspace_uuid, account_group_uuid)
+
+```ruby
+begin
+  # Get an account group
+  data, status_code, headers = api_instance.get_account_group_with_http_info(workspace_uuid, account_group_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateAccountGroup201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->get_account_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_group_uuid** | **String** | The account group &#x60;uuid&#x60;. |  |
+
+### Return type
+
+[**CreateAccountGroup201Response**](CreateAccountGroup201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_account_groups
+
+> <ListAccountGroups200Response> list_account_groups(workspace_uuid, opts)
+
+List account groups
+
+Named sets of accounts, sorted by name, with their account ids. Pass `account_ids` as `accounts` when you create a post to publish to the whole group. Paginated with `page` and `per_page` (default 100). A key limited to some accounts only sees groups whose accounts are all among its accounts, and `meta.total` counts only those. 
+
+### 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::AccountGroupsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  page: 56, # Integer | Page number (1-based).
+  per_page: 56 # Integer | Items per page, 1-100.
+}
+
+begin
+  # List account groups
+  result = api_instance.list_account_groups(workspace_uuid, opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->list_account_groups: #{e}"
+end
+```
+
+#### Using the list_account_groups_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAccountGroups200Response>, Integer, Hash)> list_account_groups_with_http_info(workspace_uuid, opts)
+
+```ruby
+begin
+  # List account groups
+  data, status_code, headers = api_instance.list_account_groups_with_http_info(workspace_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAccountGroups200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->list_account_groups_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **page** | **Integer** | Page number (1-based). | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page, 1-100. | [optional][default to 100] |
+
+### Return type
+
+[**ListAccountGroups200Response**](ListAccountGroups200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_account_group
+
+> <CreateAccountGroup201Response> update_account_group(workspace_uuid, account_group_uuid, account_group_input)
+
+Update an account group
+
+Replaces the name and the accounts of the group (accounts you leave out are removed). Admins and members only (not viewers). 
+
+### 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::AccountGroupsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_group_uuid = 'account_group_uuid_example' # String | The account group `uuid`.
+account_group_input = PostBoost::AccountGroupInput.new({name: 'name_example'}) # AccountGroupInput | 
+
+begin
+  # Update an account group
+  result = api_instance.update_account_group(workspace_uuid, account_group_uuid, account_group_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->update_account_group: #{e}"
+end
+```
+
+#### Using the update_account_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateAccountGroup201Response>, Integer, Hash)> update_account_group_with_http_info(workspace_uuid, account_group_uuid, account_group_input)
+
+```ruby
+begin
+  # Update an account group
+  data, status_code, headers = api_instance.update_account_group_with_http_info(workspace_uuid, account_group_uuid, account_group_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateAccountGroup201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountGroupsApi->update_account_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_group_uuid** | **String** | The account group &#x60;uuid&#x60;. |  |
+| **account_group_input** | [**AccountGroupInput**](AccountGroupInput.md) |  |  |
+
+### Return type
+
+[**CreateAccountGroup201Response**](CreateAccountGroup201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+