postboost 1.0.0 → 1.14.0

data/docs/MediaBase64Input.md

@@ -0,0 +1,24 @@
+# PostBoost::MediaBase64Input
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | The file as base64. A `data:<mime>;base64,` prefix is accepted. At most 20 MB once decoded. |  |
+| **filename** | **String** | File name with extension, for example `cover.png`. No folders. |  |
+| **alt_text** | **String** | Alternative text for accessibility. | [optional] |
+| **folder** | **String** | UUID of the media folder to file the upload in. Omit or null for the library root. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MediaBase64Input.new(
+  content: null,
+  filename: cover.png,
+  alt_text: null,
+  folder: null
+)
+```
+

data/docs/MediaFolder.md

@@ -0,0 +1,24 @@
+# PostBoost::MediaFolder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **parent** | **String** | UUID of the parent folder; null for a top-level folder. |  |
+| **media_count** | **Integer** | Media filed anywhere below the folder, including its sub-folders. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MediaFolder.new(
+  uuid: null,
+  name: Campaign assets,
+  parent: null,
+  media_count: null
+)
+```
+

data/docs/MediaFolderInput.md

@@ -0,0 +1,20 @@
+# PostBoost::MediaFolderInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Folder name; must be unique among its siblings (case-insensitive). | [optional] |
+| **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::MediaFolderInput.new(
+  name: null,
+  parent: null
+)
+```
+

data/docs/MediaFolderRef.md

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

data/docs/Mention.md

@@ -0,0 +1,28 @@
+# PostBoost::Mention
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **reference** | **Integer** | Write `{{mention:<reference>}}` in a post body to mention this entry; it is resolved to each network's identity at publish time. |  |
+| **name** | **String** |  |  |
+| **avatar** | **String** |  | [optional] |
+| **identities** | [**Array<MentionIdentity>**](MentionIdentity.md) |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::Mention.new(
+  id: null,
+  reference: null,
+  name: Jane Doe,
+  avatar: null,
+  identities: null,
+  created_at: null
+)
+```
+

data/docs/MentionIdentity.md

@@ -0,0 +1,24 @@
+# PostBoost::MentionIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | Mention provider key (network family). |  |
+| **provider_id** | **String** | The profile's network ID, when resolved. Never accepted from clients. | [optional] |
+| **handle** | **String** |  |  |
+| **label** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MentionIdentity.new(
+  provider: linkedin,
+  provider_id: null,
+  handle: janedoe,
+  label: null
+)
+```
+

data/docs/MentionIdentityInput.md

@@ -0,0 +1,26 @@
+# PostBoost::MentionIdentityInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | Mention provider key. One identity per provider. |  |
+| **handle** | **String** | Profile handle; a leading `@` is stripped. |  |
+| **label** | **String** |  | [optional] |
+| **token** | **String** | Sealed lookup result that names the profile's network ID. | [optional] |
+| **account_uuid** | **String** | A connected account of this workspace that names the profile. Wins over `token` when both are sent. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MentionIdentityInput.new(
+  provider: null,
+  handle: null,
+  label: null,
+  token: null,
+  account_uuid: null
+)
+```
+

data/docs/MentionInput.md

