@llmpulse/sdk 1.62.0 → 1.64.0

package/docs/PromptsImportResponseRowErrorsInner.md

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

@@ -0,0 +1,69 @@
+
+# RecommendationItem
+
+One recommendation item, in the shape GET /recommendations/{id} lists items
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`recommendationId` | number
+`recommendationType` | string
+`category` | string
+`title` | string
+`description` | string
+`priority` | string
+`estimatedImpact` | string
+`actionItems` | Array<string>
+`sourceRefs` | Array<string>
+`status` | string
+`statusChangedAt` | Date
+`position` | number
+`metadata` | { [key: string]: any; }
+`createdAt` | Date
+`updatedAt` | Date
+`resolvedSourceRefs` | Array<{ [key: string]: any; }>
+`unresolvedSourceRefs` | Array<string>
+
+## Example
+
+```typescript
+import type { RecommendationItem } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "recommendationId": null,
+  "recommendationType": null,
+  "category": null,
+  "title": null,
+  "description": null,
+  "priority": null,
+  "estimatedImpact": null,
+  "actionItems": null,
+  "sourceRefs": null,
+  "status": null,
+  "statusChangedAt": null,
+  "position": null,
+  "metadata": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "resolvedSourceRefs": null,
+  "unresolvedSourceRefs": null,
+} satisfies RecommendationItem
+
+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 RecommendationItem
+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/RecommendationItemUpdateResponse.md

@@ -0,0 +1,38 @@
+
+# RecommendationItemUpdateResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`item` | [RecommendationItem](RecommendationItem.md)
+`requestId` | string
+
+## Example
+
+```typescript
+import type { RecommendationItemUpdateResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "item": null,
+  "requestId": null,
+} satisfies RecommendationItemUpdateResponse
+
+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 RecommendationItemUpdateResponse
+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/RecommendationsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.llmpulse.ai/api/v1*
 | [**getRecommendation**](RecommendationsApi.md#getrecommendation) | **GET** /recommendations/{id} | Get recommendation run with items |
 | [**launchRecommendations**](RecommendationsApi.md#launchrecommendationsoperation) | **POST** /recommendations | Launch a recommendations generation |
 | [**listRecommendations**](RecommendationsApi.md#listrecommendations) | **GET** /recommendations | List recommendation runs |
+| [**updateRecommendationItem**](RecommendationsApi.md#updaterecommendationitemoperation) | **PATCH** /recommendations/{id}/items/{item_id} | Complete, archive or restore a recommendation item |
 
 
 
@@ -242,3 +243,83 @@ 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)
 
+
+## updateRecommendationItem
+
+> RecommendationItemUpdateResponse updateRecommendationItem(id, itemId, updateRecommendationItemRequest)
+
+Complete, archive or restore a recommendation item
+
+Moves one item of a recommendation run between `active`, `completed` and `archived`, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps `status_changed_at`. Returns the item in the shape `GET /recommendations/{id}` lists items. Requires a `read_write` scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecommendationsApi,
+} from '@llmpulse/sdk';
+import type { UpdateRecommendationItemOperationRequest } 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 RecommendationsApi(config);
+
+  const body = {
+    // number | Recommendation run id
+    id: 56,
+    // number | Item id, from the items of GET /recommendations/{id}
+    itemId: 56,
+    // UpdateRecommendationItemRequest
+    updateRecommendationItemRequest: ...,
+  } satisfies UpdateRecommendationItemOperationRequest;
+
+  try {
+    const data = await api.updateRecommendationItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | Recommendation run id | [Defaults to `undefined`] |
+| **itemId** | `number` | Item id, from the items of GET /recommendations/{id} | [Defaults to `undefined`] |
+| **updateRecommendationItemRequest** | [UpdateRecommendationItemRequest](UpdateRecommendationItemRequest.md) |  | |
+
+### Return type
+
+[**RecommendationItemUpdateResponse**](RecommendationItemUpdateResponse.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** | The updated item |  -  |
+| **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)
+

package/docs/RemovePromptTagsRequest.md

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

@@ -119,7 +119,7 @@ example().catch(console.error);
 | **403** | Plan below Growth (ERR_PLAN_REQUIRED), or Google revoked the project\'s Search Console access (ERR_SEARCH_CONSOLE_ACCESS_REVOKED): reconnect the property |  -  |
 | **404** | Resource not found |  -  |
 | **422** | Invalid parameters |  -  |
-| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header |  * Retry-After - Seconds to wait before retrying: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage <br>  |
+| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage |  * Retry-After - Seconds to wait before retrying <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -231,7 +231,7 @@ example().catch(console.error);
 | **403** | Plan below Growth (ERR_PLAN_REQUIRED), or Google revoked the project\&#39;s Search Console access (ERR_SEARCH_CONSOLE_ACCESS_REVOKED): reconnect the property |  -  |
 | **404** | Resource not found |  -  |
 | **422** | Invalid parameters |  -  |
-| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header |  * Retry-After - Seconds to wait before retrying: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage <br>  |
+| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage |  * Retry-After - Seconds to wait before retrying <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -346,7 +346,7 @@ example().catch(console.error);
 | **403** | Plan below Growth (ERR_PLAN_REQUIRED), or Google revoked the project\&#39;s Search Console access (ERR_SEARCH_CONSOLE_ACCESS_REVOKED): reconnect the property |  -  |
 | **404** | Resource not found |  -  |
 | **422** | Invalid parameters |  -  |
-| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header |  * Retry-After - Seconds to wait before retrying: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage <br>  |
+| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage |  * Retry-After - Seconds to wait before retrying <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -449,7 +449,7 @@ example().catch(console.error);
 | **403** | Plan below Growth (ERR_PLAN_REQUIRED), or Google revoked the project\&#39;s Search Console access (ERR_SEARCH_CONSOLE_ACCESS_REVOKED): reconnect the property |  -  |
 | **404** | Resource not found |  -  |
 | **422** | Invalid parameters |  -  |
-| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header |  * Retry-After - Seconds to wait before retrying: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage <br>  |
+| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage |  * Retry-After - Seconds to wait before retrying <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -552,7 +552,7 @@ example().catch(console.error);
 | **403** | Plan below Growth (ERR_PLAN_REQUIRED), or Google revoked the project\&#39;s Search Console access (ERR_SEARCH_CONSOLE_ACCESS_REVOKED): reconnect the property |  -  |
 | **404** | Resource not found |  -  |
 | **422** | Invalid parameters |  -  |
-| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header |  * Retry-After - Seconds to wait before retrying: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage <br>  |
+| **503** | Upstream provider unavailable, retry after the number of seconds in the Retry-After header: Google\&#39;s own value when it sent one, otherwise 900 after a quota error and 60 after an outage |  * Retry-After - Seconds to wait before retrying <br>  |
 
 [[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/SendCustomReportRequest.md

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

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

@@ -0,0 +1,48 @@
+
+# SentimentBreakdownCounts
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mentions` | number
+`positive` | number
+`neutral` | number
+`negative` | number
+`positivePct` | number
+`neutralPct` | number
+`negativePct` | number
+`netScore` | number
+
+## Example
+
+```typescript
+import type { SentimentBreakdownCounts } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mentions": null,
+  "positive": null,
+  "neutral": null,
+  "negative": null,
+  "positivePct": null,
+  "neutralPct": null,
+  "negativePct": null,
+  "netScore": null,
+} satisfies SentimentBreakdownCounts
+
+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 SentimentBreakdownCounts
+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/SentimentBreakdownEnvelope.md

@@ -0,0 +1,42 @@
+
+# SentimentBreakdownEnvelope
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`from` | Date
+`to` | Date
+`brand` | [SentimentBreakdownBrand](SentimentBreakdownBrand.md)
+`sort` | string
+`sortDir` | string
+
+## Example
+
+```typescript
+import type { SentimentBreakdownEnvelope } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "from": null,
+  "to": null,
+  "brand": null,
+  "sort": null,
+  "sortDir": null,
+} satisfies SentimentBreakdownEnvelope
+
+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 SentimentBreakdownEnvelope
+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/SentimentTagRow.md

@@ -0,0 +1,52 @@
+
+# SentimentTagRow
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mentions` | number
+`positive` | number
+`neutral` | number
+`negative` | number
+`positivePct` | number
+`neutralPct` | number
+`negativePct` | number
+`netScore` | number
+`tagId` | number
+`tag` | string
+
+## Example
+
+```typescript
+import type { SentimentTagRow } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mentions": null,
+  "positive": null,
+  "neutral": null,
+  "negative": null,
+  "positivePct": null,
+  "neutralPct": null,
+  "negativePct": null,
+  "netScore": null,
+  "tagId": null,
+  "tag": null,
+} satisfies SentimentTagRow
+
+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 SentimentTagRow
+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/SentimentTagsResponse.md

@@ -0,0 +1,54 @@
+
+# SentimentTagsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`page` | number
+`perPage` | number
+`total` | number
+`requestId` | string
+`from` | Date
+`to` | Date
+`brand` | [SentimentBreakdownBrand](SentimentBreakdownBrand.md)
+`sort` | string
+`sortDir` | string
+`data` | [Array<SentimentTagRow>](SentimentTagRow.md)
+
+## Example
+
+```typescript
+import type { SentimentTagsResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "page": null,
+  "perPage": null,
+  "total": null,
+  "requestId": null,
+  "from": null,
+  "to": null,
+  "brand": null,
+  "sort": null,
+  "sortDir": null,
+  "data": null,
+} satisfies SentimentTagsResponse
+
+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 SentimentTagsResponse
+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/SentimentTopicRow.md

@@ -0,0 +1,50 @@
+
+# SentimentTopicRow
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mentions` | number
+`positive` | number
+`neutral` | number
+`negative` | number
+`positivePct` | number
+`neutralPct` | number
+`negativePct` | number
+`netScore` | number
+`topic` | string
+
+## Example
+
+```typescript
+import type { SentimentTopicRow } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mentions": null,
+  "positive": null,
+  "neutral": null,
+  "negative": null,
+  "positivePct": null,
+  "neutralPct": null,
+  "negativePct": null,
+  "netScore": null,
+  "topic": null,
+} satisfies SentimentTopicRow
+
+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 SentimentTopicRow
+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)
+
+