@zlayer/api-client 0.10.86

package/docs/NotifiersApi.md

@@ -0,0 +1,446 @@
+# NotifiersApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createNotifier**](NotifiersApi.md#createnotifieroperation) | **POST** /api/v1/notifiers | Create a new notifier. Admin only. |
+| [**deleteNotifier**](NotifiersApi.md#deletenotifier) | **DELETE** /api/v1/notifiers/{id} | Delete a notifier. Admin only. |
+| [**getNotifier**](NotifiersApi.md#getnotifier) | **GET** /api/v1/notifiers/{id} | Fetch a single notifier by id. |
+| [**listNotifiers**](NotifiersApi.md#listnotifiers) | **GET** /api/v1/notifiers | List notifiers. |
+| [**testNotifier**](NotifiersApi.md#testnotifier) | **POST** /api/v1/notifiers/{id}/test | Send a test notification through a notifier. Admin only. |
+| [**updateNotifier**](NotifiersApi.md#updatenotifieroperation) | **PATCH** /api/v1/notifiers/{id} | Update a notifier. Admin only. |
+
+
+
+## createNotifier
+
+> StoredNotifier createNotifier(createNotifierRequest)
+
+Create a new notifier. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name or kind/config mismatch, or [`ApiError::Internal`] when the notifier store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { CreateNotifierOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  const body = {
+    // CreateNotifierRequest
+    createNotifierRequest: ...,
+  } satisfies CreateNotifierOperationRequest;
+
+  try {
+    const data = await api.createNotifier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createNotifierRequest** | [CreateNotifierRequest](CreateNotifierRequest.md) |  | |
+
+### Return type
+
+[**StoredNotifier**](StoredNotifier.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Notifier created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteNotifier
+
+> deleteNotifier(id)
+
+Delete a notifier. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the notifier does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { DeleteNotifierRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  const body = {
+    // string | Notifier id
+    id: id_example,
+  } satisfies DeleteNotifierRequest;
+
+  try {
+    const data = await api.deleteNotifier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Notifier id | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Notifier deleted |  -  |
+| **403** | Admin role required |  -  |
+| **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)
+
+
+## getNotifier
+
+> StoredNotifier getNotifier(id)
+
+Fetch a single notifier by id.
+
+# Errors  Returns [`ApiError::NotFound`] if no notifier with the given id exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { GetNotifierRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  const body = {
+    // string | Notifier id
+    id: id_example,
+  } satisfies GetNotifierRequest;
+
+  try {
+    const data = await api.getNotifier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Notifier id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredNotifier**](StoredNotifier.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Notifier |  -  |
+| **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)
+
+
+## listNotifiers
+
+> Array<StoredNotifier> listNotifiers()
+
+List notifiers.
+
+# Errors  Returns [`ApiError::Internal`] if the notifier store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { ListNotifiersRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  try {
+    const data = await api.listNotifiers();
+    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
+
+[**Array<StoredNotifier>**](StoredNotifier.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of notifiers |  -  |
+| **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)
+
+
+## testNotifier
+
+> TestNotifierResponse testNotifier(id)
+
+Send a test notification through a notifier. Admin only.
+
+For Slack and Discord, sends a test message via the configured webhook URL. For generic webhooks, sends a JSON test payload. For SMTP, sends a real email via [`lettre`] using the notifier\'s configured credentials.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the notifier does not exist, or [`ApiError::Internal`] when the notification fails with a truly internal error. Upstream failures (bad credentials, unreachable SMTP server, invalid addresses) are returned with HTTP 200 and `success: false` in the body, matching the convention established by the Slack/Discord/Webhook arms.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { TestNotifierRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  const body = {
+    // string | Notifier id
+    id: id_example,
+  } satisfies TestNotifierRequest;
+
+  try {
+    const data = await api.testNotifier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Notifier id | [Defaults to `undefined`] |
+
+### Return type
+
+[**TestNotifierResponse**](TestNotifierResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Test notification sent |  -  |
+| **403** | Admin role required |  -  |
+| **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)
+
+
+## updateNotifier
+
+> StoredNotifier updateNotifier(id, updateNotifierRequest)
+
+Update a notifier. Admin only.
+
+Supports partial updates: only fields present in the request body are changed.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the notifier does not exist, [`ApiError::BadRequest`] for validation errors, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotifiersApi,
+} from '@zlayer/client';
+import type { UpdateNotifierOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new NotifiersApi(config);
+
+  const body = {
+    // string | Notifier id
+    id: id_example,
+    // UpdateNotifierRequest
+    updateNotifierRequest: ...,
+  } satisfies UpdateNotifierOperationRequest;
+
+  try {
+    const data = await api.updateNotifier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Notifier id | [Defaults to `undefined`] |
+| **updateNotifierRequest** | [UpdateNotifierRequest](UpdateNotifierRequest.md) |  | |
+
+### Return type
+
+[**StoredNotifier**](StoredNotifier.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Notifier updated |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **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)
+

package/docs/OverlayApi.md

@@ -0,0 +1,251 @@
+# OverlayApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDnsStatus**](OverlayApi.md#getdnsstatus) | **GET** /api/v1/overlay/dns | Get DNS service status. |
+| [**getIpAllocation**](OverlayApi.md#getipallocation) | **GET** /api/v1/overlay/ip-alloc | Get IP allocation status. |
+| [**getOverlayPeers**](OverlayApi.md#getoverlaypeers) | **GET** /api/v1/overlay/peers | Get list of overlay peers. |
+| [**getOverlayStatus**](OverlayApi.md#getoverlaystatus) | **GET** /api/v1/overlay/status | Get overlay network status. |
+
+
+
+## getDnsStatus
+
+> DnsStatusResponse getDnsStatus()
+
+Get DNS service status.
+
+Returns DNS server configuration and registered service count. When DNS is not configured, returns a disabled status (not an error).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayApi,
+} from '@zlayer/client';
+import type { GetDnsStatusRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new OverlayApi();
+
+  try {
+    const data = await api.getDnsStatus();
+    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
+
+[**DnsStatusResponse**](DnsStatusResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | DNS service status |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getIpAllocation
+
+> IpAllocationResponse getIpAllocation()
+
+Get IP allocation status.
+
+Returns the overlay network\'s IP allocation statistics including CIDR, total IPs, allocated count, and utilization. Available on any node that has an active overlay (not just leaders).  # Errors  Returns an error if the overlay is not initialized.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayApi,
+} from '@zlayer/client';
+import type { GetIpAllocationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new OverlayApi();
+
+  try {
+    const data = await api.getIpAllocation();
+    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
+
+[**IpAllocationResponse**](IpAllocationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | IP allocation status |  -  |
+| **503** | Not a leader node or overlay not initialized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getOverlayPeers
+
+> PeerListResponse getOverlayPeers()
+
+Get list of overlay peers.
+
+Returns peer information from the overlay transport\'s UAPI state. When the overlay is not initialized, returns 503.  # Errors  Returns an error if the overlay network is not initialized.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayApi,
+} from '@zlayer/client';
+import type { GetOverlayPeersRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new OverlayApi();
+
+  try {
+    const data = await api.getOverlayPeers();
+    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
+
+[**PeerListResponse**](PeerListResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of overlay peers |  -  |
+| **503** | Overlay not initialized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getOverlayStatus
+
+> OverlayStatusResponse getOverlayStatus()
+
+Get overlay network status.
+
+Returns the current overlay network status including interface name, node IP, CIDR, peer counts, and whether the transport is active. Returns 503 if the overlay network is not initialized (e.g. host networking mode).  # Errors  Returns an error if the overlay network is not initialized.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayApi,
+} from '@zlayer/client';
+import type { GetOverlayStatusRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new OverlayApi();
+
+  try {
+    const data = await api.getOverlayStatus();
+    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
+
+[**OverlayStatusResponse**](OverlayStatusResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Overlay network status |  -  |
+| **503** | Overlay not initialized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+