@zlayer/api-client 0.10.86

package/docs/CreateContainerRequest.md

@@ -0,0 +1,51 @@
+
+# CreateContainerRequest
+
+Request to create and start a container
+
+## Properties
+
+Name | Type
+------------ | -------------
+`command` | Array<string>
+`env` | { [key: string]: string; }
+`image` | string
+`labels` | { [key: string]: string; }
+`name` | string
+`pullPolicy` | string
+`resources` | [ContainerResourceLimits](ContainerResourceLimits.md)
+`volumes` | [Array<VolumeMount>](VolumeMount.md)
+`workDir` | string
+
+## Example
+
+```typescript
+import type { CreateContainerRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "command": null,
+  "env": null,
+  "image": null,
+  "labels": null,
+  "name": null,
+  "pullPolicy": null,
+  "resources": null,
+  "volumes": null,
+  "workDir": null,
+} satisfies CreateContainerRequest
+
+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 CreateContainerRequest
+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/CreateDeploymentRequest.md

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

@@ -0,0 +1,39 @@
+
+# CreateEnvironmentRequest
+
+Body for `POST /api/v1/environments`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`name` | string
+`projectId` | string
+
+## Example
+
+```typescript
+import type { CreateEnvironmentRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "name": null,
+  "projectId": null,
+} satisfies CreateEnvironmentRequest
+
+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 CreateEnvironmentRequest
+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/CreateGitCredentialRequest.md

@@ -0,0 +1,39 @@
+
+# CreateGitCredentialRequest
+
+Body for `POST /api/v1/credentials/git`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | [GitCredentialKindSchema](GitCredentialKindSchema.md)
+`name` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { CreateGitCredentialRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": null,
+  "name": null,
+  "value": null,
+} satisfies CreateGitCredentialRequest
+
+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 CreateGitCredentialRequest
+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/CreateGroupRequest.md

@@ -0,0 +1,37 @@
+
+# CreateGroupRequest
+
+Body for `POST /api/v1/groups`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { CreateGroupRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "name": null,
+} satisfies CreateGroupRequest
+
+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 CreateGroupRequest
+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/CreateNodeTunnelRequest.md

@@ -0,0 +1,45 @@
+
+# CreateNodeTunnelRequest
+
+Request to create a node-to-node tunnel
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expose` | string
+`fromNode` | string
+`localPort` | number
+`name` | string
+`remotePort` | number
+`toNode` | string
+
+## Example
+
+```typescript
+import type { CreateNodeTunnelRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "expose": null,
+  "fromNode": null,
+  "localPort": null,
+  "name": null,
+  "remotePort": null,
+  "toNode": null,
+} satisfies CreateNodeTunnelRequest
+
+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 CreateNodeTunnelRequest
+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/CreateNodeTunnelResponse.md

@@ -0,0 +1,47 @@
+
+# CreateNodeTunnelResponse
+
+Response after creating a node-to-node tunnel
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expose` | string
+`fromNode` | string
+`localPort` | number
+`name` | string
+`remotePort` | number
+`status` | string
+`toNode` | string
+
+## Example
+
+```typescript
+import type { CreateNodeTunnelResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "expose": null,
+  "fromNode": null,
+  "localPort": null,
+  "name": null,
+  "remotePort": null,
+  "status": null,
+  "toNode": null,
+} satisfies CreateNodeTunnelResponse
+
+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 CreateNodeTunnelResponse
+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/CreateNotifierRequest.md

