postboost 1.0.0 → 1.14.0

data/lib/postboost/api/competitors_api.rb

@@ -0,0 +1,300 @@
+=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 CompetitorsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Track a competitor
+    # Starts tracking a public Instagram business or creator account from one of your Instagram accounts (connected through a Facebook Page). Returns `202` at once; followers, snapshots and recent media appear after the background import. `409` if that account already tracks the username. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_input [CompetitorInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [AddCompetitor202Response]
+    def add_competitor(workspace_uuid, competitor_input, opts = {})
+      data, _status_code, _headers = add_competitor_with_http_info(workspace_uuid, competitor_input, opts)
+      data
+    end
+
+    # Track a competitor
+    # Starts tracking a public Instagram business or creator account from one of your Instagram accounts (connected through a Facebook Page). Returns `202` at once; followers, snapshots and recent media appear after the background import. `409` if that account already tracks the username. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_input [CompetitorInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AddCompetitor202Response, Integer, Hash)>] AddCompetitor202Response data, response status code and response headers
+    def add_competitor_with_http_info(workspace_uuid, competitor_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompetitorsApi.add_competitor ...'
+      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 CompetitorsApi.add_competitor"
+      end
+      # verify the required parameter 'competitor_input' is set
+      if @api_client.config.client_side_validation && competitor_input.nil?
+        fail ArgumentError, "Missing the required parameter 'competitor_input' when calling CompetitorsApi.add_competitor"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/competitors'.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(competitor_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AddCompetitor202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompetitorsApi.add_competitor",
+        :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: CompetitorsApi#add_competitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stop tracking a competitor
+    # Deletes the competitor with its snapshots and media. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_id [Integer] The competitor &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_competitor(workspace_uuid, competitor_id, opts = {})
+      delete_competitor_with_http_info(workspace_uuid, competitor_id, opts)
+      nil
+    end
+
+    # Stop tracking a competitor
+    # Deletes the competitor with its snapshots and media. Admins and members only (not viewers). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_id [Integer] The competitor &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_competitor_with_http_info(workspace_uuid, competitor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompetitorsApi.delete_competitor ...'
+      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 CompetitorsApi.delete_competitor"
+      end
+      # verify the required parameter 'competitor_id' is set
+      if @api_client.config.client_side_validation && competitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'competitor_id' when calling CompetitorsApi.delete_competitor"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/competitors/{competitorId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'competitorId' + '}', CGI.escape(competitor_id.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 => :"CompetitorsApi.delete_competitor",
+        :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: CompetitorsApi#delete_competitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a competitor
+    # The competitor with daily follower snapshots for the last 90 days and its 12 most recent posts. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_id [Integer] The competitor &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [GetCompetitor200Response]
+    def get_competitor(workspace_uuid, competitor_id, opts = {})
+      data, _status_code, _headers = get_competitor_with_http_info(workspace_uuid, competitor_id, opts)
+      data
+    end
+
+    # Get a competitor
+    # The competitor with daily follower snapshots for the last 90 days and its 12 most recent posts. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param competitor_id [Integer] The competitor &#x60;id&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCompetitor200Response, Integer, Hash)>] GetCompetitor200Response data, response status code and response headers
+    def get_competitor_with_http_info(workspace_uuid, competitor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompetitorsApi.get_competitor ...'
+      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 CompetitorsApi.get_competitor"
+      end
+      # verify the required parameter 'competitor_id' is set
+      if @api_client.config.client_side_validation && competitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'competitor_id' when calling CompetitorsApi.get_competitor"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/competitors/{competitorId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'competitorId' + '}', CGI.escape(competitor_id.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] || 'GetCompetitor200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompetitorsApi.get_competitor",
+        :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: CompetitorsApi#get_competitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List competitors
+    # Instagram business or creator accounts the workspace tracks, by follower count. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id Only competitors tracked from this Instagram account &#x60;id&#x60;.
+    # @return [ListCompetitors200Response]
+    def list_competitors(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_competitors_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List competitors
+    # Instagram business or creator accounts the workspace tracks, by follower count. 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id Only competitors tracked from this Instagram account &#x60;id&#x60;.
+    # @return [Array<(ListCompetitors200Response, Integer, Hash)>] ListCompetitors200Response data, response status code and response headers
+    def list_competitors_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompetitorsApi.list_competitors ...'
+      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 CompetitorsApi.list_competitors"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/competitors'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].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] || 'ListCompetitors200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompetitorsApi.list_competitors",
+        :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: CompetitorsApi#list_competitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end