@zlayer/api-client 0.10.86 → 0.11.7

package/docs/BackendInfo.md

@@ -15,7 +15,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BackendInfo } from '@zlayer/client'
+import type { BackendInfo } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BackendsResponse.md

@@ -13,7 +13,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BackendsResponse } from '@zlayer/client'
+import type { BackendsResponse } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BootstrapRequest.md

@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BootstrapRequest } from '@zlayer/client'
+import type { BootstrapRequest } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BridgeNetwork.md

@@ -0,0 +1,47 @@
+
+# BridgeNetwork
+
+A user-defined bridge or overlay network that containers can attach to.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | Date
+`driver` | [BridgeNetworkDriver](BridgeNetworkDriver.md)
+`id` | string
+`internal` | boolean
+`labels` | { [key: string]: string; }
+`name` | string
+`subnet` | string
+
+## Example
+
+```typescript
+import type { BridgeNetwork } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "driver": null,
+  "id": null,
+  "internal": null,
+  "labels": null,
+  "name": null,
+  "subnet": null,
+} satisfies BridgeNetwork
+
+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 BridgeNetwork
+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/BridgeNetworkAttachment.md

@@ -0,0 +1,41 @@
+
+# BridgeNetworkAttachment
+
+A container attached to a [`BridgeNetwork`].
+
+## Properties
+
+Name | Type
+------------ | -------------
+`aliases` | Array<string>
+`containerId` | string
+`containerName` | string
+`ipv4` | string
+
+## Example
+
+```typescript
+import type { BridgeNetworkAttachment } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "aliases": null,
+  "containerId": null,
+  "containerName": null,
+  "ipv4": null,
+} satisfies BridgeNetworkAttachment
+
+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 BridgeNetworkAttachment
+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/BridgeNetworkDetails.md

@@ -0,0 +1,49 @@
+
+# BridgeNetworkDetails
+
+Response body for `GET /api/v1/container-networks/{id_or_name}`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | Date
+`driver` | [BridgeNetworkDriver](BridgeNetworkDriver.md)
+`id` | string
+`internal` | boolean
+`labels` | { [key: string]: string; }
+`name` | string
+`subnet` | string
+`attachedContainers` | [Array<BridgeNetworkAttachment>](BridgeNetworkAttachment.md)
+
+## Example
+
+```typescript
+import type { BridgeNetworkDetails } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "driver": null,
+  "id": null,
+  "internal": null,
+  "labels": null,
+  "name": null,
+  "subnet": null,
+  "attachedContainers": null,
+} satisfies BridgeNetworkDetails
+
+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 BridgeNetworkDetails
+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/BridgeNetworkDriver.md

@@ -0,0 +1,33 @@
+
+# BridgeNetworkDriver
+
+Backing driver for a [`BridgeNetwork`].
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BridgeNetworkDriver } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BridgeNetworkDriver
+
+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 BridgeNetworkDriver
+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/BuildApi.md

@@ -28,11 +28,11 @@ GET /api/v1/build/{id}/logs Get build logs.
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { GetBuildLogsRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { GetBuildLogsRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -101,11 +101,11 @@ GET /api/v1/build/{id} Get build status.
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { GetBuildStatusRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { GetBuildStatusRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -174,11 +174,11 @@ GET /api/v1/builds List all builds.
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { ListBuildsRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ListBuildsRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -236,11 +236,11 @@ GET /api/v1/templates List available runtime templates
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { ListRuntimeTemplatesRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ListRuntimeTemplatesRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new BuildApi();
 
   try {
@@ -295,11 +295,11 @@ Accepts a multipart form with: - `dockerfile`: The Dockerfile content
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { StartBuildRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { StartBuildRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -361,11 +361,11 @@ POST /api/v1/build/json Start a new build from JSON request with a context path
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { StartBuildJsonRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { StartBuildJsonRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -435,11 +435,11 @@ GET /api/v1/build/{id}/stream Stream build progress via Server-Sent Events.
 import {
   Configuration,
   BuildApi,
-} from '@zlayer/client';
-import type { StreamBuildRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { StreamBuildRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",

package/docs/BuildKind.md

@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BuildKind } from '@zlayer/client'
+import type { BuildKind } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BuildRequest.md

@@ -17,7 +17,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BuildRequest } from '@zlayer/client'
+import type { BuildRequest } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BuildRequestWithContext.md

@@ -18,7 +18,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BuildRequestWithContext } from '@zlayer/client'
+import type { BuildRequestWithContext } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BuildStateEnum.md

@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BuildStateEnum } from '@zlayer/client'
+import type { BuildStateEnum } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BuildStatus.md

@@ -17,7 +17,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BuildStatus } from '@zlayer/client'
+import type { BuildStatus } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/BulkImportResponse.md

@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BulkImportResponse } from '@zlayer/client'
+import type { BulkImportResponse } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/CertInfo.md

@@ -16,7 +16,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { CertInfo } from '@zlayer/client'
+import type { CertInfo } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ClusterApi.md

@@ -25,11 +25,11 @@ Force this node to become the cluster leader (disaster recovery).
 import {
   Configuration,
   ClusterApi,
-} from '@zlayer/client';
-import type { ClusterForceLeaderRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ClusterForceLeaderRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",
@@ -99,11 +99,11 @@ Handle node heartbeat.
 import {
   Configuration,
   ClusterApi,
-} from '@zlayer/client';
-import type { ClusterHeartbeatRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ClusterHeartbeatRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new ClusterApi();
 
   const body = {
@@ -168,11 +168,11 @@ Handle a cluster join request.
 import {
   Configuration,
   ClusterApi,
-} from '@zlayer/client';
-import type { ClusterJoinOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ClusterJoinOperationRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new ClusterApi();
 
   const body = {
@@ -238,11 +238,11 @@ List all nodes visible in the Raft cluster state.
 import {
   Configuration,
   ClusterApi,
-} from '@zlayer/client';
-import type { ClusterListNodesRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ClusterListNodesRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const config = new Configuration({ 
     // Configure HTTP bearer authorization: bearer_auth
     accessToken: "YOUR BEARER TOKEN",

package/docs/ClusterJoinRequest.md

@@ -23,7 +23,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ClusterJoinRequest } from '@zlayer/client'
+import type { ClusterJoinRequest } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ClusterJoinResponse.md

@@ -16,7 +16,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ClusterJoinResponse } from '@zlayer/client'
+import type { ClusterJoinResponse } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ClusterNodeSummary.md

@@ -25,7 +25,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ClusterNodeSummary } from '@zlayer/client'
+import type { ClusterNodeSummary } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ClusterPeer.md

@@ -18,7 +18,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ClusterPeer } from '@zlayer/client'
+import type { ClusterPeer } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ConnectBridgeNetworkRequest.md

@@ -0,0 +1,39 @@
+
+# ConnectBridgeNetworkRequest
+
+Body for `POST /api/v1/container-networks/{id_or_name}/connect`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`aliases` | Array<string>
+`containerId` | string
+`ipv4Address` | string
+
+## Example
+
+```typescript
+import type { ConnectBridgeNetworkRequest } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "aliases": null,
+  "containerId": null,
+  "ipv4Address": null,
+} satisfies ConnectBridgeNetworkRequest
+
+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 ConnectBridgeNetworkRequest
+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/ContainerEvent.md

