blanche-client-sdk 0.2.1 → 0.4.0

package/docs/ApiV1TemplatesGet200ResponseTemplatesInnerActiveSchema.md

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

@@ -0,0 +1,46 @@
+
+# ApiV1TemplatesIdGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`visible` | boolean
+`system` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+`schemas` | [Array<ApiV1TemplatesIdGet200ResponseSchemasInner>](ApiV1TemplatesIdGet200ResponseSchemasInner.md)
+
+## Example
+
+```typescript
+import type { ApiV1TemplatesIdGet200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "visible": null,
+  "system": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "schemas": null,
+} satisfies ApiV1TemplatesIdGet200Response
+
+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 ApiV1TemplatesIdGet200Response
+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/ApiV1TemplatesIdGet200ResponseSchemasInner.md

@@ -0,0 +1,44 @@
+
+# ApiV1TemplatesIdGet200ResponseSchemasInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`version` | number
+`jsonSchema` | object
+`systemPrompt` | string
+`active` | boolean
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ApiV1TemplatesIdGet200ResponseSchemasInner } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "version": null,
+  "jsonSchema": null,
+  "systemPrompt": null,
+  "active": null,
+  "createdAt": null,
+} satisfies ApiV1TemplatesIdGet200ResponseSchemasInner
+
+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 ApiV1TemplatesIdGet200ResponseSchemasInner
+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/ApiV1TemplatesIdGet404Response.md

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

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

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

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

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

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

@@ -0,0 +1,282 @@
+# RecordsApi
+
+All URIs are relative to *http://localhost:3000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**apiV1RecordsGet**](RecordsApi.md#apiv1recordsget) | **GET** /api/v1/records | List records |
+| [**apiV1RecordsIdDelete**](RecordsApi.md#apiv1recordsiddelete) | **DELETE** /api/v1/records/{id} | Delete record |
+| [**apiV1RecordsIdGet**](RecordsApi.md#apiv1recordsidget) | **GET** /api/v1/records/{id} | Get record |
+| [**apiV1RecordsIdPatch**](RecordsApi.md#apiv1recordsidpatchoperation) | **PATCH** /api/v1/records/{id} | Update record |
+
+
+
+## apiV1RecordsGet
+
+> ApiV1RecordsGet200Response apiV1RecordsGet(template, limit, offset)
+
+List records
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecordsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1RecordsGetRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new RecordsApi();
+
+  const body = {
+    // string (optional)
+    template: template_example,
+    // number (optional)
+    limit: 56,
+    // number (optional)
+    offset: 56,
+  } satisfies ApiV1RecordsGetRequest;
+
+  try {
+    const data = await api.apiV1RecordsGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **template** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1RecordsGet200Response**](ApiV1RecordsGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | records returned |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1RecordsIdDelete
+
+> ApiV1RecordsIdDelete200Response apiV1RecordsIdDelete(id)
+
+Delete record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecordsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1RecordsIdDeleteRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new RecordsApi();
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies ApiV1RecordsIdDeleteRequest;
+
+  try {
+    const data = await api.apiV1RecordsIdDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1RecordsIdDelete200Response**](ApiV1RecordsIdDelete200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | record deleted |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1RecordsIdGet
+
+> ApiV1RecordsIdGet200Response apiV1RecordsIdGet(id)
+
+Get record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecordsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1RecordsIdGetRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new RecordsApi();
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies ApiV1RecordsIdGetRequest;
+
+  try {
+    const data = await api.apiV1RecordsIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1RecordsIdGet200Response**](ApiV1RecordsIdGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | record returned |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1RecordsIdPatch
+
+> ApiV1RecordsIdPatch200Response apiV1RecordsIdPatch(id, apiV1RecordsIdPatchRequest)
+
+Update record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecordsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1RecordsIdPatchOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new RecordsApi();
+
+  const body = {
+    // string
+    id: id_example,
+    // ApiV1RecordsIdPatchRequest (optional)
+    apiV1RecordsIdPatchRequest: ...,
+  } satisfies ApiV1RecordsIdPatchOperationRequest;
+
+  try {
+    const data = await api.apiV1RecordsIdPatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **apiV1RecordsIdPatchRequest** | [ApiV1RecordsIdPatchRequest](ApiV1RecordsIdPatchRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1RecordsIdPatch200Response**](ApiV1RecordsIdPatch200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | record updated |  -  |
+| **422** | invalid request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+