@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/apis/ShoppingAdsApi.ts

@@ -0,0 +1,856 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type ApiError,
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+} from '../models/ApiError';
+import {
+    type LocalBusinessesResponse,
+    LocalBusinessesResponseFromJSON,
+    LocalBusinessesResponseToJSON,
+} from '../models/LocalBusinessesResponse';
+
+export interface ListAdsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    view?: ListAdsViewEnum;
+    owned?: boolean;
+    order?: ListAdsOrderEnum;
+    direction?: ListAdsDirectionEnum;
+    query?: string;
+    model?: ListAdsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: ListAdsBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListAdsOutputEnum;
+}
+
+export interface ListLocalBusinessesRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    owned?: boolean;
+    order?: ListLocalBusinessesOrderEnum;
+    direction?: ListLocalBusinessesDirectionEnum;
+    query?: string;
+    model?: ListLocalBusinessesModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: ListLocalBusinessesBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListLocalBusinessesOutputEnum;
+}
+
+export interface ListShoppingRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    view?: ListShoppingViewEnum;
+    owned?: boolean;
+    order?: ListShoppingOrderEnum;
+    direction?: ListShoppingDirectionEnum;
+    query?: string;
+    model?: ListShoppingModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: ListShoppingBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListShoppingOutputEnum;
+}
+
+/**
+ * ShoppingAdsApi - interface
+ * 
+ * @export
+ * @interface ShoppingAdsApiInterface
+ */
+export interface ShoppingAdsApiInterface {
+    /**
+     * Creates request options for listAds without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'advertisers' | 'ads'} [view] Row shape: one per advertising domain, or one per placement
+     * @param {boolean} [owned] Return only placements identified as the tracked brand\'s own (view=ads)
+     * @param {'ads' | 'prompts' | 'avg_position' | 'domain' | 'recent' | 'oldest' | 'position'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] Sort direction for view=advertisers. Defaults to desc, except avg_position and domain which default to asc.
+     * @param {string} [query] Case-insensitive substring filter on the ad title, domain or snippet
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listAdsRequestOpts(requestParameters: ListAdsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Paid placements returned inside AI answers. view=advertisers (default) returns one row per advertising domain with its placement count, prompt reach and average and best position; view=ads returns the individual placements with title, snippet, position and the prompt that triggered them. Position 1 is the best slot, so a LOWER average position is better. Requires the Scale plan or above.
+     * @summary List AI ad placements
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'advertisers' | 'ads'} [view] Row shape: one per advertising domain, or one per placement
+     * @param {boolean} [owned] Return only placements identified as the tracked brand\&#39;s own (view&#x3D;ads)
+     * @param {'ads' | 'prompts' | 'avg_position' | 'domain' | 'recent' | 'oldest' | 'position'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] Sort direction for view&#x3D;advertisers. Defaults to desc, except avg_position and domain which default to asc.
+     * @param {string} [query] Case-insensitive substring filter on the ad title, domain or snippet
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listAdsRaw(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Paid placements returned inside AI answers. view=advertisers (default) returns one row per advertising domain with its placement count, prompt reach and average and best position; view=ads returns the individual placements with title, snippet, position and the prompt that triggered them. Position 1 is the best slot, so a LOWER average position is better. Requires the Scale plan or above.
+     * List AI ad placements
+     */
+    listAds(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for listLocalBusinesses without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {boolean} [owned] Return only listings identified as the tracked brand\&#39;s own locations. The totals block stays account-wide.
+     * @param {'appearances' | 'business' | 'rating' | 'reviews' | 'avg_position' | 'prompts'} [order] Sort field
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the business name or address
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listLocalBusinessesRequestOpts(requestParameters: ListLocalBusinessesRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Local businesses (shops, restaurants, services) listed inside AI answers, one row per business: its name at its address, so two locations of a chain are two rows. Each row carries its appearance count, the number of prompts that listed it, its average rating and average position in the list, its review count, and whether it is yours or a tracked competitor. Every response also carries a totals block matching the KPI cards in the app. Local business lists come from a subset of models and only for prompts with local intent. Available on every plan.
+     * @summary List local businesses
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {boolean} [owned] Return only listings identified as the tracked brand\&#39;s own locations. The totals block stays account-wide.
+     * @param {'appearances' | 'business' | 'rating' | 'reviews' | 'avg_position' | 'prompts'} [order] Sort field
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the business name or address
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listLocalBusinessesRaw(requestParameters: ListLocalBusinessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LocalBusinessesResponse>>;
+
+    /**
+     * Local businesses (shops, restaurants, services) listed inside AI answers, one row per business: its name at its address, so two locations of a chain are two rows. Each row carries its appearance count, the number of prompts that listed it, its average rating and average position in the list, its review count, and whether it is yours or a tracked competitor. Every response also carries a totals block matching the KPI cards in the app. Local business lists come from a subset of models and only for prompts with local intent. Available on every plan.
+     * List local businesses
+     */
+    listLocalBusinesses(requestParameters: ListLocalBusinessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LocalBusinessesResponse>;
+
+    /**
+     * Creates request options for listShopping without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'products' | 'merchants'} [view] Row shape: one per distinct product, or one per merchant
+     * @param {boolean} [owned] Return only products identified as the tracked brand\&#39;s own. On view&#x3D;merchants this narrows to the merchants selling those products; the totals block stays account-wide.
+     * @param {'appearances' | 'price' | 'rating' | 'title' | 'products' | 'avg_price' | 'avg_rating' | 'merchant'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the product title
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listShoppingRequestOpts(requestParameters: ListShoppingRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Product cards returned inside AI answers. view=products (default) returns one row per distinct product, merged across executions, with its appearance count, price range, rating and whether it is yours, plus a currency_count saying how many currencies it was priced in (above 1 means the row reports its highest-priced listing and min_price may be another currency); view=merchants returns one row per selling merchant, with a currency field naming the money its price range and average are expressed in (providers price each market in its own currency, so a merchant that sells in more than one reports the currency most of its prices use). Every response also carries a totals block matching the KPI cards in the app, whose avg_price is computed inside the single currency named by avg_price_currency. Requires the Scale plan or above.
+     * @summary List shopping results
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'products' | 'merchants'} [view] Row shape: one per distinct product, or one per merchant
+     * @param {boolean} [owned] Return only products identified as the tracked brand\&#39;s own. On view&#x3D;merchants this narrows to the merchants selling those products; the totals block stays account-wide.
+     * @param {'appearances' | 'price' | 'rating' | 'title' | 'products' | 'avg_price' | 'avg_rating' | 'merchant'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the product title
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @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 {number} [prompt] Filter by prompt ID
+     * @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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShoppingAdsApiInterface
+     */
+    listShoppingRaw(requestParameters: ListShoppingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Product cards returned inside AI answers. view=products (default) returns one row per distinct product, merged across executions, with its appearance count, price range, rating and whether it is yours, plus a currency_count saying how many currencies it was priced in (above 1 means the row reports its highest-priced listing and min_price may be another currency); view=merchants returns one row per selling merchant, with a currency field naming the money its price range and average are expressed in (providers price each market in its own currency, so a merchant that sells in more than one reports the currency most of its prices use). Every response also carries a totals block matching the KPI cards in the app, whose avg_price is computed inside the single currency named by avg_price_currency. Requires the Scale plan or above.
+     * List shopping results
+     */
+    listShopping(requestParameters: ListShoppingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class ShoppingAdsApi extends runtime.BaseAPI implements ShoppingAdsApiInterface {
+
+    /**
+     * Creates request options for listAds without sending the request
+     */
+    async listAdsRequestOpts(requestParameters: ListAdsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listAds().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['view'] != null) {
+            queryParameters['view'] = requestParameters['view'];
+        }
+
+        if (requestParameters['owned'] != null) {
+            queryParameters['owned'] = requestParameters['owned'];
+        }
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        if (requestParameters['direction'] != null) {
+            queryParameters['direction'] = requestParameters['direction'];
+        }
+
+        if (requestParameters['query'] != null) {
+            queryParameters['query'] = requestParameters['query'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        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'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/ads`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Paid placements returned inside AI answers. view=advertisers (default) returns one row per advertising domain with its placement count, prompt reach and average and best position; view=ads returns the individual placements with title, snippet, position and the prompt that triggered them. Position 1 is the best slot, so a LOWER average position is better. Requires the Scale plan or above.
+     * List AI ad placements
+     */
+    async listAdsRaw(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.listAdsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Paid placements returned inside AI answers. view=advertisers (default) returns one row per advertising domain with its placement count, prompt reach and average and best position; view=ads returns the individual placements with title, snippet, position and the prompt that triggered them. Position 1 is the best slot, so a LOWER average position is better. Requires the Scale plan or above.
+     * List AI ad placements
+     */
+    async listAds(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.listAdsRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for listLocalBusinesses without sending the request
+     */
+    async listLocalBusinessesRequestOpts(requestParameters: ListLocalBusinessesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listLocalBusinesses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['owned'] != null) {
+            queryParameters['owned'] = requestParameters['owned'];
+        }
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        if (requestParameters['direction'] != null) {
+            queryParameters['direction'] = requestParameters['direction'];
+        }
+
+        if (requestParameters['query'] != null) {
+            queryParameters['query'] = requestParameters['query'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        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'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/local_businesses`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Local businesses (shops, restaurants, services) listed inside AI answers, one row per business: its name at its address, so two locations of a chain are two rows. Each row carries its appearance count, the number of prompts that listed it, its average rating and average position in the list, its review count, and whether it is yours or a tracked competitor. Every response also carries a totals block matching the KPI cards in the app. Local business lists come from a subset of models and only for prompts with local intent. Available on every plan.
+     * List local businesses
+     */
+    async listLocalBusinessesRaw(requestParameters: ListLocalBusinessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LocalBusinessesResponse>> {
+        const requestOptions = await this.listLocalBusinessesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LocalBusinessesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Local businesses (shops, restaurants, services) listed inside AI answers, one row per business: its name at its address, so two locations of a chain are two rows. Each row carries its appearance count, the number of prompts that listed it, its average rating and average position in the list, its review count, and whether it is yours or a tracked competitor. Every response also carries a totals block matching the KPI cards in the app. Local business lists come from a subset of models and only for prompts with local intent. Available on every plan.
+     * List local businesses
+     */
+    async listLocalBusinesses(requestParameters: ListLocalBusinessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LocalBusinessesResponse> {
+        const response = await this.listLocalBusinessesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listShopping without sending the request
+     */
+    async listShoppingRequestOpts(requestParameters: ListShoppingRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listShopping().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['view'] != null) {
+            queryParameters['view'] = requestParameters['view'];
+        }
+
+        if (requestParameters['owned'] != null) {
+            queryParameters['owned'] = requestParameters['owned'];
+        }
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        if (requestParameters['direction'] != null) {
+            queryParameters['direction'] = requestParameters['direction'];
+        }
+
+        if (requestParameters['query'] != null) {
+            queryParameters['query'] = requestParameters['query'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        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'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/shopping`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Product cards returned inside AI answers. view=products (default) returns one row per distinct product, merged across executions, with its appearance count, price range, rating and whether it is yours, plus a currency_count saying how many currencies it was priced in (above 1 means the row reports its highest-priced listing and min_price may be another currency); view=merchants returns one row per selling merchant, with a currency field naming the money its price range and average are expressed in (providers price each market in its own currency, so a merchant that sells in more than one reports the currency most of its prices use). Every response also carries a totals block matching the KPI cards in the app, whose avg_price is computed inside the single currency named by avg_price_currency. Requires the Scale plan or above.
+     * List shopping results
+     */
+    async listShoppingRaw(requestParameters: ListShoppingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.listShoppingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Product cards returned inside AI answers. view=products (default) returns one row per distinct product, merged across executions, with its appearance count, price range, rating and whether it is yours, plus a currency_count saying how many currencies it was priced in (above 1 means the row reports its highest-priced listing and min_price may be another currency); view=merchants returns one row per selling merchant, with a currency field naming the money its price range and average are expressed in (providers price each market in its own currency, so a merchant that sells in more than one reports the currency most of its prices use). Every response also carries a totals block matching the KPI cards in the app, whose avg_price is computed inside the single currency named by avg_price_currency. Requires the Scale plan or above.
+     * List shopping results
+     */
+    async listShopping(requestParameters: ListShoppingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.listShoppingRaw(requestParameters, initOverrides);
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListAdsViewEnum = {
+    Advertisers: 'advertisers',
+    Ads: 'ads'
+} as const;
+export type ListAdsViewEnum = typeof ListAdsViewEnum[keyof typeof ListAdsViewEnum];
+/**
+ * @export
+ */
+export const ListAdsOrderEnum = {
+    Ads: 'ads',
+    Prompts: 'prompts',
+    AvgPosition: 'avg_position',
+    Domain: 'domain',
+    Recent: 'recent',
+    Oldest: 'oldest',
+    Position: 'position'
+} as const;
+export type ListAdsOrderEnum = typeof ListAdsOrderEnum[keyof typeof ListAdsOrderEnum];
+/**
+ * @export
+ */
+export const ListAdsDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type ListAdsDirectionEnum = typeof ListAdsDirectionEnum[keyof typeof ListAdsDirectionEnum];
+/**
+ * @export
+ */
+export const ListAdsModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListAdsModelEnum = typeof ListAdsModelEnum[keyof typeof ListAdsModelEnum];
+/**
+ * @export
+ */
+export const ListAdsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type ListAdsBrandKindEnum = typeof ListAdsBrandKindEnum[keyof typeof ListAdsBrandKindEnum];
+/**
+ * @export
+ */
+export const ListAdsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListAdsOutputEnum = typeof ListAdsOutputEnum[keyof typeof ListAdsOutputEnum];
+/**
+ * @export
+ */
+export const ListLocalBusinessesOrderEnum = {
+    Appearances: 'appearances',
+    Business: 'business',
+    Rating: 'rating',
+    Reviews: 'reviews',
+    AvgPosition: 'avg_position',
+    Prompts: 'prompts'
+} as const;
+export type ListLocalBusinessesOrderEnum = typeof ListLocalBusinessesOrderEnum[keyof typeof ListLocalBusinessesOrderEnum];
+/**
+ * @export
+ */
+export const ListLocalBusinessesDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type ListLocalBusinessesDirectionEnum = typeof ListLocalBusinessesDirectionEnum[keyof typeof ListLocalBusinessesDirectionEnum];
+/**
+ * @export
+ */
+export const ListLocalBusinessesModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListLocalBusinessesModelEnum = typeof ListLocalBusinessesModelEnum[keyof typeof ListLocalBusinessesModelEnum];
+/**
+ * @export
+ */
+export const ListLocalBusinessesBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type ListLocalBusinessesBrandKindEnum = typeof ListLocalBusinessesBrandKindEnum[keyof typeof ListLocalBusinessesBrandKindEnum];
+/**
+ * @export
+ */
+export const ListLocalBusinessesOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListLocalBusinessesOutputEnum = typeof ListLocalBusinessesOutputEnum[keyof typeof ListLocalBusinessesOutputEnum];
+/**
+ * @export
+ */
+export const ListShoppingViewEnum = {
+    Products: 'products',
+    Merchants: 'merchants'
+} as const;
+export type ListShoppingViewEnum = typeof ListShoppingViewEnum[keyof typeof ListShoppingViewEnum];
+/**
+ * @export
+ */
+export const ListShoppingOrderEnum = {
+    Appearances: 'appearances',
+    Price: 'price',
+    Rating: 'rating',
+    Title: 'title',
+    Products: 'products',
+    AvgPrice: 'avg_price',
+    AvgRating: 'avg_rating',
+    Merchant: 'merchant'
+} as const;
+export type ListShoppingOrderEnum = typeof ListShoppingOrderEnum[keyof typeof ListShoppingOrderEnum];
+/**
+ * @export
+ */
+export const ListShoppingDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type ListShoppingDirectionEnum = typeof ListShoppingDirectionEnum[keyof typeof ListShoppingDirectionEnum];
+/**
+ * @export
+ */
+export const ListShoppingModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListShoppingModelEnum = typeof ListShoppingModelEnum[keyof typeof ListShoppingModelEnum];
+/**
+ * @export
+ */
+export const ListShoppingBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type ListShoppingBrandKindEnum = typeof ListShoppingBrandKindEnum[keyof typeof ListShoppingBrandKindEnum];
+/**
+ * @export
+ */
+export const ListShoppingOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListShoppingOutputEnum = typeof ListShoppingOutputEnum[keyof typeof ListShoppingOutputEnum];