@zlayer/api-client 0.10.86

package/docs/ServicesApi.md

@@ -0,0 +1,326 @@
+# ServicesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getService**](ServicesApi.md#getservice) | **GET** /api/v1/deployments/{deployment}/services/{service} | Get service details. |
+| [**getServiceLogs**](ServicesApi.md#getservicelogs) | **GET** /api/v1/deployments/{deployment}/services/{service}/logs | Get service logs. |
+| [**listServices**](ServicesApi.md#listservices) | **GET** /api/v1/deployments/{deployment}/services | List services in a deployment. |
+| [**scaleService**](ServicesApi.md#scaleservice) | **POST** /api/v1/deployments/{deployment}/services/{service}/scale | Scale a service. |
+
+
+
+## getService
+
+> ServiceDetails getService(deployment, service)
+
+Get service details.
+
+# Errors  Returns an error if the deployment or service is not found.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from '@zlayer/client';
+import type { GetServiceRequest } 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 ServicesApi(config);
+
+  const body = {
+    // string | Deployment name
+    deployment: deployment_example,
+    // string | Service name
+    service: service_example,
+  } satisfies GetServiceRequest;
+
+  try {
+    const data = await api.getService(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deployment** | `string` | Deployment name | [Defaults to `undefined`] |
+| **service** | `string` | Service name | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceDetails**](ServiceDetails.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** | Service details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Service 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)
+
+
+## getServiceLogs
+
+> string getServiceLogs(deployment, service, lines, follow, instance)
+
+Get service logs.
+
+Returns service logs as plain text when `follow=false`, or as a Server-Sent Events stream when `follow=true`.  In follow mode the server first emits the last N lines (controlled by the `lines` parameter) and then continuously polls for new output, emitting each new line as a `data:` SSE event.  # Errors  Returns an error if the deployment or service is not found, or the service manager is not available.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from '@zlayer/client';
+import type { GetServiceLogsRequest } 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 ServicesApi(config);
+
+  const body = {
+    // string | Deployment name
+    deployment: deployment_example,
+    // string | Service name
+    service: service_example,
+    // number | Number of lines to return (optional)
+    lines: 56,
+    // boolean | Follow logs (streaming) (optional)
+    follow: true,
+    // string | Filter by container/instance (optional)
+    instance: instance_example,
+  } satisfies GetServiceLogsRequest;
+
+  try {
+    const data = await api.getServiceLogs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deployment** | `string` | Deployment name | [Defaults to `undefined`] |
+| **service** | `string` | Service name | [Defaults to `undefined`] |
+| **lines** | `number` | Number of lines to return | [Optional] [Defaults to `undefined`] |
+| **follow** | `boolean` | Follow logs (streaming) | [Optional] [Defaults to `undefined`] |
+| **instance** | `string` | Filter by container/instance | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service logs (plain text or SSE stream) |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Service 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)
+
+
+## listServices
+
+> Array<ServiceSummary> listServices(deployment)
+
+List services in a deployment.
+
+# Errors  Returns an error if the deployment is not found or storage access fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from '@zlayer/client';
+import type { ListServicesRequest } 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 ServicesApi(config);
+
+  const body = {
+    // string | Deployment name
+    deployment: deployment_example,
+  } satisfies ListServicesRequest;
+
+  try {
+    const data = await api.listServices(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deployment** | `string` | Deployment name | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<ServiceSummary>**](ServiceSummary.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 services |  -  |
+| **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)
+
+
+## scaleService
+
+> ServiceDetails scaleService(deployment, service, scaleRequest)
+
+Scale a service.
+
+# Errors  Returns an error if the deployment or service is not found, scaling fails, or the user lacks permission.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from '@zlayer/client';
+import type { ScaleServiceRequest } 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 ServicesApi(config);
+
+  const body = {
+    // string | Deployment name
+    deployment: deployment_example,
+    // string | Service name
+    service: service_example,
+    // ScaleRequest
+    scaleRequest: ...,
+  } satisfies ScaleServiceRequest;
+
+  try {
+    const data = await api.scaleService(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deployment** | `string` | Deployment name | [Defaults to `undefined`] |
+| **service** | `string` | Service name | [Defaults to `undefined`] |
+| **scaleRequest** | [ScaleRequest](ScaleRequest.md) |  | |
+
+### Return type
+
+[**ServiceDetails**](ServiceDetails.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** | Service scaled |  -  |
+| **400** | Invalid scale request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Service 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)
+

package/docs/SetPasswordRequest.md

@@ -0,0 +1,37 @@
+
+# SetPasswordRequest
+
+Body for `POST /api/v1/users/{id}/password`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentPassword` | string
+`newPassword` | string
+
+## Example
+
+```typescript
+import type { SetPasswordRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentPassword": null,
+  "newPassword": null,
+} satisfies SetPasswordRequest
+
+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 SetPasswordRequest
+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/StepResult.md

@@ -0,0 +1,39 @@
+
+# StepResult
+
+Result of executing a single step in a workflow run.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`output` | string
+`status` | string
+`stepName` | string
+
+## Example
+
+```typescript
+import type { StepResult } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "output": null,
+  "status": null,
+  "stepName": null,
+} satisfies StepResult
+
+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 StepResult
+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/StopContainerRequest.md

@@ -0,0 +1,35 @@
+
+# StopContainerRequest
+
+Request body for stopping a container. Matches the Docker-compat `POST /containers/{id}/stop` shape.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timeout` | number
+
+## Example
+
+```typescript
+import type { StopContainerRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timeout": null,
+} satisfies StopContainerRequest
+
+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 StopContainerRequest
+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/StorageApi.md

@@ -0,0 +1,73 @@
+# StorageApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getStorageStatus**](StorageApi.md#getstoragestatus) | **GET** /api/v1/storage/status | Get storage replication status. |
+
+
+
+## getStorageStatus
+
+> StorageStatusResponse getStorageStatus()
+
+Get storage replication status.
+
+Returns the current state of SQLite-to-S3 replication including whether it is enabled, the last sync time, and pending change count.  # Errors  Returns an error if authentication fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StorageApi,
+} from '@zlayer/client';
+import type { GetStorageStatusRequest } 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 StorageApi(config);
+
+  try {
+    const data = await api.getStorageStatus();
+    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
+
+[**StorageStatusResponse**](StorageStatusResponse.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** | Storage replication status |  -  |
+| **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/StorageStatusResponse.md

@@ -0,0 +1,35 @@
+
+# StorageStatusResponse
+
+Storage status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`replication` | [ReplicationInfo](ReplicationInfo.md)
+
+## Example
+
+```typescript
+import type { StorageStatusResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "replication": null,
+} satisfies StorageStatusResponse
+
+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 StorageStatusResponse
+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/StoredEnvironment.md

@@ -0,0 +1,45 @@
+
+# StoredEnvironment
+
+A deployment/runtime environment (e.g. \"dev\", \"staging\", \"prod\").  Each environment is an isolated namespace for secrets and, later, deployments. Optionally belongs to a `Project` (added in Phase 5) — when `project_id` is `None`, the environment is global.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`description` | string
+`id` | string
+`name` | string
+`projectId` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredEnvironment } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": 2026-04-15T12:00:00Z,
+  "description": null,
+  "id": null,
+  "name": null,
+  "projectId": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredEnvironment
+
+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 StoredEnvironment
+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/StoredNotifier.md

@@ -0,0 +1,47 @@
+
+# StoredNotifier
+
+A stored notifier — a named notification channel that fires alerts to Slack, Discord, a generic webhook, or SMTP when triggered.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`config` | [NotifierConfig](NotifierConfig.md)
+`createdAt` | string
+`enabled` | boolean
+`id` | string
+`kind` | [NotifierKind](NotifierKind.md)
+`name` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredNotifier } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "config": null,
+  "createdAt": 2026-04-15T12:00:00Z,
+  "enabled": null,
+  "id": null,
+  "kind": null,
+  "name": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredNotifier
+
+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 StoredNotifier
+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/StoredPermission.md

@@ -0,0 +1,47 @@
+
+# StoredPermission
+
+A stored permission grant binding a subject (user or group) to a resource with a specific access level.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`level` | [PermissionLevel](PermissionLevel.md)
+`resourceId` | string
+`resourceKind` | string
+`subjectId` | string
+`subjectKind` | [SubjectKind](SubjectKind.md)
+
+## Example
+
+```typescript
+import type { StoredPermission } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": 2026-04-15T12:00:00Z,
+  "id": null,
+  "level": null,
+  "resourceId": null,
+  "resourceKind": null,
+  "subjectId": null,
+  "subjectKind": null,
+} satisfies StoredPermission
+
+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 StoredPermission
+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)
+
+