postboost 1.0.0 → 1.14.0

data/lib/postboost/api/accounts_api.rb

@@ -1,9 +1,9 @@
 =begin
 #PostBoost API
 
-#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 8+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.14.0
 Contact: hi@postboost.co
 Generated by: https://openapi-generator.tech
 Generator version: 7.9.0
@@ -19,6 +19,160 @@ module PostBoost
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # 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. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param provider [String] 
+    # @param connect_channel_input [ConnectChannelInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelAccount]
+    def connect_channel(workspace_uuid, provider, connect_channel_input, opts = {})
+      data, _status_code, _headers = connect_channel_with_http_info(workspace_uuid, provider, connect_channel_input, opts)
+      data
+    end
+
+    # 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. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param provider [String] 
+    # @param connect_channel_input [ConnectChannelInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelAccount, Integer, Hash)>] ChannelAccount data, response status code and response headers
+    def connect_channel_with_http_info(workspace_uuid, provider, connect_channel_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.connect_channel ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling AccountsApi.connect_channel"
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AccountsApi.connect_channel"
+      end
+      # verify enum value
+      allowable_values = ["telegram", "discord", "slack"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(provider)
+        fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'connect_channel_input' is set
+      if @api_client.config.client_side_validation && connect_channel_input.nil?
+        fail ArgumentError, "Missing the required parameter 'connect_channel_input' when calling AccountsApi.connect_channel"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/accounts/connect/{provider}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(connect_channel_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ChannelAccount'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.connect_channel",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#connect_channel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_uuid [String] UUID of the social media account.
+    # @param [Hash] opts the optional parameters
+    # @return [ReconnectLink]
+    def create_reconnect_link(workspace_uuid, account_uuid, opts = {})
+      data, _status_code, _headers = create_reconnect_link_with_http_info(workspace_uuid, account_uuid, opts)
+      data
+    end
+
+    # Create a reconnect link
+    # Creates a single-use link (valid 7 days) that lets someone without a PostBoost login, such as an agency&#39;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 &#x60;404&#x60; while the feature is not enabled on this instance. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_uuid [String] UUID of the social media account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReconnectLink, Integer, Hash)>] ReconnectLink data, response status code and response headers
+    def create_reconnect_link_with_http_info(workspace_uuid, account_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.create_reconnect_link ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling AccountsApi.create_reconnect_link"
+      end
+      # verify the required parameter 'account_uuid' is set
+      if @api_client.config.client_side_validation && account_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_uuid' when calling AccountsApi.create_reconnect_link"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/accounts/{accountUuid}/reconnect-links'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'accountUuid' + '}', CGI.escape(account_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReconnectLink'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.create_reconnect_link",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#create_reconnect_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get account
     # Returns a single social media account.
     # @param workspace_uuid [String] UUID of the workspace.
@@ -88,10 +242,77 @@ module PostBoost
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [GetAccountHealth200Response]
+    def get_account_health(workspace_uuid, opts = {})
+      data, _status_code, _headers = get_account_health_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # 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 &#x60;account.token_expiring&#x60; and &#x60;account.disconnected&#x60; webhooks report changes as they happen. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAccountHealth200Response, Integer, Hash)>] GetAccountHealth200Response data, response status code and response headers
+    def get_account_health_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_health ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling AccountsApi.get_account_health"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-health'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAccountHealth200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.get_account_health",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_account_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List accounts
-    # Returns all social media accounts connected to the workspace.
+    # Returns all social media accounts connected to the workspace, newest first. Optional filters narrow the list.
     # @param workspace_uuid [String] UUID of the workspace.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :keyword Match the account name or username.
+    # @option opts [String] :group Only accounts in this account group.
+    # @option opts [Array<String>] :providers Only accounts of these providers (for example &#x60;instagram&#x60;, &#x60;linkedin&#x60;).
+    # @option opts [Boolean] :unauthorized When &#x60;true&#x60;, only accounts that need to be reconnected.
     # @return [ListAccounts200Response]
     def list_accounts(workspace_uuid, opts = {})
       data, _status_code, _headers = list_accounts_with_http_info(workspace_uuid, opts)
@@ -99,9 +320,13 @@ module PostBoost
     end
 
     # List accounts
-    # Returns all social media accounts connected to the workspace.
+    # Returns all social media accounts connected to the workspace, newest first. Optional filters narrow the list.
     # @param workspace_uuid [String] UUID of the workspace.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :keyword Match the account name or username.
+    # @option opts [String] :group Only accounts in this account group.
+    # @option opts [Array<String>] :providers Only accounts of these providers (for example &#x60;instagram&#x60;, &#x60;linkedin&#x60;).
+    # @option opts [Boolean] :unauthorized When &#x60;true&#x60;, only accounts that need to be reconnected.
     # @return [Array<(ListAccounts200Response, Integer, Hash)>] ListAccounts200Response data, response status code and response headers
     def list_accounts_with_http_info(workspace_uuid, opts = {})
       if @api_client.config.debugging
@@ -116,6 +341,10 @@ module PostBoost
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
+      query_params[:'group'] = opts[:'group'] if !opts[:'group'].nil?
+      query_params[:'providers[]'] = @api_client.build_collection_param(opts[:'providers'], :multi) if !opts[:'providers'].nil?
+      query_params[:'unauthorized'] = opts[:'unauthorized'] if !opts[:'unauthorized'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/postboost/api/activity_api.rb

@@ -0,0 +1,97 @@
+=begin
+#PostBoost API
+
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+
+The version of the OpenAPI document: 1.14.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module PostBoost
+  class ActivityApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List API activity
+    # Every write request (`POST`, `PUT`, `DELETE`) made through the API in this workspace, newest first, with the client that made it and its outcome. Kept for 90 days. Send an `X-PostBoost-Client` header (for example `my-agent/1.2`) to label your requests; otherwise the `User-Agent` is recorded. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiActivityOutcome] :outcome 
+    # @option opts [String] :client Client label prefix, for example `mcp`.
+    # @option opts [Time] :since Only entries at or after this time (UTC).
+    # @option opts [Integer] :page  (default to 1)
+    # @return [ListApiActivity200Response]
+    def list_api_activity(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_api_activity_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List API activity
+    # Every write request (`POST`, `PUT`, `DELETE`) made through the API in this workspace, newest first, with the client that made it and its outcome. Kept for 90 days. Send an `X-PostBoost-Client` header (for example `my-agent/1.2`) to label your requests; otherwise the `User-Agent` is recorded. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiActivityOutcome] :outcome 
+    # @option opts [String] :client Client label prefix, for example `mcp`.
+    # @option opts [Time] :since Only entries at or after this time (UTC).
+    # @option opts [Integer] :page  (default to 1)
+    # @return [Array<(ListApiActivity200Response, Integer, Hash)>] ListApiActivity200Response data, response status code and response headers
+    def list_api_activity_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActivityApi.list_api_activity ...'
+      end
+      # verify the required parameter 'workspace_uuid' is set
+      if @api_client.config.client_side_validation && workspace_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling ActivityApi.list_api_activity"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/activity'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'outcome'] = opts[:'outcome'] if !opts[:'outcome'].nil?
+      query_params[:'client'] = opts[:'client'] if !opts[:'client'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListApiActivity200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ActivityApi.list_api_activity",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActivityApi#list_api_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end