@zlayer/api-client 0.10.86

package/docs/BulkImportResponse.md

@@ -0,0 +1,39 @@
+
+# BulkImportResponse
+
+Result body for `POST /api/v1/secrets/bulk-import`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`created` | number
+`errors` | Array<string>
+`updated` | number
+
+## Example
+
+```typescript
+import type { BulkImportResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "created": null,
+  "errors": null,
+  "updated": null,
+} satisfies BulkImportResponse
+
+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 BulkImportResponse
+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/CertInfo.md

@@ -0,0 +1,43 @@
+
+# CertInfo
+
+Information about a loaded TLS certificate.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domain` | string
+`fingerprint` | string
+`needsRenewal` | boolean
+`notAfter` | string
+`notBefore` | string
+
+## Example
+
+```typescript
+import type { CertInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domain": null,
+  "fingerprint": null,
+  "needsRenewal": null,
+  "notAfter": null,
+  "notBefore": null,
+} satisfies CertInfo
+
+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 CertInfo
+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/ClusterApi.md

@@ -0,0 +1,288 @@
+# ClusterApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**clusterForceLeader**](ClusterApi.md#clusterforceleader) | **POST** /api/v1/cluster/force-leader | Force this node to become the cluster leader (disaster recovery). |
+| [**clusterHeartbeat**](ClusterApi.md#clusterheartbeat) | **POST** /api/v1/cluster/heartbeat | Handle node heartbeat. |
+| [**clusterJoin**](ClusterApi.md#clusterjoinoperation) | **POST** /api/v1/cluster/join | Handle a cluster join request. |
+| [**clusterListNodes**](ClusterApi.md#clusterlistnodes) | **GET** /api/v1/cluster/nodes | List all nodes visible in the Raft cluster state. |
+
+
+
+## clusterForceLeader
+
+> ForceLeaderResponse clusterForceLeader(forceLeaderRequest)
+
+Force this node to become the cluster leader (disaster recovery).
+
+`POST /api/v1/cluster/force-leader`  DESTRUCTIVE operation for when the original leader is permanently lost. Saves cluster state, shuts down Raft, writes a recovery marker. The daemon must be restarted to complete recovery.  # Errors  Returns an error if the confirmation string is wrong, the Raft coordinator is unavailable, this node is already the leader, or the recovery state cannot be saved.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClusterApi,
+} from '@zlayer/client';
+import type { ClusterForceLeaderRequest } 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 ClusterApi(config);
+
+  const body = {
+    // ForceLeaderRequest
+    forceLeaderRequest: ...,
+  } satisfies ClusterForceLeaderRequest;
+
+  try {
+    const data = await api.clusterForceLeader(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **forceLeaderRequest** | [ForceLeaderRequest](ForceLeaderRequest.md) |  | |
+
+### Return type
+
+[**ForceLeaderResponse**](ForceLeaderResponse.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** | Force-leader initiated |  -  |
+| **400** | Invalid confirmation or leader still reachable |  -  |
+| **500** | Failed to save recovery state |  -  |
+| **503** | Raft coordinator not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## clusterHeartbeat
+
+> clusterHeartbeat(heartbeatRequest)
+
+Handle node heartbeat.
+
+`POST /api/v1/cluster/heartbeat`  Accepts resource usage data from worker nodes and proposes an `UpdateNodeHeartbeat` to the Raft state machine.  # Panics  Panics if the system clock is before the Unix epoch.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClusterApi,
+} from '@zlayer/client';
+import type { ClusterHeartbeatRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new ClusterApi();
+
+  const body = {
+    // HeartbeatRequest
+    heartbeatRequest: ...,
+  } satisfies ClusterHeartbeatRequest;
+
+  try {
+    const data = await api.clusterHeartbeat(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **heartbeatRequest** | [HeartbeatRequest](HeartbeatRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Heartbeat accepted |  -  |
+| **500** | Failed to propose heartbeat |  -  |
+| **503** | Raft coordinator not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## clusterJoin
+
+> ClusterJoinResponse clusterJoin(clusterJoinRequest)
+
+Handle a cluster join request.
+
+`POST /api/v1/cluster/join`  Validates the join token, assigns a Raft node ID, calls `raft.add_member()`, and returns the assignment + peer list.  # Errors  Returns an error if the Raft coordinator is unavailable, the join token is invalid, IP allocation fails, or the Raft membership change fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClusterApi,
+} from '@zlayer/client';
+import type { ClusterJoinOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new ClusterApi();
+
+  const body = {
+    // ClusterJoinRequest
+    clusterJoinRequest: ...,
+  } satisfies ClusterJoinOperationRequest;
+
+  try {
+    const data = await api.clusterJoin(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clusterJoinRequest** | [ClusterJoinRequest](ClusterJoinRequest.md) |  | |
+
+### Return type
+
+[**ClusterJoinResponse**](ClusterJoinResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Node joined successfully |  -  |
+| **401** | Invalid join token |  -  |
+| **500** | Failed to add member to Raft |  -  |
+| **503** | Raft coordinator not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## clusterListNodes
+
+> Array<ClusterNodeSummary> clusterListNodes()
+
+List all nodes visible in the Raft cluster state.
+
+`GET /api/v1/cluster/nodes`  # Errors  Returns an error if the cluster state cannot be read.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClusterApi,
+} from '@zlayer/client';
+import type { ClusterListNodesRequest } 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 ClusterApi(config);
+
+  try {
+    const data = await api.clusterListNodes();
+    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<ClusterNodeSummary>**](ClusterNodeSummary.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 cluster nodes |  -  |
+
+[[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/ClusterJoinRequest.md

@@ -0,0 +1,57 @@
+
+# ClusterJoinRequest
+
+Request body for `POST /api/v1/cluster/join`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`advertiseAddr` | string
+`apiPort` | number
+`cpuTotal` | number
+`diskTotal` | number
+`gpus` | [Array<GpuInfoSummary>](GpuInfoSummary.md)
+`memoryTotal` | number
+`mode` | string
+`overlayPort` | number
+`raftPort` | number
+`services` | Array<string>
+`token` | string
+`wgPublicKey` | string
+
+## Example
+
+```typescript
+import type { ClusterJoinRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "advertiseAddr": null,
+  "apiPort": null,
+  "cpuTotal": null,
+  "diskTotal": null,
+  "gpus": null,
+  "memoryTotal": null,
+  "mode": null,
+  "overlayPort": null,
+  "raftPort": null,
+  "services": null,
+  "token": null,
+  "wgPublicKey": null,
+} satisfies ClusterJoinRequest
+
+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 ClusterJoinRequest
+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/ClusterJoinResponse.md

