blanche-client-sdk 0.4.0 → 0.6.0

package/docs/ApiV1ChatsIdReportsPostRequestPlannerParams.md

@@ -0,0 +1,50 @@
+
+# ApiV1ChatsIdReportsPostRequestPlannerParams
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`from` | Date
+`to` | Date
+`lastDays` | number
+`interval` | string
+`aggregation` | string
+`metric` | string
+`templates` | Array<string>
+`metrics` | Array<string>
+`filters` | [Array<ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner>](ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.md)
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdReportsPostRequestPlannerParams } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "from": null,
+  "to": null,
+  "lastDays": null,
+  "interval": null,
+  "aggregation": null,
+  "metric": null,
+  "templates": null,
+  "metrics": null,
+  "filters": null,
+} satisfies ApiV1ChatsIdReportsPostRequestPlannerParams
+
+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 ApiV1ChatsIdReportsPostRequestPlannerParams
+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/ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.md

@@ -0,0 +1,38 @@
+
+# ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`op` | string
+`value` | any
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "op": null,
+  "value": null,
+} satisfies ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner
+
+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 ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner
+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/ApiV1ChatsIdRunsRunIdCitationsGet200Response.md

@@ -0,0 +1,36 @@
+
+# ApiV1ChatsIdRunsRunIdCitationsGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runId` | string
+`citations` | [Array<ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner>](ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.md)
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdRunsRunIdCitationsGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runId": null,
+  "citations": null,
+} satisfies ApiV1ChatsIdRunsRunIdCitationsGet200Response
+
+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 ApiV1ChatsIdRunsRunIdCitationsGet200Response
+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/ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.md

@@ -0,0 +1,40 @@
+
+# ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`toolName` | string
+`rowsCount` | number
+`sourceMetadata` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "toolName": null,
+  "rowsCount": null,
+  "sourceMetadata": null,
+} satisfies ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner
+
+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 ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner
+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/ApiV1ChatsIdRunsRunIdGet200Response.md

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsIdRunsRunIdGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sessionId` | string
+`status` | string
+`retrievalStrategy` | string
+`requestUuid` | string
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdRunsRunIdGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sessionId": null,
+  "status": null,
+  "retrievalStrategy": null,
+  "requestUuid": null,
+} satisfies ApiV1ChatsIdRunsRunIdGet200Response
+
+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 ApiV1ChatsIdRunsRunIdGet200Response
+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/ApiV1ChatsIdRunsRunIdRetryPost201Response.md

@@ -0,0 +1,40 @@
+
+# ApiV1ChatsIdRunsRunIdRetryPost201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`retrievalStrategy` | string
+`metadata` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdRunsRunIdRetryPost201Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "retrievalStrategy": null,
+  "metadata": null,
+} satisfies ApiV1ChatsIdRunsRunIdRetryPost201Response
+
+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 ApiV1ChatsIdRunsRunIdRetryPost201Response
+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/ApiV1ChatsIdSavedReportsGet200Response.md

@@ -0,0 +1,34 @@
+
+# ApiV1ChatsIdSavedReportsGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`savedReports` | [Array<ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner>](ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.md)
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdSavedReportsGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "savedReports": null,
+} satisfies ApiV1ChatsIdSavedReportsGet200Response
+
+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 ApiV1ChatsIdSavedReportsGet200Response
+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/ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.md

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`runId` | string
+`title` | string
+`report` | object
+`chartSpec` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "runId": null,
+  "title": null,
+  "report": null,
+  "chartSpec": null,
+} satisfies ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner
+
+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 ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner
+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/ApiV1ChatsIdSavedReportsPostRequest.md

@@ -0,0 +1,36 @@
+
+# ApiV1ChatsIdSavedReportsPostRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runId` | string
+`title` | string
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdSavedReportsPostRequest } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runId": null,
+  "title": null,
+} satisfies ApiV1ChatsIdSavedReportsPostRequest
+
+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 ApiV1ChatsIdSavedReportsPostRequest
+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/ApiV1ChatsPlannerContractGet200Response.md