@@ -0,0 +1,39 @@
+
+# CreateNotifierRequest
+
+Body for `POST /api/v1/notifiers`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`config` | [NotifierConfig](NotifierConfig.md)
+`kind` | [NotifierKind](NotifierKind.md)
+`name` | string
+
+## Example
+
+```typescript
+import type { CreateNotifierRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "config": null,
+  "kind": null,
+  "name": null,
+} satisfies CreateNotifierRequest
+
+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 CreateNotifierRequest
+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/CreateProjectRequest.md

@@ -0,0 +1,57 @@
+
+# CreateProjectRequest
+
+Body for `POST /api/v1/projects`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoDeploy` | boolean
+`buildKind` | [BuildKind](BuildKind.md)
+`buildPath` | string
+`defaultEnvironmentId` | string
+`deploySpecPath` | string
+`description` | string
+`gitBranch` | string
+`gitCredentialId` | string
+`gitUrl` | string
+`name` | string
+`pollIntervalSecs` | number
+`registryCredentialId` | string
+
+## Example
+
+```typescript
+import type { CreateProjectRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoDeploy": null,
+  "buildKind": null,
+  "buildPath": null,
+  "defaultEnvironmentId": null,
+  "deploySpecPath": null,
+  "description": null,
+  "gitBranch": null,
+  "gitCredentialId": null,
+  "gitUrl": null,
+  "name": null,
+  "pollIntervalSecs": null,
+  "registryCredentialId": null,
+} satisfies CreateProjectRequest
+
+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 CreateProjectRequest
+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/CreateRegistryCredentialRequest.md

@@ -0,0 +1,41 @@
+
+# CreateRegistryCredentialRequest
+
+Body for `POST /api/v1/credentials/registry`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authType` | [RegistryAuthTypeSchema](RegistryAuthTypeSchema.md)
+`password` | string
+`registry` | string
+`username` | string
+
+## Example
+
+```typescript
+import type { CreateRegistryCredentialRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authType": null,
+  "password": null,
+  "registry": null,
+  "username": null,
+} satisfies CreateRegistryCredentialRequest
+
+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 CreateRegistryCredentialRequest
+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/CreateSecretRequest.md

@@ -0,0 +1,39 @@
+
+# CreateSecretRequest
+
+Request to create or update a secret.  `scope` is optional and only honored on the legacy code path — when set alongside `?environment=`, the request is rejected.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`scope` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { CreateSecretRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "scope": null,
+  "value": null,
+} satisfies CreateSecretRequest
+
+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 CreateSecretRequest
+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/CreateSyncRequest.md

@@ -0,0 +1,43 @@
+
+# CreateSyncRequest
+
+Body for `POST /api/v1/syncs`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoApply` | boolean
+`deleteMissing` | boolean
+`gitPath` | string
+`name` | string
+`projectId` | string
+
+## Example
+
+```typescript
+import type { CreateSyncRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoApply": null,
+  "deleteMissing": null,
+  "gitPath": null,
+  "name": null,
+  "projectId": null,
+} satisfies CreateSyncRequest
+
+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 CreateSyncRequest
+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/CreateTaskRequest.md

@@ -0,0 +1,41 @@
+
+# CreateTaskRequest
+
+Body for `POST /api/v1/tasks`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`body` | string
+`kind` | [TaskKind](TaskKind.md)
+`name` | string
+`projectId` | string
+
+## Example
+
+```typescript
+import type { CreateTaskRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "body": null,
+  "kind": null,
+  "name": null,
+  "projectId": null,
+} satisfies CreateTaskRequest
+
+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 CreateTaskRequest
+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/CreateTunnelRequest.md

@@ -0,0 +1,39 @@
+
+# CreateTunnelRequest
+
+Request to create a new tunnel token
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`services` | Array<string>
+`ttlSecs` | number
+
+## Example
+
+```typescript
+import type { CreateTunnelRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "services": null,
+  "ttlSecs": null,
+} satisfies CreateTunnelRequest
+
+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 CreateTunnelRequest
+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/CreateTunnelResponse.md

@@ -0,0 +1,45 @@
+
+# CreateTunnelResponse
+
+Response after creating a tunnel token
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | number
+`expiresAt` | number
+`id` | string
+`name` | string
+`services` | Array<string>
+`token` | string
+
+## Example
+
+```typescript
+import type { CreateTunnelResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "expiresAt": null,
+  "id": null,
+  "name": null,
+  "services": null,
+  "token": null,
+} satisfies CreateTunnelResponse
+
+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 CreateTunnelResponse
+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/CreateUserRequest.md

@@ -0,0 +1,41 @@
+
+# CreateUserRequest
+
+Body for `POST /api/v1/users`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`displayName` | string
+`email` | string
+`password` | string
+`role` | [UserRole](UserRole.md)
+
+## Example
+
+```typescript
+import type { CreateUserRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "displayName": null,
+  "email": null,
+  "password": null,
+  "role": null,
+} satisfies CreateUserRequest
+
+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 CreateUserRequest
+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)
+
+