@llmpulse/sdk 1.62.0 → 1.63.0

package/dist/esm/apis/OwnedMediaCommunitiesApi.js

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,10 +21,144 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
+import { OwnedMediaCitingPromptsResponseFromJSON, } from '../models/OwnedMediaCitingPromptsResponse';
+import { OwnedMediaListResponseFromJSON, } from '../models/OwnedMediaListResponse';
+import { OwnedMediaProfilesResponseFromJSON, } from '../models/OwnedMediaProfilesResponse';
+import { OwnedMediaProfilesUpdateResponseFromJSON, } from '../models/OwnedMediaProfilesUpdateResponse';
+import { OwnedMediaSummaryResponseFromJSON, } from '../models/OwnedMediaSummaryResponse';
+import { UpdateOwnedMediaProfilesRequestToJSON, } from '../models/UpdateOwnedMediaProfilesRequest';
 /**
  *
  */
 export class OwnedMediaCommunitiesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getOwnedMediaProfiles without sending the request
+     */
+    getOwnedMediaProfilesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getOwnedMediaProfiles().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/projects/{id}/owned_media`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The profiles whose citations count as yours in the Owned Media and YouTube Intelligence reports, as Project Settings > Owned Media shows them. platforms holds one entry per platform with whether it is connected, how many extra profiles it accepts and its profiles: the main one, the extra ones, and on Reddit the claimed subreddits and usernames, each with its URL, handle, store (for apps), name, avatar and the state of the scrape that reads them. settings holds the current value of every field PATCH accepts, ready to edit and send back. Requires the Growth plan or above.
+     * Get a project\'s owned-media profiles
+     */
+    getOwnedMediaProfilesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOwnedMediaProfilesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OwnedMediaProfilesResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * The profiles whose citations count as yours in the Owned Media and YouTube Intelligence reports, as Project Settings > Owned Media shows them. platforms holds one entry per platform with whether it is connected, how many extra profiles it accepts and its profiles: the main one, the extra ones, and on Reddit the claimed subreddits and usernames, each with its URL, handle, store (for apps), name, avatar and the state of the scrape that reads them. settings holds the current value of every field PATCH accepts, ready to edit and send back. Requires the Growth plan or above.
+     * Get a project\'s owned-media profiles
+     */
+    getOwnedMediaProfiles(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOwnedMediaProfilesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOwnedMediaSummary without sending the request
+     */
+    getOwnedMediaSummaryRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getOwnedMediaSummary().');
+            }
+            if (requestParameters['provider'] == null) {
+                throw new runtime.RequiredError('provider', 'Required parameter "provider" was null or undefined when calling getOwnedMediaSummary().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['provider'] != null) {
+                queryParameters['provider'] = requestParameters['provider'];
+            }
+            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['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/owned_media/summary`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The numbers behind one Owned Media tab. kpis gives the platform citations (total), yours (your profiles and their content), your_profile and your_content apart, and share_pct; previous gives the same KPIs for the period of the same length that ends just before from, and changes the difference (percent for counts, percentage points for share_pct, null when there is nothing to compare). weekly is the citations per week, yours against everyone else. by_model and by_country split every citation of the platform; content_types (reel, post, tv, pulse, or regular, shorts and live on YouTube) and age_buckets cover posts and videos. provider=mobile_apps adds stores, the per-store totals, and has no content type or age; provider=overview returns platforms, one rollup per platform the caller can read, and no breakdowns. A team member also needs the YouTube Intelligence permission for provider=youtube. Defaults to the last 30 days. Requires the Growth plan or above.
+     * Get an owned-media summary
+     */
+    getOwnedMediaSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOwnedMediaSummaryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OwnedMediaSummaryResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * The numbers behind one Owned Media tab. kpis gives the platform citations (total), yours (your profiles and their content), your_profile and your_content apart, and share_pct; previous gives the same KPIs for the period of the same length that ends just before from, and changes the difference (percent for counts, percentage points for share_pct, null when there is nothing to compare). weekly is the citations per week, yours against everyone else. by_model and by_country split every citation of the platform; content_types (reel, post, tv, pulse, or regular, shorts and live on YouTube) and age_buckets cover posts and videos. provider=mobile_apps adds stores, the per-store totals, and has no content type or age; provider=overview returns platforms, one rollup per platform the caller can read, and no breakdowns. A team member also needs the YouTube Intelligence permission for provider=youtube. Defaults to the last 30 days. Requires the Growth plan or above.
+     * Get an owned-media summary
+     */
+    getOwnedMediaSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOwnedMediaSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listOwnedMedia without sending the request
      */
