@zlayer/api-client 0.10.86

package/docs/JobExecutionResponse.md

@@ -0,0 +1,53 @@
+
+# JobExecutionResponse
+
+Job execution status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completedAt` | string
+`durationMs` | number
+`error` | string
+`exitCode` | number
+`id` | string
+`jobName` | string
+`logs` | string
+`startedAt` | string
+`status` | string
+`trigger` | string
+
+## Example
+
+```typescript
+import type { JobExecutionResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completedAt": null,
+  "durationMs": null,
+  "error": null,
+  "exitCode": null,
+  "id": null,
+  "jobName": null,
+  "logs": null,
+  "startedAt": null,
+  "status": null,
+  "trigger": null,
+} satisfies JobExecutionResponse
+
+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 JobExecutionResponse
+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/JobsApi.md

@@ -0,0 +1,311 @@
+# JobsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelExecution**](JobsApi.md#cancelexecution) | **POST** /api/v1/jobs/{execution_id}/cancel | POST /`api/v1/jobs/{execution_id}/cancel` - Cancel a running execution |
+| [**getExecutionStatus**](JobsApi.md#getexecutionstatus) | **GET** /api/v1/jobs/{execution_id}/status | GET /`api/v1/jobs/{execution_id}/status` - Get execution status |
+| [**listJobExecutions**](JobsApi.md#listjobexecutions) | **GET** /api/v1/jobs/{name}/executions | GET /api/v1/jobs/{name}/executions - List executions for a job |
+| [**triggerJob**](JobsApi.md#triggerjob) | **POST** /api/v1/jobs/{name}/trigger | POST /api/v1/jobs/{name}/trigger - Trigger a job execution |
+
+
+
+## cancelExecution
+
+> cancelExecution(executionId)
+
+POST /`api/v1/jobs/{execution_id}/cancel` - Cancel a running execution
+
+Attempts to cancel a running or pending job execution.  # Errors  Returns an error if the execution is not found, already completed, or cancellation fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from '@zlayer/client';
+import type { CancelExecutionRequest } 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 JobsApi(config);
+
+  const body = {
+    // string | Execution ID
+    executionId: executionId_example,
+  } satisfies CancelExecutionRequest;
+
+  try {
+    const data = await api.cancelExecution(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **executionId** | `string` | Execution 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 |
+|-------------|-------------|------------------|
+| **200** | Execution cancelled |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Execution not found |  -  |
+| **409** | Execution already completed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getExecutionStatus
+
+> JobExecutionResponse getExecutionStatus(executionId)
+
+GET /`api/v1/jobs/{execution_id}/status` - Get execution status
+
+Returns the current status of a job execution, including logs if available.  # Errors  Returns an error if the execution is not found.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from '@zlayer/client';
+import type { GetExecutionStatusRequest } 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 JobsApi(config);
+
+  const body = {
+    // string | Execution ID
+    executionId: executionId_example,
+  } satisfies GetExecutionStatusRequest;
+
+  try {
+    const data = await api.getExecutionStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **executionId** | `string` | Execution ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**JobExecutionResponse**](JobExecutionResponse.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** | Execution status |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Execution 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)
+
+
+## listJobExecutions
+
+> Array<JobExecutionResponse> listJobExecutions(name, limit, status)
+
+GET /api/v1/jobs/{name}/executions - List executions for a job
+
+Returns a list of recent executions for the specified job.  # Errors  Returns an error if authentication fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from '@zlayer/client';
+import type { ListJobExecutionsRequest } 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 JobsApi(config);
+
+  const body = {
+    // string | Job name
+    name: name_example,
+    // number | Maximum number of executions to return (optional)
+    limit: 56,
+    // string | Filter by status (pending, running, completed, failed) (optional)
+    status: status_example,
+  } satisfies ListJobExecutionsRequest;
+
+  try {
+    const data = await api.listJobExecutions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Job name | [Defaults to `undefined`] |
+| **limit** | `number` | Maximum number of executions to return | [Optional] [Defaults to `undefined`] |
+| **status** | `string` | Filter by status (pending, running, completed, failed) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<JobExecutionResponse>**](JobExecutionResponse.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 executions |  -  |
+| **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)
+
+
+## triggerJob
+
+> TriggerJobResponse triggerJob(name)
+
+POST /api/v1/jobs/{name}/trigger - Trigger a job execution
+
+Starts a new execution of the specified job. Returns immediately with an execution ID that can be used to track the job\'s progress.  # Errors  Returns an error if the job is not found or triggering fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from '@zlayer/client';
+import type { TriggerJobRequest } 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 JobsApi(config);
+
+  const body = {
+    // string | Job name
+    name: name_example,
+  } satisfies TriggerJobRequest;
+
+  try {
+    const data = await api.triggerJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Job name | [Defaults to `undefined`] |
+
+### Return type
+
+[**TriggerJobResponse**](TriggerJobResponse.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 |
+|-------------|-------------|------------------|
+| **202** | Job triggered successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Job not found |  -  |
+| **500** | Internal error |  -  |
+
+[[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/JoinTokenResponse.md

@@ -0,0 +1,45 @@
+
+# JoinTokenResponse
+
+Join token response for cluster joining
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allocatedIp` | string
+`expiresAt` | number
+`leaderEndpoint` | string
+`leaderPublicKey` | string
+`overlayCidr` | string
+`token` | string
+
+## Example
+
+```typescript
+import type { JoinTokenResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "allocatedIp": null,
+  "expiresAt": null,
+  "leaderEndpoint": null,
+  "leaderPublicKey": null,
+  "overlayCidr": null,
+  "token": null,
+} satisfies JoinTokenResponse
+
+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 JoinTokenResponse
+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/KillContainerRequest.md

@@ -0,0 +1,35 @@
+
+# KillContainerRequest
+
+Request body for killing (sending a signal to) a container. Matches the Docker-compat `POST /containers/{id}/kill` shape.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`signal` | string
+
+## Example
+
+```typescript
+import type { KillContainerRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "signal": null,
+} satisfies KillContainerRequest
+
+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 KillContainerRequest
+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/LinkDeploymentRequest.md

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

@@ -0,0 +1,36 @@
+
+# LoginRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { LoginRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "password": null,
+} satisfies LoginRequest
+
+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 LoginRequest
+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/LoginResponse.md

@@ -0,0 +1,37 @@
+
+# LoginResponse
+
+Response for `/auth/login` and `/auth/bootstrap`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`csrfToken` | string
+`user` | [UserView](UserView.md)
+
+## Example
+
+```typescript
+import type { LoginResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "csrfToken": null,
+  "user": null,
+} satisfies LoginResponse
+
+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 LoginResponse
+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/NetworkSummary.md

@@ -0,0 +1,43 @@
+
+# NetworkSummary
+
+Summary returned when listing networks.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cidrCount` | number
+`description` | string
+`memberCount` | number
+`name` | string
+`ruleCount` | number
+
+## Example
+
+```typescript
+import type { NetworkSummary } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cidrCount": null,
+  "description": null,
+  "memberCount": null,
+  "name": null,
+  "ruleCount": null,
+} satisfies NetworkSummary
+
+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 NetworkSummary
+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)
+
+