mencoro 1.0.0

data/docs/TrackedQueryCountResource.md

@@ -0,0 +1,20 @@
+# Mencoro::TrackedQueryCountResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | Tracked queries in the project matching the status filter. Every status when none was sent. |  |
+| **check_cost** | **Integer** | Budget cost of force-checking exactly those tracked queries, in check budget units: the sum of each one's configured passes. One unit per pass, the same unit the plan allowance is counted in. Reserves nothing and debits nothing. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::TrackedQueryCountResource.new(
+  count: 42,
+  check_cost: 96
+)
+```
+

data/docs/TrackedQueryDetailResource.md

@@ -0,0 +1,38 @@
+# Mencoro::TrackedQueryDetailResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **project_id** | **String** | The project this tracked query belongs to |  |
+| **query_text** | **String** | The prompt or keyword sent to the engine |  |
+| **engine** | **String** |  |  |
+| **locale** | **String** | Language tag the query is asked in. Null when the engine is asked without one. | [optional] |
+| **country** | **String** | ISO-3166 alpha-2 country the query is asked from |  |
+| **query_cluster_ids** | **Array<String>** | Clusters (groups) this query belongs to. Empty when it is ungrouped. |  |
+| **status** | **String** |  |  |
+| **check_frequency** | **String** | How often the query is checked while active |  |
+| **n_passes** | **Integer** | Passes run per check. Greater than 1 only for AI engines. |  |
+| **last_checked_at** | **Time** | When a check last completed. Null means no check has completed yet, which is not the same as a check that found nothing. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::TrackedQueryDetailResource.new(
+  id: null,
+  project_id: null,
+  query_text: null,
+  engine: null,
+  locale: null,
+  country: null,
+  query_cluster_ids: null,
+  status: null,
+  check_frequency: null,
+  n_passes: null,
+  last_checked_at: null
+)
+```
+

data/docs/TrackedQueryResource.md

@@ -0,0 +1,52 @@
+# Mencoro::TrackedQueryResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **query_text** | **String** | The keyword or prompt being tracked |  |
+| **engine** | **String** |  |  |
+| **country** | **String** | ISO-3166 alpha-2 country code the query is tracked in |  |
+| **status** | **String** |  |  |
+| **query_cluster_ids** | **Array<String>** | Ids of the keyword clusters this query belongs to |  |
+| **check_frequency** | **String** | How often the query is checked |  |
+| **n_passes** | **Integer** | How many times the query is asked per check |  |
+| **last_serp_position** | **Integer** | Position in traditional search results at the last check. 1-based, LOWER is better. Null when not known yet. | [optional] |
+| **last_mention_position** | **Integer** | Position of the brand mention inside the AI answer at the last check. 1-based, LOWER is better. Null when not known yet. | [optional] |
+| **last_link_position** | **Integer** | Position of a cited link to the brand at the last check. 1-based, LOWER is better. Null when not known yet. | [optional] |
+| **last_shopping_position** | **Integer** | Position in shopping results at the last check. 1-based, LOWER is better. Null when not known yet. | [optional] |
+| **last_share_of_voice** | **Float** | 0-100 share of the weighted AI mentions against every tracked brand; HIGHER is better. Null when not known yet, which is not a share of zero. | [optional] |
+| **last_positivity_index** | **Integer** | 0-100 sentiment score of the brand mentions; HIGHER is better. Null when there were no mentions to score, which is not a score of zero. | [optional] |
+| **last_positive_mention_count** | **Integer** | Positive brand mentions at the last check. Null when not known yet. | [optional] |
+| **last_neutral_mention_count** | **Integer** | Neutral brand mentions at the last check. Null when not known yet. | [optional] |
+| **last_negative_mention_count** | **Integer** | Negative brand mentions at the last check. Null when not known yet. | [optional] |
+| **last_checked_at** | **Time** | When the query was last checked. Null when it never has been. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::TrackedQueryResource.new(
+  id: null,
+  query_text: null,
+  engine: null,
+  country: null,
+  status: null,
+  query_cluster_ids: null,
+  check_frequency: null,
+  n_passes: null,
+  last_serp_position: null,
+  last_mention_position: null,
+  last_link_position: null,
+  last_shopping_position: null,
+  last_share_of_voice: null,
+  last_positivity_index: null,
+  last_positive_mention_count: null,
+  last_neutral_mention_count: null,
+  last_negative_mention_count: null,
+  last_checked_at: null
+)
+```
+

data/docs/TrackedQueryUsageResource.md

@@ -0,0 +1,18 @@
+# Mencoro::TrackedQueryUsageResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracked_query_count** | **Integer** | Tracked queries across every project of the organization, archived projects included, counting active and paused queries alike. Never null; 0 means none are configured. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::TrackedQueryUsageResource.new(
+  tracked_query_count: 124
+)
+```
+

