postboost 1.0.0 → 1.14.0

data/lib/postboost/api/agents_api.rb

@@ -0,0 +1,771 @@
+=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 AgentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Approve and apply an agent proposal
+    # Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption. When the post was edited, deleted or left the schedule since the proposal was made, nothing changes and the proposal becomes `stale`. Admins and members only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param proposal_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [AgentProposalDecision] :agent_proposal_decision 
+    # @return [ApproveAgentProposal200Response]
+    def approve_agent_proposal(workspace_uuid, proposal_uuid, opts = {})
+      data, _status_code, _headers = approve_agent_proposal_with_http_info(workspace_uuid, proposal_uuid, opts)
+      data
+    end
+
+    # Approve and apply an agent proposal
+    # Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption. When the post was edited, deleted or left the schedule since the proposal was made, nothing changes and the proposal becomes `stale`. Admins and members only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param proposal_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [AgentProposalDecision] :agent_proposal_decision 
+    # @return [Array<(ApproveAgentProposal200Response, Integer, Hash)>] ApproveAgentProposal200Response data, response status code and response headers
+    def approve_agent_proposal_with_http_info(workspace_uuid, proposal_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.approve_agent_proposal ...'
+      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 AgentsApi.approve_agent_proposal"
+      end
+      # verify the required parameter 'proposal_uuid' is set
+      if @api_client.config.client_side_validation && proposal_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'proposal_uuid' when calling AgentsApi.approve_agent_proposal"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agent-proposals/{proposalUuid}/approve'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'proposalUuid' + '}', CGI.escape(proposal_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(opts[:'agent_proposal_decision'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApproveAgentProposal200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.approve_agent_proposal",
+        :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: AgentsApi#approve_agent_proposal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Switch on a background agent
+    # Creates an agent (one per type per workspace). It first runs within five minutes, then on its `schedule`. **Pre-publish checker** looks at posts scheduled in the next `horizon_hours` and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop `banned_phrases`. With `ai_review: true` it also asks AI to review up to `max_ai_reviews_per_run` posts per run (one AI credit each). Admins and members only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param workspace_agent_input [WorkspaceAgentInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAgent201Response]
+    def create_agent(workspace_uuid, workspace_agent_input, opts = {})
+      data, _status_code, _headers = create_agent_with_http_info(workspace_uuid, workspace_agent_input, opts)
+      data
+    end
+
+    # Switch on a background agent
+    # Creates an agent (one per type per workspace). It first runs within five minutes, then on its &#x60;schedule&#x60;. **Pre-publish checker** looks at posts scheduled in the next &#x60;horizon_hours&#x60; and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop &#x60;banned_phrases&#x60;. With &#x60;ai_review: true&#x60; it also asks AI to review up to &#x60;max_ai_reviews_per_run&#x60; posts per run (one AI credit each). Admins and members only. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param workspace_agent_input [WorkspaceAgentInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAgent201Response, Integer, Hash)>] CreateAgent201Response data, response status code and response headers
+    def create_agent_with_http_info(workspace_uuid, workspace_agent_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.create_agent ...'
+      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 AgentsApi.create_agent"
+      end
+      # verify the required parameter 'workspace_agent_input' is set
+      if @api_client.config.client_side_validation && workspace_agent_input.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_agent_input' when calling AgentsApi.create_agent"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents'.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(workspace_agent_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAgent201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.create_agent",
+        :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: AgentsApi#create_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a background agent
+    # Removes the agent. Its run history and proposals stay. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteAgent200Response]
+    def delete_agent(workspace_uuid, agent_uuid, opts = {})
+      data, _status_code, _headers = delete_agent_with_http_info(workspace_uuid, agent_uuid, opts)
+      data
+    end
+
+    # Delete a background agent
+    # Removes the agent. Its run history and proposals stay. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteAgent200Response, Integer, Hash)>] DeleteAgent200Response data, response status code and response headers
+    def delete_agent_with_http_info(workspace_uuid, agent_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.delete_agent ...'
+      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 AgentsApi.delete_agent"
+      end
+      # verify the required parameter 'agent_uuid' is set
+      if @api_client.config.client_side_validation && agent_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'agent_uuid' when calling AgentsApi.delete_agent"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents/{agentUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'agentUuid' + '}', CGI.escape(agent_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] || 'DeleteAgent200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.delete_agent",
+        :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: AgentsApi#delete_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an agent run with its proposals
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param run_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [RunAgent202Response]
+    def get_agent_run(workspace_uuid, run_uuid, opts = {})
+      data, _status_code, _headers = get_agent_run_with_http_info(workspace_uuid, run_uuid, opts)
+      data
+    end
+
+    # Get an agent run with its proposals
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param run_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RunAgent202Response, Integer, Hash)>] RunAgent202Response data, response status code and response headers
+    def get_agent_run_with_http_info(workspace_uuid, run_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.get_agent_run ...'
+      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 AgentsApi.get_agent_run"
+      end
+      # verify the required parameter 'run_uuid' is set
+      if @api_client.config.client_side_validation && run_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'run_uuid' when calling AgentsApi.get_agent_run"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agent-runs/{runUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'runUuid' + '}', CGI.escape(run_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] || 'RunAgent202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.get_agent_run",
+        :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: AgentsApi#get_agent_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List agent proposals (approval queue)
+    # Proposals of all agents in the workspace, newest first. Defaults to `pending`.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status  (default to 'pending')
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [Integer] :page 
+    # @return [ListAgentProposals200Response]
+    def list_agent_proposals(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_agent_proposals_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List agent proposals (approval queue)
+    # Proposals of all agents in the workspace, newest first. Defaults to &#x60;pending&#x60;.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status  (default to 'pending')
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [Integer] :page 
+    # @return [Array<(ListAgentProposals200Response, Integer, Hash)>] ListAgentProposals200Response data, response status code and response headers
+    def list_agent_proposals_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.list_agent_proposals ...'
+      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 AgentsApi.list_agent_proposals"
+      end
+      allowable_values = ["pending", "applied", "rejected", "stale", "failed", "expired"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      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 AgentsApi.list_agent_proposals, 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 AgentsApi.list_agent_proposals, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AgentsApi.list_agent_proposals, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/agent-proposals'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'ListAgentProposals200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.list_agent_proposals",
+        :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: AgentsApi#list_agent_proposals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Run history of an agent
+    # Runs of the agent, newest first, with what each checked and proposed and the AI credits it used.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [Integer] :page 
+    # @return [ListAgentRuns200Response]
+    def list_agent_runs(workspace_uuid, agent_uuid, opts = {})
+      data, _status_code, _headers = list_agent_runs_with_http_info(workspace_uuid, agent_uuid, opts)
+      data
+    end
+
+    # Run history of an agent
+    # Runs of the agent, newest first, with what each checked and proposed and the AI credits it used.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [Integer] :page 
+    # @return [Array<(ListAgentRuns200Response, Integer, Hash)>] ListAgentRuns200Response data, response status code and response headers
+    def list_agent_runs_with_http_info(workspace_uuid, agent_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.list_agent_runs ...'
+      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 AgentsApi.list_agent_runs"
+      end
+      # verify the required parameter 'agent_uuid' is set
+      if @api_client.config.client_side_validation && agent_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'agent_uuid' when calling AgentsApi.list_agent_runs"
+      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 AgentsApi.list_agent_runs, 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 AgentsApi.list_agent_runs, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AgentsApi.list_agent_runs, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents/{agentUuid}/runs'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'agentUuid' + '}', CGI.escape(agent_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'ListAgentRuns200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.list_agent_runs",
+        :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: AgentsApi#list_agent_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List background agents
+    # Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available type: `pre_publish_checker`. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [ListAgents200Response]
+    def list_agents(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_agents_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List background agents
+    # Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available type: &#x60;pre_publish_checker&#x60;. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListAgents200Response, Integer, Hash)>] ListAgents200Response data, response status code and response headers
+    def list_agents_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.list_agents ...'
+      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 AgentsApi.list_agents"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents'.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] || 'ListAgents200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.list_agents",
+        :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: AgentsApi#list_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reject an agent proposal
+    # Records the rejection (and optional note); nothing changes on the post. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param proposal_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [AgentProposalDecision] :agent_proposal_decision 
+    # @return [ApproveAgentProposal200Response]
+    def reject_agent_proposal(workspace_uuid, proposal_uuid, opts = {})
+      data, _status_code, _headers = reject_agent_proposal_with_http_info(workspace_uuid, proposal_uuid, opts)
+      data
+    end
+
+    # Reject an agent proposal
+    # Records the rejection (and optional note); nothing changes on the post. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param proposal_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [AgentProposalDecision] :agent_proposal_decision 
+    # @return [Array<(ApproveAgentProposal200Response, Integer, Hash)>] ApproveAgentProposal200Response data, response status code and response headers
+    def reject_agent_proposal_with_http_info(workspace_uuid, proposal_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.reject_agent_proposal ...'
+      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 AgentsApi.reject_agent_proposal"
+      end
+      # verify the required parameter 'proposal_uuid' is set
+      if @api_client.config.client_side_validation && proposal_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'proposal_uuid' when calling AgentsApi.reject_agent_proposal"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agent-proposals/{proposalUuid}/reject'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'proposalUuid' + '}', CGI.escape(proposal_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(opts[:'agent_proposal_decision'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApproveAgentProposal200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.reject_agent_proposal",
+        :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: AgentsApi#reject_agent_proposal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Run a background agent now
+    # Queues a run outside the schedule (`trigger: manual`). Six per hour. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [RunAgent202Response]
+    def run_agent(workspace_uuid, agent_uuid, opts = {})
+      data, _status_code, _headers = run_agent_with_http_info(workspace_uuid, agent_uuid, opts)
+      data
+    end
+
+    # Run a background agent now
+    # Queues a run outside the schedule (&#x60;trigger: manual&#x60;). Six per hour. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RunAgent202Response, Integer, Hash)>] RunAgent202Response data, response status code and response headers
+    def run_agent_with_http_info(workspace_uuid, agent_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.run_agent ...'
+      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 AgentsApi.run_agent"
+      end
+      # verify the required parameter 'agent_uuid' is set
+      if @api_client.config.client_side_validation && agent_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'agent_uuid' when calling AgentsApi.run_agent"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents/{agentUuid}/run'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'agentUuid' + '}', CGI.escape(agent_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] || 'RunAgent202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.run_agent",
+        :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: AgentsApi#run_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a background agent
+    # Changes the name, schedule, settings or `enabled`. Settings you leave out keep their value. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param workspace_agent_update [WorkspaceAgentUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAgent201Response]
+    def update_agent(workspace_uuid, agent_uuid, workspace_agent_update, opts = {})
+      data, _status_code, _headers = update_agent_with_http_info(workspace_uuid, agent_uuid, workspace_agent_update, opts)
+      data
+    end
+
+    # Update a background agent
+    # Changes the name, schedule, settings or &#x60;enabled&#x60;. Settings you leave out keep their value. Admins and members only.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param agent_uuid [String] 
+    # @param workspace_agent_update [WorkspaceAgentUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAgent201Response, Integer, Hash)>] CreateAgent201Response data, response status code and response headers
+    def update_agent_with_http_info(workspace_uuid, agent_uuid, workspace_agent_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.update_agent ...'
+      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 AgentsApi.update_agent"
+      end
+      # verify the required parameter 'agent_uuid' is set
+      if @api_client.config.client_side_validation && agent_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'agent_uuid' when calling AgentsApi.update_agent"
+      end
+      # verify the required parameter 'workspace_agent_update' is set
+      if @api_client.config.client_side_validation && workspace_agent_update.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_agent_update' when calling AgentsApi.update_agent"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/agents/{agentUuid}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'agentUuid' + '}', CGI.escape(agent_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(workspace_agent_update)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAgent201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.update_agent",
+        :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: AgentsApi#update_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end