@boatdev/sdk 1.11.0 → 1.12.0

package/docs/CreateSandboxRequest.md

@@ -17,6 +17,10 @@ Name | Type
 `failFast` | boolean
 `count` | number
 `setupScript` | string
+`name` | string
+`visibility` | string
+`hostedPorts` | [Array<HostPortRequest>](HostPortRequest.md)
+`files` | [Array<CreateSandboxRequestFilesInner>](CreateSandboxRequestFilesInner.md)
 `org` | string
 `teamId` | string
 `from` | string
@@ -38,6 +42,10 @@ const example = {
   "failFast": null,
   "count": null,
   "setupScript": null,
+  "name": null,
+  "visibility": null,
+  "hostedPorts": null,
+  "files": null,
   "org": null,
   "teamId": null,
   "from": null,

package/docs/CreateSandboxRequestFilesInner.md

@@ -0,0 +1,36 @@
+
+# CreateSandboxRequestFilesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`content` | string
+`encoding` | string
+
+## Example
+
+```typescript
+import type { CreateSandboxRequestFilesInner } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "content": null,
+  "encoding": null,
+} satisfies CreateSandboxRequestFilesInner
+
+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 CreateSandboxRequestFilesInner
+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/CreateSandboxResponse.md

@@ -12,6 +12,7 @@ Name | Type
 `ttlSeconds` | number
 `sandbox` | [Sandbox](Sandbox.md)
 `sandboxes` | [Array<Sandbox>](Sandbox.md)
+`hostedPorts` | [Array<CreateSandboxResponseAllOfHostedPortsInner>](CreateSandboxResponseAllOfHostedPortsInner.md)
 `giftLimitNotice` | string
 
 ## Example
@@ -27,6 +28,7 @@ const example = {
   "ttlSeconds": null,
   "sandbox": null,
   "sandboxes": null,
+  "hostedPorts": null,
   "giftLimitNotice": null,
 } satisfies CreateSandboxResponse
 

package/docs/CreateSandboxResponseAllOfHostedPortsInner.md

@@ -0,0 +1,44 @@
+
+# CreateSandboxResponseAllOfHostedPortsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`port` | number
+`url` | string
+`isProtected` | boolean
+`access` | string
+`localhost` | boolean
+`error` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CreateSandboxResponseAllOfHostedPortsInner } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "port": null,
+  "url": null,
+  "isProtected": null,
+  "access": null,
+  "localhost": null,
+  "error": null,
+  "message": null,
+} satisfies CreateSandboxResponseAllOfHostedPortsInner
+
+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 CreateSandboxResponseAllOfHostedPortsInner
+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/FileDeleteResponse.md

@@ -0,0 +1,38 @@
+
+# FileDeleteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`path` | string
+
+## Example
+
+```typescript
+import type { FileDeleteResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "path": null,
+} satisfies FileDeleteResponse
+
+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 FileDeleteResponse
+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/FileEntry.md

@@ -0,0 +1,44 @@
+
+# FileEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`path` | string
+`isDir` | boolean
+`isSymlink` | boolean
+`size` | number
+`mode` | string
+`modifiedAt` | Date
+
+## Example
+
+```typescript
+import type { FileEntry } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "path": null,
+  "isDir": null,
+  "isSymlink": null,
+  "size": null,
+  "mode": null,
+  "modifiedAt": null,
+} satisfies FileEntry
+
+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 FileEntry
+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/FileFindResponse.md

@@ -0,0 +1,42 @@
+
+# FileFindResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`matches` | [Array<FileFindResponseAllOfMatches>](FileFindResponseAllOfMatches.md)
+`truncated` | boolean
+`errors` | Array<string>
+
+## Example
+
+```typescript
+import type { FileFindResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "matches": null,
+  "truncated": null,
+  "errors": null,
+} satisfies FileFindResponse
+
+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 FileFindResponse
+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/FileFindResponseAllOfMatches.md

@@ -0,0 +1,36 @@
+
+# FileFindResponseAllOfMatches
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`file` | string
+`line` | number
+`content` | string
+
+## Example
+
+```typescript
+import type { FileFindResponseAllOfMatches } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "file": null,
+  "line": null,
+  "content": null,
+} satisfies FileFindResponseAllOfMatches
+
+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 FileFindResponseAllOfMatches
+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/FileFolderRequest.md

@@ -0,0 +1,34 @@
+
+# FileFolderRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`mode` | string
+
+## Example
+
+```typescript
+import type { FileFolderRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "mode": null,
+} satisfies FileFolderRequest
+
+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 FileFolderRequest
+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/FileInfoResponse.md

@@ -0,0 +1,50 @@
+
+# FileInfoResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`name` | string
+`path` | string
+`isDir` | boolean
+`isSymlink` | boolean
+`size` | number
+`mode` | string
+`modifiedAt` | Date
+`success` | boolean
+
+## Example
+
+```typescript
+import type { FileInfoResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "name": null,
+  "path": null,
+  "isDir": null,
+  "isSymlink": null,
+  "size": null,
+  "mode": null,
+  "modifiedAt": null,
+  "success": null,
+} satisfies FileInfoResponse
+
+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 FileInfoResponse
+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/FileListResponse.md

@@ -0,0 +1,42 @@
+
+# FileListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`path` | string
+`files` | [Array<FileEntry>](FileEntry.md)
+`truncated` | boolean
+
+## Example
+
+```typescript
+import type { FileListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "path": null,
+  "files": null,
+  "truncated": null,
+} satisfies FileListResponse
+
+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 FileListResponse
+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/FileMoveRequest.md

@@ -0,0 +1,36 @@
+
+# FileMoveRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | string
+`destination` | string
+`overwrite` | boolean
+
+## Example
+
+```typescript
+import type { FileMoveRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+  "destination": null,
+  "overwrite": null,
+} satisfies FileMoveRequest
+
+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 FileMoveRequest
+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/FileMoveResponse.md

@@ -0,0 +1,40 @@
+
+# FileMoveResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`path` | string
+`destination` | string
+
+## Example
+
+```typescript
+import type { FileMoveResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "path": null,
+  "destination": null,
+} satisfies FileMoveResponse
+
+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 FileMoveResponse
+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/FilePermissionsRequest.md

@@ -0,0 +1,34 @@
+
+# FilePermissionsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`mode` | string
+
+## Example
+
+```typescript
+import type { FilePermissionsRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "mode": null,
+} satisfies FilePermissionsRequest
+
+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 FilePermissionsRequest
+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/FileReplaceRequest.md

@@ -0,0 +1,36 @@
+
+# FileReplaceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`paths` | Array<string>
+`pattern` | string
+`newValue` | string
+
+## Example
+
+```typescript
+import type { FileReplaceRequest } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "paths": null,
+  "pattern": null,
+  "newValue": null,
+} satisfies FileReplaceRequest
+
+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 FileReplaceRequest
+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/FileReplaceResponse.md

