postboost 1.0.0 → 1.14.0

data/lib/postboost/api/mentions_api.rb

@@ -0,0 +1,397 @@
+=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 MentionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create mention
+    # Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_input [MentionInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+    # @return [CreateMention201Response]
+    def create_mention(workspace_uuid, mention_input, opts = {})
+      data, _status_code, _headers = create_mention_with_http_info(workspace_uuid, mention_input, opts)
+      data
+    end
+
+    # Create mention
+    # Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`). 
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_input [MentionInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+    # @return [Array<(CreateMention201Response, Integer, Hash)>] CreateMention201Response data, response status code and response headers
+    def create_mention_with_http_info(workspace_uuid, mention_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MentionsApi.create_mention ...'
+      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 MentionsApi.create_mention"
+      end
+      # verify the required parameter 'mention_input' is set
+      if @api_client.config.client_side_validation && mention_input.nil?
+        fail ArgumentError, "Missing the required parameter 'mention_input' when calling MentionsApi.create_mention"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MentionsApi.create_mention, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MentionsApi.create_mention, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/{workspaceUuid}/mentions'.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
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mention_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateMention201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MentionsApi.create_mention",
+        :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: MentionsApi#create_mention\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete mention
+    # Removes a mention from the mention book. `success` is false when nothing was deleted.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def delete_mention(workspace_uuid, mention_id, opts = {})
+      data, _status_code, _headers = delete_mention_with_http_info(workspace_uuid, mention_id, opts)
+      data
+    end
+
+    # Delete mention
+    # Removes a mention from the mention book. &#x60;success&#x60; is false when nothing was deleted.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def delete_mention_with_http_info(workspace_uuid, mention_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MentionsApi.delete_mention ...'
+      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 MentionsApi.delete_mention"
+      end
+      # verify the required parameter 'mention_id' is set
+      if @api_client.config.client_side_validation && mention_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mention_id' when calling MentionsApi.delete_mention"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/mentions/{mentionId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'mentionId' + '}', CGI.escape(mention_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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MentionsApi.delete_mention",
+        :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: MentionsApi#delete_mention\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get mention
+    # Returns a single mention with its identities.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param [Hash] opts the optional parameters
+    # @return [CreateMention201Response]
+    def get_mention(workspace_uuid, mention_id, opts = {})
+      data, _status_code, _headers = get_mention_with_http_info(workspace_uuid, mention_id, opts)
+      data
+    end
+
+    # Get mention
+    # Returns a single mention with its identities.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateMention201Response, Integer, Hash)>] CreateMention201Response data, response status code and response headers
+    def get_mention_with_http_info(workspace_uuid, mention_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MentionsApi.get_mention ...'
+      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 MentionsApi.get_mention"
+      end
+      # verify the required parameter 'mention_id' is set
+      if @api_client.config.client_side_validation && mention_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mention_id' when calling MentionsApi.get_mention"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/mentions/{mentionId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'mentionId' + '}', CGI.escape(mention_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] || 'CreateMention201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MentionsApi.get_mention",
+        :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: MentionsApi#get_mention\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List mentions
+    # Returns a paginated list of the workspace's mention book, ranked, with each entry's network identities.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q Search keyword.
+    # @option opts [Integer] :per_page  (default to 25)
+    # @option opts [Integer] :page  (default to 1)
+    # @return [ListMentions200Response]
+    def list_mentions(workspace_uuid, opts = {})
+      data, _status_code, _headers = list_mentions_with_http_info(workspace_uuid, opts)
+      data
+    end
+
+    # List mentions
+    # Returns a paginated list of the workspace&#39;s mention book, ranked, with each entry&#39;s network identities.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q Search keyword.
+    # @option opts [Integer] :per_page  (default to 25)
+    # @option opts [Integer] :page  (default to 1)
+    # @return [Array<(ListMentions200Response, Integer, Hash)>] ListMentions200Response data, response status code and response headers
+    def list_mentions_with_http_info(workspace_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MentionsApi.list_mentions ...'
+      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 MentionsApi.list_mentions"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/mentions'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].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] || 'ListMentions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MentionsApi.list_mentions",
+        :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: MentionsApi#list_mentions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update mention
+    # Replaces the mention's name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns `422`.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param mention_input [MentionInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateMention201Response]
+    def update_mention(workspace_uuid, mention_id, mention_input, opts = {})
+      data, _status_code, _headers = update_mention_with_http_info(workspace_uuid, mention_id, mention_input, opts)
+      data
+    end
+
+    # Update mention
+    # Replaces the mention&#39;s name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns &#x60;422&#x60;.
+    # @param workspace_uuid [String] UUID of the workspace.
+    # @param mention_id [String] The mention&#39;s &#x60;id&#x60; (a UUID).
+    # @param mention_input [MentionInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateMention201Response, Integer, Hash)>] CreateMention201Response data, response status code and response headers
+    def update_mention_with_http_info(workspace_uuid, mention_id, mention_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MentionsApi.update_mention ...'
+      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 MentionsApi.update_mention"
+      end
+      # verify the required parameter 'mention_id' is set
+      if @api_client.config.client_side_validation && mention_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mention_id' when calling MentionsApi.update_mention"
+      end
+      # verify the required parameter 'mention_input' is set
+      if @api_client.config.client_side_validation && mention_input.nil?
+        fail ArgumentError, "Missing the required parameter 'mention_input' when calling MentionsApi.update_mention"
+      end
+      # resource path
+      local_var_path = '/{workspaceUuid}/mentions/{mentionId}'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s)).sub('{' + 'mentionId' + '}', CGI.escape(mention_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']
+      # 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(mention_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateMention201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MentionsApi.update_mention",
+        :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: MentionsApi#update_mention\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end