@llmpulse/sdk 1.62.0 → 1.63.0

package/docs/CollectionsTagsApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 | [**deleteCollection**](CollectionsTagsApi.md#deletecollection) | **DELETE** /collections/{id} | Delete a tag |
 | [**listCollections**](CollectionsTagsApi.md#listcollections) | **GET** /dimensions/collections | List tags/collections |
 | [**listTags**](CollectionsTagsApi.md#listtags) | **GET** /dimensions/tags | List tags (alias for /collections) |
+| [**removePromptTags**](CollectionsTagsApi.md#removeprompttagsoperation) | **POST** /prompts/remove_tags | Bulk-detach tags from prompts |
 | [**updateCollection**](CollectionsTagsApi.md#updatecollectionoperation) | **PATCH** /collections/{id} | Update a tag |
 
 
@@ -379,6 +380,79 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## removePromptTags
+
+> PromptTagsRemoveResponse removePromptTags(removePromptTagsRequest)
+
+Bulk-detach tags from prompts
+
+Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CollectionsTagsApi,
+} from '@llmpulse/sdk';
+import type { RemovePromptTagsOperationRequest } from '@llmpulse/sdk';
+
+async function example() {
+  console.log("🚀 Testing @llmpulse/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CollectionsTagsApi(config);
+
+  const body = {
+    // RemovePromptTagsRequest
+    removePromptTagsRequest: ...,
+  } satisfies RemovePromptTagsOperationRequest;
+
+  try {
+    const data = await api.removePromptTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **removePromptTagsRequest** | [RemovePromptTagsRequest](RemovePromptTagsRequest.md) |  | |
+
+### Return type
+
+[**PromptTagsRemoveResponse**](PromptTagsRemoveResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Tags detached |  -  |
+| **403** | API key lacks write permission |  -  |
+| **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)
+
+
 ## updateCollection
 
 > updateCollection(id, updateCollectionRequest)

package/docs/CompetitorDiscoveryState.md

@@ -0,0 +1,38 @@
+
+# CompetitorDiscoveryState
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`loading` | boolean
+`generatedAt` | Date
+
+## Example
+
+```typescript
+import type { CompetitorDiscoveryState } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "loading": null,
+  "generatedAt": null,
+} satisfies CompetitorDiscoveryState
+
+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 CompetitorDiscoveryState
+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/CompetitorSuggestion.md

@@ -0,0 +1,44 @@
+
+# CompetitorSuggestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`domain` | string
+`brandName` | string
+`matchingNames` | Array<string>
+`mentions` | number
+`citations` | number
+
+## Example
+
+```typescript
+import type { CompetitorSuggestion } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "domain": null,
+  "brandName": null,
+  "matchingNames": null,
+  "mentions": null,
+  "citations": null,
+} satisfies CompetitorSuggestion
+
+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 CompetitorSuggestion
+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/CompetitorSuggestionsResponse.md

@@ -0,0 +1,48 @@
+
+# CompetitorSuggestionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`page` | number
+`perPage` | number
+`total` | number
+`requestId` | string
+`basis` | string
+`discovery` | [CompetitorDiscoveryState](CompetitorDiscoveryState.md)
+`data` | [Array<CompetitorSuggestion>](CompetitorSuggestion.md)
+
+## Example
+
+```typescript
+import type { CompetitorSuggestionsResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "page": null,
+  "perPage": null,
+  "total": null,
+  "requestId": null,
+  "basis": null,
+  "discovery": null,
+  "data": null,
+} satisfies CompetitorSuggestionsResponse
+
+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 CompetitorSuggestionsResponse
+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/CompetitorsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 | [**createCompetitor**](CompetitorsApi.md#createcompetitoroperation) | **POST** /competitors | Add a competitor |
 | [**deleteCompetitor**](CompetitorsApi.md#deletecompetitor) | **DELETE** /competitors/{id} | Delete a competitor |
 | [**getCompetitorDetails**](CompetitorsApi.md#getcompetitordetails) | **GET** /dimensions/competitors/{id} | Competitor details |
+| [**listCompetitorSuggestions**](CompetitorsApi.md#listcompetitorsuggestions) | **GET** /competitors/suggestions | List competitor suggestions |
 | [**listCompetitors**](CompetitorsApi.md#listcompetitors) | **GET** /dimensions/competitors | List competitors |
 | [**updateCompetitor**](CompetitorsApi.md#updatecompetitoroperation) | **PATCH** /competitors/{id} | Update a competitor |
 
@@ -233,6 +234,93 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## listCompetitorSuggestions
+
+> CompetitorSuggestionsResponse listCompetitorSuggestions(projectId, basis, query, page, perPage, output)
+
+List competitor suggestions
+
+The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CompetitorsApi,
+} from '@llmpulse/sdk';
+import type { ListCompetitorSuggestionsRequest } from '@llmpulse/sdk';
+
+async function example() {
+  console.log("🚀 Testing @llmpulse/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CompetitorsApi(config);
+
+  const body = {
+    // number | Project ID
+    projectId: 56,
+    // 'brands' | 'citations' (optional)
+    basis: basis_example,
+    // string | Only suggestions whose brand name or domain contains this text (optional)
+    query: query_example,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    perPage: 56,
+    // '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 ListCompetitorSuggestionsRequest;
+
+  try {
+    const data = await api.listCompetitorSuggestions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `number` | Project ID | [Defaults to `undefined`] |
+| **basis** | `brands`, `citations` |  | [Optional] [Defaults to `'brands'`] [Enum: brands, citations] |
+| **query** | `string` | Only suggestions whose brand name or domain contains this text | [Optional] [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **perPage** | `number` |  | [Optional] [Defaults to `20`] |
+| **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
+
+[**CompetitorSuggestionsResponse**](CompetitorSuggestionsResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated suggestions |  -  |
+| **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)
+
+
 ## listCompetitors
 
 > ListCompetitors200Response listCompetitors(projectId, includeProjectBrand, output)

package/docs/CustomReportBlock.md

@@ -0,0 +1,38 @@
+
+# CustomReportBlock
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`key` | string
+`text` | string
+
+## Example
+
+```typescript
+import type { CustomReportBlock } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "key": null,
+  "text": null,
+} satisfies CustomReportBlock
+
+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 CustomReportBlock
+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/CustomReportDateRange.md

@@ -0,0 +1,42 @@
+
+# CustomReportDateRange
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`rangeDays` | number
+`from` | Date
+`to` | Date
+`label` | string
+
+## Example
+
+```typescript
+import type { CustomReportDateRange } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "rangeDays": null,
+  "from": null,
+  "to": null,
+  "label": null,
+} satisfies CustomReportDateRange
+
+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 CustomReportDateRange
+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/CustomReportDetailResponse.md

@@ -0,0 +1,74 @@
+
+# CustomReportDetailResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`id` | number
+`name` | string
+`dateRange` | [CustomReportDateRange](CustomReportDateRange.md)
+`schedule` | [CustomReportSchedule](CustomReportSchedule.md)
+`recipientsCount` | number
+`published` | boolean
+`publicLinkActive` | boolean
+`passwordProtected` | boolean
+`portalOnly` | boolean
+`lastSentAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`filters` | [CustomReportFilters](CustomReportFilters.md)
+`comparePrevious` | boolean
+`attachExcel` | boolean
+`manualSendAvailableAt` | Date
+`generatedAt` | Date
+`blocks` | [Array<CustomReportBlock>](CustomReportBlock.md)
+`widgets` | [Array<CustomReportWidget>](CustomReportWidget.md)
+`requestId` | string
+
+## Example
+
+```typescript
+import type { CustomReportDetailResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "id": null,
+  "name": null,
+  "dateRange": null,
+  "schedule": null,
+  "recipientsCount": null,
+  "published": null,
+  "publicLinkActive": null,
+  "passwordProtected": null,
+  "portalOnly": null,
+  "lastSentAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "filters": null,
+  "comparePrevious": null,
+  "attachExcel": null,
+  "manualSendAvailableAt": null,
+  "generatedAt": null,
+  "blocks": null,
+  "widgets": null,
+  "requestId": null,
+} satisfies CustomReportDetailResponse
+
+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 CustomReportDetailResponse
+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/CustomReportFilters.md

@@ -0,0 +1,40 @@
+
+# CustomReportFilters
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`models` | Array<string>
+`collectionIds` | Array<number>
+`brandKind` | string
+`competitorIds` | Array<number>
+
+## Example
+
+```typescript
+import type { CustomReportFilters } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "models": null,
+  "collectionIds": null,
+  "brandKind": null,
+  "competitorIds": null,
+} satisfies CustomReportFilters
+
+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 CustomReportFilters
+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/CustomReportSchedule.md

@@ -0,0 +1,40 @@
+
+# CustomReportSchedule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`dayOfWeek` | number
+`hour` | number
+`timezone` | string
+
+## Example
+
+```typescript
+import type { CustomReportSchedule } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "dayOfWeek": null,
+  "hour": null,
+  "timezone": null,
+} satisfies CustomReportSchedule
+
+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 CustomReportSchedule
+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/CustomReportSendResponse.md

@@ -0,0 +1,42 @@
+
+# CustomReportSendResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`id` | number
+`status` | string
+`recipientsCount` | number
+`requestId` | string
+
+## Example
+
+```typescript
+import type { CustomReportSendResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "id": null,
+  "status": null,
+  "recipientsCount": null,
+  "requestId": null,
+} satisfies CustomReportSendResponse
+
+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 CustomReportSendResponse
+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/CustomReportSummary.md

@@ -0,0 +1,60 @@
+
+# CustomReportSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`dateRange` | [CustomReportDateRange](CustomReportDateRange.md)
+`schedule` | [CustomReportSchedule](CustomReportSchedule.md)
+`recipientsCount` | number
+`published` | boolean
+`publicLinkActive` | boolean
+`passwordProtected` | boolean
+`portalOnly` | boolean
+`widgetCount` | number
+`widgets` | [Array<CustomReportWidgetRef>](CustomReportWidgetRef.md)
+`lastSentAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { CustomReportSummary } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "dateRange": null,
+  "schedule": null,
+  "recipientsCount": null,
+  "published": null,
+  "publicLinkActive": null,
+  "passwordProtected": null,
+  "portalOnly": null,
+  "widgetCount": null,
+  "widgets": null,
+  "lastSentAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies CustomReportSummary
+
+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 CustomReportSummary
+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)
+
+