@zlayer/api-client 0.10.86

package/docs/AuditEntry.md

@@ -0,0 +1,51 @@
+
+# AuditEntry
+
+A recorded audit log entry capturing who did what, when, and to which resource.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`action` | string
+`createdAt` | string
+`details` | object
+`id` | string
+`ip` | string
+`resourceId` | string
+`resourceKind` | string
+`userAgent` | string
+`userId` | string
+
+## Example
+
+```typescript
+import type { AuditEntry } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "action": null,
+  "createdAt": 2026-04-15T12:00:00Z,
+  "details": null,
+  "id": null,
+  "ip": null,
+  "resourceId": null,
+  "resourceKind": null,
+  "userAgent": null,
+  "userId": null,
+} satisfies AuditEntry
+
+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 AuditEntry
+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/AuthenticationApi.md

@@ -0,0 +1,395 @@
+# AuthenticationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**bootstrap**](AuthenticationApi.md#bootstrapoperation) | **POST** /auth/bootstrap | Bootstrap the very first admin user. Returns 409 if any user exists. |
+| [**csrf**](AuthenticationApi.md#csrf) | **GET** /auth/csrf | Rotate the CSRF double-submit token for the current session. |
+| [**getToken**](AuthenticationApi.md#gettoken) | **POST** /auth/token | Get an access token. |
+| [**login**](AuthenticationApi.md#loginoperation) | **POST** /auth/login | Sign in an existing user. |
+| [**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout | Clear the session + CSRF cookies. |
+| [**me**](AuthenticationApi.md#me) | **GET** /auth/me | Return the currently signed-in user. |
+
+
+
+## bootstrap
+
+> LoginResponse bootstrap(bootstrapRequest)
+
+Bootstrap the very first admin user. Returns 409 if any user exists.
+
+# Errors  Returns an error if the user store or credential store is not configured, if any user already exists, if the request is missing required fields, or if the underlying stores fail.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { BootstrapOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  const body = {
+    // BootstrapRequest
+    bootstrapRequest: ...,
+  } satisfies BootstrapOperationRequest;
+
+  try {
+    const data = await api.bootstrap(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **bootstrapRequest** | [BootstrapRequest](BootstrapRequest.md) |  | |
+
+### Return type
+
+[**LoginResponse**](LoginResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Admin user created |  -  |
+| **400** | Invalid email or password |  -  |
+| **409** | Bootstrap already completed |  -  |
+| **503** | User store not configured |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## csrf
+
+> CsrfResponse csrf()
+
+Rotate the CSRF double-submit token for the current session.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { CsrfRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  try {
+    const data = await api.csrf();
+    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
+
+[**CsrfResponse**](CsrfResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rotated CSRF token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getToken
+
+> TokenResponse getToken(tokenRequest)
+
+Get an access token.
+
+# Errors  Returns an error if credentials are invalid or token creation fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { GetTokenRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  const body = {
+    // TokenRequest
+    tokenRequest: ...,
+  } satisfies GetTokenRequest;
+
+  try {
+    const data = await api.getToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenRequest** | [TokenRequest](TokenRequest.md) |  | |
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Token created |  -  |
+| **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)
+
+
+## login
+
+> LoginResponse login(loginRequest)
+
+Sign in an existing user.
+
+# Errors  Returns an error if credentials are invalid, the user is disabled, or any backing store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { LoginOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  const body = {
+    // LoginRequest
+    loginRequest: ...,
+  } satisfies LoginOperationRequest;
+
+  try {
+    const data = await api.login(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **loginRequest** | [LoginRequest](LoginRequest.md) |  | |
+
+### Return type
+
+[**LoginResponse**](LoginResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Logged in |  -  |
+| **401** | Invalid credentials |  -  |
+| **403** | User disabled |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## logout
+
+> logout()
+
+Clear the session + CSRF cookies.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { LogoutRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  try {
+    const data = await api.logout();
+    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
+
+`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 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## me
+
+> UserView me()
+
+Return the currently signed-in user.
+
+# Errors  Returns an error if the user store is not configured, if the user no longer exists, or if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@zlayer/client';
+import type { MeRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new AuthenticationApi();
+
+  try {
+    const data = await api.me();
+    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
+
+[**UserView**](UserView.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current user |  -  |
+| **401** | Not signed in |  -  |
+
+[[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/BackendGroupInfo.md

@@ -0,0 +1,43 @@
+
+# BackendGroupInfo
+
+A load-balancer backend group for one service.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`backends` | [Array<BackendInfo>](BackendInfo.md)
+`healthyCount` | number
+`service` | string
+`strategy` | string
+`totalCount` | number
+
+## Example
+
+```typescript
+import type { BackendGroupInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "backends": null,
+  "healthyCount": null,
+  "service": null,
+  "strategy": null,
+  "totalCount": null,
+} satisfies BackendGroupInfo
+
+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 BackendGroupInfo
+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/BackendInfo.md

@@ -0,0 +1,41 @@
+
+# BackendInfo
+
+Information about a single backend in a load-balancer group.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`activeConnections` | number
+`address` | string
+`consecutiveFailures` | number
+`healthy` | boolean
+
+## Example
+
+```typescript
+import type { BackendInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "activeConnections": null,
+  "address": null,
+  "consecutiveFailures": null,
+  "healthy": null,
+} satisfies BackendInfo
+
+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 BackendInfo
+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/BackendsResponse.md

@@ -0,0 +1,37 @@
+
+# BackendsResponse
+
+Response for `GET /api/v1/proxy/backends`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`groups` | [Array<BackendGroupInfo>](BackendGroupInfo.md)
+`totalGroups` | number
+
+## Example
+
+```typescript
+import type { BackendsResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "groups": null,
+  "totalGroups": null,
+} satisfies BackendsResponse
+
+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 BackendsResponse
+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/BootstrapRequest.md

@@ -0,0 +1,39 @@
+
+# BootstrapRequest
+
+Request for `POST /auth/bootstrap`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`displayName` | string
+`email` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { BootstrapRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "displayName": null,
+  "email": null,
+  "password": null,
+} satisfies BootstrapRequest
+
+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 BootstrapRequest
+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)
+
+