@boatdev/sdk 1.9.5 → 1.9.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +44 -0
- package/dist/apis/BoatApi.d.ts +339 -3
- package/dist/apis/BoatApi.js +865 -15
- package/dist/esm/apis/BoatApi.d.ts +339 -3
- package/dist/esm/apis/BoatApi.js +865 -15
- package/dist/esm/models/AccountAiUsageResponse.d.ts +83 -0
- package/dist/esm/models/AccountAiUsageResponse.js +78 -0
- package/dist/esm/models/AiProxySettings.d.ts +81 -0
- package/dist/esm/models/AiProxySettings.js +76 -0
- package/dist/esm/models/AiProxySettingsAllOfPricing.d.ts +38 -0
- package/dist/esm/models/AiProxySettingsAllOfPricing.js +47 -0
- package/dist/esm/models/AiUsageRow.d.ts +80 -0
- package/dist/esm/models/AiUsageRow.js +75 -0
- package/dist/esm/models/AiUsageTotals.d.ts +62 -0
- package/dist/esm/models/AiUsageTotals.js +63 -0
- package/dist/esm/models/CreateCredentialProfileRequest.d.ts +44 -0
- package/dist/esm/models/CreateCredentialProfileRequest.js +47 -0
- package/dist/esm/models/CredentialAccount.d.ts +50 -0
- package/dist/esm/models/CredentialAccount.js +53 -0
- package/dist/esm/models/CredentialAccountsResponse.d.ts +64 -0
- package/dist/esm/models/CredentialAccountsResponse.js +65 -0
- package/dist/esm/models/CredentialId.d.ts +36 -0
- package/dist/esm/models/CredentialId.js +54 -0
- package/dist/esm/models/CredentialProfile.d.ts +91 -0
- package/dist/esm/models/CredentialProfile.js +79 -0
- package/dist/esm/models/CredentialProfileDeletedResponse.d.ts +44 -0
- package/dist/esm/models/CredentialProfileDeletedResponse.js +51 -0
- package/dist/esm/models/CredentialProfileListResponse.d.ts +45 -0
- package/dist/esm/models/CredentialProfileListResponse.js +52 -0
- package/dist/esm/models/CredentialProfileOwner.d.ts +58 -0
- package/dist/esm/models/CredentialProfileOwner.js +62 -0
- package/dist/esm/models/CredentialProfileResponse.d.ts +51 -0
- package/dist/esm/models/CredentialProfileResponse.js +56 -0
- package/dist/esm/models/ProcessListResponse.d.ts +1 -1
- package/dist/esm/models/SandboxAiAccessResponse.d.ts +56 -0
- package/dist/esm/models/SandboxAiAccessResponse.js +59 -0
- package/dist/esm/models/SandboxAiUsage.d.ts +64 -0
- package/dist/esm/models/SandboxAiUsage.js +65 -0
- package/dist/esm/models/SandboxAiUsageResponse.d.ts +88 -0
- package/dist/esm/models/SandboxAiUsageResponse.js +81 -0
- package/dist/esm/models/SandboxEnvironment.d.ts +13 -1
- package/dist/esm/models/SandboxEnvironment.js +4 -0
- package/dist/esm/models/SetCredentialKeyRequest.d.ts +38 -0
- package/dist/esm/models/SetCredentialKeyRequest.js +45 -0
- package/dist/esm/models/SetCustomApiRequest.d.ts +38 -0
- package/dist/esm/models/SetCustomApiRequest.js +47 -0
- package/dist/esm/models/SetSandboxAiAccessRequest.d.ts +32 -0
- package/dist/esm/models/SetSandboxAiAccessRequest.js +43 -0
- package/dist/esm/models/UpdateAiProxyRequest.d.ts +32 -0
- package/dist/esm/models/UpdateAiProxyRequest.js +43 -0
- package/dist/esm/models/UpdateCredentialProfileRequest.d.ts +38 -0
- package/dist/esm/models/UpdateCredentialProfileRequest.js +43 -0
- package/dist/esm/models/UpdateSandboxEnvironmentRequest.d.ts +12 -0
- package/dist/esm/models/UpdateSandboxEnvironmentRequest.js +4 -0
- package/dist/esm/models/index.d.ts +22 -0
- package/dist/esm/models/index.js +22 -0
- package/dist/models/AccountAiUsageResponse.d.ts +83 -0
- package/dist/models/AccountAiUsageResponse.js +85 -0
- package/dist/models/AiProxySettings.d.ts +81 -0
- package/dist/models/AiProxySettings.js +83 -0
- package/dist/models/AiProxySettingsAllOfPricing.d.ts +38 -0
- package/dist/models/AiProxySettingsAllOfPricing.js +54 -0
- package/dist/models/AiUsageRow.d.ts +80 -0
- package/dist/models/AiUsageRow.js +82 -0
- package/dist/models/AiUsageTotals.d.ts +62 -0
- package/dist/models/AiUsageTotals.js +70 -0
- package/dist/models/CreateCredentialProfileRequest.d.ts +44 -0
- package/dist/models/CreateCredentialProfileRequest.js +54 -0
- package/dist/models/CredentialAccount.d.ts +50 -0
- package/dist/models/CredentialAccount.js +60 -0
- package/dist/models/CredentialAccountsResponse.d.ts +64 -0
- package/dist/models/CredentialAccountsResponse.js +72 -0
- package/dist/models/CredentialId.d.ts +36 -0
- package/dist/models/CredentialId.js +62 -0
- package/dist/models/CredentialProfile.d.ts +91 -0
- package/dist/models/CredentialProfile.js +86 -0
- package/dist/models/CredentialProfileDeletedResponse.d.ts +44 -0
- package/dist/models/CredentialProfileDeletedResponse.js +58 -0
- package/dist/models/CredentialProfileListResponse.d.ts +45 -0
- package/dist/models/CredentialProfileListResponse.js +59 -0
- package/dist/models/CredentialProfileOwner.d.ts +58 -0
- package/dist/models/CredentialProfileOwner.js +70 -0
- package/dist/models/CredentialProfileResponse.d.ts +51 -0
- package/dist/models/CredentialProfileResponse.js +63 -0
- package/dist/models/ProcessListResponse.d.ts +1 -1
- package/dist/models/SandboxAiAccessResponse.d.ts +56 -0
- package/dist/models/SandboxAiAccessResponse.js +66 -0
- package/dist/models/SandboxAiUsage.d.ts +64 -0
- package/dist/models/SandboxAiUsage.js +72 -0
- package/dist/models/SandboxAiUsageResponse.d.ts +88 -0
- package/dist/models/SandboxAiUsageResponse.js +88 -0
- package/dist/models/SandboxEnvironment.d.ts +13 -1
- package/dist/models/SandboxEnvironment.js +4 -0
- package/dist/models/SetCredentialKeyRequest.d.ts +38 -0
- package/dist/models/SetCredentialKeyRequest.js +52 -0
- package/dist/models/SetCustomApiRequest.d.ts +38 -0
- package/dist/models/SetCustomApiRequest.js +54 -0
- package/dist/models/SetSandboxAiAccessRequest.d.ts +32 -0
- package/dist/models/SetSandboxAiAccessRequest.js +50 -0
- package/dist/models/UpdateAiProxyRequest.d.ts +32 -0
- package/dist/models/UpdateAiProxyRequest.js +50 -0
- package/dist/models/UpdateCredentialProfileRequest.d.ts +38 -0
- package/dist/models/UpdateCredentialProfileRequest.js +50 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.d.ts +12 -0
- package/dist/models/UpdateSandboxEnvironmentRequest.js +4 -0
- package/dist/models/index.d.ts +22 -0
- package/dist/models/index.js +22 -0
- package/docs/AccountAiUsageResponse.md +48 -0
- package/docs/AiProxySettings.md +48 -0
- package/docs/AiProxySettingsAllOfPricing.md +34 -0
- package/docs/AiUsageRow.md +48 -0
- package/docs/AiUsageTotals.md +43 -0
- package/docs/BoatApi.md +1588 -212
- package/docs/CreateCredentialProfileRequest.md +36 -0
- package/docs/CredentialAccount.md +39 -0
- package/docs/CredentialAccountsResponse.md +42 -0
- package/docs/CredentialId.md +31 -0
- package/docs/CredentialProfile.md +51 -0
- package/docs/CredentialProfileDeletedResponse.md +36 -0
- package/docs/CredentialProfileListResponse.md +36 -0
- package/docs/CredentialProfileOwner.md +38 -0
- package/docs/CredentialProfileResponse.md +38 -0
- package/docs/SandboxAiAccessResponse.md +40 -0
- package/docs/SandboxAiUsage.md +42 -0
- package/docs/SandboxAiUsageResponse.md +50 -0
- package/docs/SandboxEnvironment.md +4 -0
- package/docs/SetCredentialKeyRequest.md +34 -0
- package/docs/SetCustomApiRequest.md +34 -0
- package/docs/SetSandboxAiAccessRequest.md +32 -0
- package/docs/UpdateAiProxyRequest.md +32 -0
- package/docs/UpdateCredentialProfileRequest.md +34 -0
- package/docs/UpdateSandboxEnvironmentRequest.md +4 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +1440 -133
- package/src/models/AccountAiUsageResponse.ts +160 -0
- package/src/models/AiProxySettings.ts +146 -0
- package/src/models/AiProxySettingsAllOfPricing.ts +75 -0
- package/src/models/AiUsageRow.ts +138 -0
- package/src/models/AiUsageTotals.ts +111 -0
- package/src/models/CreateCredentialProfileRequest.ts +82 -0
- package/src/models/CredentialAccount.ts +92 -0
- package/src/models/CredentialAccountsResponse.ts +128 -0
- package/src/models/CredentialId.ts +64 -0
- package/src/models/CredentialProfile.ts +168 -0
- package/src/models/CredentialProfileDeletedResponse.ts +84 -0
- package/src/models/CredentialProfileListResponse.ts +92 -0
- package/src/models/CredentialProfileOwner.ts +104 -0
- package/src/models/CredentialProfileResponse.ts +101 -0
- package/src/models/ProcessListResponse.ts +1 -1
- package/src/models/SandboxAiAccessResponse.ts +102 -0
- package/src/models/SandboxAiUsage.ts +126 -0
- package/src/models/SandboxAiUsageResponse.ts +162 -0
- package/src/models/SandboxEnvironment.ts +17 -1
- package/src/models/SetCredentialKeyRequest.ts +74 -0
- package/src/models/SetCustomApiRequest.ts +75 -0
- package/src/models/SetSandboxAiAccessRequest.ts +66 -0
- package/src/models/UpdateAiProxyRequest.ts +66 -0
- package/src/models/UpdateCredentialProfileRequest.ts +73 -0
- package/src/models/UpdateSandboxEnvironmentRequest.ts +16 -0
- package/src/models/index.ts +22 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Boat Public API v1
|
|
3
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SetSandboxAiAccessRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface SetSandboxAiAccessRequest {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof SetSandboxAiAccessRequest
|
|
22
|
+
*/
|
|
23
|
+
blocked: boolean;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the SetSandboxAiAccessRequest interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfSetSandboxAiAccessRequest(value: object): value is SetSandboxAiAccessRequest;
|
|
29
|
+
export declare function SetSandboxAiAccessRequestFromJSON(json: any): SetSandboxAiAccessRequest;
|
|
30
|
+
export declare function SetSandboxAiAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetSandboxAiAccessRequest;
|
|
31
|
+
export declare function SetSandboxAiAccessRequestToJSON(json: any): SetSandboxAiAccessRequest;
|
|
32
|
+
export declare function SetSandboxAiAccessRequestToJSONTyped(value?: SetSandboxAiAccessRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Boat Public API v1
|
|
6
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfSetSandboxAiAccessRequest = instanceOfSetSandboxAiAccessRequest;
|
|
17
|
+
exports.SetSandboxAiAccessRequestFromJSON = SetSandboxAiAccessRequestFromJSON;
|
|
18
|
+
exports.SetSandboxAiAccessRequestFromJSONTyped = SetSandboxAiAccessRequestFromJSONTyped;
|
|
19
|
+
exports.SetSandboxAiAccessRequestToJSON = SetSandboxAiAccessRequestToJSON;
|
|
20
|
+
exports.SetSandboxAiAccessRequestToJSONTyped = SetSandboxAiAccessRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the SetSandboxAiAccessRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfSetSandboxAiAccessRequest(value) {
|
|
25
|
+
if (!('blocked' in value) || value['blocked'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function SetSandboxAiAccessRequestFromJSON(json) {
|
|
30
|
+
return SetSandboxAiAccessRequestFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function SetSandboxAiAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'blocked': json['blocked'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
function SetSandboxAiAccessRequestToJSON(json) {
|
|
41
|
+
return SetSandboxAiAccessRequestToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function SetSandboxAiAccessRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'blocked': value['blocked'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Boat Public API v1
|
|
3
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface UpdateAiProxyRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface UpdateAiProxyRequest {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof UpdateAiProxyRequest
|
|
22
|
+
*/
|
|
23
|
+
enabled: boolean;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the UpdateAiProxyRequest interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfUpdateAiProxyRequest(value: object): value is UpdateAiProxyRequest;
|
|
29
|
+
export declare function UpdateAiProxyRequestFromJSON(json: any): UpdateAiProxyRequest;
|
|
30
|
+
export declare function UpdateAiProxyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAiProxyRequest;
|
|
31
|
+
export declare function UpdateAiProxyRequestToJSON(json: any): UpdateAiProxyRequest;
|
|
32
|
+
export declare function UpdateAiProxyRequestToJSONTyped(value?: UpdateAiProxyRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Boat Public API v1
|
|
6
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfUpdateAiProxyRequest = instanceOfUpdateAiProxyRequest;
|
|
17
|
+
exports.UpdateAiProxyRequestFromJSON = UpdateAiProxyRequestFromJSON;
|
|
18
|
+
exports.UpdateAiProxyRequestFromJSONTyped = UpdateAiProxyRequestFromJSONTyped;
|
|
19
|
+
exports.UpdateAiProxyRequestToJSON = UpdateAiProxyRequestToJSON;
|
|
20
|
+
exports.UpdateAiProxyRequestToJSONTyped = UpdateAiProxyRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the UpdateAiProxyRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfUpdateAiProxyRequest(value) {
|
|
25
|
+
if (!('enabled' in value) || value['enabled'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function UpdateAiProxyRequestFromJSON(json) {
|
|
30
|
+
return UpdateAiProxyRequestFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function UpdateAiProxyRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'enabled': json['enabled'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
function UpdateAiProxyRequestToJSON(json) {
|
|
41
|
+
return UpdateAiProxyRequestToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function UpdateAiProxyRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'enabled': value['enabled'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Boat Public API v1
|
|
3
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface UpdateCredentialProfileRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface UpdateCredentialProfileRequest {
|
|
18
|
+
/**
|
|
19
|
+
* New profile name.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof UpdateCredentialProfileRequest
|
|
22
|
+
*/
|
|
23
|
+
name?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Send true to make this profile its owner's default. The previous default loses the flag. False is ignored; make another profile the default instead.
|
|
26
|
+
* @type {boolean}
|
|
27
|
+
* @memberof UpdateCredentialProfileRequest
|
|
28
|
+
*/
|
|
29
|
+
isDefault?: boolean;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the UpdateCredentialProfileRequest interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfUpdateCredentialProfileRequest(value: object): value is UpdateCredentialProfileRequest;
|
|
35
|
+
export declare function UpdateCredentialProfileRequestFromJSON(json: any): UpdateCredentialProfileRequest;
|
|
36
|
+
export declare function UpdateCredentialProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCredentialProfileRequest;
|
|
37
|
+
export declare function UpdateCredentialProfileRequestToJSON(json: any): UpdateCredentialProfileRequest;
|
|
38
|
+
export declare function UpdateCredentialProfileRequestToJSONTyped(value?: UpdateCredentialProfileRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Boat Public API v1
|
|
6
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfUpdateCredentialProfileRequest = instanceOfUpdateCredentialProfileRequest;
|
|
17
|
+
exports.UpdateCredentialProfileRequestFromJSON = UpdateCredentialProfileRequestFromJSON;
|
|
18
|
+
exports.UpdateCredentialProfileRequestFromJSONTyped = UpdateCredentialProfileRequestFromJSONTyped;
|
|
19
|
+
exports.UpdateCredentialProfileRequestToJSON = UpdateCredentialProfileRequestToJSON;
|
|
20
|
+
exports.UpdateCredentialProfileRequestToJSONTyped = UpdateCredentialProfileRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the UpdateCredentialProfileRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfUpdateCredentialProfileRequest(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function UpdateCredentialProfileRequestFromJSON(json) {
|
|
28
|
+
return UpdateCredentialProfileRequestFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function UpdateCredentialProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
36
|
+
'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
function UpdateCredentialProfileRequestToJSON(json) {
|
|
40
|
+
return UpdateCredentialProfileRequestToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
function UpdateCredentialProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'name': value['name'],
|
|
48
|
+
'isDefault': value['isDefault'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -59,6 +59,18 @@ export interface UpdateSandboxEnvironmentRequest {
|
|
|
59
59
|
* @memberof UpdateSandboxEnvironmentRequest
|
|
60
60
|
*/
|
|
61
61
|
passAgentsCredentials?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Id or name of a credential profile you can use, or null for the sandbox owner's default profile. Unknown profiles return `404 credential_profile_not_found`.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof UpdateSandboxEnvironmentRequest
|
|
66
|
+
*/
|
|
67
|
+
credentialProfileId?: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* With `safeForThirdParties` true, pass AI credentials as proxy placeholders. Setting true needs the AI credentials proxy on for the profile owner, else `400 ai_proxy_off`.
|
|
70
|
+
* @type {boolean}
|
|
71
|
+
* @memberof UpdateSandboxEnvironmentRequest
|
|
72
|
+
*/
|
|
73
|
+
proxyAiCredentials?: boolean;
|
|
62
74
|
/**
|
|
63
75
|
* Full .env-style content for the new version.
|
|
64
76
|
* @type {string}
|
|
@@ -41,6 +41,8 @@ function UpdateSandboxEnvironmentRequestFromJSONTyped(json, ignoreDiscriminator)
|
|
|
41
41
|
'passSecrets': json['passSecrets'] == null ? undefined : json['passSecrets'],
|
|
42
42
|
'passSandboxCredentials': json['passSandboxCredentials'] == null ? undefined : json['passSandboxCredentials'],
|
|
43
43
|
'passAgentsCredentials': json['passAgentsCredentials'] == null ? undefined : json['passAgentsCredentials'],
|
|
44
|
+
'credentialProfileId': json['credentialProfileId'] == null ? undefined : json['credentialProfileId'],
|
|
45
|
+
'proxyAiCredentials': json['proxyAiCredentials'] == null ? undefined : json['proxyAiCredentials'],
|
|
44
46
|
'envContents': json['envContents'] == null ? undefined : json['envContents'],
|
|
45
47
|
'secretFiles': json['secretFiles'] == null ? undefined : (json['secretFiles'].map(SecretFile_1.SecretFileFromJSON)),
|
|
46
48
|
'repositories': json['repositories'] == null ? undefined : (json['repositories'].map(UpdateSandboxEnvironmentRequestRepositoriesInner_1.UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSON)),
|
|
@@ -61,6 +63,8 @@ function UpdateSandboxEnvironmentRequestToJSONTyped(value, ignoreDiscriminator =
|
|
|
61
63
|
'passSecrets': value['passSecrets'],
|
|
62
64
|
'passSandboxCredentials': value['passSandboxCredentials'],
|
|
63
65
|
'passAgentsCredentials': value['passAgentsCredentials'],
|
|
66
|
+
'credentialProfileId': value['credentialProfileId'],
|
|
67
|
+
'proxyAiCredentials': value['proxyAiCredentials'],
|
|
64
68
|
'envContents': value['envContents'],
|
|
65
69
|
'secretFiles': value['secretFiles'] == null ? undefined : (value['secretFiles'].map(SecretFile_1.SecretFileToJSON)),
|
|
66
70
|
'repositories': value['repositories'] == null ? undefined : (value['repositories'].map(UpdateSandboxEnvironmentRequestRepositoriesInner_1.UpdateSandboxEnvironmentRequestRepositoriesInnerToJSON)),
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
|
+
export * from './AccountAiUsageResponse';
|
|
1
2
|
export * from './ActiveOrgResponse';
|
|
2
3
|
export * from './ActiveOrgResponseAllOfActive';
|
|
3
4
|
export * from './ActiveOrgUpdateRequest';
|
|
4
5
|
export * from './AddEnvironmentRepoRequest';
|
|
6
|
+
export * from './AiProxySettings';
|
|
7
|
+
export * from './AiProxySettingsAllOfPricing';
|
|
8
|
+
export * from './AiUsageRow';
|
|
9
|
+
export * from './AiUsageTotals';
|
|
5
10
|
export * from './ApiKey';
|
|
6
11
|
export * from './ApiKeyCatalog';
|
|
7
12
|
export * from './ApiKeyCatalogScopeResources';
|
|
@@ -30,11 +35,20 @@ export * from './CommandStreamFrame';
|
|
|
30
35
|
export * from './CompletionEvent';
|
|
31
36
|
export * from './Conversation';
|
|
32
37
|
export * from './ConversationsResponse';
|
|
38
|
+
export * from './CreateCredentialProfileRequest';
|
|
33
39
|
export * from './CreateSandboxEnvironmentRequest';
|
|
34
40
|
export * from './CreateSandboxRequest';
|
|
35
41
|
export * from './CreateSandboxResponse';
|
|
36
42
|
export * from './CreateScopedApiKey503Response';
|
|
37
43
|
export * from './CreateScopedApiKeyRequest';
|
|
44
|
+
export * from './CredentialAccount';
|
|
45
|
+
export * from './CredentialAccountsResponse';
|
|
46
|
+
export * from './CredentialId';
|
|
47
|
+
export * from './CredentialProfile';
|
|
48
|
+
export * from './CredentialProfileDeletedResponse';
|
|
49
|
+
export * from './CredentialProfileListResponse';
|
|
50
|
+
export * from './CredentialProfileOwner';
|
|
51
|
+
export * from './CredentialProfileResponse';
|
|
38
52
|
export * from './DataRetentionPolicyResponse';
|
|
39
53
|
export * from './DataRetentionUpdateRequest';
|
|
40
54
|
export * from './DeletionOperation';
|
|
@@ -99,6 +113,9 @@ export * from './ResumeRequest';
|
|
|
99
113
|
export * from './RotateApiKey409Response';
|
|
100
114
|
export * from './Sandbox';
|
|
101
115
|
export * from './SandboxActionResponse';
|
|
116
|
+
export * from './SandboxAiAccessResponse';
|
|
117
|
+
export * from './SandboxAiUsage';
|
|
118
|
+
export * from './SandboxAiUsageResponse';
|
|
102
119
|
export * from './SandboxEnvironment';
|
|
103
120
|
export * from './SandboxEnvironmentListResponse';
|
|
104
121
|
export * from './SandboxEnvironmentResponse';
|
|
@@ -113,8 +130,11 @@ export * from './SecretFile';
|
|
|
113
130
|
export * from './SecretsResponse';
|
|
114
131
|
export * from './SecretsUpdateRequest';
|
|
115
132
|
export * from './SelectedRepository';
|
|
133
|
+
export * from './SetCredentialKeyRequest';
|
|
134
|
+
export * from './SetCustomApiRequest';
|
|
116
135
|
export * from './SetEnvironmentSecretFileRequest';
|
|
117
136
|
export * from './SetEnvironmentVarRequest';
|
|
137
|
+
export * from './SetSandboxAiAccessRequest';
|
|
118
138
|
export * from './Share200Response';
|
|
119
139
|
export * from './SnapshotChunk';
|
|
120
140
|
export * from './SnapshotDownloadResponse';
|
|
@@ -142,6 +162,8 @@ export * from './TelemetrySetRequest';
|
|
|
142
162
|
export * from './TelemetrySetResponse';
|
|
143
163
|
export * from './TelemetryTestResult';
|
|
144
164
|
export * from './UnknownEvent';
|
|
165
|
+
export * from './UpdateAiProxyRequest';
|
|
166
|
+
export * from './UpdateCredentialProfileRequest';
|
|
145
167
|
export * from './UpdateSandboxEnvironmentRequest';
|
|
146
168
|
export * from './UpdateSandboxEnvironmentRequestRepositoriesInner';
|
|
147
169
|
export * from './UpdateSandboxRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -16,10 +16,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
|
+
__exportStar(require("./AccountAiUsageResponse"), exports);
|
|
19
20
|
__exportStar(require("./ActiveOrgResponse"), exports);
|
|
20
21
|
__exportStar(require("./ActiveOrgResponseAllOfActive"), exports);
|
|
21
22
|
__exportStar(require("./ActiveOrgUpdateRequest"), exports);
|
|
22
23
|
__exportStar(require("./AddEnvironmentRepoRequest"), exports);
|
|
24
|
+
__exportStar(require("./AiProxySettings"), exports);
|
|
25
|
+
__exportStar(require("./AiProxySettingsAllOfPricing"), exports);
|
|
26
|
+
__exportStar(require("./AiUsageRow"), exports);
|
|
27
|
+
__exportStar(require("./AiUsageTotals"), exports);
|
|
23
28
|
__exportStar(require("./ApiKey"), exports);
|
|
24
29
|
__exportStar(require("./ApiKeyCatalog"), exports);
|
|
25
30
|
__exportStar(require("./ApiKeyCatalogScopeResources"), exports);
|
|
@@ -48,11 +53,20 @@ __exportStar(require("./CommandStreamFrame"), exports);
|
|
|
48
53
|
__exportStar(require("./CompletionEvent"), exports);
|
|
49
54
|
__exportStar(require("./Conversation"), exports);
|
|
50
55
|
__exportStar(require("./ConversationsResponse"), exports);
|
|
56
|
+
__exportStar(require("./CreateCredentialProfileRequest"), exports);
|
|
51
57
|
__exportStar(require("./CreateSandboxEnvironmentRequest"), exports);
|
|
52
58
|
__exportStar(require("./CreateSandboxRequest"), exports);
|
|
53
59
|
__exportStar(require("./CreateSandboxResponse"), exports);
|
|
54
60
|
__exportStar(require("./CreateScopedApiKey503Response"), exports);
|
|
55
61
|
__exportStar(require("./CreateScopedApiKeyRequest"), exports);
|
|
62
|
+
__exportStar(require("./CredentialAccount"), exports);
|
|
63
|
+
__exportStar(require("./CredentialAccountsResponse"), exports);
|
|
64
|
+
__exportStar(require("./CredentialId"), exports);
|
|
65
|
+
__exportStar(require("./CredentialProfile"), exports);
|
|
66
|
+
__exportStar(require("./CredentialProfileDeletedResponse"), exports);
|
|
67
|
+
__exportStar(require("./CredentialProfileListResponse"), exports);
|
|
68
|
+
__exportStar(require("./CredentialProfileOwner"), exports);
|
|
69
|
+
__exportStar(require("./CredentialProfileResponse"), exports);
|
|
56
70
|
__exportStar(require("./DataRetentionPolicyResponse"), exports);
|
|
57
71
|
__exportStar(require("./DataRetentionUpdateRequest"), exports);
|
|
58
72
|
__exportStar(require("./DeletionOperation"), exports);
|
|
@@ -117,6 +131,9 @@ __exportStar(require("./ResumeRequest"), exports);
|
|
|
117
131
|
__exportStar(require("./RotateApiKey409Response"), exports);
|
|
118
132
|
__exportStar(require("./Sandbox"), exports);
|
|
119
133
|
__exportStar(require("./SandboxActionResponse"), exports);
|
|
134
|
+
__exportStar(require("./SandboxAiAccessResponse"), exports);
|
|
135
|
+
__exportStar(require("./SandboxAiUsage"), exports);
|
|
136
|
+
__exportStar(require("./SandboxAiUsageResponse"), exports);
|
|
120
137
|
__exportStar(require("./SandboxEnvironment"), exports);
|
|
121
138
|
__exportStar(require("./SandboxEnvironmentListResponse"), exports);
|
|
122
139
|
__exportStar(require("./SandboxEnvironmentResponse"), exports);
|
|
@@ -131,8 +148,11 @@ __exportStar(require("./SecretFile"), exports);
|
|
|
131
148
|
__exportStar(require("./SecretsResponse"), exports);
|
|
132
149
|
__exportStar(require("./SecretsUpdateRequest"), exports);
|
|
133
150
|
__exportStar(require("./SelectedRepository"), exports);
|
|
151
|
+
__exportStar(require("./SetCredentialKeyRequest"), exports);
|
|
152
|
+
__exportStar(require("./SetCustomApiRequest"), exports);
|
|
134
153
|
__exportStar(require("./SetEnvironmentSecretFileRequest"), exports);
|
|
135
154
|
__exportStar(require("./SetEnvironmentVarRequest"), exports);
|
|
155
|
+
__exportStar(require("./SetSandboxAiAccessRequest"), exports);
|
|
136
156
|
__exportStar(require("./Share200Response"), exports);
|
|
137
157
|
__exportStar(require("./SnapshotChunk"), exports);
|
|
138
158
|
__exportStar(require("./SnapshotDownloadResponse"), exports);
|
|
@@ -160,6 +180,8 @@ __exportStar(require("./TelemetrySetRequest"), exports);
|
|
|
160
180
|
__exportStar(require("./TelemetrySetResponse"), exports);
|
|
161
181
|
__exportStar(require("./TelemetryTestResult"), exports);
|
|
162
182
|
__exportStar(require("./UnknownEvent"), exports);
|
|
183
|
+
__exportStar(require("./UpdateAiProxyRequest"), exports);
|
|
184
|
+
__exportStar(require("./UpdateCredentialProfileRequest"), exports);
|
|
163
185
|
__exportStar(require("./UpdateSandboxEnvironmentRequest"), exports);
|
|
164
186
|
__exportStar(require("./UpdateSandboxEnvironmentRequestRepositoriesInner"), exports);
|
|
165
187
|
__exportStar(require("./UpdateSandboxRequest"), exports);
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# AccountAiUsageResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`ok` | boolean
|
|
10
|
+
`type` | string
|
|
11
|
+
`accountId` | string
|
|
12
|
+
`profileId` | string
|
|
13
|
+
`since` | Date
|
|
14
|
+
`sandboxes` | [Array<SandboxAiUsage>](SandboxAiUsage.md)
|
|
15
|
+
`usage` | [Array<AiUsageRow>](AiUsageRow.md)
|
|
16
|
+
`totals` | [AiUsageTotals](AiUsageTotals.md)
|
|
17
|
+
`dollars` | number
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { AccountAiUsageResponse } from '@boatdev/sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"ok": null,
|
|
27
|
+
"type": null,
|
|
28
|
+
"accountId": null,
|
|
29
|
+
"profileId": null,
|
|
30
|
+
"since": null,
|
|
31
|
+
"sandboxes": null,
|
|
32
|
+
"usage": null,
|
|
33
|
+
"totals": null,
|
|
34
|
+
"dollars": null,
|
|
35
|
+
} satisfies AccountAiUsageResponse
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as AccountAiUsageResponse
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# AiProxySettings
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`ok` | boolean
|
|
10
|
+
`type` | string
|
|
11
|
+
`success` | boolean
|
|
12
|
+
`accountId` | string
|
|
13
|
+
`org` | boolean
|
|
14
|
+
`enabled` | boolean
|
|
15
|
+
`enabledAt` | Date
|
|
16
|
+
`pricing` | [AiProxySettingsAllOfPricing](AiProxySettingsAllOfPricing.md)
|
|
17
|
+
`proxyUrl` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { AiProxySettings } from '@boatdev/sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"ok": null,
|
|
27
|
+
"type": null,
|
|
28
|
+
"success": null,
|
|
29
|
+
"accountId": null,
|
|
30
|
+
"org": null,
|
|
31
|
+
"enabled": null,
|
|
32
|
+
"enabledAt": null,
|
|
33
|
+
"pricing": null,
|
|
34
|
+
"proxyUrl": null,
|
|
35
|
+
} satisfies AiProxySettings
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as AiProxySettings
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AiProxySettingsAllOfPricing
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`dailyDollars` | number
|
|
10
|
+
`dollarsPer1000Requests` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { AiProxySettingsAllOfPricing } from '@boatdev/sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"dailyDollars": null,
|
|
20
|
+
"dollarsPer1000Requests": null,
|
|
21
|
+
} satisfies AiProxySettingsAllOfPricing
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as AiProxySettingsAllOfPricing
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# AiUsageRow
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`requests` | number
|
|
10
|
+
`errors` | number
|
|
11
|
+
`inputTokens` | number
|
|
12
|
+
`outputTokens` | number
|
|
13
|
+
`cacheReadTokens` | number
|
|
14
|
+
`cacheWriteTokens` | number
|
|
15
|
+
`day` | Date
|
|
16
|
+
`credential` | string
|
|
17
|
+
`model` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { AiUsageRow } from '@boatdev/sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"requests": null,
|
|
27
|
+
"errors": null,
|
|
28
|
+
"inputTokens": null,
|
|
29
|
+
"outputTokens": null,
|
|
30
|
+
"cacheReadTokens": null,
|
|
31
|
+
"cacheWriteTokens": null,
|
|
32
|
+
"day": null,
|
|
33
|
+
"credential": null,
|
|
34
|
+
"model": null,
|
|
35
|
+
} satisfies AiUsageRow
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as AiUsageRow
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# AiUsageTotals
|
|
3
|
+
|
|
4
|
+
Token counts are the numbers the provider reports in its replies.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`requests` | number
|
|
11
|
+
`errors` | number
|
|
12
|
+
`inputTokens` | number
|
|
13
|
+
`outputTokens` | number
|
|
14
|
+
`cacheReadTokens` | number
|
|
15
|
+
`cacheWriteTokens` | number
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { AiUsageTotals } from '@boatdev/sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"requests": null,
|
|
25
|
+
"errors": null,
|
|
26
|
+
"inputTokens": null,
|
|
27
|
+
"outputTokens": null,
|
|
28
|
+
"cacheReadTokens": null,
|
|
29
|
+
"cacheWriteTokens": null,
|
|
30
|
+
} satisfies AiUsageTotals
|
|
31
|
+
|
|
32
|
+
console.log(example)
|
|
33
|
+
|
|
34
|
+
// Convert the instance to a JSON string
|
|
35
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
36
|
+
console.log(exampleJSON)
|
|
37
|
+
|
|
38
|
+
// Parse the JSON string back to an object
|
|
39
|
+
const exampleParsed = JSON.parse(exampleJSON) as AiUsageTotals
|
|
40
|
+
console.log(exampleParsed)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|