data/docs/UpdateOrganizationRequest.md

@@ -0,0 +1,22 @@
+# Mencoro::UpdateOrganizationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **contact_email** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::UpdateOrganizationRequest.new(
+  name: null,
+  description: null,
+  contact_email: null
+)
+```
+

data/docs/UpdateProjectBrandProfileRequest.md

@@ -0,0 +1,20 @@
+# Mencoro::UpdateProjectBrandProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **website_domains** | **Array<String>** | Domains a cited link or a search result is matched against. A full URL or a bare host. | [optional] |
+| **brand_names** | **Array<String>** | Terms a mention in an AI answer is matched against. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::UpdateProjectBrandProfileRequest.new(
+  website_domains: null,
+  brand_names: null
+)
+```
+

data/docs/UpdateProjectRequest.md

@@ -0,0 +1,18 @@
+# Mencoro::UpdateProjectRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::UpdateProjectRequest.new(
+  name: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="mencoro"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="mencoro-api-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/mencoro/api/account_api.rb

@@ -0,0 +1,136 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Mencoro
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the authenticated identity
+    # Returns the user the API key belongs to, plus the key's capabilities and scope. Use it to confirm which credential a call runs under.
+    # @param [Hash] opts the optional parameters
+    # @return [MeResource]
+    def get_me(opts = {})
+      data, _status_code, _headers = get_me_with_http_info(opts)
+      data
+    end
+
+    # Get the authenticated identity
+    # Returns the user the API key belongs to, plus the key's capabilities and scope. Use it to confirm which credential a call runs under.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MeResource, Integer, Hash)>] MeResource data, response status code and response headers
+    def get_me_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_me ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/me'
+
+      # 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] || 'MeResource'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_me",
+        :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: AccountApi#get_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Counts across everything the key can reach
+    # Aggregate counts over every organization the key's owner is an active member of, narrowed to the key's scope — the same set /api/v1/organizations pages through. `organizations.total` is that set's size; `projects.total` and `projects.active` count the projects inside it, archived ones included in the total and excluded from the active figure. Every value is an exact count: zero means zero, and no value here is ever null or unknown. Per-organization billing and usage figures are not part of this response; read them from the subscription and entitlements operations instead.
+    # @param [Hash] opts the optional parameters
+    # @return [GetMeStats200Response]
+    def get_me_stats(opts = {})
+      data, _status_code, _headers = get_me_stats_with_http_info(opts)
+      data
+    end
+
+    # Counts across everything the key can reach
+    # Aggregate counts over every organization the key&#39;s owner is an active member of, narrowed to the key&#39;s scope — the same set /api/v1/organizations pages through. &#x60;organizations.total&#x60; is that set&#39;s size; &#x60;projects.total&#x60; and &#x60;projects.active&#x60; count the projects inside it, archived ones included in the total and excluded from the active figure. Every value is an exact count: zero means zero, and no value here is ever null or unknown. Per-organization billing and usage figures are not part of this response; read them from the subscription and entitlements operations instead.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetMeStats200Response, Integer, Hash)>] GetMeStats200Response data, response status code and response headers
+    def get_me_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_me_stats ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/me/stats'
+
+      # 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] || 'GetMeStats200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_me_stats",
+        :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: AccountApi#get_me_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end