postboost 1.8.0 → 1.14.0

data/lib/postboost/api/webhooks_api.rb

@@ -0,0 +1,228 @@
+=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 WebhooksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Subscribe a webhook
+    # Registers a callback URL for the given events, the way n8n, Zapier and Make instant triggers do. Deliveries are `POST` requests with a JSON body (see [Webhooks](/webhooks) for the payload), signed with the returned `secret` in `X-Signature` (HMAC-SHA256 of the raw body, hex encoded) and attempted up to 3 times. Only public `https://` URLs are accepted. The `secret` is in this response only. Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param webhook_subscription_input [WebhookSubscriptionInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWebhookSubscription201Response]
+    def create_webhook_subscription(workspace_uuid, webhook_subscription_input, opts = {})
+      data, _status_code, _headers = create_webhook_subscription_with_http_info(workspace_uuid, webhook_subscription_input, opts)
+      data
+    end
+
+    # Subscribe a webhook
+    # Registers a callback URL for the given events, the way n8n, Zapier and Make instant triggers do. Deliveries are `POST` requests with a JSON body (see [Webhooks](/webhooks) for the payload), signed with the returned `secret` in `X-Signature` (HMAC-SHA256 of the raw body, hex encoded) and attempted up to 3 times. Only public `https://` URLs are accepted. The `secret` is in this response only. Workspace admins only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param webhook_subscription_input [WebhookSubscriptionInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWebhookSubscription201Response, Integer, Hash)>] CreateWebhookSubscription201Response data, response status code and response headers
+    def create_webhook_subscription_with_http_info(workspace_uuid, webhook_subscription_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook_subscription ...'
+      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 WebhooksApi.create_webhook_subscription"
+      end
+      # verify the required parameter 'webhook_subscription_input' is set
+      if @api_client.config.client_side_validation && webhook_subscription_input.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_subscription_input' when calling WebhooksApi.create_webhook_subscription"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/webhooks/subscriptions'.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']
+      # 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(webhook_subscription_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWebhookSubscription201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.create_webhook_subscription",
+        :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: WebhooksApi#create_webhook_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unsubscribe a webhook
+    # Deletes the webhook and stops its deliveries. Workspace admins only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param subscription_uuid [String] UUID of the webhook subscription.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def delete_webhook_subscription(workspace_uuid, subscription_uuid, opts = {})
+      data, _status_code, _headers = delete_webhook_subscription_with_http_info(workspace_uuid, subscription_uuid, opts)
+      data
+    end
+
+    # Unsubscribe a webhook
+    # Deletes the webhook and stops its deliveries. Workspace admins only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param subscription_uuid [String] UUID of the webhook subscription.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def delete_webhook_subscription_with_http_info(workspace_uuid, subscription_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook_subscription ...'
+      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 WebhooksApi.delete_webhook_subscription"
+      end
+      # verify the required parameter 'subscription_uuid' is set
+      if @api_client.config.client_side_validation && subscription_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_uuid' when calling WebhooksApi.delete_webhook_subscription"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/webhooks/subscriptions/{subscriptionUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'subscriptionUuid' + '}', CGI.escape(subscription_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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.delete_webhook_subscription",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#delete_webhook_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List webhook subscriptions
+    # The workspace's webhooks, newest first: subscriptions created through this API and the ones added in **Settings → Webhooks**. Secrets are never returned here. Workspace admins only; needs the `webhooks` plan capability and, for scoped keys, the `webhooks` ability. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [ListWebhookSubscriptions200Response]
+    def list_webhook_subscriptions(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_webhook_subscriptions_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List webhook subscriptions
+    # The workspace&#39;s webhooks, newest first: subscriptions created through this API and the ones added in **Settings → Webhooks**. Secrets are never returned here. Workspace admins only; needs the &#x60;webhooks&#x60; plan capability and, for scoped keys, the &#x60;webhooks&#x60; ability. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListWebhookSubscriptions200Response, Integer, Hash)>] ListWebhookSubscriptions200Response data, response status code and response headers
+    def list_webhook_subscriptions_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhook_subscriptions ...'
+      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 WebhooksApi.list_webhook_subscriptions"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/webhooks/subscriptions'.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] || 'ListWebhookSubscriptions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.list_webhook_subscriptions",
+        :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: WebhooksApi#list_webhook_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end