@zlayer/api-client 0.10.86

package/docs/GroupsApi.md

@@ -0,0 +1,497 @@
+# GroupsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addMember**](GroupsApi.md#addmemberoperation) | **POST** /api/v1/groups/{id}/members | Add a member to a group. Admin only. |
+| [**createGroup**](GroupsApi.md#creategroupoperation) | **POST** /api/v1/groups | Create a new group. Admin only. |
+| [**deleteGroup**](GroupsApi.md#deletegroup) | **DELETE** /api/v1/groups/{id} | Delete a group. Admin only. |
+| [**getGroup**](GroupsApi.md#getgroup) | **GET** /api/v1/groups/{id} | Fetch a single group by id. |
+| [**listGroups**](GroupsApi.md#listgroups) | **GET** /api/v1/groups | List all groups. |
+| [**removeMember**](GroupsApi.md#removemember) | **DELETE** /api/v1/groups/{id}/members/{user_id} | Remove a member from a group. Admin only. |
+| [**updateGroup**](GroupsApi.md#updategroupoperation) | **PATCH** /api/v1/groups/{id} | Update a group\'s name and/or description. Admin only. |
+
+
+
+## addMember
+
+> addMember(id, addMemberRequest)
+
+Add a member to a group. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when `user_id` is empty, [`ApiError::NotFound`] when the group does not exist, or [`ApiError::Internal`] if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { AddMemberOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // string | Group id
+    id: id_example,
+    // AddMemberRequest
+    addMemberRequest: ...,
+  } satisfies AddMemberOperationRequest;
+
+  try {
+    const data = await api.addMember(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Group id | [Defaults to `undefined`] |
+| **addMemberRequest** | [AddMemberRequest](AddMemberRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Member added |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Group 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)
+
+
+## createGroup
+
+> StoredUserGroup createGroup(createGroupRequest)
+
+Create a new group. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when the name is empty, or [`ApiError::Internal`] if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { CreateGroupOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // CreateGroupRequest
+    createGroupRequest: ...,
+  } satisfies CreateGroupOperationRequest;
+
+  try {
+    const data = await api.createGroup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) |  | |
+
+### Return type
+
+[**StoredUserGroup**](StoredUserGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Group created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteGroup
+
+> deleteGroup(id)
+
+Delete a group. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the group does not exist, or [`ApiError::Internal`] if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { DeleteGroupRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // string | Group id
+    id: id_example,
+  } satisfies DeleteGroupRequest;
+
+  try {
+    const data = await api.deleteGroup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Group id | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | 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)
+
+
+## getGroup
+
+> StoredUserGroup getGroup(id)
+
+Fetch a single group by id.
+
+# Errors  Returns [`ApiError::NotFound`] when no such group exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { GetGroupRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // string | Group id
+    id: id_example,
+  } satisfies GetGroupRequest;
+
+  try {
+    const data = await api.getGroup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Group id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredUserGroup**](StoredUserGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Group |  -  |
+| **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)
+
+
+## listGroups
+
+> Array<StoredUserGroup> listGroups()
+
+List all groups.
+
+# Errors  Returns [`ApiError::Internal`] if the group store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { ListGroupsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  try {
+    const data = await api.listGroups();
+    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<StoredUserGroup>**](StoredUserGroup.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 groups |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeMember
+
+> removeMember(id, userId)
+
+Remove a member from a group. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the group or membership does not exist, or [`ApiError::Internal`] if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { RemoveMemberRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // string | Group id
+    id: id_example,
+    // string | User id to remove
+    userId: userId_example,
+  } satisfies RemoveMemberRequest;
+
+  try {
+    const data = await api.removeMember(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Group id | [Defaults to `undefined`] |
+| **userId** | `string` | User id to remove | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Member removed |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Group or membership 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)
+
+
+## updateGroup
+
+> StoredUserGroup updateGroup(id, updateGroupRequest)
+
+Update a group\'s name and/or description. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the group does not exist, or [`ApiError::Internal`] if the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GroupsApi,
+} from '@zlayer/client';
+import type { UpdateGroupOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new GroupsApi();
+
+  const body = {
+    // string | Group id
+    id: id_example,
+    // UpdateGroupRequest
+    updateGroupRequest: ...,
+  } satisfies UpdateGroupOperationRequest;
+
+  try {
+    const data = await api.updateGroup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Group id | [Defaults to `undefined`] |
+| **updateGroupRequest** | [UpdateGroupRequest](UpdateGroupRequest.md) |  | |
+
+### Return type
+
+[**StoredUserGroup**](StoredUserGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated group |  -  |
+| **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)
+

package/docs/HealthApi.md

@@ -0,0 +1,125 @@
+# HealthApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**liveness**](HealthApi.md#liveness) | **GET** /health/live | Liveness probe - basic health check |
+| [**readiness**](HealthApi.md#readiness) | **GET** /health/ready | Readiness probe - full health check |
+
+
+
+## liveness
+
+> HealthResponse liveness()
+
+Liveness probe - basic health check
+
+### Example
+
+```ts
+import {
+  Configuration,
+  HealthApi,
+} from '@zlayer/client';
+import type { LivenessRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new HealthApi();
+
+  try {
+    const data = await api.liveness();
+    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
+
+[**HealthResponse**](HealthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service is alive |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## readiness
+
+> HealthResponse readiness()
+
+Readiness probe - full health check
+
+### Example
+
+```ts
+import {
+  Configuration,
+  HealthApi,
+} from '@zlayer/client';
+import type { ReadinessRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new HealthApi();
+
+  try {
+    const data = await api.readiness();
+    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
+
+[**HealthResponse**](HealthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service is ready |  -  |
+| **503** | Service not ready |  -  |
+
+[[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/HealthResponse.md

@@ -0,0 +1,41 @@
+
+# HealthResponse
+
+Health check response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runtimeName` | string
+`status` | string
+`uptimeSecs` | number
+`version` | string
+
+## Example
+
+```typescript
+import type { HealthResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runtimeName": null,
+  "status": null,
+  "uptimeSecs": null,
+  "version": null,
+} satisfies HealthResponse
+
+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 HealthResponse
+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/HeartbeatRequest.md

@@ -0,0 +1,43 @@
+
+# HeartbeatRequest
+
+Heartbeat request from a worker node.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpuUsed` | number
+`diskUsed` | number
+`gpuUtilization` | [Array<GpuUtilizationReport>](GpuUtilizationReport.md)
+`memoryUsed` | number
+`nodeId` | number
+
+## Example
+
+```typescript
+import type { HeartbeatRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpuUsed": null,
+  "diskUsed": null,
+  "gpuUtilization": null,
+  "memoryUsed": null,
+  "nodeId": null,
+} satisfies HeartbeatRequest
+
+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 HeartbeatRequest
+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)
+
+