postboost 1.8.0 → 1.14.0

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
+)
+```
+

data/docs/CreateRecyclingRule201Response.md

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

data/docs/CreateReportExport201Response.md

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

data/docs/CreateResellerClient201Response.md

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

data/docs/CreateRssFeed201Response.md

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

data/docs/CreateTemplate201Response.md

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

data/docs/CreateWebhookSubscription201Response.md

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

data/docs/CreateWebhookSubscription201ResponseData.md

@@ -0,0 +1,30 @@
+# PostBoost::CreateWebhookSubscription201ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **callback_url** | **String** |  |  |
+| **events** | **Array<String>** |  |  |
+| **active** | **Boolean** |  |  |
+| **created_at** | **Time** |  | [optional] |
+| **secret** | **String** | Signing secret for `X-Signature`. Returned once. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CreateWebhookSubscription201ResponseData.new(
+  uuid: null,
+  name: null,
+  callback_url: null,
+  events: null,
+  active: null,
+  created_at: null,
+  secret: null
+)
+```
+

data/docs/DeleteAgent200Response.md

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

data/docs/GetAccountHealth200Response.md

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

data/docs/GetBrandVoice200Response.md

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

data/docs/GetCompetitor200Response.md

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

data/docs/GetInboxConversation200Response.md

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

data/docs/GetPostingSchedule200Response.md

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

data/docs/GetReportBranding200Response.md

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

data/docs/GuardrailError.md

@@ -0,0 +1,28 @@
+# PostBoost::GuardrailError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **code** | **String** |  | [optional] |
+| **account_id** | **Integer** | The account the problem is about. | [optional] |
+| **existing_post_uuid** | **String** | `duplicate_post` only: the earlier post with the same content. | [optional] |
+| **limit** | **Integer** | `account_daily_cap_reached` only: the account's daily cap. | [optional] |
+| **used** | **Integer** | `account_daily_cap_reached` only: posts already counted on that UTC day. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::GuardrailError.new(
+  message: null,
+  code: null,
+  account_id: null,
+  existing_post_uuid: null,
+  limit: null,
+  used: null
+)
+```
+

data/docs/HashtagGroup.md

@@ -0,0 +1,22 @@
+# PostBoost::HashtagGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Hashtag group UUID. |  |
+| **name** | **String** |  |  |
+| **content** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::HashtagGroup.new(
+  id: null,
+  name: Coffee,
+  content: #coffee #specialtycoffee #homebarista
+)
+```
+

data/docs/HashtagGroupInput.md

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