@zlayer/api-client 0.10.86 → 0.10.88

package/docs/ContainerInfo.md

@@ -8,26 +8,36 @@ Container information returned by the API
 Name | Type
 ------------ | -------------
 `createdAt` | string
+`exitCode` | number
+`health` | [ContainerHealthInfo](ContainerHealthInfo.md)
 `id` | string
 `image` | string
+`ipv4` | string
 `labels` | { [key: string]: string; }
 `name` | string
+`networks` | [Array<NetworkAttachmentInfo>](NetworkAttachmentInfo.md)
 `pid` | number
+`ports` | [Array<PortMapping>](PortMapping.md)
 `state` | string
 
 ## Example
 
 ```typescript
-import type { ContainerInfo } from '@zlayer/client'
+import type { ContainerInfo } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {
   "createdAt": null,
+  "exitCode": null,
+  "health": null,
   "id": null,
   "image": null,
+  "ipv4": null,
   "labels": null,
   "name": null,
+  "networks": null,
   "pid": null,
+  "ports": null,
   "state": null,
 } satisfies ContainerInfo
 

package/docs/ContainerNetworksApi.md

@@ -0,0 +1,466 @@
+# ContainerNetworksApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**connectContainerNetwork**](ContainerNetworksApi.md#connectcontainernetwork) | **POST** /api/v1/container-networks/{id_or_name}/connect | Attach a container to a network. |
+| [**createContainerNetwork**](ContainerNetworksApi.md#createcontainernetwork) | **POST** /api/v1/container-networks | Create a new bridge or overlay network. |
+| [**deleteContainerNetwork**](ContainerNetworksApi.md#deletecontainernetwork) | **DELETE** /api/v1/container-networks/{id_or_name} | Delete a bridge network. Refuses if the network still has attachments unless `?force=true` is set. |
+| [**disconnectContainerNetwork**](ContainerNetworksApi.md#disconnectcontainernetwork) | **POST** /api/v1/container-networks/{id_or_name}/disconnect | Detach a container from a network. |
+| [**getContainerNetwork**](ContainerNetworksApi.md#getcontainernetwork) | **GET** /api/v1/container-networks/{id_or_name} | Inspect a single bridge network by id or by name. |
+| [**listContainerNetworks**](ContainerNetworksApi.md#listcontainernetworks) | **GET** /api/v1/container-networks | List all bridge networks, optionally filtered by label. |
+
+
+
+## connectContainerNetwork
+
+> connectContainerNetwork(idOrName, connectBridgeNetworkRequest)
+
+Attach a container to a network.
+
+# Errors  - [`ApiError::BadRequest`] for an empty `container_id` or invalid   `ipv4_address`. - [`ApiError::NotFound`] when no network matches `id_or_name`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { ConnectContainerNetworkRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // string | Network id or name
+    idOrName: idOrName_example,
+    // ConnectBridgeNetworkRequest
+    connectBridgeNetworkRequest: ...,
+  } satisfies ConnectContainerNetworkRequest;
+
+  try {
+    const data = await api.connectContainerNetwork(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **idOrName** | `string` | Network id or name | [Defaults to `undefined`] |
+| **connectBridgeNetworkRequest** | [ConnectBridgeNetworkRequest](ConnectBridgeNetworkRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Container connected |  -  |
+| **400** | Invalid request (e.g. bad ipv4_address) |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Network 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)
+
+
+## createContainerNetwork
+
+> BridgeNetwork createContainerNetwork(createBridgeNetworkRequest)
+
+Create a new bridge or overlay network.
+
+# Errors  - [`ApiError::BadRequest`] if the network name or subnet is malformed. - [`ApiError::Conflict`] if a network with the same name already exists. - [`ApiError::Forbidden`] / [`ApiError::Unauthorized`] from the auth layer.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { CreateContainerNetworkRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // CreateBridgeNetworkRequest
+    createBridgeNetworkRequest: ...,
+  } satisfies CreateContainerNetworkRequest;
+
+  try {
+    const data = await api.createContainerNetwork(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createBridgeNetworkRequest** | [CreateBridgeNetworkRequest](CreateBridgeNetworkRequest.md) |  | |
+
+### Return type
+
+[**BridgeNetwork**](BridgeNetwork.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** | Network created |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **409** | Network with that name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteContainerNetwork
+
+> deleteContainerNetwork(idOrName, force)
+
+Delete a bridge network. Refuses if the network still has attachments unless `?force=true` is set.
+
+# Errors  - [`ApiError::NotFound`] when no network matches `id_or_name`. - [`ApiError::Conflict`] when the network still has attachments and   `force` is false. - Auth errors propagated from the `operator` role check.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { DeleteContainerNetworkRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // string | Network id or name
+    idOrName: idOrName_example,
+    // boolean | If true, delete even if the network still has attachments. (optional)
+    force: true,
+  } satisfies DeleteContainerNetworkRequest;
+
+  try {
+    const data = await api.deleteContainerNetwork(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **idOrName** | `string` | Network id or name | [Defaults to `undefined`] |
+| **force** | `boolean` | If true, delete even if the network still has attachments. | [Optional] [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** | Network deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Network not found |  -  |
+| **409** | Network still has attachments (use ?force=true) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## disconnectContainerNetwork
+
+> disconnectContainerNetwork(idOrName, disconnectBridgeNetworkRequest)
+
+Detach a container from a network.
+
+# Errors  - [`ApiError::BadRequest`] when `container_id` is empty. - [`ApiError::NotFound`] when the network or the container-on-network   pair is not known (unless `force` was passed).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { DisconnectContainerNetworkRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // string | Network id or name
+    idOrName: idOrName_example,
+    // DisconnectBridgeNetworkRequest
+    disconnectBridgeNetworkRequest: ...,
+  } satisfies DisconnectContainerNetworkRequest;
+
+  try {
+    const data = await api.disconnectContainerNetwork(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **idOrName** | `string` | Network id or name | [Defaults to `undefined`] |
+| **disconnectBridgeNetworkRequest** | [DisconnectBridgeNetworkRequest](DisconnectBridgeNetworkRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Container disconnected |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Network or container 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)
+
+
+## getContainerNetwork
+
+> BridgeNetworkDetails getContainerNetwork(idOrName)
+
+Inspect a single bridge network by id or by name.
+
+# Errors  [`ApiError::NotFound`] when no network matches `id_or_name`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { GetContainerNetworkRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // string | Network id or name
+    idOrName: idOrName_example,
+  } satisfies GetContainerNetworkRequest;
+
+  try {
+    const data = await api.getContainerNetwork(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **idOrName** | `string` | Network id or name | [Defaults to `undefined`] |
+
+### Return type
+
+[**BridgeNetworkDetails**](BridgeNetworkDetails.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** | Network details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Network 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)
+
+
+## listContainerNetworks
+
+> Array<BridgeNetwork> listContainerNetworks(label)
+
+List all bridge networks, optionally filtered by label.
+
+# Errors  [`ApiError::BadRequest`] when the `label` query param is not in `key=value` form.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContainerNetworksApi,
+} from '@zlayer/api-client';
+import type { ListContainerNetworksRequest } from '@zlayer/api-client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/api-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ContainerNetworksApi(config);
+
+  const body = {
+    // string | Optional label filter in `key=value` form. Only networks whose labels contain a matching pair are returned. (optional)
+    label: label_example,
+  } satisfies ListContainerNetworksRequest;
+
+  try {
+    const data = await api.listContainerNetworks(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **label** | `string` | Optional label filter in `key=value` form. Only networks whose labels contain a matching pair are returned. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<BridgeNetwork>**](BridgeNetwork.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 bridge networks |  -  |
+| **400** | Invalid label filter |  -  |
+| **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)
+

package/docs/ContainerResourceLimits.md

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

package/docs/ContainerRestartKind.md

@@ -0,0 +1,33 @@
+
+# ContainerRestartKind
+
+Which flavor of container restart policy to apply.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ContainerRestartKind } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ContainerRestartKind
+
+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 ContainerRestartKind
+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/ContainerRestartPolicy.md

@@ -0,0 +1,39 @@
+
+# ContainerRestartPolicy
+
+Container-runtime-level restart policy.  Maps onto Docker\'s `HostConfig.RestartPolicy`. Distinct from [`PanicPolicy`], which governs what `ZLayer` does in response to an application panic (it does not set a Docker restart policy).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`delay` | string
+`kind` | [ContainerRestartKind](ContainerRestartKind.md)
+`maxAttempts` | number
+
+## Example
+
+```typescript
+import type { ContainerRestartPolicy } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "delay": null,
+  "kind": null,
+  "maxAttempts": null,
+} satisfies ContainerRestartPolicy
+
+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 ContainerRestartPolicy
+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/ContainerStatsResponse.md

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

package/docs/ContainerWaitResponse.md

@@ -1,24 +1,30 @@
 
 # ContainerWaitResponse
 
-Wait response with container exit code
+Wait response with container exit code plus optional classification fields (added in §3.12 of the SDK-fixes spec).  The three optional fields (`reason`, `signal`, `finished_at`) are additive — clients that only read `exit_code` keep working unchanged.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `exitCode` | number
+`finishedAt` | string
 `id` | string
+`reason` | string
+`signal` | string
 
 ## Example
 
 ```typescript
-import type { ContainerWaitResponse } from '@zlayer/client'
+import type { ContainerWaitResponse } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {
   "exitCode": null,
+  "finishedAt": null,
   "id": null,
+  "reason": null,
+  "signal": null,
 } satisfies ContainerWaitResponse
 
 console.log(example)