@@ -0,0 +1,43 @@
+
+# ClusterJoinResponse
+
+Response body for `POST /api/v1/cluster/join`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nodeId` | string
+`overlayIp` | string
+`peers` | [Array<ClusterPeer>](ClusterPeer.md)
+`raftNodeId` | number
+`role` | string
+
+## Example
+
+```typescript
+import type { ClusterJoinResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nodeId": null,
+  "overlayIp": null,
+  "peers": null,
+  "raftNodeId": null,
+  "role": null,
+} satisfies ClusterJoinResponse
+
+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 ClusterJoinResponse
+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/ClusterNodeSummary.md

@@ -0,0 +1,61 @@
+
+# ClusterNodeSummary
+
+Summary of a cluster node for listing.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`address` | string
+`advertiseAddr` | string
+`cpuTotal` | number
+`cpuUsed` | number
+`id` | string
+`isLeader` | boolean
+`lastHeartbeat` | number
+`memoryTotal` | number
+`memoryUsed` | number
+`mode` | string
+`overlayIp` | string
+`registeredAt` | number
+`role` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { ClusterNodeSummary } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "address": null,
+  "advertiseAddr": null,
+  "cpuTotal": null,
+  "cpuUsed": null,
+  "id": null,
+  "isLeader": null,
+  "lastHeartbeat": null,
+  "memoryTotal": null,
+  "memoryUsed": null,
+  "mode": null,
+  "overlayIp": null,
+  "registeredAt": null,
+  "role": null,
+  "status": null,
+} satisfies ClusterNodeSummary
+
+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 ClusterNodeSummary
+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/ClusterPeer.md

@@ -0,0 +1,47 @@
+
+# ClusterPeer
+
+Summary of an existing cluster peer returned in join response.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`advertiseAddr` | string
+`nodeId` | string
+`overlayIp` | string
+`overlayPort` | number
+`raftNodeId` | number
+`raftPort` | number
+`wgPublicKey` | string
+
+## Example
+
+```typescript
+import type { ClusterPeer } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "advertiseAddr": null,
+  "nodeId": null,
+  "overlayIp": null,
+  "overlayPort": null,
+  "raftNodeId": null,
+  "raftPort": null,
+  "wgPublicKey": null,
+} satisfies ClusterPeer
+
+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 ClusterPeer
+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/ContainerExecRequest.md

@@ -0,0 +1,35 @@
+
+# ContainerExecRequest
+
+Exec request for running a command in a container
+
+## Properties
+
+Name | Type
+------------ | -------------
+`command` | Array<string>
+
+## Example
+
+```typescript
+import type { ContainerExecRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "command": null,
+} satisfies ContainerExecRequest
+
+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 ContainerExecRequest
+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/ContainerExecResponse.md

@@ -0,0 +1,39 @@
+
+# ContainerExecResponse
+
+Exec response with command output
+
+## Properties
+
+Name | Type
+------------ | -------------
+`exitCode` | number
+`stderr` | string
+`stdout` | string
+
+## Example
+
+```typescript
+import type { ContainerExecResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "exitCode": null,
+  "stderr": null,
+  "stdout": null,
+} satisfies ContainerExecResponse
+
+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 ContainerExecResponse
+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/ContainerInfo.md

@@ -0,0 +1,47 @@
+
+# ContainerInfo
+
+Container information returned by the API
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`image` | string
+`labels` | { [key: string]: string; }
+`name` | string
+`pid` | number
+`state` | string
+
+## Example
+
+```typescript
+import type { ContainerInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "id": null,
+  "image": null,
+  "labels": null,
+  "name": null,
+  "pid": null,
+  "state": null,
+} satisfies ContainerInfo
+
+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 ContainerInfo
+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)
+
+