postboost 1.8.0 → 1.14.0

data/docs/AnalyticsApi.md

@@ -4,11 +4,160 @@ All URIs are relative to *https://postboost.co/app/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_report_export**](AnalyticsApi.md#create_report_export) | **POST** /{workspaceUuid}/reports/exports | Create a report export |
+| [**download_report_export**](AnalyticsApi.md#download_report_export) | **GET** /{workspaceUuid}/reports/exports/{exportUuid}/download | Download a report file |
 | [**get_account_analytics**](AnalyticsApi.md#get_account_analytics) | **GET** /{workspaceUuid}/analytics/accounts/{accountUuid} | Get account analytics |
 | [**get_analytics_summary**](AnalyticsApi.md#get_analytics_summary) | **GET** /{workspaceUuid}/analytics | Get analytics summary |
 | [**get_best_posting_times**](AnalyticsApi.md#get_best_posting_times) | **GET** /{workspaceUuid}/analytics/best-times | Get best posting times |
 | [**get_post_analytics_0**](AnalyticsApi.md#get_post_analytics_0) | **GET** /{workspaceUuid}/posts/{postUuid}/analytics | Get post analytics |
 | [**get_posting_times**](AnalyticsApi.md#get_posting_times) | **GET** /{workspaceUuid}/analytics/posting-times | Get posting times heatmap |
+| [**get_report_branding**](AnalyticsApi.md#get_report_branding) | **GET** /{workspaceUuid}/report-branding | Get the report branding |
+| [**get_report_export**](AnalyticsApi.md#get_report_export) | **GET** /{workspaceUuid}/reports/exports/{exportUuid} | Get a report export |
+| [**list_report_exports**](AnalyticsApi.md#list_report_exports) | **GET** /{workspaceUuid}/reports/exports | List report exports |
+| [**update_report_branding**](AnalyticsApi.md#update_report_branding) | **PUT** /{workspaceUuid}/report-branding | Update the report branding |
+| [**upload_report_branding_logo**](AnalyticsApi.md#upload_report_branding_logo) | **POST** /{workspaceUuid}/report-branding/logo | Upload the report logo |
+
+
+## create_report_export
+
+> <CreateReportExport201Response> create_report_export(workspace_uuid, report_export_input)
+
+Create a report export
+
+Generates a report for a period (default `last_month`) or a custom `date_from`/`date_to` range: a branded PDF (summary, accounts, top 10 posts; the header uses the report branding) or a CSV with one row per published post and account (`dataset: posts`, default) or per account (`dataset: accounts`). CSV files are UTF-8 with a byte order mark. At most 500 posts per report. The file is ready when the call returns; fetch it from `download_url` with the same token. Admins and members only; 20 per minute. 
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+report_export_input = PostBoost::ReportExportInput.new({format: 'csv'}) # ReportExportInput | 
+
+begin
+  # Create a report export
+  result = api_instance.create_report_export(workspace_uuid, report_export_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->create_report_export: #{e}"
+end
+```
+
+#### Using the create_report_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateReportExport201Response>, Integer, Hash)> create_report_export_with_http_info(workspace_uuid, report_export_input)
+
+```ruby
+begin
+  # Create a report export
+  data, status_code, headers = api_instance.create_report_export_with_http_info(workspace_uuid, report_export_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateReportExport201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->create_report_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **report_export_input** | [**ReportExportInput**](ReportExportInput.md) |  |  |
+
+### Return type
+
+[**CreateReportExport201Response**](CreateReportExport201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## download_report_export
+
+> File download_report_export(workspace_uuid, export_uuid)
+
+Download a report file
+
+The PDF or CSV file. `410` once it expired (7 days) or if the export failed.
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+export_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the report export.
+
+begin
+  # Download a report file
+  result = api_instance.download_report_export(workspace_uuid, export_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->download_report_export: #{e}"
+end
+```
+
+#### Using the download_report_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> download_report_export_with_http_info(workspace_uuid, export_uuid)
+
+```ruby
+begin
+  # Download a report file
+  data, status_code, headers = api_instance.download_report_export_with_http_info(workspace_uuid, export_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->download_report_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **export_uuid** | **String** | UUID of the report export. |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, text/csv, application/json
 
 
 ## get_account_analytics
@@ -399,3 +548,352 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## get_report_branding
+
+> <GetReportBranding200Response> get_report_branding(workspace_uuid)
+
+Get the report branding
+
+The white-label header of the workspace's PDF reports. Unset fields are `null`; the workspace name is used then.
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+
+begin
+  # Get the report branding
+  result = api_instance.get_report_branding(workspace_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->get_report_branding: #{e}"
+end
+```
+
+#### Using the get_report_branding_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetReportBranding200Response>, Integer, Hash)> get_report_branding_with_http_info(workspace_uuid)
+
+```ruby
+begin
+  # Get the report branding
+  data, status_code, headers = api_instance.get_report_branding_with_http_info(workspace_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetReportBranding200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->get_report_branding_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+
+### Return type
+
+[**GetReportBranding200Response**](GetReportBranding200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_report_export
+
+> <CreateReportExport201Response> get_report_export(workspace_uuid, export_uuid)
+
+Get a report export
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+export_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the report export.
+
+begin
+  # Get a report export
+  result = api_instance.get_report_export(workspace_uuid, export_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->get_report_export: #{e}"
+end
+```
+
+#### Using the get_report_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateReportExport201Response>, Integer, Hash)> get_report_export_with_http_info(workspace_uuid, export_uuid)
+
+```ruby
+begin
+  # Get a report export
+  data, status_code, headers = api_instance.get_report_export_with_http_info(workspace_uuid, export_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateReportExport201Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->get_report_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **export_uuid** | **String** | UUID of the report export. |  |
+
+### Return type
+
+[**CreateReportExport201Response**](CreateReportExport201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_report_exports
+
+> <ListReportExports200Response> list_report_exports(workspace_uuid)
+
+List report exports
+
+The workspace's latest 50 report exports, newest first. Files can be downloaded for 7 days.
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+
+begin
+  # List report exports
+  result = api_instance.list_report_exports(workspace_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->list_report_exports: #{e}"
+end
+```
+
+#### Using the list_report_exports_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListReportExports200Response>, Integer, Hash)> list_report_exports_with_http_info(workspace_uuid)
+
+```ruby
+begin
+  # List report exports
+  data, status_code, headers = api_instance.list_report_exports_with_http_info(workspace_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListReportExports200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->list_report_exports_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+
+### Return type
+
+[**ListReportExports200Response**](ListReportExports200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_report_branding
+
+> <GetReportBranding200Response> update_report_branding(workspace_uuid, report_branding_input)
+
+Update the report branding
+
+Name, colour and footer of PDF reports. Fields you leave out keep their value. Upload the logo with `uploadReportBrandingLogo`. Admins and members only.
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+report_branding_input = PostBoost::ReportBrandingInput.new # ReportBrandingInput | 
+
+begin
+  # Update the report branding
+  result = api_instance.update_report_branding(workspace_uuid, report_branding_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->update_report_branding: #{e}"
+end
+```
+
+#### Using the update_report_branding_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetReportBranding200Response>, Integer, Hash)> update_report_branding_with_http_info(workspace_uuid, report_branding_input)
+
+```ruby
+begin
+  # Update the report branding
+  data, status_code, headers = api_instance.update_report_branding_with_http_info(workspace_uuid, report_branding_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetReportBranding200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->update_report_branding_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **report_branding_input** | [**ReportBrandingInput**](ReportBrandingInput.md) |  |  |
+
+### Return type
+
+[**GetReportBranding200Response**](GetReportBranding200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## upload_report_branding_logo
+
+> <GetReportBranding200Response> upload_report_branding_logo(workspace_uuid, logo)
+
+Upload the report logo
+
+PNG or JPEG, up to 1 MB (SVG is not accepted). Replaces the current logo. Admins and members only.
+
+### 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::AnalyticsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+logo = File.new('/path/to/some/file') # File | 
+
+begin
+  # Upload the report logo
+  result = api_instance.upload_report_branding_logo(workspace_uuid, logo)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->upload_report_branding_logo: #{e}"
+end
+```
+
+#### Using the upload_report_branding_logo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetReportBranding200Response>, Integer, Hash)> upload_report_branding_logo_with_http_info(workspace_uuid, logo)
+
+```ruby
+begin
+  # Upload the report logo
+  data, status_code, headers = api_instance.upload_report_branding_logo_with_http_info(workspace_uuid, logo)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetReportBranding200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AnalyticsApi->upload_report_branding_logo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **logo** | **File** |  |  |
+
+### Return type
+
+[**GetReportBranding200Response**](GetReportBranding200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/ApiActivity.md

@@ -0,0 +1,36 @@
+# PostBoost::ApiActivity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **user_id** | **Integer** |  | [optional] |
+| **token_ref** | **String** | First 12 hex characters of the SHA-256 of the API token used, to tell tokens apart. | [optional] |
+| **client** | **String** | `X-PostBoost-Client` header, else the `User-Agent`. | [optional] |
+| **route_name** | **String** |  | [optional] |
+| **method** | **String** |  |  |
+| **post_uuid** | **String** |  | [optional] |
+| **outcome** | [**ApiActivityOutcome**](ApiActivityOutcome.md) |  |  |
+| **http_status** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ApiActivity.new(
+  id: null,
+  user_id: null,
+  token_ref: null,
+  client: null,
+  route_name: null,
+  method: null,
+  post_uuid: null,
+  outcome: null,
+  http_status: null,
+  created_at: null
+)
+```
+

data/docs/ApiActivityOutcome.md

@@ -0,0 +1,15 @@
+# PostBoost::ApiActivityOutcome
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ApiActivityOutcome.new()
+```
+

data/docs/ApiKey.md

@@ -0,0 +1,32 @@
+# PostBoost::ApiKey
+
+## 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] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ApiKey.new(
+  id: null,
+  name: null,
+  abilities: null,
+  account_ids: null,
+  created_by: null,
+  last_used_at: null,
+  expires_at: null,
+  created_at: null
+)
+```
+

data/docs/ApiKeyAbility.md

@@ -0,0 +1,15 @@
+# PostBoost::ApiKeyAbility
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ApiKeyAbility.new()
+```
+

data/docs/ApiKeyInput.md

@@ -0,0 +1,24 @@
+# PostBoost::ApiKeyInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **abilities** | [**Array<ApiKeyAbility>**](ApiKeyAbility.md) |  |  |
+| **account_ids** | **Array<Integer>** | Limit the key to these account ids of the workspace. Omit or null for every account. A limited key must send `account_ids` on recycling rules, report exports and AI drafts, and its lists show only its accounts. | [optional] |
+| **expires_at** | **Date** | Last day the key works. Must be after today. Omit for no expiry. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ApiKeyInput.new(
+  name: null,
+  abilities: null,
+  account_ids: null,
+  expires_at: null
+)
+```
+

data/docs/ApproveAgentProposal200Response.md

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

data/docs/ApproveAgentProposal409Response.md

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

data/docs/ApproveInboxReplyDraft403Response.md

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