postboost 1.8.0 → 1.14.0

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
+

data/docs/AccountHealth.md

@@ -0,0 +1,34 @@
+# PostBoost::AccountHealth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **provider** | **String** |  |  |
+| **authorized** | **Boolean** | False when the account must be reconnected. |  |
+| **has_token** | **Boolean** | Whether an access token is stored for the account. |  |
+| **healthy** | **Boolean** | `authorized` and `has_token`: the account can publish. |  |
+| **daily_cap** | [**AccountHealthDailyCap**](AccountHealthDailyCap.md) |  |  |
+| **connection** | [**AccountConnectionHealth**](AccountConnectionHealth.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountHealth.new(
+  id: null,
+  uuid: null,
+  name: null,
+  provider: null,
+  authorized: null,
+  has_token: null,
+  healthy: null,
+  daily_cap: null,
+  connection: null
+)
+```
+

data/docs/AccountHealthDailyCap.md

@@ -0,0 +1,20 @@
+# PostBoost::AccountHealthDailyCap
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Posts allowed per UTC day for this network. |  |
+| **used_today** | **Integer** | Scheduled, awaiting-approval and published posts counted for today (UTC). |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AccountHealthDailyCap.new(
+  limit: null,
+  used_today: null
+)
+```
+

data/docs/AccountsApi.md

@@ -4,10 +4,157 @@ All URIs are relative to *https://postboost.co/app/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**connect_channel**](AccountsApi.md#connect_channel) | **POST** /{workspaceUuid}/accounts/connect/{provider} | Connect a Telegram, Discord or Slack channel |
+| [**create_reconnect_link**](AccountsApi.md#create_reconnect_link) | **POST** /{workspaceUuid}/accounts/{accountUuid}/reconnect-links | Create a reconnect link |
 | [**get_account**](AccountsApi.md#get_account) | **GET** /{workspaceUuid}/accounts/{accountUuid} | Get account |
+| [**get_account_health**](AccountsApi.md#get_account_health) | **GET** /{workspaceUuid}/account-health | Account health |
 | [**list_accounts**](AccountsApi.md#list_accounts) | **GET** /{workspaceUuid}/accounts | List accounts |
 
 
+## connect_channel
+
+> <ChannelAccount> connect_channel(workspace_uuid, provider, connect_channel_input)
+
+Connect a Telegram, Discord or Slack channel
+
+Connects a channel that uses a bot token or a webhook URL instead of a login. The credentials are checked against the network first, stored encrypted and never returned. Connecting the same channel again updates it (`200`) instead of adding a second account. Workspace admins only; counts toward the plan's social account limit.  - **telegram**: `bot_token` from @BotFather and `chat` (the channel's `@username`, or its   numeric id such as `-1001234567890` for a private channel). The bot must be an administrator   of the channel allowed to post messages. - **discord**: `webhook_url` from Channel settings → Integrations → Webhooks   (`https://discord.com/api/webhooks/…`). - **slack**: `webhook_url` of an incoming webhook (`https://hooks.slack.com/services/…`) and an   optional display `name`. Slack posts cannot be deleted from PostBoost, and images must be   publicly reachable.  Webhook URLs on any other host are refused (`422`) before any request is made. 
+
+### 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::AccountsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+provider = 'telegram' # String | 
+connect_channel_input = PostBoost::ConnectChannelInput.new # ConnectChannelInput | 
+
+begin
+  # Connect a Telegram, Discord or Slack channel
+  result = api_instance.connect_channel(workspace_uuid, provider, connect_channel_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->connect_channel: #{e}"
+end
+```
+
+#### Using the connect_channel_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelAccount>, Integer, Hash)> connect_channel_with_http_info(workspace_uuid, provider, connect_channel_input)
+
+```ruby
+begin
+  # Connect a Telegram, Discord or Slack channel
+  data, status_code, headers = api_instance.connect_channel_with_http_info(workspace_uuid, provider, connect_channel_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelAccount>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->connect_channel_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **provider** | **String** |  |  |
+| **connect_channel_input** | [**ConnectChannelInput**](ConnectChannelInput.md) |  |  |
+
+### Return type
+
+[**ChannelAccount**](ChannelAccount.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_reconnect_link
+
+> <ReconnectLink> create_reconnect_link(workspace_uuid, account_uuid)
+
+Create a reconnect link
+
+Creates a single-use link (valid 7 days) that lets someone without a PostBoost login, such as an agency's client, re-authorize this one account on its network. The link only refreshes the connection of this account; signing in as a different profile or page changes nothing. Workspace admins only. Available for Facebook Pages, Instagram, Threads, LinkedIn, TikTok, YouTube and Pinterest. Returns `404` while the feature is not enabled on this instance. 
+
+### 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::AccountsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the social media account.
+
+begin
+  # Create a reconnect link
+  result = api_instance.create_reconnect_link(workspace_uuid, account_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->create_reconnect_link: #{e}"
+end
+```
+
+#### Using the create_reconnect_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReconnectLink>, Integer, Hash)> create_reconnect_link_with_http_info(workspace_uuid, account_uuid)
+
+```ruby
+begin
+  # Create a reconnect link
+  data, status_code, headers = api_instance.create_reconnect_link_with_http_info(workspace_uuid, account_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReconnectLink>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->create_reconnect_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_uuid** | **String** | UUID of the social media account. |  |
+
+### Return type
+
+[**ReconnectLink**](ReconnectLink.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_account
 
 > <Account> get_account(workspace_uuid, account_uuid)
@@ -79,6 +226,75 @@ end
 - **Accept**: application/json
 
 
+## get_account_health
+
+> <GetAccountHealth200Response> get_account_health(workspace_uuid)
+
+Account health
+
+Pre-flight health of every account in the workspace: whether it is authorized and holds an access token, how much of its daily post cap (per UTC day, scheduled, awaiting approval and published posts) is used today, and its connection health: predicted token expiry, latest publish outcome and where to reconnect it. The `account.token_expiring` and `account.disconnected` webhooks report changes as they happen. 
+
+### 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::AccountsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+
+begin
+  # Account health
+  result = api_instance.get_account_health(workspace_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->get_account_health: #{e}"
+end
+```
+
+#### Using the get_account_health_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccountHealth200Response>, Integer, Hash)> get_account_health_with_http_info(workspace_uuid)
+
+```ruby
+begin
+  # Account health
+  data, status_code, headers = api_instance.get_account_health_with_http_info(workspace_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccountHealth200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->get_account_health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+
+### Return type
+
+[**GetAccountHealth200Response**](GetAccountHealth200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_accounts
 
 > <ListAccounts200Response> list_accounts(workspace_uuid, opts)