blanche-client-sdk 0.2.0 → 0.3.0

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/ApiV1TemplatesPost422Response.md

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

@@ -0,0 +1,279 @@
+# TemplatesApi
+
+All URIs are relative to *http://localhost:3000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**apiV1TemplatesGet**](TemplatesApi.md#apiv1templatesget) | **GET** /api/v1/templates | List templates |
+| [**apiV1TemplatesIdGet**](TemplatesApi.md#apiv1templatesidget) | **GET** /api/v1/templates/{id} | Get template |
+| [**apiV1TemplatesIdPatch**](TemplatesApi.md#apiv1templatesidpatchoperation) | **PATCH** /api/v1/templates/{id} | Update template |
+| [**apiV1TemplatesPost**](TemplatesApi.md#apiv1templatespostoperation) | **POST** /api/v1/templates | Create template |
+
+
+
+## apiV1TemplatesGet
+
+> ApiV1TemplatesGet200Response apiV1TemplatesGet(format)
+
+List templates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from 'blanche-client-sdk';
+import type { ApiV1TemplatesGetRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new TemplatesApi();
+
+  const body = {
+    // string | Use \'system_prompt\' to return prompt format (optional)
+    format: format_example,
+  } satisfies ApiV1TemplatesGetRequest;
+
+  try {
+    const data = await api.apiV1TemplatesGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **format** | `string` | Use \'system_prompt\' to return prompt format | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1TemplatesGet200Response**](ApiV1TemplatesGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | system prompt returned |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1TemplatesIdGet
+
+> ApiV1TemplatesIdGet200Response apiV1TemplatesIdGet(id)
+
+Get template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from 'blanche-client-sdk';
+import type { ApiV1TemplatesIdGetRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new TemplatesApi();
+
+  const body = {
+    // string | Template ID
+    id: id_example,
+  } satisfies ApiV1TemplatesIdGetRequest;
+
+  try {
+    const data = await api.apiV1TemplatesIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Template ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1TemplatesIdGet200Response**](ApiV1TemplatesIdGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | template returned |  -  |
+| **404** | not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1TemplatesIdPatch
+
+> ApiV1TemplatesPost201Response apiV1TemplatesIdPatch(id, apiV1TemplatesIdPatchRequest)
+
+Update template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from 'blanche-client-sdk';
+import type { ApiV1TemplatesIdPatchOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new TemplatesApi();
+
+  const body = {
+    // string | Template ID
+    id: id_example,
+    // ApiV1TemplatesIdPatchRequest (optional)
+    apiV1TemplatesIdPatchRequest: ...,
+  } satisfies ApiV1TemplatesIdPatchOperationRequest;
+
+  try {
+    const data = await api.apiV1TemplatesIdPatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Template ID | [Defaults to `undefined`] |
+| **apiV1TemplatesIdPatchRequest** | [ApiV1TemplatesIdPatchRequest](ApiV1TemplatesIdPatchRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1TemplatesPost201Response**](ApiV1TemplatesPost201Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | template updated |  -  |
+| **404** | not found |  -  |
+| **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)
+
+
+## apiV1TemplatesPost
+
+> ApiV1TemplatesPost201Response apiV1TemplatesPost(apiV1TemplatesPostRequest)
+
+Create template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from 'blanche-client-sdk';
+import type { ApiV1TemplatesPostOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new TemplatesApi();
+
+  const body = {
+    // ApiV1TemplatesPostRequest (optional)
+    apiV1TemplatesPostRequest: ...,
+  } satisfies ApiV1TemplatesPostOperationRequest;
+
+  try {
+    const data = await api.apiV1TemplatesPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiV1TemplatesPostRequest** | [ApiV1TemplatesPostRequest](ApiV1TemplatesPostRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1TemplatesPost201Response**](ApiV1TemplatesPost201Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | template created |  -  |
+| **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)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blanche-client-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "OpenAPI client for blanche-client-sdk",
   "author": "OpenAPI-Generator",
   "repository": {