@@ -0,0 +1,36 @@
+
+# ApiV1ChatsPlannerContractGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`version` | string
+`schema` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsPlannerContractGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "version": null,
+  "schema": null,
+} satisfies ApiV1ChatsPlannerContractGet200Response
+
+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 ApiV1ChatsPlannerContractGet200Response
+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/ApiV1ChatsPlannerPost200Response.md

@@ -0,0 +1,44 @@
+
+# ApiV1ChatsPlannerPost200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`intent` | string
+`tool` | string
+`template` | string
+`params` | object
+`retrievalStrategy` | string
+`confidence` | number
+
+## Example
+
+```typescript
+import type { ApiV1ChatsPlannerPost200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "intent": null,
+  "tool": null,
+  "template": null,
+  "params": null,
+  "retrievalStrategy": null,
+  "confidence": null,
+} satisfies ApiV1ChatsPlannerPost200Response
+
+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 ApiV1ChatsPlannerPost200Response
+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/ApiV1ChatsPlannerPostRequest.md

@@ -0,0 +1,40 @@
+
+# ApiV1ChatsPlannerPostRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`question` | string
+`template` | string
+`requestedTool` | string
+`params` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsPlannerPostRequest } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "question": null,
+  "template": null,
+  "requestedTool": null,
+  "params": null,
+} satisfies ApiV1ChatsPlannerPostRequest
+
+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 ApiV1ChatsPlannerPostRequest
+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/ApiV1ChatsPost201Response.md

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsPost201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`title` | string
+`status` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ApiV1ChatsPost201Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "title": null,
+  "status": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ApiV1ChatsPost201Response
+
+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 ApiV1ChatsPost201Response
+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/ApiV1ChatsPostRequest.md

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

@@ -0,0 +1,38 @@
+
+# ApiV1ChatsSyncGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chats` | Array<object>
+`cursor` | string
+`hasMore` | boolean
+
+## Example
+
+```typescript
+import type { ApiV1ChatsSyncGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chats": null,
+  "cursor": null,
+  "hasMore": null,
+} satisfies ApiV1ChatsSyncGet200Response
+
+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 ApiV1ChatsSyncGet200Response
+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/{ApiV1RecordsIdPatch200Response.md → ApiV1RecordsIdPut200Response.md}

@@ -1,5 +1,5 @@
 
-# ApiV1RecordsIdPatch200Response
+# ApiV1RecordsIdPut200Response
 
 
 ## Properties
@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ApiV1RecordsIdPatch200Response } from 'blanche-client-sdk'
+import type { ApiV1RecordsIdPut200Response } from 'blanche-client-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -22,7 +22,7 @@ const example = {
   "template": null,
   "data": null,
   "updatedAt": null,
-} satisfies ApiV1RecordsIdPatch200Response
+} satisfies ApiV1RecordsIdPut200Response
 
 console.log(example)
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ApiV1RecordsIdPatch200Response
+const exampleParsed = JSON.parse(exampleJSON) as ApiV1RecordsIdPut200Response
 console.log(exampleParsed)
 ```
 

package/docs/{ApiV1RecordsIdPatchRequest.md → ApiV1RecordsIdPutRequest.md}

@@ -1,5 +1,5 @@
 
-# ApiV1RecordsIdPatchRequest
+# ApiV1RecordsIdPutRequest
 
 
 ## Properties
@@ -11,12 +11,12 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ApiV1RecordsIdPatchRequest } from 'blanche-client-sdk'
+import type { ApiV1RecordsIdPutRequest } from 'blanche-client-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies ApiV1RecordsIdPatchRequest
+} satisfies ApiV1RecordsIdPutRequest
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ApiV1RecordsIdPatchRequest
+const exampleParsed = JSON.parse(exampleJSON) as ApiV1RecordsIdPutRequest
 console.log(exampleParsed)
 ```
 

package/docs/ApiV1TemplatesGet200ResponseTemplatesInner.md

@@ -17,6 +17,7 @@ Name | Type
 `updatedAt` | Date
 `schema` | object
 `prompt` | string
+`messageTemplate` | string
 
 ## Example
 
@@ -36,6 +37,7 @@ const example = {
   "updatedAt": null,
   "schema": null,
   "prompt": null,
+  "messageTemplate": null,
 } satisfies ApiV1TemplatesGet200ResponseTemplatesInner
 
 console.log(example)