@zlayer/api-client 0.10.86

package/docs/VariablesApi.md

@@ -0,0 +1,382 @@
+# VariablesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createVariable**](VariablesApi.md#createvariableoperation) | **POST** /api/v1/variables | Create a new variable. Admin only. |
+| [**deleteVariable**](VariablesApi.md#deletevariable) | **DELETE** /api/v1/variables/{id} | Delete a variable. Admin only. |
+| [**getVariable**](VariablesApi.md#getvariable) | **GET** /api/v1/variables/{id} | Fetch a single variable by id. |
+| [**listVariables**](VariablesApi.md#listvariables) | **GET** /api/v1/variables | List variables. |
+| [**updateVariable**](VariablesApi.md#updatevariableoperation) | **PATCH** /api/v1/variables/{id} | Update a variable\'s name and/or value. Admin only. |
+
+
+
+## createVariable
+
+> StoredVariable createVariable(createVariableRequest)
+
+Create a new variable. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name, [`ApiError::Conflict`] when the `(name, scope)` is already used, or [`ApiError::Internal`] when the variable store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariablesApi,
+} from '@zlayer/client';
+import type { CreateVariableOperationRequest } 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 VariablesApi(config);
+
+  const body = {
+    // CreateVariableRequest
+    createVariableRequest: ...,
+  } satisfies CreateVariableOperationRequest;
+
+  try {
+    const data = await api.createVariable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createVariableRequest** | [CreateVariableRequest](CreateVariableRequest.md) |  | |
+
+### Return type
+
+[**StoredVariable**](StoredVariable.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** | Variable created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **409** | Name already used in the given scope |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteVariable
+
+> deleteVariable(id)
+
+Delete a variable. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the variable does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariablesApi,
+} from '@zlayer/client';
+import type { DeleteVariableRequest } 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 VariablesApi(config);
+
+  const body = {
+    // string | Variable id
+    id: id_example,
+  } satisfies DeleteVariableRequest;
+
+  try {
+    const data = await api.deleteVariable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Variable 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** | Variable 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)
+
+
+## getVariable
+
+> StoredVariable getVariable(id)
+
+Fetch a single variable by id.
+
+# Errors  Returns [`ApiError::NotFound`] if no variable with the given id exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariablesApi,
+} from '@zlayer/client';
+import type { GetVariableRequest } 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 VariablesApi(config);
+
+  const body = {
+    // string | Variable id
+    id: id_example,
+  } satisfies GetVariableRequest;
+
+  try {
+    const data = await api.getVariable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Variable id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredVariable**](StoredVariable.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** | Variable |  -  |
+| **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)
+
+
+## listVariables
+
+> Array<StoredVariable> listVariables(scope)
+
+List variables.
+
+Filter rules (see [`ListVariablesQuery`]):  - `?scope={id}` -> variables belonging to that scope. - no `scope` query -> only global variables (`scope IS NULL`).  # Errors  Returns [`ApiError::Internal`] if the variable store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariablesApi,
+} from '@zlayer/client';
+import type { ListVariablesRequest } 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 VariablesApi(config);
+
+  const body = {
+    // string | Scope (project id) to filter by; omit for globals only (optional)
+    scope: scope_example,
+  } satisfies ListVariablesRequest;
+
+  try {
+    const data = await api.listVariables(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scope** | `string` | Scope (project id) to filter by; omit for globals only | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<StoredVariable>**](StoredVariable.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 variables |  -  |
+| **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)
+
+
+## updateVariable
+
+> StoredVariable updateVariable(id, updateVariableRequest)
+
+Update a variable\'s name and/or value. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the variable does not exist, [`ApiError::BadRequest`] for an empty replacement name, [`ApiError::Conflict`] when the new name collides with another variable in the same scope, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VariablesApi,
+} from '@zlayer/client';
+import type { UpdateVariableOperationRequest } 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 VariablesApi(config);
+
+  const body = {
+    // string | Variable id
+    id: id_example,
+    // UpdateVariableRequest
+    updateVariableRequest: ...,
+  } satisfies UpdateVariableOperationRequest;
+
+  try {
+    const data = await api.updateVariable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Variable id | [Defaults to `undefined`] |
+| **updateVariableRequest** | [UpdateVariableRequest](UpdateVariableRequest.md) |  | |
+
+### Return type
+
+[**StoredVariable**](StoredVariable.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 |
+|-------------|-------------|------------------|
+| **200** | Updated variable |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Not found |  -  |
+| **409** | Name collides with another variable |  -  |
+
+[[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/VolumeMount.md

@@ -0,0 +1,39 @@
+
+# VolumeMount
+
+Volume mount specification
+
+## Properties
+
+Name | Type
+------------ | -------------
+`readonly` | boolean
+`source` | string
+`target` | string
+
+## Example
+
+```typescript
+import type { VolumeMount } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "readonly": null,
+  "source": null,
+  "target": null,
+} satisfies VolumeMount
+
+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 VolumeMount
+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/VolumeSummary.md

@@ -0,0 +1,39 @@
+
+# VolumeSummary
+
+Summary of a single volume returned by the list endpoint.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`path` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { VolumeSummary } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "path": null,
+  "sizeBytes": null,
+} satisfies VolumeSummary
+
+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 VolumeSummary
+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/VolumesApi.md

@@ -0,0 +1,152 @@
+# VolumesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteVolume**](VolumesApi.md#deletevolume) | **DELETE** /api/v1/volumes/{name} | Delete a volume by name. |
+| [**listVolumes**](VolumesApi.md#listvolumes) | **GET** /api/v1/volumes | List all volumes on disk. |
+
+
+
+## deleteVolume
+
+> deleteVolume(name, force)
+
+Delete a volume by name.
+
+Removes a volume directory from disk. By default, only empty volumes can be deleted. Use `?force=true` to remove non-empty volumes.  # Errors  Returns an error if the volume is not found or cannot be removed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VolumesApi,
+} from '@zlayer/client';
+import type { DeleteVolumeRequest } 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 VolumesApi(config);
+
+  const body = {
+    // string | Volume name
+    name: name_example,
+    // boolean | Force removal of non-empty volumes
+    force: true,
+  } satisfies DeleteVolumeRequest;
+
+  try {
+    const data = await api.deleteVolume(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Volume name | [Defaults to `undefined`] |
+| **force** | `boolean` | Force removal of non-empty volumes | [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** | Volume deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Volume not found |  -  |
+| **409** | Volume is non-empty (use ?force=true) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listVolumes
+
+> Array<VolumeSummary> listVolumes()
+
+List all volumes on disk.
+
+Enumerates subdirectories under the volume base directory and returns metadata for each one.  # Errors  Returns an error if the volume directory cannot be read.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VolumesApi,
+} from '@zlayer/client';
+import type { ListVolumesRequest } 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 VolumesApi(config);
+
+  try {
+    const data = await api.listVolumes();
+    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<VolumeSummary>**](VolumeSummary.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 volumes |  -  |
+| **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)
+

package/docs/WebhookInfoResponse.md

@@ -0,0 +1,37 @@
+
+# WebhookInfoResponse
+
+Response for `GET /api/v1/projects/{id}/webhook`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`secret` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { WebhookInfoResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "secret": null,
+  "url": null,
+} satisfies WebhookInfoResponse
+
+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 WebhookInfoResponse
+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/WebhookResponse.md

@@ -0,0 +1,37 @@
+
+# WebhookResponse
+
+Response for the public webhook receiver.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sha` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { WebhookResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sha": null,
+  "status": null,
+} satisfies WebhookResponse
+
+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 WebhookResponse
+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)
+
+