@zlayer/api-client 0.10.86 → 0.11.7

package/docs/UpdateLabelsRequest.md

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

package/docs/UpdateLabelsResponse.md

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

package/docs/UpdateNotifierRequest.md

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

package/docs/UpdateProjectRequest.md

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

package/docs/UpdateUserRequest.md

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

package/docs/UpdateVariableRequest.md

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

package/docs/UserRole.md

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

package/docs/UserView.md

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

package/docs/UsersApi.md

@@ -27,11 +27,11 @@ Create a new user. Admin only.
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { CreateUserOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { CreateUserOperationRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   const body = {
@@ -97,11 +97,11 @@ Delete a user. Admin only. Callers cannot delete their own account.
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { DeleteUserRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { DeleteUserRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   const body = {
@@ -166,11 +166,11 @@ Fetch a single user. Admins can read any record; regular users can read only the
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { GetUserRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { GetUserRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   const body = {
@@ -234,11 +234,11 @@ List all users. Admin only.
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { ListUsersRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ListUsersRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   try {
@@ -294,11 +294,11 @@ Set a user\'s password. Admins may change any user\'s password; regular
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { SetPasswordOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { SetPasswordOperationRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   const body = {
@@ -368,11 +368,11 @@ Update a user\'s mutable fields. Admin only.
 import {
   Configuration,
   UsersApi,
-} from '@zlayer/client';
-import type { UpdateUserOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { UpdateUserOperationRequest } from '@zlayer/api-client';
 
 async function example() {
-  console.log("🚀 Testing @zlayer/client SDK...");
+  console.log("🚀 Testing @zlayer/api-client SDK...");
   const api = new UsersApi();
 
   const body = {

package/docs/VariablesApi.md

@@ -26,11 +26,11 @@ Create a new variable. Admin only.
 import {
   Configuration,
   VariablesApi,
-} from '@zlayer/client';
-import type { CreateVariableOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { CreateVariableOperationRequest } 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",
@@ -100,11 +100,11 @@ Delete a variable. Admin only.
 import {
   Configuration,
   VariablesApi,
-} from '@zlayer/client';
-import type { DeleteVariableRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { DeleteVariableRequest } 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",
@@ -173,11 +173,11 @@ Fetch a single variable by id.
 import {
   Configuration,
   VariablesApi,
-} from '@zlayer/client';
-import type { GetVariableRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { GetVariableRequest } 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",
@@ -245,11 +245,11 @@ Filter rules (see [`ListVariablesQuery`]):  - `?scope={id}&#
 import {
   Configuration,
   VariablesApi,
-} from '@zlayer/client';
-import type { ListVariablesRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ListVariablesRequest } 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",
@@ -317,11 +317,11 @@ Update a variable\'s name and/or value. Admin only.
 import {
   Configuration,
   VariablesApi,
-} from '@zlayer/client';
-import type { UpdateVariableOperationRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { UpdateVariableOperationRequest } 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/VolumeInfo.md

@@ -0,0 +1,45 @@
+
+# VolumeInfo
+
+Full volume response shape used by the list, inspect, and create endpoints.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`inUseBy` | Array<string>
+`labels` | { [key: string]: string; }
+`name` | string
+`path` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { VolumeInfo } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "inUseBy": null,
+  "labels": null,
+  "name": null,
+  "path": null,
+  "sizeBytes": null,
+} satisfies VolumeInfo
+
+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 VolumeInfo
+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/VolumeMount.md

@@ -1,7 +1,7 @@
 
 # VolumeMount
 
-Volume mount specification
+Volume mount specification.  The `type` field (a Docker-compatible discriminator) selects how `source` is interpreted: - `\"bind\"` (default): `source` is an absolute host path. - `\"volume\"`: `source` is a named-volume identifier. - `\"tmpfs\"`: no `source`; a memory-backed mount is provisioned.
 
 ## Properties
 
@@ -10,17 +10,19 @@ Name | Type
 `readonly` | boolean
 `source` | string
 `target` | string
+`type` | [VolumeMountType](VolumeMountType.md)
 
 ## Example
 
 ```typescript
-import type { VolumeMount } from '@zlayer/client'
+import type { VolumeMount } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {
   "readonly": null,
   "source": null,
   "target": null,
+  "type": null,
 } satisfies VolumeMount
 
 console.log(example)

package/docs/VolumeMountType.md

@@ -0,0 +1,33 @@
+
+# VolumeMountType
+
+Volume mount kind discriminator.  Selects which [`zlayer_spec::StorageSpec`] variant [`VolumeMount`] is translated into by [`build_service_spec`]. When omitted on the wire, defaults to [`VolumeMountType::Bind`] (legacy behavior).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { VolumeMountType } from '@zlayer/api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies VolumeMountType
+
+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 VolumeMountType
+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/VolumeSummary.md

@@ -1,7 +1,7 @@
 
 # VolumeSummary
 
-Summary of a single volume returned by the list endpoint.
+Legacy response shape kept for backwards compatibility with older SDK consumers that deserialize strictly. New consumers should use [`VolumeInfo`]. `list_volumes` now returns [`VolumeInfo`] which is a strict superset of the fields in `VolumeSummary`.
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { VolumeSummary } from '@zlayer/client'
+import type { VolumeSummary } from '@zlayer/api-client'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/VolumesApi.md

@@ -4,18 +4,95 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**createVolume**](VolumesApi.md#createvolumeoperation) | **POST** /api/v1/volumes | Create a new named volume. |
 | [**deleteVolume**](VolumesApi.md#deletevolume) | **DELETE** /api/v1/volumes/{name} | Delete a volume by name. |
+| [**getVolume**](VolumesApi.md#getvolume) | **GET** /api/v1/volumes/{name} | Inspect a single volume by name. |
 | [**listVolumes**](VolumesApi.md#listvolumes) | **GET** /api/v1/volumes | List all volumes on disk. |
 
 
 
+## createVolume
+
+> VolumeInfo createVolume(createVolumeRequest)
+
+Create a new named volume.
+
+Creates `state.volume_dir/{name}` on disk and writes a `.metadata.json` sidecar capturing labels, size, tier, and the creation timestamp.  # Errors  - 400 Bad Request — invalid name, size, or tier. - 403 Forbidden — caller lacks the `operator` role. - 409 Conflict — a volume with this name already exists. - 500 Internal — filesystem errors.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VolumesApi,
+} from '@zlayer/api-client';
+import type { CreateVolumeOperationRequest } 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 VolumesApi(config);
+
+  const body = {
+    // CreateVolumeRequest
+    createVolumeRequest: ...,
+  } satisfies CreateVolumeOperationRequest;
+
+  try {
+    const data = await api.createVolume(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createVolumeRequest** | [CreateVolumeRequest](CreateVolumeRequest.md) |  | |
+
+### Return type
+
+[**VolumeInfo**](VolumeInfo.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** | Volume created |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **409** | Volume 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)
+
+
 ## deleteVolume
 
 > deleteVolume(name, force)
 
 Delete a volume by name.
 
-Removes a volume directory from disk. By default, only empty volumes can be deleted. Use `?force=true` to remove non-empty volumes.  # Errors  Returns an error if the volume is not found or cannot be removed.
+By default, refuses to remove a volume that is non-empty OR that any container currently reports mounting. `?force=true` overrides both checks.  # Errors  - 404 Not Found — no such volume. - 409 Conflict — non-empty or in-use without `?force=true`. - 403 Forbidden — caller lacks the `operator` role.
 
 ### Example
 
@@ -23,11 +100,11 @@ Removes a volume directory from disk. By default, only empty volumes can be dele
 import {
   Configuration,
   VolumesApi,
-} from '@zlayer/client';
-import type { DeleteVolumeRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { DeleteVolumeRequest } 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",
@@ -37,7 +114,7 @@ async function example() {
   const body = {
     // string | Volume name
     name: name_example,
-    // boolean | Force removal of non-empty volumes
+    // boolean | Force removal of non-empty or in-use volumes
     force: true,
   } satisfies DeleteVolumeRequest;
 
@@ -59,7 +136,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **name** | `string` | Volume name | [Defaults to `undefined`] |
-| **force** | `boolean` | Force removal of non-empty volumes | [Defaults to `undefined`] |
+| **force** | `boolean` | Force removal of non-empty or in-use volumes | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -82,18 +159,91 @@ example().catch(console.error);
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **404** | Volume not found |  -  |
-| **409** | Volume is non-empty (use ?force=true) |  -  |
+| **409** | Volume is non-empty or in use (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)
+
+
+## getVolume
+
+> VolumeInfo getVolume(name)
+
+Inspect a single volume by name.
+
+Reads the sidecar when present, synthesizes defaults for legacy volumes, and populates `in_use_by` when a [`VolumeUsageSource`] is wired.  # Errors  - 404 Not Found — no such volume. - 500 Internal — filesystem or parse errors.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VolumesApi,
+} from '@zlayer/api-client';
+import type { GetVolumeRequest } 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 VolumesApi(config);
+
+  const body = {
+    // string | Volume name
+    name: name_example,
+  } satisfies GetVolumeRequest;
+
+  try {
+    const data = await api.getVolume(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Volume name | [Defaults to `undefined`] |
+
+### Return type
+
+[**VolumeInfo**](VolumeInfo.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** | Volume metadata |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Volume 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)
 
 
 ## listVolumes
 
-> Array<VolumeSummary> listVolumes()
+> Array<VolumeInfo> listVolumes()
 
 List all volumes on disk.
 
-Enumerates subdirectories under the volume base directory and returns metadata for each one.  # Errors  Returns an error if the volume directory cannot be read.
+Enumerates subdirectories under the volume base directory, reads each sidecar when present, and returns a [`VolumeInfo`] for each entry (including `in_use_by` when a [`VolumeUsageSource`] is wired).  # Errors  Returns an error if the volume directory cannot be read.
 
 ### Example
 
@@ -101,11 +251,11 @@ Enumerates subdirectories under the volume base directory and returns metadata f
 import {
   Configuration,
   VolumesApi,
-} from '@zlayer/client';
-import type { ListVolumesRequest } from '@zlayer/client';
+} from '@zlayer/api-client';
+import type { ListVolumesRequest } 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",
@@ -130,7 +280,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**Array<VolumeSummary>**](VolumeSummary.md)
+[**Array<VolumeInfo>**](VolumeInfo.md)
 
 ### Authorization
 

package/docs/WebhookInfoResponse.md

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

package/docs/WebhookResponse.md

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