agental-sdk 0.1.0 → 0.2.0

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/dist/openapi.d.ts CHANGED
@@ -74,7 +74,7 @@ export interface paths {
74
74
  path?: never;
75
75
  cookie?: never;
76
76
  };
77
- /** @description Sandboxes that have not been deleted. With tag, only those that have every tag named, as many times as it is sent: tag=run-7f3a&tag=claude. With metadata[key]=value, only those whose metadata has that value for that key, for each key sent. A sandbox's template's tags and metadata count as its own. */
77
+ /** @description Sandboxes that have not been deleted, the newest last unless sort says otherwise. Times are a day, read as UTC, or a time with its zone, in ISO 8601. Every filter is judged on a sandbox as it is answered: its status, its autoStopAt, its outbound rule, and its tags and metadata with its template's counted as its own and its own value for a key winning over its template's. With metadata[key]=value, only those whose metadata has that value for that key, and with notMetadata[key]=value only those that do not; a value of * means the key is set, whatever its value, or for notMetadata not set. With limit, one page, and nextCursor for the next; a page sorted by anything but created can miss or repeat a sandbox that changes while the pages are read. */
78
78
  get: operations["listSandboxes"];
79
79
  put?: never;
80
80
  post: operations["createSandbox"];
@@ -84,6 +84,108 @@ export interface paths {
84
84
  patch?: never;
85
85
  trace?: never;
86
86
  };
