@greatwait/contracts 0.1.0-alpha.4 → 0.1.0-alpha.6
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/README.md +1 -1
- package/dist/authority.d.ts +4 -1
- package/dist/authority.js +1 -0
- package/dist/billing.d.ts +231 -1
- package/dist/billing.js +150 -1
- package/dist/callback-safety.js +13 -3
- package/dist/configuration-bounds.d.ts +13 -0
- package/dist/configuration-bounds.js +13 -0
- package/dist/data-export.d.ts +2 -0
- package/dist/delivery.d.ts +26 -0
- package/dist/delivery.js +2 -0
- package/dist/effective-limits.d.ts +40 -0
- package/dist/effective-limits.js +42 -0
- package/dist/endpoints.d.ts +173 -5
- package/dist/endpoints.js +77 -6
- package/dist/first-value-journey.d.ts +1 -1
- package/dist/first-value-journey.js +11 -7
- package/dist/forecast.d.ts +111 -21
- package/dist/forecast.js +87 -24
- package/dist/http-request.d.ts +193 -0
- package/dist/http-request.js +305 -0
- package/dist/identity.d.ts +4 -4
- package/dist/index.d.ts +9 -6
- package/dist/index.js +8 -5
- package/dist/mcp.d.ts +2 -1
- package/dist/mcp.js +1 -1
- package/dist/members.d.ts +141 -0
- package/dist/members.js +223 -0
- package/dist/oauth.d.ts +7 -0
- package/dist/operation-definitions.d.ts +20 -4
- package/dist/operation-definitions.js +9 -1
- package/dist/operational-config.d.ts +101 -0
- package/dist/operational-config.js +341 -0
- package/dist/operations.d.ts +1299 -52
- package/dist/operations.js +466 -32
- package/dist/organization-lifecycle.d.ts +10 -0
- package/dist/partition.d.ts +17 -9
- package/dist/partition.js +3 -3
- package/dist/policy.js +5 -2
- package/dist/problems.d.ts +25 -2
- package/dist/problems.js +49 -1
- package/dist/protocol.d.ts +5 -5
- package/dist/protocol.js +2 -1
- package/dist/scheduling-records.d.ts +226 -0
- package/dist/scheduling-records.js +5 -0
- package/dist/scheduling.d.ts +273 -1
- package/dist/scheduling.js +91 -4
- package/dist/secrets.d.ts +7 -0
- package/dist/tenancy.d.ts +1 -1
- package/dist/tenancy.js +1 -1
- package/dist/usage.js +6 -21
- package/dist/zod-values.d.ts +2 -2
- package/dist/zod-values.js +1 -1
- package/generated/v1/examples/attempts.list.response.json +2 -0
- package/generated/v1/examples/attempts.read.response.json +2 -0
- package/generated/v1/examples/billing.fundingconfirm.response.json +120 -0
- package/generated/v1/examples/billing.invoicehistory.response.json +6 -0
- package/generated/v1/examples/billing.invoices.response.json +15 -0
- package/generated/v1/examples/billing.paymenthistory.response.json +6 -0
- package/generated/v1/examples/billing.paymentmethod.response.json +16 -0
- package/generated/v1/examples/billing.paymentmethodconfirm.request.json +3 -0
- package/generated/v1/examples/billing.paymentmethodconfirm.response.json +16 -0
- package/generated/v1/examples/billing.paymentmethodremove.request.json +3 -0
- package/generated/v1/examples/billing.paymentmethodremove.response.json +4 -0
- package/generated/v1/examples/billing.paymentmethodsetup.request.json +1 -0
- package/generated/v1/examples/billing.paymentmethodsetup.response.json +3 -0
- package/generated/v1/examples/endpoints.ensure.request.json +3 -0
- package/generated/v1/examples/endpoints.ensure.response.json +20 -0
- package/generated/v1/examples/invitations.create.request.json +5 -0
- package/generated/v1/examples/invitations.create.response.json +7 -0
- package/generated/v1/examples/invitations.list.response.json +11 -0
- package/generated/v1/examples/invitations.resend.request.json +1 -0
- package/generated/v1/examples/invitations.resend.response.json +4 -0
- package/generated/v1/examples/invitations.revoke.request.json +3 -0
- package/generated/v1/examples/invitations.revoke.response.json +4 -0
- package/generated/v1/examples/limits.read.response.json +16 -0
- package/generated/v1/examples/members.list.response.json +13 -0
- package/generated/v1/examples/members.remove.request.json +3 -0
- package/generated/v1/examples/members.remove.response.json +4 -0
- package/generated/v1/examples/members.role.request.json +3 -0
- package/generated/v1/examples/members.role.response.json +4 -0
- package/generated/v1/examples/occurrences.redeliver.response.json +2 -0
- package/generated/v1/examples/projectmembers.add.request.json +1 -0
- package/generated/v1/examples/projectmembers.add.response.json +4 -0
- package/generated/v1/examples/projectmembers.remove.request.json +3 -0
- package/generated/v1/examples/projectmembers.remove.response.json +4 -0
- package/generated/v1/first-value-journey.json +24 -8
- package/generated/v1/manifest.json +627 -10
- package/generated/v1/openapi.json +29081 -15663
- package/generated/v1/policy-matrix.json +137 -2
- package/generated/v1/schemas/attempts.list.response.json +15 -0
- package/generated/v1/schemas/attempts.read.response.json +15 -0
- package/generated/v1/schemas/billing.fundingconfirm.response.json +552 -0
- package/generated/v1/schemas/billing.invoicehistory.query.json +16 -0
- package/generated/v1/schemas/billing.invoicehistory.response.json +88 -0
- package/generated/v1/schemas/billing.invoices.response.json +51 -0
- package/generated/v1/schemas/billing.ledger.response.json +5 -0
- package/generated/v1/schemas/billing.notificationsettingsupdate.request.json +24 -17
- package/generated/v1/schemas/billing.paymenthistory.query.json +16 -0
- package/generated/v1/schemas/billing.paymenthistory.response.json +182 -0
- package/generated/v1/schemas/billing.paymentmethod.response.json +137 -0
- package/generated/v1/schemas/billing.paymentmethodconfirm.request.json +14 -0
- package/generated/v1/schemas/billing.paymentmethodconfirm.response.json +137 -0
- package/generated/v1/schemas/billing.paymentmethodremove.request.json +12 -0
- package/generated/v1/schemas/billing.paymentmethodremove.response.json +137 -0
- package/generated/v1/schemas/billing.paymentmethodsetup.request.json +12 -0
- package/generated/v1/schemas/billing.paymentmethodsetup.response.json +11 -0
- package/generated/v1/schemas/billing.purchase.request.json +4 -0
- package/generated/v1/schemas/context.read.response.json +1 -0
- package/generated/v1/schemas/credentials.connection.response.json +1 -0
- package/generated/v1/schemas/credentials.create.request.json +1 -0
- package/generated/v1/schemas/credentials.create.response.json +1 -0
- package/generated/v1/schemas/credentials.list.response.json +1 -0
- package/generated/v1/schemas/credentials.revoke.response.json +1 -0
- package/generated/v1/schemas/credentials.rotate.response.json +2 -0
- package/generated/v1/schemas/endpoints.acknowledgeSigningKeyRotation.response.json +59 -0
- package/generated/v1/schemas/endpoints.create.request.json +74 -0
- package/generated/v1/schemas/endpoints.create.response.json +59 -0
- package/generated/v1/schemas/endpoints.disable.response.json +59 -0
- package/generated/v1/schemas/endpoints.enable.response.json +59 -0
- package/generated/v1/schemas/endpoints.ensure.request.json +91 -0
- package/generated/v1/schemas/endpoints.ensure.response.json +169 -0
- package/generated/v1/schemas/endpoints.list.response.json +59 -0
- package/generated/v1/schemas/endpoints.read.response.json +59 -0
- package/generated/v1/schemas/endpoints.rotateSigningKey.response.json +59 -0
- package/generated/v1/schemas/endpoints.update.request.json +74 -0
- package/generated/v1/schemas/endpoints.update.response.json +59 -0
- package/generated/v1/schemas/forecast.read.request-headers.json +10 -0
- package/generated/v1/schemas/forecast.read.response.json +148 -0
- package/generated/v1/schemas/grants.list.response.json +1 -0
- package/generated/v1/schemas/grants.revoke.response.json +1 -0
- package/generated/v1/schemas/invitations.create.request-headers.json +13 -0
- package/generated/v1/schemas/invitations.create.request.json +24 -0
- package/generated/v1/schemas/invitations.create.response.json +31 -0
- package/generated/v1/schemas/invitations.list.response.json +40 -0
- package/generated/v1/schemas/invitations.resend.request-headers.json +13 -0
- package/generated/v1/schemas/invitations.resend.request.json +6 -0
- package/generated/v1/schemas/invitations.resend.response.json +27 -0
- package/generated/v1/schemas/invitations.revoke.request-headers.json +13 -0
- package/generated/v1/schemas/invitations.revoke.request.json +12 -0
- package/generated/v1/schemas/invitations.revoke.response.json +27 -0
- package/generated/v1/schemas/limits.read.response.json +79 -0
- package/generated/v1/schemas/members.list.response.json +53 -0
- package/generated/v1/schemas/members.remove.request-headers.json +13 -0
- package/generated/v1/schemas/members.remove.request.json +12 -0
- package/generated/v1/schemas/members.remove.response.json +27 -0
- package/generated/v1/schemas/members.role.request-headers.json +13 -0
- package/generated/v1/schemas/members.role.request.json +12 -0
- package/generated/v1/schemas/members.role.response.json +27 -0
- package/generated/v1/schemas/occurrences.redeliver.response.json +15 -0
- package/generated/v1/schemas/projectmembers.add.request-headers.json +13 -0
- package/generated/v1/schemas/projectmembers.add.request.json +6 -0
- package/generated/v1/schemas/projectmembers.add.response.json +27 -0
- package/generated/v1/schemas/projectmembers.remove.request-headers.json +13 -0
- package/generated/v1/schemas/projectmembers.remove.request.json +12 -0
- package/generated/v1/schemas/projectmembers.remove.response.json +27 -0
- package/generated/v1/schemas/schedules.archive.response.json +138 -1
- package/generated/v1/schemas/schedules.cancel.response.json +138 -1
- package/generated/v1/schemas/schedules.create.request.json +150 -1
- package/generated/v1/schemas/schedules.create.response.json +156 -1
- package/generated/v1/schemas/schedules.list.response.json +138 -1
- package/generated/v1/schemas/schedules.pause.response.json +138 -1
- package/generated/v1/schemas/schedules.read.response.json +138 -1
- package/generated/v1/schemas/schedules.replace.request.json +150 -1
- package/generated/v1/schemas/schedules.replace.response.json +156 -1
- package/generated/v1/schemas/schedules.resume.response.json +138 -1
- package/generated/v1/snippets/billing.fundingconfirm.json +6 -0
- package/generated/v1/snippets/billing.invoicehistory.json +6 -0
- package/generated/v1/snippets/billing.invoices.json +6 -0
- package/generated/v1/snippets/billing.notificationsettingsupdate.json +1 -1
- package/generated/v1/snippets/billing.paymenthistory.json +6 -0
- package/generated/v1/snippets/billing.paymentmethod.json +6 -0
- package/generated/v1/snippets/billing.paymentmethodconfirm.json +6 -0
- package/generated/v1/snippets/billing.paymentmethodremove.json +6 -0
- package/generated/v1/snippets/billing.paymentmethodsetup.json +6 -0
- package/generated/v1/snippets/endpoints.create.json +1 -1
- package/generated/v1/snippets/endpoints.ensure.json +6 -0
- package/generated/v1/snippets/forecast.windows.json +1 -1
- package/generated/v1/snippets/invitations.create.json +6 -0
- package/generated/v1/snippets/invitations.list.json +6 -0
- package/generated/v1/snippets/invitations.resend.json +6 -0
- package/generated/v1/snippets/invitations.revoke.json +6 -0
- package/generated/v1/snippets/journey/create-destination.json +1 -1
- package/generated/v1/snippets/limits.read.json +6 -0
- package/generated/v1/snippets/members.list.json +6 -0
- package/generated/v1/snippets/members.remove.json +6 -0
- package/generated/v1/snippets/members.role.json +6 -0
- package/generated/v1/snippets/projectmembers.add.json +6 -0
- package/generated/v1/snippets/projectmembers.remove.json +6 -0
- package/package.json +7 -2
package/dist/operations.d.ts
CHANGED
|
@@ -161,6 +161,15 @@ export interface OperationDefinition {
|
|
|
161
161
|
* scopes every call needs. Generators publish them for consent clients.
|
|
162
162
|
*/
|
|
163
163
|
readonly conditionalScopes?: readonly Scope[];
|
|
164
|
+
/**
|
|
165
|
+
* When `conditionalScopes` apply, as the clause the published description
|
|
166
|
+
* ends with ("… is required as well when …"). Absent means the original
|
|
167
|
+
* case: a target the caller did not create. W9-44 added the second case — a
|
|
168
|
+
* schedule write naming a `url` with no endpoint behind it — and a document
|
|
169
|
+
* describing it with the credential wording would send an integrator
|
|
170
|
+
* looking for somebody else's resource.
|
|
171
|
+
*/
|
|
172
|
+
readonly conditionalScopesWhen?: string;
|
|
164
173
|
/** Problem codes this operation may return, beyond the universal ones. */
|
|
165
174
|
readonly problems: readonly ProblemCode[];
|
|
166
175
|
/**
|
|
@@ -275,20 +284,224 @@ type BillingFundingContract = {
|
|
|
275
284
|
type NamedOperation<TId extends string> = OperationDefinition & {
|
|
276
285
|
readonly id: TId;
|
|
277
286
|
};
|
|
278
|
-
export declare const OPERATIONS: readonly [
|
|
287
|
+
export declare const OPERATIONS: readonly [{
|
|
288
|
+
readonly creates: false;
|
|
289
|
+
readonly description: "" | "Read the verified organization's execution-credit payments with bounded cursor continuation. Existing recent-history responses remain compatible.";
|
|
290
|
+
readonly example: {
|
|
291
|
+
data?: never;
|
|
292
|
+
freshness?: never;
|
|
293
|
+
} | {
|
|
294
|
+
data: never[];
|
|
295
|
+
freshness: {
|
|
296
|
+
kind: string;
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
readonly id: "billing.paymenthistory";
|
|
300
|
+
readonly idempotent: true;
|
|
301
|
+
readonly mcp: {
|
|
302
|
+
readonly destructive: false;
|
|
303
|
+
readonly kind: "tool";
|
|
304
|
+
readonly openWorld: false;
|
|
305
|
+
};
|
|
306
|
+
readonly method: "GET";
|
|
307
|
+
readonly mutates: false;
|
|
308
|
+
readonly path: "/v1/billing/payment-history";
|
|
309
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
310
|
+
readonly problems: readonly ["invalid_request", "service_unavailable"];
|
|
311
|
+
readonly query: import("zod").ZodObject<{
|
|
312
|
+
cursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
313
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
314
|
+
}, import("zod/v4/core").$strip>;
|
|
315
|
+
readonly response: import("zod").ZodObject<{
|
|
316
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
317
|
+
createdAt: import("zod").ZodString;
|
|
318
|
+
credit: import("zod").ZodObject<{
|
|
319
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
320
|
+
microdollars: import("zod").ZodString;
|
|
321
|
+
scale: import("zod").ZodLiteral<6>;
|
|
322
|
+
}, import("zod/v4/core").$strip>;
|
|
323
|
+
gross: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
324
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
325
|
+
microdollars: import("zod").ZodString;
|
|
326
|
+
scale: import("zod").ZodLiteral<6>;
|
|
327
|
+
}, import("zod/v4/core").$strip>>;
|
|
328
|
+
id: import("zod").ZodString;
|
|
329
|
+
kind: import("zod").ZodEnum<{
|
|
330
|
+
manual: "manual";
|
|
331
|
+
automatic: "automatic";
|
|
332
|
+
}>;
|
|
333
|
+
paymentUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
334
|
+
reason: import("zod").ZodOptional<import("zod").ZodString>;
|
|
335
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
336
|
+
state: import("zod").ZodEnum<{
|
|
337
|
+
pending: "pending";
|
|
338
|
+
paid: "paid";
|
|
339
|
+
failed: "failed";
|
|
340
|
+
"authentication-required": "authentication-required";
|
|
341
|
+
"action-required": "action-required";
|
|
342
|
+
canceled: "canceled";
|
|
343
|
+
refunded: "refunded";
|
|
344
|
+
reversed: "reversed";
|
|
345
|
+
disputed: "disputed";
|
|
346
|
+
}>;
|
|
347
|
+
tax: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
348
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
349
|
+
microdollars: import("zod").ZodString;
|
|
350
|
+
scale: import("zod").ZodLiteral<6>;
|
|
351
|
+
}, import("zod/v4/core").$strip>>;
|
|
352
|
+
taxStatus: import("zod").ZodEnum<{
|
|
353
|
+
confirmed: "confirmed";
|
|
354
|
+
"calculated-at-checkout": "calculated-at-checkout";
|
|
355
|
+
}>;
|
|
356
|
+
updatedAt: import("zod").ZodString;
|
|
357
|
+
}, import("zod/v4/core").$strict>>;
|
|
358
|
+
freshness: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
359
|
+
kind: import("zod").ZodLiteral<"authoritative">;
|
|
360
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
361
|
+
asOf: import("zod").ZodString;
|
|
362
|
+
kind: import("zod").ZodLiteral<"projected">;
|
|
363
|
+
lagSeconds: import("zod").ZodNumber;
|
|
364
|
+
}, import("zod/v4/core").$strip>], "kind">;
|
|
365
|
+
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
366
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
367
|
+
readonly scopes: readonly ["usage:read"];
|
|
368
|
+
readonly sessionAuthority: "headers";
|
|
369
|
+
readonly summary: "" | "Page execution-credit payments";
|
|
370
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
371
|
+
}, {
|
|
372
|
+
readonly creates: false;
|
|
373
|
+
readonly description: "" | "Read the verified organization's project subscription invoices with bounded cursor continuation. Existing recent-history responses remain compatible.";
|
|
374
|
+
readonly example: {
|
|
375
|
+
data?: never;
|
|
376
|
+
freshness?: never;
|
|
377
|
+
} | {
|
|
378
|
+
data: never[];
|
|
379
|
+
freshness: {
|
|
380
|
+
kind: string;
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
readonly id: "billing.invoicehistory";
|
|
384
|
+
readonly idempotent: true;
|
|
385
|
+
readonly mcp: {
|
|
386
|
+
readonly destructive: false;
|
|
387
|
+
readonly kind: "tool";
|
|
388
|
+
readonly openWorld: false;
|
|
389
|
+
};
|
|
390
|
+
readonly method: "GET";
|
|
391
|
+
readonly mutates: false;
|
|
392
|
+
readonly path: "/v1/billing/invoice-history";
|
|
393
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
394
|
+
readonly problems: readonly ["invalid_request", "service_unavailable"];
|
|
395
|
+
readonly query: import("zod").ZodObject<{
|
|
396
|
+
cursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
397
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
398
|
+
}, import("zod/v4/core").$strip>;
|
|
399
|
+
readonly response: import("zod").ZodObject<{
|
|
400
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
401
|
+
id: import("zod").ZodString;
|
|
402
|
+
createdAt: import("zod").ZodString;
|
|
403
|
+
amount: import("zod").ZodObject<{
|
|
404
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
405
|
+
microdollars: import("zod").ZodString;
|
|
406
|
+
scale: import("zod").ZodLiteral<6>;
|
|
407
|
+
}, import("zod/v4/core").$strip>;
|
|
408
|
+
state: import("zod").ZodEnum<{
|
|
409
|
+
void: "void";
|
|
410
|
+
paid: "paid";
|
|
411
|
+
open: "open";
|
|
412
|
+
uncollectible: "uncollectible";
|
|
413
|
+
}>;
|
|
414
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
415
|
+
}, import("zod/v4/core").$strict>>;
|
|
416
|
+
freshness: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
417
|
+
kind: import("zod").ZodLiteral<"authoritative">;
|
|
418
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
419
|
+
asOf: import("zod").ZodString;
|
|
420
|
+
kind: import("zod").ZodLiteral<"projected">;
|
|
421
|
+
lagSeconds: import("zod").ZodNumber;
|
|
422
|
+
}, import("zod/v4/core").$strip>], "kind">;
|
|
423
|
+
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
424
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
425
|
+
readonly scopes: readonly ["usage:read"];
|
|
426
|
+
readonly sessionAuthority: "headers";
|
|
427
|
+
readonly summary: "" | "Page project subscription invoices";
|
|
428
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
429
|
+
}, OperationDefinition & {
|
|
279
430
|
readonly id: "exports.create";
|
|
431
|
+
} & {
|
|
432
|
+
readonly request: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
|
|
280
433
|
}, OperationDefinition & {
|
|
281
434
|
readonly id: "exports.read";
|
|
282
435
|
}, OperationDefinition & {
|
|
283
436
|
readonly id: "exports.part";
|
|
284
437
|
}, OperationDefinition & {
|
|
285
438
|
readonly id: "exports.cancel";
|
|
439
|
+
}, OperationDefinition & {
|
|
440
|
+
readonly id: "members.list";
|
|
441
|
+
}, OperationDefinition & {
|
|
442
|
+
readonly id: "invitations.list";
|
|
443
|
+
}, OperationDefinition & {
|
|
444
|
+
readonly id: "invitations.create";
|
|
445
|
+
} & {
|
|
446
|
+
readonly request: import("zod").ZodObject<{
|
|
447
|
+
email: import("zod").ZodString;
|
|
448
|
+
role: import("zod").ZodEnum<{
|
|
449
|
+
admin: "admin";
|
|
450
|
+
member: "member";
|
|
451
|
+
}>;
|
|
452
|
+
projects: import("zod").ZodArray<import("zod").ZodString>;
|
|
453
|
+
}, import("zod/v4/core").$strict>;
|
|
454
|
+
}, OperationDefinition & {
|
|
455
|
+
readonly id: "invitations.resend";
|
|
456
|
+
} & {
|
|
457
|
+
readonly request: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
|
|
458
|
+
}, OperationDefinition & {
|
|
459
|
+
readonly id: "invitations.revoke";
|
|
460
|
+
} & {
|
|
461
|
+
readonly request: import("zod").ZodObject<{
|
|
462
|
+
confirmed: import("zod").ZodLiteral<true>;
|
|
463
|
+
}, import("zod/v4/core").$strict>;
|
|
464
|
+
}, OperationDefinition & {
|
|
465
|
+
readonly id: "members.role";
|
|
466
|
+
} & {
|
|
467
|
+
readonly request: import("zod").ZodObject<{
|
|
468
|
+
role: import("zod").ZodEnum<{
|
|
469
|
+
admin: "admin";
|
|
470
|
+
member: "member";
|
|
471
|
+
}>;
|
|
472
|
+
}, import("zod/v4/core").$strict>;
|
|
473
|
+
}, OperationDefinition & {
|
|
474
|
+
readonly id: "members.remove";
|
|
475
|
+
} & {
|
|
476
|
+
readonly request: import("zod").ZodObject<{
|
|
477
|
+
confirmed: import("zod").ZodLiteral<true>;
|
|
478
|
+
}, import("zod/v4/core").$strict>;
|
|
479
|
+
}, OperationDefinition & {
|
|
480
|
+
readonly id: "projectmembers.add";
|
|
481
|
+
} & {
|
|
482
|
+
readonly request: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
|
|
483
|
+
}, OperationDefinition & {
|
|
484
|
+
readonly id: "projectmembers.remove";
|
|
485
|
+
} & {
|
|
486
|
+
readonly request: import("zod").ZodObject<{
|
|
487
|
+
confirmed: import("zod").ZodLiteral<true>;
|
|
488
|
+
}, import("zod/v4/core").$strict>;
|
|
286
489
|
}, OperationDefinition & {
|
|
287
490
|
readonly id: "organizations.lifecycle";
|
|
288
491
|
}, OperationDefinition & {
|
|
289
492
|
readonly id: "organizations.close";
|
|
493
|
+
} & {
|
|
494
|
+
readonly request: import("zod").ZodObject<{
|
|
495
|
+
expectedGeneration: import("zod").ZodNumber;
|
|
496
|
+
immediate: import("zod").ZodBoolean;
|
|
497
|
+
confirmation: import("zod").ZodLiteral<"delete organization">;
|
|
498
|
+
}, import("zod/v4/core").$strict>;
|
|
290
499
|
}, OperationDefinition & {
|
|
291
500
|
readonly id: "organizations.restore";
|
|
501
|
+
} & {
|
|
502
|
+
readonly request: import("zod").ZodObject<{
|
|
503
|
+
expectedGeneration: import("zod").ZodNumber;
|
|
504
|
+
}, import("zod/v4/core").$strict>;
|
|
292
505
|
}, {
|
|
293
506
|
readonly creates: false;
|
|
294
507
|
readonly description: "" | "Reports the service, environment, and build the request reached. Unauthenticated: it carries no customer data and is used by canaries and deployment smoke checks.";
|
|
@@ -443,7 +656,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
443
656
|
readonly surfaces: readonly ["mock"];
|
|
444
657
|
}, {
|
|
445
658
|
readonly creates: true;
|
|
446
|
-
readonly description: "" | "Creates a reusable callback endpoint in the caller's project and environment. The destination must be HTTPS on effective port 443, contain no URL credentials or fragment, and resolve only to public unicast addresses. The endpoint is active and usable the moment it exists; there is nothing to verify. A disabled endpoint is never delivered to, and a schedule write naming one answers not_found, because disabling is terminal rather than a state to recover from. The per-endpoint secret is returned
|
|
659
|
+
readonly description: "" | "Creates a reusable callback endpoint in the caller's project and environment. The destination must be HTTPS on effective port 443, contain no URL credentials or fragment, and resolve only to public unicast addresses. The endpoint is active and usable the moment it exists; there is nothing to verify. A disabled endpoint is never delivered to, and a schedule write naming one answers not_found, because disabling is terminal rather than a state to recover from. The per-endpoint secret is returned to this call and to no other call an API credential or an OAuth token can make; a signed-in member can read it again through endpoints.revealSigningSecret. There is no endpoint-count ceiling. Disabled endpoints remain readable for audit; request and DNS inspection admission bound creation work and reads are paged. Optional `headers` set reusable defaults. Ordinary values remain readable; `secret: true` encrypts a write-only value that is never returned. Header edits use explicit `set`, `keep`, and `remove` actions.";
|
|
447
660
|
readonly example: {
|
|
448
661
|
createdAt?: never;
|
|
449
662
|
environmentKind?: never;
|
|
@@ -477,7 +690,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
477
690
|
readonly idempotent: false;
|
|
478
691
|
readonly mcp: {
|
|
479
692
|
readonly kind: "unavailable";
|
|
480
|
-
readonly reason: "Creation returns a one-time endpoint signing secret, and MCP has no negotiated secure-result channel that can keep it out of ordinary tool history.";
|
|
693
|
+
readonly reason: "Creation returns a one-time endpoint signing secret, and MCP has no negotiated secure-result channel that can keep it out of ordinary tool history. Agents use endpoints_ensure, or schedules_create with a `url`, which create an endpoint without returning its secret.";
|
|
481
694
|
};
|
|
482
695
|
readonly method: "POST";
|
|
483
696
|
readonly mutates: true;
|
|
@@ -485,6 +698,21 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
485
698
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
486
699
|
readonly problems: readonly ["state_conflict", "invalid_request", "plan_limit_reached", "rate_limited"];
|
|
487
700
|
readonly request: import("zod").ZodObject<{
|
|
701
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
702
|
+
action: import("zod").ZodLiteral<"set">;
|
|
703
|
+
name: import("zod").ZodString;
|
|
704
|
+
value: import("zod").ZodString;
|
|
705
|
+
secret: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
706
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
707
|
+
action: import("zod").ZodLiteral<"keep">;
|
|
708
|
+
name: import("zod").ZodString;
|
|
709
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
710
|
+
action: import("zod").ZodLiteral<"remove">;
|
|
711
|
+
name: import("zod").ZodString;
|
|
712
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
713
|
+
action: import("zod").ZodLiteral<"suppress">;
|
|
714
|
+
name: import("zod").ZodString;
|
|
715
|
+
}, import("zod/v4/core").$strict>], "action">>>;
|
|
488
716
|
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
489
717
|
url: import("zod").ZodString;
|
|
490
718
|
}, import("zod/v4/core").$strip>;
|
|
@@ -494,6 +722,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
494
722
|
url: string;
|
|
495
723
|
};
|
|
496
724
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
725
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
726
|
+
name: import("zod").ZodString;
|
|
727
|
+
secret: import("zod").ZodLiteral<false>;
|
|
728
|
+
value: import("zod").ZodString;
|
|
729
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
730
|
+
name: import("zod").ZodString;
|
|
731
|
+
secret: import("zod").ZodLiteral<true>;
|
|
732
|
+
configured: import("zod").ZodLiteral<true>;
|
|
733
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
734
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
735
|
+
name: import("zod").ZodString;
|
|
736
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
737
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
497
738
|
createdAt: import("zod").ZodString;
|
|
498
739
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
499
740
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -526,6 +767,127 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
526
767
|
readonly sessionAuthority: "headers";
|
|
527
768
|
readonly summary: "" | "Create a callback endpoint";
|
|
528
769
|
readonly surfaces: readonly ["api", "mock"];
|
|
770
|
+
}, {
|
|
771
|
+
readonly creates: false;
|
|
772
|
+
readonly description: "" | "Finds or creates the callback endpoint at a URL in the caller's project and environment, without returning its signing secret. With no `name`, an existing endpoint that is not disabled at exactly this address is returned unchanged, preferring the one named after its URL; with a `name`, the endpoint must also carry that name. Otherwise one is created under the same rules as endpoints.create — HTTPS on effective port 443, no URL credentials or fragment, resolving only to public unicast addresses — and `created` is true. Optional `headers` apply only to an endpoint this call creates. Sent when the endpoint already exists, they are accepted if they are exactly its ordinary headers — what a retry of the creating call sends — and otherwise refused as `state_conflict` naming it; endpoints.update changes them. A secret value cannot be compared, so a call carrying one is refused for an endpoint that already exists. The result is metadata only: `signingSecret` says that the secret is not returned and where a signed-in member reveals it (`revealUrl`, the endpoint's dashboard page). Every callback is signed with that secret whether or not the receiver checks it. This is the endpoint operation agents use over MCP; endpoints.create, which returns the secret once, is withheld there.";
|
|
773
|
+
readonly example: {
|
|
774
|
+
created?: never;
|
|
775
|
+
createdAt?: never;
|
|
776
|
+
environmentKind?: never;
|
|
777
|
+
id?: never;
|
|
778
|
+
name?: never;
|
|
779
|
+
project?: never;
|
|
780
|
+
signingKeys?: never;
|
|
781
|
+
signingSecret?: never;
|
|
782
|
+
status?: never;
|
|
783
|
+
updatedAt?: never;
|
|
784
|
+
url?: never;
|
|
785
|
+
version?: never;
|
|
786
|
+
} | {
|
|
787
|
+
created: boolean;
|
|
788
|
+
createdAt: string;
|
|
789
|
+
environmentKind: string;
|
|
790
|
+
id: string;
|
|
791
|
+
name: string;
|
|
792
|
+
project: string;
|
|
793
|
+
signingKeys: {
|
|
794
|
+
current: string;
|
|
795
|
+
};
|
|
796
|
+
signingSecret: {
|
|
797
|
+
guidance: string;
|
|
798
|
+
returned: boolean;
|
|
799
|
+
revealUrl: string;
|
|
800
|
+
};
|
|
801
|
+
status: string;
|
|
802
|
+
updatedAt: string;
|
|
803
|
+
url: string;
|
|
804
|
+
version: number;
|
|
805
|
+
};
|
|
806
|
+
readonly id: "endpoints.ensure";
|
|
807
|
+
readonly idempotent: true;
|
|
808
|
+
readonly mcp: {
|
|
809
|
+
readonly destructive: false;
|
|
810
|
+
readonly kind: "tool";
|
|
811
|
+
readonly openWorld: true;
|
|
812
|
+
};
|
|
813
|
+
readonly method: "POST";
|
|
814
|
+
readonly mutates: true;
|
|
815
|
+
readonly path: "/v1/endpoints/ensure";
|
|
816
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
817
|
+
readonly problems: readonly ["state_conflict", "invalid_request", "plan_limit_reached", "rate_limited"];
|
|
818
|
+
readonly request: import("zod").ZodObject<{
|
|
819
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
820
|
+
action: import("zod").ZodLiteral<"set">;
|
|
821
|
+
name: import("zod").ZodString;
|
|
822
|
+
value: import("zod").ZodString;
|
|
823
|
+
secret: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
824
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
825
|
+
action: import("zod").ZodLiteral<"keep">;
|
|
826
|
+
name: import("zod").ZodString;
|
|
827
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
828
|
+
action: import("zod").ZodLiteral<"remove">;
|
|
829
|
+
name: import("zod").ZodString;
|
|
830
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
831
|
+
action: import("zod").ZodLiteral<"suppress">;
|
|
832
|
+
name: import("zod").ZodString;
|
|
833
|
+
}, import("zod/v4/core").$strict>], "action">>>;
|
|
834
|
+
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
835
|
+
url: import("zod").ZodString;
|
|
836
|
+
}, import("zod/v4/core").$strip>;
|
|
837
|
+
readonly requestExample: {
|
|
838
|
+
url?: never;
|
|
839
|
+
} | {
|
|
840
|
+
url: string;
|
|
841
|
+
};
|
|
842
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
843
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
844
|
+
name: import("zod").ZodString;
|
|
845
|
+
secret: import("zod").ZodLiteral<false>;
|
|
846
|
+
value: import("zod").ZodString;
|
|
847
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
848
|
+
name: import("zod").ZodString;
|
|
849
|
+
secret: import("zod").ZodLiteral<true>;
|
|
850
|
+
configured: import("zod").ZodLiteral<true>;
|
|
851
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
852
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
853
|
+
name: import("zod").ZodString;
|
|
854
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
855
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
856
|
+
createdAt: import("zod").ZodString;
|
|
857
|
+
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
858
|
+
environmentKind: import("zod").ZodEnum<{
|
|
859
|
+
test: "test";
|
|
860
|
+
live: "live";
|
|
861
|
+
}>;
|
|
862
|
+
id: import("zod").ZodString;
|
|
863
|
+
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
864
|
+
project: import("zod").ZodString;
|
|
865
|
+
signingKeys: import("zod").ZodObject<{
|
|
866
|
+
current: import("zod").ZodString;
|
|
867
|
+
next: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
868
|
+
acknowledgedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
869
|
+
id: import("zod").ZodString;
|
|
870
|
+
overlapEndsAt: import("zod").ZodString;
|
|
871
|
+
}, import("zod/v4/core").$strip>>;
|
|
872
|
+
}, import("zod/v4/core").$strip>;
|
|
873
|
+
status: import("zod").ZodEnum<{
|
|
874
|
+
disabled: "disabled";
|
|
875
|
+
active: "active";
|
|
876
|
+
}>;
|
|
877
|
+
updatedAt: import("zod").ZodString;
|
|
878
|
+
url: import("zod").ZodString;
|
|
879
|
+
version: import("zod").ZodNumber;
|
|
880
|
+
created: import("zod").ZodBoolean;
|
|
881
|
+
signingSecret: import("zod").ZodObject<{
|
|
882
|
+
guidance: import("zod").ZodString;
|
|
883
|
+
returned: import("zod").ZodLiteral<false>;
|
|
884
|
+
revealUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
885
|
+
}, import("zod/v4/core").$strip>;
|
|
886
|
+
}, import("zod/v4/core").$strip>;
|
|
887
|
+
readonly scopes: readonly ["endpoints:write"];
|
|
888
|
+
readonly sessionAuthority: "headers";
|
|
889
|
+
readonly summary: "" | "Find or create a callback endpoint by URL";
|
|
890
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
529
891
|
}, {
|
|
530
892
|
readonly creates: false;
|
|
531
893
|
readonly description: "" | "Lists the caller's callback endpoints for exactly its own project and environment. The result is authoritative and metadata-only: no signing secret or sealed key material has a field in this shape.";
|
|
@@ -568,6 +930,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
568
930
|
}, import("zod/v4/core").$strip>;
|
|
569
931
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
570
932
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
933
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
934
|
+
name: import("zod").ZodString;
|
|
935
|
+
secret: import("zod").ZodLiteral<false>;
|
|
936
|
+
value: import("zod").ZodString;
|
|
937
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
938
|
+
name: import("zod").ZodString;
|
|
939
|
+
secret: import("zod").ZodLiteral<true>;
|
|
940
|
+
configured: import("zod").ZodLiteral<true>;
|
|
941
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
942
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
943
|
+
name: import("zod").ZodString;
|
|
944
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
945
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
571
946
|
createdAt: import("zod").ZodString;
|
|
572
947
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
573
948
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -654,6 +1029,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
654
1029
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
655
1030
|
readonly problems: readonly ["invalid_request", "not_found"];
|
|
656
1031
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
1032
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1033
|
+
name: import("zod").ZodString;
|
|
1034
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1035
|
+
value: import("zod").ZodString;
|
|
1036
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1037
|
+
name: import("zod").ZodString;
|
|
1038
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1039
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1040
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1041
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1042
|
+
name: import("zod").ZodString;
|
|
1043
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1044
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
657
1045
|
createdAt: import("zod").ZodString;
|
|
658
1046
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
659
1047
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -688,7 +1076,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
688
1076
|
ETag: import("zod").ZodString;
|
|
689
1077
|
}, import("zod/v4/core").$strip>;
|
|
690
1078
|
readonly creates: false;
|
|
691
|
-
readonly description: "" | "Replaces an endpoint's destination after applying the complete URL and DNS policy, and renames it when a name is given.
|
|
1079
|
+
readonly description: "" | "Replaces an endpoint's destination after applying the complete URL and DNS policy, and renames it when a name is given. Optional `headers` patch endpoint defaults with `set`, `keep`, or `remove`; omitted headers preserve them. A secret value can be retained, replaced (including an empty string), or removed, but cannot be revealed. Header and destination edits apply to newly admitted attempts, including retries; recovery of the same admitted attempt keeps its snapshot. Disabled endpoints cannot be updated. Send If-Match with the version the endpoint was read at to be refused rather than overwrite a destination somebody else changed in the meantime.";
|
|
692
1080
|
readonly example: {
|
|
693
1081
|
createdAt?: never;
|
|
694
1082
|
environmentKind?: never;
|
|
@@ -725,6 +1113,21 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
725
1113
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
726
1114
|
readonly problems: readonly ["invalid_request", "not_found", "rate_limited", "state_conflict", "version_conflict"];
|
|
727
1115
|
readonly request: import("zod").ZodObject<{
|
|
1116
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
1117
|
+
action: import("zod").ZodLiteral<"set">;
|
|
1118
|
+
name: import("zod").ZodString;
|
|
1119
|
+
value: import("zod").ZodString;
|
|
1120
|
+
secret: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1121
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1122
|
+
action: import("zod").ZodLiteral<"keep">;
|
|
1123
|
+
name: import("zod").ZodString;
|
|
1124
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1125
|
+
action: import("zod").ZodLiteral<"remove">;
|
|
1126
|
+
name: import("zod").ZodString;
|
|
1127
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1128
|
+
action: import("zod").ZodLiteral<"suppress">;
|
|
1129
|
+
name: import("zod").ZodString;
|
|
1130
|
+
}, import("zod/v4/core").$strict>], "action">>>;
|
|
728
1131
|
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
729
1132
|
url: import("zod").ZodString;
|
|
730
1133
|
}, import("zod/v4/core").$strip>;
|
|
@@ -737,6 +1140,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
737
1140
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
738
1141
|
}, import("zod/v4/core").$strip>;
|
|
739
1142
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
1143
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1144
|
+
name: import("zod").ZodString;
|
|
1145
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1146
|
+
value: import("zod").ZodString;
|
|
1147
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1148
|
+
name: import("zod").ZodString;
|
|
1149
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1150
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1151
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1152
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1153
|
+
name: import("zod").ZodString;
|
|
1154
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1155
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
740
1156
|
createdAt: import("zod").ZodString;
|
|
741
1157
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
742
1158
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -771,7 +1187,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
771
1187
|
ETag: import("zod").ZodString;
|
|
772
1188
|
}, import("zod/v4/core").$strip>;
|
|
773
1189
|
readonly creates: true;
|
|
774
|
-
readonly description: "" | "Creates the next endpoint signing key and selects it immediately for new deliveries while retaining the current key in the receiver acceptance set for a bounded overlap. The overlap defaults to and cannot exceed 24 hours. A second rotation is refused until the current overlap ends. The new secret is returned once
|
|
1190
|
+
readonly description: "" | "Creates the next endpoint signing key and selects it immediately for new deliveries while retaining the current key in the receiver acceptance set for a bounded overlap. The overlap defaults to and cannot exceed 24 hours. A second rotation is refused until the current overlap ends. The new secret is returned once to this call, so a call whose answer was never read has rotated a key the caller does not hold. It is recoverable: a signed-in member can read both keys, and the instant the overlap ends, through endpoints.revealSigningSecret. An API credential or an OAuth token cannot, so an integration that loses the answer needs a member to read it back rather than a second rotation, which is refused until the overlap ends. Send If-Match with the version the endpoint was read at to be refused rather than rotate an endpoint that has changed since.";
|
|
775
1191
|
readonly example: {
|
|
776
1192
|
endpoint?: never;
|
|
777
1193
|
keyId?: never;
|
|
@@ -823,6 +1239,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
823
1239
|
}, import("zod/v4/core").$strip>;
|
|
824
1240
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
825
1241
|
endpoint: import("zod").ZodObject<{
|
|
1242
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1243
|
+
name: import("zod").ZodString;
|
|
1244
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1245
|
+
value: import("zod").ZodString;
|
|
1246
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1247
|
+
name: import("zod").ZodString;
|
|
1248
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1249
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1250
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1251
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1252
|
+
name: import("zod").ZodString;
|
|
1253
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1254
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
826
1255
|
createdAt: import("zod").ZodString;
|
|
827
1256
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
828
1257
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -905,6 +1334,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
905
1334
|
"If-Match": import("zod").ZodString;
|
|
906
1335
|
}, import("zod/v4/core").$strip>;
|
|
907
1336
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
1337
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1338
|
+
name: import("zod").ZodString;
|
|
1339
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1340
|
+
value: import("zod").ZodString;
|
|
1341
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1342
|
+
name: import("zod").ZodString;
|
|
1343
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1344
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1345
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1346
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1347
|
+
name: import("zod").ZodString;
|
|
1348
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1349
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
908
1350
|
createdAt: import("zod").ZodString;
|
|
909
1351
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
910
1352
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -1018,6 +1460,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
1018
1460
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
1019
1461
|
readonly problems: readonly ["invalid_request", "not_found"];
|
|
1020
1462
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
1463
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1464
|
+
name: import("zod").ZodString;
|
|
1465
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1466
|
+
value: import("zod").ZodString;
|
|
1467
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1468
|
+
name: import("zod").ZodString;
|
|
1469
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1470
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1471
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1472
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1473
|
+
name: import("zod").ZodString;
|
|
1474
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1475
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
1021
1476
|
createdAt: import("zod").ZodString;
|
|
1022
1477
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1023
1478
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -1091,6 +1546,19 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
1091
1546
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
1092
1547
|
readonly problems: readonly ["invalid_request", "not_found", "state_conflict"];
|
|
1093
1548
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
1549
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
1550
|
+
name: import("zod").ZodString;
|
|
1551
|
+
secret: import("zod").ZodLiteral<false>;
|
|
1552
|
+
value: import("zod").ZodString;
|
|
1553
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1554
|
+
name: import("zod").ZodString;
|
|
1555
|
+
secret: import("zod").ZodLiteral<true>;
|
|
1556
|
+
configured: import("zod").ZodLiteral<true>;
|
|
1557
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
1558
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
1559
|
+
name: import("zod").ZodString;
|
|
1560
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
1561
|
+
}, import("zod/v4/core").$strict>]>>>;
|
|
1094
1562
|
createdAt: import("zod").ZodString;
|
|
1095
1563
|
disabledAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1096
1564
|
environmentKind: import("zod").ZodEnum<{
|
|
@@ -1933,6 +2401,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
1933
2401
|
}>;
|
|
1934
2402
|
project: import("zod").ZodString;
|
|
1935
2403
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
2404
|
+
"members:manage": "members:manage";
|
|
1936
2405
|
"credentials:administer": "credentials:administer";
|
|
1937
2406
|
"billing:write": "billing:write";
|
|
1938
2407
|
"credentials:read": "credentials:read";
|
|
@@ -1995,6 +2464,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
1995
2464
|
}>;
|
|
1996
2465
|
project: import("zod").ZodString;
|
|
1997
2466
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
2467
|
+
"members:manage": "members:manage";
|
|
1998
2468
|
"credentials:administer": "credentials:administer";
|
|
1999
2469
|
"billing:write": "billing:write";
|
|
2000
2470
|
"credentials:read": "credentials:read";
|
|
@@ -2038,6 +2508,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2038
2508
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2039
2509
|
supersededBy: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2040
2510
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
2511
|
+
"members:manage": "members:manage";
|
|
2041
2512
|
"credentials:administer": "credentials:administer";
|
|
2042
2513
|
"billing:write": "billing:write";
|
|
2043
2514
|
"credentials:read": "credentials:read";
|
|
@@ -2117,6 +2588,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2117
2588
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2118
2589
|
supersededBy: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2119
2590
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
2591
|
+
"members:manage": "members:manage";
|
|
2120
2592
|
"credentials:administer": "credentials:administer";
|
|
2121
2593
|
"billing:write": "billing:write";
|
|
2122
2594
|
"credentials:read": "credentials:read";
|
|
@@ -2186,6 +2658,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2186
2658
|
endpoint: import("zod").ZodString;
|
|
2187
2659
|
id: import("zod").ZodString;
|
|
2188
2660
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
2661
|
+
"members:manage": "members:manage";
|
|
2189
2662
|
"credentials:administer": "credentials:administer";
|
|
2190
2663
|
"billing:write": "billing:write";
|
|
2191
2664
|
"credentials:read": "credentials:read";
|
|
@@ -2206,8 +2679,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2206
2679
|
}>>;
|
|
2207
2680
|
state: import("zod").ZodEnum<{
|
|
2208
2681
|
revoked: "revoked";
|
|
2209
|
-
usable: "usable";
|
|
2210
2682
|
expired: "expired";
|
|
2683
|
+
usable: "usable";
|
|
2211
2684
|
}>;
|
|
2212
2685
|
tools: import("zod").ZodArray<import("zod").ZodString>;
|
|
2213
2686
|
}, import("zod/v4/core").$strip>;
|
|
@@ -2590,6 +3063,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2590
3063
|
}>>;
|
|
2591
3064
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2592
3065
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
3066
|
+
"members:manage": "members:manage";
|
|
2593
3067
|
"credentials:administer": "credentials:administer";
|
|
2594
3068
|
"billing:write": "billing:write";
|
|
2595
3069
|
"credentials:read": "credentials:read";
|
|
@@ -2672,6 +3146,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2672
3146
|
}>>;
|
|
2673
3147
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2674
3148
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
3149
|
+
"members:manage": "members:manage";
|
|
2675
3150
|
"credentials:administer": "credentials:administer";
|
|
2676
3151
|
"billing:write": "billing:write";
|
|
2677
3152
|
"credentials:read": "credentials:read";
|
|
@@ -2765,6 +3240,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2765
3240
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2766
3241
|
supersededBy: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2767
3242
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
3243
|
+
"members:manage": "members:manage";
|
|
2768
3244
|
"credentials:administer": "credentials:administer";
|
|
2769
3245
|
"billing:write": "billing:write";
|
|
2770
3246
|
"credentials:read": "credentials:read";
|
|
@@ -2801,6 +3277,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2801
3277
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2802
3278
|
supersededBy: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2803
3279
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
3280
|
+
"members:manage": "members:manage";
|
|
2804
3281
|
"credentials:administer": "credentials:administer";
|
|
2805
3282
|
"billing:write": "billing:write";
|
|
2806
3283
|
"credentials:read": "credentials:read";
|
|
@@ -2870,6 +3347,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2870
3347
|
revokedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2871
3348
|
supersededBy: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2872
3349
|
scopes: import("zod").ZodArray<import("zod").ZodEnum<{
|
|
3350
|
+
"members:manage": "members:manage";
|
|
2873
3351
|
"credentials:administer": "credentials:administer";
|
|
2874
3352
|
"billing:write": "billing:write";
|
|
2875
3353
|
"credentials:read": "credentials:read";
|
|
@@ -2904,7 +3382,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2904
3382
|
"Idempotency-Replayed": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
2905
3383
|
}, import("zod/v4/core").$strip>;
|
|
2906
3384
|
readonly creates: true;
|
|
2907
|
-
readonly description: "" | "Creates a schedule and returns it together with its first planned occurrence. Give exactly one of `at`, `delaySeconds`, `everySeconds` and `cron`. An optional `partitionKey` selects a fairness lane inside this project and environment; it is fixed after create. Add a verified `endpoint` to deliver each occurrence there;
|
|
3385
|
+
readonly description: "" | "Creates a schedule and returns it together with its first planned occurrence. Give exactly one of `at`, `delaySeconds`, `everySeconds` and `cron`. An optional `partitionKey` selects a fairness lane inside this project and environment; it is fixed after create. Add a verified `endpoint` to deliver each occurrence there. Instead of `endpoint`, give a `url`: the service uses this project and environment's existing endpoint at exactly that address, or creates one silently. Its signing secret is never returned; the response's `endpointSigningSecret` says where a signed-in member reveals it. Reusing an endpoint needs only `schedules:write`; creating one also needs `endpoints:write`, and without it the request is refused as `scope_missing`. Optional JSON `data` is encrypted before PostgreSQL persistence, placed in the signed callback, and returned as given by a schedule read. Optional `http` selects POST (default), PUT, or bodyless GET and schedule header overrides. Omitted HTTP settings preserve the signed structured envelope; `body: { mode: 'json', value: ... }` sends that JSON directly without interpolation. Ordinary headers remain readable and secret values are encrypted and write-only. Schedule headers override endpoint defaults case-insensitively, with `suppress` to omit an inherited header and `remove` to resume inheritance. Product signing, content and transport headers are reserved. Raw JSON and GET carry asynchronous completion details in reserved Callback-Completion headers. `at` and `delaySeconds` fire once; a delay is converted to an absolute instant when the request is accepted, so a schedule created either way reads back the same afterwards. `everySeconds` is a fixed duration and its first occurrence falls one interval after acceptance — it stays the same length across a daylight-saving change, and takes no timezone for that reason. `cron` is a wall clock: it is read against the IANA `timeZone` sent with it, `UTC` when none is, and the first occurrence is the first instant the expression names after acceptance. Where the clocks go forward and the wall time named does not exist that day, the occurrence falls at the first instant after the gap; where they go back and it happens twice, it falls once, at the earlier of the two. A recurring schedule is materialized one occurrence at a time: the next one is planned once the current one is due, so a read always shows one occurrence still to come. `lateness.policy` decides what happens when an occurrence reaches its first attempt after its planned instant: `skipAhead` never carries a recurring arrival across its next scheduled instant (and a shorter custom window may retire it earlier), while `catchUp` admits one arrival within `maxStalenessSeconds` even after later recurrence instants passed. A one-shot has no next recurrence, so either explicit policy uses its window and the default is `catchUp` with 24 hours; recurring schedules default to `skipAhead`, and a `catchUp` without an override has a one-interval window. A retry already in progress is exempt because it arrived and failed; its retry and give-up policy still decide the outcome. The organization, project and environment come from the verified principal; a body cannot name them, and the endpoint must belong to the same tuple, so a credential issued for one project can only ever create schedules in that project. Send an `Idempotency-Key` to make a retry safe: the identical request returns the schedule that key already created, marked `Idempotency-Replayed: true`, and creates nothing further; the same key with a different request is refused `idempotency_key_reused`. A replay reports the schedule **as it stands now**, not a frozen copy of the first response — if it was paused in between, the replay says so.";
|
|
2908
3386
|
readonly example: {
|
|
2909
3387
|
occurrence?: never;
|
|
2910
3388
|
schedule?: never;
|
|
@@ -2946,9 +3424,39 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2946
3424
|
readonly method: "POST";
|
|
2947
3425
|
readonly mutates: true;
|
|
2948
3426
|
readonly path: "/v1/schedules";
|
|
3427
|
+
readonly conditionalScopes: readonly ["endpoints:write"];
|
|
3428
|
+
readonly conditionalScopesWhen: "the request names a `url` this project and environment has no endpoint at yet";
|
|
2949
3429
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
2950
|
-
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "plan_limit_reached", "service_unavailable", "state_conflict"];
|
|
3430
|
+
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "plan_limit_reached", "rate_limited", "scope_missing", "service_unavailable", "state_conflict"];
|
|
2951
3431
|
readonly request: import("zod").ZodObject<{
|
|
3432
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3433
|
+
method: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
3434
|
+
POST: "POST";
|
|
3435
|
+
PUT: "PUT";
|
|
3436
|
+
GET: "GET";
|
|
3437
|
+
}>>;
|
|
3438
|
+
body: import("zod").ZodOptional<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
3439
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
3440
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3441
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
3442
|
+
value: import("zod").ZodJSONSchema;
|
|
3443
|
+
}, import("zod/v4/core").$strict>], "mode">>;
|
|
3444
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
3445
|
+
action: import("zod").ZodLiteral<"set">;
|
|
3446
|
+
name: import("zod").ZodString;
|
|
3447
|
+
value: import("zod").ZodString;
|
|
3448
|
+
secret: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
3449
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3450
|
+
action: import("zod").ZodLiteral<"keep">;
|
|
3451
|
+
name: import("zod").ZodString;
|
|
3452
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3453
|
+
action: import("zod").ZodLiteral<"remove">;
|
|
3454
|
+
name: import("zod").ZodString;
|
|
3455
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3456
|
+
action: import("zod").ZodLiteral<"suppress">;
|
|
3457
|
+
name: import("zod").ZodString;
|
|
3458
|
+
}, import("zod/v4/core").$strict>], "action">>>;
|
|
3459
|
+
}, import("zod/v4/core").$strict>>;
|
|
2952
3460
|
at: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2953
3461
|
cron: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2954
3462
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
@@ -2966,6 +3474,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
2966
3474
|
}, import("zod/v4/core").$strict>>;
|
|
2967
3475
|
everySeconds: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
2968
3476
|
endpoint: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3477
|
+
url: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2969
3478
|
latencyClass: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
2970
3479
|
realtime: "realtime";
|
|
2971
3480
|
bulk: "bulk";
|
|
@@ -3004,7 +3513,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3004
3513
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
3005
3514
|
"Idempotency-Key": import("zod").ZodOptional<import("zod").ZodString>;
|
|
3006
3515
|
}, import("zod/v4/core").$strip>;
|
|
3007
|
-
readonly response: import("zod").ZodObject<{
|
|
3516
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
3008
3517
|
occurrence: import("zod").ZodObject<{
|
|
3009
3518
|
generation: import("zod").ZodNumber;
|
|
3010
3519
|
id: import("zod").ZodString;
|
|
@@ -3035,6 +3544,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3035
3544
|
attemptCount: import("zod").ZodNumber;
|
|
3036
3545
|
}, import("zod/v4/core").$strip>;
|
|
3037
3546
|
schedule: import("zod").ZodObject<{
|
|
3547
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3548
|
+
method: import("zod").ZodEnum<{
|
|
3549
|
+
POST: "POST";
|
|
3550
|
+
PUT: "PUT";
|
|
3551
|
+
GET: "GET";
|
|
3552
|
+
}>;
|
|
3553
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
3554
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
3555
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3556
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
3557
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3558
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
3559
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3560
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
3561
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
3562
|
+
name: import("zod").ZodString;
|
|
3563
|
+
secret: import("zod").ZodLiteral<false>;
|
|
3564
|
+
value: import("zod").ZodString;
|
|
3565
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3566
|
+
name: import("zod").ZodString;
|
|
3567
|
+
secret: import("zod").ZodLiteral<true>;
|
|
3568
|
+
configured: import("zod").ZodLiteral<true>;
|
|
3569
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
3570
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3571
|
+
name: import("zod").ZodString;
|
|
3572
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
3573
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
3574
|
+
}, import("zod/v4/core").$strict>>;
|
|
3038
3575
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3039
3576
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3040
3577
|
createdAt: import("zod").ZodString;
|
|
@@ -3086,7 +3623,12 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3086
3623
|
updatedAt: import("zod").ZodString;
|
|
3087
3624
|
version: import("zod").ZodNumber;
|
|
3088
3625
|
}, import("zod/v4/core").$strip>;
|
|
3089
|
-
|
|
3626
|
+
endpointSigningSecret: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3627
|
+
guidance: import("zod").ZodString;
|
|
3628
|
+
returned: import("zod").ZodLiteral<false>;
|
|
3629
|
+
revealUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3630
|
+
}, import("zod/v4/core").$strip>>;
|
|
3631
|
+
}, import("zod/v4/core").$strip>;
|
|
3090
3632
|
}, {
|
|
3091
3633
|
readonly scopes: readonly ["schedules:read"];
|
|
3092
3634
|
readonly sessionAuthority: "headers";
|
|
@@ -3096,7 +3638,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3096
3638
|
ETag: import("zod").ZodString;
|
|
3097
3639
|
}, import("zod/v4/core").$strip>;
|
|
3098
3640
|
readonly creates: false;
|
|
3099
|
-
readonly description: "" | "Reads one schedule and its next occurrence from the partition that owns it. A schedule belonging to another organization, project or environment answers not_found rather than a refusal that would confirm it exists. The response carries the schedule's version as a strong ETag; send it back in `If-Match` to make a later write conditional on nothing having changed in between. The response carries the schedule's `data` when it has one, exactly as it was given; the listing leaves it off.";
|
|
3641
|
+
readonly description: "" | "Reads one schedule and its next occurrence from the partition that owns it. A schedule belonging to another organization, project or environment answers not_found rather than a refusal that would confirm it exists. The response carries the schedule's version as a strong ETag; send it back in `If-Match` to make a later write conditional on nothing having changed in between. The response carries the schedule's `data` when it has one, exactly as it was given; the listing leaves it off. Detail reads also include the custom JSON body; listings and mutation responses omit its content. HTTP settings expose ordinary values and configured secret markers, never secret values.";
|
|
3100
3642
|
readonly example: {
|
|
3101
3643
|
occurrence?: never;
|
|
3102
3644
|
schedule?: never;
|
|
@@ -3143,7 +3685,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3143
3685
|
readonly path: "/v1/schedules/{scheduleId}";
|
|
3144
3686
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3145
3687
|
readonly problems: readonly ["invalid_request", "not_found"];
|
|
3146
|
-
readonly response: import("zod").ZodObject<{
|
|
3688
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
3147
3689
|
occurrence: import("zod").ZodObject<{
|
|
3148
3690
|
generation: import("zod").ZodNumber;
|
|
3149
3691
|
id: import("zod").ZodString;
|
|
@@ -3174,6 +3716,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3174
3716
|
attemptCount: import("zod").ZodNumber;
|
|
3175
3717
|
}, import("zod/v4/core").$strip>;
|
|
3176
3718
|
schedule: import("zod").ZodObject<{
|
|
3719
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3720
|
+
method: import("zod").ZodEnum<{
|
|
3721
|
+
POST: "POST";
|
|
3722
|
+
PUT: "PUT";
|
|
3723
|
+
GET: "GET";
|
|
3724
|
+
}>;
|
|
3725
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
3726
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
3727
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3728
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
3729
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3730
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
3731
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3732
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
3733
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
3734
|
+
name: import("zod").ZodString;
|
|
3735
|
+
secret: import("zod").ZodLiteral<false>;
|
|
3736
|
+
value: import("zod").ZodString;
|
|
3737
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3738
|
+
name: import("zod").ZodString;
|
|
3739
|
+
secret: import("zod").ZodLiteral<true>;
|
|
3740
|
+
configured: import("zod").ZodLiteral<true>;
|
|
3741
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
3742
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3743
|
+
name: import("zod").ZodString;
|
|
3744
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
3745
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
3746
|
+
}, import("zod/v4/core").$strict>>;
|
|
3177
3747
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3178
3748
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3179
3749
|
createdAt: import("zod").ZodString;
|
|
@@ -3225,7 +3795,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3225
3795
|
updatedAt: import("zod").ZodString;
|
|
3226
3796
|
version: import("zod").ZodNumber;
|
|
3227
3797
|
}, import("zod/v4/core").$strip>;
|
|
3228
|
-
}, import("zod/v4/core").$strip
|
|
3798
|
+
}, import("zod/v4/core").$strip>;
|
|
3229
3799
|
}, {
|
|
3230
3800
|
readonly creates: false;
|
|
3231
3801
|
readonly description: "" | "Lists the caller's own schedules, oldest first, one page at a time. Archived schedules are left out: archiving is how a schedule leaves the working set, and a listing that still carried them would make the operation pointless. Give `endpoint` to keep the page to the schedules that deliver to that endpoint — the way back from a destination to everything pointed at it, which is what somebody who disabled or is about to move an endpoint needs to see. Items are schedules rather than schedules-with-occurrences, because a cross-partition listing is served from a projection that holds a summary; read a schedule to get its authoritative next occurrence. Every page states whether it is authoritative or projected.";
|
|
@@ -3279,8 +3849,36 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3279
3849
|
due: "due";
|
|
3280
3850
|
}>>;
|
|
3281
3851
|
}, import("zod/v4/core").$strip>;
|
|
3282
|
-
readonly response: import("zod").ZodObject<{
|
|
3852
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
3283
3853
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
3854
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3855
|
+
method: import("zod").ZodEnum<{
|
|
3856
|
+
POST: "POST";
|
|
3857
|
+
PUT: "PUT";
|
|
3858
|
+
GET: "GET";
|
|
3859
|
+
}>;
|
|
3860
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
3861
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
3862
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3863
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
3864
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3865
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
3866
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3867
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
3868
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
3869
|
+
name: import("zod").ZodString;
|
|
3870
|
+
secret: import("zod").ZodLiteral<false>;
|
|
3871
|
+
value: import("zod").ZodString;
|
|
3872
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3873
|
+
name: import("zod").ZodString;
|
|
3874
|
+
secret: import("zod").ZodLiteral<true>;
|
|
3875
|
+
configured: import("zod").ZodLiteral<true>;
|
|
3876
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
3877
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
3878
|
+
name: import("zod").ZodString;
|
|
3879
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
3880
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
3881
|
+
}, import("zod/v4/core").$strict>>;
|
|
3284
3882
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3285
3883
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
3286
3884
|
createdAt: import("zod").ZodString;
|
|
@@ -3340,14 +3938,14 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3340
3938
|
lagSeconds: import("zod").ZodNumber;
|
|
3341
3939
|
}, import("zod/v4/core").$strip>], "kind">;
|
|
3342
3940
|
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3343
|
-
}, import("zod/v4/core").$strip
|
|
3941
|
+
}, import("zod/v4/core").$strip>;
|
|
3344
3942
|
readonly scopes: readonly ["schedules:read"];
|
|
3345
3943
|
readonly sessionAuthority: "headers";
|
|
3346
3944
|
readonly summary: "" | "List schedules";
|
|
3347
3945
|
readonly surfaces: readonly ["api", "mock"];
|
|
3348
3946
|
}, {
|
|
3349
3947
|
readonly creates: false;
|
|
3350
|
-
readonly description: "" | "Counts the occurrences this project and environment expect to fire, in epoch-aligned time buckets, with a latency-class split on every bucket and an optional customer partition-key breakdown. A recurring series contributes every instant it fires inside the window rather than only its next one, and `nextFireCount` reports how many of a bucket's occurrences are a schedule's next firing. The answer states
|
|
3948
|
+
readonly description: "" | "Counts the occurrences this project and environment expect to fire, in epoch-aligned time buckets, with a latency-class split on every bucket and an optional customer partition-key breakdown. A recurring series contributes every instant it fires inside the window rather than only its next one, and `nextFireCount` reports how many of a bucket's occurrences are a schedule's next firing. The answer states freshness and explicit coverage. Clients sending X-Greatwait-Accept-Partial-Forecast: true receive bounded lower-bound counts when a book reaches a row, cell or recurrence-work bound, with coverage.complete false and the exact bounds reached. Without this capability header the previous refusal behavior remains safe for clients that only read totals. Unavailable or stale sources still refuse. Coverage identifies the selected recurring schedule range but never includes destinations, payload or endpoint detail.";
|
|
3351
3949
|
readonly example: {
|
|
3352
3950
|
buckets?: never;
|
|
3353
3951
|
freshness?: never;
|
|
@@ -3378,6 +3976,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3378
3976
|
to: string;
|
|
3379
3977
|
};
|
|
3380
3978
|
};
|
|
3979
|
+
readonly requestHeaders: import("zod").ZodObject<{
|
|
3980
|
+
"X-Greatwait-Accept-Partial-Forecast": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3981
|
+
}, import("zod/v4/core").$strip>;
|
|
3381
3982
|
readonly id: "forecast.read";
|
|
3382
3983
|
readonly idempotent: true;
|
|
3383
3984
|
readonly mcp: {
|
|
@@ -3400,6 +4001,52 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3400
4001
|
to: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3401
4002
|
}, import("zod/v4/core").$strip>;
|
|
3402
4003
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
4004
|
+
coverage: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
4005
|
+
complete: import("zod").ZodBoolean;
|
|
4006
|
+
countMeaning: import("zod").ZodEnum<{
|
|
4007
|
+
"complete-total": "complete-total";
|
|
4008
|
+
"lower-bound": "lower-bound";
|
|
4009
|
+
}>;
|
|
4010
|
+
projectedWindow: import("zod").ZodObject<{
|
|
4011
|
+
from: import("zod").ZodString;
|
|
4012
|
+
to: import("zod").ZodString;
|
|
4013
|
+
}, import("zod/v4/core").$strip>;
|
|
4014
|
+
completeThrough: import("zod").ZodString;
|
|
4015
|
+
heads: import("zod").ZodObject<{
|
|
4016
|
+
groupsRead: import("zod").ZodNumber;
|
|
4017
|
+
occurrencesCounted: import("zod").ZodNumber;
|
|
4018
|
+
complete: import("zod").ZodBoolean;
|
|
4019
|
+
selection: import("zod").ZodLiteral<"earliest bucket, latency class, partition key groups">;
|
|
4020
|
+
lastGroup: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
4021
|
+
start: import("zod").ZodString;
|
|
4022
|
+
latencyClass: import("zod").ZodEnum<{
|
|
4023
|
+
realtime: "realtime";
|
|
4024
|
+
bulk: "bulk";
|
|
4025
|
+
}>;
|
|
4026
|
+
partitionKey: import("zod").ZodString;
|
|
4027
|
+
}, import("zod/v4/core").$strip>>;
|
|
4028
|
+
}, import("zod/v4/core").$strip>;
|
|
4029
|
+
recurring: import("zod").ZodObject<{
|
|
4030
|
+
schedulesRead: import("zod").ZodNumber;
|
|
4031
|
+
populationComplete: import("zod").ZodBoolean;
|
|
4032
|
+
selection: import("zod").ZodLiteral<"oldest eligible active recurring schedules by createdAt and scheduleId">;
|
|
4033
|
+
firstScheduleId: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4034
|
+
lastScheduleId: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4035
|
+
}, import("zod/v4/core").$strip>;
|
|
4036
|
+
work: import("zod").ZodObject<{
|
|
4037
|
+
usedUnits: import("zod").ZodNumber;
|
|
4038
|
+
limitUnits: import("zod").ZodNumber;
|
|
4039
|
+
}, import("zod/v4/core").$strip>;
|
|
4040
|
+
boundsReached: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4041
|
+
kind: import("zod").ZodEnum<{
|
|
4042
|
+
"head-cells": "head-cells";
|
|
4043
|
+
"recurring-series": "recurring-series";
|
|
4044
|
+
"projection-work": "projection-work";
|
|
4045
|
+
"projection-cells": "projection-cells";
|
|
4046
|
+
}>;
|
|
4047
|
+
limit: import("zod").ZodNumber;
|
|
4048
|
+
}, import("zod/v4/core").$strip>>;
|
|
4049
|
+
}, import("zod/v4/core").$strip>>;
|
|
3403
4050
|
buckets: import("zod").ZodArray<import("zod").ZodObject<{
|
|
3404
4051
|
byLatencyClass: import("zod").ZodObject<{
|
|
3405
4052
|
bulk: import("zod").ZodNumber;
|
|
@@ -3428,7 +4075,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3428
4075
|
readonly surfaces: readonly ["api", "mock"];
|
|
3429
4076
|
}, {
|
|
3430
4077
|
readonly creates: false;
|
|
3431
|
-
readonly description: "" | "Reads the verified principal's organization-wide prepaid execution position from the authoritative PostgreSQL ledger. Desired and effective revisions remain distinct, and pending stays true until
|
|
4078
|
+
readonly description: "" | "Reads the verified principal's organization-wide prepaid execution position from the authoritative PostgreSQL ledger. Desired and effective revisions remain distinct, and pending stays true until the control plane records PostgreSQL confirmation. Amounts are exact integer microdollars encoded as decimal strings; currency is USD and scale is six. Reserved credit has already been committed to a logical attempt but is not yet a settled debit. A missing hard cap means the customer elected no execution spending cap, never zero room. Shadow mode records what enforcement would have done without charging or blocking, and the activation boundary prevents retroactive charges.";
|
|
3432
4079
|
readonly example: {};
|
|
3433
4080
|
readonly id: "billing.summary";
|
|
3434
4081
|
readonly idempotent: true;
|
|
@@ -3441,7 +4088,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3441
4088
|
readonly mutates: false;
|
|
3442
4089
|
readonly path: "/v1/billing/summary";
|
|
3443
4090
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3444
|
-
readonly problems: readonly [];
|
|
4091
|
+
readonly problems: readonly ["billing_not_ready", "service_unavailable"];
|
|
3445
4092
|
readonly response: import("zod").ZodObject<{
|
|
3446
4093
|
activation: import("zod").ZodObject<{
|
|
3447
4094
|
boundary: import("zod").ZodString;
|
|
@@ -3668,6 +4315,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3668
4315
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3669
4316
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "revision_conflict", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3670
4317
|
readonly request: import("zod").ZodObject<{
|
|
4318
|
+
automaticTopUp: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
3671
4319
|
confirmed: import("zod").ZodLiteral<true>;
|
|
3672
4320
|
expectedRevision: import("zod").ZodNumber;
|
|
3673
4321
|
quote: import("zod").ZodString;
|
|
@@ -3684,6 +4332,26 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3684
4332
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
3685
4333
|
"Idempotency-Key": import("zod").ZodString;
|
|
3686
4334
|
}, import("zod/v4/core").$strip>;
|
|
4335
|
+
} & BillingFundingContract, {
|
|
4336
|
+
readonly creates: false;
|
|
4337
|
+
readonly description: "" | "Confirms one execution-credit payment or saved-payment-method setup now, typically when the customer returns from hosted Checkout, instead of waiting for the provider's notification or the scheduled repair. It reads that one operation from the payment provider under the caller organization's authenticated account and applies what the provider reports: a paid Checkout grants its exact credit once, an open or unpaid one stays pending, and an operation already settled is answered without reading the provider. Nothing in the request can claim a payment succeeded — it names only which operation to read. Repeating the call is safe and converges on the same state. Returns the same execution-funding position as billing.funding.";
|
|
4338
|
+
readonly environments: readonly ["live"];
|
|
4339
|
+
readonly id: "billing.fundingconfirm";
|
|
4340
|
+
readonly idempotent: true;
|
|
4341
|
+
readonly mcp: {
|
|
4342
|
+
readonly destructive: false;
|
|
4343
|
+
readonly kind: "tool";
|
|
4344
|
+
readonly openWorld: false;
|
|
4345
|
+
};
|
|
4346
|
+
readonly method: "POST";
|
|
4347
|
+
readonly mutates: true;
|
|
4348
|
+
readonly path: "/v1/billing/funding/{paymentOperation}/confirm";
|
|
4349
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4350
|
+
readonly problems: readonly ["not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
4351
|
+
readonly scopes: readonly ["billing:write"];
|
|
4352
|
+
readonly sessionAuthority: "headers";
|
|
4353
|
+
readonly summary: "" | "Confirm one payment with the provider now";
|
|
4354
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
3687
4355
|
} & BillingFundingContract, {
|
|
3688
4356
|
readonly scopes: readonly ["billing:write"];
|
|
3689
4357
|
readonly sessionAuthority: "headers";
|
|
@@ -3731,14 +4399,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3731
4399
|
}, import("zod/v4/core").$strip>;
|
|
3732
4400
|
} & BillingFundingContract, NamedOperation<"billing.autotopuppreview">, NamedOperation<"billing.autotopup">, {
|
|
3733
4401
|
readonly scopes: readonly ["billing:write"];
|
|
3734
|
-
readonly
|
|
3735
|
-
readonly summary: "" | "Request operator-reviewed refund";
|
|
4402
|
+
readonly summary: "" | "Reserve credit against a payment for refund";
|
|
3736
4403
|
readonly surfaces: readonly ["api", "mock"];
|
|
3737
4404
|
readonly responseHeaders?: import("zod").ZodObject<{
|
|
3738
4405
|
"Idempotency-Replayed": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3739
4406
|
}, import("zod/v4/core").$strip>;
|
|
3740
4407
|
readonly creates: true;
|
|
3741
|
-
readonly description: "" | "
|
|
4408
|
+
readonly description: "" | "Reserves unused purchased execution credit against one original payment, with the billing owner's explicit confirmation. Purchased credit is not refundable except where a charge is refunded because the service did not work as described, so this records no promise of a refund: it never calls Stripe, cashes out credit or grants an MCP cash-out path. A Stripe refund of that payment settles the reservation when it carries the same credit and supersedes it otherwise; the Idempotency-Key preserves one reservation across retries. Trial credit has no cash value, and a refund does not restore automatic purchasing authority used in the month.";
|
|
3742
4409
|
readonly environments: readonly ["live"];
|
|
3743
4410
|
readonly example: {
|
|
3744
4411
|
amount?: never;
|
|
@@ -3767,7 +4434,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3767
4434
|
readonly method: "POST";
|
|
3768
4435
|
readonly mutates: true;
|
|
3769
4436
|
readonly path: "/v1/billing/funding/refunds";
|
|
3770
|
-
readonly principals: readonly ["api-credential", "oauth"
|
|
4437
|
+
readonly principals: readonly ["api-credential", "oauth"];
|
|
3771
4438
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3772
4439
|
readonly request: import("zod").ZodObject<{
|
|
3773
4440
|
amount: import("zod").ZodObject<{
|
|
@@ -3810,14 +4477,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3810
4477
|
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
3811
4478
|
}, {
|
|
3812
4479
|
readonly scopes: readonly ["billing:write"];
|
|
3813
|
-
readonly
|
|
3814
|
-
readonly summary: "" | "Record a reviewed refund decision";
|
|
4480
|
+
readonly summary: "" | "Complete or decline a refund reservation";
|
|
3815
4481
|
readonly surfaces: readonly ["api", "mock"];
|
|
3816
4482
|
readonly responseHeaders?: import("zod").ZodObject<{
|
|
3817
4483
|
"Idempotency-Replayed": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3818
4484
|
}, import("zod/v4/core").$strip>;
|
|
3819
4485
|
readonly creates: false;
|
|
3820
|
-
readonly description: "" | "
|
|
4486
|
+
readonly description: "" | "Completes or declines a pending refund reservation. Completion verifies an existing Stripe refund by authenticated provider read before applying the exact credit, tax and gross adjustment, and converges on the recorded adjustment when that refund already settled the reservation; it never creates a provider refund. Decline releases the reserved credit without contacting the provider, and a reservation a Stripe refund superseded is refused as a state conflict. The Idempotency-Key makes either outcome converge across retries.";
|
|
3821
4487
|
readonly environments: readonly ["live"];
|
|
3822
4488
|
readonly id: "billing.refundresolution";
|
|
3823
4489
|
readonly idempotent: true;
|
|
@@ -3829,7 +4495,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3829
4495
|
readonly method: "PATCH";
|
|
3830
4496
|
readonly mutates: true;
|
|
3831
4497
|
readonly path: "/v1/billing/funding/refunds/{refundRequest}";
|
|
3832
|
-
readonly principals: readonly ["api-credential", "oauth"
|
|
4498
|
+
readonly principals: readonly ["api-credential", "oauth"];
|
|
3833
4499
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3834
4500
|
readonly request: import("zod").ZodObject<{
|
|
3835
4501
|
confirmed: import("zod").ZodLiteral<true>;
|
|
@@ -4082,6 +4748,282 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4082
4748
|
};
|
|
4083
4749
|
readonly summary: "" | "Open hosted payment recovery";
|
|
4084
4750
|
readonly problems: readonly ["service_unavailable", "state_conflict", "not_found", "revision_conflict", "test_to_live_escalation"];
|
|
4751
|
+
}, {
|
|
4752
|
+
readonly creates: false;
|
|
4753
|
+
readonly description: "" | "Reads the verified organization's saved payment method: the one method automatic execution top-ups and project subscriptions charge. It is the payment provider's default payment method for the organization, read by authenticated provider call. method says what it is — type card with brand, last four digits and expiry; type link with the email Link reports, when it reports one; or type other with the provider's type name (cashapp, amazon_pay, klarna and the like) — and every variant carries label, the name to show a person. card repeats the card details when the method is a card and is null otherwise; it is kept for clients written before other payment methods were accepted. A method the organization already authorized for automatic top-up or a project subscription is adopted as the saved method, so an existing customer is not told they have none. method and card are null when the organization has none.";
|
|
4754
|
+
readonly example: {
|
|
4755
|
+
card?: never;
|
|
4756
|
+
method?: never;
|
|
4757
|
+
} | {
|
|
4758
|
+
card: {
|
|
4759
|
+
brand: string;
|
|
4760
|
+
expMonth: number;
|
|
4761
|
+
expYear: number;
|
|
4762
|
+
last4: string;
|
|
4763
|
+
};
|
|
4764
|
+
method: {
|
|
4765
|
+
brand: string;
|
|
4766
|
+
expMonth: number;
|
|
4767
|
+
expYear: number;
|
|
4768
|
+
label: string;
|
|
4769
|
+
last4: string;
|
|
4770
|
+
type: string;
|
|
4771
|
+
};
|
|
4772
|
+
};
|
|
4773
|
+
readonly id: "billing.paymentmethod";
|
|
4774
|
+
readonly idempotent: true;
|
|
4775
|
+
readonly mcp: {
|
|
4776
|
+
readonly destructive: false;
|
|
4777
|
+
readonly kind: "tool";
|
|
4778
|
+
readonly openWorld: false;
|
|
4779
|
+
};
|
|
4780
|
+
readonly method: "GET";
|
|
4781
|
+
readonly mutates: false;
|
|
4782
|
+
readonly path: "/v1/billing/payment-method";
|
|
4783
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4784
|
+
readonly problems: readonly ["service_unavailable"];
|
|
4785
|
+
readonly response: import("zod").ZodObject<{
|
|
4786
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
4787
|
+
brand: import("zod").ZodString;
|
|
4788
|
+
last4: import("zod").ZodString;
|
|
4789
|
+
expMonth: import("zod").ZodNumber;
|
|
4790
|
+
expYear: import("zod").ZodNumber;
|
|
4791
|
+
}, import("zod/v4/core").$strict>>;
|
|
4792
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
4793
|
+
brand: import("zod").ZodString;
|
|
4794
|
+
last4: import("zod").ZodString;
|
|
4795
|
+
expMonth: import("zod").ZodNumber;
|
|
4796
|
+
expYear: import("zod").ZodNumber;
|
|
4797
|
+
type: import("zod").ZodLiteral<"card">;
|
|
4798
|
+
label: import("zod").ZodString;
|
|
4799
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4800
|
+
type: import("zod").ZodLiteral<"link">;
|
|
4801
|
+
label: import("zod").ZodString;
|
|
4802
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
4803
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4804
|
+
type: import("zod").ZodLiteral<"other">;
|
|
4805
|
+
label: import("zod").ZodString;
|
|
4806
|
+
providerType: import("zod").ZodString;
|
|
4807
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
4808
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4809
|
+
readonly scopes: readonly ["usage:read"];
|
|
4810
|
+
readonly sessionAuthority: "headers";
|
|
4811
|
+
readonly summary: "" | "Read the saved payment method";
|
|
4812
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4813
|
+
}, {
|
|
4814
|
+
readonly creates: false;
|
|
4815
|
+
readonly description: "" | "Lists the verified organization's project subscription charges: the payment provider's invoices for its project subscription, read by authenticated provider call, most recent first and at most 24. Execution-credit purchases are not listed here; billing.funding reports them. Draft and zero-amount invoices are omitted. Each amount is the invoice total including tax, and the receipt link, when present, is the provider-hosted invoice page. An organization that has never been billed has an empty list; reading it creates nothing and changes nothing.";
|
|
4816
|
+
readonly example: {
|
|
4817
|
+
data?: never;
|
|
4818
|
+
} | {
|
|
4819
|
+
data: {
|
|
4820
|
+
amount: {
|
|
4821
|
+
currency: string;
|
|
4822
|
+
microdollars: string;
|
|
4823
|
+
scale: number;
|
|
4824
|
+
};
|
|
4825
|
+
createdAt: string;
|
|
4826
|
+
id: string;
|
|
4827
|
+
receiptUrl: string;
|
|
4828
|
+
state: string;
|
|
4829
|
+
}[];
|
|
4830
|
+
};
|
|
4831
|
+
readonly id: "billing.invoices";
|
|
4832
|
+
readonly idempotent: true;
|
|
4833
|
+
readonly mcp: {
|
|
4834
|
+
readonly destructive: false;
|
|
4835
|
+
readonly kind: "tool";
|
|
4836
|
+
readonly openWorld: false;
|
|
4837
|
+
};
|
|
4838
|
+
readonly method: "GET";
|
|
4839
|
+
readonly mutates: false;
|
|
4840
|
+
readonly path: "/v1/billing/invoices";
|
|
4841
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4842
|
+
readonly problems: readonly ["service_unavailable"];
|
|
4843
|
+
readonly response: import("zod").ZodObject<{
|
|
4844
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4845
|
+
id: import("zod").ZodString;
|
|
4846
|
+
createdAt: import("zod").ZodString;
|
|
4847
|
+
amount: import("zod").ZodObject<{
|
|
4848
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
4849
|
+
microdollars: import("zod").ZodString;
|
|
4850
|
+
scale: import("zod").ZodLiteral<6>;
|
|
4851
|
+
}, import("zod/v4/core").$strip>;
|
|
4852
|
+
state: import("zod").ZodEnum<{
|
|
4853
|
+
void: "void";
|
|
4854
|
+
paid: "paid";
|
|
4855
|
+
open: "open";
|
|
4856
|
+
uncollectible: "uncollectible";
|
|
4857
|
+
}>;
|
|
4858
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4859
|
+
}, import("zod/v4/core").$strict>>;
|
|
4860
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4861
|
+
readonly scopes: readonly ["usage:read"];
|
|
4862
|
+
readonly sessionAuthority: "headers";
|
|
4863
|
+
readonly summary: "" | "List project subscription charges";
|
|
4864
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4865
|
+
}, {
|
|
4866
|
+
readonly creates: false;
|
|
4867
|
+
readonly description: "" | "Creates a short-lived provider-hosted payment-method setup session for the verified organization and returns its address. It offers every payment method the provider account enables that can be charged later without the customer present — cards, Link and others. Saving one there charges nothing; it becomes the saved payment method only once billing.paymentmethodconfirm (when the browser returns) or the provider's notification reads the completed setup by authenticated provider call. An optional return address must share the origin of the configured billing page.";
|
|
4868
|
+
readonly environments: readonly ["live"];
|
|
4869
|
+
readonly example: {
|
|
4870
|
+
url?: never;
|
|
4871
|
+
} | {
|
|
4872
|
+
url: string;
|
|
4873
|
+
};
|
|
4874
|
+
readonly id: "billing.paymentmethodsetup";
|
|
4875
|
+
readonly idempotent: false;
|
|
4876
|
+
readonly mcp: {
|
|
4877
|
+
readonly destructive: false;
|
|
4878
|
+
readonly kind: "tool";
|
|
4879
|
+
readonly openWorld: false;
|
|
4880
|
+
};
|
|
4881
|
+
readonly method: "POST";
|
|
4882
|
+
readonly mutates: true;
|
|
4883
|
+
readonly path: "/v1/billing/payment-method/setup";
|
|
4884
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4885
|
+
readonly problems: readonly ["invalid_request", "service_unavailable", "state_conflict", "not_found", "revision_conflict", "test_to_live_escalation"];
|
|
4886
|
+
readonly request: import("zod").ZodObject<{
|
|
4887
|
+
returnUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4888
|
+
}, import("zod/v4/core").$strict>;
|
|
4889
|
+
readonly requestExample: {};
|
|
4890
|
+
readonly response: import("zod").ZodObject<{
|
|
4891
|
+
url: import("zod").ZodString;
|
|
4892
|
+
}, import("zod/v4/core").$strip> | import("zod").ZodNever;
|
|
4893
|
+
readonly scopes: readonly ["billing:write"];
|
|
4894
|
+
readonly sessionAuthority: "headers";
|
|
4895
|
+
readonly summary: "" | "Start saving a payment method";
|
|
4896
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4897
|
+
}, {
|
|
4898
|
+
readonly creates: false;
|
|
4899
|
+
readonly description: "" | "Makes the payment method saved in one completed hosted setup the organization's saved payment method, typically when the browser returns from it. The session is read by authenticated provider call and must belong to the verified organization's own customer; a session of another organization is answered not found. It becomes the provider default for invoices, the default of the organization's project subscription, and the automatic top-up payment method — readying a top-up rule that was waiting for one. The response has the shape billing.paymentmethod returns. When the previous method was removed (billing.paymentmethodremove) and the paid period it let run out has not ended, renewal resumes for the projects that removal stopped; a project the customer cancelled themselves stays cancelled. Nothing in the request can claim a setup succeeded, and repeating the call is safe.";
|
|
4900
|
+
readonly environments: readonly ["live"];
|
|
4901
|
+
readonly example: {
|
|
4902
|
+
card?: never;
|
|
4903
|
+
method?: never;
|
|
4904
|
+
} | {
|
|
4905
|
+
card: {
|
|
4906
|
+
brand: string;
|
|
4907
|
+
expMonth: number;
|
|
4908
|
+
expYear: number;
|
|
4909
|
+
last4: string;
|
|
4910
|
+
};
|
|
4911
|
+
method: {
|
|
4912
|
+
brand: string;
|
|
4913
|
+
expMonth: number;
|
|
4914
|
+
expYear: number;
|
|
4915
|
+
label: string;
|
|
4916
|
+
last4: string;
|
|
4917
|
+
type: string;
|
|
4918
|
+
};
|
|
4919
|
+
};
|
|
4920
|
+
readonly id: "billing.paymentmethodconfirm";
|
|
4921
|
+
readonly idempotent: true;
|
|
4922
|
+
readonly mcp: {
|
|
4923
|
+
readonly destructive: false;
|
|
4924
|
+
readonly kind: "tool";
|
|
4925
|
+
readonly openWorld: false;
|
|
4926
|
+
};
|
|
4927
|
+
readonly method: "POST";
|
|
4928
|
+
readonly mutates: true;
|
|
4929
|
+
readonly path: "/v1/billing/payment-method/confirm";
|
|
4930
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4931
|
+
readonly problems: readonly ["invalid_request", "not_found", "service_unavailable", "state_conflict", "revision_conflict", "test_to_live_escalation"];
|
|
4932
|
+
readonly request: import("zod").ZodObject<{
|
|
4933
|
+
checkoutSession: import("zod").ZodString;
|
|
4934
|
+
}, import("zod/v4/core").$strict>;
|
|
4935
|
+
readonly requestExample: {
|
|
4936
|
+
checkoutSession?: never;
|
|
4937
|
+
} | {
|
|
4938
|
+
checkoutSession: string;
|
|
4939
|
+
};
|
|
4940
|
+
readonly response: import("zod").ZodObject<{
|
|
4941
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
4942
|
+
brand: import("zod").ZodString;
|
|
4943
|
+
last4: import("zod").ZodString;
|
|
4944
|
+
expMonth: import("zod").ZodNumber;
|
|
4945
|
+
expYear: import("zod").ZodNumber;
|
|
4946
|
+
}, import("zod/v4/core").$strict>>;
|
|
4947
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
4948
|
+
brand: import("zod").ZodString;
|
|
4949
|
+
last4: import("zod").ZodString;
|
|
4950
|
+
expMonth: import("zod").ZodNumber;
|
|
4951
|
+
expYear: import("zod").ZodNumber;
|
|
4952
|
+
type: import("zod").ZodLiteral<"card">;
|
|
4953
|
+
label: import("zod").ZodString;
|
|
4954
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4955
|
+
type: import("zod").ZodLiteral<"link">;
|
|
4956
|
+
label: import("zod").ZodString;
|
|
4957
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
4958
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4959
|
+
type: import("zod").ZodLiteral<"other">;
|
|
4960
|
+
label: import("zod").ZodString;
|
|
4961
|
+
providerType: import("zod").ZodString;
|
|
4962
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
4963
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4964
|
+
readonly scopes: readonly ["billing:write"];
|
|
4965
|
+
readonly sessionAuthority: "headers";
|
|
4966
|
+
readonly summary: "" | "Confirm a saved payment method";
|
|
4967
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4968
|
+
}, {
|
|
4969
|
+
readonly creates: false;
|
|
4970
|
+
readonly description: "" | "Removes the verified organization's saved payment method, and with it everything that charges it. Removing it stops renewal: every project subscription is set to end at the end of the period already paid for, so paid projects keep running until then and then stop, with nothing refunded and nothing more charged; billing.projects shows each one's cancellationAt. The included free project is unaffected. Automatic top-up turns off immediately and forgets its payment method. A pending or declined project addition is ended, so nothing later starts a checkout or a charge, and no project can be added until a payment method is saved again. The method stops being the provider default and is detached from the organization's customer. The request must carry confirmed: true. Repeating the call is safe: with nothing on file it answers a null method and card and still makes sure nothing is left that could charge one. Saving a payment method through billing.paymentmethodsetup before the period ends keeps those projects: renewal resumes on the new method, except for any project the customer cancelled themselves. After the period ends, a paid project must be added again.";
|
|
4971
|
+
readonly environments: readonly ["live"];
|
|
4972
|
+
readonly example: {
|
|
4973
|
+
card?: never;
|
|
4974
|
+
method?: never;
|
|
4975
|
+
} | {
|
|
4976
|
+
card: null;
|
|
4977
|
+
method: null;
|
|
4978
|
+
};
|
|
4979
|
+
readonly id: "billing.paymentmethodremove";
|
|
4980
|
+
readonly idempotent: true;
|
|
4981
|
+
readonly mcp: {
|
|
4982
|
+
readonly destructive: true;
|
|
4983
|
+
readonly kind: "tool";
|
|
4984
|
+
readonly openWorld: false;
|
|
4985
|
+
};
|
|
4986
|
+
readonly method: "POST";
|
|
4987
|
+
readonly mutates: true;
|
|
4988
|
+
readonly path: "/v1/billing/payment-method/remove";
|
|
4989
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4990
|
+
readonly problems: readonly ["invalid_request", "not_found", "service_unavailable", "state_conflict", "revision_conflict", "test_to_live_escalation"];
|
|
4991
|
+
readonly request: import("zod").ZodObject<{
|
|
4992
|
+
confirmed: import("zod").ZodLiteral<true>;
|
|
4993
|
+
}, import("zod/v4/core").$strict>;
|
|
4994
|
+
readonly requestExample: {
|
|
4995
|
+
confirmed?: never;
|
|
4996
|
+
} | {
|
|
4997
|
+
confirmed: boolean;
|
|
4998
|
+
};
|
|
4999
|
+
readonly response: import("zod").ZodObject<{
|
|
5000
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
5001
|
+
brand: import("zod").ZodString;
|
|
5002
|
+
last4: import("zod").ZodString;
|
|
5003
|
+
expMonth: import("zod").ZodNumber;
|
|
5004
|
+
expYear: import("zod").ZodNumber;
|
|
5005
|
+
}, import("zod/v4/core").$strict>>;
|
|
5006
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
5007
|
+
brand: import("zod").ZodString;
|
|
5008
|
+
last4: import("zod").ZodString;
|
|
5009
|
+
expMonth: import("zod").ZodNumber;
|
|
5010
|
+
expYear: import("zod").ZodNumber;
|
|
5011
|
+
type: import("zod").ZodLiteral<"card">;
|
|
5012
|
+
label: import("zod").ZodString;
|
|
5013
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
5014
|
+
type: import("zod").ZodLiteral<"link">;
|
|
5015
|
+
label: import("zod").ZodString;
|
|
5016
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
5017
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
5018
|
+
type: import("zod").ZodLiteral<"other">;
|
|
5019
|
+
label: import("zod").ZodString;
|
|
5020
|
+
providerType: import("zod").ZodString;
|
|
5021
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
5022
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
5023
|
+
readonly scopes: readonly ["billing:write"];
|
|
5024
|
+
readonly sessionAuthority: "headers";
|
|
5025
|
+
readonly summary: "" | "Remove the saved payment method";
|
|
5026
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4085
5027
|
}, {
|
|
4086
5028
|
readonly creates: false;
|
|
4087
5029
|
readonly description: "" | "Advances at most one due, already-authorized desired billing-policy revision for the caller's organization into PostgreSQL, then returns the same exact desired/effective summary as billing.summary. The command never changes the desired document. A transport failure is recorded for bounded retry and remains pending. Repeating the command may advance the next queued revision, so each call requires approval.";
|
|
@@ -4098,7 +5040,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4098
5040
|
readonly mutates: true;
|
|
4099
5041
|
readonly path: "/v1/billing/reconcile";
|
|
4100
5042
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4101
|
-
readonly problems: readonly ["service_unavailable", "test_to_live_escalation"];
|
|
5043
|
+
readonly problems: readonly ["billing_not_ready", "service_unavailable", "test_to_live_escalation"];
|
|
4102
5044
|
readonly response: import("zod").ZodObject<{
|
|
4103
5045
|
activation: import("zod").ZodObject<{
|
|
4104
5046
|
boundary: import("zod").ZodString;
|
|
@@ -4423,6 +5365,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4423
5365
|
service_blocked: "service_blocked";
|
|
4424
5366
|
service_restored: "service_restored";
|
|
4425
5367
|
}>;
|
|
5368
|
+
note: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5369
|
+
"provider-details-attached": "provider-details-attached";
|
|
5370
|
+
}>>;
|
|
4426
5371
|
period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4427
5372
|
recordedAt: import("zod").ZodString;
|
|
4428
5373
|
reference: import("zod").ZodObject<{
|
|
@@ -4442,6 +5387,83 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4442
5387
|
readonly sessionAuthority: "headers";
|
|
4443
5388
|
readonly summary: "" | "List immutable billing entries";
|
|
4444
5389
|
readonly surfaces: readonly ["api", "mock"];
|
|
5390
|
+
}, {
|
|
5391
|
+
readonly creates: false;
|
|
5392
|
+
readonly description: "" | "Read effective customer allowances for the verified organization. Deployment and organization revisions identify the policy used; infrastructure and other organizations' settings are excluded.";
|
|
5393
|
+
readonly example: {
|
|
5394
|
+
limits?: never;
|
|
5395
|
+
provenance?: never;
|
|
5396
|
+
revision?: never;
|
|
5397
|
+
} | {
|
|
5398
|
+
limits: {
|
|
5399
|
+
inlinePayloadBytes: number;
|
|
5400
|
+
forecastHorizonSeconds: number;
|
|
5401
|
+
usageWindowDays: number;
|
|
5402
|
+
};
|
|
5403
|
+
provenance: {
|
|
5404
|
+
inlinePayloadBytes: string;
|
|
5405
|
+
forecastHorizonSeconds: string;
|
|
5406
|
+
usageWindowDays: string;
|
|
5407
|
+
};
|
|
5408
|
+
revision: {
|
|
5409
|
+
global: number;
|
|
5410
|
+
organization: number;
|
|
5411
|
+
};
|
|
5412
|
+
};
|
|
5413
|
+
readonly id: "limits.read";
|
|
5414
|
+
readonly idempotent: true;
|
|
5415
|
+
readonly mcp: {
|
|
5416
|
+
readonly destructive: false;
|
|
5417
|
+
readonly kind: "tool";
|
|
5418
|
+
readonly openWorld: false;
|
|
5419
|
+
};
|
|
5420
|
+
readonly method: "GET";
|
|
5421
|
+
readonly mutates: false;
|
|
5422
|
+
readonly path: "/v1/limits";
|
|
5423
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
5424
|
+
readonly problems: readonly ["service_unavailable"];
|
|
5425
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5426
|
+
limits: import("zod").ZodObject<{
|
|
5427
|
+
inlinePayloadBytes: import("zod").ZodNumber;
|
|
5428
|
+
partitionKeyCeiling: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5429
|
+
forecastHorizonSeconds: import("zod").ZodNumber;
|
|
5430
|
+
usageWindowDays: import("zod").ZodNumber;
|
|
5431
|
+
}, import("zod/v4/core").$strict>;
|
|
5432
|
+
provenance: import("zod").ZodObject<{
|
|
5433
|
+
inlinePayloadBytes: import("zod").ZodEnum<{
|
|
5434
|
+
organization: "organization";
|
|
5435
|
+
default: "default";
|
|
5436
|
+
global: "global";
|
|
5437
|
+
deployment: "deployment";
|
|
5438
|
+
}>;
|
|
5439
|
+
partitionKeyCeiling: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5440
|
+
organization: "organization";
|
|
5441
|
+
default: "default";
|
|
5442
|
+
global: "global";
|
|
5443
|
+
deployment: "deployment";
|
|
5444
|
+
}>>;
|
|
5445
|
+
forecastHorizonSeconds: import("zod").ZodEnum<{
|
|
5446
|
+
organization: "organization";
|
|
5447
|
+
default: "default";
|
|
5448
|
+
global: "global";
|
|
5449
|
+
deployment: "deployment";
|
|
5450
|
+
}>;
|
|
5451
|
+
usageWindowDays: import("zod").ZodEnum<{
|
|
5452
|
+
organization: "organization";
|
|
5453
|
+
default: "default";
|
|
5454
|
+
global: "global";
|
|
5455
|
+
deployment: "deployment";
|
|
5456
|
+
}>;
|
|
5457
|
+
}, import("zod/v4/core").$strict>;
|
|
5458
|
+
revision: import("zod").ZodObject<{
|
|
5459
|
+
global: import("zod").ZodNumber;
|
|
5460
|
+
organization: import("zod").ZodNumber;
|
|
5461
|
+
}, import("zod/v4/core").$strict>;
|
|
5462
|
+
}, import("zod/v4/core").$strict>;
|
|
5463
|
+
readonly scopes: readonly ["schedules:read"];
|
|
5464
|
+
readonly sessionAuthority: "headers";
|
|
5465
|
+
readonly summary: "" | "Read effective customer limits";
|
|
5466
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4445
5467
|
}, {
|
|
4446
5468
|
readonly creates: false;
|
|
4447
5469
|
readonly description: "" | "Legacy terminal-occurrence volume by UTC day from the authoritative scheduling model. This is an operational outcome aggregate retained for compatibility; it is not the PAYG invoice meter. Billing is per logical delivery attempt, including retries and redeliveries, and is exposed exactly by billing.summary and billing.ledger. Days with no terminal occurrence are absent rather than zero, and the window states which days the answer covers. `from` and `to` are snapped outward to UTC midnight, so an answer always covers whole days.";
|
|
@@ -4645,7 +5667,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4645
5667
|
readonly idempotent: true;
|
|
4646
5668
|
readonly mcp: {
|
|
4647
5669
|
readonly kind: "unavailable";
|
|
4648
|
-
readonly reason: "A transitional shape for the autoscaler migration,
|
|
5670
|
+
readonly reason: "A transitional shape for the autoscaler migration, withdrawn after its cutover. forecast.read is the same data in the shape this product publishes, and it is the tool an agent should reach for.";
|
|
4649
5671
|
};
|
|
4650
5672
|
readonly method: "GET";
|
|
4651
5673
|
readonly mutates: false;
|
|
@@ -4725,7 +5747,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4725
5747
|
newest: "newest";
|
|
4726
5748
|
}>>;
|
|
4727
5749
|
}, import("zod/v4/core").$strip>;
|
|
4728
|
-
readonly response: import("zod").ZodObject<{
|
|
5750
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
4729
5751
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4730
5752
|
generation: import("zod").ZodNumber;
|
|
4731
5753
|
id: import("zod").ZodString;
|
|
@@ -4759,7 +5781,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4759
5781
|
freshness: import("zod").ZodObject<{
|
|
4760
5782
|
kind: import("zod").ZodLiteral<"authoritative">;
|
|
4761
5783
|
}, import("zod/v4/core").$strip>;
|
|
4762
|
-
}, import("zod/v4/core").$strip
|
|
5784
|
+
}, import("zod/v4/core").$strip>;
|
|
4763
5785
|
readonly scopes: readonly ["occurrences:read"];
|
|
4764
5786
|
readonly sessionAuthority: "headers";
|
|
4765
5787
|
readonly summary: "" | "List retained occurrences";
|
|
@@ -4820,7 +5842,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4820
5842
|
schedule: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4821
5843
|
to: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4822
5844
|
}, import("zod/v4/core").$strip>;
|
|
4823
|
-
readonly response: import("zod").ZodObject<{
|
|
5845
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
4824
5846
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4825
5847
|
generation: import("zod").ZodNumber;
|
|
4826
5848
|
id: import("zod").ZodString;
|
|
@@ -4857,7 +5879,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4857
5879
|
retention: import("zod").ZodObject<{
|
|
4858
5880
|
from: import("zod").ZodString;
|
|
4859
5881
|
}, import("zod/v4/core").$strip>;
|
|
4860
|
-
}, import("zod/v4/core").$strip
|
|
5882
|
+
}, import("zod/v4/core").$strip>;
|
|
4861
5883
|
readonly scopes: readonly ["occurrences:read"];
|
|
4862
5884
|
readonly sessionAuthority: "headers";
|
|
4863
5885
|
readonly summary: "" | "List project executions";
|
|
@@ -4899,7 +5921,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4899
5921
|
readonly path: "/v1/schedules/{scheduleId}/occurrences/{occurrenceId}";
|
|
4900
5922
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4901
5923
|
readonly problems: readonly ["invalid_request", "not_found"];
|
|
4902
|
-
readonly response: import("zod").ZodObject<{
|
|
5924
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
4903
5925
|
freshness: import("zod").ZodObject<{
|
|
4904
5926
|
kind: import("zod").ZodLiteral<"authoritative">;
|
|
4905
5927
|
}, import("zod/v4/core").$strip>;
|
|
@@ -4932,7 +5954,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4932
5954
|
timingPolicyVersion: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4933
5955
|
attemptCount: import("zod").ZodNumber;
|
|
4934
5956
|
}, import("zod/v4/core").$strip>;
|
|
4935
|
-
}, import("zod/v4/core").$strip
|
|
5957
|
+
}, import("zod/v4/core").$strip>;
|
|
4936
5958
|
readonly scopes: readonly ["occurrences:read"];
|
|
4937
5959
|
readonly sessionAuthority: "headers";
|
|
4938
5960
|
readonly summary: "" | "Read an occurrence";
|
|
@@ -4948,6 +5970,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4948
5970
|
data: {
|
|
4949
5971
|
attemptNumber: number;
|
|
4950
5972
|
classifiedAt: string;
|
|
5973
|
+
dispatchRecoveries: number;
|
|
5974
|
+
localReceiptRecoveries: number;
|
|
4951
5975
|
delivery: string;
|
|
4952
5976
|
diagnostic: string;
|
|
4953
5977
|
durationMs: number;
|
|
@@ -4986,10 +6010,12 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4986
6010
|
cursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4987
6011
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
4988
6012
|
}, import("zod/v4/core").$strip>;
|
|
4989
|
-
readonly response: import("zod").ZodObject<{
|
|
6013
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
4990
6014
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4991
6015
|
id: import("zod").ZodString;
|
|
6016
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
4992
6017
|
occurrence: import("zod").ZodString;
|
|
6018
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
4993
6019
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
4994
6020
|
none: "none";
|
|
4995
6021
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5048,13 +6074,14 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5048
6074
|
network_ambiguous: "network_ambiguous";
|
|
5049
6075
|
payload_unavailable: "payload_unavailable";
|
|
5050
6076
|
}>>;
|
|
6077
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5051
6078
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5052
6079
|
}, import("zod/v4/core").$strip>>;
|
|
5053
6080
|
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5054
6081
|
freshness: import("zod").ZodObject<{
|
|
5055
6082
|
kind: import("zod").ZodLiteral<"authoritative">;
|
|
5056
6083
|
}, import("zod/v4/core").$strip>;
|
|
5057
|
-
}, import("zod/v4/core").$strip
|
|
6084
|
+
}, import("zod/v4/core").$strip>;
|
|
5058
6085
|
readonly scopes: readonly ["occurrences:read"];
|
|
5059
6086
|
readonly sessionAuthority: "headers";
|
|
5060
6087
|
readonly summary: "" | "List delivery attempts";
|
|
@@ -5069,6 +6096,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5069
6096
|
attempt: {
|
|
5070
6097
|
attemptNumber: number;
|
|
5071
6098
|
classifiedAt: string;
|
|
6099
|
+
dispatchRecoveries: number;
|
|
6100
|
+
localReceiptRecoveries: number;
|
|
5072
6101
|
delivery: string;
|
|
5073
6102
|
diagnostic: string;
|
|
5074
6103
|
durationMs: number;
|
|
@@ -5101,10 +6130,12 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5101
6130
|
readonly path: "/v1/schedules/{scheduleId}/occurrences/{occurrenceId}/attempts/{attemptId}";
|
|
5102
6131
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
5103
6132
|
readonly problems: readonly ["invalid_request", "not_found"];
|
|
5104
|
-
readonly response: import("zod").ZodObject<{
|
|
6133
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5105
6134
|
attempt: import("zod").ZodObject<{
|
|
5106
6135
|
id: import("zod").ZodString;
|
|
6136
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5107
6137
|
occurrence: import("zod").ZodString;
|
|
6138
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5108
6139
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5109
6140
|
none: "none";
|
|
5110
6141
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5163,12 +6194,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5163
6194
|
network_ambiguous: "network_ambiguous";
|
|
5164
6195
|
payload_unavailable: "payload_unavailable";
|
|
5165
6196
|
}>>;
|
|
6197
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5166
6198
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5167
6199
|
}, import("zod/v4/core").$strip>;
|
|
5168
6200
|
freshness: import("zod").ZodObject<{
|
|
5169
6201
|
kind: import("zod").ZodLiteral<"authoritative">;
|
|
5170
6202
|
}, import("zod/v4/core").$strip>;
|
|
5171
|
-
}, import("zod/v4/core").$strip
|
|
6203
|
+
}, import("zod/v4/core").$strip>;
|
|
5172
6204
|
readonly scopes: readonly ["occurrences:read"];
|
|
5173
6205
|
readonly sessionAuthority: "headers";
|
|
5174
6206
|
readonly summary: "" | "Read a delivery attempt";
|
|
@@ -5189,6 +6221,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5189
6221
|
} | {
|
|
5190
6222
|
attempt: {
|
|
5191
6223
|
attemptNumber: number;
|
|
6224
|
+
dispatchRecoveries: number;
|
|
6225
|
+
localReceiptRecoveries: number;
|
|
5192
6226
|
delivery: string;
|
|
5193
6227
|
id: string;
|
|
5194
6228
|
occurrence: string;
|
|
@@ -5217,10 +6251,12 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5217
6251
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5218
6252
|
"Idempotency-Key": import("zod").ZodString;
|
|
5219
6253
|
}, import("zod/v4/core").$strip>;
|
|
5220
|
-
readonly response: import("zod").ZodObject<{
|
|
6254
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5221
6255
|
attempt: import("zod").ZodObject<{
|
|
5222
6256
|
id: import("zod").ZodString;
|
|
6257
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5223
6258
|
occurrence: import("zod").ZodString;
|
|
6259
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5224
6260
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5225
6261
|
none: "none";
|
|
5226
6262
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5279,12 +6315,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5279
6315
|
network_ambiguous: "network_ambiguous";
|
|
5280
6316
|
payload_unavailable: "payload_unavailable";
|
|
5281
6317
|
}>>;
|
|
6318
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5282
6319
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5283
6320
|
}, import("zod/v4/core").$strip>;
|
|
5284
6321
|
freshness: import("zod").ZodObject<{
|
|
5285
6322
|
kind: import("zod").ZodLiteral<"authoritative">;
|
|
5286
6323
|
}, import("zod/v4/core").$strip>;
|
|
5287
|
-
}, import("zod/v4/core").$strip
|
|
6324
|
+
}, import("zod/v4/core").$strip>;
|
|
5288
6325
|
}, {
|
|
5289
6326
|
readonly scopes: readonly ["schedules:write"];
|
|
5290
6327
|
readonly sessionAuthority: "headers";
|
|
@@ -5294,7 +6331,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5294
6331
|
ETag: import("zod").ZodString;
|
|
5295
6332
|
}, import("zod/v4/core").$strip>;
|
|
5296
6333
|
readonly creates: false;
|
|
5297
|
-
readonly description: "" | "Replaces a schedule's definition, starting a new generation. Takes the same four ways of saying when as a create, so a one-shot can be replaced by a recurring definition and the other way round. An omitted callback endpoint/data pair preserves the stored callback; sending `data` alone replaces the encrypted data for the current endpoint, and sending `endpoint` selects a verified endpoint in the same authority tuple. The occurrence planned under the old definition is settled `skipped_stale` and can never fire unless it was already in flight, in which case its immutable attempt is allowed to settle honestly; a fresh occurrence is planned under the new definition, and the old definition's series stops advancing. `lateness` is resolved afresh against the replacement recurrence: omit it for that kind's default, or state `skipAhead`, `catchUp`, and an optional `maxStalenessSeconds` override. The policy applies only before an occurrence's first attempt; a retry already in progress remains on its retry and give-up ladder. Send `If-Match` with the version you read to make this conditional; without it the replace is unconditional and the last writer wins. A cancelled or completed schedule cannot be replaced. `partitionKey` is fixed when the schedule is created: omit it to preserve the stored value or echo that exact value in a GET → modify → PUT flow. Adding, changing, or clearing it is refused as `invalid_request` with `/partitionKey` identified. `latencyClass` remains derived from the replacement recurrence when the caller omits it.";
|
|
6334
|
+
readonly description: "" | "Replaces a schedule's definition, starting a new generation. Takes the same four ways of saying when as a create, so a one-shot can be replaced by a recurring definition and the other way round. An omitted callback endpoint/data pair preserves the stored callback; sending `data` alone replaces the encrypted data for the current endpoint, and sending `endpoint` selects a verified endpoint in the same authority tuple. Sending `url` instead selects the endpoint at that address in the same tuple, creating one silently when there is none; creating needs `endpoints:write` as well, and the response's `endpointSigningSecret` says where its signing secret is revealed. Omitted `http` preserves HTTP settings. Its headers are a patch: `set` replaces a value, `keep` retains a configured value, `suppress` omits an endpoint default, and `remove` resumes inheritance. Explicit GET with no body clears a saved custom template; POST/PUT with `body: { mode: 'envelope' }` restores the structured callback. The occurrence planned under the old definition is settled `skipped_stale` and can never fire unless it was already in flight, in which case its immutable attempt is allowed to settle honestly; a fresh occurrence is planned under the new definition, and the old definition's series stops advancing. `lateness` is resolved afresh against the replacement recurrence: omit it for that kind's default, or state `skipAhead`, `catchUp`, and an optional `maxStalenessSeconds` override. The policy applies only before an occurrence's first attempt; a retry already in progress remains on its retry and give-up ladder. Send `If-Match` with the version you read to make this conditional; without it the replace is unconditional and the last writer wins. A cancelled or completed schedule cannot be replaced. `partitionKey` is fixed when the schedule is created: omit it to preserve the stored value or echo that exact value in a GET → modify → PUT flow. Adding, changing, or clearing it is refused as `invalid_request` with `/partitionKey` identified. `latencyClass` remains derived from the replacement recurrence when the caller omits it.";
|
|
5298
6335
|
readonly example: {
|
|
5299
6336
|
occurrence?: never;
|
|
5300
6337
|
schedule?: never;
|
|
@@ -5336,9 +6373,39 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5336
6373
|
readonly method: "PUT";
|
|
5337
6374
|
readonly mutates: true;
|
|
5338
6375
|
readonly path: "/v1/schedules/{scheduleId}";
|
|
6376
|
+
readonly conditionalScopes: readonly ["endpoints:write"];
|
|
6377
|
+
readonly conditionalScopesWhen: "the request names a `url` this project and environment has no endpoint at yet";
|
|
5339
6378
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
5340
|
-
readonly problems: readonly ["invalid_request", "not_found", "plan_limit_reached", "service_unavailable", "state_conflict", "version_conflict"];
|
|
6379
|
+
readonly problems: readonly ["invalid_request", "not_found", "plan_limit_reached", "rate_limited", "scope_missing", "service_unavailable", "state_conflict", "version_conflict"];
|
|
5341
6380
|
readonly request: import("zod").ZodObject<{
|
|
6381
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6382
|
+
method: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
6383
|
+
POST: "POST";
|
|
6384
|
+
PUT: "PUT";
|
|
6385
|
+
GET: "GET";
|
|
6386
|
+
}>>;
|
|
6387
|
+
body: import("zod").ZodOptional<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
6388
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
6389
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6390
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
6391
|
+
value: import("zod").ZodJSONSchema;
|
|
6392
|
+
}, import("zod/v4/core").$strict>], "mode">>;
|
|
6393
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
6394
|
+
action: import("zod").ZodLiteral<"set">;
|
|
6395
|
+
name: import("zod").ZodString;
|
|
6396
|
+
value: import("zod").ZodString;
|
|
6397
|
+
secret: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
6398
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6399
|
+
action: import("zod").ZodLiteral<"keep">;
|
|
6400
|
+
name: import("zod").ZodString;
|
|
6401
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6402
|
+
action: import("zod").ZodLiteral<"remove">;
|
|
6403
|
+
name: import("zod").ZodString;
|
|
6404
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6405
|
+
action: import("zod").ZodLiteral<"suppress">;
|
|
6406
|
+
name: import("zod").ZodString;
|
|
6407
|
+
}, import("zod/v4/core").$strict>], "action">>>;
|
|
6408
|
+
}, import("zod/v4/core").$strict>>;
|
|
5342
6409
|
at: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5343
6410
|
cron: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5344
6411
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
@@ -5356,6 +6423,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5356
6423
|
}, import("zod/v4/core").$strict>>;
|
|
5357
6424
|
everySeconds: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5358
6425
|
endpoint: import("zod").ZodOptional<import("zod").ZodString>;
|
|
6426
|
+
url: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5359
6427
|
latencyClass: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5360
6428
|
realtime: "realtime";
|
|
5361
6429
|
bulk: "bulk";
|
|
@@ -5392,7 +6460,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5392
6460
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5393
6461
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
5394
6462
|
}, import("zod/v4/core").$strip>;
|
|
5395
|
-
readonly response: import("zod").ZodObject<{
|
|
6463
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5396
6464
|
occurrence: import("zod").ZodObject<{
|
|
5397
6465
|
generation: import("zod").ZodNumber;
|
|
5398
6466
|
id: import("zod").ZodString;
|
|
@@ -5423,6 +6491,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5423
6491
|
attemptCount: import("zod").ZodNumber;
|
|
5424
6492
|
}, import("zod/v4/core").$strip>;
|
|
5425
6493
|
schedule: import("zod").ZodObject<{
|
|
6494
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6495
|
+
method: import("zod").ZodEnum<{
|
|
6496
|
+
POST: "POST";
|
|
6497
|
+
PUT: "PUT";
|
|
6498
|
+
GET: "GET";
|
|
6499
|
+
}>;
|
|
6500
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
6501
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
6502
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6503
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
6504
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6505
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
6506
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
6507
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
6508
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
6509
|
+
name: import("zod").ZodString;
|
|
6510
|
+
secret: import("zod").ZodLiteral<false>;
|
|
6511
|
+
value: import("zod").ZodString;
|
|
6512
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6513
|
+
name: import("zod").ZodString;
|
|
6514
|
+
secret: import("zod").ZodLiteral<true>;
|
|
6515
|
+
configured: import("zod").ZodLiteral<true>;
|
|
6516
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
6517
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6518
|
+
name: import("zod").ZodString;
|
|
6519
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
6520
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
6521
|
+
}, import("zod/v4/core").$strict>>;
|
|
5426
6522
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5427
6523
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
5428
6524
|
createdAt: import("zod").ZodString;
|
|
@@ -5474,7 +6570,12 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5474
6570
|
updatedAt: import("zod").ZodString;
|
|
5475
6571
|
version: import("zod").ZodNumber;
|
|
5476
6572
|
}, import("zod/v4/core").$strip>;
|
|
5477
|
-
|
|
6573
|
+
endpointSigningSecret: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6574
|
+
guidance: import("zod").ZodString;
|
|
6575
|
+
returned: import("zod").ZodLiteral<false>;
|
|
6576
|
+
revealUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
6577
|
+
}, import("zod/v4/core").$strip>>;
|
|
6578
|
+
}, import("zod/v4/core").$strip>;
|
|
5478
6579
|
}, {
|
|
5479
6580
|
readonly scopes: readonly ["schedules:write"];
|
|
5480
6581
|
readonly sessionAuthority: "headers";
|
|
@@ -5529,7 +6630,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5529
6630
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5530
6631
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
5531
6632
|
}, import("zod/v4/core").$strip>;
|
|
5532
|
-
readonly response: import("zod").ZodObject<{
|
|
6633
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5533
6634
|
occurrence: import("zod").ZodObject<{
|
|
5534
6635
|
generation: import("zod").ZodNumber;
|
|
5535
6636
|
id: import("zod").ZodString;
|
|
@@ -5560,6 +6661,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5560
6661
|
attemptCount: import("zod").ZodNumber;
|
|
5561
6662
|
}, import("zod/v4/core").$strip>;
|
|
5562
6663
|
schedule: import("zod").ZodObject<{
|
|
6664
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6665
|
+
method: import("zod").ZodEnum<{
|
|
6666
|
+
POST: "POST";
|
|
6667
|
+
PUT: "PUT";
|
|
6668
|
+
GET: "GET";
|
|
6669
|
+
}>;
|
|
6670
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
6671
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
6672
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6673
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
6674
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6675
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
6676
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
6677
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
6678
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
6679
|
+
name: import("zod").ZodString;
|
|
6680
|
+
secret: import("zod").ZodLiteral<false>;
|
|
6681
|
+
value: import("zod").ZodString;
|
|
6682
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6683
|
+
name: import("zod").ZodString;
|
|
6684
|
+
secret: import("zod").ZodLiteral<true>;
|
|
6685
|
+
configured: import("zod").ZodLiteral<true>;
|
|
6686
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
6687
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6688
|
+
name: import("zod").ZodString;
|
|
6689
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
6690
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
6691
|
+
}, import("zod/v4/core").$strict>>;
|
|
5563
6692
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5564
6693
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
5565
6694
|
createdAt: import("zod").ZodString;
|
|
@@ -5611,7 +6740,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5611
6740
|
updatedAt: import("zod").ZodString;
|
|
5612
6741
|
version: import("zod").ZodNumber;
|
|
5613
6742
|
}, import("zod/v4/core").$strip>;
|
|
5614
|
-
}, import("zod/v4/core").$strip
|
|
6743
|
+
}, import("zod/v4/core").$strip>;
|
|
5615
6744
|
}, {
|
|
5616
6745
|
readonly scopes: readonly ["schedules:write"];
|
|
5617
6746
|
readonly sessionAuthority: "headers";
|
|
@@ -5666,7 +6795,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5666
6795
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5667
6796
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
5668
6797
|
}, import("zod/v4/core").$strip>;
|
|
5669
|
-
readonly response: import("zod").ZodObject<{
|
|
6798
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5670
6799
|
occurrence: import("zod").ZodObject<{
|
|
5671
6800
|
generation: import("zod").ZodNumber;
|
|
5672
6801
|
id: import("zod").ZodString;
|
|
@@ -5697,6 +6826,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5697
6826
|
attemptCount: import("zod").ZodNumber;
|
|
5698
6827
|
}, import("zod/v4/core").$strip>;
|
|
5699
6828
|
schedule: import("zod").ZodObject<{
|
|
6829
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6830
|
+
method: import("zod").ZodEnum<{
|
|
6831
|
+
POST: "POST";
|
|
6832
|
+
PUT: "PUT";
|
|
6833
|
+
GET: "GET";
|
|
6834
|
+
}>;
|
|
6835
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
6836
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
6837
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6838
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
6839
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6840
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
6841
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
6842
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
6843
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
6844
|
+
name: import("zod").ZodString;
|
|
6845
|
+
secret: import("zod").ZodLiteral<false>;
|
|
6846
|
+
value: import("zod").ZodString;
|
|
6847
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6848
|
+
name: import("zod").ZodString;
|
|
6849
|
+
secret: import("zod").ZodLiteral<true>;
|
|
6850
|
+
configured: import("zod").ZodLiteral<true>;
|
|
6851
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
6852
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
6853
|
+
name: import("zod").ZodString;
|
|
6854
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
6855
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
6856
|
+
}, import("zod/v4/core").$strict>>;
|
|
5700
6857
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5701
6858
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
5702
6859
|
createdAt: import("zod").ZodString;
|
|
@@ -5748,7 +6905,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5748
6905
|
updatedAt: import("zod").ZodString;
|
|
5749
6906
|
version: import("zod").ZodNumber;
|
|
5750
6907
|
}, import("zod/v4/core").$strip>;
|
|
5751
|
-
}, import("zod/v4/core").$strip
|
|
6908
|
+
}, import("zod/v4/core").$strip>;
|
|
5752
6909
|
}, {
|
|
5753
6910
|
readonly scopes: readonly ["schedules:write"];
|
|
5754
6911
|
readonly sessionAuthority: "headers";
|
|
@@ -5804,7 +6961,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5804
6961
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5805
6962
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
5806
6963
|
}, import("zod/v4/core").$strip>;
|
|
5807
|
-
readonly response: import("zod").ZodObject<{
|
|
6964
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5808
6965
|
occurrence: import("zod").ZodObject<{
|
|
5809
6966
|
generation: import("zod").ZodNumber;
|
|
5810
6967
|
id: import("zod").ZodString;
|
|
@@ -5835,6 +6992,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5835
6992
|
attemptCount: import("zod").ZodNumber;
|
|
5836
6993
|
}, import("zod/v4/core").$strip>;
|
|
5837
6994
|
schedule: import("zod").ZodObject<{
|
|
6995
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
6996
|
+
method: import("zod").ZodEnum<{
|
|
6997
|
+
POST: "POST";
|
|
6998
|
+
PUT: "PUT";
|
|
6999
|
+
GET: "GET";
|
|
7000
|
+
}>;
|
|
7001
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
7002
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
7003
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7004
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
7005
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7006
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
7007
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
7008
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
7009
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
7010
|
+
name: import("zod").ZodString;
|
|
7011
|
+
secret: import("zod").ZodLiteral<false>;
|
|
7012
|
+
value: import("zod").ZodString;
|
|
7013
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7014
|
+
name: import("zod").ZodString;
|
|
7015
|
+
secret: import("zod").ZodLiteral<true>;
|
|
7016
|
+
configured: import("zod").ZodLiteral<true>;
|
|
7017
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
7018
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7019
|
+
name: import("zod").ZodString;
|
|
7020
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
7021
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
7022
|
+
}, import("zod/v4/core").$strict>>;
|
|
5838
7023
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5839
7024
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
5840
7025
|
createdAt: import("zod").ZodString;
|
|
@@ -5886,7 +7071,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5886
7071
|
updatedAt: import("zod").ZodString;
|
|
5887
7072
|
version: import("zod").ZodNumber;
|
|
5888
7073
|
}, import("zod/v4/core").$strip>;
|
|
5889
|
-
}, import("zod/v4/core").$strip
|
|
7074
|
+
}, import("zod/v4/core").$strip>;
|
|
5890
7075
|
}, {
|
|
5891
7076
|
readonly scopes: readonly ["schedules:write"];
|
|
5892
7077
|
readonly sessionAuthority: "headers";
|
|
@@ -5943,7 +7128,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5943
7128
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
5944
7129
|
"If-Match": import("zod").ZodOptional<import("zod").ZodString>;
|
|
5945
7130
|
}, import("zod/v4/core").$strip>;
|
|
5946
|
-
readonly response: import("zod").ZodObject<{
|
|
7131
|
+
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
5947
7132
|
occurrence: import("zod").ZodObject<{
|
|
5948
7133
|
generation: import("zod").ZodNumber;
|
|
5949
7134
|
id: import("zod").ZodString;
|
|
@@ -5974,6 +7159,34 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5974
7159
|
attemptCount: import("zod").ZodNumber;
|
|
5975
7160
|
}, import("zod/v4/core").$strip>;
|
|
5976
7161
|
schedule: import("zod").ZodObject<{
|
|
7162
|
+
http: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
7163
|
+
method: import("zod").ZodEnum<{
|
|
7164
|
+
POST: "POST";
|
|
7165
|
+
PUT: "PUT";
|
|
7166
|
+
GET: "GET";
|
|
7167
|
+
}>;
|
|
7168
|
+
body: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
7169
|
+
mode: import("zod").ZodLiteral<"envelope">;
|
|
7170
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7171
|
+
mode: import("zod").ZodLiteral<"none">;
|
|
7172
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7173
|
+
mode: import("zod").ZodLiteral<"json">;
|
|
7174
|
+
value: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
7175
|
+
}, import("zod/v4/core").$strict>], "mode">;
|
|
7176
|
+
headers: import("zod").ZodArray<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
7177
|
+
name: import("zod").ZodString;
|
|
7178
|
+
secret: import("zod").ZodLiteral<false>;
|
|
7179
|
+
value: import("zod").ZodString;
|
|
7180
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7181
|
+
name: import("zod").ZodString;
|
|
7182
|
+
secret: import("zod").ZodLiteral<true>;
|
|
7183
|
+
configured: import("zod").ZodLiteral<true>;
|
|
7184
|
+
value: import("zod").ZodOptional<import("zod").ZodNever>;
|
|
7185
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
7186
|
+
name: import("zod").ZodString;
|
|
7187
|
+
suppressed: import("zod").ZodLiteral<true>;
|
|
7188
|
+
}, import("zod/v4/core").$strict>]>>;
|
|
7189
|
+
}, import("zod/v4/core").$strict>>;
|
|
5977
7190
|
archivedAt: import("zod").ZodOptional<import("zod").ZodString>;
|
|
5978
7191
|
data: import("zod").ZodOptional<import("zod").ZodJSONSchema>;
|
|
5979
7192
|
createdAt: import("zod").ZodString;
|
|
@@ -6025,7 +7238,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
6025
7238
|
updatedAt: import("zod").ZodString;
|
|
6026
7239
|
version: import("zod").ZodNumber;
|
|
6027
7240
|
}, import("zod/v4/core").$strip>;
|
|
6028
|
-
}, import("zod/v4/core").$strip
|
|
7241
|
+
}, import("zod/v4/core").$strip>;
|
|
6029
7242
|
}];
|
|
6030
7243
|
/**
|
|
6031
7244
|
* Every declared operation id, as a literal union.
|
|
@@ -6036,6 +7249,40 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
6036
7249
|
* list and the implementation can drift together while the test still passes.
|
|
6037
7250
|
*/
|
|
6038
7251
|
export type OperationId = (typeof OPERATIONS)[number]["id"];
|
|
7252
|
+
/**
|
|
7253
|
+
* The body a caller sends to an operation, as its request schema accepts it.
|
|
7254
|
+
*
|
|
7255
|
+
* What the generated client types each builder's `body` with (W9-46). Until
|
|
7256
|
+
* then every body was `unknown`, so a field the API had accepted for weeks —
|
|
7257
|
+
* `url` on `schedules.create` — compiled exactly as well as a misspelling of
|
|
7258
|
+
* it, and the published package could not tell a TypeScript reader either was
|
|
7259
|
+
* wrong. The schema's *input* rather than its output: a caller writes what the
|
|
7260
|
+
* schema parses, before defaults and transforms.
|
|
7261
|
+
*/
|
|
7262
|
+
export type OperationRequestBody<TId extends OperationId> = [
|
|
7263
|
+
OperationEntry<TId>
|
|
7264
|
+
] extends [never] ? unknown : OperationEntry<TId> extends {
|
|
7265
|
+
readonly request: infer TSchema extends z.ZodTypeAny;
|
|
7266
|
+
} ? ReadonlyInput<z.input<TSchema>> : unknown;
|
|
7267
|
+
/**
|
|
7268
|
+
* A request body as a caller may hold it: readonly at every depth.
|
|
7269
|
+
*
|
|
7270
|
+
* A builder only reads what it is handed, and a caller keeping its settings in
|
|
7271
|
+
* `readonly` arrays (the dashboard's header changes do) should not have to copy
|
|
7272
|
+
* them to satisfy a type that promises nothing about mutation.
|
|
7273
|
+
*/
|
|
7274
|
+
type ReadonlyInput<T> = T extends readonly (infer TItem)[] ? readonly ReadonlyInput<TItem>[] : T extends object ? {
|
|
7275
|
+
readonly [TKey in keyof T]: ReadonlyInput<T[TKey]>;
|
|
7276
|
+
} : T;
|
|
7277
|
+
/**
|
|
7278
|
+
* One registry entry, by id — `never` for an entry contributed by a module
|
|
7279
|
+
* that declares its operations as plain `OperationDefinition`s, whose `id` is
|
|
7280
|
+
* `string`. Those bodies stay `unknown` rather than collapsing to `never`,
|
|
7281
|
+
* which would make the operation uncallable.
|
|
7282
|
+
*/
|
|
7283
|
+
type OperationEntry<TId extends OperationId> = Extract<(typeof OPERATIONS)[number], {
|
|
7284
|
+
readonly id: TId;
|
|
7285
|
+
}>;
|
|
6039
7286
|
/**
|
|
6040
7287
|
* Headers the contract mock uses to expose state a body cannot carry.
|
|
6041
7288
|
*
|