blanche-client-sdk

v0.6.4

Published

19 days ago

OpenAPI client for blanche-client-sdk

0High
0Medium
0Low

strikepark

[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install blanche-client-sdk --save

Next, try it out.

import {
  Configuration,
  ChatsApi,
} from 'blanche-client-sdk';
import type { ApiV1ChatsChatIdMessagesGetRequest } from 'blanche-client-sdk';

async function example() {
  console.log("🚀 Testing blanche-client-sdk SDK...");
  const api = new ChatsApi();

  const body = {
    // string
    chatId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // number (optional)
    limit: 56,
    // number (optional)
    offset: 56,
  } satisfies ApiV1ChatsChatIdMessagesGetRequest;

  try {
    const data = await api.apiV1ChatsChatIdMessagesGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost:3000

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- ChatsApi | apiV1ChatsChatIdMessagesGet | GET /api/v1/chats/{chat_id}/messages | List chat messages ChatsApi | apiV1ChatsChatIdMessagesPost | POST /api/v1/chats/{chat_id}/messages | Create chat message ChatsApi | apiV1ChatsChatIdMessagesSyncGet | GET /api/v1/chats/{chat_id}/messages/sync | Sync chat messages by cursor ChatsApi | apiV1ChatsGet | GET /api/v1/chats | List chats ChatsApi | apiV1ChatsIdArtifactsGet | GET /api/v1/chats/{id}/artifacts | List artifacts for chat ChatsApi | apiV1ChatsIdMessagesMessageIdAttachmentsGet | GET /api/v1/chats/{id}/messages/{message_id}/attachments | List chat message attachments ChatsApi | apiV1ChatsIdMessagesMessageIdAttachmentsPost | POST /api/v1/chats/{id}/messages/{message_id}/attachments | Create chat message attachment ChatsApi | apiV1ChatsIdReadPost | POST /api/v1/chats/{id}/read | Mark chat as read ChatsApi | apiV1ChatsIdReportsPost | POST /api/v1/chats/{id}/reports | Run deterministic SQL report tool ChatsApi | apiV1ChatsIdRunsRunIdArtifactsGet | GET /api/v1/chats/{id}/runs/{run_id}/artifacts | List artifacts for chat run ChatsApi | apiV1ChatsIdRunsRunIdCancelPost | POST /api/v1/chats/{id}/runs/{run_id}/cancel | Cancel chat run ChatsApi | apiV1ChatsIdRunsRunIdCitationsGet | GET /api/v1/chats/{id}/runs/{run_id}/citations | Get run citations ChatsApi | apiV1ChatsIdRunsRunIdGet | GET /api/v1/chats/{id}/runs/{run_id} | Get chat run status ChatsApi | apiV1ChatsIdRunsRunIdRetryPost | POST /api/v1/chats/{id}/runs/{run_id}/retry | Retry chat run ChatsApi | apiV1ChatsIdSavedReportsGet | GET /api/v1/chats/{id}/saved_reports | List saved reports for chat ChatsApi | apiV1ChatsIdSavedReportsPost | POST /api/v1/chats/{id}/saved_reports | Save report snapshot for chat run ChatsApi | apiV1ChatsPlannerContractGet | GET /api/v1/chats/planner_contract | Get planner contract schema ChatsApi | apiV1ChatsPlannerPost | POST /api/v1/chats/planner | Build deterministic planner decision ChatsApi | apiV1ChatsPost | POST /api/v1/chats | Create chat ChatsApi | apiV1ChatsRealtimeContractGet | GET /api/v1/chats/realtime_contract | Get AnyCable realtime event contract ChatsApi | apiV1ChatsSyncGet | GET /api/v1/chats/sync | Sync chats by cursor RecordsApi | apiV1RecordsGet | GET /api/v1/records | List records RecordsApi | apiV1RecordsIdDelete | DELETE /api/v1/records/{id} | Delete record RecordsApi | apiV1RecordsIdGet | GET /api/v1/records/{id} | Get record RecordsApi | apiV1RecordsIdPatch | PATCH /api/v1/records/{id} | Update record RecordsApi | apiV1RecordsIdPut | PUT /api/v1/records/{id} | Update record (PUT) SessionsApi | apiV1SessionsDelete | DELETE /api/v1/sessions | Logout user and invalidate refresh token SessionsApi | apiV1SessionsPost | POST /api/v1/sessions | Authenticate user and return tokens SessionsApi | apiV1SessionsRefreshPost | POST /api/v1/sessions/refresh | Refresh tokens using a valid refresh token TelegramLinksApi | apiV1TelegramLinksConsumePost | POST /api/v1/telegram_links/consume | Consume telegram link TelegramLinksApi | apiV1TelegramLinksPost | POST /api/v1/telegram_links | Create telegram link TelegramLinksApi | apiV1TelegramLinksTokenGet | GET /api/v1/telegram_links/{token} | Get telegram link status TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasGet | GET /api/v1/templates/{template_id}/schemas | List template schemas TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasIdActivatePatch | PATCH /api/v1/templates/{template_id}/schemas/{id}/activate | Activate template schema TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasIdDeactivatePatch | PATCH /api/v1/templates/{template_id}/schemas/{id}/deactivate | Deactivate template schema TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasIdPatch | PATCH /api/v1/templates/{template_id}/schemas/{id} | Update template schema TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasIdPut | PUT /api/v1/templates/{template_id}/schemas/{id} | Update template schema (PUT) TemplateSchemasApi | apiV1TemplatesTemplateIdSchemasPost | POST /api/v1/templates/{template_id}/schemas | Create template schema TemplatesApi | apiV1TemplatesGet | GET /api/v1/templates | List templates TemplatesApi | apiV1TemplatesIdGet | GET /api/v1/templates/{id} | Get template TemplatesApi | apiV1TemplatesIdPatch | PATCH /api/v1/templates/{id} | Update template TemplatesApi | apiV1TemplatesIdPut | PUT /api/v1/templates/{id} | Update template (PUT) TemplatesApi | apiV1TemplatesPost | POST /api/v1/templates | Create template UsersApi | apiV1ProfileGet | GET /api/v1/profile | Get current user profile UsersApi | apiV1UsersIdPatch | PATCH /api/v1/users/{id} | Updates a user UsersApi | apiV1UsersIdPut | PUT /api/v1/users/{id} | Updates a user (PUT) UsersApi | apiV1UsersPost | POST /api/v1/users | Creates a user

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: v1
Package version: 0.6.4
Generator version: 7.20.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme