@zlayer/api-client 0.10.86

package/docs/CronApi.md

@@ -0,0 +1,369 @@
+# CronApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**disableCronJob**](CronApi.md#disablecronjob) | **PUT** /api/v1/cron/{name}/disable | PUT /api/v1/cron/{name}/disable - Disable a cron job |
+| [**enableCronJob**](CronApi.md#enablecronjob) | **PUT** /api/v1/cron/{name}/enable | PUT /api/v1/cron/{name}/enable - Enable a cron job |
+| [**getCronJob**](CronApi.md#getcronjob) | **GET** /api/v1/cron/{name} | GET /api/v1/cron/{name} - Get cron job details |
+| [**listCronJobs**](CronApi.md#listcronjobs) | **GET** /api/v1/cron | GET /api/v1/cron - List all cron jobs |
+| [**triggerCronJob**](CronApi.md#triggercronjob) | **POST** /api/v1/cron/{name}/trigger | POST /api/v1/cron/{name}/trigger - Manually trigger a cron job |
+
+
+
+## disableCronJob
+
+> CronStatusResponse disableCronJob(name)
+
+PUT /api/v1/cron/{name}/disable - Disable a cron job
+
+Disables a cron job, preventing it from running on schedule. The job can still be manually triggered.  # Errors  Returns an error if the cron job is not found or the user lacks permission.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CronApi,
+} from '@zlayer/client';
+import type { DisableCronJobRequest } 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 CronApi(config);
+
+  const body = {
+    // string | Cron job name
+    name: name_example,
+  } satisfies DisableCronJobRequest;
+
+  try {
+    const data = await api.disableCronJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Cron job name | [Defaults to `undefined`] |
+
+### Return type
+
+[**CronStatusResponse**](CronStatusResponse.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** | Cron job disabled |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Cron job 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)
+
+
+## enableCronJob
+
+> CronStatusResponse enableCronJob(name)
+
+PUT /api/v1/cron/{name}/enable - Enable a cron job
+
+Enables a disabled cron job, allowing it to run on schedule.  # Errors  Returns an error if the cron job is not found or the user lacks permission.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CronApi,
+} from '@zlayer/client';
+import type { EnableCronJobRequest } 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 CronApi(config);
+
+  const body = {
+    // string | Cron job name
+    name: name_example,
+  } satisfies EnableCronJobRequest;
+
+  try {
+    const data = await api.enableCronJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Cron job name | [Defaults to `undefined`] |
+
+### Return type
+
+[**CronStatusResponse**](CronStatusResponse.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** | Cron job enabled |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Cron job 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)
+
+
+## getCronJob
+
+> CronJobResponse getCronJob(name)
+
+GET /api/v1/cron/{name} - Get cron job details
+
+Returns detailed information about a specific cron job.  # Errors  Returns an error if the cron job is not found.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CronApi,
+} from '@zlayer/client';
+import type { GetCronJobRequest } 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 CronApi(config);
+
+  const body = {
+    // string | Cron job name
+    name: name_example,
+  } satisfies GetCronJobRequest;
+
+  try {
+    const data = await api.getCronJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Cron job name | [Defaults to `undefined`] |
+
+### Return type
+
+[**CronJobResponse**](CronJobResponse.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** | Cron job details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Cron job 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)
+
+
+## listCronJobs
+
+> Array<CronJobResponse> listCronJobs()
+
+GET /api/v1/cron - List all cron jobs
+
+Returns a list of all registered cron jobs with their schedule information.  # Errors  Returns an error if the user is not authenticated.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CronApi,
+} from '@zlayer/client';
+import type { ListCronJobsRequest } 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 CronApi(config);
+
+  try {
+    const data = await api.listCronJobs();
+    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<CronJobResponse>**](CronJobResponse.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 cron jobs |  -  |
+| **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)
+
+
+## triggerCronJob
+
+> TriggerCronResponse triggerCronJob(name)
+
+POST /api/v1/cron/{name}/trigger - Manually trigger a cron job
+
+Triggers an immediate execution of the cron job, regardless of its schedule.  # Errors  Returns an error if the cron job is not found or triggering fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CronApi,
+} from '@zlayer/client';
+import type { TriggerCronJobRequest } 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 CronApi(config);
+
+  const body = {
+    // string | Cron job name
+    name: name_example,
+  } satisfies TriggerCronJobRequest;
+
+  try {
+    const data = await api.triggerCronJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Cron job name | [Defaults to `undefined`] |
+
+### Return type
+
+[**TriggerCronResponse**](TriggerCronResponse.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** | Cron job triggered |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Cron job 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/CronJobResponse.md

@@ -0,0 +1,43 @@
+
+# CronJobResponse
+
+Response for cron job information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`lastRun` | string
+`name` | string
+`nextRun` | string
+`schedule` | string
+
+## Example
+
+```typescript
+import type { CronJobResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "lastRun": null,
+  "name": null,
+  "nextRun": null,
+  "schedule": null,
+} satisfies CronJobResponse
+
+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 CronJobResponse
+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/CronStatusResponse.md

@@ -0,0 +1,39 @@
+
+# CronStatusResponse
+
+Response for enable/disable operations
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`message` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { CronStatusResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "message": null,
+  "name": null,
+} satisfies CronStatusResponse
+
+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 CronStatusResponse
+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/CsrfResponse.md

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

@@ -0,0 +1,45 @@
+
+# DeploymentDetails
+
+Deployment details (enhanced with per-service health and endpoints)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`name` | string
+`serviceHealth` | [Array<ServiceHealthInfo>](ServiceHealthInfo.md)
+`services` | Array<string>
+`status` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { DeploymentDetails } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "name": null,
+  "serviceHealth": null,
+  "services": null,
+  "status": null,
+  "updatedAt": null,
+} satisfies DeploymentDetails
+
+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 DeploymentDetails
+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/DeploymentSummary.md

@@ -0,0 +1,41 @@
+
+# DeploymentSummary
+
+Deployment summary
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`name` | string
+`serviceCount` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { DeploymentSummary } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "name": null,
+  "serviceCount": null,
+  "status": null,
+} satisfies DeploymentSummary
+
+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 DeploymentSummary
+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)
+
+