@llmpulse/sdk 1.76.0 → 1.77.0

package/docs/ProjectCreateRequest.md

@@ -28,6 +28,7 @@ Name | Type
 `weeklyEmailSubscribed` | boolean
 `externalIdentifier` | string
 `executePromptsImmediately` | boolean
+`pitch` | boolean
 
 ## Example
 
@@ -58,6 +59,7 @@ const example = {
   "weeklyEmailSubscribed": null,
   "externalIdentifier": null,
   "executePromptsImmediately": null,
+  "pitch": null,
 } satisfies ProjectCreateRequest
 
 console.log(example)

package/docs/ProjectDetails.md

@@ -11,6 +11,8 @@ Name | Type
 `brandName` | string
 `tracked` | boolean
 `untrackedReason` | string
+`pitch` | boolean
+`pitchExpiresAt` | Date
 `url` | string
 `description` | string
 `matchingNames` | Array<string>
@@ -30,6 +32,7 @@ Name | Type
 `createdAt` | Date
 `promptLimit` | number
 `stats` | [ProjectDetailsAllOfStats](ProjectDetailsAllOfStats.md)
+`pitchRun` | [ProjectDetailsAllOfPitchRun](ProjectDetailsAllOfPitchRun.md)
 `dataCoverage` | [ProjectDetailsAllOfDataCoverage](ProjectDetailsAllOfDataCoverage.md)
 `searchConsole` | [ProjectDetailsAllOfSearchConsole](ProjectDetailsAllOfSearchConsole.md)
 `aiTraffic` | [ProjectDetailsAllOfAiTraffic](ProjectDetailsAllOfAiTraffic.md)