@@ -0,0 +1,22 @@
+# PostBoost::MentionInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **avatar** | **String** |  | [optional] |
+| **identities** | [**Array<MentionIdentityInput>**](MentionIdentityInput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::MentionInput.new(
+  name: null,
+  avatar: null,
+  identities: null
+)
+```
+

data/docs/MentionsApi.md

@@ -0,0 +1,379 @@
+# PostBoost::MentionsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_mention**](MentionsApi.md#create_mention) | **POST** /{workspaceUuid}/mentions | Create mention |
+| [**delete_mention**](MentionsApi.md#delete_mention) | **DELETE** /{workspaceUuid}/mentions/{mentionId} | Delete mention |
+| [**get_mention**](MentionsApi.md#get_mention) | **GET** /{workspaceUuid}/mentions/{mentionId} | Get mention |
+| [**list_mentions**](MentionsApi.md#list_mentions) | **GET** /{workspaceUuid}/mentions | List mentions |
+| [**update_mention**](MentionsApi.md#update_mention) | **PUT** /{workspaceUuid}/mentions/{mentionId} | Update mention |
+
+
+## create_mention
+
+> <CreateMention201Response> create_mention(workspace_uuid, mention_input, opts)
+
+Create mention
+
+Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`). 
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_input = PostBoost::MentionInput.new({name: 'name_example'}) # MentionInput | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+}
+
+begin
+  # Create mention
+  result = api_instance.create_mention(workspace_uuid, mention_input, opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->create_mention: #{e}"
+end
+```
+
+#### Using the create_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> create_mention_with_http_info(workspace_uuid, mention_input, opts)
+
+```ruby
+begin
+  # Create mention
+  data, status_code, headers = api_instance.create_mention_with_http_info(workspace_uuid, mention_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->create_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_input** | [**MentionInput**](MentionInput.md) |  |  |
+| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.  | [optional] |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_mention
+
+> Object delete_mention(workspace_uuid, mention_id)
+
+Delete mention
+
+Removes a mention from the mention book. `success` is false when nothing was deleted.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+
+begin
+  # Delete mention
+  result = api_instance.delete_mention(workspace_uuid, mention_id)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->delete_mention: #{e}"
+end
+```
+
+#### Using the delete_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_mention_with_http_info(workspace_uuid, mention_id)
+
+```ruby
+begin
+  # Delete mention
+  data, status_code, headers = api_instance.delete_mention_with_http_info(workspace_uuid, mention_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->delete_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_mention
+
+> <CreateMention201Response> get_mention(workspace_uuid, mention_id)
+
+Get mention
+
+Returns a single mention with its identities.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+
+begin
+  # Get mention
+  result = api_instance.get_mention(workspace_uuid, mention_id)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->get_mention: #{e}"
+end
+```
+
+#### Using the get_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> get_mention_with_http_info(workspace_uuid, mention_id)
+
+```ruby
+begin
+  # Get mention
+  data, status_code, headers = api_instance.get_mention_with_http_info(workspace_uuid, mention_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->get_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_mentions
+
+> <ListMentions200Response> list_mentions(workspace_uuid, opts)
+
+List mentions
+
+Returns a paginated list of the workspace's mention book, ranked, with each entry's network identities.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  q: 'q_example', # String | Search keyword.
+  per_page: 56, # Integer | 
+  page: 56 # Integer | 
+}
+
+begin
+  # List mentions
+  result = api_instance.list_mentions(workspace_uuid, opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->list_mentions: #{e}"
+end
+```
+
+#### Using the list_mentions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListMentions200Response>, Integer, Hash)> list_mentions_with_http_info(workspace_uuid, opts)
+
+```ruby
+begin
+  # List mentions
+  data, status_code, headers = api_instance.list_mentions_with_http_info(workspace_uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListMentions200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->list_mentions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **q** | **String** | Search keyword. | [optional] |
+| **per_page** | **Integer** |  | [optional][default to 25] |
+| **page** | **Integer** |  | [optional][default to 1] |
+
+### Return type
+
+[**ListMentions200Response**](ListMentions200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_mention
+
+> <CreateMention201Response> update_mention(workspace_uuid, mention_id, mention_input)
+
+Update mention
+
+Replaces the mention's name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns `422`.
+
+### 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::MentionsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+mention_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The mention's `id` (a UUID).
+mention_input = PostBoost::MentionInput.new({name: 'name_example'}) # MentionInput | 
+
+begin
+  # Update mention
+  result = api_instance.update_mention(workspace_uuid, mention_id, mention_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->update_mention: #{e}"
+end
+```
+
+#### Using the update_mention_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMention201Response>, Integer, Hash)> update_mention_with_http_info(workspace_uuid, mention_id, mention_input)
+
+```ruby
+begin
+  # Update mention
+  data, status_code, headers = api_instance.update_mention_with_http_info(workspace_uuid, mention_id, mention_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMention201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling MentionsApi->update_mention_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **mention_id** | **String** | The mention&#39;s &#x60;id&#x60; (a UUID). |  |
+| **mention_input** | [**MentionInput**](MentionInput.md) |  |  |
+
+### Return type
+
+[**CreateMention201Response**](CreateMention201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MessageOnly.md

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

data/docs/PollRssFeed200Response.md

@@ -0,0 +1,22 @@
+# PostBoost::PollRssFeed200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** | Posts created from new items. |  |
+| **skipped** | **Integer** | New items refused by a guardrail. |  |
+| **data** | [**RssFeed**](RssFeed.md) |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PollRssFeed200Response.new(
+  created: null,
+  skipped: null,
+  data: null
+)
+```
+

data/docs/Post.md

@@ -4,16 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **uuid** | **String** |  | [optional] |
-| **status** | [**PostStatus**](PostStatus.md) |  | [optional] |
-| **accounts** | [**Array<Account>**](Account.md) |  | [optional] |
-| **versions** | [**Array<PostVersion>**](PostVersion.md) |  | [optional] |
-| **tags** | [**Array<Tag>**](Tag.md) |  | [optional] |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **status** | [**PostStatus**](PostStatus.md) |  |  |
+| **publish_progress** | [**PublishProgress**](PublishProgress.md) | Only present while the post is publishing. | [optional] |
+| **accounts** | [**Array<Account>**](Account.md) |  |  |
+| **versions** | [**Array<PostVersion>**](PostVersion.md) |  |  |
+| **tags** | [**Array<Tag>**](Tag.md) |  |  |
 | **scheduled_at** | **Time** |  | [optional] |
 | **published_at** | **Time** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
-| **trashed** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **trashed** | **Boolean** |  |  |
 
 ## Example
 
@@ -24,6 +25,7 @@ instance = PostBoost::Post.new(
   id: null,
   uuid: null,
   status: null,
+  publish_progress: null,
   accounts: null,
   versions: null,
   tags: null,

data/docs/PostAnalytics.md

@@ -0,0 +1,22 @@
+# PostBoost::PostAnalytics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **summary** | **Hash<String, Object>** | Totals (views, likes, comments, shares), trends, engagement rate, breakdown, funnel and peak day across the post's accounts. Empty when nothing is published yet. |  |
+| **winner** | **Object** |  | [optional] |
+| **accounts** | **Array<Hash<String, Object>>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::PostAnalytics.new(
+  summary: null,
+  winner: null,
+  accounts: null
+)
+```
+

data/docs/PostContent.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **body** | **String** | Post text/caption. | [optional] |
+| **body** | **String** | Post text/caption. For a second item on Facebook Page, Instagram or LinkedIn this is the first comment. | [optional] |
 | **url** | **String** |  | [optional] |
 | **media** | **Array<Integer>** | Array of media IDs from the media library. | [optional] |
 | **video_thumbs** | **Array<Object>** |  | [optional] |