@@ -0,0 +1,47 @@
+
+# ContainerEvent
+
+A container lifecycle event published on the bus.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`at` | Date
+`exitCode` | number
+`id` | string
+`kind` | [ContainerEventKind](ContainerEventKind.md)
+`labels` | { [key: string]: string; }
+`reason` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { ContainerEvent } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "at": null,
+  "exitCode": null,
+  "id": null,
+  "kind": null,
+  "labels": null,
+  "reason": null,
+  "status": null,
+} satisfies ContainerEvent
+
+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 ContainerEvent
+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/ContainerEventKind.md

@@ -0,0 +1,33 @@
+
+# ContainerEventKind
+
+Kind of container lifecycle event.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ContainerEventKind } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ContainerEventKind
+
+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 ContainerEventKind
+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

@@ -12,7 +12,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ContainerExecRequest } from '@zlayer/client'
+import type { ContainerExecRequest } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ContainerExecResponse.md

@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ContainerExecResponse } from '@zlayer/client'
+import type { ContainerExecResponse } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ContainerHealthInfo.md

@@ -0,0 +1,39 @@
+
+# ContainerHealthInfo
+
+Runtime-native health snapshot on [`ContainerInfo::health`].  Sourced from bollard\'s `ContainerState.health` for Docker-backed containers. The internal `HealthMonitor` in `crates/zlayer-agent/src/health.rs` drives service-level health events against user-configured health specs; for standalone containers the API reports the runtime-native status instead so images with a baked-in `HEALTHCHECK` still surface correctly.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`failingStreak` | number
+`lastOutput` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { ContainerHealthInfo } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "failingStreak": null,
+  "lastOutput": null,
+  "status": null,
+} satisfies ContainerHealthInfo
+
+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 ContainerHealthInfo
+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)
+
+