@llmpulse/sdk 0.0.0-stage → 1.59.0

package/docs/ReputationStudiesApi.md

@@ -0,0 +1,436 @@
+# ReputationStudiesApi
+
+All URIs are relative to *https://api.llmpulse.ai/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getReputationReport**](ReputationStudiesApi.md#getreputationreport) | **GET** /reputation/reports/{id} | Get reputation report scores |
+| [**getStudy**](ReputationStudiesApi.md#getstudy) | **GET** /studies/{id} | Get a custom AI study |
+| [**getStudyReport**](ReputationStudiesApi.md#getstudyreport) | **GET** /studies/{id}/reports/{report_id} | Get custom study report scores |
+| [**listReputationReports**](ReputationStudiesApi.md#listreputationreports) | **GET** /reputation/reports | List reputation reports |
+| [**listStudies**](ReputationStudiesApi.md#liststudies) | **GET** /studies | List custom AI studies |
+
+
+
+## getReputationReport
+
+> getReputationReport(id, projectId, page, perPage, model, brand, dimension, output)
+
+Get reputation report scores
+
+One reputation report\'s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReputationStudiesApi,
+} from '@llmpulse/sdk';
+import type { GetReputationReportRequest } 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 ReputationStudiesApi(config);
+
+  const body = {
+    // string | The report id from GET /reputation/reports
+    id: id_example,
+    // number | Project ID
+    projectId: 56,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    perPage: 56,
+    // 'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude' | Restrict to one analyst model (optional)
+    model: model_example,
+    // string | Restrict to one brand name, or a comma-separated list (optional)
+    brand: brand_example,
+    // string | Restrict to one reputation dimension key (optional)
+    dimension: dimension_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 GetReputationReportRequest;
+
+  try {
+    const data = await api.getReputationReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | The report id from GET /reputation/reports | [Defaults to `undefined`] |
+| **projectId** | `number` | Project ID | [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **perPage** | `number` |  | [Optional] [Defaults to `20`] |
+| **model** | `chatgpt`, `perplexity`, `gemini`, `deepseek`, `grok`, `claude` | Restrict to one analyst model | [Optional] [Defaults to `undefined`] [Enum: chatgpt, perplexity, gemini, deepseek, grok, claude] |
+| **brand** | `string` | Restrict to one brand name, or a comma-separated list | [Optional] [Defaults to `undefined`] |
+| **dimension** | `string` | Restrict to one reputation dimension key | [Optional] [Defaults to `undefined`] |
+| **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
+
+`void` (Empty response body)
+
+### 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 score rows plus the report summary |  -  |
+| **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)
+
+
+## getStudy
+
+> getStudy(id)
+
+Get a custom AI study
+
+One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReputationStudiesApi,
+} from '@llmpulse/sdk';
+import type { GetStudyRequest } 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 ReputationStudiesApi(config);
+
+  const body = {
+    // number
+    id: 56,
+  } satisfies GetStudyRequest;
+
+  try {
+    const data = await api.getStudy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The study |  -  |
+| **404** | Resource not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStudyReport
+
+> getStudyReport(id, reportId, page, perPage, model, subject, dimension, output)
+
+Get custom study report scores
+
+One custom-study report\'s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReputationStudiesApi,
+} from '@llmpulse/sdk';
+import type { GetStudyReportRequest } 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 ReputationStudiesApi(config);
+
+  const body = {
+    // number
+    id: 56,
+    // string | The report id from GET /studies/{id}
+    reportId: reportId_example,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    perPage: 56,
+    // 'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude' | Restrict to one analyst model (optional)
+    model: model_example,
+    // string | Restrict to one subject name, or a comma-separated list (optional)
+    subject: subject_example,
+    // string | Restrict to one dimension key (optional)
+    dimension: dimension_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 GetStudyReportRequest;
+
+  try {
+    const data = await api.getStudyReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` |  | [Defaults to `undefined`] |
+| **reportId** | `string` | The report id from GET /studies/{id} | [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **perPage** | `number` |  | [Optional] [Defaults to `20`] |
+| **model** | `chatgpt`, `perplexity`, `gemini`, `deepseek`, `grok`, `claude` | Restrict to one analyst model | [Optional] [Defaults to `undefined`] [Enum: chatgpt, perplexity, gemini, deepseek, grok, claude] |
+| **subject** | `string` | Restrict to one subject name, or a comma-separated list | [Optional] [Defaults to `undefined`] |
+| **dimension** | `string` | Restrict to one dimension key | [Optional] [Defaults to `undefined`] |
+| **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
+
+`void` (Empty response body)
+
+### 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 score rows plus the report summary |  -  |
+| **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)
+
+
+## listReputationReports
+
+> listReputationReports(projectId, page, perPage, output)
+
+List reputation reports
+
+The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReputationStudiesApi,
+} from '@llmpulse/sdk';
+import type { ListReputationReportsRequest } 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 ReputationStudiesApi(config);
+
+  const body = {
+    // number | Project ID
+    projectId: 56,
+    // 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 ListReputationReportsRequest;
+
+  try {
+    const data = await api.listReputationReports(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`] |
+| **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
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated report summaries |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listStudies
+
+> listStudies(projectId, status, page, perPage, output)
+
+List custom AI studies
+
+The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReputationStudiesApi,
+} from '@llmpulse/sdk';
+import type { ListStudiesRequest } 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 ReputationStudiesApi(config);
+
+  const body = {
+    // number | Restrict to studies attached to this project (plus account-level ones) (optional)
+    projectId: 56,
+    // 'active' | 'archived' (optional)
+    status: status_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 ListStudiesRequest;
+
+  try {
+    const data = await api.listStudies(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `number` | Restrict to studies attached to this project (plus account-level ones) | [Optional] [Defaults to `undefined`] |
+| **status** | `active`, `archived` |  | [Optional] [Defaults to `undefined`] [Enum: active, archived] |
+| **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
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated study summaries |  -  |
+
+[[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/RevokeTeamInvitation200Response.md

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

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

@@ -0,0 +1,42 @@
+
+# SampleWebhookPayloads200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`event` | string
+`occurredAt` | Date
+`projectId` | number
+`subscriptionId` | number
+`data` | object
+
+## Example
+
+```typescript
+import type { SampleWebhookPayloads200ResponseDataInner } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "event": null,
+  "occurredAt": null,
+  "projectId": null,
+  "subscriptionId": null,
+  "data": null,
+} satisfies SampleWebhookPayloads200ResponseDataInner
+
+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 SampleWebhookPayloads200ResponseDataInner
+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)
+
+