@zlayer/api-client 0.10.86

package/docs/StoredProject.md

@@ -0,0 +1,65 @@
+
+# StoredProject
+
+A project bundles a git source, build configuration, registry credential reference, linked deployments, and a default environment.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoDeploy` | boolean
+`buildKind` | [BuildKind](BuildKind.md)
+`buildPath` | string
+`createdAt` | string
+`defaultEnvironmentId` | string
+`deploySpecPath` | string
+`description` | string
+`gitBranch` | string
+`gitCredentialId` | string
+`gitUrl` | string
+`id` | string
+`name` | string
+`ownerId` | string
+`pollIntervalSecs` | number
+`registryCredentialId` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredProject } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoDeploy": null,
+  "buildKind": null,
+  "buildPath": null,
+  "createdAt": 2026-04-15T12:00:00Z,
+  "defaultEnvironmentId": null,
+  "deploySpecPath": null,
+  "description": null,
+  "gitBranch": null,
+  "gitCredentialId": null,
+  "gitUrl": null,
+  "id": null,
+  "name": null,
+  "ownerId": null,
+  "pollIntervalSecs": null,
+  "registryCredentialId": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredProject
+
+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 StoredProject
+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/StoredSync.md

@@ -0,0 +1,51 @@
+
+# StoredSync
+
+A stored sync resource (persistent record of a git-backed resource set).  A sync points at a directory within a project\'s checkout that contains `ZLayer` resource YAMLs. On diff/apply the directory is scanned, compared against current API state, and reconciled.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoApply` | boolean
+`createdAt` | string
+`deleteMissing` | boolean
+`gitPath` | string
+`id` | string
+`lastAppliedSha` | string
+`name` | string
+`projectId` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredSync } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoApply": null,
+  "createdAt": 2026-04-15T12:00:00Z,
+  "deleteMissing": null,
+  "gitPath": null,
+  "id": null,
+  "lastAppliedSha": null,
+  "name": null,
+  "projectId": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredSync
+
+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 StoredSync
+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/StoredTask.md

@@ -0,0 +1,47 @@
+
+# StoredTask
+
+A stored task — a named runnable script that can be executed on demand.  Tasks can be global (`project_id = None`) or project-scoped (`project_id = Some(project_id)`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`body` | string
+`createdAt` | string
+`id` | string
+`kind` | [TaskKind](TaskKind.md)
+`name` | string
+`projectId` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredTask } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "body": null,
+  "createdAt": 2026-04-15T12:00:00Z,
+  "id": null,
+  "kind": null,
+  "name": null,
+  "projectId": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredTask
+
+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 StoredTask
+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/StoredUserGroup.md

@@ -0,0 +1,43 @@
+
+# StoredUserGroup
+
+A stored user group for role-based access control.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`description` | string
+`id` | string
+`name` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredUserGroup } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": 2026-04-15T12:00:00Z,
+  "description": null,
+  "id": null,
+  "name": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredUserGroup
+
+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 StoredUserGroup
+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/StoredVariable.md

@@ -0,0 +1,45 @@
+
+# StoredVariable
+
+A stored variable — a plaintext key-value pair for template substitution in deployment specs. Variables are NOT encrypted (unlike secrets). They live in their own storage, separate from the encrypted secrets store.  Variables can be global (`scope = None`) or project-scoped (`scope = Some(project_id)`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`name` | string
+`scope` | string
+`updatedAt` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { StoredVariable } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": 2026-04-15T12:00:00Z,
+  "id": null,
+  "name": null,
+  "scope": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+  "value": null,
+} satisfies StoredVariable
+
+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 StoredVariable
+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/StoredWorkflow.md

@@ -0,0 +1,45 @@
+
+# StoredWorkflow
+
+A stored workflow — a named sequence of steps forming a DAG that composes tasks, project builds, deploys, and sync applies.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`name` | string
+`projectId` | string
+`steps` | [Array<WorkflowStep>](WorkflowStep.md)
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { StoredWorkflow } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": 2026-04-15T12:00:00Z,
+  "id": null,
+  "name": null,
+  "projectId": null,
+  "steps": null,
+  "updatedAt": 2026-04-15T12:00:00Z,
+} satisfies StoredWorkflow
+
+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 StoredWorkflow
+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/StreamBackendInfo.md

