npm - @llmpulse/sdk - Versions diffs - 1.68.0 → 1.70.0 - Mend

@llmpulse/sdk 1.68.0 → 1.70.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1480) hide show

package/dist/apis/MentionsCitationsApi.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.68.0
+ * The version of the OpenAPI document: 1.70.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,6 +24,11 @@ export interface ListAllCitationsRequest {
     from?: Date;
     to?: Date;
     output?: ListAllCitationsOutputEnum;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: ListAllCitationsBrandKindEnum;
+    range?: number;
 }
 export interface ListAllMentionsRequest {
     projectId: number;
@@ -36,6 +41,11 @@ export interface ListAllMentionsRequest {
     from?: Date;
     to?: Date;
     output?: ListAllMentionsOutputEnum;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: ListAllMentionsBrandKindEnum;
+    range?: number;
 }
 export interface ListCitationsRequest {
     projectId: number;
@@ -49,6 +59,9 @@ export interface ListCitationsRequest {
     from?: Date;
     to?: Date;
     output?: ListCitationsOutputEnum;
+    promptType?: string;
+    brandKind?: ListCitationsBrandKindEnum;
+    range?: number;
 }
 export interface ListCompetitorCitationsRequest {
     projectId: number;
@@ -61,6 +74,11 @@ export interface ListCompetitorCitationsRequest {
     from?: Date;
     to?: Date;
     output?: ListCompetitorCitationsOutputEnum;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: ListCompetitorCitationsBrandKindEnum;
+    range?: number;
 }
 export interface ListCompetitorMentionsRequest {
     projectId: number;
@@ -73,6 +91,11 @@ export interface ListCompetitorMentionsRequest {
     from?: Date;
     to?: Date;
     output?: ListCompetitorMentionsOutputEnum;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: ListCompetitorMentionsBrandKindEnum;
+    range?: number;
 }
 export interface ListMentionsRequest {
     projectId: number;
@@ -86,6 +109,9 @@ export interface ListMentionsRequest {
     from?: Date;
     to?: Date;
     output?: ListMentionsOutputEnum;
+    promptType?: string;
+    brandKind?: ListMentionsBrandKindEnum;
+    range?: number;
 }
 /**
  * MentionsCitationsApi - interface
@@ -106,6 +132,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -123,6 +154,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -145,6 +181,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -162,6 +203,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -185,6 +231,9 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -203,6 +252,9 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -225,6 +277,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -242,6 +299,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -264,6 +326,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -281,6 +348,11 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -303,6 +375,9 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
      */
@@ -321,6 +396,9 @@ export interface MentionsCitationsApiInterface {
      * @param {Date} [from]
      * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MentionsCitationsApiInterface
@@ -443,6 +521,15 @@ export declare const ListAllCitationsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListAllCitationsOutputEnum = typeof ListAllCitationsOutputEnum[keyof typeof ListAllCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListAllCitationsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListAllCitationsBrandKindEnum = typeof ListAllCitationsBrandKindEnum[keyof typeof ListAllCitationsBrandKindEnum];
 /**
  * @export
  */
@@ -470,6 +557,15 @@ export declare const ListAllMentionsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListAllMentionsOutputEnum = typeof ListAllMentionsOutputEnum[keyof typeof ListAllMentionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListAllMentionsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListAllMentionsBrandKindEnum = typeof ListAllMentionsBrandKindEnum[keyof typeof ListAllMentionsBrandKindEnum];
 /**
  * @export
  */
@@ -497,6 +593,15 @@ export declare const ListCitationsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListCitationsOutputEnum = typeof ListCitationsOutputEnum[keyof typeof ListCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCitationsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListCitationsBrandKindEnum = typeof ListCitationsBrandKindEnum[keyof typeof ListCitationsBrandKindEnum];
 /**
  * @export
  */
@@ -524,6 +629,15 @@ export declare const ListCompetitorCitationsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListCompetitorCitationsOutputEnum = typeof ListCompetitorCitationsOutputEnum[keyof typeof ListCompetitorCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorCitationsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListCompetitorCitationsBrandKindEnum = typeof ListCompetitorCitationsBrandKindEnum[keyof typeof ListCompetitorCitationsBrandKindEnum];
 /**
  * @export
  */
@@ -551,6 +665,15 @@ export declare const ListCompetitorMentionsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListCompetitorMentionsOutputEnum = typeof ListCompetitorMentionsOutputEnum[keyof typeof ListCompetitorMentionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorMentionsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListCompetitorMentionsBrandKindEnum = typeof ListCompetitorMentionsBrandKindEnum[keyof typeof ListCompetitorMentionsBrandKindEnum];
 /**
  * @export
  */
@@ -578,3 +701,12 @@ export declare const ListMentionsOutputEnum: {
     readonly Csv: "csv";
 };
 export type ListMentionsOutputEnum = typeof ListMentionsOutputEnum[keyof typeof ListMentionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListMentionsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListMentionsBrandKindEnum = typeof ListMentionsBrandKindEnum[keyof typeof ListMentionsBrandKindEnum];

package/dist/apis/MentionsCitationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.68.0
+ * The version of the OpenAPI document: 1.70.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListMentionsOutputEnum = exports.ListMentionsModelEnum = exports.ListCompetitorMentionsOutputEnum = exports.ListCompetitorMentionsModelEnum = exports.ListCompetitorCitationsOutputEnum = exports.ListCompetitorCitationsModelEnum = exports.ListCitationsOutputEnum = exports.ListCitationsModelEnum = exports.ListAllMentionsOutputEnum = exports.ListAllMentionsModelEnum = exports.ListAllCitationsOutputEnum = exports.ListAllCitationsModelEnum = exports.MentionsCitationsApi = void 0;
+exports.ListMentionsBrandKindEnum = exports.ListMentionsOutputEnum = exports.ListMentionsModelEnum = exports.ListCompetitorMentionsBrandKindEnum = exports.ListCompetitorMentionsOutputEnum = exports.ListCompetitorMentionsModelEnum = exports.ListCompetitorCitationsBrandKindEnum = exports.ListCompetitorCitationsOutputEnum = exports.ListCompetitorCitationsModelEnum = exports.ListCitationsBrandKindEnum = exports.ListCitationsOutputEnum = exports.ListCitationsModelEnum = exports.ListAllMentionsBrandKindEnum = exports.ListAllMentionsOutputEnum = exports.ListAllMentionsModelEnum = exports.ListAllCitationsBrandKindEnum = exports.ListAllCitationsOutputEnum = exports.ListAllCitationsModelEnum = exports.MentionsCitationsApi = void 0;
 const runtime = require("../runtime");
 const CitationsResponse_1 = require("../models/CitationsResponse");
 const CompetitorMentionsResponse_1 = require("../models/CompetitorMentionsResponse");
@@ -70,6 +70,21 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['countryCode'] != null) {
+                queryParameters['country_code'] = requestParameters['countryCode'];
+            }
+            if (requestParameters['languageCode'] != null) {
+                queryParameters['language_code'] = requestParameters['languageCode'];
+            }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -146,6 +161,21 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['countryCode'] != null) {
+                queryParameters['country_code'] = requestParameters['countryCode'];
+            }
+            if (requestParameters['languageCode'] != null) {
+                queryParameters['language_code'] = requestParameters['languageCode'];
+            }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -225,6 +255,15 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -302,6 +341,21 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['countryCode'] != null) {
+                queryParameters['country_code'] = requestParameters['countryCode'];
+            }
+            if (requestParameters['languageCode'] != null) {
+                queryParameters['language_code'] = requestParameters['languageCode'];
+            }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -378,6 +432,21 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['countryCode'] != null) {
+                queryParameters['country_code'] = requestParameters['countryCode'];
+            }
+            if (requestParameters['languageCode'] != null) {
+                queryParameters['language_code'] = requestParameters['languageCode'];
+            }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -456,6 +525,15 @@ class MentionsCitationsApi extends runtime.BaseAPI {
             if (requestParameters['output'] != null) {
                 queryParameters['output'] = requestParameters['output'];
             }
+            if (requestParameters['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -519,6 +597,14 @@ exports.ListAllCitationsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListAllCitationsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -544,6 +630,14 @@ exports.ListAllMentionsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListAllMentionsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -569,6 +663,14 @@ exports.ListCitationsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListCitationsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -594,6 +696,14 @@ exports.ListCompetitorCitationsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListCompetitorCitationsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -619,6 +729,14 @@ exports.ListCompetitorMentionsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListCompetitorMentionsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -644,3 +762,11 @@ exports.ListMentionsOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+exports.ListMentionsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};

package/dist/apis/MetricsApi.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.68.0
+ * The version of the OpenAPI document: 1.70.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,6 +48,9 @@ export interface GetShareOfVoiceRequest {
     brandKind?: GetShareOfVoiceBrandKindEnum;
     output?: GetShareOfVoiceOutputEnum;
     view?: GetShareOfVoiceViewEnum;
+    countryCode?: string;
+    languageCode?: string;
+    includeProject?: boolean;
 }
 export interface GetSummaryRequest {
     projectId: number;
@@ -63,6 +66,9 @@ export interface GetSummaryRequest {
     promptType?: string;
     brandKind?: GetSummaryBrandKindEnum;
     output?: GetSummaryOutputEnum;
+    countryCode?: string;
+    languageCode?: string;
+    includeProject?: boolean;
 }
 export interface GetTimeseriesRequest {
     projectId: number;
@@ -99,6 +105,8 @@ export interface GetTopSourcesRequest {
     page?: number;
     perPage?: number;
     output?: GetTopSourcesOutputEnum;
+    collectionIds?: Array<number>;
+    domains?: Array<string>;
 }
 /**
  * MetricsApi - interface
@@ -175,6 +183,9 @@ export interface MetricsApiInterface {
      * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
      * @param {'over_time' | 'current' | 'breakdown'} [view] Which Share of Voice projection to flatten. Only valid together with \&#39;output\&#39;. \&#39;over_time\&#39; (default) is one row per date and actor, \&#39;current\&#39; the ranked snapshot, \&#39;breakdown\&#39; the Top 4 plus Others.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {boolean} [includeProject]
      * @throws {RequiredError}
      * @memberof MetricsApiInterface
      */
@@ -195,6 +206,9 @@ export interface MetricsApiInterface {
      * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
      * @param {'over_time' | 'current' | 'breakdown'} [view] Which Share of Voice projection to flatten. Only valid together with \&#39;output\&#39;. \&#39;over_time\&#39; (default) is one row per date and actor, \&#39;current\&#39; the ranked snapshot, \&#39;breakdown\&#39; the Top 4 plus Others.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {boolean} [includeProject]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApiInterface
@@ -220,6 +234,9 @@ export interface MetricsApiInterface {
      * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
      * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {boolean} [includeProject]
      * @throws {RequiredError}
      * @memberof MetricsApiInterface
      */
@@ -240,6 +257,9 @@ export interface MetricsApiInterface {
      * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
      * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {boolean} [includeProject]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApiInterface
@@ -319,6 +339,8 @@ export interface MetricsApiInterface {
      * @param {number} [page]
      * @param {number} [perPage]
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {Array<number>} [collectionIds] Tags (collections) to include at once, as a union: one ID or a comma-separated list, e.g. collection_ids&#x3D;12,15 (collection_ids[]&#x3D;12&amp;collection_ids[]&#x3D;15 is also accepted). Combines with collection_id. An ID outside the project returns 422 ERR_INVALID_PARAM.
+     * @param {Array<string>} [domains] Restrict the result to these exact domains, case-insensitive: one domain or a comma-separated list, e.g. domains&#x3D;wikipedia.org,reddit.com. The bracket form domains[]&#x3D;wikipedia.org&amp;domains[]&#x3D;reddit.com is also accepted.
      * @throws {RequiredError}
      * @memberof MetricsApiInterface
      */
@@ -342,6 +364,8 @@ export interface MetricsApiInterface {
      * @param {number} [page]
      * @param {number} [perPage]
      * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {Array<number>} [collectionIds] Tags (collections) to include at once, as a union: one ID or a comma-separated list, e.g. collection_ids&#x3D;12,15 (collection_ids[]&#x3D;12&amp;collection_ids[]&#x3D;15 is also accepted). Combines with collection_id. An ID outside the project returns 422 ERR_INVALID_PARAM.
+     * @param {Array<string>} [domains] Restrict the result to these exact domains, case-insensitive: one domain or a comma-separated list, e.g. domains&#x3D;wikipedia.org,reddit.com. The bracket form domains[]&#x3D;wikipedia.org&amp;domains[]&#x3D;reddit.com is also accepted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApiInterface