blanche-client-sdk 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +94 -10
- package/README.md +82 -16
- package/dist/apis/ChatsApi.d.ts +286 -0
- package/dist/apis/ChatsApi.js +1125 -0
- package/dist/apis/RecordsApi.d.ts +22 -6
- package/dist/apis/RecordsApi.js +63 -2
- package/dist/apis/TemplateSchemasApi.d.ts +115 -0
- package/dist/apis/TemplateSchemasApi.js +456 -0
- package/dist/apis/TemplatesApi.d.ts +22 -6
- package/dist/apis/TemplatesApi.js +62 -1
- package/dist/apis/UsersApi.d.ts +17 -1
- package/dist/apis/UsersApi.js +59 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/models/ApiV1ChatsChatIdMessagesGet200Response.d.ts +51 -0
- package/dist/models/ApiV1ChatsChatIdMessagesGet200Response.js +64 -0
- package/dist/models/ApiV1ChatsChatIdMessagesGet200ResponseMessagesInner.d.ts +74 -0
- package/dist/models/ApiV1ChatsChatIdMessagesGet200ResponseMessagesInner.js +79 -0
- package/dist/models/ApiV1ChatsChatIdMessagesPost201Response.d.ts +62 -0
- package/dist/models/ApiV1ChatsChatIdMessagesPost201Response.js +71 -0
- package/dist/models/ApiV1ChatsChatIdMessagesPostRequest.d.ts +44 -0
- package/dist/models/ApiV1ChatsChatIdMessagesPostRequest.js +55 -0
- package/dist/models/ApiV1ChatsChatIdMessagesSyncGet200Response.d.ts +44 -0
- package/dist/models/ApiV1ChatsChatIdMessagesSyncGet200Response.js +57 -0
- package/dist/models/ApiV1ChatsGet200Response.d.ts +51 -0
- package/dist/models/ApiV1ChatsGet200Response.js +64 -0
- package/dist/models/ApiV1ChatsGet200ResponseChatsInner.d.ts +68 -0
- package/dist/models/ApiV1ChatsGet200ResponseChatsInner.js +69 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response.d.ts +33 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response.js +52 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner.d.ts +74 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner.js +75 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.d.ts +50 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.js +63 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest.d.ts +65 -0
- package/dist/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest.js +68 -0
- package/dist/models/ApiV1ChatsIdReadPost200Response.d.ts +50 -0
- package/dist/models/ApiV1ChatsIdReadPost200Response.js +61 -0
- package/dist/models/ApiV1ChatsIdReadPostRequest.d.ts +32 -0
- package/dist/models/ApiV1ChatsIdReadPostRequest.js +49 -0
- package/dist/models/ApiV1ChatsIdReportsPost200Response.d.ts +46 -0
- package/dist/models/ApiV1ChatsIdReportsPost200Response.js +61 -0
- package/dist/models/ApiV1ChatsIdReportsPost200ResponseRowsInner.d.ts +38 -0
- package/dist/models/ApiV1ChatsIdReportsPost200ResponseRowsInner.js +53 -0
- package/dist/models/ApiV1ChatsIdReportsPost200ResponseSourceMetadata.d.ts +56 -0
- package/dist/models/ApiV1ChatsIdReportsPost200ResponseSourceMetadata.js +67 -0
- package/dist/models/ApiV1ChatsIdReportsPost422Response.d.ts +32 -0
- package/dist/models/ApiV1ChatsIdReportsPost422Response.js +51 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequest.d.ts +33 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequest.js +52 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlanner.d.ts +61 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlanner.js +74 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlannerParams.d.ts +100 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlannerParams.js +84 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.d.ts +56 -0
- package/dist/models/ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.js +71 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdCitationsGet200Response.d.ts +39 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdCitationsGet200Response.js +56 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.d.ts +50 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.js +59 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdGet200Response.d.ts +56 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdGet200Response.js +65 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdRetryPost201Response.d.ts +50 -0
- package/dist/models/ApiV1ChatsIdRunsRunIdRetryPost201Response.js +61 -0
- package/dist/models/ApiV1ChatsIdSavedReportsGet200Response.d.ts +33 -0
- package/dist/models/ApiV1ChatsIdSavedReportsGet200Response.js +52 -0
- package/dist/models/ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.d.ts +56 -0
- package/dist/models/ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.js +65 -0
- package/dist/models/ApiV1ChatsIdSavedReportsPostRequest.d.ts +38 -0
- package/dist/models/ApiV1ChatsIdSavedReportsPostRequest.js +53 -0
- package/dist/models/ApiV1ChatsPlannerContractGet200Response.d.ts +38 -0
- package/dist/models/ApiV1ChatsPlannerContractGet200Response.js +55 -0
- package/dist/models/ApiV1ChatsPlannerPost200Response.d.ts +62 -0
- package/dist/models/ApiV1ChatsPlannerPost200Response.js +71 -0
- package/dist/models/ApiV1ChatsPlannerPostRequest.d.ts +50 -0
- package/dist/models/ApiV1ChatsPlannerPostRequest.js +59 -0
- package/dist/models/ApiV1ChatsPost201Response.d.ts +56 -0
- package/dist/models/ApiV1ChatsPost201Response.js +65 -0
- package/dist/models/ApiV1ChatsPostRequest.d.ts +32 -0
- package/dist/models/ApiV1ChatsPostRequest.js +49 -0
- package/dist/models/ApiV1ChatsSyncGet200Response.d.ts +44 -0
- package/dist/models/ApiV1ChatsSyncGet200Response.js +57 -0
- package/dist/models/ApiV1RecordsIdPut200Response.d.ts +50 -0
- package/dist/models/{ApiV1RecordsIdPatch200Response.js → ApiV1RecordsIdPut200Response.js} +13 -13
- package/dist/models/ApiV1RecordsIdPutRequest.d.ts +32 -0
- package/dist/models/ApiV1RecordsIdPutRequest.js +51 -0
- package/dist/models/ApiV1TemplatesIdPutRequest.d.ts +33 -0
- package/dist/models/ApiV1TemplatesIdPutRequest.js +52 -0
- package/dist/models/ApiV1TemplatesIdPutRequestTemplate.d.ts +38 -0
- package/dist/models/ApiV1TemplatesIdPutRequestTemplate.js +51 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasGet200Response.d.ts +33 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasGet200Response.js +52 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasGet200ResponseSchemasInner.d.ts +62 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasGet200ResponseSchemasInner.js +69 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasIdPutRequest.d.ts +50 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasIdPutRequest.js +55 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasPost201Response.d.ts +44 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasPost201Response.js +59 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasPostRequest.d.ts +50 -0
- package/dist/models/ApiV1TemplatesTemplateIdSchemasPostRequest.js +59 -0
- package/dist/models/ApiV1UsersIdPutRequest.d.ts +33 -0
- package/dist/models/ApiV1UsersIdPutRequest.js +52 -0
- package/dist/models/ApiV1UsersIdPutRequestUser.d.ts +56 -0
- package/dist/models/ApiV1UsersIdPutRequestUser.js +57 -0
- package/dist/models/index.d.ts +45 -5
- package/dist/models/index.js +45 -5
- package/docs/ApiV1ChatsChatIdMessagesGet200Response.md +40 -0
- package/docs/ApiV1ChatsChatIdMessagesGet200ResponseMessagesInner.md +48 -0
- package/docs/ApiV1ChatsChatIdMessagesPost201Response.md +44 -0
- package/docs/ApiV1ChatsChatIdMessagesPostRequest.md +38 -0
- package/docs/ApiV1ChatsChatIdMessagesSyncGet200Response.md +38 -0
- package/docs/ApiV1ChatsGet200Response.md +40 -0
- package/docs/ApiV1ChatsGet200ResponseChatsInner.md +46 -0
- package/docs/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response.md +34 -0
- package/docs/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner.md +48 -0
- package/docs/ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.md +40 -0
- package/docs/ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest.md +42 -0
- package/docs/ApiV1ChatsIdReadPost200Response.md +40 -0
- package/docs/ApiV1ChatsIdReadPostRequest.md +34 -0
- package/docs/ApiV1ChatsIdReportsPost200Response.md +38 -0
- package/docs/ApiV1ChatsIdReportsPost200ResponseRowsInner.md +36 -0
- package/docs/ApiV1ChatsIdReportsPost200ResponseSourceMetadata.md +42 -0
- package/docs/{ApiV1RecordsIdPatch422Response.md → ApiV1ChatsIdReportsPost422Response.md} +4 -4
- package/docs/ApiV1ChatsIdReportsPostRequest.md +34 -0
- package/docs/ApiV1ChatsIdReportsPostRequestPlanner.md +40 -0
- package/docs/ApiV1ChatsIdReportsPostRequestPlannerParams.md +50 -0
- package/docs/ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.md +38 -0
- package/docs/ApiV1ChatsIdRunsRunIdCitationsGet200Response.md +36 -0
- package/docs/ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.md +40 -0
- package/docs/ApiV1ChatsIdRunsRunIdGet200Response.md +42 -0
- package/docs/ApiV1ChatsIdRunsRunIdRetryPost201Response.md +40 -0
- package/docs/ApiV1ChatsIdSavedReportsGet200Response.md +34 -0
- package/docs/ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.md +42 -0
- package/docs/ApiV1ChatsIdSavedReportsPostRequest.md +36 -0
- package/docs/ApiV1ChatsPlannerContractGet200Response.md +36 -0
- package/docs/ApiV1ChatsPlannerPost200Response.md +44 -0
- package/docs/ApiV1ChatsPlannerPostRequest.md +40 -0
- package/docs/ApiV1ChatsPost201Response.md +42 -0
- package/docs/ApiV1ChatsPostRequest.md +34 -0
- package/docs/ApiV1ChatsSyncGet200Response.md +38 -0
- package/docs/{ApiV1RecordsIdPatch200Response.md → ApiV1RecordsIdPut200Response.md} +4 -4
- package/docs/{ApiV1RecordsIdPatchRequest.md → ApiV1RecordsIdPutRequest.md} +4 -4
- package/docs/{ApiV1TemplatesIdPatchRequest.md → ApiV1TemplatesIdPutRequest.md} +5 -5
- package/docs/{ApiV1TemplatesIdPatchRequestTemplate.md → ApiV1TemplatesIdPutRequestTemplate.md} +4 -4
- package/docs/ApiV1TemplatesTemplateIdSchemasGet200Response.md +34 -0
- package/docs/ApiV1TemplatesTemplateIdSchemasGet200ResponseSchemasInner.md +44 -0
- package/docs/ApiV1TemplatesTemplateIdSchemasIdPutRequest.md +40 -0
- package/docs/ApiV1TemplatesTemplateIdSchemasPost201Response.md +38 -0
- package/docs/ApiV1TemplatesTemplateIdSchemasPostRequest.md +40 -0
- package/docs/ApiV1UsersIdPutRequest.md +34 -0
- package/docs/ApiV1UsersIdPutRequestUser.md +42 -0
- package/docs/ChatsApi.md +1172 -0
- package/docs/RecordsApi.md +77 -8
- package/docs/TemplateSchemasApi.md +425 -0
- package/docs/TemplatesApi.md +76 -7
- package/docs/UsersApi.md +69 -0
- package/package.json +1 -1
- package/src/apis/ChatsApi.ts +1000 -0
- package/src/apis/RecordsApi.ts +69 -16
- package/src/apis/TemplateSchemasApi.ts +381 -0
- package/src/apis/TemplatesApi.ts +65 -12
- package/src/apis/UsersApi.ts +55 -0
- package/src/apis/index.ts +2 -0
- package/src/models/ApiV1ChatsChatIdMessagesGet200Response.ts +101 -0
- package/src/models/ApiV1ChatsChatIdMessagesGet200ResponseMessagesInner.ts +129 -0
- package/src/models/ApiV1ChatsChatIdMessagesPost201Response.ts +111 -0
- package/src/models/ApiV1ChatsChatIdMessagesPostRequest.ts +82 -0
- package/src/models/ApiV1ChatsChatIdMessagesSyncGet200Response.ts +83 -0
- package/src/models/ApiV1ChatsGet200Response.ts +101 -0
- package/src/models/ApiV1ChatsGet200ResponseChatsInner.ts +117 -0
- package/src/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response.ts +74 -0
- package/src/models/ApiV1ChatsIdMessagesMessageIdAttachmentsGet200ResponseAttachmentsInner.ts +127 -0
- package/src/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.ts +93 -0
- package/src/models/ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest.ts +110 -0
- package/src/models/ApiV1ChatsIdReadPost200Response.ts +92 -0
- package/src/models/ApiV1ChatsIdReadPostRequest.ts +65 -0
- package/src/models/ApiV1ChatsIdReportsPost200Response.ts +99 -0
- package/src/models/ApiV1ChatsIdReportsPost200ResponseRowsInner.ts +74 -0
- package/src/models/ApiV1ChatsIdReportsPost200ResponseSourceMetadata.ts +102 -0
- package/src/models/ApiV1ChatsIdReportsPost422Response.ts +66 -0
- package/src/models/ApiV1ChatsIdReportsPostRequest.ts +74 -0
- package/src/models/ApiV1ChatsIdReportsPostRequestPlanner.ts +114 -0
- package/src/models/ApiV1ChatsIdReportsPostRequestPlannerParams.ts +160 -0
- package/src/models/ApiV1ChatsIdReportsPostRequestPlannerParamsFiltersInner.ts +99 -0
- package/src/models/ApiV1ChatsIdRunsRunIdCitationsGet200Response.ts +83 -0
- package/src/models/ApiV1ChatsIdRunsRunIdCitationsGet200ResponseCitationsInner.ts +91 -0
- package/src/models/ApiV1ChatsIdRunsRunIdGet200Response.ts +101 -0
- package/src/models/ApiV1ChatsIdRunsRunIdRetryPost201Response.ts +92 -0
- package/src/models/ApiV1ChatsIdSavedReportsGet200Response.ts +74 -0
- package/src/models/ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.ts +101 -0
- package/src/models/ApiV1ChatsIdSavedReportsPostRequest.ts +74 -0
- package/src/models/ApiV1ChatsPlannerContractGet200Response.ts +75 -0
- package/src/models/ApiV1ChatsPlannerPost200Response.ts +111 -0
- package/src/models/ApiV1ChatsPlannerPostRequest.ts +91 -0
- package/src/models/ApiV1ChatsPost201Response.ts +101 -0
- package/src/models/ApiV1ChatsPostRequest.ts +65 -0
- package/src/models/ApiV1ChatsSyncGet200Response.ts +83 -0
- package/src/models/{ApiV1RecordsIdPatch200Response.ts → ApiV1RecordsIdPut200Response.ts} +14 -14
- package/src/models/ApiV1RecordsIdPutRequest.ts +66 -0
- package/src/models/ApiV1TemplatesIdPutRequest.ts +74 -0
- package/src/models/ApiV1TemplatesIdPutRequestTemplate.ts +73 -0
- package/src/models/ApiV1TemplatesTemplateIdSchemasGet200Response.ts +74 -0
- package/src/models/ApiV1TemplatesTemplateIdSchemasGet200ResponseSchemasInner.ts +110 -0
- package/src/models/ApiV1TemplatesTemplateIdSchemasIdPutRequest.ts +89 -0
- package/src/models/ApiV1TemplatesTemplateIdSchemasPost201Response.ts +84 -0
- package/src/models/ApiV1TemplatesTemplateIdSchemasPostRequest.ts +91 -0
- package/src/models/ApiV1UsersIdPutRequest.ts +74 -0
- package/src/models/ApiV1UsersIdPutRequestUser.ts +97 -0
- package/src/models/index.ts +45 -5
- package/dist/models/ApiV1RecordsIdPatch200Response.d.ts +0 -50
- package/dist/models/ApiV1RecordsIdPatch422Response.d.ts +0 -32
- package/dist/models/ApiV1RecordsIdPatch422Response.js +0 -51
- package/dist/models/ApiV1RecordsIdPatchRequest.d.ts +0 -32
- package/dist/models/ApiV1RecordsIdPatchRequest.js +0 -51
- package/dist/models/ApiV1TemplatesIdPatchRequest.d.ts +0 -33
- package/dist/models/ApiV1TemplatesIdPatchRequest.js +0 -52
- package/dist/models/ApiV1TemplatesIdPatchRequestTemplate.d.ts +0 -38
- package/dist/models/ApiV1TemplatesIdPatchRequestTemplate.js +0 -51
- package/src/models/ApiV1RecordsIdPatch422Response.ts +0 -66
- package/src/models/ApiV1RecordsIdPatchRequest.ts +0 -66
- package/src/models/ApiV1TemplatesIdPatchRequest.ts +0 -74
- package/src/models/ApiV1TemplatesIdPatchRequestTemplate.ts +0 -73
package/docs/ChatsApi.md
ADDED
|
@@ -0,0 +1,1172 @@
|
|
|
1
|
+
# ChatsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:3000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**apiV1ChatsChatIdMessagesGet**](ChatsApi.md#apiv1chatschatidmessagesget) | **GET** /api/v1/chats/{chat_id}/messages | List chat messages |
|
|
8
|
+
| [**apiV1ChatsChatIdMessagesPost**](ChatsApi.md#apiv1chatschatidmessagespostoperation) | **POST** /api/v1/chats/{chat_id}/messages | Create chat message |
|
|
9
|
+
| [**apiV1ChatsChatIdMessagesSyncGet**](ChatsApi.md#apiv1chatschatidmessagessyncget) | **GET** /api/v1/chats/{chat_id}/messages/sync | Sync chat messages by cursor |
|
|
10
|
+
| [**apiV1ChatsGet**](ChatsApi.md#apiv1chatsget) | **GET** /api/v1/chats | List chats |
|
|
11
|
+
| [**apiV1ChatsIdMessagesMessageIdAttachmentsGet**](ChatsApi.md#apiv1chatsidmessagesmessageidattachmentsget) | **GET** /api/v1/chats/{id}/messages/{message_id}/attachments | List chat message attachments |
|
|
12
|
+
| [**apiV1ChatsIdMessagesMessageIdAttachmentsPost**](ChatsApi.md#apiv1chatsidmessagesmessageidattachmentspostoperation) | **POST** /api/v1/chats/{id}/messages/{message_id}/attachments | Create chat message attachment |
|
|
13
|
+
| [**apiV1ChatsIdReadPost**](ChatsApi.md#apiv1chatsidreadpostoperation) | **POST** /api/v1/chats/{id}/read | Mark chat as read |
|
|
14
|
+
| [**apiV1ChatsIdReportsPost**](ChatsApi.md#apiv1chatsidreportspostoperation) | **POST** /api/v1/chats/{id}/reports | Run deterministic SQL report tool |
|
|
15
|
+
| [**apiV1ChatsIdRunsRunIdCitationsGet**](ChatsApi.md#apiv1chatsidrunsrunidcitationsget) | **GET** /api/v1/chats/{id}/runs/{run_id}/citations | Get run citations |
|
|
16
|
+
| [**apiV1ChatsIdRunsRunIdGet**](ChatsApi.md#apiv1chatsidrunsrunidget) | **GET** /api/v1/chats/{id}/runs/{run_id} | Get chat run status |
|
|
17
|
+
| [**apiV1ChatsIdRunsRunIdRetryPost**](ChatsApi.md#apiv1chatsidrunsrunidretrypost) | **POST** /api/v1/chats/{id}/runs/{run_id}/retry | Retry chat run |
|
|
18
|
+
| [**apiV1ChatsIdSavedReportsGet**](ChatsApi.md#apiv1chatsidsavedreportsget) | **GET** /api/v1/chats/{id}/saved_reports | List saved reports for chat |
|
|
19
|
+
| [**apiV1ChatsIdSavedReportsPost**](ChatsApi.md#apiv1chatsidsavedreportspostoperation) | **POST** /api/v1/chats/{id}/saved_reports | Save report snapshot for chat run |
|
|
20
|
+
| [**apiV1ChatsPlannerContractGet**](ChatsApi.md#apiv1chatsplannercontractget) | **GET** /api/v1/chats/planner_contract | Get planner contract schema |
|
|
21
|
+
| [**apiV1ChatsPlannerPost**](ChatsApi.md#apiv1chatsplannerpostoperation) | **POST** /api/v1/chats/planner | Build deterministic planner decision |
|
|
22
|
+
| [**apiV1ChatsPost**](ChatsApi.md#apiv1chatspostoperation) | **POST** /api/v1/chats | Create chat |
|
|
23
|
+
| [**apiV1ChatsSyncGet**](ChatsApi.md#apiv1chatssyncget) | **GET** /api/v1/chats/sync | Sync chats by cursor |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## apiV1ChatsChatIdMessagesGet
|
|
28
|
+
|
|
29
|
+
> ApiV1ChatsChatIdMessagesGet200Response apiV1ChatsChatIdMessagesGet(chatId, limit, offset)
|
|
30
|
+
|
|
31
|
+
List chat messages
|
|
32
|
+
|
|
33
|
+
### Example
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
import {
|
|
37
|
+
Configuration,
|
|
38
|
+
ChatsApi,
|
|
39
|
+
} from 'blanche-client-sdk';
|
|
40
|
+
import type { ApiV1ChatsChatIdMessagesGetRequest } from 'blanche-client-sdk';
|
|
41
|
+
|
|
42
|
+
async function example() {
|
|
43
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
44
|
+
const api = new ChatsApi();
|
|
45
|
+
|
|
46
|
+
const body = {
|
|
47
|
+
// string
|
|
48
|
+
chatId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
49
|
+
// number (optional)
|
|
50
|
+
limit: 56,
|
|
51
|
+
// number (optional)
|
|
52
|
+
offset: 56,
|
|
53
|
+
} satisfies ApiV1ChatsChatIdMessagesGetRequest;
|
|
54
|
+
|
|
55
|
+
try {
|
|
56
|
+
const data = await api.apiV1ChatsChatIdMessagesGet(body);
|
|
57
|
+
console.log(data);
|
|
58
|
+
} catch (error) {
|
|
59
|
+
console.error(error);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// Run the test
|
|
64
|
+
example().catch(console.error);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
|------------- | ------------- | ------------- | -------------|
|
|
72
|
+
| **chatId** | `string` | | [Defaults to `undefined`] |
|
|
73
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
74
|
+
| **offset** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**ApiV1ChatsChatIdMessagesGet200Response**](ApiV1ChatsChatIdMessagesGet200Response.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
No authorization required
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: Not defined
|
|
87
|
+
- **Accept**: `application/json`
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### HTTP response details
|
|
91
|
+
| Status code | Description | Response headers |
|
|
92
|
+
|-------------|-------------|------------------|
|
|
93
|
+
| **200** | messages returned | - |
|
|
94
|
+
|
|
95
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## apiV1ChatsChatIdMessagesPost
|
|
99
|
+
|
|
100
|
+
> ApiV1ChatsChatIdMessagesPost201Response apiV1ChatsChatIdMessagesPost(chatId, apiV1ChatsChatIdMessagesPostRequest)
|
|
101
|
+
|
|
102
|
+
Create chat message
|
|
103
|
+
|
|
104
|
+
### Example
|
|
105
|
+
|
|
106
|
+
```ts
|
|
107
|
+
import {
|
|
108
|
+
Configuration,
|
|
109
|
+
ChatsApi,
|
|
110
|
+
} from 'blanche-client-sdk';
|
|
111
|
+
import type { ApiV1ChatsChatIdMessagesPostOperationRequest } from 'blanche-client-sdk';
|
|
112
|
+
|
|
113
|
+
async function example() {
|
|
114
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
115
|
+
const api = new ChatsApi();
|
|
116
|
+
|
|
117
|
+
const body = {
|
|
118
|
+
// string
|
|
119
|
+
chatId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
120
|
+
// ApiV1ChatsChatIdMessagesPostRequest (optional)
|
|
121
|
+
apiV1ChatsChatIdMessagesPostRequest: ...,
|
|
122
|
+
} satisfies ApiV1ChatsChatIdMessagesPostOperationRequest;
|
|
123
|
+
|
|
124
|
+
try {
|
|
125
|
+
const data = await api.apiV1ChatsChatIdMessagesPost(body);
|
|
126
|
+
console.log(data);
|
|
127
|
+
} catch (error) {
|
|
128
|
+
console.error(error);
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
// Run the test
|
|
133
|
+
example().catch(console.error);
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
| Name | Type | Description | Notes |
|
|
140
|
+
|------------- | ------------- | ------------- | -------------|
|
|
141
|
+
| **chatId** | `string` | | [Defaults to `undefined`] |
|
|
142
|
+
| **apiV1ChatsChatIdMessagesPostRequest** | [ApiV1ChatsChatIdMessagesPostRequest](ApiV1ChatsChatIdMessagesPostRequest.md) | | [Optional] |
|
|
143
|
+
|
|
144
|
+
### Return type
|
|
145
|
+
|
|
146
|
+
[**ApiV1ChatsChatIdMessagesPost201Response**](ApiV1ChatsChatIdMessagesPost201Response.md)
|
|
147
|
+
|
|
148
|
+
### Authorization
|
|
149
|
+
|
|
150
|
+
No authorization required
|
|
151
|
+
|
|
152
|
+
### HTTP request headers
|
|
153
|
+
|
|
154
|
+
- **Content-Type**: `application/json`
|
|
155
|
+
- **Accept**: `application/json`
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### HTTP response details
|
|
159
|
+
| Status code | Description | Response headers |
|
|
160
|
+
|-------------|-------------|------------------|
|
|
161
|
+
| **201** | message created | - |
|
|
162
|
+
|
|
163
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
## apiV1ChatsChatIdMessagesSyncGet
|
|
167
|
+
|
|
168
|
+
> ApiV1ChatsChatIdMessagesSyncGet200Response apiV1ChatsChatIdMessagesSyncGet(chatId, cursor, limit)
|
|
169
|
+
|
|
170
|
+
Sync chat messages by cursor
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```ts
|
|
175
|
+
import {
|
|
176
|
+
Configuration,
|
|
177
|
+
ChatsApi,
|
|
178
|
+
} from 'blanche-client-sdk';
|
|
179
|
+
import type { ApiV1ChatsChatIdMessagesSyncGetRequest } from 'blanche-client-sdk';
|
|
180
|
+
|
|
181
|
+
async function example() {
|
|
182
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
183
|
+
const api = new ChatsApi();
|
|
184
|
+
|
|
185
|
+
const body = {
|
|
186
|
+
// string
|
|
187
|
+
chatId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
188
|
+
// string (optional)
|
|
189
|
+
cursor: cursor_example,
|
|
190
|
+
// number (optional)
|
|
191
|
+
limit: 56,
|
|
192
|
+
} satisfies ApiV1ChatsChatIdMessagesSyncGetRequest;
|
|
193
|
+
|
|
194
|
+
try {
|
|
195
|
+
const data = await api.apiV1ChatsChatIdMessagesSyncGet(body);
|
|
196
|
+
console.log(data);
|
|
197
|
+
} catch (error) {
|
|
198
|
+
console.error(error);
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
// Run the test
|
|
203
|
+
example().catch(console.error);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
| Name | Type | Description | Notes |
|
|
210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
211
|
+
| **chatId** | `string` | | [Defaults to `undefined`] |
|
|
212
|
+
| **cursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
213
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
[**ApiV1ChatsChatIdMessagesSyncGet200Response**](ApiV1ChatsChatIdMessagesSyncGet200Response.md)
|
|
218
|
+
|
|
219
|
+
### Authorization
|
|
220
|
+
|
|
221
|
+
No authorization required
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: Not defined
|
|
226
|
+
- **Accept**: `application/json`
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
### HTTP response details
|
|
230
|
+
| Status code | Description | Response headers |
|
|
231
|
+
|-------------|-------------|------------------|
|
|
232
|
+
| **200** | sync messages returned | - |
|
|
233
|
+
|
|
234
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
## apiV1ChatsGet
|
|
238
|
+
|
|
239
|
+
> ApiV1ChatsGet200Response apiV1ChatsGet(limit, offset)
|
|
240
|
+
|
|
241
|
+
List chats
|
|
242
|
+
|
|
243
|
+
### Example
|
|
244
|
+
|
|
245
|
+
```ts
|
|
246
|
+
import {
|
|
247
|
+
Configuration,
|
|
248
|
+
ChatsApi,
|
|
249
|
+
} from 'blanche-client-sdk';
|
|
250
|
+
import type { ApiV1ChatsGetRequest } from 'blanche-client-sdk';
|
|
251
|
+
|
|
252
|
+
async function example() {
|
|
253
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
254
|
+
const api = new ChatsApi();
|
|
255
|
+
|
|
256
|
+
const body = {
|
|
257
|
+
// number (optional)
|
|
258
|
+
limit: 56,
|
|
259
|
+
// number (optional)
|
|
260
|
+
offset: 56,
|
|
261
|
+
} satisfies ApiV1ChatsGetRequest;
|
|
262
|
+
|
|
263
|
+
try {
|
|
264
|
+
const data = await api.apiV1ChatsGet(body);
|
|
265
|
+
console.log(data);
|
|
266
|
+
} catch (error) {
|
|
267
|
+
console.error(error);
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
// Run the test
|
|
272
|
+
example().catch(console.error);
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Parameters
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
| Name | Type | Description | Notes |
|
|
279
|
+
|------------- | ------------- | ------------- | -------------|
|
|
280
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
281
|
+
| **offset** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
282
|
+
|
|
283
|
+
### Return type
|
|
284
|
+
|
|
285
|
+
[**ApiV1ChatsGet200Response**](ApiV1ChatsGet200Response.md)
|
|
286
|
+
|
|
287
|
+
### Authorization
|
|
288
|
+
|
|
289
|
+
No authorization required
|
|
290
|
+
|
|
291
|
+
### HTTP request headers
|
|
292
|
+
|
|
293
|
+
- **Content-Type**: Not defined
|
|
294
|
+
- **Accept**: `application/json`
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### HTTP response details
|
|
298
|
+
| Status code | Description | Response headers |
|
|
299
|
+
|-------------|-------------|------------------|
|
|
300
|
+
| **200** | chats returned | - |
|
|
301
|
+
|
|
302
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
## apiV1ChatsIdMessagesMessageIdAttachmentsGet
|
|
306
|
+
|
|
307
|
+
> ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response apiV1ChatsIdMessagesMessageIdAttachmentsGet(id, messageId)
|
|
308
|
+
|
|
309
|
+
List chat message attachments
|
|
310
|
+
|
|
311
|
+
### Example
|
|
312
|
+
|
|
313
|
+
```ts
|
|
314
|
+
import {
|
|
315
|
+
Configuration,
|
|
316
|
+
ChatsApi,
|
|
317
|
+
} from 'blanche-client-sdk';
|
|
318
|
+
import type { ApiV1ChatsIdMessagesMessageIdAttachmentsGetRequest } from 'blanche-client-sdk';
|
|
319
|
+
|
|
320
|
+
async function example() {
|
|
321
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
322
|
+
const api = new ChatsApi();
|
|
323
|
+
|
|
324
|
+
const body = {
|
|
325
|
+
// string
|
|
326
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
327
|
+
// string
|
|
328
|
+
messageId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
329
|
+
} satisfies ApiV1ChatsIdMessagesMessageIdAttachmentsGetRequest;
|
|
330
|
+
|
|
331
|
+
try {
|
|
332
|
+
const data = await api.apiV1ChatsIdMessagesMessageIdAttachmentsGet(body);
|
|
333
|
+
console.log(data);
|
|
334
|
+
} catch (error) {
|
|
335
|
+
console.error(error);
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
// Run the test
|
|
340
|
+
example().catch(console.error);
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
| Name | Type | Description | Notes |
|
|
347
|
+
|------------- | ------------- | ------------- | -------------|
|
|
348
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
349
|
+
| **messageId** | `string` | | [Defaults to `undefined`] |
|
|
350
|
+
|
|
351
|
+
### Return type
|
|
352
|
+
|
|
353
|
+
[**ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response**](ApiV1ChatsIdMessagesMessageIdAttachmentsGet200Response.md)
|
|
354
|
+
|
|
355
|
+
### Authorization
|
|
356
|
+
|
|
357
|
+
No authorization required
|
|
358
|
+
|
|
359
|
+
### HTTP request headers
|
|
360
|
+
|
|
361
|
+
- **Content-Type**: Not defined
|
|
362
|
+
- **Accept**: `application/json`
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
### HTTP response details
|
|
366
|
+
| Status code | Description | Response headers |
|
|
367
|
+
|-------------|-------------|------------------|
|
|
368
|
+
| **200** | attachments returned | - |
|
|
369
|
+
|
|
370
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
## apiV1ChatsIdMessagesMessageIdAttachmentsPost
|
|
374
|
+
|
|
375
|
+
> ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response apiV1ChatsIdMessagesMessageIdAttachmentsPost(id, messageId, apiV1ChatsIdMessagesMessageIdAttachmentsPostRequest)
|
|
376
|
+
|
|
377
|
+
Create chat message attachment
|
|
378
|
+
|
|
379
|
+
### Example
|
|
380
|
+
|
|
381
|
+
```ts
|
|
382
|
+
import {
|
|
383
|
+
Configuration,
|
|
384
|
+
ChatsApi,
|
|
385
|
+
} from 'blanche-client-sdk';
|
|
386
|
+
import type { ApiV1ChatsIdMessagesMessageIdAttachmentsPostOperationRequest } from 'blanche-client-sdk';
|
|
387
|
+
|
|
388
|
+
async function example() {
|
|
389
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
390
|
+
const api = new ChatsApi();
|
|
391
|
+
|
|
392
|
+
const body = {
|
|
393
|
+
// string
|
|
394
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
395
|
+
// string
|
|
396
|
+
messageId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
397
|
+
// ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest (optional)
|
|
398
|
+
apiV1ChatsIdMessagesMessageIdAttachmentsPostRequest: ...,
|
|
399
|
+
} satisfies ApiV1ChatsIdMessagesMessageIdAttachmentsPostOperationRequest;
|
|
400
|
+
|
|
401
|
+
try {
|
|
402
|
+
const data = await api.apiV1ChatsIdMessagesMessageIdAttachmentsPost(body);
|
|
403
|
+
console.log(data);
|
|
404
|
+
} catch (error) {
|
|
405
|
+
console.error(error);
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
// Run the test
|
|
410
|
+
example().catch(console.error);
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### Parameters
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
| Name | Type | Description | Notes |
|
|
417
|
+
|------------- | ------------- | ------------- | -------------|
|
|
418
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
419
|
+
| **messageId** | `string` | | [Defaults to `undefined`] |
|
|
420
|
+
| **apiV1ChatsIdMessagesMessageIdAttachmentsPostRequest** | [ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest](ApiV1ChatsIdMessagesMessageIdAttachmentsPostRequest.md) | | [Optional] |
|
|
421
|
+
|
|
422
|
+
### Return type
|
|
423
|
+
|
|
424
|
+
[**ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response**](ApiV1ChatsIdMessagesMessageIdAttachmentsPost201Response.md)
|
|
425
|
+
|
|
426
|
+
### Authorization
|
|
427
|
+
|
|
428
|
+
No authorization required
|
|
429
|
+
|
|
430
|
+
### HTTP request headers
|
|
431
|
+
|
|
432
|
+
- **Content-Type**: `application/json`
|
|
433
|
+
- **Accept**: `application/json`
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
### HTTP response details
|
|
437
|
+
| Status code | Description | Response headers |
|
|
438
|
+
|-------------|-------------|------------------|
|
|
439
|
+
| **201** | attachment created | - |
|
|
440
|
+
|
|
441
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
## apiV1ChatsIdReadPost
|
|
445
|
+
|
|
446
|
+
> ApiV1ChatsIdReadPost200Response apiV1ChatsIdReadPost(id, apiV1ChatsIdReadPostRequest)
|
|
447
|
+
|
|
448
|
+
Mark chat as read
|
|
449
|
+
|
|
450
|
+
### Example
|
|
451
|
+
|
|
452
|
+
```ts
|
|
453
|
+
import {
|
|
454
|
+
Configuration,
|
|
455
|
+
ChatsApi,
|
|
456
|
+
} from 'blanche-client-sdk';
|
|
457
|
+
import type { ApiV1ChatsIdReadPostOperationRequest } from 'blanche-client-sdk';
|
|
458
|
+
|
|
459
|
+
async function example() {
|
|
460
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
461
|
+
const api = new ChatsApi();
|
|
462
|
+
|
|
463
|
+
const body = {
|
|
464
|
+
// string
|
|
465
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
466
|
+
// ApiV1ChatsIdReadPostRequest (optional)
|
|
467
|
+
apiV1ChatsIdReadPostRequest: ...,
|
|
468
|
+
} satisfies ApiV1ChatsIdReadPostOperationRequest;
|
|
469
|
+
|
|
470
|
+
try {
|
|
471
|
+
const data = await api.apiV1ChatsIdReadPost(body);
|
|
472
|
+
console.log(data);
|
|
473
|
+
} catch (error) {
|
|
474
|
+
console.error(error);
|
|
475
|
+
}
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
// Run the test
|
|
479
|
+
example().catch(console.error);
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
### Parameters
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
| Name | Type | Description | Notes |
|
|
486
|
+
|------------- | ------------- | ------------- | -------------|
|
|
487
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
488
|
+
| **apiV1ChatsIdReadPostRequest** | [ApiV1ChatsIdReadPostRequest](ApiV1ChatsIdReadPostRequest.md) | | [Optional] |
|
|
489
|
+
|
|
490
|
+
### Return type
|
|
491
|
+
|
|
492
|
+
[**ApiV1ChatsIdReadPost200Response**](ApiV1ChatsIdReadPost200Response.md)
|
|
493
|
+
|
|
494
|
+
### Authorization
|
|
495
|
+
|
|
496
|
+
No authorization required
|
|
497
|
+
|
|
498
|
+
### HTTP request headers
|
|
499
|
+
|
|
500
|
+
- **Content-Type**: `application/json`
|
|
501
|
+
- **Accept**: `application/json`
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
### HTTP response details
|
|
505
|
+
| Status code | Description | Response headers |
|
|
506
|
+
|-------------|-------------|------------------|
|
|
507
|
+
| **200** | chat read state updated | - |
|
|
508
|
+
|
|
509
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
## apiV1ChatsIdReportsPost
|
|
513
|
+
|
|
514
|
+
> ApiV1ChatsIdReportsPost200Response apiV1ChatsIdReportsPost(id, apiV1ChatsIdReportsPostRequest)
|
|
515
|
+
|
|
516
|
+
Run deterministic SQL report tool
|
|
517
|
+
|
|
518
|
+
### Example
|
|
519
|
+
|
|
520
|
+
```ts
|
|
521
|
+
import {
|
|
522
|
+
Configuration,
|
|
523
|
+
ChatsApi,
|
|
524
|
+
} from 'blanche-client-sdk';
|
|
525
|
+
import type { ApiV1ChatsIdReportsPostOperationRequest } from 'blanche-client-sdk';
|
|
526
|
+
|
|
527
|
+
async function example() {
|
|
528
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
529
|
+
const api = new ChatsApi();
|
|
530
|
+
|
|
531
|
+
const body = {
|
|
532
|
+
// string
|
|
533
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
534
|
+
// ApiV1ChatsIdReportsPostRequest (optional)
|
|
535
|
+
apiV1ChatsIdReportsPostRequest: ...,
|
|
536
|
+
} satisfies ApiV1ChatsIdReportsPostOperationRequest;
|
|
537
|
+
|
|
538
|
+
try {
|
|
539
|
+
const data = await api.apiV1ChatsIdReportsPost(body);
|
|
540
|
+
console.log(data);
|
|
541
|
+
} catch (error) {
|
|
542
|
+
console.error(error);
|
|
543
|
+
}
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
// Run the test
|
|
547
|
+
example().catch(console.error);
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
### Parameters
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
| Name | Type | Description | Notes |
|
|
554
|
+
|------------- | ------------- | ------------- | -------------|
|
|
555
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
556
|
+
| **apiV1ChatsIdReportsPostRequest** | [ApiV1ChatsIdReportsPostRequest](ApiV1ChatsIdReportsPostRequest.md) | | [Optional] |
|
|
557
|
+
|
|
558
|
+
### Return type
|
|
559
|
+
|
|
560
|
+
[**ApiV1ChatsIdReportsPost200Response**](ApiV1ChatsIdReportsPost200Response.md)
|
|
561
|
+
|
|
562
|
+
### Authorization
|
|
563
|
+
|
|
564
|
+
No authorization required
|
|
565
|
+
|
|
566
|
+
### HTTP request headers
|
|
567
|
+
|
|
568
|
+
- **Content-Type**: `application/json`
|
|
569
|
+
- **Accept**: `application/json`
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
### HTTP response details
|
|
573
|
+
| Status code | Description | Response headers |
|
|
574
|
+
|-------------|-------------|------------------|
|
|
575
|
+
| **200** | report returned | - |
|
|
576
|
+
| **422** | invalid request | - |
|
|
577
|
+
|
|
578
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
## apiV1ChatsIdRunsRunIdCitationsGet
|
|
582
|
+
|
|
583
|
+
> ApiV1ChatsIdRunsRunIdCitationsGet200Response apiV1ChatsIdRunsRunIdCitationsGet(id, runId)
|
|
584
|
+
|
|
585
|
+
Get run citations
|
|
586
|
+
|
|
587
|
+
### Example
|
|
588
|
+
|
|
589
|
+
```ts
|
|
590
|
+
import {
|
|
591
|
+
Configuration,
|
|
592
|
+
ChatsApi,
|
|
593
|
+
} from 'blanche-client-sdk';
|
|
594
|
+
import type { ApiV1ChatsIdRunsRunIdCitationsGetRequest } from 'blanche-client-sdk';
|
|
595
|
+
|
|
596
|
+
async function example() {
|
|
597
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
598
|
+
const api = new ChatsApi();
|
|
599
|
+
|
|
600
|
+
const body = {
|
|
601
|
+
// string
|
|
602
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
603
|
+
// string
|
|
604
|
+
runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
605
|
+
} satisfies ApiV1ChatsIdRunsRunIdCitationsGetRequest;
|
|
606
|
+
|
|
607
|
+
try {
|
|
608
|
+
const data = await api.apiV1ChatsIdRunsRunIdCitationsGet(body);
|
|
609
|
+
console.log(data);
|
|
610
|
+
} catch (error) {
|
|
611
|
+
console.error(error);
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
// Run the test
|
|
616
|
+
example().catch(console.error);
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### Parameters
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
| Name | Type | Description | Notes |
|
|
623
|
+
|------------- | ------------- | ------------- | -------------|
|
|
624
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
625
|
+
| **runId** | `string` | | [Defaults to `undefined`] |
|
|
626
|
+
|
|
627
|
+
### Return type
|
|
628
|
+
|
|
629
|
+
[**ApiV1ChatsIdRunsRunIdCitationsGet200Response**](ApiV1ChatsIdRunsRunIdCitationsGet200Response.md)
|
|
630
|
+
|
|
631
|
+
### Authorization
|
|
632
|
+
|
|
633
|
+
No authorization required
|
|
634
|
+
|
|
635
|
+
### HTTP request headers
|
|
636
|
+
|
|
637
|
+
- **Content-Type**: Not defined
|
|
638
|
+
- **Accept**: `application/json`
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
### HTTP response details
|
|
642
|
+
| Status code | Description | Response headers |
|
|
643
|
+
|-------------|-------------|------------------|
|
|
644
|
+
| **200** | citations returned | - |
|
|
645
|
+
|
|
646
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
## apiV1ChatsIdRunsRunIdGet
|
|
650
|
+
|
|
651
|
+
> ApiV1ChatsIdRunsRunIdGet200Response apiV1ChatsIdRunsRunIdGet(id, runId)
|
|
652
|
+
|
|
653
|
+
Get chat run status
|
|
654
|
+
|
|
655
|
+
### Example
|
|
656
|
+
|
|
657
|
+
```ts
|
|
658
|
+
import {
|
|
659
|
+
Configuration,
|
|
660
|
+
ChatsApi,
|
|
661
|
+
} from 'blanche-client-sdk';
|
|
662
|
+
import type { ApiV1ChatsIdRunsRunIdGetRequest } from 'blanche-client-sdk';
|
|
663
|
+
|
|
664
|
+
async function example() {
|
|
665
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
666
|
+
const api = new ChatsApi();
|
|
667
|
+
|
|
668
|
+
const body = {
|
|
669
|
+
// string
|
|
670
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
671
|
+
// string
|
|
672
|
+
runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
673
|
+
} satisfies ApiV1ChatsIdRunsRunIdGetRequest;
|
|
674
|
+
|
|
675
|
+
try {
|
|
676
|
+
const data = await api.apiV1ChatsIdRunsRunIdGet(body);
|
|
677
|
+
console.log(data);
|
|
678
|
+
} catch (error) {
|
|
679
|
+
console.error(error);
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
// Run the test
|
|
684
|
+
example().catch(console.error);
|
|
685
|
+
```
|
|
686
|
+
|
|
687
|
+
### Parameters
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
| Name | Type | Description | Notes |
|
|
691
|
+
|------------- | ------------- | ------------- | -------------|
|
|
692
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
693
|
+
| **runId** | `string` | | [Defaults to `undefined`] |
|
|
694
|
+
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
[**ApiV1ChatsIdRunsRunIdGet200Response**](ApiV1ChatsIdRunsRunIdGet200Response.md)
|
|
698
|
+
|
|
699
|
+
### Authorization
|
|
700
|
+
|
|
701
|
+
No authorization required
|
|
702
|
+
|
|
703
|
+
### HTTP request headers
|
|
704
|
+
|
|
705
|
+
- **Content-Type**: Not defined
|
|
706
|
+
- **Accept**: `application/json`
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
### HTTP response details
|
|
710
|
+
| Status code | Description | Response headers |
|
|
711
|
+
|-------------|-------------|------------------|
|
|
712
|
+
| **200** | run returned | - |
|
|
713
|
+
|
|
714
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
## apiV1ChatsIdRunsRunIdRetryPost
|
|
718
|
+
|
|
719
|
+
> ApiV1ChatsIdRunsRunIdRetryPost201Response apiV1ChatsIdRunsRunIdRetryPost(id, runId)
|
|
720
|
+
|
|
721
|
+
Retry chat run
|
|
722
|
+
|
|
723
|
+
### Example
|
|
724
|
+
|
|
725
|
+
```ts
|
|
726
|
+
import {
|
|
727
|
+
Configuration,
|
|
728
|
+
ChatsApi,
|
|
729
|
+
} from 'blanche-client-sdk';
|
|
730
|
+
import type { ApiV1ChatsIdRunsRunIdRetryPostRequest } from 'blanche-client-sdk';
|
|
731
|
+
|
|
732
|
+
async function example() {
|
|
733
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
734
|
+
const api = new ChatsApi();
|
|
735
|
+
|
|
736
|
+
const body = {
|
|
737
|
+
// string
|
|
738
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
739
|
+
// string
|
|
740
|
+
runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
741
|
+
} satisfies ApiV1ChatsIdRunsRunIdRetryPostRequest;
|
|
742
|
+
|
|
743
|
+
try {
|
|
744
|
+
const data = await api.apiV1ChatsIdRunsRunIdRetryPost(body);
|
|
745
|
+
console.log(data);
|
|
746
|
+
} catch (error) {
|
|
747
|
+
console.error(error);
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
// Run the test
|
|
752
|
+
example().catch(console.error);
|
|
753
|
+
```
|
|
754
|
+
|
|
755
|
+
### Parameters
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
| Name | Type | Description | Notes |
|
|
759
|
+
|------------- | ------------- | ------------- | -------------|
|
|
760
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
761
|
+
| **runId** | `string` | | [Defaults to `undefined`] |
|
|
762
|
+
|
|
763
|
+
### Return type
|
|
764
|
+
|
|
765
|
+
[**ApiV1ChatsIdRunsRunIdRetryPost201Response**](ApiV1ChatsIdRunsRunIdRetryPost201Response.md)
|
|
766
|
+
|
|
767
|
+
### Authorization
|
|
768
|
+
|
|
769
|
+
No authorization required
|
|
770
|
+
|
|
771
|
+
### HTTP request headers
|
|
772
|
+
|
|
773
|
+
- **Content-Type**: Not defined
|
|
774
|
+
- **Accept**: `application/json`
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
### HTTP response details
|
|
778
|
+
| Status code | Description | Response headers |
|
|
779
|
+
|-------------|-------------|------------------|
|
|
780
|
+
| **201** | retry run created | - |
|
|
781
|
+
|
|
782
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
## apiV1ChatsIdSavedReportsGet
|
|
786
|
+
|
|
787
|
+
> ApiV1ChatsIdSavedReportsGet200Response apiV1ChatsIdSavedReportsGet(id)
|
|
788
|
+
|
|
789
|
+
List saved reports for chat
|
|
790
|
+
|
|
791
|
+
### Example
|
|
792
|
+
|
|
793
|
+
```ts
|
|
794
|
+
import {
|
|
795
|
+
Configuration,
|
|
796
|
+
ChatsApi,
|
|
797
|
+
} from 'blanche-client-sdk';
|
|
798
|
+
import type { ApiV1ChatsIdSavedReportsGetRequest } from 'blanche-client-sdk';
|
|
799
|
+
|
|
800
|
+
async function example() {
|
|
801
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
802
|
+
const api = new ChatsApi();
|
|
803
|
+
|
|
804
|
+
const body = {
|
|
805
|
+
// string
|
|
806
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
807
|
+
} satisfies ApiV1ChatsIdSavedReportsGetRequest;
|
|
808
|
+
|
|
809
|
+
try {
|
|
810
|
+
const data = await api.apiV1ChatsIdSavedReportsGet(body);
|
|
811
|
+
console.log(data);
|
|
812
|
+
} catch (error) {
|
|
813
|
+
console.error(error);
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
// Run the test
|
|
818
|
+
example().catch(console.error);
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
### Parameters
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
| Name | Type | Description | Notes |
|
|
825
|
+
|------------- | ------------- | ------------- | -------------|
|
|
826
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
827
|
+
|
|
828
|
+
### Return type
|
|
829
|
+
|
|
830
|
+
[**ApiV1ChatsIdSavedReportsGet200Response**](ApiV1ChatsIdSavedReportsGet200Response.md)
|
|
831
|
+
|
|
832
|
+
### Authorization
|
|
833
|
+
|
|
834
|
+
No authorization required
|
|
835
|
+
|
|
836
|
+
### HTTP request headers
|
|
837
|
+
|
|
838
|
+
- **Content-Type**: Not defined
|
|
839
|
+
- **Accept**: `application/json`
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
### HTTP response details
|
|
843
|
+
| Status code | Description | Response headers |
|
|
844
|
+
|-------------|-------------|------------------|
|
|
845
|
+
| **200** | saved reports returned | - |
|
|
846
|
+
|
|
847
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
## apiV1ChatsIdSavedReportsPost
|
|
851
|
+
|
|
852
|
+
> ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner apiV1ChatsIdSavedReportsPost(id, apiV1ChatsIdSavedReportsPostRequest)
|
|
853
|
+
|
|
854
|
+
Save report snapshot for chat run
|
|
855
|
+
|
|
856
|
+
### Example
|
|
857
|
+
|
|
858
|
+
```ts
|
|
859
|
+
import {
|
|
860
|
+
Configuration,
|
|
861
|
+
ChatsApi,
|
|
862
|
+
} from 'blanche-client-sdk';
|
|
863
|
+
import type { ApiV1ChatsIdSavedReportsPostOperationRequest } from 'blanche-client-sdk';
|
|
864
|
+
|
|
865
|
+
async function example() {
|
|
866
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
867
|
+
const api = new ChatsApi();
|
|
868
|
+
|
|
869
|
+
const body = {
|
|
870
|
+
// string
|
|
871
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
872
|
+
// ApiV1ChatsIdSavedReportsPostRequest (optional)
|
|
873
|
+
apiV1ChatsIdSavedReportsPostRequest: ...,
|
|
874
|
+
} satisfies ApiV1ChatsIdSavedReportsPostOperationRequest;
|
|
875
|
+
|
|
876
|
+
try {
|
|
877
|
+
const data = await api.apiV1ChatsIdSavedReportsPost(body);
|
|
878
|
+
console.log(data);
|
|
879
|
+
} catch (error) {
|
|
880
|
+
console.error(error);
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
|
|
884
|
+
// Run the test
|
|
885
|
+
example().catch(console.error);
|
|
886
|
+
```
|
|
887
|
+
|
|
888
|
+
### Parameters
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
| Name | Type | Description | Notes |
|
|
892
|
+
|------------- | ------------- | ------------- | -------------|
|
|
893
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
894
|
+
| **apiV1ChatsIdSavedReportsPostRequest** | [ApiV1ChatsIdSavedReportsPostRequest](ApiV1ChatsIdSavedReportsPostRequest.md) | | [Optional] |
|
|
895
|
+
|
|
896
|
+
### Return type
|
|
897
|
+
|
|
898
|
+
[**ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner**](ApiV1ChatsIdSavedReportsGet200ResponseSavedReportsInner.md)
|
|
899
|
+
|
|
900
|
+
### Authorization
|
|
901
|
+
|
|
902
|
+
No authorization required
|
|
903
|
+
|
|
904
|
+
### HTTP request headers
|
|
905
|
+
|
|
906
|
+
- **Content-Type**: `application/json`
|
|
907
|
+
- **Accept**: `application/json`
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
### HTTP response details
|
|
911
|
+
| Status code | Description | Response headers |
|
|
912
|
+
|-------------|-------------|------------------|
|
|
913
|
+
| **201** | saved report created | - |
|
|
914
|
+
|
|
915
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
## apiV1ChatsPlannerContractGet
|
|
919
|
+
|
|
920
|
+
> ApiV1ChatsPlannerContractGet200Response apiV1ChatsPlannerContractGet()
|
|
921
|
+
|
|
922
|
+
Get planner contract schema
|
|
923
|
+
|
|
924
|
+
### Example
|
|
925
|
+
|
|
926
|
+
```ts
|
|
927
|
+
import {
|
|
928
|
+
Configuration,
|
|
929
|
+
ChatsApi,
|
|
930
|
+
} from 'blanche-client-sdk';
|
|
931
|
+
import type { ApiV1ChatsPlannerContractGetRequest } from 'blanche-client-sdk';
|
|
932
|
+
|
|
933
|
+
async function example() {
|
|
934
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
935
|
+
const api = new ChatsApi();
|
|
936
|
+
|
|
937
|
+
try {
|
|
938
|
+
const data = await api.apiV1ChatsPlannerContractGet();
|
|
939
|
+
console.log(data);
|
|
940
|
+
} catch (error) {
|
|
941
|
+
console.error(error);
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
|
|
945
|
+
// Run the test
|
|
946
|
+
example().catch(console.error);
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
### Parameters
|
|
950
|
+
|
|
951
|
+
This endpoint does not need any parameter.
|
|
952
|
+
|
|
953
|
+
### Return type
|
|
954
|
+
|
|
955
|
+
[**ApiV1ChatsPlannerContractGet200Response**](ApiV1ChatsPlannerContractGet200Response.md)
|
|
956
|
+
|
|
957
|
+
### Authorization
|
|
958
|
+
|
|
959
|
+
No authorization required
|
|
960
|
+
|
|
961
|
+
### HTTP request headers
|
|
962
|
+
|
|
963
|
+
- **Content-Type**: Not defined
|
|
964
|
+
- **Accept**: `application/json`
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
### HTTP response details
|
|
968
|
+
| Status code | Description | Response headers |
|
|
969
|
+
|-------------|-------------|------------------|
|
|
970
|
+
| **200** | planner contract returned | - |
|
|
971
|
+
|
|
972
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
## apiV1ChatsPlannerPost
|
|
976
|
+
|
|
977
|
+
> ApiV1ChatsPlannerPost200Response apiV1ChatsPlannerPost(apiV1ChatsPlannerPostRequest)
|
|
978
|
+
|
|
979
|
+
Build deterministic planner decision
|
|
980
|
+
|
|
981
|
+
### Example
|
|
982
|
+
|
|
983
|
+
```ts
|
|
984
|
+
import {
|
|
985
|
+
Configuration,
|
|
986
|
+
ChatsApi,
|
|
987
|
+
} from 'blanche-client-sdk';
|
|
988
|
+
import type { ApiV1ChatsPlannerPostOperationRequest } from 'blanche-client-sdk';
|
|
989
|
+
|
|
990
|
+
async function example() {
|
|
991
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
992
|
+
const api = new ChatsApi();
|
|
993
|
+
|
|
994
|
+
const body = {
|
|
995
|
+
// ApiV1ChatsPlannerPostRequest (optional)
|
|
996
|
+
apiV1ChatsPlannerPostRequest: ...,
|
|
997
|
+
} satisfies ApiV1ChatsPlannerPostOperationRequest;
|
|
998
|
+
|
|
999
|
+
try {
|
|
1000
|
+
const data = await api.apiV1ChatsPlannerPost(body);
|
|
1001
|
+
console.log(data);
|
|
1002
|
+
} catch (error) {
|
|
1003
|
+
console.error(error);
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
// Run the test
|
|
1008
|
+
example().catch(console.error);
|
|
1009
|
+
```
|
|
1010
|
+
|
|
1011
|
+
### Parameters
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
| Name | Type | Description | Notes |
|
|
1015
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1016
|
+
| **apiV1ChatsPlannerPostRequest** | [ApiV1ChatsPlannerPostRequest](ApiV1ChatsPlannerPostRequest.md) | | [Optional] |
|
|
1017
|
+
|
|
1018
|
+
### Return type
|
|
1019
|
+
|
|
1020
|
+
[**ApiV1ChatsPlannerPost200Response**](ApiV1ChatsPlannerPost200Response.md)
|
|
1021
|
+
|
|
1022
|
+
### Authorization
|
|
1023
|
+
|
|
1024
|
+
No authorization required
|
|
1025
|
+
|
|
1026
|
+
### HTTP request headers
|
|
1027
|
+
|
|
1028
|
+
- **Content-Type**: `application/json`
|
|
1029
|
+
- **Accept**: `application/json`
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
### HTTP response details
|
|
1033
|
+
| Status code | Description | Response headers |
|
|
1034
|
+
|-------------|-------------|------------------|
|
|
1035
|
+
| **200** | planner returned | - |
|
|
1036
|
+
| **422** | invalid request | - |
|
|
1037
|
+
|
|
1038
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
## apiV1ChatsPost
|
|
1042
|
+
|
|
1043
|
+
> ApiV1ChatsPost201Response apiV1ChatsPost(apiV1ChatsPostRequest)
|
|
1044
|
+
|
|
1045
|
+
Create chat
|
|
1046
|
+
|
|
1047
|
+
### Example
|
|
1048
|
+
|
|
1049
|
+
```ts
|
|
1050
|
+
import {
|
|
1051
|
+
Configuration,
|
|
1052
|
+
ChatsApi,
|
|
1053
|
+
} from 'blanche-client-sdk';
|
|
1054
|
+
import type { ApiV1ChatsPostOperationRequest } from 'blanche-client-sdk';
|
|
1055
|
+
|
|
1056
|
+
async function example() {
|
|
1057
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
1058
|
+
const api = new ChatsApi();
|
|
1059
|
+
|
|
1060
|
+
const body = {
|
|
1061
|
+
// ApiV1ChatsPostRequest (optional)
|
|
1062
|
+
apiV1ChatsPostRequest: ...,
|
|
1063
|
+
} satisfies ApiV1ChatsPostOperationRequest;
|
|
1064
|
+
|
|
1065
|
+
try {
|
|
1066
|
+
const data = await api.apiV1ChatsPost(body);
|
|
1067
|
+
console.log(data);
|
|
1068
|
+
} catch (error) {
|
|
1069
|
+
console.error(error);
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
// Run the test
|
|
1074
|
+
example().catch(console.error);
|
|
1075
|
+
```
|
|
1076
|
+
|
|
1077
|
+
### Parameters
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
| Name | Type | Description | Notes |
|
|
1081
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1082
|
+
| **apiV1ChatsPostRequest** | [ApiV1ChatsPostRequest](ApiV1ChatsPostRequest.md) | | [Optional] |
|
|
1083
|
+
|
|
1084
|
+
### Return type
|
|
1085
|
+
|
|
1086
|
+
[**ApiV1ChatsPost201Response**](ApiV1ChatsPost201Response.md)
|
|
1087
|
+
|
|
1088
|
+
### Authorization
|
|
1089
|
+
|
|
1090
|
+
No authorization required
|
|
1091
|
+
|
|
1092
|
+
### HTTP request headers
|
|
1093
|
+
|
|
1094
|
+
- **Content-Type**: `application/json`
|
|
1095
|
+
- **Accept**: `application/json`
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
### HTTP response details
|
|
1099
|
+
| Status code | Description | Response headers |
|
|
1100
|
+
|-------------|-------------|------------------|
|
|
1101
|
+
| **201** | chat created | - |
|
|
1102
|
+
|
|
1103
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
## apiV1ChatsSyncGet
|
|
1107
|
+
|
|
1108
|
+
> ApiV1ChatsSyncGet200Response apiV1ChatsSyncGet(cursor, limit)
|
|
1109
|
+
|
|
1110
|
+
Sync chats by cursor
|
|
1111
|
+
|
|
1112
|
+
### Example
|
|
1113
|
+
|
|
1114
|
+
```ts
|
|
1115
|
+
import {
|
|
1116
|
+
Configuration,
|
|
1117
|
+
ChatsApi,
|
|
1118
|
+
} from 'blanche-client-sdk';
|
|
1119
|
+
import type { ApiV1ChatsSyncGetRequest } from 'blanche-client-sdk';
|
|
1120
|
+
|
|
1121
|
+
async function example() {
|
|
1122
|
+
console.log("🚀 Testing blanche-client-sdk SDK...");
|
|
1123
|
+
const api = new ChatsApi();
|
|
1124
|
+
|
|
1125
|
+
const body = {
|
|
1126
|
+
// string (optional)
|
|
1127
|
+
cursor: cursor_example,
|
|
1128
|
+
// number (optional)
|
|
1129
|
+
limit: 56,
|
|
1130
|
+
} satisfies ApiV1ChatsSyncGetRequest;
|
|
1131
|
+
|
|
1132
|
+
try {
|
|
1133
|
+
const data = await api.apiV1ChatsSyncGet(body);
|
|
1134
|
+
console.log(data);
|
|
1135
|
+
} catch (error) {
|
|
1136
|
+
console.error(error);
|
|
1137
|
+
}
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
// Run the test
|
|
1141
|
+
example().catch(console.error);
|
|
1142
|
+
```
|
|
1143
|
+
|
|
1144
|
+
### Parameters
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
| Name | Type | Description | Notes |
|
|
1148
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1149
|
+
| **cursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1150
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1151
|
+
|
|
1152
|
+
### Return type
|
|
1153
|
+
|
|
1154
|
+
[**ApiV1ChatsSyncGet200Response**](ApiV1ChatsSyncGet200Response.md)
|
|
1155
|
+
|
|
1156
|
+
### Authorization
|
|
1157
|
+
|
|
1158
|
+
No authorization required
|
|
1159
|
+
|
|
1160
|
+
### HTTP request headers
|
|
1161
|
+
|
|
1162
|
+
- **Content-Type**: Not defined
|
|
1163
|
+
- **Accept**: `application/json`
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
### HTTP response details
|
|
1167
|
+
| Status code | Description | Response headers |
|
|
1168
|
+
|-------------|-------------|------------------|
|
|
1169
|
+
| **200** | sync slice returned | - |
|
|
1170
|
+
|
|
1171
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1172
|
+
|