postboost 1.0.0 → 1.14.0

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/ChannelAccount.md

@@ -0,0 +1,36 @@
+# PostBoost::ChannelAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **username** | **String** | Telegram public channel username; null for private channels, Discord and Slack. | [optional] |
+| **image** | **String** |  | [optional] |
+| **provider** | **String** |  |  |
+| **data** | **Object** | Provider metadata (Telegram `chat_id`, Discord `channel_id`/`guild_id`, Slack `team_id`). |  |
+| **authorized** | **Boolean** |  |  |
+| **profile_url** | **String** |  | [optional] |
+| **created_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ChannelAccount.new(
+  id: null,
+  uuid: null,
+  name: Product news,
+  username: null,
+  image: null,
+  provider: null,
+  data: null,
+  authorized: null,
+  profile_url: null,
+  created_at: null
+)
+```
+

data/docs/CodedError.md

@@ -0,0 +1,22 @@
+# PostBoost::CodedError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **code** | **String** | Machine-readable reason, e.g. `ai_credits_exhausted`, `image_credits_exhausted`, `not_enough_posts`. | [optional] |
+| **errors** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CodedError.new(
+  message: null,
+  code: null,
+  errors: null
+)
+```
+

data/docs/Competitor.md

@@ -0,0 +1,34 @@
+# PostBoost::Competitor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **account_id** | **Integer** |  |  |
+| **username** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **image** | **String** |  | [optional] |
+| **followers_count** | **Integer** |  | [optional] |
+| **media_count** | **Integer** |  | [optional] |
+| **avg_engagement** | **Integer** | Average likes plus comments per imported post. |  |
+| **last_snapshot_date** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::Competitor.new(
+  id: null,
+  account_id: null,
+  username: natgeo,
+  name: null,
+  image: null,
+  followers_count: null,
+  media_count: null,
+  avg_engagement: null,
+  last_snapshot_date: null
+)
+```
+

data/docs/CompetitorDetail.md

@@ -0,0 +1,38 @@
+# PostBoost::CompetitorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **account_id** | **Integer** |  |  |
+| **username** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **image** | **String** |  | [optional] |
+| **followers_count** | **Integer** |  | [optional] |
+| **media_count** | **Integer** |  | [optional] |
+| **avg_engagement** | **Integer** | Average likes plus comments per imported post. |  |
+| **last_snapshot_date** | **Date** |  | [optional] |
+| **snapshots** | [**Array<CompetitorSnapshot>**](CompetitorSnapshot.md) |  |  |
+| **recent_media** | [**Array<CompetitorMedia>**](CompetitorMedia.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CompetitorDetail.new(
+  id: null,
+  account_id: null,
+  username: natgeo,
+  name: null,
+  image: null,
+  followers_count: null,
+  media_count: null,
+  avg_engagement: null,
+  last_snapshot_date: null,
+  snapshots: null,
+  recent_media: null
+)
+```
+

data/docs/CompetitorInput.md

@@ -0,0 +1,20 @@
+# PostBoost::CompetitorInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** | Your Instagram account `id` (connected through a Facebook Page) used to look the competitor up. |  |
+| **username** | **String** | Instagram username, with or without `@`. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CompetitorInput.new(
+  account_id: null,
+  username: natgeo
+)
+```
+

data/docs/CompetitorMedia.md

@@ -0,0 +1,28 @@
+# PostBoost::CompetitorMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **caption** | **String** |  | [optional] |
+| **permalink** | **String** |  | [optional] |
+| **media_type** | **String** |  | [optional] |
+| **like_count** | **Integer** |  | [optional] |
+| **comments_count** | **Integer** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CompetitorMedia.new(
+  caption: null,
+  permalink: null,
+  media_type: null,
+  like_count: null,
+  comments_count: null,
+  timestamp: null
+)
+```
+

data/docs/CompetitorSnapshot.md

