@zlayer/api-client 0.10.86

package/docs/SecretMetadataResponse.md

@@ -0,0 +1,43 @@
+
+# SecretMetadataResponse
+
+Response containing secret metadata. Never includes the value unless the caller is on the explicit `?reveal=true` admin path, in which case `value` is populated.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | number
+`name` | string
+`updatedAt` | number
+`value` | string
+`version` | number
+
+## Example
+
+```typescript
+import type { SecretMetadataResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "name": null,
+  "updatedAt": null,
+  "value": null,
+  "version": null,
+} satisfies SecretMetadataResponse
+
+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 SecretMetadataResponse
+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/SecretsApi.md

@@ -0,0 +1,411 @@
+# SecretsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**bulkImportSecrets**](SecretsApi.md#bulkimportsecrets) | **POST** /api/v1/secrets/bulk-import | Bulk-import secrets from a dotenv-style payload (`KEY=value\\n…`). |
+| [**createSecret**](SecretsApi.md#createsecretoperation) | **POST** /api/v1/secrets | Create or update a secret. |
+| [**deleteSecret**](SecretsApi.md#deletesecret) | **DELETE** /api/v1/secrets/{name} | Delete a secret. |
+| [**getSecretMetadata**](SecretsApi.md#getsecretmetadata) | **GET** /api/v1/secrets/{name} | Get metadata for a specific secret. With `?reveal=true` (admin only), the response also includes the plaintext `value`. |
+| [**listSecrets**](SecretsApi.md#listsecrets) | **GET** /api/v1/secrets | List secrets in a scope. |
+
+
+
+## bulkImportSecrets
+
+> BulkImportResponse bulkImportSecrets(environment, body)
+
+Bulk-import secrets from a dotenv-style payload (`KEY=value\\n…`).
+
+Each non-empty, non-comment line is parsed into a (name, value) pair and written to the env\'s scope. Lines that fail to parse are returned in `errors` and do not abort the import. Each successful write is counted as either `created` or `updated`.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the environment id is unknown, or [`ApiError::Internal`] when the secrets store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SecretsApi,
+} from '@zlayer/client';
+import type { BulkImportSecretsRequest } 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 SecretsApi(config);
+
+  const body = {
+    // string | Environment id to import into
+    environment: environment_example,
+    // string
+    body: body_example,
+  } satisfies BulkImportSecretsRequest;
+
+  try {
+    const data = await api.bulkImportSecrets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **environment** | `string` | Environment id to import into | [Defaults to `undefined`] |
+| **body** | `string` |  | |
+
+### Return type
+
+[**BulkImportResponse**](BulkImportResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Import summary |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Environment id unknown |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createSecret
+
+> SecretMetadataResponse createSecret(createSecretRequest, environment, scope)
+
+Create or update a secret.
+
+Stores a new secret or updates an existing one. The secret value is encrypted at rest and the version number is incremented on updates.  Scope resolution: see [`resolve_scope`].  # Errors  Returns an error if validation fails, storage operations fail, or the caller lacks permission.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SecretsApi,
+} from '@zlayer/client';
+import type { CreateSecretOperationRequest } 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 SecretsApi(config);
+
+  const body = {
+    // CreateSecretRequest
+    createSecretRequest: ...,
+    // string | Environment id (mutually exclusive with body \'scope\') (optional)
+    environment: environment_example,
+    // string | Explicit scope (legacy) (optional)
+    scope: scope_example,
+  } satisfies CreateSecretOperationRequest;
+
+  try {
+    const data = await api.createSecret(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSecretRequest** | [CreateSecretRequest](CreateSecretRequest.md) |  | |
+| **environment** | `string` | Environment id (mutually exclusive with body \'scope\') | [Optional] [Defaults to `undefined`] |
+| **scope** | `string` | Explicit scope (legacy) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SecretMetadataResponse**](SecretMetadataResponse.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** | Secret updated |  -  |
+| **201** | Secret created |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Environment id unknown |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteSecret
+
+> deleteSecret(name, environment, scope)
+
+Delete a secret.
+
+Scope resolution: see [`resolve_scope_get`] (the same query type is reused minus `reveal`).  # Errors  Returns an error if the secret is not found, storage access fails, or the caller lacks permission.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SecretsApi,
+} from '@zlayer/client';
+import type { DeleteSecretRequest } 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 SecretsApi(config);
+
+  const body = {
+    // string | Secret name
+    name: name_example,
+    // string | Environment id (optional)
+    environment: environment_example,
+    // string | Explicit scope (optional)
+    scope: scope_example,
+  } satisfies DeleteSecretRequest;
+
+  try {
+    const data = await api.deleteSecret(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Secret name | [Defaults to `undefined`] |
+| **environment** | `string` | Environment id | [Optional] [Defaults to `undefined`] |
+| **scope** | `string` | Explicit scope | [Optional] [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** | Secret deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Secret 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)
+
+
+## getSecretMetadata
+
+> SecretMetadataResponse getSecretMetadata(name, environment, scope, reveal)
+
+Get metadata for a specific secret. With `?reveal=true` (admin only), the response also includes the plaintext `value`.
+
+Scope resolution: see [`resolve_scope_get`].  # Errors  Returns an error if the secret is not found, the caller is unauthorised to reveal, or storage access fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SecretsApi,
+} from '@zlayer/client';
+import type { GetSecretMetadataRequest } 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 SecretsApi(config);
+
+  const body = {
+    // string | Secret name
+    name: name_example,
+    // string | Environment id (optional)
+    environment: environment_example,
+    // string | Explicit scope (optional)
+    scope: scope_example,
+    // boolean | Include plaintext value (admin only) (optional)
+    reveal: true,
+  } satisfies GetSecretMetadataRequest;
+
+  try {
+    const data = await api.getSecretMetadata(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Secret name | [Defaults to `undefined`] |
+| **environment** | `string` | Environment id | [Optional] [Defaults to `undefined`] |
+| **scope** | `string` | Explicit scope | [Optional] [Defaults to `undefined`] |
+| **reveal** | `boolean` | Include plaintext value (admin only) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SecretMetadataResponse**](SecretMetadataResponse.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** | Secret metadata |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Reveal requires admin |  -  |
+| **404** | Secret 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)
+
+
+## listSecrets
+
+> Array<SecretMetadataResponse> listSecrets(environment, scope)
+
+List secrets in a scope.
+
+Scope resolution: see [`resolve_scope`].  # Errors  Returns an error if storage access fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SecretsApi,
+} from '@zlayer/client';
+import type { ListSecretsRequest } 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 SecretsApi(config);
+
+  const body = {
+    // string | Environment id (optional)
+    environment: environment_example,
+    // string | Explicit scope (optional)
+    scope: scope_example,
+  } satisfies ListSecretsRequest;
+
+  try {
+    const data = await api.listSecrets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **environment** | `string` | Environment id | [Optional] [Defaults to `undefined`] |
+| **scope** | `string` | Explicit scope | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<SecretMetadataResponse>**](SecretMetadataResponse.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 secret metadata |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Environment id unknown |  -  |
+
+[[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/ServiceDetails.md

@@ -0,0 +1,47 @@
+
+# ServiceDetails
+
+Service details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deployment` | string
+`desiredReplicas` | number
+`endpoints` | [Array<ServiceEndpoint>](ServiceEndpoint.md)
+`metrics` | [ServiceMetrics](ServiceMetrics.md)
+`name` | string
+`replicas` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { ServiceDetails } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deployment": null,
+  "desiredReplicas": null,
+  "endpoints": null,
+  "metrics": null,
+  "name": null,
+  "replicas": null,
+  "status": null,
+} satisfies ServiceDetails
+
+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 ServiceDetails
+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/ServiceEndpoint.md

