@llmpulse/sdk 1.61.0 → 1.63.0

package/docs/CustomReportsResponse.md

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

@@ -244,7 +244,7 @@ example().catch(console.error);
 
 Revert GEO Writer task content
 
-Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
 
 ### Example
 
@@ -321,7 +321,7 @@ example().catch(console.error);
 
 Edit GEO Writer task content
 
-Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
 
 ### Example
 

package/docs/OwnedMediaAgeBucketShare.md

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

@@ -0,0 +1,49 @@
+
+# OwnedMediaCitedItem
+
+The post, video, profile or channel. Null when nothing in the window matches it
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | string
+`title` | string
+`subtitle` | string
+`url` | string
+`imageUrl` | string
+`yours` | boolean
+`date` | Date
+`stats` | [OwnedMediaCitedItemStats](OwnedMediaCitedItemStats.md)
+
+## Example
+
+```typescript
+import type { OwnedMediaCitedItem } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": null,
+  "title": null,
+  "subtitle": null,
+  "url": null,
+  "imageUrl": null,
+  "yours": null,
+  "date": null,
+  "stats": null,
+} satisfies OwnedMediaCitedItem
+
+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 OwnedMediaCitedItem
+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/OwnedMediaCitedItemStats.md

@@ -0,0 +1,47 @@
+
+# OwnedMediaCitedItemStats
+
+The counts the platform reports for the item; absent keys are unknown
+
+## Properties
+
+Name | Type
+------------ | -------------
+`citations` | number
+`likes` | number
+`comments` | number
+`views` | number
+`followers` | number
+`uniquePosts` | number
+`uniqueVideos` | number
+
+## Example
+
+```typescript
+import type { OwnedMediaCitedItemStats } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "citations": null,
+  "likes": null,
+  "comments": null,
+  "views": null,
+  "followers": null,
+  "uniquePosts": null,
+  "uniqueVideos": null,
+} satisfies OwnedMediaCitedItemStats
+
+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 OwnedMediaCitedItemStats
+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/OwnedMediaCitingAnswer.md

@@ -0,0 +1,50 @@
+
+# OwnedMediaCitingAnswer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`answerId` | number
+`promptId` | number
+`promptText` | string
+`model` | string
+`countryCode` | string
+`languageCode` | string
+`executedAt` | Date
+`excerpt` | string
+`appUrl` | string
+
+## Example
+
+```typescript
+import type { OwnedMediaCitingAnswer } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "answerId": null,
+  "promptId": null,
+  "promptText": null,
+  "model": null,
+  "countryCode": null,
+  "languageCode": null,
+  "executedAt": null,
+  "excerpt": null,
+  "appUrl": null,
+} satisfies OwnedMediaCitingAnswer
+
+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 OwnedMediaCitingAnswer
+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/OwnedMediaCitingPromptsResponse.md

@@ -0,0 +1,56 @@
+
+# OwnedMediaCitingPromptsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`provider` | string
+`from` | Date
+`to` | Date
+`item` | [OwnedMediaCitedItem](OwnedMediaCitedItem.md)
+`citationCount` | number
+`promptCount` | number
+`page` | number
+`perPage` | number
+`total` | number
+`data` | [Array<OwnedMediaCitingAnswer>](OwnedMediaCitingAnswer.md)
+`requestId` | string
+
+## Example
+
+```typescript
+import type { OwnedMediaCitingPromptsResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "provider": null,
+  "from": null,
+  "to": null,
+  "item": null,
+  "citationCount": null,
+  "promptCount": null,
+  "page": null,
+  "perPage": null,
+  "total": null,
+  "data": null,
+  "requestId": null,
+} satisfies OwnedMediaCitingPromptsResponse
+
+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 OwnedMediaCitingPromptsResponse
+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)
+
+