@zlayer/api-client 0.10.86

package/docs/DeploymentsApi.md

@@ -0,0 +1,295 @@
+# DeploymentsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createDeployment**](DeploymentsApi.md#createdeploymentoperation) | **POST** /api/v1/deployments | Create a new deployment. |
+| [**deleteDeployment**](DeploymentsApi.md#deletedeployment) | **DELETE** /api/v1/deployments/{name} | Delete a deployment. |
+| [**getDeployment**](DeploymentsApi.md#getdeployment) | **GET** /api/v1/deployments/{name} | Get deployment details (with live per-service health when available). |
+| [**listDeployments**](DeploymentsApi.md#listdeployments) | **GET** /api/v1/deployments | List all deployments. |
+
+
+
+## createDeployment
+
+> DeploymentDetails createDeployment(createDeploymentRequest)
+
+Create a new deployment.
+
+When the daemon has orchestration wired (service manager, proxy, overlay), this handler:  1. Parses and validates the spec YAML  2. Stores the deployment with status `Deploying`  3. Spawns an async task that registers services, sets up overlays,     configures the proxy, and scales services  4. Returns immediately with `Deploying` status  5. The async task updates the stored status to `Running` or `Failed`  Without orchestration wired, it stores the spec with `Pending` status.  # Errors  Returns an error if the spec is invalid or storage fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeploymentsApi,
+} from '@zlayer/client';
+import type { CreateDeploymentOperationRequest } 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 DeploymentsApi(config);
+
+  const body = {
+    // CreateDeploymentRequest
+    createDeploymentRequest: ...,
+  } satisfies CreateDeploymentOperationRequest;
+
+  try {
+    const data = await api.createDeployment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createDeploymentRequest** | [CreateDeploymentRequest](CreateDeploymentRequest.md) |  | |
+
+### Return type
+
+[**DeploymentDetails**](DeploymentDetails.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** | Deployment created |  -  |
+| **400** | Invalid specification |  -  |
+| **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)
+
+
+## deleteDeployment
+
+> deleteDeployment(name)
+
+Delete a deployment.
+
+# Errors  Returns an error if the deployment is not found, storage access fails, or teardown encounters critical failures.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeploymentsApi,
+} from '@zlayer/client';
+import type { DeleteDeploymentRequest } 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 DeploymentsApi(config);
+
+  const body = {
+    // string | Deployment name
+    name: name_example,
+  } satisfies DeleteDeploymentRequest;
+
+  try {
+    const data = await api.deleteDeployment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Deployment name | [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** | Deployment deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Deployment 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)
+
+
+## getDeployment
+
+> DeploymentDetails getDeployment(name)
+
+Get deployment details (with live per-service health when available).
+
+# Errors  Returns an error if the deployment is not found or storage access fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeploymentsApi,
+} from '@zlayer/client';
+import type { GetDeploymentRequest } 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 DeploymentsApi(config);
+
+  const body = {
+    // string | Deployment name
+    name: name_example,
+  } satisfies GetDeploymentRequest;
+
+  try {
+    const data = await api.getDeployment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Deployment name | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeploymentDetails**](DeploymentDetails.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** | Deployment details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Deployment 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)
+
+
+## listDeployments
+
+> Array<DeploymentSummary> listDeployments()
+
+List all deployments.
+
+# Errors  Returns an error if storage access fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeploymentsApi,
+} from '@zlayer/client';
+import type { ListDeploymentsRequest } 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 DeploymentsApi(config);
+
+  try {
+    const data = await api.listDeployments();
+    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<DeploymentSummary>**](DeploymentSummary.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 deployments |  -  |
+| **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/DnsStatusResponse.md

@@ -0,0 +1,45 @@
+
+# DnsStatusResponse
+
+DNS service status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bindAddr` | string
+`enabled` | boolean
+`port` | number
+`serviceCount` | number
+`services` | Array<string>
+`zone` | string
+
+## Example
+
+```typescript
+import type { DnsStatusResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bindAddr": null,
+  "enabled": null,
+  "port": null,
+  "serviceCount": null,
+  "services": null,
+  "zone": null,
+} satisfies DnsStatusResponse
+
+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 DnsStatusResponse
+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/EnvironmentsApi.md

@@ -0,0 +1,383 @@
+# EnvironmentsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createEnvironment**](EnvironmentsApi.md#createenvironmentoperation) | **POST** /api/v1/environments | Create a new environment. Admin only. |
+| [**deleteEnvironment**](EnvironmentsApi.md#deleteenvironment) | **DELETE** /api/v1/environments/{id} | Delete an environment. Admin only. |
+| [**getEnvironment**](EnvironmentsApi.md#getenvironment) | **GET** /api/v1/environments/{id} | Fetch a single environment by id. |
+| [**listEnvironments**](EnvironmentsApi.md#listenvironments) | **GET** /api/v1/environments | List environments. |
+| [**updateEnvironment**](EnvironmentsApi.md#updateenvironmentoperation) | **PATCH** /api/v1/environments/{id} | Rename / re-describe an environment. Admin only. |
+
+
+
+## createEnvironment
+
+> StoredEnvironment createEnvironment(createEnvironmentRequest)
+
+Create a new environment. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the `(name, project_id)` is already used, or [`ApiError::Internal`] when the environment store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@zlayer/client';
+import type { CreateEnvironmentOperationRequest } 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 EnvironmentsApi(config);
+
+  const body = {
+    // CreateEnvironmentRequest
+    createEnvironmentRequest: ...,
+  } satisfies CreateEnvironmentOperationRequest;
+
+  try {
+    const data = await api.createEnvironment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createEnvironmentRequest** | [CreateEnvironmentRequest](CreateEnvironmentRequest.md) |  | |
+
+### Return type
+
+[**StoredEnvironment**](StoredEnvironment.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** | Environment created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **409** | Name already used in the given project |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteEnvironment
+
+> deleteEnvironment(id)
+
+Delete an environment. Admin only.
+
+Non-cascading: the operator must purge any secrets attached to the environment before deletion (typically via `DELETE /api/v1/secrets?env={id}&all=true`). If the environment still has secrets, this endpoint returns 409.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::Conflict`] when secrets remain, or [`ApiError::Internal`] when a backing store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@zlayer/client';
+import type { DeleteEnvironmentRequest } 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 EnvironmentsApi(config);
+
+  const body = {
+    // string | Environment id
+    id: id_example,
+  } satisfies DeleteEnvironmentRequest;
+
+  try {
+    const data = await api.deleteEnvironment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Environment 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** | Environment deleted |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Not found |  -  |
+| **409** | Environment still has secrets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEnvironment
+
+> StoredEnvironment getEnvironment(id)
+
+Fetch a single environment by id.
+
+# Errors  Returns [`ApiError::NotFound`] if no environment with the given id exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@zlayer/client';
+import type { GetEnvironmentRequest } 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 EnvironmentsApi(config);
+
+  const body = {
+    // string | Environment id
+    id: id_example,
+  } satisfies GetEnvironmentRequest;
+
+  try {
+    const data = await api.getEnvironment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Environment id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredEnvironment**](StoredEnvironment.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** | Environment |  -  |
+| **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)
+
+
+## listEnvironments
+
+> Array<StoredEnvironment> listEnvironments(project)
+
+List environments.
+
+Filter rules (see [`ListEnvironmentsQuery`]):  - `?project={id}` → environments belonging to that project. - `?project=*` → every environment across every project + globals,   merged and sorted by name. - no `project` query → only global environments (`project_id IS NULL`).  # Errors  Returns [`ApiError::Internal`] if the environment store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@zlayer/client';
+import type { ListEnvironmentsRequest } 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 EnvironmentsApi(config);
+
+  const body = {
+    // string | Project id to filter by; \'*\' lists all; omit for globals only (optional)
+    project: project_example,
+  } satisfies ListEnvironmentsRequest;
+
+  try {
+    const data = await api.listEnvironments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **project** | `string` | Project id to filter by; \'*\' lists all; omit for globals only | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<StoredEnvironment>**](StoredEnvironment.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 environments |  -  |
+| **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)
+
+
+## updateEnvironment
+
+> StoredEnvironment updateEnvironment(id, updateEnvironmentRequest)
+
+Rename / re-describe an environment. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides with another environment in the same scope, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@zlayer/client';
+import type { UpdateEnvironmentOperationRequest } 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 EnvironmentsApi(config);
+
+  const body = {
+    // string | Environment id
+    id: id_example,
+    // UpdateEnvironmentRequest
+    updateEnvironmentRequest: ...,
+  } satisfies UpdateEnvironmentOperationRequest;
+
+  try {
+    const data = await api.updateEnvironment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Environment id | [Defaults to `undefined`] |
+| **updateEnvironmentRequest** | [UpdateEnvironmentRequest](UpdateEnvironmentRequest.md) |  | |
+
+### Return type
+
+[**StoredEnvironment**](StoredEnvironment.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** | Updated environment |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Not found |  -  |
+| **409** | Name collides with another environment |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+