blanche-client-sdk 0.5.0 → 0.6.1

package/docs/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner.md

@@ -0,0 +1,48 @@
+
+# ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`messageId` | string
+`kind` | string
+`fileUrl` | string
+`mimeType` | string
+`fileSize` | number
+`metadata` | object
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "messageId": null,
+  "kind": null,
+  "fileUrl": null,
+  "mimeType": null,
+  "fileSize": null,
+  "metadata": null,
+  "createdAt": null,
+} satisfies ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner
+
+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 ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner
+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/ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.md

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

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | string
+`fileUrl` | string
+`mimeType` | string
+`fileSize` | number
+`metadata` | object
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": null,
+  "fileUrl": null,
+  "mimeType": null,
+  "fileSize": null,
+  "metadata": null,
+} satisfies ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest
+
+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 ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest
+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/ApiV1ChatsIdReadPost200Response.md

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

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

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsIdReportsPost200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tool` | string
+`planner` | object
+`retrievalStrategy` | string
+`rows` | [Array<ApiV1ChatsIdReportsPost200ResponseRowsInner>](ApiV1ChatsIdReportsPost200ResponseRowsInner.md)
+`sourceMetadata` | [ApiV1ChatsIdReportsPost200ResponseSourceMetadata](ApiV1ChatsIdReportsPost200ResponseSourceMetadata.md)
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdReportsPost200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tool": null,
+  "planner": null,
+  "retrievalStrategy": null,
+  "rows": null,
+  "sourceMetadata": null,
+} satisfies ApiV1ChatsIdReportsPost200Response
+
+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 ApiV1ChatsIdReportsPost200Response
+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/ApiV1ChatsIdReportsPost200ResponseRowsInner.md

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

@@ -0,0 +1,42 @@
+
+# ApiV1ChatsIdReportsPost200ResponseSourceMetadata
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`templateId` | string
+`templateName` | string
+`schemaVersion` | number
+`rowsCount` | number
+`sqlFingerprint` | string
+
+## Example
+
+```typescript
+import type { ApiV1ChatsIdReportsPost200ResponseSourceMetadata } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "templateId": null,
+  "templateName": null,
+  "schemaVersion": null,
+  "rowsCount": null,
+  "sqlFingerprint": null,
+} satisfies ApiV1ChatsIdReportsPost200ResponseSourceMetadata
+
+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 ApiV1ChatsIdReportsPost200ResponseSourceMetadata
+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/{ApiV1RecordsIdPatch422Response.md → ApiV1ChatsIdReportsPost422Response.md}

@@ -1,5 +1,5 @@
 
-# ApiV1RecordsIdPatch422Response
+# ApiV1ChatsIdReportsPost422Response
 
 
 ## Properties
@@ -11,12 +11,12 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ApiV1RecordsIdPatch422Response } from 'blanche-client-sdk'
+import type { ApiV1ChatsIdReportsPost422Response } from 'blanche-client-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "errors": null,
-} satisfies ApiV1RecordsIdPatch422Response
+} satisfies ApiV1ChatsIdReportsPost422Response
 
 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 ApiV1RecordsIdPatch422Response
+const exampleParsed = JSON.parse(exampleJSON) as ApiV1ChatsIdReportsPost422Response
 console.log(exampleParsed)
 ```
 

package/docs/ApiV1ChatsIdReportsPostRequest.md

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

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