@@ -0,0 +1,35 @@
+
+# StreamBackendInfo
+
+Information about a single L4 stream proxy backend.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`address` | string
+
+## Example
+
+```typescript
+import type { StreamBackendInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "address": null,
+} satisfies StreamBackendInfo
+
+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 StreamBackendInfo
+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/StreamInfo.md

@@ -0,0 +1,43 @@
+
+# StreamInfo
+
+Information about a single L4 stream proxy.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`backendCount` | number
+`backends` | [Array<StreamBackendInfo>](StreamBackendInfo.md)
+`port` | number
+`protocol` | string
+`service` | string
+
+## Example
+
+```typescript
+import type { StreamInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "backendCount": null,
+  "backends": null,
+  "port": null,
+  "protocol": null,
+  "service": null,
+} satisfies StreamInfo
+
+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 StreamInfo
+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/StreamsResponse.md

@@ -0,0 +1,41 @@
+
+# StreamsResponse
+
+Response for `GET /api/v1/proxy/streams`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streams` | [Array<StreamInfo>](StreamInfo.md)
+`tcpCount` | number
+`total` | number
+`udpCount` | number
+
+## Example
+
+```typescript
+import type { StreamsResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streams": null,
+  "tcpCount": null,
+  "total": null,
+  "udpCount": null,
+} satisfies StreamsResponse
+
+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 StreamsResponse
+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/SubjectKind.md

@@ -0,0 +1,33 @@
+
+# SubjectKind
+
+Whether a permission subject is a user or a group.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SubjectKind } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SubjectKind
+
+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 SubjectKind
+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/SuccessResponse.md

@@ -0,0 +1,35 @@
+
+# SuccessResponse
+
+Generic success response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { SuccessResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies SuccessResponse
+
+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 SuccessResponse
+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/SyncApplyResponse.md

@@ -0,0 +1,39 @@
+
+# SyncApplyResponse
+
+Response for a real apply. Reports per-resource outcomes, the current commit SHA the sync was applied at (when known), and a short human-readable summary for CLI display.  NOTE: This is a breaking change from the previous dry-run-only `{ diff, message }` shape. Clients inspecting the apply response directly must be updated — callers that only consumed the HTTP status stay working.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`appliedSha` | string
+`results` | [Array<SyncResourceResult>](SyncResourceResult.md)
+`summary` | string
+
+## Example
+
+```typescript
+import type { SyncApplyResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "appliedSha": null,
+  "results": null,
+  "summary": null,
+} satisfies SyncApplyResponse
+
+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 SyncApplyResponse
+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/SyncDiffResponse.md

@@ -0,0 +1,39 @@
+
+# SyncDiffResponse
+
+JSON-friendly wrapper around [`SyncDiff`].
+
+## Properties
+
+Name | Type
+------------ | -------------
+`toCreate` | [Array<SyncResourceResponse>](SyncResourceResponse.md)
+`toDelete` | Array<string>
+`toUpdate` | [Array<SyncResourceResponse>](SyncResourceResponse.md)
+
+## Example
+
+```typescript
+import type { SyncDiffResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "toCreate": null,
+  "toDelete": null,
+  "toUpdate": null,
+} satisfies SyncDiffResponse
+
+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 SyncDiffResponse
+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/SyncResourceResponse.md

@@ -0,0 +1,39 @@
+
+# SyncResourceResponse
+
+A single resource in the diff output.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filePath` | string
+`kind` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { SyncResourceResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filePath": null,
+  "kind": null,
+  "name": null,
+} satisfies SyncResourceResponse
+
+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 SyncResourceResponse
+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/SyncResourceResult.md

@@ -0,0 +1,43 @@
+
+# SyncResourceResult
+
+Result of reconciling a single resource during apply.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`action` | string
+`error` | string
+`kind` | string
+`resource` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { SyncResourceResult } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "action": null,
+  "error": null,
+  "kind": null,
+  "resource": null,
+  "status": null,
+} satisfies SyncResourceResult
+
+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 SyncResourceResult
+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)
+
+