@zlayer/api-client 0.10.86

package/docs/TasksApi.md

@@ -0,0 +1,450 @@
+# TasksApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTask**](TasksApi.md#createtaskoperation) | **POST** /api/v1/tasks | Create a new task. Admin only. |
+| [**deleteTask**](TasksApi.md#deletetask) | **DELETE** /api/v1/tasks/{id} | Delete a task. Admin only. |
+| [**getTask**](TasksApi.md#gettask) | **GET** /api/v1/tasks/{id} | Fetch a single task by id. |
+| [**listTaskRuns**](TasksApi.md#listtaskruns) | **GET** /api/v1/tasks/{id}/runs | List past runs for a task, most recent first. |
+| [**listTasks**](TasksApi.md#listtasks) | **GET** /api/v1/tasks | List tasks. |
+| [**runTask**](TasksApi.md#runtask) | **POST** /api/v1/tasks/{id}/run | Execute a task synchronously. Admin only. |
+
+
+
+## createTask
+
+> StoredTask createTask(createTaskRequest)
+
+Create a new task. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name or body, or [`ApiError::Internal`] when the task store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { CreateTaskOperationRequest } 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 TasksApi(config);
+
+  const body = {
+    // CreateTaskRequest
+    createTaskRequest: ...,
+  } satisfies CreateTaskOperationRequest;
+
+  try {
+    const data = await api.createTask(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createTaskRequest** | [CreateTaskRequest](CreateTaskRequest.md) |  | |
+
+### Return type
+
+[**StoredTask**](StoredTask.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** | Task created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteTask
+
+> deleteTask(id)
+
+Delete a task. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the task does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { DeleteTaskRequest } 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 TasksApi(config);
+
+  const body = {
+    // string | Task id
+    id: id_example,
+  } satisfies DeleteTaskRequest;
+
+  try {
+    const data = await api.deleteTask(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Task 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** | Task deleted |  -  |
+| **403** | Admin role required |  -  |
+| **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)
+
+
+## getTask
+
+> StoredTask getTask(id)
+
+Fetch a single task by id.
+
+# Errors  Returns [`ApiError::NotFound`] if no task with the given id exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { GetTaskRequest } 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 TasksApi(config);
+
+  const body = {
+    // string | Task id
+    id: id_example,
+  } satisfies GetTaskRequest;
+
+  try {
+    const data = await api.getTask(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Task id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredTask**](StoredTask.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** | Task |  -  |
+| **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)
+
+
+## listTaskRuns
+
+> Array<TaskRun> listTaskRuns(id)
+
+List past runs for a task, most recent first.
+
+# Errors  Returns [`ApiError::NotFound`] if the task does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { ListTaskRunsRequest } 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 TasksApi(config);
+
+  const body = {
+    // string | Task id
+    id: id_example,
+  } satisfies ListTaskRunsRequest;
+
+  try {
+    const data = await api.listTaskRuns(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Task id | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<TaskRun>**](TaskRun.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 task runs |  -  |
+| **404** | Task 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)
+
+
+## listTasks
+
+> Array<StoredTask> listTasks(projectId)
+
+List tasks.
+
+# Errors  Returns [`ApiError::Internal`] if the task store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { ListTasksRequest } 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 TasksApi(config);
+
+  const body = {
+    // string | Filter by project id; omit to list all tasks (optional)
+    projectId: projectId_example,
+  } satisfies ListTasksRequest;
+
+  try {
+    const data = await api.listTasks(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Filter by project id; omit to list all tasks | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<StoredTask>**](StoredTask.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 tasks |  -  |
+| **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)
+
+
+## runTask
+
+> TaskRun runTask(id)
+
+Execute a task synchronously. Admin only.
+
+Runs the task\'s body via `sh -c` on Unix, captures stdout/stderr, and returns the completed `TaskRun`.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the task does not exist, [`ApiError::NotImplemented`] on non-Unix platforms, or [`ApiError::Internal`] when the store or execution fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TasksApi,
+} from '@zlayer/client';
+import type { RunTaskRequest } 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 TasksApi(config);
+
+  const body = {
+    // string | Task id
+    id: id_example,
+  } satisfies RunTaskRequest;
+
+  try {
+    const data = await api.runTask(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Task id | [Defaults to `undefined`] |
+
+### Return type
+
+[**TaskRun**](TaskRun.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** | Task run result |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Task not found |  -  |
+| **501** | Not implemented on this platform |  -  |
+
+[[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/TemplateInfo.md

@@ -0,0 +1,39 @@
+
+# TemplateInfo
+
+Runtime template information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`detectFiles` | Array<string>
+`name` | string
+
+## Example
+
+```typescript
+import type { TemplateInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "detectFiles": null,
+  "name": null,
+} satisfies TemplateInfo
+
+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 TemplateInfo
+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/TestNotifierResponse.md

@@ -0,0 +1,37 @@
+
+# TestNotifierResponse
+
+Response from `POST /api/v1/notifiers/{id}/test`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`success` | boolean
+
+## Example
+
+```typescript
+import type { TestNotifierResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "success": null,
+} satisfies TestNotifierResponse
+
+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 TestNotifierResponse
+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/TlsResponse.md

@@ -0,0 +1,41 @@
+
+# TlsResponse
+
+Response for `GET /api/v1/proxy/tls`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`acmeAvailable` | boolean
+`acmeEmail` | string
+`certificates` | [Array<CertInfo>](CertInfo.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { TlsResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "acmeAvailable": null,
+  "acmeEmail": null,
+  "certificates": null,
+  "total": null,
+} satisfies TlsResponse
+
+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 TlsResponse
+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/TokenRequest.md

@@ -0,0 +1,37 @@
+
+# TokenRequest
+
+Token request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiKey` | string
+`apiSecret` | string
+
+## Example
+
+```typescript
+import type { TokenRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiKey": null,
+  "apiSecret": null,
+} satisfies TokenRequest
+
+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 TokenRequest
+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/TokenResponse.md

@@ -0,0 +1,39 @@
+
+# TokenResponse
+
+Token response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`expiresIn` | number
+`tokenType` | string
+
+## Example
+
+```typescript
+import type { TokenResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": null,
+  "expiresIn": null,
+  "tokenType": null,
+} satisfies TokenResponse
+
+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 TokenResponse
+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/TriggerBuildResponse.md

@@ -0,0 +1,37 @@
+
+# TriggerBuildResponse
+
+Trigger build response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`buildId` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { TriggerBuildResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "buildId": null,
+  "message": null,
+} satisfies TriggerBuildResponse
+
+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 TriggerBuildResponse
+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)
+
+