blanche-client-sdk 0.1.3

package/docs/ApiV1SessionsPost401Response.md

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

@@ -0,0 +1,36 @@
+
+# ApiV1SessionsPostRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { ApiV1SessionsPostRequest } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": user@example.com,
+  "password": password123,
+} satisfies ApiV1SessionsPostRequest
+
+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 ApiV1SessionsPostRequest
+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/ApiV1UsersIdPatch200Response.md

@@ -0,0 +1,38 @@
+
+# ApiV1UsersIdPatch200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`timezone` | string
+
+## Example
+
+```typescript
+import type { ApiV1UsersIdPatch200Response } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 0197df79-a142-74e4-b92c-bb3b8f1aae22,
+  "email": updated@example.com,
+  "timezone": America/New_York,
+} satisfies ApiV1UsersIdPatch200Response
+
+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 ApiV1UsersIdPatch200Response
+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/ApiV1UsersIdPatchRequest.md

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

@@ -0,0 +1,38 @@
+
+# ApiV1UsersIdPatchRequestUser
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+`timezone` | string
+
+## Example
+
+```typescript
+import type { ApiV1UsersIdPatchRequestUser } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": updated@example.com,
+  "password": newpassword123,
+  "timezone": America/New_York,
+} satisfies ApiV1UsersIdPatchRequestUser
+
+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 ApiV1UsersIdPatchRequestUser
+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/ApiV1UsersPost422Response.md

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

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

@@ -0,0 +1,38 @@
+
+# ApiV1UsersPostRequestUser
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+`timezone` | string
+
+## Example
+
+```typescript
+import type { ApiV1UsersPostRequestUser } from 'blanche-client-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": user@example.com,
+  "password": password123,
+  "timezone": UTC,
+} satisfies ApiV1UsersPostRequestUser
+
+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 ApiV1UsersPostRequestUser
+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/SessionsApi.md

@@ -0,0 +1,209 @@
+# SessionsApi
+
+All URIs are relative to *http://localhost:3000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**apiV1SessionsDelete**](SessionsApi.md#apiv1sessionsdelete) | **DELETE** /api/v1/sessions | Logout user and invalidate refresh token |
+| [**apiV1SessionsPost**](SessionsApi.md#apiv1sessionspostoperation) | **POST** /api/v1/sessions | Authenticate user and return tokens |
+| [**apiV1SessionsRefreshPost**](SessionsApi.md#apiv1sessionsrefreshpost) | **POST** /api/v1/sessions/refresh | Refresh tokens using a valid refresh token |
+
+
+
+## apiV1SessionsDelete
+
+> apiV1SessionsDelete(xRefreshToken)
+
+Logout user and invalidate refresh token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1SessionsDeleteRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new SessionsApi();
+
+  const body = {
+    // string | JWT refresh token
+    xRefreshToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...,
+  } satisfies ApiV1SessionsDeleteRequest;
+
+  try {
+    const data = await api.apiV1SessionsDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xRefreshToken** | `string` | JWT refresh token | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | logged out |  -  |
+| **401** | invalid refresh token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1SessionsPost
+
+> ApiV1SessionsPost200Response apiV1SessionsPost(apiV1SessionsPostRequest)
+
+Authenticate user and return tokens
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1SessionsPostOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new SessionsApi();
+
+  const body = {
+    // ApiV1SessionsPostRequest (optional)
+    apiV1SessionsPostRequest: ...,
+  } satisfies ApiV1SessionsPostOperationRequest;
+
+  try {
+    const data = await api.apiV1SessionsPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiV1SessionsPostRequest** | [ApiV1SessionsPostRequest](ApiV1SessionsPostRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1SessionsPost200Response**](ApiV1SessionsPost200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | tokens returned |  -  |
+| **401** | invalid credentials |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1SessionsRefreshPost
+
+> ApiV1SessionsPost200Response apiV1SessionsRefreshPost(xRefreshToken)
+
+Refresh tokens using a valid refresh token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from 'blanche-client-sdk';
+import type { ApiV1SessionsRefreshPostRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new SessionsApi();
+
+  const body = {
+    // string | JWT refresh token
+    xRefreshToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...,
+  } satisfies ApiV1SessionsRefreshPostRequest;
+
+  try {
+    const data = await api.apiV1SessionsRefreshPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xRefreshToken** | `string` | JWT refresh token | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiV1SessionsPost200Response**](ApiV1SessionsPost200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | tokens refreshed |  -  |
+| **401** | invalid refresh token |  -  |
+
+[[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/UsersApi.md

@@ -0,0 +1,205 @@
+# UsersApi
+
+All URIs are relative to *http://localhost:3000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**apiV1ProfileGet**](UsersApi.md#apiv1profileget) | **GET** /api/v1/profile | Get current user profile |
+| [**apiV1UsersIdPatch**](UsersApi.md#apiv1usersidpatchoperation) | **PATCH** /api/v1/users/{id} | Updates a user |
+| [**apiV1UsersPost**](UsersApi.md#apiv1userspostoperation) | **POST** /api/v1/users | Creates a user |
+
+
+
+## apiV1ProfileGet
+
+> ApiV1ProfileGet200Response apiV1ProfileGet()
+
+Get current user profile
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from 'blanche-client-sdk';
+import type { ApiV1ProfileGetRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new UsersApi();
+
+  try {
+    const data = await api.apiV1ProfileGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiV1ProfileGet200Response**](ApiV1ProfileGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | profile returned |  -  |
+| **401** | unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## apiV1UsersIdPatch
+
+> ApiV1UsersIdPatch200Response apiV1UsersIdPatch(id, apiV1UsersIdPatchRequest)
+
+Updates a user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from 'blanche-client-sdk';
+import type { ApiV1UsersIdPatchOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // string | User ID
+    id: id_example,
+    // ApiV1UsersIdPatchRequest (optional)
+    apiV1UsersIdPatchRequest: ...,
+  } satisfies ApiV1UsersIdPatchOperationRequest;
+
+  try {
+    const data = await api.apiV1UsersIdPatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | User ID | [Defaults to `undefined`] |
+| **apiV1UsersIdPatchRequest** | [ApiV1UsersIdPatchRequest](ApiV1UsersIdPatchRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1UsersIdPatch200Response**](ApiV1UsersIdPatch200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user updated |  -  |
+| **401** | unauthorized |  -  |
+| **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)
+
+
+## apiV1UsersPost
+
+> ApiV1ProfileGet200Response apiV1UsersPost(apiV1UsersPostRequest)
+
+Creates a user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from 'blanche-client-sdk';
+import type { ApiV1UsersPostOperationRequest } from 'blanche-client-sdk';
+
+async function example() {
+  console.log("🚀 Testing blanche-client-sdk SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // ApiV1UsersPostRequest (optional)
+    apiV1UsersPostRequest: ...,
+  } satisfies ApiV1UsersPostOperationRequest;
+
+  try {
+    const data = await api.apiV1UsersPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiV1UsersPostRequest** | [ApiV1UsersPostRequest](ApiV1UsersPostRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ApiV1ProfileGet200Response**](ApiV1ProfileGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | user 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)
+