@@ -48,6 +51,8 @@ const example = {
   "brandName": null,
   "tracked": null,
   "untrackedReason": null,
+  "pitch": null,
+  "pitchExpiresAt": null,
   "url": null,
   "description": null,
   "matchingNames": null,
@@ -67,6 +72,7 @@ const example = {
   "createdAt": null,
   "promptLimit": null,
   "stats": null,
+  "pitchRun": null,
   "dataCoverage": null,
   "searchConsole": null,
   "aiTraffic": null,

package/docs/ProjectDetailsAllOfPitchRun.md

@@ -0,0 +1,45 @@
+
+# ProjectDetailsAllOfPitchRun
+
+The one run of a pitch project; null for a tracked project. Its answers are dated between launched_at and settled_at, so read its metrics with from set to the launched_at date (the default ranges leave out a pitch older than a few weeks)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`launchedAt` | Date
+`settledAt` | Date
+`models` | Array<string>
+`answersExpected` | number
+`answersReceived` | number
+
+## Example
+
+```typescript
+import type { ProjectDetailsAllOfPitchRun } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "launchedAt": null,
+  "settledAt": null,
+  "models": null,
+  "answersExpected": null,
+  "answersReceived": null,
+} satisfies ProjectDetailsAllOfPitchRun
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProjectDetailsAllOfPitchRun
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProjectsApi.md

@@ -24,7 +24,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 
 Create a project (fast mode)
 
-Create a complete project in one call: project fields, prompts (queued for execution and categorization), collections tagging those prompts, competitors, weekly email subscription. The response lists same_domain_projects so an accidental duplicate is visible; it never blocks the create. Idempotent via `external_identifier` (embed-enabled accounts only; replay returns 200 with the existing project). Requires a `read_write` scope API key.
+Create a complete project in one call: project fields, prompts (queued for execution and categorization), collections tagging those prompts, competitors, weekly email subscription. With pitch true it creates a pitch project instead: a one-off snapshot for a prospect that runs once, takes no project slot and is deleted after 90 days unless converted; ERR_PLAN_REQUIRED when the account is below the Scale tier, on a trial or without approved pitch project access (error.meta.access says which), ERR_QUOTA_EXCEEDED when the month\'s pitch projects are used (error.meta.resets_on), ERR_INVALID_PARAM for more than 100 prompts or a domain the account tracks or pitched in the last 90 days. The response lists same_domain_projects so an accidental duplicate is visible; it never blocks the create. Idempotent via `external_identifier` (embed-enabled accounts only; replay returns 200 with the existing project). Requires a `read_write` scope API key.
 
 ### Example
 
@@ -322,7 +322,7 @@ example().catch(console.error);
 
 Project details
 
-Detailed info for one project: matching_names, additional_owned_domains, industry, business model, primary products, target audience, brand voice, locale, app store IDs, prompt_limit (the project\'s own prompt cap, null without one), stats (incl. prompts_by_brand_kind counts and prompts_available, how many prompts can still be added: the lower of the project\'s free slots and the account\'s remaining prompts, null when neither caps it), data_coverage (models, countries and languages with data) and the status of each data connection (search_console, ai_traffic, agent_traffic) with the connect_url where the user connects it.
+Detailed info for one project: matching_names, additional_owned_domains, industry, business model, primary products, target audience, brand voice, locale, app store IDs, prompt_limit (the project\'s own prompt cap, null without one), stats (incl. prompts_by_brand_kind counts and prompts_available, how many prompts can still be added: the lower of the project\'s free slots and the account\'s remaining prompts, null when neither caps it), data_coverage (models, countries and languages with data), the status of each data connection (search_console, ai_traffic, agent_traffic) with the connect_url where the user connects it, and for a pitch project its pitch_expires_at and pitch_run (when it ran, the AI models it asked and how many answers arrived).
 
 ### Example
 
@@ -602,11 +602,11 @@ example().catch(console.error);
 
 ## listProjects
 
-> ListProjects200Response listProjects(output)
+> ListProjects200Response listProjects(pitch, output)
 
 List projects
 
-All projects accessible with your API key.
+All projects accessible with your API key. Pitch projects, one-off snapshots deleted 90 days after they are created, are left out unless pitch is include or only.
 
 ### Example
 
@@ -626,6 +626,8 @@ async function example() {
   const api = new ProjectsApi(config);
 
   const body = {
+    // 'exclude' | 'include' | 'only' | exclude (default) leaves pitch projects out, include lists them with the tracked projects, only lists pitch projects alone (optional)
+    pitch: pitch_example,
     // 'flat' | 'csv' | 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. (optional)
     output: output_example,
   } satisfies ListProjectsRequest;
@@ -647,6 +649,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **pitch** | `exclude`, `include`, `only` | exclude (default) leaves pitch projects out, include lists them with the tracked projects, only lists pitch projects alone | [Optional] [Defaults to `'exclude'`] [Enum: exclude, include, only] |
 | **output** | `flat`, `csv` | 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. | [Optional] [Defaults to `undefined`] [Enum: flat, csv] |
 
 ### Return type
@@ -677,7 +680,7 @@ example().catch(console.error);
 
 Update a project profile (Brand Book)
 
-Updates the project name and profile, the same fields as Project Settings: name, brand_name, description, industry, business_model (plus business_model_other when it is OTHER), target_audience, brand_voice, goals, primary_products, matching_names, and the additional owned domains (additional_owned_domains). Send only the fields to change; unknown fields are rejected, and a request is applied whole or not at all. All seven Brand Book fields feed every GEO Writer task and prompt suggestions; only industry, description, and target_audience help Recommendations. A matching_names change re-runs mention/citation matching over the project history in the background, and an additional_owned_domains change reprocesses the past answers that cite an added or removed domain (rematching=true); further edits are rejected while that runs. Only the account owner can send additional_owned_domains: a team member key gets ERR_INSUFFICIENT_PERMISSION and nothing is applied. prompt_limit sets or (null) removes the project\'s own prompt cap, as in Account Settings > Prompt Limits. Only the account owner or a co-owner whose permissions grant Projects update can send it (Account Settings > Prompt Limits lets any co-owner change it; here a co-owner, like every team member, also needs Projects update): any other team member gets ERR_INSUFFICIENT_PERMISSION, and a key limited to some projects ERR_KEY_PROJECT_SCOPED, with nothing applied. A request that sends only prompt_limit is applied even while a rematch runs. Requires a `read_write` scope API key.
+Updates the project name and profile, the same fields as Project Settings: name, brand_name, description, industry, business_model (plus business_model_other when it is OTHER), target_audience, brand_voice, goals, primary_products, matching_names, and the additional owned domains (additional_owned_domains). Send only the fields to change; unknown fields are rejected, and a request is applied whole or not at all. All seven Brand Book fields feed every GEO Writer task and prompt suggestions; only industry, description, and target_audience help Recommendations. A matching_names change re-runs mention/citation matching over the project history in the background, and an additional_owned_domains change reprocesses the past answers that cite an added or removed domain (rematching=true); further edits are rejected while that runs. Only the account owner can send additional_owned_domains: a team member key gets ERR_INSUFFICIENT_PERMISSION and nothing is applied. prompt_limit sets or (null) removes the project\'s own prompt cap, as in Account Settings > Prompt Limits. Only the account owner or a co-owner whose permissions grant Projects update can send it (Account Settings > Prompt Limits lets any co-owner change it; here a co-owner, like every team member, also needs Projects update): any other team member gets ERR_INSUFFICIENT_PERMISSION, and a key limited to some projects ERR_KEY_PROJECT_SCOPED, with nothing applied. A request that sends only prompt_limit is applied even while a rematch runs. pitch false, sent on its own, converts a pitch project into a tracked project, like Convert in the app: it keeps its answers and metrics, is no longer deleted, takes a project slot, and its prompts count against the prompt quota and run on the account\'s schedule from the next run. It cannot be undone and does not give back the month\'s pitch project. Converting needs the Projects update and create permissions (ERR_INSUFFICIENT_PERMISSION) and a key for the whole account (ERR_KEY_PROJECT_SCOPED); ERR_LIMIT_REACHED, with error.meta.limit, when the account has no project slot or prompts left or the project has more prompts or competitors than the plan allows per project, and ERR_INVALID_PARAM when the project is not a live pitch project. Requires a `read_write` scope API key.
 
 ### Example
 

package/docs/PromptsApi.md

@@ -25,7 +25,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 
 Accept suggested prompts
 
-Starts tracking up to 100 pending suggestions: each becomes a prompt in its own country and language, optionally put in one tag (tag_ids or tag_names; create_missing creates a missing name when the team member may create tags). Suggestions that are no longer pending come back in skipped. When the new prompts would exceed the plan the call returns ERR_LIMIT_REACHED and accepts nothing. Requires a `read_write` scope API key and, for team members, create access to Prompts.
+Starts tracking up to 100 pending suggestions: each becomes a prompt in its own country and language, optionally put in one tag (tag_ids or tag_names; create_missing creates a missing name when the team member may create tags). Suggestions that are no longer pending come back in skipped. When the new prompts would exceed the plan the call returns ERR_LIMIT_REACHED and accepts nothing. The prompts of a launched pitch project are fixed, so accepting a suggestion returns ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen. Requires a `read_write` scope API key and, for team members, create access to Prompts.
 
 ### Example
 
@@ -99,7 +99,7 @@ example().catch(console.error);
 
 Generate prompt suggestions
 
-Starts a suggestion run with one of the generators behind the app\'s Add prompts wizards and answers 202 with the run. website writes suggestions from the scraped website (80% non-brand, 20% brand; up to 100 per project, then ERR_LIMIT_REACHED), keyword from a keyword or the project profile (optionally around a competitor), topic from a topic, reddit from Reddit discussions of a topic or brand, paa from Google People Also Ask (up to 5 keywords, counted against the account\'s 24-hour lookup allowance), reputational from brand reputation questions, translate from the project\'s prompts of another locale, search_console from the connected property\'s top queries of the last 28 days (Growth plan or above, ERR_PLAN_REQUIRED). The suggestions land in the Suggested prompts queue; poll GET /prompt_generations/{id}, then accept the ones you want with POST /suggested_prompts/accept. Nothing is tracked until accepted. The request is validated before the run starts, and refused with ERR_LIMIT_REACHED when the plan has no prompt slot left, or ERR_QUOTA_EXCEEDED after 60 runs in an hour (the per-user prompt suggestion allowance, shared with project setup). Requires a `read_write` scope API key and, for team members, create access to Prompts.
+Starts a suggestion run with one of the generators behind the app\'s Add prompts wizards and answers 202 with the run. website writes suggestions from the scraped website (80% non-brand, 20% brand; up to 100 per project, then ERR_LIMIT_REACHED), keyword from a keyword or the project profile (optionally around a competitor), topic from a topic, reddit from Reddit discussions of a topic or brand, paa from Google People Also Ask (up to 5 keywords, counted against the account\'s 24-hour lookup allowance), reputational from brand reputation questions, translate from the project\'s prompts of another locale, search_console from the connected property\'s top queries of the last 28 days (Growth plan or above, ERR_PLAN_REQUIRED). The suggestions land in the Suggested prompts queue; poll GET /prompt_generations/{id}, then accept the ones you want with POST /suggested_prompts/accept. Nothing is tracked until accepted. The request is validated before the run starts, and refused with ERR_LIMIT_REACHED when the plan has no prompt slot left, ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen for a launched pitch project, whose prompts are fixed, or ERR_QUOTA_EXCEEDED after 60 runs in an hour (the per-user prompt suggestion allowance, shared with project setup). Requires a `read_write` scope API key and, for team members, create access to Prompts.
 
 ### Example
 
@@ -173,7 +173,7 @@ example().catch(console.error);
 
 Bulk-create prompts
 
-Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. When the project does not run on the schedule (paused, or beyond the plan\'s project limit) the prompts are still created, and the response says so with `tracked` false, `untracked_reason` and a `warning`. Requires a `read_write` scope API key.
+Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. When the project does not run on the schedule (paused, or beyond the plan\'s project limit) the prompts are still created, and the response says so with `tracked` false, `untracked_reason` and a `warning`. A pitch project holds at most 100 prompts in all, deleted ones included (ERR_LIMIT_REACHED past that), and the prompts of a launched pitch project are fixed, so adding one returns ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen. Requires a `read_write` scope API key.
 
 ### Example
 
@@ -246,7 +246,7 @@ example().catch(console.error);
 
 Delete a prompt
 
-Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. Requires a `read_write` scope API key.
+Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. The prompts of a launched pitch project are fixed, so deleting one returns ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen. Requires a `read_write` scope API key.
 
 ### Example
 
@@ -312,6 +312,7 @@ example().catch(console.error);
 | **200** | Deleted |  -  |
 | **403** | API key lacks write permission |  -  |
 | **404** | Resource not found |  -  |
+| **422** | Invalid parameters |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -398,7 +399,7 @@ example().catch(console.error);
 
 Import prompts
 
-The app\'s CSV import as JSON: up to 500 rows, each with its own prompt, country_code, language_code (codes or names; both default to the project\'s) and tags, created when missing. Duplicates are skipped and existing prompts still get the row\'s tags. The prompt limits are checked before anything is written: when the new prompts would exceed the plan the call returns ERR_LIMIT_REACHED and imports nothing. A row is skipped and comes back in row_errors when its country or language is unknown, when it would give a prompt more than 50 tags (rows repeating a prompt add up) or when its tags would take the request past 500 new tags. For a team member without create access to Tags, a row that needs a tag that does not exist yet is skipped and comes back in row_errors. For a team member without update access to Prompts, a row matching a prompt that already existed adds no tags to it, and comes back in row_errors when it would have added one. Responds 201 when it created prompts, 200 otherwise. `tracked` false, with `untracked_reason` and a `warning`, means the project does not run on the schedule, so the imported prompts do not run until that changes. Requires a `read_write` scope API key and, for team members, create access to Prompts.
+The app\'s CSV import as JSON: up to 500 rows, each with its own prompt, country_code, language_code (codes or names; both default to the project\'s) and tags, created when missing. Duplicates are skipped and existing prompts still get the row\'s tags. The prompt limits are checked before anything is written: when the new prompts would exceed the plan the call returns ERR_LIMIT_REACHED and imports nothing. A row is skipped and comes back in row_errors when its country or language is unknown, when it would give a prompt more than 50 tags (rows repeating a prompt add up) or when its tags would take the request past 500 new tags. For a team member without create access to Tags, a row that needs a tag that does not exist yet is skipped and comes back in row_errors. For a team member without update access to Prompts, a row matching a prompt that already existed adds no tags to it, and comes back in row_errors when it would have added one. Responds 201 when it created prompts, 200 otherwise. The prompts of a launched pitch project are fixed, so importing one returns ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen. `tracked` false, with `untracked_reason` and a `warning`, means the project does not run on the schedule, so the imported prompts do not run until that changes. Requires a `read_write` scope API key and, for team members, create access to Prompts.
 
 ### Example
 

package/docs/StoreIntegrationsApi.md

@@ -20,7 +20,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 
 Accept catalog prompt suggestions
 
-Starts tracking pending suggestions: each one becomes a prompt, tagged with a collection named after its product. Suggestions that are no longer pending come back in skipped. All accepted suggestions must share one country and language. When the new prompts would exceed the plan, the call returns ERR_LIMIT_REACHED and accepts nothing. Requires a `read_write` scope API key and, for team members, create access to Prompts. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
+Starts tracking pending suggestions: each one becomes a prompt, tagged with a collection named after its product. Suggestions that are no longer pending come back in skipped. All accepted suggestions must share one country and language. When the new prompts would exceed the plan, the call returns ERR_LIMIT_REACHED and accepts nothing. The prompts of a launched pitch project are fixed, so accepting a suggestion returns ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen. Requires a `read_write` scope API key and, for team members, create access to Prompts. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
 
 ### Example
 
@@ -169,7 +169,7 @@ example().catch(console.error);
 
 Match a store to a project
 
-Tells a store app whether the API key\'s account can use it and which project the store belongs to: the live project whose domain equals the store domain, else one whose domain is a parent or a subdomain of it, else null. candidates lists every live project of the account so the app can offer a picker. Takes no project_id. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
+Tells a store app whether the API key\'s account can use it and which project the store belongs to: the live project whose domain equals the store domain, else one whose domain is a parent or a subdomain of it, else null. candidates lists every live project of the account so the app can offer a picker. Pitch projects are never matched or listed, since a store is a data connection a pitch project does not take. Takes no project_id. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
 
 ### Example
 
@@ -487,7 +487,7 @@ example().catch(console.error);
 
 Replace AI-referred store orders for a window
 
-Replaces the daily AI-referred orders and revenue of the from..to window. Send the raw referring host or utm_source of each order\'s first visit as referrer: LLM Pulse classifies it and ignores anything that is not an AI assistant. Entries for the same day and assistant are summed. Every stored row of that project and platform inside the window is replaced, so pushing the same window again converges instead of counting twice. Rows are kept per project and platform, not per store, so one store reports per project. Requires a `read_write` scope API key and, for team members, update access to AI Traffic. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
+Replaces the daily AI-referred orders and revenue of the from..to window. Send the raw referring host or utm_source of each order\'s first visit as referrer: LLM Pulse classifies it and ignores anything that is not an AI assistant. Entries for the same day and assistant are summed. Every stored row of that project and platform inside the window is replaced, so pushing the same window again converges instead of counting twice. Rows are kept per project and platform, not per store, so one store reports per project. A pitch project takes no store data: pushing orders to one returns ERR_INVALID_PARAM. Requires a `read_write` scope API key and, for team members, update access to AI Traffic. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).
 
 ### Example
 

package/docs/TechnicalGEOReportsApi.md

@@ -257,7 +257,7 @@ example().catch(console.error);
 
 Revert llms.txt report content
 
-Discards every manual edit on the llms_txt report and restores the llms.txt and llms-full.txt files exactly as they were generated. Returns ERR_INVALID_PARAM when the report has no manual edits or report_type is not llms_txt. Requires a `read_write` scope API key and, for team members, create permission on GEO Optimization.
+Discards every manual edit on the llms_txt report and restores the llms.txt and llms-full.txt files exactly as they were generated. Returns ERR_INVALID_PARAM when the report has no manual edits or report_type is not llms_txt. Requires a `read_write` scope API key and, for team members, create permission on GEO Audits.
 
 ### Example
 
@@ -334,7 +334,7 @@ example().catch(console.error);
 
 Edit llms.txt report content
 
-Replaces the llms.txt and llms-full.txt files of a completed llms_txt report in place, without generating them again. `edits` maps llms_txt and/or llms_full_txt to the full replacement text. `content_version` must equal result_data.content_version of the report as last read; when the report changed since, the edit is refused as stale and the message names the current version. A missing or stale content_version, a blank file, a file over 200,000 characters, a value that is not text, an unknown file key, an empty `edits` object, a report that has not completed or a report_type other than llms_txt is rejected with ERR_INVALID_PARAM and nothing is written. Files are stored with Unix line endings and one trailing newline. A file identical to the stored one is ignored, and the response lists the files that actually changed. The first edit keeps the generated files in original_llms_txt_content and original_llms_full_txt_content so POST /technical_geo_reports/{id}/revert_content can restore them; running the report again creates a new report without these edits. Requires a `read_write` scope API key and, for team members, create permission on GEO Optimization.
+Replaces the llms.txt and llms-full.txt files of a completed llms_txt report in place, without generating them again. `edits` maps llms_txt and/or llms_full_txt to the full replacement text. `content_version` must equal result_data.content_version of the report as last read; when the report changed since, the edit is refused as stale and the message names the current version. A missing or stale content_version, a blank file, a file over 200,000 characters, a value that is not text, an unknown file key, an empty `edits` object, a report that has not completed or a report_type other than llms_txt is rejected with ERR_INVALID_PARAM and nothing is written. Files are stored with Unix line endings and one trailing newline. A file identical to the stored one is ignored, and the response lists the files that actually changed. The first edit keeps the generated files in original_llms_txt_content and original_llms_full_txt_content so POST /technical_geo_reports/{id}/revert_content can restore them; running the report again creates a new report without these edits. Requires a `read_write` scope API key and, for team members, create permission on GEO Audits.
 
 ### Example
 

package/docs/UpdateProjectRequest.md

@@ -19,6 +19,7 @@ Name | Type
 `matchingNames` | Array<string>
 `additionalOwnedDomains` | Array<string>
 `promptLimit` | number
+`pitch` | boolean
 
 ## Example
 
@@ -40,6 +41,7 @@ const example = {
   "matchingNames": null,
   "additionalOwnedDomains": null,
   "promptLimit": null,
+  "pitch": null,
 } satisfies UpdateProjectRequest
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llmpulse/sdk",
-  "version": "1.76.0",
+  "version": "1.77.0",
   "description": "OpenAPI client for @llmpulse/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AIAgentTrafficApi.ts

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

package/src/apis/AIModelInsightsApi.ts

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

package/src/apis/APIKeysApi.ts

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

package/src/apis/AccountApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.76.0
+ * The version of the OpenAPI document: 1.77.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,7 +39,7 @@ export interface AccountApiInterface {
     getAccountRequestOpts(): Promise<runtime.RequestOpts>;
 
     /**
-     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits, manual GEO audit runs in the last 24 hours and pitch projects created this month, with the account\'s pitch project access) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), limits.pitch_projects is absent, and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
      * @summary Account plan, quota usage and rate limits
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -48,7 +48,7 @@ export interface AccountApiInterface {
     getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount200Response>>;
 
     /**
-     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits, manual GEO audit runs in the last 24 hours and pitch projects created this month, with the account\'s pitch project access) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), limits.pitch_projects is absent, and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
      * Account plan, quota usage and rate limits
      */
     getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount200Response>;
@@ -88,7 +88,7 @@ export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
     }
 
     /**
-     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits, manual GEO audit runs in the last 24 hours and pitch projects created this month, with the account\'s pitch project access) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), limits.pitch_projects is absent, and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
      * Account plan, quota usage and rate limits
      */
     async getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount200Response>> {
@@ -99,7 +99,7 @@ export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
     }
 
     /**
-     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits, manual GEO audit runs in the last 24 hours and pitch projects created this month, with the account\'s pitch project access) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), limits.pitch_projects is absent, and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
      * Account plan, quota usage and rate limits
      */
     async getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount200Response> {

package/src/apis/AnnotationsApi.ts

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

package/src/apis/AnswersApi.ts

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

package/src/apis/CollectionsTagsApi.ts

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

package/src/apis/CompetitorsApi.ts

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

package/src/apis/CustomReportsApi.ts

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

package/src/apis/GEOAuditsApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.76.0
+ * The version of the OpenAPI document: 1.77.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -248,7 +248,7 @@ export interface GEOAuditsApiInterface {
     deleteGeoAuditRequestOpts(requestParameters: DeleteGeoAuditRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Optimization.
+     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Audits.
      * @summary Delete (archive) a GEO audit
      * @param {number} projectId Project ID
      * @param {string} id Audit id
@@ -259,7 +259,7 @@ export interface GEOAuditsApiInterface {
     deleteGeoAuditRaw(requestParameters: DeleteGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditArchived>>;
 
     /**
-     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Optimization.
+     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Audits.
      * Delete (archive) a GEO audit
      */
     deleteGeoAudit(requestParameters: DeleteGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditArchived>;
@@ -510,7 +510,7 @@ export interface GEOAuditsApiInterface {
     updateGeoAuditRequestOpts(requestParameters: UpdateGeoAuditRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * @summary Update a GEO audit
      * @param {string} id Audit id
      * @param {GeoAuditUpdateRequest} geoAuditUpdateRequest 
@@ -521,7 +521,7 @@ export interface GEOAuditsApiInterface {
     updateGeoAuditRaw(requestParameters: UpdateGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditResponse>>;
 
     /**
-     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Update a GEO audit
      */
     updateGeoAudit(requestParameters: UpdateGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditResponse>;
@@ -537,7 +537,7 @@ export interface GEOAuditsApiInterface {
     updateGeoAuditIssueRequestOpts(requestParameters: UpdateGeoAuditIssueRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * @summary Accept or reopen a GEO audit issue
      * @param {string} geoAuditId Audit id
      * @param {number} id Issue id
@@ -549,7 +549,7 @@ export interface GEOAuditsApiInterface {
     updateGeoAuditIssueRaw(requestParameters: UpdateGeoAuditIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditIssueResponse>>;
 
     /**
-     * Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Accept or reopen a GEO audit issue
      */
     updateGeoAuditIssue(requestParameters: UpdateGeoAuditIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditIssueResponse>;
@@ -737,7 +737,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Optimization.
+     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Audits.
      * Delete (archive) a GEO audit
      */
     async deleteGeoAuditRaw(requestParameters: DeleteGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditArchived>> {
@@ -748,7 +748,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Optimization.
+     * Archives the audit. Requires a `read_write` scope API key and, for team members, delete permission on GEO Audits.
      * Delete (archive) a GEO audit
      */
     async deleteGeoAudit(requestParameters: DeleteGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditArchived> {
@@ -1386,7 +1386,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Update a GEO audit
      */
     async updateGeoAuditRaw(requestParameters: UpdateGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditResponse>> {
@@ -1397,7 +1397,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Updates the schedule, the email alerts or the status. Making an audit recurring or resuming it counts against the plan limit of active recurring audits (ERR_LIMIT_REACHED). Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Update a GEO audit
      */
     async updateGeoAudit(requestParameters: UpdateGeoAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditResponse> {
@@ -1459,7 +1459,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Accept or reopen a GEO audit issue
      */
     async updateGeoAuditIssueRaw(requestParameters: UpdateGeoAuditIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GeoAuditIssueResponse>> {
@@ -1470,7 +1470,7 @@ export class GEOAuditsApi extends runtime.BaseAPI implements GEOAuditsApiInterfa
     }
 
     /**
-     * Requires a `read_write` scope API key and, for team members, update permission on GEO Optimization.
+     * Requires a `read_write` scope API key and, for team members, update permission on GEO Audits.
      * Accept or reopen a GEO audit issue
      */
     async updateGeoAuditIssue(requestParameters: UpdateGeoAuditIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GeoAuditIssueResponse> {

package/src/apis/GEOWriterApi.ts

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

package/src/apis/HealthApi.ts

@@ -4,7 +4,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.76.0
+ * The version of the OpenAPI document: 1.77.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -44,7 +44,7 @@ export interface HealthApiInterface {
     pingRequestOpts(requestParameters: PingRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id. The project object carries only id, name and brand_name; GET /dimensions/projects/{id} returns the rest, pitch and tracked included.
      * @summary Health check
      * @param {number} [projectId] Optional project to verify access for
      * @param {*} [options] Override http request option.
@@ -54,7 +54,7 @@ export interface HealthApiInterface {
     pingRaw(requestParameters: PingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Ping200Response>>;
 
     /**
-     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id. The project object carries only id, name and brand_name; GET /dimensions/projects/{id} returns the rest, pitch and tracked included.
      * Health check
      */
     ping(requestParameters: PingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Ping200Response>;
@@ -98,7 +98,7 @@ export class HealthApi extends runtime.BaseAPI implements HealthApiInterface {
     }
 
     /**
-     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id. The project object carries only id, name and brand_name; GET /dimensions/projects/{id} returns the rest, pitch and tracked included.
      * Health check
      */
     async pingRaw(requestParameters: PingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Ping200Response>> {
@@ -109,7 +109,7 @@ export class HealthApi extends runtime.BaseAPI implements HealthApiInterface {
     }
 
     /**
-     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id. The project object carries only id, name and brand_name; GET /dimensions/projects/{id} returns the rest, pitch and tracked included.
      * Health check
      */
     async ping(requestParameters: PingRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Ping200Response> {