@@ -0,0 +1,41 @@
+
+# ServiceEndpoint
+
+Service endpoint
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`port` | number
+`protocol` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { ServiceEndpoint } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "port": null,
+  "protocol": null,
+  "url": null,
+} satisfies ServiceEndpoint
+
+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 ServiceEndpoint
+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/ServiceHealthInfo.md

@@ -0,0 +1,43 @@
+
+# ServiceHealthInfo
+
+Per-service health info included in deployment details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`endpoints` | Array<string>
+`health` | string
+`name` | string
+`replicasDesired` | number
+`replicasRunning` | number
+
+## Example
+
+```typescript
+import type { ServiceHealthInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "endpoints": null,
+  "health": null,
+  "name": null,
+  "replicasDesired": null,
+  "replicasRunning": null,
+} satisfies ServiceHealthInfo
+
+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 ServiceHealthInfo
+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/ServiceMetrics.md

@@ -0,0 +1,39 @@
+
+# ServiceMetrics
+
+Service metrics
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpuPercent` | number
+`memoryPercent` | number
+`rps` | number
+
+## Example
+
+```typescript
+import type { ServiceMetrics } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpuPercent": null,
+  "memoryPercent": null,
+  "rps": null,
+} satisfies ServiceMetrics
+
+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 ServiceMetrics
+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/ServiceSummary.md

@@ -0,0 +1,45 @@
+
+# ServiceSummary
+
+Service summary
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deployment` | string
+`desiredReplicas` | number
+`endpoints` | [Array<ServiceEndpoint>](ServiceEndpoint.md)
+`name` | string
+`replicas` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { ServiceSummary } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deployment": null,
+  "desiredReplicas": null,
+  "endpoints": null,
+  "name": null,
+  "replicas": null,
+  "status": null,
+} satisfies ServiceSummary
+
+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 ServiceSummary
+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)
+
+