@boatdev/sdk 1.0.0

package/docs/ApiKeyScope.md

@@ -0,0 +1,40 @@
+
+# ApiKeyScope
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expiresAt` | Date
+`actions` | Array<string>
+`sandboxes` | [ApiKeyScopeSandboxes](ApiKeyScopeSandboxes.md)
+`environments` | [ApiKeyScopeSandboxes](ApiKeyScopeSandboxes.md)
+`grandfathered` | boolean
+
+## Example
+
+```typescript
+import type { ApiKeyScope } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "expiresAt": null,
+  "actions": null,
+  "sandboxes": null,
+  "environments": null,
+  "grandfathered": null,
+} satisfies ApiKeyScope
+
+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 ApiKeyScope
+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/ApiKeyScopeResource.md

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

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

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

@@ -0,0 +1,64 @@
+
+# ApiKeyUsageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`id` | string
+`name` | string
+`credentialLane` | string
+`keyPrefix` | string
+`keyLastFour` | string
+`sandboxId` | string
+`createdAt` | Date
+`lastUsedAt` | Date
+`usage` | [ApiKeyRequestUsage](ApiKeyRequestUsage.md)
+`resources` | [ApiKeyResourceTotals](ApiKeyResourceTotals.md)
+`expiresAt` | Date
+`expired` | boolean
+`expiringSoon` | boolean
+`scope` | [ApiKeyScope](ApiKeyScope.md)
+`createdResources` | [Array<ApiKeyCreatedResource>](ApiKeyCreatedResource.md)
+
+## Example
+
+```typescript
+import type { ApiKeyUsageResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "id": null,
+  "name": null,
+  "credentialLane": null,
+  "keyPrefix": null,
+  "keyLastFour": null,
+  "sandboxId": null,
+  "createdAt": null,
+  "lastUsedAt": null,
+  "usage": null,
+  "resources": null,
+  "expiresAt": null,
+  "expired": null,
+  "expiringSoon": null,
+  "scope": null,
+  "createdResources": null,
+} satisfies ApiKeyUsageResponse
+
+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 ApiKeyUsageResponse
+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/ApiKeysResponse.md

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