@zlayer/api-client 0.10.86

package/docs/BuildApi.md

@@ -0,0 +1,495 @@
+# BuildApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getBuildLogs**](BuildApi.md#getbuildlogs) | **GET** /api/v1/build/{id}/logs | GET /api/v1/build/{id}/logs Get build logs. |
+| [**getBuildStatus**](BuildApi.md#getbuildstatus) | **GET** /api/v1/build/{id} | GET /api/v1/build/{id} Get build status. |
+| [**listBuilds**](BuildApi.md#listbuilds) | **GET** /api/v1/builds | GET /api/v1/builds List all builds. |
+| [**listRuntimeTemplates**](BuildApi.md#listruntimetemplates) | **GET** /api/v1/templates | GET /api/v1/templates List available runtime templates |
+| [**startBuild**](BuildApi.md#startbuild) | **POST** /api/v1/build | POST /api/v1/build Start a new build from multipart upload (Dockerfile + context tarball) |
+| [**startBuildJson**](BuildApi.md#startbuildjson) | **POST** /api/v1/build/json | POST /api/v1/build/json Start a new build from JSON request with a context path on the server. |
+| [**streamBuild**](BuildApi.md#streambuild) | **GET** /api/v1/build/{id}/stream | GET /api/v1/build/{id}/stream Stream build progress via Server-Sent Events. |
+
+
+
+## getBuildLogs
+
+> string getBuildLogs(id)
+
+GET /api/v1/build/{id}/logs Get build logs.
+
+# Errors  Returns an error if the build is not found or logs cannot be read.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { GetBuildLogsRequest } 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 BuildApi(config);
+
+  const body = {
+    // string | Build ID
+    id: id_example,
+  } satisfies GetBuildLogsRequest;
+
+  try {
+    const data = await api.getBuildLogs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Build ID | [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Build logs |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Build 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)
+
+
+## getBuildStatus
+
+> BuildStatus getBuildStatus(id)
+
+GET /api/v1/build/{id} Get build status.
+
+# Errors  Returns an error if the build is not found.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { GetBuildStatusRequest } 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 BuildApi(config);
+
+  const body = {
+    // string | Build ID
+    id: id_example,
+  } satisfies GetBuildStatusRequest;
+
+  try {
+    const data = await api.getBuildStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Build ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**BuildStatus**](BuildStatus.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** | Build status |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Build 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)
+
+
+## listBuilds
+
+> Array<BuildStatus> listBuilds()
+
+GET /api/v1/builds List all builds.
+
+# Errors  Returns an error if the user is not authenticated.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { ListBuildsRequest } 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 BuildApi(config);
+
+  try {
+    const data = await api.listBuilds();
+    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<BuildStatus>**](BuildStatus.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 builds |  -  |
+| **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)
+
+
+## listRuntimeTemplates
+
+> Array<TemplateInfo> listRuntimeTemplates()
+
+GET /api/v1/templates List available runtime templates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { ListRuntimeTemplatesRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new BuildApi();
+
+  try {
+    const data = await api.listRuntimeTemplates();
+    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<TemplateInfo>**](TemplateInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of templates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## startBuild
+
+> TriggerBuildResponse startBuild()
+
+POST /api/v1/build Start a new build from multipart upload (Dockerfile + context tarball)
+
+Accepts a multipart form with: - `dockerfile`: The Dockerfile content (optional if using runtime) - `context`: A tarball containing the build context - `config`: JSON configuration (`BuildRequest`)  # Errors  Returns an error if the request is invalid, context extraction fails, or the build cannot be started.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { StartBuildRequest } 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 BuildApi(config);
+
+  try {
+    const data = await api.startBuild();
+    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
+
+[**TriggerBuildResponse**](TriggerBuildResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Build started |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **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)
+
+
+## startBuildJson
+
+> TriggerBuildResponse startBuildJson(buildRequestWithContext)
+
+POST /api/v1/build/json Start a new build from JSON request with a context path on the server.
+
+# Errors  Returns an error if the context path is invalid or the build cannot be started.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { StartBuildJsonRequest } 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 BuildApi(config);
+
+  const body = {
+    // BuildRequestWithContext
+    buildRequestWithContext: ...,
+  } satisfies StartBuildJsonRequest;
+
+  try {
+    const data = await api.startBuildJson(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **buildRequestWithContext** | [BuildRequestWithContext](BuildRequestWithContext.md) |  | |
+
+### Return type
+
+[**TriggerBuildResponse**](TriggerBuildResponse.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 |
+|-------------|-------------|------------------|
+| **202** | Build started |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **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)
+
+
+## streamBuild
+
+> streamBuild(id)
+
+GET /api/v1/build/{id}/stream Stream build progress via Server-Sent Events.
+
+# Errors  Returns an error if the build is not found or not active.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BuildApi,
+} from '@zlayer/client';
+import type { StreamBuildRequest } 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 BuildApi(config);
+
+  const body = {
+    // string | Build ID
+    id: id_example,
+  } satisfies StreamBuildRequest;
+
+  try {
+    const data = await api.streamBuild(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Build 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** | SSE event stream |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Build 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/BuildKind.md

@@ -0,0 +1,33 @@
+
+# BuildKind
+
+How a project is built.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BuildKind } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BuildKind
+
+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 BuildKind
+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/BuildRequest.md

@@ -0,0 +1,45 @@
+
+# BuildRequest
+
+Build request for JSON API
+
+## Properties
+
+Name | Type
+------------ | -------------
+`buildArgs` | { [key: string]: string; }
+`noCache` | boolean
+`push` | boolean
+`runtime` | string
+`tags` | Array<string>
+`target` | string
+
+## Example
+
+```typescript
+import type { BuildRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "buildArgs": null,
+  "noCache": null,
+  "push": null,
+  "runtime": null,
+  "tags": null,
+  "target": null,
+} satisfies BuildRequest
+
+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 BuildRequest
+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/BuildRequestWithContext.md

@@ -0,0 +1,47 @@
+
+# BuildRequestWithContext
+
+Build request with server-side context path
+
+## Properties
+
+Name | Type
+------------ | -------------
+`buildArgs` | { [key: string]: string; }
+`contextPath` | string
+`noCache` | boolean
+`push` | boolean
+`runtime` | string
+`tags` | Array<string>
+`target` | string
+
+## Example
+
+```typescript
+import type { BuildRequestWithContext } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "buildArgs": null,
+  "contextPath": null,
+  "noCache": null,
+  "push": null,
+  "runtime": null,
+  "tags": null,
+  "target": null,
+} satisfies BuildRequestWithContext
+
+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 BuildRequestWithContext
+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/BuildStateEnum.md

@@ -0,0 +1,33 @@
+
+# BuildStateEnum
+
+Build state enumeration
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BuildStateEnum } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BuildStateEnum
+
+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 BuildStateEnum
+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/BuildStatus.md

@@ -0,0 +1,45 @@
+
+# BuildStatus
+
+Build status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completedAt` | string
+`error` | string
+`id` | string
+`imageId` | string
+`startedAt` | string
+`status` | [BuildStateEnum](BuildStateEnum.md)
+
+## Example
+
+```typescript
+import type { BuildStatus } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completedAt": null,
+  "error": null,
+  "id": null,
+  "imageId": null,
+  "startedAt": null,
+  "status": null,
+} satisfies BuildStatus
+
+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 BuildStatus
+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)
+
+