@@ -103,23 +237,119 @@ export class OwnedMediaCommunitiesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. Video, post, channel and profile rows also carry their image (thumbnail_url or avatar_url, our cached copy where one exists), their average position in the answers and, on YouTube, the video id, the channel handle and URL, and the channel key that /dimensions/owned_media/citing_prompts accepts. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. A team member also needs the YouTube Intelligence permission for provider=youtube. Requires the Growth plan or above.
      * List owned-media citations
      */
     listOwnedMediaRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.listOwnedMediaRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.VoidApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OwnedMediaListResponseFromJSON(jsonValue));
         });
     }
     /**
-     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. Video, post, channel and profile rows also carry their image (thumbnail_url or avatar_url, our cached copy where one exists), their average position in the answers and, on YouTube, the video id, the channel handle and URL, and the channel key that /dimensions/owned_media/citing_prompts accepts. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. A team member also needs the YouTube Intelligence permission for provider=youtube. Requires the Growth plan or above.
      * List owned-media citations
      */
     listOwnedMedia(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.listOwnedMediaRaw(requestParameters, initOverrides);
+            const response = yield this.listOwnedMediaRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listOwnedMediaCitingPrompts without sending the request
+     */
+    listOwnedMediaCitingPromptsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listOwnedMediaCitingPrompts().');
+            }
+            if (requestParameters['provider'] == null) {
+                throw new runtime.RequiredError('provider', 'Required parameter "provider" was null or undefined when calling listOwnedMediaCitingPrompts().');
+            }
+            const queryParameters = {};
+            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['provider'] != null) {
+                queryParameters['provider'] = requestParameters['provider'];
+            }
+            if (requestParameters['url'] != null) {
+                queryParameters['url'] = requestParameters['url'];
+            }
+            if (requestParameters['profile'] != null) {
+                queryParameters['profile'] = requestParameters['profile'];
+            }
+            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['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/owned_media/citing_prompts`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The drill-down behind one row of an Owned Media or YouTube Intelligence table. Pass exactly one of url (a post or video URL, any variant of it) or profile (a handle with or without @, a profile or channel URL, or the channel key the YouTube channels rows return). item describes it (title, image, owner, whether it is yours and its stats), citation_count and prompt_count count its citations in the window, and data lists the citing answers newest first, each with its prompt, answer id, model, country, language, execution date, a plain-text excerpt and its link in the app. It shows prompt and answer text, so a team member also needs the Prompts permission, and YouTube Intelligence for provider=youtube. Defaults to the last 30 days. Requires the Growth plan or above.
+     * List the answers citing an owned-media item
+     */
+    listOwnedMediaCitingPromptsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listOwnedMediaCitingPromptsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OwnedMediaCitingPromptsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * The drill-down behind one row of an Owned Media or YouTube Intelligence table. Pass exactly one of url (a post or video URL, any variant of it) or profile (a handle with or without @, a profile or channel URL, or the channel key the YouTube channels rows return). item describes it (title, image, owner, whether it is yours and its stats), citation_count and prompt_count count its citations in the window, and data lists the citing answers newest first, each with its prompt, answer id, model, country, language, execution date, a plain-text excerpt and its link in the app. It shows prompt and answer text, so a team member also needs the Prompts permission, and YouTube Intelligence for provider=youtube. Defaults to the last 30 days. Requires the Growth plan or above.
+     * List the answers citing an owned-media item
+     */
+    listOwnedMediaCitingPrompts(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listOwnedMediaCitingPromptsRaw(requestParameters, initOverrides);
+            return yield response.value();
         });
     }
     /**
@@ -228,7 +458,98 @@ export class OwnedMediaCommunitiesApi extends runtime.BaseAPI {
             yield this.listRedditCitationsRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for updateOwnedMediaProfiles without sending the request
+     */
+    updateOwnedMediaProfilesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateOwnedMediaProfiles().');
+            }
+            if (requestParameters['updateOwnedMediaProfilesRequest'] == null) {
+                throw new runtime.RequiredError('updateOwnedMediaProfilesRequest', 'Required parameter "updateOwnedMediaProfilesRequest" was null or undefined when calling updateOwnedMediaProfiles().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/projects/{id}/owned_media`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateOwnedMediaProfilesRequestToJSON(requestParameters['updateOwnedMediaProfilesRequest']),
+            };
+        });
+    }
+    /**
+     * Sets the profiles whose citations count as yours, like Project Settings > Owned Media. Send only the fields to change: a URL field takes a URL, or an empty string or null to clear it, and every list REPLACES the stored one ([] clears it). URLs are normalized like the app (a profile URL is stored in its canonical form, a Google Play package name becomes its listing URL), and anything the app would refuse (a URL from another platform, an extra profile equal to the main one, more than 10 extra profiles, a malformed subreddit) is rejected with ERR_INVALID_PARAM and nothing is applied. A new main or extra profile is scraped in the background for its name and avatar, listed in profile_scrapes_queued. The response is the GET payload after the change. A team member needs the Owned Media create permission, YouTube Intelligence create to change the YouTube channel, and Projects update to change the extra profile or Reddit lists. Requires the Growth plan or above and a `read_write` scope API key.
+     * Update a project\'s owned-media profiles
+     */
+    updateOwnedMediaProfilesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateOwnedMediaProfilesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OwnedMediaProfilesUpdateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Sets the profiles whose citations count as yours, like Project Settings > Owned Media. Send only the fields to change: a URL field takes a URL, or an empty string or null to clear it, and every list REPLACES the stored one ([] clears it). URLs are normalized like the app (a profile URL is stored in its canonical form, a Google Play package name becomes its listing URL), and anything the app would refuse (a URL from another platform, an extra profile equal to the main one, more than 10 extra profiles, a malformed subreddit) is rejected with ERR_INVALID_PARAM and nothing is applied. A new main or extra profile is scraped in the background for its name and avatar, listed in profile_scrapes_queued. The response is the GET payload after the change. A team member needs the Owned Media create permission, YouTube Intelligence create to change the YouTube channel, and Projects update to change the extra profile or Reddit lists. Requires the Growth plan or above and a `read_write` scope API key.
+     * Update a project\'s owned-media profiles
+     */
+    updateOwnedMediaProfiles(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateOwnedMediaProfilesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
+/**
+ * @export
+ */
+export const GetOwnedMediaSummaryProviderEnum = {
+    Youtube: 'youtube',
+    Instagram: 'instagram',
+    Facebook: 'facebook',
+    Tiktok: 'tiktok',
+    Linkedin: 'linkedin',
+    MobileApps: 'mobile_apps',
+    Overview: 'overview'
+};
+/**
+ * @export
+ */
+export const GetOwnedMediaSummaryModelEnum = {
+    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'
+};
+/**
+ * @export
+ */
+export const GetOwnedMediaSummaryBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
 /**
  * @export
  */
@@ -291,6 +612,49 @@ export const ListOwnedMediaOutputEnum = {
     Flat: 'flat',
     Csv: 'csv'
 };
+/**
+ * @export
+ */
+export const ListOwnedMediaCitingPromptsProviderEnum = {
+    Youtube: 'youtube',
+    Instagram: 'instagram',
+    Facebook: 'facebook',
+    Tiktok: 'tiktok',
+    Linkedin: 'linkedin'
+};
+/**
+ * @export
+ */
+export const ListOwnedMediaCitingPromptsModelEnum = {
+    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'
+};
+/**
+ * @export
+ */
+export const ListOwnedMediaCitingPromptsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
+/**
+ * @export
+ */
+export const ListOwnedMediaCitingPromptsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};
 /**
  * @export
  */

package/dist/esm/apis/ProjectsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/ProjectsApi.js

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).