@@ -0,0 +1,22 @@
+# PostBoost::CompetitorSnapshot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** |  | [optional] |
+| **followers_count** | **Integer** |  | [optional] |
+| **media_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CompetitorSnapshot.new(
+  date: null,
+  followers_count: null,
+  media_count: null
+)
+```
+

data/docs/CompetitorsApi.md

@@ -0,0 +1,296 @@
+# PostBoost::CompetitorsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_competitor**](CompetitorsApi.md#add_competitor) | **POST** /{workspaceUuid}/competitors | Track a competitor |
+| [**delete_competitor**](CompetitorsApi.md#delete_competitor) | **DELETE** /{workspaceUuid}/competitors/{competitorId} | Stop tracking a competitor |
+| [**get_competitor**](CompetitorsApi.md#get_competitor) | **GET** /{workspaceUuid}/competitors/{competitorId} | Get a competitor |
+| [**list_competitors**](CompetitorsApi.md#list_competitors) | **GET** /{workspaceUuid}/competitors | List competitors |
+
+
+## add_competitor
+
+> <AddCompetitor202Response> add_competitor(workspace_uuid, competitor_input)
+
+Track a competitor
+
+Starts tracking a public Instagram business or creator account from one of your Instagram accounts (connected through a Facebook Page). Returns `202` at once; followers, snapshots and recent media appear after the background import. `409` if that account already tracks the username. 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::CompetitorsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+competitor_input = PostBoost::CompetitorInput.new({account_id: 37, username: 'natgeo'}) # CompetitorInput | 
+
+begin
+  # Track a competitor
+  result = api_instance.add_competitor(workspace_uuid, competitor_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->add_competitor: #{e}"
+end
+```
+
+#### Using the add_competitor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddCompetitor202Response>, Integer, Hash)> add_competitor_with_http_info(workspace_uuid, competitor_input)
+
+```ruby
+begin
+  # Track a competitor
+  data, status_code, headers = api_instance.add_competitor_with_http_info(workspace_uuid, competitor_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddCompetitor202Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->add_competitor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **competitor_input** | [**CompetitorInput**](CompetitorInput.md) |  |  |
+
+### Return type
+
+[**AddCompetitor202Response**](AddCompetitor202Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_competitor
+
+> delete_competitor(workspace_uuid, competitor_id)
+
+Stop tracking a competitor
+
+Deletes the competitor with its snapshots and media. 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::CompetitorsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+competitor_id = 56 # Integer | The competitor `id`.
+
+begin
+  # Stop tracking a competitor
+  api_instance.delete_competitor(workspace_uuid, competitor_id)
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->delete_competitor: #{e}"
+end
+```
+
+#### Using the delete_competitor_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_competitor_with_http_info(workspace_uuid, competitor_id)
+
+```ruby
+begin
+  # Stop tracking a competitor
+  data, status_code, headers = api_instance.delete_competitor_with_http_info(workspace_uuid, competitor_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->delete_competitor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **competitor_id** | **Integer** | The competitor &#x60;id&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_competitor
+
+> <GetCompetitor200Response> get_competitor(workspace_uuid, competitor_id)
+
+Get a competitor
+
+The competitor with daily follower snapshots for the last 90 days and its 12 most recent posts. 
+
+### 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::CompetitorsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+competitor_id = 56 # Integer | The competitor `id`.
+
+begin
+  # Get a competitor
+  result = api_instance.get_competitor(workspace_uuid, competitor_id)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->get_competitor: #{e}"
+end
+```
+
+#### Using the get_competitor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCompetitor200Response>, Integer, Hash)> get_competitor_with_http_info(workspace_uuid, competitor_id)
+
+```ruby
+begin
+  # Get a competitor
+  data, status_code, headers = api_instance.get_competitor_with_http_info(workspace_uuid, competitor_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCompetitor200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->get_competitor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **competitor_id** | **Integer** | The competitor &#x60;id&#x60;. |  |
+
+### Return type
+
+[**GetCompetitor200Response**](GetCompetitor200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_competitors
+
+> <ListCompetitors200Response> list_competitors(workspace_uuid, opts)
+
+List competitors
+
+Instagram business or creator accounts the workspace tracks, by follower count. 
+
+### 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::CompetitorsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  account_id: 56 # Integer | Only competitors tracked from this Instagram account `id`.
+}
+
+begin
+  # List competitors
+  result = api_instance.list_competitors(workspace_uuid, opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->list_competitors: #{e}"
+end
+```
+
+#### Using the list_competitors_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCompetitors200Response>, Integer, Hash)> list_competitors_with_http_info(workspace_uuid, opts)
+
+```ruby
+begin
+  # List competitors
+  data, status_code, headers = api_instance.list_competitors_with_http_info(workspace_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCompetitors200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling CompetitorsApi->list_competitors_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_id** | **Integer** | Only competitors tracked from this Instagram account &#x60;id&#x60;. | [optional] |
+
+### Return type
+
+[**ListCompetitors200Response**](ListCompetitors200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

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/ConnectChannelInput.md

@@ -0,0 +1,24 @@
+# PostBoost::ConnectChannelInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bot_token** | **String** | Telegram only. Bot token from @BotFather. | [optional] |
+| **chat** | **String** | Telegram only. Channel `@username` or numeric chat id. | [optional] |
+| **webhook_url** | **String** | Discord or Slack incoming webhook URL. | [optional] |
+| **name** | **String** | Slack only. Display name for the channel (Slack webhooks do not report one). | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ConnectChannelInput.new(
+  bot_token: 123456789:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsawQ,
+  chat: @yourchannel,
+  webhook_url: null,
+  name: null
+)
+```
+

data/docs/CreateAccountGroup201Response.md

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

data/docs/CreateAgent201Response.md

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

data/docs/CreateApiKey201Response.md

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

data/docs/CreateApiKey201ResponseData.md

@@ -0,0 +1,34 @@
+# PostBoost::CreateApiKey201ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **name** | **String** |  |  |
+| **abilities** | [**Array<ApiKeyAbility>**](ApiKeyAbility.md) |  |  |
+| **account_ids** | **Array<Integer>** |  | [optional] |
+| **created_by** | **String** | Name of the user the key acts as. | [optional] |
+| **last_used_at** | **Time** |  | [optional] |
+| **expires_at** | **Date** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **token** | **String** | The plain API key. Shown only in this response. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CreateApiKey201ResponseData.new(
+  id: null,
+  name: null,
+  abilities: null,
+  account_ids: null,
+  created_by: null,
+  last_used_at: null,
+  expires_at: null,
+  created_at: null,
+  token: null
+)
+```
+

data/docs/CreateHashtagGroup201Response.md

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

data/docs/CreateInboxReplyDraft201Response.md

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