@deepraxis/sdk 0.1.0-dev.c01abef → 0.1.0-dev.c0c05d8

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.
@@ -2059,19 +2059,19 @@ export declare const getSandboxV1Sandboxes: <ThrowOnError extends boolean = fals
2059
2059
  /**
2060
2060
  * Create sandbox (v2)
2061
2061
  *
2062
- * Start an isolated environment using a templateID from templates.list, then retain sandboxID for lifecycle calls. Unlike E2B, templateID resolves to your ready Environment or a public Base; omit it to use the default base template (`base`), as the E2B SDK does. timeout is seconds from creation and defaults to 300. envVars supplies environment variables and metadata stores your string labels. All system communication is secured; use the returned envdAccessToken for files and commands through the envd data plane, not the management methods. Never print that token.
2062
+ * Create a sandbox from the template. All system communication with the sandbox is secured.
2063
2063
  */
2064
2064
  export declare const postSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesResponses, PostSandboxV1SandboxesErrors, ThrowOnError>;
2065
2065
  /**
2066
2066
  * Sandbox metrics
2067
2067
  *
2068
- * Read CPU, memory and disk usage over the requested interval; start and end are Unix seconds. Unlike E2B, light sandboxes do not provide metrics; check the returned capabilities before requesting them.
2068
+ * Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.
2069
2069
  */
2070
2070
  export declare const getSandboxV1SandboxesBySandboxIdMetrics: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdMetricsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdMetricsErrors, ThrowOnError>;
2071
2071
  /**
2072
2072
  * Pause sandbox
2073
2073
  *
2074
- * Suspend a running sandbox for later connection; use delete to discard it instead. Unlike E2B, light sandboxes preserve disk rather than memory, and persistent sandboxes can resume on data-plane traffic even when autoResume is false. Inspect paused state with the management retrieve operation to avoid waking the sandbox. Explicitly ephemeral sandboxes cannot pause. memory defaults to true, but only a memory-capable sandbox preserves running processes; memory=false saves disk state and resumes with a cold boot. Success returns 204; connect resumes the saved sandbox.
2074
+ * Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.
2075
2075
  */
2076
2076
  export declare const postSandboxV1SandboxesBySandboxIdPause: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdPauseData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdPauseErrors, ThrowOnError>;
2077
2077
  /**
@@ -2083,13 +2083,13 @@ export declare const postSandboxV1SandboxesBySandboxIdTimeout: <ThrowOnError ext
2083
2083
  /**
2084
2084
  * Connect sandbox (v2)
2085
2085
  *
2086
- * Reconnect to an existing sandbox and resume it if paused. The optional timeout is seconds from now and defaults to 300; a later existing deadline is preserved. A running sandbox returns 200 and a resumed sandbox returns 201. Read sandboxID, domain and envdAccessToken from the response for subsequent data-plane access; never treat connecting as executing a command.
2086
+ * Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.
2087
2087
  */
2088
2088
  export declare const postSandboxV1SandboxesBySandboxIdConnect: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdConnectData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdConnectErrors, ThrowOnError>;
2089
2089
  /**
2090
2090
  * List templates (v2)
2091
2091
  *
2092
- * Choose a templateID before creating a sandbox. Unlike E2B, this catalog lists your ready Environments and public Bases; use a returned ID or alias; `base` is the default template that create uses when templateID is omitted. Page through results using nextToken.
2092
+ * List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.
2093
2093
  */
2094
2094
  export declare const getSandboxV1Templates: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1TemplatesData, ThrowOnError>) => RequestResult<GetSandboxV1TemplatesResponses, GetSandboxV1TemplatesErrors, ThrowOnError>;
2095
2095
  /**
@@ -5953,7 +5953,7 @@ export const getSandboxV1Sandboxes = (options) => (options?.client ?? client).ge
5953
5953
  /**
5954
5954
  * Create sandbox (v2)
5955
5955
  *
5956
- * Start an isolated environment using a templateID from templates.list, then retain sandboxID for lifecycle calls. Unlike E2B, templateID resolves to your ready Environment or a public Base; omit it to use the default base template (`base`), as the E2B SDK does. timeout is seconds from creation and defaults to 300. envVars supplies environment variables and metadata stores your string labels. All system communication is secured; use the returned envdAccessToken for files and commands through the envd data plane, not the management methods. Never print that token.
5956
+ * Create a sandbox from the template. All system communication with the sandbox is secured.
5957
5957
  */
