@zlayer/api-client 0.10.86

package/docs/WebhooksApi.md

@@ -0,0 +1,233 @@
+# WebhooksApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getWebhookInfo**](WebhooksApi.md#getwebhookinfo) | **GET** /api/v1/projects/{id}/webhook | Get webhook configuration for a project. |
+| [**receiveWebhook**](WebhooksApi.md#receivewebhook) | **POST** /webhooks/{provider}/{project_id} | Receive a webhook push event and trigger a project pull. |
+| [**rotateWebhookSecret**](WebhooksApi.md#rotatewebhooksecret) | **POST** /api/v1/projects/{id}/webhook/rotate | Rotate (regenerate) the webhook secret for a project. |
+
+
+
+## getWebhookInfo
+
+> WebhookInfoResponse getWebhookInfo(id)
+
+Get webhook configuration for a project.
+
+Returns the webhook URL pattern and the HMAC secret. Generates the secret on first call if it does not exist.  Auth required (any authenticated user).  # Errors  Returns [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] on store failures.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@zlayer/client';
+import type { GetWebhookInfoRequest } 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 WebhooksApi(config);
+
+  const body = {
+    // string | Project id
+    id: id_example,
+  } satisfies GetWebhookInfoRequest;
+
+  try {
+    const data = await api.getWebhookInfo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Project id | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebhookInfoResponse**](WebhookInfoResponse.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** | Webhook configuration |  -  |
+| **404** | Project 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)
+
+
+## receiveWebhook
+
+> WebhookResponse receiveWebhook(provider, projectId, body)
+
+Receive a webhook push event and trigger a project pull.
+
+This endpoint is **unauthenticated** -- it relies on HMAC signature verification against the per-project webhook secret.  Supported providers: `github`, `gitea`, `forgejo`, `gitlab`.  # Errors  Returns [`ApiError::NotFound`] when no webhook secret is configured, [`ApiError::Forbidden`] when signature verification fails, [`ApiError::BadRequest`] for unsupported providers or missing git URL, or [`ApiError::Internal`] on git operation failures.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@zlayer/client';
+import type { ReceiveWebhookRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new WebhooksApi();
+
+  const body = {
+    // string | Git host provider (github, gitea, forgejo, gitlab)
+    provider: provider_example,
+    // string | Project id
+    projectId: projectId_example,
+    // string | Raw webhook payload from the git host
+    body: body_example,
+  } satisfies ReceiveWebhookRequest;
+
+  try {
+    const data = await api.receiveWebhook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **provider** | `string` | Git host provider (github, gitea, forgejo, gitlab) | [Defaults to `undefined`] |
+| **projectId** | `string` | Project id | [Defaults to `undefined`] |
+| **body** | `string` | Raw webhook payload from the git host | |
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Pull triggered |  -  |
+| **400** | Bad request (unsupported provider or project has no git URL) |  -  |
+| **403** | Signature verification failed |  -  |
+| **404** | Project not found or no webhook secret configured |  -  |
+| **500** | Pull failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## rotateWebhookSecret
+
+> WebhookInfoResponse rotateWebhookSecret(id)
+
+Rotate (regenerate) the webhook secret for a project.
+
+Admin only.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the project does not exist, or [`ApiError::Internal`] on store failures.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@zlayer/client';
+import type { RotateWebhookSecretRequest } 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 WebhooksApi(config);
+
+  const body = {
+    // string | Project id
+    id: id_example,
+  } satisfies RotateWebhookSecretRequest;
+
+  try {
+    const data = await api.rotateWebhookSecret(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Project id | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebhookInfoResponse**](WebhookInfoResponse.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** | New webhook configuration |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Project 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/WorkflowAction.md

@@ -0,0 +1,41 @@
+
+# WorkflowAction
+
+The action a workflow step performs.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`taskId` | string
+`type` | string
+`projectId` | string
+`syncId` | string
+
+## Example
+
+```typescript
+import type { WorkflowAction } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "taskId": null,
+  "type": null,
+  "projectId": null,
+  "syncId": null,
+} satisfies WorkflowAction
+
+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 WorkflowAction
+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/WorkflowActionOneOf.md

@@ -0,0 +1,37 @@
+
+# WorkflowActionOneOf
+
+Execute a task by id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`taskId` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { WorkflowActionOneOf } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "taskId": null,
+  "type": null,
+} satisfies WorkflowActionOneOf
+
+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 WorkflowActionOneOf
+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/WorkflowActionOneOf1.md

@@ -0,0 +1,37 @@
+
+# WorkflowActionOneOf1
+
+Build a project by id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { WorkflowActionOneOf1 } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "type": null,
+} satisfies WorkflowActionOneOf1
+
+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 WorkflowActionOneOf1
+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/WorkflowActionOneOf2.md

@@ -0,0 +1,37 @@
+
+# WorkflowActionOneOf2
+
+Deploy a project by id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { WorkflowActionOneOf2 } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "type": null,
+} satisfies WorkflowActionOneOf2
+
+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 WorkflowActionOneOf2
+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/WorkflowActionOneOf3.md

@@ -0,0 +1,37 @@
+
+# WorkflowActionOneOf3
+
+Apply a sync resource by id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`syncId` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { WorkflowActionOneOf3 } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "syncId": null,
+  "type": null,
+} satisfies WorkflowActionOneOf3
+
+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 WorkflowActionOneOf3
+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/WorkflowRun.md

@@ -0,0 +1,45 @@
+
+# WorkflowRun
+
+A recorded execution of a workflow.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`finishedAt` | string
+`id` | string
+`startedAt` | string
+`status` | [WorkflowRunStatus](WorkflowRunStatus.md)
+`stepResults` | [Array<StepResult>](StepResult.md)
+`workflowId` | string
+
+## Example
+
+```typescript
+import type { WorkflowRun } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "finishedAt": 2026-04-15T12:00:01Z,
+  "id": null,
+  "startedAt": 2026-04-15T12:00:00Z,
+  "status": null,
+  "stepResults": null,
+  "workflowId": null,
+} satisfies WorkflowRun
+
+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 WorkflowRun
+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/WorkflowRunStatus.md

@@ -0,0 +1,33 @@
+
+# WorkflowRunStatus
+
+Overall status of a workflow run.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { WorkflowRunStatus } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies WorkflowRunStatus
+
+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 WorkflowRunStatus
+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/WorkflowStep.md

@@ -0,0 +1,39 @@
+
+# WorkflowStep
+
+A single step in a workflow.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`action` | [WorkflowAction](WorkflowAction.md)
+`name` | string
+`onFailure` | string
+
+## Example
+
+```typescript
+import type { WorkflowStep } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "action": null,
+  "name": null,
+  "onFailure": null,
+} satisfies WorkflowStep
+
+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 WorkflowStep
+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)
+
+