@zlayer/api-client 0.10.86

package/docs/SyncsApi.md

@@ -0,0 +1,365 @@
+# SyncsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**applySync**](SyncsApi.md#applysync) | **POST** /api/v1/syncs/{id}/apply | Apply a sync — real reconcile against the API. |
+| [**createSync**](SyncsApi.md#createsyncoperation) | **POST** /api/v1/syncs | Create a new sync. |
+| [**deleteSync**](SyncsApi.md#deletesync) | **DELETE** /api/v1/syncs/{id} | Delete a sync. |
+| [**diffSync**](SyncsApi.md#diffsync) | **GET** /api/v1/syncs/{id}/diff | Compute a diff for a sync (scan git path vs. remote resources). |
+| [**listSyncs**](SyncsApi.md#listsyncs) | **GET** /api/v1/syncs | List all syncs. |
+
+
+
+## applySync
+
+> SyncApplyResponse applySync(id)
+
+Apply a sync — real reconcile against the API.
+
+For each resource in the manifest directory: - `deployment` YAMLs are parsed, validated, and upserted into the   deployment store. - `job` / `cron` kinds are recorded as skipped with an explanatory message   (standalone job/cron storage does not yet exist; schedule services via   `DeploymentSpec` instead). - Unknown kinds are skipped with `\"unknown kind: {kind}\"`.  If `sync.delete_missing` is `true`, deployments present in the store but absent from the manifest directory are deleted. Otherwise deletions are recorded as skipped with reason `\"delete_missing=false\"`.  On success the sync\'s `last_applied_sha` is refreshed from the current checkout and persisted.  # Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncsApi,
+} from '@zlayer/client';
+import type { ApplySyncRequest } 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 SyncsApi(config);
+
+  const body = {
+    // string | Sync id
+    id: id_example,
+  } satisfies ApplySyncRequest;
+
+  try {
+    const data = await api.applySync(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Sync id | [Defaults to `undefined`] |
+
+### Return type
+
+[**SyncApplyResponse**](SyncApplyResponse.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** | Apply result |  -  |
+| **404** | Sync 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)
+
+
+## createSync
+
+> StoredSync createSync(createSyncRequest)
+
+Create a new sync.
+
+# Errors  Returns [`ApiError::Validation`] if required fields are missing, or [`ApiError::Conflict`] if a sync with the same name already exists.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncsApi,
+} from '@zlayer/client';
+import type { CreateSyncOperationRequest } 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 SyncsApi(config);
+
+  const body = {
+    // CreateSyncRequest
+    createSyncRequest: ...,
+  } satisfies CreateSyncOperationRequest;
+
+  try {
+    const data = await api.createSync(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSyncRequest** | [CreateSyncRequest](CreateSyncRequest.md) |  | |
+
+### Return type
+
+[**StoredSync**](StoredSync.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** | Sync created |  -  |
+| **400** | Validation error |  -  |
+| **409** | Sync 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)
+
+
+## deleteSync
+
+> deleteSync(id)
+
+Delete a sync.
+
+# Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if the store operation fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncsApi,
+} from '@zlayer/client';
+import type { DeleteSyncRequest } 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 SyncsApi(config);
+
+  const body = {
+    // string | Sync id
+    id: id_example,
+  } satisfies DeleteSyncRequest;
+
+  try {
+    const data = await api.deleteSync(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Sync 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** | Sync deleted |  -  |
+| **404** | Sync 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)
+
+
+## diffSync
+
+> SyncDiffResponse diffSync(id)
+
+Compute a diff for a sync (scan git path vs. remote resources).
+
+# Errors  Returns [`ApiError::NotFound`] if the sync id does not exist, or [`ApiError::Internal`] if scanning fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncsApi,
+} from '@zlayer/client';
+import type { DiffSyncRequest } 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 SyncsApi(config);
+
+  const body = {
+    // string | Sync id
+    id: id_example,
+  } satisfies DiffSyncRequest;
+
+  try {
+    const data = await api.diffSync(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Sync id | [Defaults to `undefined`] |
+
+### Return type
+
+[**SyncDiffResponse**](SyncDiffResponse.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** | Computed diff |  -  |
+| **404** | Sync 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)
+
+
+## listSyncs
+
+> Array<StoredSync> listSyncs()
+
+List all syncs.
+
+# Errors  Returns [`ApiError::Internal`] if the sync store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncsApi,
+} from '@zlayer/client';
+import type { ListSyncsRequest } 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 SyncsApi(config);
+
+  try {
+    const data = await api.listSyncs();
+    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<StoredSync>**](StoredSync.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 syncs |  -  |
+
+[[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/TagImageRequest.md

@@ -0,0 +1,37 @@
+
+# TagImageRequest
+
+Request body for [`tag_image_handler`]. Matches Docker-compat `docker tag` semantics: create a new reference (`target`) pointing at an already-cached image (`source`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | string
+`target` | string
+
+## Example
+
+```typescript
+import type { TagImageRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+  "target": null,
+} satisfies TagImageRequest
+
+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 TagImageRequest
+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/TaskKind.md

@@ -0,0 +1,33 @@
+
+# TaskKind
+
+Script type for a task.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TaskKind } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TaskKind
+
+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 TaskKind
+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/TaskRun.md

@@ -0,0 +1,47 @@
+
+# TaskRun
+
+A recorded execution of a task.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`exitCode` | number
+`finishedAt` | string
+`id` | string
+`startedAt` | string
+`stderr` | string
+`stdout` | string
+`taskId` | string
+
+## Example
+
+```typescript
+import type { TaskRun } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "exitCode": null,
+  "finishedAt": 2026-04-15T12:00:01Z,
+  "id": null,
+  "startedAt": 2026-04-15T12:00:00Z,
+  "stderr": null,
+  "stdout": null,
+  "taskId": null,
+} satisfies TaskRun
+
+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 TaskRun
+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)
+
+