5958
5958
  export const postSandboxV1Sandboxes = (options) => (options.client ?? client).post({
5959
5959
  security: [
@@ -5994,7 +5994,7 @@ export const postSandboxV1Sandboxes = (options) => (options.client ?? client).po
5994
5994
  /**
5995
5995
  * Sandbox metrics
5996
5996
  *
5997
- * Read CPU, memory and disk usage over the requested interval; start and end are Unix seconds. Unlike E2B, light sandboxes do not provide metrics; check the returned capabilities before requesting them.
5997
+ * Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.
5998
5998
  */
5999
5999
  export const getSandboxV1SandboxesBySandboxIdMetrics = (options) => (options.client ?? client).get({
6000
6000
  security: [
@@ -6031,7 +6031,7 @@ export const getSandboxV1SandboxesBySandboxIdMetrics = (options) => (options.cli
6031
6031
  /**
6032
6032
  * Pause sandbox
6033
6033
  *
6034
- * Suspend a running sandbox for later connection; use delete to discard it instead. Unlike E2B, light sandboxes preserve disk rather than memory, and persistent sandboxes can resume on data-plane traffic even when autoResume is false. Inspect paused state with the management retrieve operation to avoid waking the sandbox. Explicitly ephemeral sandboxes cannot pause. memory defaults to true, but only a memory-capable sandbox preserves running processes; memory=false saves disk state and resumes with a cold boot. Success returns 204; connect resumes the saved sandbox.
6034
+ * Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.
6035
6035
  */
6036
6036
  export const postSandboxV1SandboxesBySandboxIdPause = (options) => (options.client ?? client).post({
6037
6037
  security: [
@@ -6113,7 +6113,7 @@ export const postSandboxV1SandboxesBySandboxIdTimeout = (options) => (options.cl
6113
6113
  /**
6114
6114
  * Connect sandbox (v2)
6115
6115
  *
6116
- * Reconnect to an existing sandbox and resume it if paused. The optional timeout is seconds from now and defaults to 300; a later existing deadline is preserved. A running sandbox returns 200 and a resumed sandbox returns 201. Read sandboxID, domain and envdAccessToken from the response for subsequent data-plane access; never treat connecting as executing a command.
6116
+ * Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.
6117
6117
  */
6118
6118
  export const postSandboxV1SandboxesBySandboxIdConnect = (options) => (options.client ?? client).post({
6119
6119
  security: [
@@ -6154,7 +6154,7 @@ export const postSandboxV1SandboxesBySandboxIdConnect = (options) => (options.cl
6154
6154
  /**
6155
6155
  * List templates (v2)
6156
6156
  *
6157
- * Choose a templateID before creating a sandbox. Unlike E2B, this catalog lists your ready Environments and public Bases; use a returned ID or alias; `base` is the default template that create uses when templateID is omitted. Page through results using nextToken.
6157
+ * List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.
6158
6158
  */
6159
6159
  export const getSandboxV1Templates = (options) => (options?.client ?? client).get({
6160
6160
  security: [
@@ -3912,7 +3912,7 @@ export type SandboxSandboxDetail = {
3912
3912
  */
3913
3913
  allowInternetAccess?: boolean;
3914
3914
  /**
3915
- * Domain returned for sandbox traffic. Build an HTTP service URL as https://<port>-<sandboxID>.<domain> using the returned values, without replacing or stripping the sandboxID suffix.
3915
+ * Base domain where the sandbox traffic is accessible
3916
3916
  */
3917
3917
  domain?: string;
3918
3918
  cpuCount: SandboxCpuCount;
@@ -11867,7 +11867,7 @@ export type MediaMediaEventPage = MediaPage & {
11867
11867
  */
11868
11868
  export type SandboxNewSandboxV2 = {
11869
11869
  /**
11870
- * Template ID or alias from templates.list; resolves to your ready Environment first, then a public Base. Omit it to use the default base template (`base`).
11870
+ * Identifier of the required template
11871
11871
  */
11872
11872
  templateID: string;
11873
11873
  /**
@@ -11929,7 +11929,7 @@ export type SandboxSandbox = {
11929
11929
  */
11930
11930
  trafficAccessToken?: string;
11931
11931
  /**
11932
- * Domain returned for sandbox traffic. Build an HTTP service URL as https://<port>-<sandboxID>.<domain> using the returned values, without replacing or stripping the sandboxID suffix.
11932
+ * Base domain where the sandbox traffic is accessible
11933
11933
  */
11934
11934
  domain?: string;
11935
11935
  };
@@ -17213,7 +17213,7 @@ export type SandboxSandboxNetworkConfig = {
17213
17213
  */
17214
17214
  maskRequestHost?: string;
17215
17215
  /**
17216
- * Unlike E2B, network.httpsPorts is rejected; omit it and serve plaintext HTTP inside the sandbox. The public port URL still uses HTTPS. The upstream field denotes HTTPS-speaking internal ports, permits self-signed certificates and excludes envd port 49983.
17216
+ * Unlike E2B, network.httpsPorts is rejected; omit it when creating a sandbox.
17217
17217
  */
17218
17218
  httpsPorts?: Array<number>;
17219
17219
  /**
@@ -9851,7 +9851,7 @@ export declare const operations: readonly [{
9851
9851
  readonly resource: "sandbox.sandboxes";
9852
9852
  readonly method: "create";
9853
9853
  readonly summary: "Create sandbox (v2)";
9854
- readonly description: "Start an isolated environment using a templateID from templates.list, then retain sandboxID for lifecycle calls. Unlike E2B, templateID resolves to your ready Environment or a public Base; omit it to use the default base template (`base`), as the E2B SDK does. timeout is seconds from creation and defaults to 300. envVars supplies environment variables and metadata stores your string labels. All system communication is secured; use the returned envdAccessToken for files and commands through the envd data plane, not the management methods. Never print that token.";
9854
+ readonly description: "Create a sandbox from the template. All system communication with the sandbox is secured.";
9855
9855
  readonly http: "POST";
9856
9856
  readonly path: "/sandbox/v1/sandboxes";
9857
9857
  readonly streaming: "no";
@@ -9864,7 +9864,7 @@ export declare const operations: readonly [{
9864
9864
  readonly name: "templateID";
9865
9865
  readonly type: "string";
9866
9866
  readonly required: true;
9867
- readonly description: "Template ID or alias from templates.list; resolves to your ready Environment first, then a public Base. Omit it to use the default base template (`base`).";
9867
+ readonly description: "Identifier of the required template";
9868
9868
  }, {
9869
9869
  readonly name: "timeout";
9870
9870
  readonly type: "integer";
@@ -9978,7 +9978,7 @@ export declare const operations: readonly [{
9978
9978
  readonly resource: "sandbox.sandboxes";
9979
9979
  readonly method: "connect";
9980
9980
  readonly summary: "Connect sandbox (v2)";
9981
- readonly description: "Reconnect to an existing sandbox and resume it if paused. The optional timeout is seconds from now and defaults to 300; a later existing deadline is preserved. A running sandbox returns 200 and a resumed sandbox returns 201. Read sandboxID, domain and envdAccessToken from the response for subsequent data-plane access; never treat connecting as executing a command.";
9981
+ readonly description: "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.";
9982
9982
  readonly http: "POST";
9983
9983
  readonly path: "/sandbox/v1/sandboxes/{sandboxID}/connect";
9984
9984
  readonly streaming: "no";
@@ -10099,7 +10099,7 @@ export declare const operations: readonly [{
10099
10099
  readonly resource: "sandbox.sandboxes.metrics";
10100
10100
  readonly method: "list";
10101
10101
  readonly summary: "Sandbox metrics";
10102
- readonly description: "Read CPU, memory and disk usage over the requested interval; start and end are Unix seconds. Unlike E2B, light sandboxes do not provide metrics; check the returned capabilities before requesting them.";
10102
+ readonly description: "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.";
10103
10103
  readonly http: "GET";
10104
10104
  readonly path: "/sandbox/v1/sandboxes/{sandboxID}/metrics";
10105
10105
  readonly streaming: "no";
@@ -10168,7 +10168,7 @@ export declare const operations: readonly [{
10168
10168
  readonly resource: "sandbox.sandboxes";
10169
10169
  readonly method: "pause";
10170
10170
  readonly summary: "Pause sandbox";
10171
- readonly description: "Suspend a running sandbox for later connection; use delete to discard it instead. Unlike E2B, light sandboxes preserve disk rather than memory, and persistent sandboxes can resume on data-plane traffic even when autoResume is false. Inspect paused state with the management retrieve operation to avoid waking the sandbox. Explicitly ephemeral sandboxes cannot pause. memory defaults to true, but only a memory-capable sandbox preserves running processes; memory=false saves disk state and resumes with a cold boot. Success returns 204; connect resumes the saved sandbox.";
10171
+ readonly description: "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.";
10172
10172
  readonly http: "POST";
10173
10173
  readonly path: "/sandbox/v1/sandboxes/{sandboxID}/pause";
10174
10174
  readonly streaming: "no";
@@ -10484,7 +10484,7 @@ export declare const operations: readonly [{
10484
10484
  readonly resource: "sandbox.templates";
10485
10485
  readonly method: "list";
10486
10486
  readonly summary: "List templates (v2)";
10487
- readonly description: "Choose a templateID before creating a sandbox. Unlike E2B, this catalog lists your ready Environments and public Bases; use a returned ID or alias; `base` is the default template that create uses when templateID is omitted. Page through results using nextToken.";
10487
+ readonly description: "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.";
10488
10488
  readonly http: "GET";
10489
10489
  readonly path: "/sandbox/v1/templates";
10490
10490
  readonly streaming: "no";
@@ -12297,7 +12297,7 @@ export const operations = [
12297
12297
  "resource": "sandbox.sandboxes",
12298
12298
  "method": "create",
12299
12299
  "summary": "Create sandbox (v2)",
12300
- "description": "Start an isolated environment using a templateID from templates.list, then retain sandboxID for lifecycle calls. Unlike E2B, templateID resolves to your ready Environment or a public Base; omit it to use the default base template (`base`), as the E2B SDK does. timeout is seconds from creation and defaults to 300. envVars supplies environment variables and metadata stores your string labels. All system communication is secured; use the returned envdAccessToken for files and commands through the envd data plane, not the management methods. Never print that token.",
12300
+ "description": "Create a sandbox from the template. All system communication with the sandbox is secured.",
12301
12301
  "http": "POST",
12302
12302
  "path": "/sandbox/v1/sandboxes",
12303
12303
  "streaming": "no",
@@ -12311,7 +12311,7 @@ export const operations = [
12311
12311
  "name": "templateID",
12312
12312
  "type": "string",
12313
12313
  "required": true,
12314
- "description": "Template ID or alias from templates.list; resolves to your ready Environment first, then a public Base. Omit it to use the default base template (`base`)."
12314
+ "description": "Identifier of the required template"
12315
12315
  },
12316
12316
  {
12317
12317
  "name": "timeout",
@@ -12449,7 +12449,7 @@ export const operations = [
12449
12449
  "resource": "sandbox.sandboxes",
12450
12450
  "method": "connect",
12451
12451
  "summary": "Connect sandbox (v2)",
12452
- "description": "Reconnect to an existing sandbox and resume it if paused. The optional timeout is seconds from now and defaults to 300; a later existing deadline is preserved. A running sandbox returns 200 and a resumed sandbox returns 201. Read sandboxID, domain and envdAccessToken from the response for subsequent data-plane access; never treat connecting as executing a command.",
12452
+ "description": "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.",
12453
12453
  "http": "POST",
12454
12454
  "path": "/sandbox/v1/sandboxes/{sandboxID}/connect",
12455
12455
  "streaming": "no",
@@ -12608,7 +12608,7 @@ export const operations = [
12608
12608
  "resource": "sandbox.sandboxes.metrics",
12609
12609
  "method": "list",
12610
12610
  "summary": "Sandbox metrics",
12611
- "description": "Read CPU, memory and disk usage over the requested interval; start and end are Unix seconds. Unlike E2B, light sandboxes do not provide metrics; check the returned capabilities before requesting them.",
12611
+ "description": "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.",
12612
12612
  "http": "GET",
12613
12613
  "path": "/sandbox/v1/sandboxes/{sandboxID}/metrics",
12614
12614
  "streaming": "no",
@@ -12692,7 +12692,7 @@ export const operations = [
12692
12692
  "resource": "sandbox.sandboxes",
12693
12693
  "method": "pause",
12694
12694
  "summary": "Pause sandbox",
12695
- "description": "Suspend a running sandbox for later connection; use delete to discard it instead. Unlike E2B, light sandboxes preserve disk rather than memory, and persistent sandboxes can resume on data-plane traffic even when autoResume is false. Inspect paused state with the management retrieve operation to avoid waking the sandbox. Explicitly ephemeral sandboxes cannot pause. memory defaults to true, but only a memory-capable sandbox preserves running processes; memory=false saves disk state and resumes with a cold boot. Success returns 204; connect resumes the saved sandbox.",
12695
+ "description": "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.",
12696
12696
  "http": "POST",
12697
12697
  "path": "/sandbox/v1/sandboxes/{sandboxID}/pause",
12698
12698
  "streaming": "no",
@@ -13084,7 +13084,7 @@ export const operations = [
13084
13084
  "resource": "sandbox.templates",
13085
13085
  "method": "list",
13086
13086
  "summary": "List templates (v2)",
13087
- "description": "Choose a templateID before creating a sandbox. Unlike E2B, this catalog lists your ready Environments and public Bases; use a returned ID or alias; `base` is the default template that create uses when templateID is omitted. Page through results using nextToken.",
13087
+ "description": "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.",
13088
13088
  "http": "GET",
13089
13089
  "path": "/sandbox/v1/templates",
13090
13090
  "streaming": "no",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deepraxis/sdk",
3
- "version": "0.1.0-dev.c01abef",
3
+ "version": "0.1.0-dev.c0c05d8",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
6
  "exports": {