@boatdev/sdk 1.9.4 → 1.9.6

package/docs/CreateCredentialProfileRequest.md

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

@@ -0,0 +1,31 @@
+
+# CredentialId
+
+One AI credential in a credential profile. The `*-api-key` ids are API keys you can set with `PUT /credential-profiles/{profile}/keys/{credential}`. The sign-ins (`*-subscription`) and Bedrock (`*-bedrock`) are connected on the dashboard Agents & Proxying page, with the profile picked at the top; you can remove them here.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CredentialId } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CredentialId
+
+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 CredentialId
+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/CredentialProfile.md

@@ -0,0 +1,49 @@
+
+# CredentialProfile
+
+A named set of AI credentials. Secret values are never returned.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`isDefault` | boolean
+`owner` | [CredentialProfileOwner](CredentialProfileOwner.md)
+`canManage` | boolean
+`connected` | [Array<CredentialId>](CredentialId.md)
+`customApis` | Array<string>
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { CredentialProfile } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "isDefault": null,
+  "owner": null,
+  "canManage": null,
+  "connected": null,
+  "customApis": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies CredentialProfile
+
+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 CredentialProfile
+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/CredentialProfileDeletedResponse.md

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

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

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

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

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

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

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

@@ -0,0 +1,42 @@
+
+# SandboxAiUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sandboxId` | string
+`name` | string
+`blocked` | boolean
+`usage` | [Array<AiUsageRow>](AiUsageRow.md)
+`totals` | [AiUsageTotals](AiUsageTotals.md)
+`dollars` | number
+
+## Example
+
+```typescript
+import type { SandboxAiUsage } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sandboxId": null,
+  "name": null,
+  "blocked": null,
+  "usage": null,
+  "totals": null,
+  "dollars": null,
+} satisfies SandboxAiUsage
+
+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 SandboxAiUsage
+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/SandboxAiUsageResponse.md

@@ -0,0 +1,50 @@
+
+# SandboxAiUsageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`sandboxId` | string
+`blocked` | boolean
+`proxied` | boolean
+`credentialProfileId` | string
+`since` | Date
+`usage` | [Array<AiUsageRow>](AiUsageRow.md)
+`totals` | [AiUsageTotals](AiUsageTotals.md)
+`dollars` | number
+
+## Example
+
+```typescript
+import type { SandboxAiUsageResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "sandboxId": null,
+  "blocked": null,
+  "proxied": null,
+  "credentialProfileId": null,
+  "since": null,
+  "usage": null,
+  "totals": null,
+  "dollars": null,
+} satisfies SandboxAiUsageResponse
+
+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 SandboxAiUsageResponse
+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/SandboxEnvironment.md

@@ -18,6 +18,8 @@ Name | Type
 `passSecrets` | boolean
 `passSandboxCredentials` | boolean
 `passAgentsCredentials` | boolean
+`credentialProfileId` | string
+`proxyAiCredentials` | boolean
 `envContents` | string
 `secretFiles` | [Array<SecretFile>](SecretFile.md)
 `selectedRepositories` | [Array<SelectedRepository>](SelectedRepository.md)
@@ -41,6 +43,8 @@ const example = {
   "passSecrets": null,
   "passSandboxCredentials": null,
   "passAgentsCredentials": null,
+  "credentialProfileId": null,
+  "proxyAiCredentials": null,
   "envContents": null,
   "secretFiles": null,
   "selectedRepositories": null,

package/docs/SetCredentialKeyRequest.md

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

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

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

@@ -18,6 +18,7 @@ Name | Type
 `fileCount` | number
 `contentSizeBytes` | number
 `contentFileCount` | number
+`origin` | string
 
 ## Example
 
@@ -38,6 +39,7 @@ const example = {
   "fileCount": null,
   "contentSizeBytes": null,
   "contentFileCount": null,
+  "origin": null,
 } satisfies SnapshotSummary
 
 console.log(example)

package/docs/UpdateAiProxyRequest.md

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

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