87
+ "/v1/sandbox-summary": {
88
+ parameters: {
89
+ query?: never;
90
+ header?: never;
91
+ path?: never;
92
+ cookie?: never;
93
+ };
94
+ /** @description How many sandboxes the list's filters find, and what they cost: an hour, as each is charged now by its open run, running or stopped; and since midnight UTC today, by their runs. Spent covers the sandboxes found now, not the account: sandboxes deleted today, snapshots, burst fees and the rest are in GET /v1/billing. ifStopped is what the running among them would cost stopped, with and without their memory. With facets, the count and hourly cost of each value of each field named, at most 20 values a field, the most first; a field's own filter is left out of its counts, so each value says what choosing it would find. Takes every filter GET /v1/sandboxes takes, and not sort, limit or cursor. */
95
+ get: operations["summarizeSandboxes"];
96
+ put?: never;
97
+ post?: never;
98
+ delete?: never;
99
+ options?: never;
100
+ head?: never;
101
+ patch?: never;
102
+ trace?: never;
103
+ };
104
+ "/v1/sandbox-jobs/preview": {
105
+ parameters: {
106
+ query?: never;
107
+ header?: never;
108
+ path?: never;
109
+ cookie?: never;
110
+ };
111
+ get?: never;
112
+ put?: never;
113
+ /** @description Fixes the sandboxes a job would act on, and does nothing to them: those the filter finds (the list's filters, not limit or cursor), or the IDs named, that the caller may act on. Answers how many, the first of them, what they cost an hour now and would after, and when the preview expires. A job made from it acts on exactly these, and on no sandbox that comes into the filter later. A key needs the action the single call takes: sandbox.stop for stop and archive, sandbox.resume for start, snapshot.write, sandbox.auto-stop to set a stop time and sandbox.update to take it away, sandbox.update for labels, sandbox.delete for delete (or sandbox.delete-own, which deletes only the sandboxes the key made). */
114
+ post: operations["previewSandboxJob"];
115
+ delete?: never;
116
+ options?: never;
117
+ head?: never;
118
+ patch?: never;
119
+ trace?: never;
120
+ };
121
+ "/v1/sandbox-jobs": {
122
+ parameters: {
123
+ query?: never;
124
+ header?: never;
125
+ path?: never;
126
+ cookie?: never;
127
+ };
128
+ /** @description The organization's last 50 jobs, the newest first. A key limited by lists sees only the jobs it made. */
129
+ get: operations["listSandboxJobs"];
130
+ put?: never;
131
+ /** @description Makes a job from a preview, { previewId }, or from IDs named outright, { action, options, ids }. It acts on exactly those sandboxes, a few at a time, checking each again just before: one that left the filter it was chosen by, is already as the action would make it, or that its maker may no longer act on, is skipped. An item is pending, acting, accepted (going on after the call, as a stop writing memory does), done, skipped, failed, or uncertain (the worker stopped between acting and writing the answer; settled by reading the sandbox, never by acting again). Sent again with the same Idempotency-Key, the same job is answered. */
132
+ post: operations["createSandboxJob"];
133
+ delete?: never;
134
+ options?: never;
135
+ head?: never;
136
+ patch?: never;
137
+ trace?: never;
138
+ };
139
+ "/v1/sandbox-jobs/{id}": {
140
+ parameters: {
141
+ query?: never;
142
+ header?: never;
143
+ path?: never;
144
+ cookie?: never;
145
+ };
146
+ get: operations["getSandboxJob"];
147
+ put?: never;
148
+ post?: never;
149
+ delete?: never;
150
+ options?: never;
151
+ head?: never;
152
+ patch?: never;
153
+ trace?: never;
154
+ };
155
+ "/v1/sandbox-jobs/{id}/items": {
156
+ parameters: {
157
+ query?: never;
158
+ header?: never;
159
+ path?: never;
160
+ cookie?: never;
161
+ };
162
+ /** @description Each sandbox of the job, in order: its state, why, and what it made or follows (an operation, a stop, a snapshot). */
163
+ get: operations["listSandboxJobItems"];
164
+ put?: never;
165
+ post?: never;
166
+ delete?: never;
167
+ options?: never;
168
+ head?: never;
169
+ patch?: never;
170
+ trace?: never;
171
+ };
172
+ "/v1/sandbox-jobs/{id}/cancel": {
173
+ parameters: {
174
+ query?: never;
175
+ header?: never;
176
+ path?: never;
177
+ cookie?: never;
178
+ };
179
+ get?: never;
180
+ put?: never;
181
+ /** @description No item that has not begun begins; those under way are followed to their end. Who made the job may cancel it, and an owner or admin of its organization. */
182
+ post: operations["cancelSandboxJob"];
183
+ delete?: never;
184
+ options?: never;
185
+ head?: never;
186
+ patch?: never;
187
+ trace?: never;
188
+ };
87
189
  "/v1/sandboxes/{id}": {
88
190
  parameters: {
89
191
  query?: never;
@@ -1800,24 +1902,6 @@ export interface paths {
1800
1902
  patch?: never;
1801
1903
  trace?: never;
1802
1904
  };
1803
- "/v1/templates/{id}/repo": {
1804
- parameters: {
1805
- query?: never;
1806
- header?: never;
1807
- path?: never;
1808
- cookie?: never;
1809
- };
1810
- /** @description The repository the template links to. It is kept for reference: nothing is cloned yet. */
1811
- get: operations["getTemplateRepo"];
1812
- /** @description Links the template to a repository, in place of the one it linked to. Nothing is cloned. */
1813
- put: operations["setTemplateRepo"];
1814
- post?: never;
1815
- delete: operations["deleteTemplateRepo"];
1816
- options?: never;
1817
- head?: never;
1818
- patch?: never;
1819
- trace?: never;
1820
- };
1821
1905
  "/v1/templates/{id}/sandboxes": {
1822
1906
  parameters: {
1823
1907
  query?: never;
@@ -2276,7 +2360,7 @@ export interface paths {
2276
2360
  };
2277
2361
  get?: never;
2278
2362
  put?: never;
2279
- /** @description Where to send the browser to pay for a plan, for an account that must start one before it allows a terminal. The checkout comes back to this sign-in's page, which then allows it. Any other purchase is POST /v1/billing/checkout. */
2363
+ /** @description Where to send the browser to save a card for the free plan, or pay for a plan, for an account that must do one before it allows a terminal. The checkout comes back to this sign-in's page, which then allows it. Any other purchase is POST /v1/billing/checkout. */
2280
2364
  post: operations["checkoutForCliSignIn"];
2281
2365
  delete?: never;
2282
2366
  options?: never;
@@ -2805,6 +2889,22 @@ export interface components {
2805
2889
  /** @description Why the memory its last stop kept was not put back by its last start, which started it from its disk: as after an upgrade of the server it is on, which the memory cannot be put back across. Null when it was put back, or none was kept. */
2806
2890
  memoryLost: string | null;
2807
2891
  network: components["schemas"]["SandboxNetwork"];
2892
+ /** @description What it is doing, as last read: null when it is not running, not read yet, or where GET /v1/policy says metrics is false. */
2893
+ activity: {
2894
+ /** @description low-cpu: for the last hour, observed with enough coverage, its CPU at its busiest stayed under the line (5% of its vCPUs unless the deployment sets another). A heuristic: an agent waiting on a model or a download is busy with almost no CPU, and nothing acts on it by itself. disk-full, memory-full: at or over the line (90%). not-read: its server has not answered for 3 minutes, and none of the others is said. */
2895
+ states: ("low-cpu" | "disk-full" | "memory-full" | "not-read")[];
2896
+ /** @description Its CPU now, 0 to 1 of its vCPUs. */
2897
+ cpuNow: number | null;
2898
+ /** @description Its CPU at its busiest in the last hour, 0 to 1 of its vCPUs. */
2899
+ cpuMaxLastHour: number | null;
2900
+ /** @description How many of the last hour's minutes were read, since its current run began on its current server. */
2901
+ observedMinutes: number;
2902
+ memoryUsedBytes: number | null;
2903
+ memoryTotalBytes: number | null;
2904
+ diskUsedBytes: number | null;
2905
+ diskTotalBytes: number | null;
2906
+ readAt: string;
2907
+ } | null;
2808
2908
  /**
2809
2909
  * @description Its template's tags and its own, each once: the template's first. A change to its template's tags shows here at once. GET /v1/sandboxes?tag= finds sandboxes by them.
2810
2910
  * @example [
@@ -2867,6 +2967,22 @@ export interface components {
2867
2967
  createdAt: string;
2868
2968
  updatedAt: string;
2869
2969
  };
2970
+ WaitingCreate: {
2971
+ waiting: {
2972
+ /** @description The region it waits for room in. */
2973
+ region: string;
2974
+ /**
2975
+ * @description When it was first asked for under this key. Its deadline is kept from then across every try.
2976
+ * @example 2026-11-05T12:00:00.000Z
2977
+ */
2978
+ askedAt: string;
2979
+ /**
2980
+ * @description Until when a try with the same key is waited for. After it, the create is refused with 409 capacity_exceeded.
2981
+ * @example 2026-11-05T12:02:30.000Z
2982
+ */
2983
+ until: string;
2984
+ };
2985
+ };
2870
2986
  CreateSandbox: {
2871
2987
  /**
2872
2988
  * @description Lowercase letters, digits, and hyphens. 1–63 characters. Must not start or end with a hyphen.
@@ -2946,6 +3062,167 @@ export interface components {
2946
3062
  };
2947
3063
  SandboxList: {
2948
3064
  sandboxes: components["schemas"]["Sandbox"][];
3065
+ /** @description What to send as cursor, with the same sort and limit, for the sandboxes after these. Null when these are the last. */
3066
+ nextCursor: string | null;
3067
+ };
3068
+ SandboxSummary: {
3069
+ /** @description Midnight UTC today, from when spentMicros is counted. */
3070
+ since: string;
3071
+ total: {
3072
+ count: number;
3073
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3074
+ microsPerHour: number;
3075
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3076
+ spentMicros: number;
3077
+ };
3078
+ /** @description What was found, by status as the API says it, the archived apart from the other stopped ones. */
3079
+ byState: {
3080
+ creating: {
3081
+ count: number;
3082
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3083
+ microsPerHour: number;
3084
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3085
+ spentMicros: number;
3086
+ };
3087
+ running: {
3088
+ count: number;
3089
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3090
+ microsPerHour: number;
3091
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3092
+ spentMicros: number;
3093
+ };
3094
+ /** @description Stopped and not archived. */
3095
+ stopped: {
3096
+ count: number;
3097
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3098
+ microsPerHour: number;
3099
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3100
+ spentMicros: number;
3101
+ };
3102
+ archived: {
3103
+ count: number;
3104
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3105
+ microsPerHour: number;
3106
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3107
+ spentMicros: number;
3108
+ };
3109
+ restoring: {
3110
+ count: number;
3111
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3112
+ microsPerHour: number;
3113
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3114
+ spentMicros: number;
3115
+ };
3116
+ migrating: {
3117
+ count: number;
3118
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3119
+ microsPerHour: number;
3120
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3121
+ spentMicros: number;
3122
+ };
3123
+ error: {
3124
+ count: number;
3125
+ /** @description What they are charged an hour now, in millionths of a US dollar: the rates of their open runs, running or stopped. */
3126
+ microsPerHour: number;
3127
+ /** @description What their runs cost since midnight UTC today, in millionths of a US dollar. */
3128
+ spentMicros: number;
3129
+ };
3130
+ };
3131
+ /** @description What the running among them would cost an hour stopped, with their disks kept, and with their memory kept too. */
3132
+ ifStopped: {
3133
+ microsPerHour: number;
3134
+ withMemoryMicrosPerHour: number;
3135
+ };
3136
+ /** @description Each field asked for in facets, by its name. */
3137
+ facets: {
3138
+ [key: string]: {
3139
+ values: {
3140
+ value: string;
3141
+ count: number;
3142
+ microsPerHour: number;
3143
+ }[];
3144
+ /** @description How many other values there are past the ones listed. */
3145
+ more: number;
3146
+ };
3147
+ };
3148
+ };
3149
+ SandboxJobPreview: {
3150
+ id: string;
3151
+ /** @enum {string} */
3152
+ action: "stop" | "start" | "archive" | "snapshot" | "auto-stop" | "labels" | "delete";
3153
+ options: {
3154
+ /** @description For stop: keep their memory as well as their disks. */
3155
+ keepMemory?: boolean;
3156
+ /** @description For snapshot: its name, checkpoint when left out. */
3157
+ name?: string;
3158
+ /** @description For auto-stop: the time to stop at, in ISO 8601, or null to take the time limit away. */
3159
+ at?: string | null;
3160
+ /** @description For auto-stop: seconds from now, fixed to a time when the job is made. */
3161
+ inSeconds?: number;
3162
+ /** @description For labels: tags of their own to add. */
3163
+ addTags?: string[];
3164
+ /** @description For labels: tags of their own to take away. One from a template stays, and the item says so. */
3165
+ removeTags?: string[];
3166
+ /** @description For labels: their own metadata to set, a key with null taken away. */
3167
+ metadata?: {
3168
+ [key: string]: string | null;
3169
+ };
3170
+ };
3171
+ count: number;
3172
+ sample: {
3173
+ id: string;
3174
+ name: string;
3175
+ status: string;
3176
+ }[];
3177
+ /** @description What the chosen are charged an hour now, and would be once the action is done, in millionths of a US dollar. */
3178
+ microsPerHour: {
3179
+ now: number;
3180
+ after: number;
3181
+ };
3182
+ expiresAt: string;
3183
+ };
3184
+ SandboxJob: {
3185
+ id: string;
3186
+ /** @enum {string} */
3187
+ action: "stop" | "start" | "archive" | "snapshot" | "auto-stop" | "labels" | "delete";
3188
+ options: {
3189
+ /** @description For stop: keep their memory as well as their disks. */
3190
+ keepMemory?: boolean;
3191
+ /** @description For snapshot: its name, checkpoint when left out. */
3192
+ name?: string;
3193
+ /** @description For auto-stop: the time to stop at, in ISO 8601, or null to take the time limit away. */
3194
+ at?: string | null;
3195
+ /** @description For auto-stop: seconds from now, fixed to a time when the job is made. */
3196
+ inSeconds?: number;
3197
+ /** @description For labels: tags of their own to add. */
3198
+ addTags?: string[];
3199
+ /** @description For labels: tags of their own to take away. One from a template stays, and the item says so. */
3200
+ removeTags?: string[];
3201
+ /** @description For labels: their own metadata to set, a key with null taken away. */
3202
+ metadata?: {
3203
+ [key: string]: string | null;
3204
+ };
3205
+ };
3206
+ /** @enum {string} */
3207
+ state: "running" | "done" | "cancelled";
3208
+ total: number;
3209
+ counts: {
3210
+ pending: number;
3211
+ acting: number;
3212
+ accepted: number;
3213
+ done: number;
3214
+ skipped: number;
3215
+ failed: number;
3216
+ uncertain: number;
3217
+ };
3218
+ createdAt: string;
3219
+ endedAt: string | null;
3220
+ /** @description The first items that failed, are uncertain or were skipped, with why. */
3221
+ problems: {
3222
+ sandboxId: string;
3223
+ state: string;
3224
+ reason: string | null;
3225
+ }[];
2949
3226
  };
2950
3227
  ExecResult: {
2951
3228
  exitCode: number;
@@ -3528,6 +3805,8 @@ export interface components {
3528
3805
  keepMemory: boolean;
3529
3806
  /** @enum {string} */
3530
3807
  overlap: "skip" | "replace" | "parallel";
3808
+ /** @description Whether its run deletes the sandbox after, where its command exits 0. Only a schedule that runs once has it. */
3809
+ deleteAfter: boolean;
3531
3810
  enabled: boolean;
3532
3811
  /** @description When it next runs. Null while it is paused, and for one that ran once. A cron's or a one-off's is its time and the schedule's own delay of up to a minute, the same each time, so that the schedules due at one time do not all start their sandboxes at once. */
3533
3812
  nextRunAt: string | null;
@@ -3564,6 +3843,8 @@ export interface components {
3564
3843
  * @enum {string|null}
3565
3844
  */
3566
3845
  stoppedSandbox: "disk" | "memory" | null;
3846
+ /** @description Whether this run deleted its sandbox after its command exited 0, as its schedule's deleteAfter asks. Where it did not, a schedule with deleteAfter says why in reason. */
3847
+ deletedSandbox: boolean;
3567
3848
  };
3568
3849
  CreateSchedule: {
3569
3850
  /**
@@ -3610,6 +3891,8 @@ export interface components {
3610
3891
  * @enum {string}
3611
3892
  */
3612
3893
  overlap?: "skip" | "replace" | "parallel";
3894
+ /** @description For a schedule that runs once, with at: true deletes the sandbox when its run's command exits 0, whether the run started it or it was running already, as DELETE /v1/sandboxes/{id} does. A run that fails, times out, is skipped or could not start leaves it, so that it can be looked at, and its record says so. Defaults to false. It takes a key that may delete the sandbox: sandbox.delete, or sandbox.delete-own for one the key made. */
3895
+ deleteAfter?: boolean;
3613
3896
  /** @description False pauses it. Defaults to true. */
3614
3897
  enabled?: boolean;
3615
3898
  };
@@ -3658,6 +3941,8 @@ export interface components {
3658
3941
  * @enum {string}
3659
3942
  */
3660
3943
  overlap?: "skip" | "replace" | "parallel";
3944
+ /** @description For a schedule that runs once, with at: true deletes the sandbox when its run's command exits 0, whether the run started it or it was running already, as DELETE /v1/sandboxes/{id} does. A run that fails, times out, is skipped or could not start leaves it, so that it can be looked at, and its record says so. Defaults to false. It takes a key that may delete the sandbox: sandbox.delete, or sandbox.delete-own for one the key made. */
3945
+ deleteAfter?: boolean;
3661
3946
  /** @description False pauses it. Defaults to true. */
3662
3947
  enabled?: boolean;
3663
3948
  };
@@ -3732,6 +4017,11 @@ export interface components {
3732
4017
  poolMax: number | null;
3733
4018
  /** @description The template its pool sandboxes are made on, where the repository is private and runs no workflows from fork pull requests. Null: the organization's empty runs-on template, which every other pool and a fork's own sandbox get. */
3734
4019
  templateId: string | null;
4020
+ /**
4021
+ * @description The size a job that asks for runs-on: agental gets: its template's, or medium with none. A job that asks for agental-<size> gets that size. Each size has a pool of its own.
4022
+ * @enum {string}
4023
+ */
4024
+ size: "tiny" | "small" | "medium" | "large";
3735
4025
  sandboxes: {
3736
4026
  sandboxId: string;
3737
4027
  name: string;
@@ -3867,7 +4157,8 @@ export interface components {
3867
4157
  status: string;
3868
4158
  periodStart: string | null;
3869
4159
  periodEnd: string | null;
3870
- hadFreeMonth: boolean;
4160
+ /** @description When a card was first saved on the free plan, or null. */
4161
+ cardSavedAt: string | null;
3871
4162
  } | null;
3872
4163
  payments: {
3873
4164
  id: string;
@@ -3948,7 +4239,6 @@ export interface components {
3948
4239
  hidden: string[];
3949
4240
  /** @description The paths of its secret files. Contents are read one at a time. */
3950
4241
  files: string[];
3951
- repo: components["schemas"]["TemplateRepo"] | null;
3952
4242
  network: components["schemas"]["TemplateNetwork"];
3953
4243
  ssh: components["schemas"]["TemplateSsh"];
3954
4244
  /** @description Raised by every change to its variables, files and outbound rule. A sandbox that has it at another revision is not up to date with it. */
@@ -3986,15 +4276,6 @@ export interface components {
3986
4276
  /** @description Seconds a sandbox made from the template runs after each start before it is stopped, when the create names none. Null is the deployment's default. */
3987
4277
  ttlSeconds: number | null;
3988
4278
  };
3989
- TemplateRepo: {
3990
- name: string;
3991
- url: string;
3992
- /**
3993
- * @description Nothing is cloned yet. The link is kept for reference.
3994
- * @enum {boolean}
3995
- */
3996
- connected: false;
3997
- };
3998
4279
  TemplateNetwork: {
3999
4280
  /**
4000
4281
  * @description What a sandbox on the template may reach outside itself, before its own addresses. open is the internet, which is what a sandbox has when nothing is asked. blocked lets nothing out: names still resolve, and no connection leaves. allowlist lets out only what goes to an address in allow. It is enforced outside the sandbox, on the server it runs on, so nothing running in the sandbox can change it, root included. What reaches the sandbox is not affected: commands, files and its public addresses work as before. Whatever this says, no sandbox reaches another sandbox or a private network, or delivers mail on port 25.
@@ -4300,7 +4581,7 @@ export interface components {
4300
4581
  * @enum {string}
4301
4582
  */
4302
4583
  signup: "open" | "invite";
4303
- /** @description Sandboxes one account held to no plan may hold at a time, stopped ones included. An account on a plan, where plans are enforced, may hold any number, and runs as many at once as its plan's runningUnits. Null means no per-account limit. */
4584
+ /** @description Sandboxes one account may hold at a time, stopped ones included, before it has saved a card or bought a plan. One that has, where plans are enforced, may hold any number, and runs as many at once as its plan's runningUnits. Null means no per-account limit. */
4304
4585
  sandboxesPerAccount: number | null;
4305
4586
  /** @description Seconds a new sandbox runs after a start before it is stopped. Null means it is not stopped for age. */
4306
4587
  defaultTtlSeconds: number | null;
@@ -4397,7 +4678,7 @@ export interface components {
4397
4678
  /** @enum {string} */
4398
4679
  label: "list price";
4399
4680
  }[];
4400
- /** @description The monthly plans: what each costs, what it includes, which sizes it makes, how many sandboxes it runs at once, and how many it starts at once for nothing. */
4681
+ /** @description The plans: what each costs a month, what it includes, which sizes it makes, how many sandboxes it runs at once, and how many it starts at once for nothing. The first, free, costs and includes nothing: it pays from top-ups and its one credit, see free. */
4401
4682
  tiers: {
4402
4683
  /** @example plan100 */
4403
4684
  id: string;
@@ -4427,7 +4708,7 @@ export interface components {
4427
4708
  * @description Kept for clients that read it: the free burst in megabytes. Nothing is refused for speed now; a start faster than the free burst costs a fee.
4428
4709
  */
4429
4710
  burst: {
4430
- /** @description The plan's place among the plans, 0 for the $20 plan. */
4711
+ /** @description The plan's place among the plans, 0 for the free plan. */
4431
4712
  tier: number;
4432
4713
  /**
4433
4714
  * @description The plan's free burst, in megabytes: freeBurstUnits times 4096.
@@ -4450,7 +4731,7 @@ export interface components {
4450
4731
  */
4451
4732
  sizes: ("tiny" | "small" | "medium" | "large")[];
4452
4733
  }[];
4453
- /** @description What a start costs when an account starts sandboxes faster than its plan's free burst. Fees come out of the plan's credits and then the top-ups. The free month pays none: such a start is refused. */
4734
+ /** @description What a start costs when an account starts sandboxes faster than its plan's free burst. Fees come out of the plan's credits and then the top-ups. */
4454
4735
  burstFee: {
4455
4736
  /**
4456
4737
  * @description How long an account's burst meter takes to fall by half. Each start adds its memory to it.
@@ -4468,7 +4749,7 @@ export interface components {
4468
4749
  */
4469
4750
  defaultBudgetMicros: number;
4470
4751
  };
4471
- /** @description Top-ups offered as a choice: credits bought once, on top of a plan. Any other whole number of dollars in topUpRange may be bought too. It is used after the month's credits, and it does not expire. */
4752
+ /** @description Top-ups offered as a choice: credits bought once, on any plan, the free one included. Any other whole number of dollars in topUpRange may be bought too. It is used after the month's credits, and it does not expire. */
4472
4753
  topUps: {
4473
4754
  /** @example topup500 */
4474
4755
  id: string;
@@ -4536,20 +4817,20 @@ export interface components {
4536
4817
  */
4537
4818
  snapshotMicrosPerHour: number;
4538
4819
  };
4539
- /** @description A new account's first month on the $20 plan is free. The card is taken first, and the plan is charged when the days end. Once an account. */
4540
- freeMonth: {
4541
- /** @example 30 */
4542
- days: number;
4820
+ /** @description The free plan: nothing a month, and what it runs is paid from top-ups and its one credit. It needs a card saved, charged nothing: POST /v1/billing/checkout with {"card": true}. */
4821
+ free: {
4822
+ /** @enum {string} */
4823
+ planId: "free";
4543
4824
  /**
4544
- * @description The plan whose first days are free: its credits and its sizes.
4545
- * @example plan20
4825
+ * @description The credit an account on the free plan is given once, when it first saves a card, in millionths of a US dollar. It does not expire.
4826
+ * @example 10000000
4546
4827
  */
4547
- planId: string;
4828
+ creditMicros: number;
4548
4829
  /**
4549
- * @description Small sandboxes the free month runs and starts at once, at most, in place of the plan's runningUnits and freeBurstUnits where those are larger. A tiny counts half.
4550
- * @example 4
4830
+ * @description Small sandboxes the free plan runs and starts at once, at most, until the account has paid for something, a top-up of any size. Then the plan's runningUnits. A tiny counts half.
4831
+ * @example 2
4551
4832
  */
4552
- runningUnits: number;
4833
+ unpaidUnits: number;
4553
4834
  };
4554
4835
  };
4555
4836
  Billing: {
@@ -4562,13 +4843,14 @@ export interface components {
4562
4843
  testMode: boolean;
4563
4844
  /** @description Whether a plan is needed to run a sandbox. False: plans are shown and sold, and nothing is held to them. */
4564
4845
  enforced: boolean;
4565
- /** @description True while this account must start a plan before it uses agental: plans are enforced here, and it has no plan, or the one it had has ended. The console shows the plan choice before anything else while it is. A paused plan, or one whose payment is late, is still a plan. */
4846
+ /** @description True while this account must save a card, or buy a plan, before it uses agental: plans are enforced here, and it is on the free plan with no card saved. The console shows that choice before anything else while it is. */
4566
4847
  needsPlan: boolean;
4567
4848
  /**
4568
- * @description trialing is the plan's free first month, as the payment provider names it. active is a paid month.
4849
+ * @description The subscription to a plan bought by the month, as the payment provider names it. none or canceled: the account is on the free plan.
4569
4850
  * @enum {string}
4570
4851
  */
4571
4852
  status: "none" | "trialing" | "active" | "past_due" | "paused" | "canceled";
4853
+ /** @description The plan the account is on: one bought by the month while it is live, else the free plan. Null where plans are not enforced on it and it has none bought. */
4572
4854
  plan: {
4573
4855
  id: string;
4574
4856
  dollarsPerMonth: number;
@@ -4593,7 +4875,7 @@ export interface components {
4593
4875
  * @description Kept for clients that read it: the free burst in megabytes. Nothing is refused for speed now; a start faster than the free burst costs a fee.
4594
4876
  */
4595
4877
  burst: {
4596
- /** @description The plan's place among the plans, 0 for the $20 plan. */
4878
+ /** @description The plan's place among the plans, 0 for the free plan. */
4597
4879
  tier: number;
4598
4880
  /**
4599
4881
  * @description The plan's free burst, in megabytes: freeBurstUnits times 4096.
@@ -4608,15 +4890,19 @@ export interface components {
4608
4890
  };
4609
4891
  sizes: ("tiny" | "small" | "medium" | "large")[];
4610
4892
  } | null;
4611
- /** @description The month the plan is in, the free month included. */
4893
+ /** @description The month the plan is in. On the free plan, from where its use was last settled against its credits to the next month's start, in UTC. */
4612
4894
  period: {
4613
4895
  start: string;
4614
4896
  end: string;
4615
4897
  } | null;
4616
- /** @description Set while the plan is in its free first month. It is the plan's includedMicros and sizes, running and starting at most freeMonth.runningUnits small sandboxes at once (GET /v1/billing/plans). */
4617
- freeMonth: {
4618
- /** @description When the free days end and the plan is first charged. */
4619
- endsAt: string | null;
4898
+ /** @description Set while the account is on the free plan. */
4899
+ free: {
4900
+ /** @description Whether the account has a card saved, which it must before it runs anything, and so has had its credit. */
4901
+ cardSaved: boolean;
4902
+ /** @description Whether it has paid for anything. Until it has, it runs and starts at most unpaidUnits small sandboxes at once. */
4903
+ paid: boolean;
4904
+ /** @example 2 */
4905
+ unpaidUnits: number;
4620
4906
  } | null;
4621
4907
  includedMicros: number;
4622
4908
  /** @description What has been used this month at list price: running time, mail, stopped sandboxes and snapshots past the free ones. */
@@ -4638,9 +4924,9 @@ export interface components {
4638
4924
  snapshotMicros: number;
4639
4925
  /** @description The part of usedMicros that is burst fees: what starts faster than the plan's free burst cost. GET /v1/burst says where the account stands. */
4640
4926
  burstMicros: number;
4641
- /** @description What an earlier month ran past its plan and its top-ups. This month's credits pay it first, then the top-ups. */
4927
+ /** @description What an earlier month ran past its plan and its top-ups. This month's credits pay it first, then the top-ups. On the free plan, what the account owes now: what it has run past its credits. */
4642
4928
  carriedMicros: number;
4643
- /** @description What is left of the credits bought on top of the plan. It is used after the month's credits, and it does not expire. */
4929
+ /** @description What is left of the credits bought on top of the plan, and of the free plan's credit. It is used after the month's credits, and it does not expire. */
4644
4930
  topUpMicros: number;
4645
4931
  /**
4646
4932
  * @deprecated
@@ -4648,8 +4934,6 @@ export interface components {
4648
4934
  */
4649
4935
  sandboxesAtOnce: number | null;
4650
4936
  cancelAtPeriodEnd: boolean;
4651
- /** @description Whether the account has had its free month. One that has pays for the $20 plan from its first day. */
4652
- hadFreeMonth: boolean;
4653
4937
  canRun: boolean;
4654
4938
  /** @enum {string|null} */
4655
4939
  reason: "billing_required" | "out_of_credit" | null;
@@ -4658,18 +4942,18 @@ export interface components {
4658
4942
  /** @description The top-up charged, in whole US dollars. */
4659
4943
  dollars: number;
4660
4944
  } | null;
4661
- /** @description Whether an auto-reload can be set: Stripe sells here, and the account has bought a plan or a top-up there, which saved its card. */
4945
+ /** @description Whether an auto-reload can be set: Stripe sells here, and the account has saved a card there, or bought a plan or a top-up. */
4662
4946
  canAutoReload: boolean;
4663
- /** @description Set while the account has no plan, or owes for what it used past its plan, and still holds sandboxes or snapshots. The account is emailed when it begins, 7 days before deletesAt and the day before. Starting a plan, paying what is owed, or deleting everything ends it. Null otherwise, and always where plans are not enforced. */
4947
+ /** @description Set while the account has no card saved, or has used its credits, and still holds sandboxes or snapshots. The account is emailed when it begins, 7 days before deletesAt and the day before; the account itself stays open. A top-up that pays what is owed, a card saved, a plan started, or deleting everything ends it. Null otherwise, and always where plans are not enforced. */
4664
4948
  lapse: {
4665
4949
  /**
4666
- * @description no_plan: the account has no plan. unpaid: it has a plan and owes for what it used past the plan's credits and its top-ups, from a month that has closed.
4950
+ * @description no_plan: the account is on the free plan with no card saved. out_of_credit: it is on the free plan and its credits are used. unpaid: it has a plan bought by the month and owes for what it used past the plan's credits and its top-ups, from a month that has closed.
4667
4951
  * @enum {string}
4668
4952
  */
4669
- reason: "no_plan" | "unpaid";
4953
+ reason: "no_plan" | "unpaid" | "out_of_credit";
4670
4954
  /** @description When the account was first seen with no plan, or owing, while it held sandboxes or snapshots. */
4671
4955
  lapsedAt: string;
4672
- /** @description When its sandboxes and snapshots are deleted, with the mail they received, unless a plan is started, or what is owed paid, first. 30 days after lapsedAt. */
4956
+ /** @description When its sandboxes and snapshots are deleted, with the mail they received, unless what is owed is paid, a card saved or a plan started first. 30 days after lapsedAt. */
4673
4957
  deletesAt: string;
4674
4958
  } | null;
4675
4959
  };
@@ -4989,7 +5273,7 @@ export interface components {
4989
5273
  Burst: {
4990
5274
  /** @description Whether the account is held to its plan: a start past the running count is refused, and a fast one costs a fee. False: what it starts is only measured. */
4991
5275
  enforced: boolean;
4992
- /** @description The plan it is on, in its free month or not, or null when it is on none. */
5276
+ /** @description The plan it is on, free included, or null where plans are not enforced on it. */
4993
5277
  plan: string | null;
4994
5278
  /**
4995
5279
  * @description Whose limits it has: its plan's, a plan's we gave it, or, on no plan, the smallest plan's.
@@ -5022,8 +5306,8 @@ export interface components {
5022
5306
  feeMicrosPerGib: number;
5023
5307
  /** @description Whether it may start a sandbox at all now. A plan out of credit may not: GET /v1/billing says why. */
5024
5308
  mayStart: boolean;
5025
- /** @description Whether its plan is in its free month, which pays no burst fees: a start that would cost one is refused. */
5026
- freeMonth: boolean;
5309
+ /** @description Whether it is on the free plan and has paid for nothing yet: until it has, it runs and starts at most free.unpaidUnits small sandboxes at once (GET /v1/billing/plans). */
5310
+ unpaid: boolean;
5027
5311
  /** @description What it has spent on burst fees this month, in millionths of a US dollar. */
5028
5312
  spentMicros: number;
5029
5313
  /** @description The most it spends on burst fees in a month. A start that would go past it is refused with 429 burst_budget_reached. */
@@ -5230,8 +5514,48 @@ export interface operations {
5230
5514
  listSandboxes: {
5231
5515
  parameters: {
5232
5516
  query?: {
5233
- /** @description A tag the sandboxes must have. Sent more than once, they must have each. */
5517
+ /** @description A tag the sandboxes must have. Sent more than once, they must have each; a tag has no commas, and one sent with them is one tag. A template's tags count as the sandbox's own. */
5234
5518
  tag?: string | string[];
5519
+ /** @description A tag the sandboxes must not have. Sent more than once, they must have none of them. */
5520
+ notTag?: string | string[];
5521
+ /** @description A status the sandboxes are in, as the API says it: creating, running, stopped, error, restoring or migrating. Sent more than once, or with commas, any of them. */
5522
+ status?: string | string[];
5523
+ /** @description true for only archived sandboxes, false for none: with status=stopped it parts the archived from the rest. */
5524
+ archived?: string;
5525
+ /** @description A size: tiny, small, medium or large. Sent more than once, or with commas, any of them. */
5526
+ size?: string | string[];
5527
+ /** @description A region. Sent more than once, or with commas, any of them. */
5528
+ region?: string | string[];
5529
+ /** @description A template's ID. Sent more than once, or with commas, any of them. */
5530
+ templateId?: string | string[];
5531
+ /** @description Who made the sandboxes, as createdBy says it. Sent more than once, or with commas, any of them. */
5532
+ createdBy?: string | string[];
5533
+ /** @description Only sandboxes made after this time, in ISO 8601. */
5534
+ createdAfter?: string;
5535
+ /** @description Only sandboxes made before this time, in ISO 8601. */
5536
+ createdBefore?: string;
5537
+ /** @description Only sandboxes stopped before this time, in ISO 8601: a sandbox that is not stopped has no time it stopped. */
5538
+ stoppedBefore?: string;
5539
+ /** @description Only sandboxes whose autoStopAt is before this time, in ISO 8601. */
5540
+ stopsBefore?: string;
5541
+ /** @description never: only sandboxes with no autoStopAt, which every sandbox that is not running is. */
5542
+ stops?: string;
5543
+ /** @description true for only sandboxes stopped with their memory kept, false for the rest. */
5544
+ memoryKept?: string;
5545
+ /** @description An outbound rule: open, blocked or allowlist. Sent more than once, or with commas, any of them. */
5546
+ outbound?: string | string[];
5547
+ /** @description What they are doing: low-cpu, disk-full, memory-full or not-read. Sent more than once, or with commas, any of them. Only where GET /v1/policy says metrics. */
5548
+ activity?: string | string[];
5549
+ /** @description What they are not doing: none of these states. */
5550
+ notActivity?: string | string[];
5551
+ /** @description Text found in the name or the ID, case ignored. */
5552
+ q?: string;
5553
+ /** @description created (the default, oldest first), -created, name, -name, status, -status, stopped or -stopped (a sandbox not stopped last), cost or -cost (what it is charged an hour now), -cpu, -memory or -disk (the busiest or fullest first, those not read last). Only created and -created keep a walk through the pages exact while sandboxes change. */
5554
+ sort?: string;
5555
+ /** @description How many sandboxes one answer holds, 1 to 200. Left out, every sandbox that matches is answered at once. */
5556
+ limit?: string;
5557
+ /** @description The nextCursor of the page before, sent with the same sort and limit. */
5558
+ cursor?: string;
5235
5559
  };
5236
5560
  header?: never;
5237
5561
  path?: never;
@@ -5239,7 +5563,7 @@ export interface operations {
5239
5563
  };
5240
5564
  requestBody?: never;
5241
5565
  responses: {
5242
- /** @description Sandboxes that have not been deleted, and have every tag and metadata value asked for. */
5566
+ /** @description Sandboxes that have not been deleted and match every filter sent. */
5243
5567
  200: {
5244
5568
  headers: {
5245
5569
  [name: string]: unknown;
@@ -5268,53 +5592,397 @@ export interface operations {
5268
5592
  };
5269
5593
  };
5270
5594
  };
5271
- createSandbox: {
5595
+ createSandbox: {
5596
+ parameters: {
5597
+ query?: never;
5598
+ header: {
5599
+ /** @description Idempotency-Key header. Required on create. The same key and body return the original sandbox. A timed-out create is recovered on retry. */
5600
+ "idempotency-key": string;
5601
+ /** @description The most this start may cost in burst fees, in millionths of a US dollar: 0 refuses any fee. A start that would cost more is refused with 429 burst_fee_too_high, which says when it would cost nothing. Left out, it pays what the account's monthly budget allows. See GET /v1/burst. */
5602
+ "agental-max-burst-fee"?: string;
5603
+ };
5604
+ path?: never;
5605
+ cookie?: never;
5606
+ };
5607
+ requestBody: {
5608
+ content: {
5609
+ "application/json": components["schemas"]["CreateSandbox"];
5610
+ };
5611
+ };
5612
+ responses: {
5613
+ /** @description Idempotent replay of a finished create. */
5614
+ 200: {
5615
+ headers: {
5616
+ [name: string]: unknown;
5617
+ };
5618
+ content: {
5619
+ "application/json": components["schemas"]["Sandbox"];
5620
+ };
5621
+ };
5622
+ /** @description Sandbox created and running. With snapshotId, it starts as that snapshot holds the disk. */
5623
+ 201: {
5624
+ headers: {
5625
+ [name: string]: unknown;
5626
+ };
5627
+ content: {
5628
+ "application/json": components["schemas"]["Sandbox"];
5629
+ };
5630
+ };
5631
+ /** @description Not made yet: send the same request again with the same Idempotency-Key in 10 seconds. With sandbox and operation, the create was accepted and its host result is uncertain. With waiting, no server has room for it right now: nothing is made, and a try with the same key places it as soon as there is room, until waiting.until, kept from its first try. After that it is refused with 409 capacity_exceeded. */
5632
+ 202: {
5633
+ headers: {
5634
+ [name: string]: unknown;
5635
+ };
5636
+ content: {
5637
+ "application/json": components["schemas"]["AcceptedCreate"] | components["schemas"]["WaitingCreate"];
5638
+ };
5639
+ };
5640
+ /** @description Invalid request, missing Idempotency-Key, or size_too_small for the snapshot. unsupported_region: there are no servers in the region asked for, and the message names the regions there are. region_mismatch: the region asked for is not the region of the snapshot it has to be made from. ttl_too_long: ttlSeconds, or the template's, is over maxTtlSeconds of GET /v1/policy. invalid_network_policy: an address in network.allow cannot be allowed, and the message says which and why. rule_on_template: network.outbound was sent, and the message says where a rule is set now. */
5641
+ 400: {
5642
+ headers: {
5643
+ [name: string]: unknown;
5644
+ };
5645
+ content: {
5646
+ "application/json": components["schemas"]["Error"];
5647
+ };
5648
+ };
5649
+ /** @description Missing or invalid API key. */
5650
+ 401: {
5651
+ headers: {
5652
+ [name: string]: unknown;
5653
+ };
5654
+ content: {
5655
+ "application/json": components["schemas"]["Error"];
5656
+ };
5657
+ };
5658
+ /** @description billing_required: the account is on the free plan with no card saved. out_of_credit: its credits, the plan's and the top-ups, are used. size_not_on_plan: the plan does not make sandboxes of this size, and the message names the plan that does. Nothing was created. */
5659
+ 402: {
5660
+ headers: {
5661
+ [name: string]: unknown;
5662
+ };
5663
+ content: {
5664
+ "application/json": components["schemas"]["Error"];
5665
+ };
5666
+ };
5667
+ /** @description not_found: there is no such snapshot. */
5668
+ 404: {
5669
+ headers: {
5670
+ [name: string]: unknown;
5671
+ };
5672
+ content: {
5673
+ "application/json": components["schemas"]["Error"];
5674
+ };
5675
+ };
5676
+ /** @description Capacity exceeded, name taken, or idempotency key reused with a different body. too_many_addresses: the template's rule and network.allow come to more than 100 addresses. */
5677
+ 409: {
5678
+ headers: {
5679
+ [name: string]: unknown;
5680
+ };
5681
+ content: {
5682
+ "application/json": components["schemas"]["Error"];
5683
+ };
5684
+ };
5685
+ /** @description This idempotency key already failed. */
5686
+ 422: {
5687
+ headers: {
5688
+ [name: string]: unknown;
5689
+ };
5690
+ content: {
5691
+ "application/json": components["schemas"]["Error"];
5692
+ };
5693
+ };
5694
+ /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. Nothing was created. */
5695
+ 429: {
5696
+ headers: {
5697
+ [name: string]: unknown;
5698
+ };
5699
+ content: {
5700
+ "application/json": components["schemas"]["Error"];
5701
+ };
5702
+ };
5703
+ /** @description The compute host rejected the create. */
5704
+ 500: {
5705
+ headers: {
5706
+ [name: string]: unknown;
5707
+ };
5708
+ content: {
5709
+ "application/json": components["schemas"]["Error"];
5710
+ };
5711
+ };
5712
+ /** @description network_policy_unavailable: network.allow names addresses, or the template holds the sandbox to blocked or an allowlist, where GET /v1/policy says networkPolicy is false. Nothing was created. */
5713
+ 501: {
5714
+ headers: {
5715
+ [name: string]: unknown;
5716
+ };
5717
+ content: {
5718
+ "application/json": components["schemas"]["Error"];
5719
+ };
5720
+ };
5721
+ };
5722
+ };
5723
+ summarizeSandboxes: {
5724
+ parameters: {
5725
+ query?: {
5726
+ /** @description A tag the sandboxes must have. Sent more than once, they must have each; a tag has no commas, and one sent with them is one tag. A template's tags count as the sandbox's own. */
5727
+ tag?: string | string[];
5728
+ /** @description A tag the sandboxes must not have. Sent more than once, they must have none of them. */
5729
+ notTag?: string | string[];
5730
+ /** @description A status the sandboxes are in, as the API says it: creating, running, stopped, error, restoring or migrating. Sent more than once, or with commas, any of them. */
5731
+ status?: string | string[];
5732
+ /** @description true for only archived sandboxes, false for none: with status=stopped it parts the archived from the rest. */
5733
+ archived?: string;
5734
+ /** @description A size: tiny, small, medium or large. Sent more than once, or with commas, any of them. */
5735
+ size?: string | string[];
5736
+ /** @description A region. Sent more than once, or with commas, any of them. */
5737
+ region?: string | string[];
5738
+ /** @description A template's ID. Sent more than once, or with commas, any of them. */
5739
+ templateId?: string | string[];
5740
+ /** @description Who made the sandboxes, as createdBy says it. Sent more than once, or with commas, any of them. */
5741
+ createdBy?: string | string[];
5742
+ /** @description Only sandboxes made after this time, in ISO 8601. */
5743
+ createdAfter?: string;
5744
+ /** @description Only sandboxes made before this time, in ISO 8601. */
5745
+ createdBefore?: string;
5746
+ /** @description Only sandboxes stopped before this time, in ISO 8601: a sandbox that is not stopped has no time it stopped. */
5747
+ stoppedBefore?: string;
5748
+ /** @description Only sandboxes whose autoStopAt is before this time, in ISO 8601. */
5749
+ stopsBefore?: string;
5750
+ /** @description never: only sandboxes with no autoStopAt, which every sandbox that is not running is. */
5751
+ stops?: string;
5752
+ /** @description true for only sandboxes stopped with their memory kept, false for the rest. */
5753
+ memoryKept?: string;
5754
+ /** @description An outbound rule: open, blocked or allowlist. Sent more than once, or with commas, any of them. */
5755
+ outbound?: string | string[];
5756
+ /** @description What they are doing: low-cpu, disk-full, memory-full or not-read. Sent more than once, or with commas, any of them. Only where GET /v1/policy says metrics. */
5757
+ activity?: string | string[];
5758
+ /** @description What they are not doing: none of these states. */
5759
+ notActivity?: string | string[];
5760
+ /** @description Text found in the name or the ID, case ignored. */
5761
+ q?: string;
5762
+ /** @description Fields to count values of, by commas or sent more than once: status, size, region, templateId, tag, outbound, metadataKeys, activity, or metadata.<key>. */
5763
+ facets?: string | string[];
5764
+ };
5765
+ header?: never;
5766
+ path?: never;
5767
+ cookie?: never;
5768
+ };
5769
+ requestBody?: never;
5770
+ responses: {
5771
+ /** @description The sandboxes found, counted and costed. */
5772
+ 200: {
5773
+ headers: {
5774
+ [name: string]: unknown;
5775
+ };
5776
+ content: {
5777
+ "application/json": components["schemas"]["SandboxSummary"];
5778
+ };
5779
+ };
5780
+ /** @description Missing or invalid API key. */
5781
+ 401: {
5782
+ headers: {
5783
+ [name: string]: unknown;
5784
+ };
5785
+ content: {
5786
+ "application/json": components["schemas"]["Error"];
5787
+ };
5788
+ };
5789
+ /** @description Not found. */
5790
+ 404: {
5791
+ headers: {
5792
+ [name: string]: unknown;
5793
+ };
5794
+ content: {
5795
+ "application/json": components["schemas"]["Error"];
5796
+ };
5797
+ };
5798
+ };
5799
+ };
5800
+ previewSandboxJob: {
5801
+ parameters: {
5802
+ query?: never;
5803
+ header?: never;
5804
+ path?: never;
5805
+ cookie?: never;
5806
+ };
5807
+ requestBody: {
5808
+ content: {
5809
+ "application/json": {
5810
+ /** @enum {string} */
5811
+ action: "stop" | "start" | "archive" | "snapshot" | "auto-stop" | "labels" | "delete";
5812
+ options?: {
5813
+ /** @description For stop: keep their memory as well as their disks. */
5814
+ keepMemory?: boolean;
5815
+ /** @description For snapshot: its name, checkpoint when left out. */
5816
+ name?: string;
5817
+ /** @description For auto-stop: the time to stop at, in ISO 8601, or null to take the time limit away. */
5818
+ at?: string | null;
5819
+ /** @description For auto-stop: seconds from now, fixed to a time when the job is made. */
5820
+ inSeconds?: number;
5821
+ /** @description For labels: tags of their own to add. */
5822
+ addTags?: string[];
5823
+ /** @description For labels: tags of their own to take away. One from a template stays, and the item says so. */
5824
+ removeTags?: string[];
5825
+ /** @description For labels: their own metadata to set, a key with null taken away. */
5826
+ metadata?: {
5827
+ [key: string]: string | null;
5828
+ };
5829
+ };
5830
+ select: {
5831
+ /** @description GET /v1/sandboxes's filters, as its query has them. */
5832
+ filter?: {
5833
+ [key: string]: string | string[];
5834
+ };
5835
+ ids?: string[];
5836
+ };
5837
+ };
5838
+ };
5839
+ };
5840
+ responses: {
5841
+ /** @description The sandboxes the job would act on, fixed. */
5842
+ 201: {
5843
+ headers: {
5844
+ [name: string]: unknown;
5845
+ };
5846
+ content: {
5847
+ "application/json": components["schemas"]["SandboxJobPreview"];
5848
+ };
5849
+ };
5850
+ /** @description Missing or invalid API key. */
5851
+ 401: {
5852
+ headers: {
5853
+ [name: string]: unknown;
5854
+ };
5855
+ content: {
5856
+ "application/json": components["schemas"]["Error"];
5857
+ };
5858
+ };
5859
+ /** @description Not found. */
5860
+ 404: {
5861
+ headers: {
5862
+ [name: string]: unknown;
5863
+ };
5864
+ content: {
5865
+ "application/json": components["schemas"]["Error"];
5866
+ };
5867
+ };
5868
+ /** @description nothing_selected: the filter finds no sandbox. */
5869
+ 409: {
5870
+ headers: {
5871
+ [name: string]: unknown;
5872
+ };
5873
+ content: {
5874
+ "application/json": components["schemas"]["Error"];
5875
+ };
5876
+ };
5877
+ };
5878
+ };
5879
+ listSandboxJobs: {
5880
+ parameters: {
5881
+ query?: never;
5882
+ header?: never;
5883
+ path?: never;
5884
+ cookie?: never;
5885
+ };
5886
+ requestBody?: never;
5887
+ responses: {
5888
+ /** @description Jobs. */
5889
+ 200: {
5890
+ headers: {
5891
+ [name: string]: unknown;
5892
+ };
5893
+ content: {
5894
+ "application/json": {
5895
+ jobs: components["schemas"]["SandboxJob"][];
5896
+ };
5897
+ };
5898
+ };
5899
+ /** @description Missing or invalid API key. */
5900
+ 401: {
5901
+ headers: {
5902
+ [name: string]: unknown;
5903
+ };
5904
+ content: {
5905
+ "application/json": components["schemas"]["Error"];
5906
+ };
5907
+ };
5908
+ /** @description Not found. */
5909
+ 404: {
5910
+ headers: {
5911
+ [name: string]: unknown;
5912
+ };
5913
+ content: {
5914
+ "application/json": components["schemas"]["Error"];
5915
+ };
5916
+ };
5917
+ };
5918
+ };
5919
+ createSandboxJob: {
5272
5920
  parameters: {
5273
5921
  query?: never;
5274
- header: {
5275
- /** @description Idempotency-Key header. Required on create. The same key and body return the original sandbox. A timed-out create is recovered on retry. */
5276
- "idempotency-key": string;
5277
- /** @description The most this start may cost in burst fees, in millionths of a US dollar: 0 refuses any fee. A start that would cost more is refused with 429 burst_fee_too_high, which says when it would cost nothing. Left out, it pays what the account's monthly budget allows. See GET /v1/burst. */
5278
- "agental-max-burst-fee"?: string;
5279
- };
5922
+ header?: never;
5280
5923
  path?: never;
5281
5924
  cookie?: never;
5282
5925
  };
5283
5926
  requestBody: {
5284
5927
  content: {
5285
- "application/json": components["schemas"]["CreateSandbox"];
5928
+ "application/json": {
5929
+ previewId?: string;
5930
+ /** @description For delete, required: the count of sandboxes its preview showed. Another count is refused, and nothing is deleted. */
5931
+ confirm?: number;
5932
+ /** @enum {string} */
5933
+ action?: "stop" | "start" | "archive" | "snapshot" | "auto-stop" | "labels" | "delete";
5934
+ options?: {
5935
+ /** @description For stop: keep their memory as well as their disks. */
5936
+ keepMemory?: boolean;
5937
+ /** @description For snapshot: its name, checkpoint when left out. */
5938
+ name?: string;
5939
+ /** @description For auto-stop: the time to stop at, in ISO 8601, or null to take the time limit away. */
5940
+ at?: string | null;
5941
+ /** @description For auto-stop: seconds from now, fixed to a time when the job is made. */
5942
+ inSeconds?: number;
5943
+ /** @description For labels: tags of their own to add. */
5944
+ addTags?: string[];
5945
+ /** @description For labels: tags of their own to take away. One from a template stays, and the item says so. */
5946
+ removeTags?: string[];
5947
+ /** @description For labels: their own metadata to set, a key with null taken away. */
5948
+ metadata?: {
5949
+ [key: string]: string | null;
5950
+ };
5951
+ };
5952
+ ids?: string[];
5953
+ };
5286
5954
  };
5287
5955
  };
5288
5956
  responses: {
5289
- /** @description Idempotent replay of a finished create. */
5290
- 200: {
5957
+ /** @description The job, under way. */
5958
+ 202: {
5291
5959
  headers: {
5292
5960
  [name: string]: unknown;
5293
5961
  };
5294
5962
  content: {
5295
- "application/json": components["schemas"]["Sandbox"];
5963
+ "application/json": components["schemas"]["SandboxJob"];
5296
5964
  };
5297
5965
  };
5298
- /** @description Sandbox created and running. With snapshotId, it starts as that snapshot holds the disk. */
5299
- 201: {
5966
+ /** @description confirm_required: a delete is made with confirm, the count its preview showed. */
5967
+ 400: {
5300
5968
  headers: {
5301
5969
  [name: string]: unknown;
5302
5970
  };
5303
5971
  content: {
5304
- "application/json": components["schemas"]["Sandbox"];
5972
+ "application/json": components["schemas"]["Error"];
5305
5973
  };
5306
5974
  };
5307
- /** @description Create was accepted but the host result is uncertain. Retry the same Idempotency-Key or POST /v1/reconcile. */
5308
- 202: {
5975
+ /** @description Missing or invalid API key. */
5976
+ 401: {
5309
5977
  headers: {
5310
5978
  [name: string]: unknown;
5311
5979
  };
5312
5980
  content: {
5313
- "application/json": components["schemas"]["AcceptedCreate"];
5981
+ "application/json": components["schemas"]["Error"];
5314
5982
  };
5315
5983
  };
5316
- /** @description Invalid request, missing Idempotency-Key, or size_too_small for the snapshot. unsupported_region: there are no servers in the region asked for, and the message names the regions there are. region_mismatch: the region asked for is not the region of the snapshot it has to be made from. ttl_too_long: ttlSeconds, or the template's, is over maxTtlSeconds of GET /v1/policy. invalid_network_policy: an address in network.allow cannot be allowed, and the message says which and why. rule_on_template: network.outbound was sent, and the message says where a rule is set now. */
5317
- 400: {
5984
+ /** @description Not found. */
5985
+ 404: {
5318
5986
  headers: {
5319
5987
  [name: string]: unknown;
5320
5988
  };
@@ -5322,8 +5990,8 @@ export interface operations {
5322
5990
  "application/json": components["schemas"]["Error"];
5323
5991
  };
5324
5992
  };
5325
- /** @description Missing or invalid API key. */
5326
- 401: {
5993
+ /** @description preview_expired: preview again; the set it finds then is the one acted on. confirm_mismatch: confirm is not the count the preview holds; nothing was deleted. */
5994
+ 409: {
5327
5995
  headers: {
5328
5996
  [name: string]: unknown;
5329
5997
  };
@@ -5331,8 +5999,30 @@ export interface operations {
5331
5999
  "application/json": components["schemas"]["Error"];
5332
6000
  };
5333
6001
  };
5334
- /** @description billing_required: the account is on no plan. out_of_credit: the month's credits and the top-ups are used. size_not_on_plan: the plan does not make sandboxes of this size, and the message names the plan that does. Nothing was created. */
5335
- 402: {
6002
+ };
6003
+ };
6004
+ getSandboxJob: {
6005
+ parameters: {
6006
+ query?: never;
6007
+ header?: never;
6008
+ path: {
6009
+ id: string;
6010
+ };
6011
+ cookie?: never;
6012
+ };
6013
+ requestBody?: never;
6014
+ responses: {
6015
+ /** @description The job, its counts and its first problems. */
6016
+ 200: {
6017
+ headers: {
6018
+ [name: string]: unknown;
6019
+ };
6020
+ content: {
6021
+ "application/json": components["schemas"]["SandboxJob"];
6022
+ };
6023
+ };
6024
+ /** @description Missing or invalid API key. */
6025
+ 401: {
5336
6026
  headers: {
5337
6027
  [name: string]: unknown;
5338
6028
  };
@@ -5340,7 +6030,7 @@ export interface operations {
5340
6030
  "application/json": components["schemas"]["Error"];
5341
6031
  };
5342
6032
  };
5343
- /** @description not_found: there is no such snapshot. */
6033
+ /** @description Not found. */
5344
6034
  404: {
5345
6035
  headers: {
5346
6036
  [name: string]: unknown;
@@ -5349,17 +6039,50 @@ export interface operations {
5349
6039
  "application/json": components["schemas"]["Error"];
5350
6040
  };
5351
6041
  };
5352
- /** @description Capacity exceeded, name taken, or idempotency key reused with a different body. too_many_addresses: the template's rule and network.allow come to more than 100 addresses. */
5353
- 409: {
6042
+ };
6043
+ };
6044
+ listSandboxJobItems: {
6045
+ parameters: {
6046
+ query?: {
6047
+ /** @description Only items in this state. */
6048
+ state?: string;
6049
+ /** @description 1 to 200; 100 unless said. */
6050
+ limit?: string;
6051
+ /** @description The nextCursor of the page before. */
6052
+ cursor?: string;
6053
+ };
6054
+ header?: never;
6055
+ path: {
6056
+ id: string;
6057
+ };
6058
+ cookie?: never;
6059
+ };
6060
+ requestBody?: never;
6061
+ responses: {
6062
+ /** @description A page of items. */
6063
+ 200: {
5354
6064
  headers: {
5355
6065
  [name: string]: unknown;
5356
6066
  };
5357
6067
  content: {
5358
- "application/json": components["schemas"]["Error"];
6068
+ "application/json": {
6069
+ items: {
6070
+ id: string;
6071
+ sandboxId: string;
6072
+ state: string;
6073
+ reason: string | null;
6074
+ link: {
6075
+ [key: string]: string;
6076
+ };
6077
+ startedAt: string | null;
6078
+ endedAt: string | null;
6079
+ }[];
6080
+ nextCursor: string | null;
6081
+ };
5359
6082
  };
5360
6083
  };
5361
- /** @description This idempotency key already failed. */
5362
- 422: {
6084
+ /** @description Missing or invalid API key. */
6085
+ 401: {
5363
6086
  headers: {
5364
6087
  [name: string]: unknown;
5365
6088
  };
@@ -5367,8 +6090,8 @@ export interface operations {
5367
6090
  "application/json": components["schemas"]["Error"];
5368
6091
  };
5369
6092
  };
5370
- /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. burst_in_free_month: the start would cost a burst fee, which the free month does not pay. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. Nothing was created. */
5371
- 429: {
6093
+ /** @description Not found. */
6094
+ 404: {
5372
6095
  headers: {
5373
6096
  [name: string]: unknown;
5374
6097
  };
@@ -5376,8 +6099,30 @@ export interface operations {
5376
6099
  "application/json": components["schemas"]["Error"];
5377
6100
  };
5378
6101
  };
5379
- /** @description The compute host rejected the create. */
5380
- 500: {
6102
+ };
6103
+ };
6104
+ cancelSandboxJob: {
6105
+ parameters: {
6106
+ query?: never;
6107
+ header?: never;
6108
+ path: {
6109
+ id: string;
6110
+ };
6111
+ cookie?: never;
6112
+ };
6113
+ requestBody?: never;
6114
+ responses: {
6115
+ /** @description The job. */
6116
+ 200: {
6117
+ headers: {
6118
+ [name: string]: unknown;
6119
+ };
6120
+ content: {
6121
+ "application/json": components["schemas"]["SandboxJob"];
6122
+ };
6123
+ };
6124
+ /** @description Missing or invalid API key. */
6125
+ 401: {
5381
6126
  headers: {
5382
6127
  [name: string]: unknown;
5383
6128
  };
@@ -5385,8 +6130,8 @@ export interface operations {
5385
6130
  "application/json": components["schemas"]["Error"];
5386
6131
  };
5387
6132
  };
5388
- /** @description network_policy_unavailable: network.allow names addresses, or the template holds the sandbox to blocked or an allowlist, where GET /v1/policy says networkPolicy is false. Nothing was created. */
5389
- 501: {
6133
+ /** @description Not found. */
6134
+ 404: {
5390
6135
  headers: {
5391
6136
  [name: string]: unknown;
5392
6137
  };
@@ -5637,7 +6382,7 @@ export interface operations {
5637
6382
  "application/json": components["schemas"]["Error"];
5638
6383
  };
5639
6384
  };
5640
- /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. burst_in_free_month: the start would cost a burst fee, which the free month does not pay. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left stopped. */
6385
+ /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left stopped. */
5641
6386
  429: {
5642
6387
  headers: {
5643
6388
  [name: string]: unknown;
@@ -6293,7 +7038,7 @@ export interface operations {
6293
7038
  "application/json": components["schemas"]["Error"];
6294
7039
  };
6295
7040
  };
6296
- /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. burst_in_free_month: the start would cost a burst fee, which the free month does not pay. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left stopped. */
7041
+ /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left stopped. */
6297
7042
  429: {
6298
7043
  headers: {
6299
7044
  [name: string]: unknown;
@@ -6354,7 +7099,7 @@ export interface operations {
6354
7099
  "application/json": components["schemas"]["Error"];
6355
7100
  };
6356
7101
  };
6357
- /** @description The sandbox was not running, and bringing it back on is a start. running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. burst_in_free_month: the start would cost a burst fee, which the free month does not pay. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left as it was. */
7102
+ /** @description The sandbox was not running, and bringing it back on is a start. running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. It is left as it was. */
6358
7103
  429: {
6359
7104
  headers: {
6360
7105
  [name: string]: unknown;
@@ -6432,7 +7177,7 @@ export interface operations {
6432
7177
  "application/json": components["schemas"]["Error"];
6433
7178
  };
6434
7179
  };
6435
- /** @description billing_required: the account is on no plan. out_of_credit: the month's credits and the top-ups are used. size_not_on_plan: the plan does not make sandboxes of the source's size, and the message names the plan that does. Nothing was forked. */
7180
+ /** @description billing_required: the account is on the free plan with no card saved. out_of_credit: its credits, the plan's and the top-ups, are used. size_not_on_plan: the plan does not make sandboxes of the source's size, and the message names the plan that does. Nothing was forked. */
6436
7181
  402: {
6437
7182
  headers: {
6438
7183
  [name: string]: unknown;
@@ -6468,7 +7213,7 @@ export interface operations {
6468
7213
  "application/json": components["schemas"]["Error"];
6469
7214
  };
6470
7215
  };
6471
- /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. burst_in_free_month: the start would cost a burst fee, which the free month does not pay. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. Nothing was forked. */
7216
+ /** @description running_limit_reached: the account runs as many sandboxes as its plan's runningUnits allows. burst_fee_too_high: the start would cost more in burst fees than the Agental-Max-Burst-Fee header allows. burst_budget_reached: the burst fee would take this month's fees past the account's budget. feeMicros says what the start would have cost; retryAfterSeconds and the Retry-After header say when it would cost nothing. Nothing was forked. */
6472
7217
  429: {
6473
7218
  headers: {
6474
7219
  [name: string]: unknown;
@@ -9576,11 +10321,17 @@ export interface operations {
9576
10321
  organizations: {
9577
10322
  id: string;
9578
10323
  name: string;
10324
+ /** @description Whether it is the caller's own organization. */
9579
10325
  personal: boolean;
9580
10326
  /** @enum {string|null} */
9581
10327
  role: "owner" | "admin" | "member" | null;
9582
- /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use a team. Always false for a person's own. */
10328
+ /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use it. A person's own organization takes members on those plans too, with its person its only owner. */
9583
10329
  membersAllowed: boolean;
10330
+ /**
10331
+ * @description The plan it is on, free included, where the caller may read its bill: their own, or a team they own or are an admin of. Null for a member, or where plans are not kept.
10332
+ * @example plan500
10333
+ */
10334
+ plan: string | null;
9584
10335
  }[];
9585
10336
  closed: components["schemas"]["ClosedAccount"];
9586
10337
  };
@@ -9679,6 +10430,7 @@ export interface operations {
9679
10430
  organizations: {
9680
10431
  id: string;
9681
10432
  name: string;
10433
+ /** @description Whether it is the caller's own organization. Someone else's own, which the caller was invited into, is false, as a team's is. */
9682
10434
  personal: boolean;
9683
10435
  createdAt: string;
9684
10436
  /**
@@ -9686,7 +10438,7 @@ export interface operations {
9686
10438
  * @enum {string|null}
9687
10439
  */
9688
10440
  role: "owner" | "admin" | "member" | null;
9689
- /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use a team. Always false for a person's own. */
10441
+ /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use it. A person's own organization takes members on those plans too, with its person its only owner. */
9690
10442
  membersAllowed: boolean;
9691
10443
  }[];
9692
10444
  };
@@ -9742,6 +10494,7 @@ export interface operations {
9742
10494
  organization: {
9743
10495
  id: string;
9744
10496
  name: string;
10497
+ /** @description Whether it is the caller's own organization. Someone else's own, which the caller was invited into, is false, as a team's is. */
9745
10498
  personal: boolean;
9746
10499
  createdAt: string;
9747
10500
  };
@@ -9760,6 +10513,7 @@ export interface operations {
9760
10513
  organization: {
9761
10514
  id: string;
9762
10515
  name: string;
10516
+ /** @description Whether it is the caller's own organization. Someone else's own, which the caller was invited into, is false, as a team's is. */
9763
10517
  personal: boolean;
9764
10518
  createdAt: string;
9765
10519
  /**
@@ -9767,7 +10521,7 @@ export interface operations {
9767
10521
  * @enum {string|null}
9768
10522
  */
9769
10523
  role: "owner" | "admin" | "member" | null;
9770
- /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use a team. Always false for a person's own. */
10524
+ /** @description Whether its plan lets it have members besides its owners: $500 or $2000, or limits of that level given by hand. Below that, only its owners may use it. A person's own organization takes members on those plans too, with its person its only owner. */
9771
10525
  membersAllowed: boolean;
9772
10526
  };
9773
10527
  /** @enum {boolean} */
@@ -9833,6 +10587,7 @@ export interface operations {
9833
10587
  "application/json": {
9834
10588
  id: string;
9835
10589
  name: string;
10590
+ /** @description Whether it is the caller's own organization. Someone else's own, which the caller was invited into, is false, as a team's is. */
9836
10591
  personal: boolean;
9837
10592
  createdAt: string;
9838
10593
  };
@@ -10900,7 +11655,7 @@ export interface operations {
10900
11655
  "application/json": components["schemas"]["Schedule"];
10901
11656
  };
10902
11657
  };
10903
- /** @description invalid_request: neither every nor cron, both, or one that is not right; an unknown time zone; or a cron that names no time. */
11658
+ /** @description invalid_request: neither every nor cron, both, or one that is not right; an unknown time zone; a cron that names no time; or deleteAfter on a schedule that does not run once. */
10904
11659
  400: {
10905
11660
  headers: {
10906
11661
  [name: string]: unknown;
@@ -10918,7 +11673,7 @@ export interface operations {
10918
11673
  "application/json": components["schemas"]["Error"];
10919
11674
  };
10920
11675
  };
10921
- /** @description key_action_forbidden: a schedule that starts its sandbox, made with a key that may not start and stop it. */
11676
+ /** @description key_action_forbidden: a schedule that starts its sandbox, made with a key that may not start and stop it; or one that deletes it, with a key that may not delete it. */
10922
11677
  403: {
10923
11678
  headers: {
10924
11679
  [name: string]: unknown;
@@ -11043,7 +11798,7 @@ export interface operations {
11043
11798
  };
11044
11799
  };
11045
11800
  responses: {
11046
- /** @description Changed. What was left out is as it was. A change of when it runs, or a resume, sets its next run from now. A run under way goes on as it began. */
11801
+ /** @description Changed. What was left out is as it was. A change of when it runs, or a resume, sets its next run from now. A run under way goes on as it began, save that turning deleteAfter off while it runs keeps its sandbox. */
11047
11802
  200: {
11048
11803
  headers: {
11049
11804
  [name: string]: unknown;
@@ -11129,7 +11884,7 @@ export interface operations {
11129
11884
  "application/json": components["schemas"]["Error"];
11130
11885
  };
11131
11886
  };
11132
- /** @description key_action_forbidden: a schedule that starts its sandbox, run with a key that may not start and stop it. */
11887
+ /** @description key_action_forbidden: a schedule that starts its sandbox, run with a key that may not start and stop it; or one that deletes it, with a key that may not delete it. */
11133
11888
  403: {
11134
11889
  headers: {
11135
11890
  [name: string]: unknown;
@@ -11289,7 +12044,7 @@ export interface operations {
11289
12044
  "application/json": components["schemas"]["Error"];
11290
12045
  };
11291
12046
  };
11292
- /** @description team_not_empty, plan_active, or personal_organization. */
12047
+ /** @description team_not_empty, plan_active, or personal_organization: a person's own organization goes only with their account. */
11293
12048
  409: {
11294
12049
  headers: {
11295
12050
  [name: string]: unknown;
@@ -11317,7 +12072,7 @@ export interface operations {
11317
12072
  };
11318
12073
  };
11319
12074
  responses: {
11320
- /** @description The team, renamed. Only an owner renames it. */
12075
+ /** @description The team, or the caller's own organization, renamed: those invited into it see it by this name. Only an owner renames it. */
11321
12076
  200: {
11322
12077
  headers: {
11323
12078
  [name: string]: unknown;
@@ -11344,15 +12099,6 @@ export interface operations {
11344
12099
  "application/json": components["schemas"]["Error"];
11345
12100
  };
11346
12101
  };
11347
- /** @description personal_organization: a person's own organization keeps its name. */
11348
- 409: {
11349
- headers: {
11350
- [name: string]: unknown;
11351
- };
11352
- content: {
11353
- "application/json": components["schemas"]["Error"];
11354
- };
11355
- };
11356
12102
  };
11357
12103
  };
11358
12104
  listMembers: {
@@ -11441,7 +12187,7 @@ export interface operations {
11441
12187
  "application/json": components["schemas"]["Error"];
11442
12188
  };
11443
12189
  };
11444
- /** @description last_owner. personal_organization. */
12190
+ /** @description last_owner. personal_organization: a person's own organization keeps its person. */
11445
12191
  409: {
11446
12192
  headers: {
11447
12193
  [name: string]: unknown;
@@ -11502,7 +12248,7 @@ export interface operations {
11502
12248
  "application/json": components["schemas"]["Error"];
11503
12249
  };
11504
12250
  };
11505
- /** @description last_owner: a team keeps at least one owner. personal_organization. */
12251
+ /** @description last_owner: a team keeps at least one owner. personal_organization: a person's own organization has one owner, its person. */
11506
12252
  409: {
11507
12253
  headers: {
11508
12254
  [name: string]: unknown;
@@ -11551,7 +12297,7 @@ export interface operations {
11551
12297
  "application/json": components["schemas"]["Error"];
11552
12298
  };
11553
12299
  };
11554
- /** @description personal_organization: the caller acts in their own organization, which has no invites. */
12300
+ /** @description personal_organization: the caller acts in no organization. */
11555
12301
  409: {
11556
12302
  headers: {
11557
12303
  [name: string]: unknown;
@@ -11592,7 +12338,7 @@ export interface operations {
11592
12338
  "application/json": components["schemas"]["Invite"];
11593
12339
  };
11594
12340
  };
11595
- /** @description plan_required: a team has members on the $500 or $2000 plan. role_required, key_action_forbidden. */
12341
+ /** @description plan_required: an organization has members besides its owners on the $500 or $2000 plan, a person's own too. role_required, key_action_forbidden. */
11596
12342
  403: {
11597
12343
  headers: {
11598
12344
  [name: string]: unknown;
@@ -11610,7 +12356,7 @@ export interface operations {
11610
12356
  "application/json": components["schemas"]["Error"];
11611
12357
  };
11612
12358
  };
11613
- /** @description invite_open, already_member, or personal_organization: act in a team first. */
12359
+ /** @description invite_open, already_member, or personal_organization: the caller acts in no organization. */
11614
12360
  409: {
11615
12361
  headers: {
11616
12362
  [name: string]: unknown;
@@ -11797,7 +12543,7 @@ export interface operations {
11797
12543
  };
11798
12544
  };
11799
12545
  responses: {
11800
- /** @description Set. A pool keeps the sandboxes it has: a smaller pool makes no more, and a new template is for sandboxes made from now on. */
12546
+ /** @description Set. A pool keeps the sandboxes it has: a smaller pool makes no more, and a new template is for sandboxes made from now on. A template of another size sends the plain agental jobs queued from now on to the pool of that size. */
11801
12547
  200: {
11802
12548
  headers: {
11803
12549
  [name: string]: unknown;
@@ -13591,140 +14337,6 @@ export interface operations {
13591
14337
  };
13592
14338
  };
13593
14339
  };
13594
- getTemplateRepo: {
13595
- parameters: {
13596
- query?: never;
13597
- header?: never;
13598
- path: {
13599
- id: string;
13600
- };
13601
- cookie?: never;
13602
- };
13603
- requestBody?: never;
13604
- responses: {
13605
- /** @description The repository, or null when there is none. */
13606
- 200: {
13607
- headers: {
13608
- [name: string]: unknown;
13609
- };
13610
- content: {
13611
- "application/json": components["schemas"]["TemplateRepo"] | null;
13612
- };
13613
- };
13614
- /** @description Missing or invalid API key. */
13615
- 401: {
13616
- headers: {
13617
- [name: string]: unknown;
13618
- };
13619
- content: {
13620
- "application/json": components["schemas"]["Error"];
13621
- };
13622
- };
13623
- /** @description Not found. */
13624
- 404: {
13625
- headers: {
13626
- [name: string]: unknown;
13627
- };
13628
- content: {
13629
- "application/json": components["schemas"]["Error"];
13630
- };
13631
- };
13632
- };
13633
- };
13634
- setTemplateRepo: {
13635
- parameters: {
13636
- query?: never;
13637
- header?: never;
13638
- path: {
13639
- id: string;
13640
- };
13641
- cookie?: never;
13642
- };
13643
- requestBody: {
13644
- content: {
13645
- "application/json": {
13646
- name: string;
13647
- url: string;
13648
- };
13649
- };
13650
- };
13651
- responses: {
13652
- /** @description The repository it links to now. */
13653
- 200: {
13654
- headers: {
13655
- [name: string]: unknown;
13656
- };
13657
- content: {
13658
- "application/json": components["schemas"]["TemplateRepo"];
13659
- };
13660
- };
13661
- /** @description invalid_request: the name, path or value is not one that can be kept. invalid_path: the path leads out of the working folder. */
13662
- 400: {
13663
- headers: {
13664
- [name: string]: unknown;
13665
- };
13666
- content: {
13667
- "application/json": components["schemas"]["Error"];
13668
- };
13669
- };
13670
- /** @description Missing or invalid API key. */
13671
- 401: {
13672
- headers: {
13673
- [name: string]: unknown;
13674
- };
13675
- content: {
13676
- "application/json": components["schemas"]["Error"];
13677
- };
13678
- };
13679
- /** @description Not found. */
13680
- 404: {
13681
- headers: {
13682
- [name: string]: unknown;
13683
- };
13684
- content: {
13685
- "application/json": components["schemas"]["Error"];
13686
- };
13687
- };
13688
- };
13689
- };
13690
- deleteTemplateRepo: {
13691
- parameters: {
13692
- query?: never;
13693
- header?: never;
13694
- path: {
13695
- id: string;
13696
- };
13697
- cookie?: never;
13698
- };
13699
- requestBody?: never;
13700
- responses: {
13701
- /** @description The template links to no repository. */
13702
- 204: {
13703
- headers: {
13704
- [name: string]: unknown;
13705
- };
13706
- content?: never;
13707
- };
13708
- /** @description Missing or invalid API key. */
13709
- 401: {
13710
- headers: {
13711
- [name: string]: unknown;
13712
- };
13713
- content: {
13714
- "application/json": components["schemas"]["Error"];
13715
- };
13716
- };
13717
- /** @description Not found. */
13718
- 404: {
13719
- headers: {
13720
- [name: string]: unknown;
13721
- };
13722
- content: {
13723
- "application/json": components["schemas"]["Error"];
13724
- };
13725
- };
13726
- };
13727
- };
13728
14340
  listTemplateSandboxes: {
13729
14341
  parameters: {
13730
14342
  query?: never;
@@ -14556,7 +15168,7 @@ export interface operations {
14556
15168
  "application/json": components["schemas"]["Error"];
14557
15169
  };
14558
15170
  };
14559
- /** @description billing_required: the account has no plan, where plans are required. Start one in the console first; the message gives its address. */
15171
+ /** @description billing_required: the account is on the free plan with no card saved, where plans are required. Save one, or start a plan, in the console first; the message gives its address. */
14560
15172
  402: {
14561
15173
  headers: {
14562
15174
  [name: string]: unknown;
@@ -15124,7 +15736,13 @@ export interface operations {
15124
15736
  content: {
15125
15737
  "application/json": {
15126
15738
  /** @enum {string} */
15127
- plan: "plan20" | "plan100" | "plan500" | "plan2000";
15739
+ plan: "plan100" | "plan500" | "plan2000";
15740
+ } | {
15741
+ /**
15742
+ * @description Save a card for the free plan, charging nothing. Once Stripe says it was saved, the account is given the free plan's credit, once an account and once a card, and may run sandboxes.
15743
+ * @enum {boolean}
15744
+ */
15745
+ card: true;
15128
15746
  } | {
15129
15747
  /** @description How many US dollars to pay for credits: a whole number from 15 to 100000. From 200 on it adds a bonus, see topUpBonus in GET /v1/billing/plans. true is $20, as clients older than the choice send it. */
15130
15748
  topUp: number | true;
@@ -15132,7 +15750,7 @@ export interface operations {
15132
15750
  };
15133
15751
  };
15134
15752
  responses: {
15135
- /** @description Where to send the browser to pay: for a plan, or for a top-up of credits that do not expire. An account that already has a plan and picks another is moved with nothing to pay on a page: url is null and changed is true, and the month's credits are each plan's for the part of the month it holds. A smaller plan is moved to at once, and a bigger one once the payment provider has charged the difference, within seconds. The first $20 plan starts with its first month free. */
15753
+ /** @description Where to send the browser: to save a card for the free plan, charging nothing; to pay for a plan; or for a top-up of credits that do not expire. An account that already has a plan and picks another is moved with nothing to pay on a page: url is null and changed is true, and the month's credits are each plan's for the part of the month it holds. A smaller plan is moved to at once, and a bigger one once the payment provider has charged the difference, within seconds. To go back to the free plan, cancel the plan in the billing portal. */
15136
15754
  200: {
15137
15755
  headers: {
15138
15756
  [name: string]: unknown;
@@ -15141,7 +15759,7 @@ export interface operations {
15141
15759
  "application/json": components["schemas"]["Checkout"];
15142
15760
  };
15143
15761
  };
15144
- /** @description billing_not_configured, already_on_plan, or payment_late: the plan's last payment has not gone through, so it is not changed until it has. */
15762
+ /** @description billing_not_configured, already_on_plan, card_saved: a card is saved already, or payment_late: the plan's last payment has not gone through, so it is not changed until it has. */
15145
15763
  409: {
15146
15764
  headers: {
15147
15765
  [name: string]: unknown;
@@ -15204,7 +15822,7 @@ export interface operations {
15204
15822
  "application/json": components["schemas"]["AutoReload"];
15205
15823
  };
15206
15824
  };
15207
- /** @description billing_not_configured: Stripe does not sell here. no_card: the account has not bought a plan or a top-up at Stripe, so it has no card saved there. */
15825
+ /** @description billing_not_configured: Stripe does not sell here. no_card: the account has no card saved at Stripe: save one, or buy a plan or a top-up. */
15208
15826
  409: {
15209
15827
  headers: {
15210
15828
  [name: string]: unknown;
@@ -15446,7 +16064,7 @@ export interface operations {
15446
16064
  "application/json": components["schemas"]["Error"];
15447
16065
  };
15448
16066
  };
15449
- /** @description billing_required: the account has no plan, where plans are required. The page offers the plans first: see POST /v1/cli-sign-ins/{id}/checkout. */
16067
+ /** @description billing_required: the account is on the free plan with no card saved, where plans are required. The page offers to save one, or a plan, first: see POST /v1/cli-sign-ins/{id}/checkout. */
15450
16068
  402: {
15451
16069
  headers: {
15452
16070
  [name: string]: unknown;
@@ -15506,12 +16124,15 @@ export interface operations {
15506
16124
  content: {
15507
16125
  "application/json": {
15508
16126
  /** @enum {string} */
15509
- plan: "plan20" | "plan100" | "plan500" | "plan2000";
16127
+ plan: "plan100" | "plan500" | "plan2000";
16128
+ } | {
16129
+ /** @enum {boolean} */
16130
+ card: true;
15510
16131
  };
15511
16132
  };
15512
16133
  };
15513
16134
  responses: {
15514
- /** @description Where to send the browser to pay. The first $20 plan starts with its first month free. */
16135
+ /** @description Where to send the browser: to save a card, charging nothing, or to pay for a plan. */
15515
16136
  200: {
15516
16137
  headers: {
15517
16138
  [name: string]: unknown;