@@ -0,0 +1,38 @@
+
+# FileReplaceResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`results` | [Array<FileReplaceResponseAllOfResults>](FileReplaceResponseAllOfResults.md)
+
+## Example
+
+```typescript
+import type { FileReplaceResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "results": null,
+} satisfies FileReplaceResponse
+
+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 FileReplaceResponse
+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/FileReplaceResponseAllOfResults.md

@@ -0,0 +1,38 @@
+
+# FileReplaceResponseAllOfResults
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`file` | string
+`success` | boolean
+`replacements` | number
+`error` | string
+
+## Example
+
+```typescript
+import type { FileReplaceResponseAllOfResults } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "file": null,
+  "success": null,
+  "replacements": null,
+  "error": null,
+} satisfies FileReplaceResponseAllOfResults
+
+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 FileReplaceResponseAllOfResults
+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/FileSearchResponse.md

@@ -0,0 +1,42 @@
+
+# FileSearchResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`success` | boolean
+`files` | Array<string>
+`truncated` | boolean
+`errors` | Array<string>
+
+## Example
+
+```typescript
+import type { FileSearchResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "success": null,
+  "files": null,
+  "truncated": null,
+  "errors": null,
+} satisfies FileSearchResponse
+
+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 FileSearchResponse
+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)