postboost 1.0.0 → 1.14.0

data/docs/XUsageCounter.md

@@ -0,0 +1,20 @@
+# PostBoost::XUsageCounter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **used** | **Integer** |  |  |
+| **limit** | **Integer** | Monthly allowance; null = unlimited. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::XUsageCounter.new(
+  used: null,
+  limit: null
+)
+```
+

data/lib/postboost/api/account_groups_api.rb

@@ -0,0 +1,395 @@
+=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 AccountGroupsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an account group
+    # Creates a named set of accounts of this workspace. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_input [AccountGroupInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAccountGroup201Response]
+    def create_account_group(workspace_uuid, account_group_input, opts = {})
+      data, _status_code, _headers = create_account_group_with_http_info(workspace_uuid, account_group_input, opts)
+      data
+    end
+
+    # Create an account group
+    # Creates a named set of accounts of this workspace. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_input [AccountGroupInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAccountGroup201Response, Integer, Hash)>] CreateAccountGroup201Response data, response status code and response headers
+    def create_account_group_with_http_info(workspace_uuid, account_group_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountGroupsApi.create_account_group ...'
+      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 AccountGroupsApi.create_account_group"
+      end
+      # verify the required parameter 'account_group_input' is set
+      if @api_client.config.client_side_validation && account_group_input.nil?
+        fail ArgumentError, "Missing the required parameter 'account_group_input' when calling AccountGroupsApi.create_account_group"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-groups'.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(account_group_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAccountGroup201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountGroupsApi.create_account_group",
+        :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: AccountGroupsApi#create_account_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an account group
+    # Deletes the group, not its accounts. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_account_group(workspace_uuid, account_group_uuid, opts = {})
+      delete_account_group_with_http_info(workspace_uuid, account_group_uuid, opts)
+      nil
+    end
+
+    # Delete an account group
+    # Deletes the group, not its accounts. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_account_group_with_http_info(workspace_uuid, account_group_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountGroupsApi.delete_account_group ...'
+      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 AccountGroupsApi.delete_account_group"
+      end
+      # verify the required parameter 'account_group_uuid' is set
+      if @api_client.config.client_side_validation && account_group_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_group_uuid' when calling AccountGroupsApi.delete_account_group"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-groups/{accountGroupUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'accountGroupUuid' + '}', CGI.escape(account_group_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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountGroupsApi.delete_account_group",
+        :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: AccountGroupsApi#delete_account_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an account group
+    # One account group. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAccountGroup201Response]
+    def get_account_group(workspace_uuid, account_group_uuid, opts = {})
+      data, _status_code, _headers = get_account_group_with_http_info(workspace_uuid, account_group_uuid, opts)
+      data
+    end
+
+    # Get an account group
+    # One account group. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAccountGroup201Response, Integer, Hash)>] CreateAccountGroup201Response data, response status code and response headers
+    def get_account_group_with_http_info(workspace_uuid, account_group_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountGroupsApi.get_account_group ...'
+      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 AccountGroupsApi.get_account_group"
+      end
+      # verify the required parameter 'account_group_uuid' is set
+      if @api_client.config.client_side_validation && account_group_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_group_uuid' when calling AccountGroupsApi.get_account_group"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-groups/{accountGroupUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'accountGroupUuid' + '}', CGI.escape(account_group_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] || 'CreateAccountGroup201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountGroupsApi.get_account_group",
+        :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: AccountGroupsApi#get_account_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List account groups
+    # Named sets of accounts, sorted by name, with their account ids. Pass `account_ids` as `accounts` when you create a post to publish to the whole group. Paginated with `page` and `per_page` (default 100). A key limited to some accounts only sees groups whose accounts are all among its accounts, and `meta.total` counts only those. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Items per page, 1-100. (default to 100)
+    # @return [ListAccountGroups200Response]
+    def list_account_groups(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_account_groups_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List account groups
+    # Named sets of accounts, sorted by name, with their account ids. Pass &#x60;account_ids&#x60; as &#x60;accounts&#x60; when you create a post to publish to the whole group. Paginated with &#x60;page&#x60; and &#x60;per_page&#x60; (default 100). A key limited to some accounts only sees groups whose accounts are all among its accounts, and &#x60;meta.total&#x60; counts only those. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Items per page, 1-100. (default to 100)
+    # @return [Array<(ListAccountGroups200Response, Integer, Hash)>] ListAccountGroups200Response data, response status code and response headers
+    def list_account_groups_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountGroupsApi.list_account_groups ...'
+      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 AccountGroupsApi.list_account_groups"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountGroupsApi.list_account_groups, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AccountGroupsApi.list_account_groups, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AccountGroupsApi.list_account_groups, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-groups'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_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] || 'ListAccountGroups200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountGroupsApi.list_account_groups",
+        :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: AccountGroupsApi#list_account_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an account group
+    # Replaces the name and the accounts of the group (accounts you leave out are removed). Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param account_group_input [AccountGroupInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAccountGroup201Response]
+    def update_account_group(workspace_uuid, account_group_uuid, account_group_input, opts = {})
+      data, _status_code, _headers = update_account_group_with_http_info(workspace_uuid, account_group_uuid, account_group_input, opts)
+      data
+    end
+
+    # Update an account group
+    # Replaces the name and the accounts of the group (accounts you leave out are removed). Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param account_group_uuid [String] The account group &#x60;uuid&#x60;.
+    # @param account_group_input [AccountGroupInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAccountGroup201Response, Integer, Hash)>] CreateAccountGroup201Response data, response status code and response headers
+    def update_account_group_with_http_info(workspace_uuid, account_group_uuid, account_group_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountGroupsApi.update_account_group ...'
+      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 AccountGroupsApi.update_account_group"
+      end
+      # verify the required parameter 'account_group_uuid' is set
+      if @api_client.config.client_side_validation && account_group_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_group_uuid' when calling AccountGroupsApi.update_account_group"
+      end
+      # verify the required parameter 'account_group_input' is set
+      if @api_client.config.client_side_validation && account_group_input.nil?
+        fail ArgumentError, "Missing the required parameter 'account_group_input' when calling AccountGroupsApi.update_account_group"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/account-groups/{accountGroupUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'accountGroupUuid' + '}', CGI.escape(account_group_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(account_group_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAccountGroup201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountGroupsApi.update_account_group",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountGroupsApi#update_account_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end