@greatwait/contracts 0.1.0-alpha.4 → 0.1.0-alpha.5
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/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/effective-limits.d.ts +40 -0
- package/dist/effective-limits.js +42 -0
- package/dist/endpoints.d.ts +5 -5
- package/dist/endpoints.js +5 -5
- 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/index.d.ts +5 -4
- package/dist/index.js +5 -4
- package/dist/mcp.js +1 -1
- package/dist/operational-config.d.ts +101 -0
- package/dist/operational-config.js +341 -0
- package/dist/operations.d.ts +597 -16
- package/dist/operations.js +384 -23
- package/dist/partition.d.ts +17 -9
- package/dist/partition.js +3 -3
- 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 +6 -0
- package/dist/scheduling.d.ts +37 -1
- package/dist/scheduling.js +60 -4
- package/dist/usage.js +6 -21
- 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/limits.read.response.json +16 -0
- package/generated/v1/examples/occurrences.redeliver.response.json +2 -0
- package/generated/v1/first-value-journey.json +24 -8
- package/generated/v1/manifest.json +342 -10
- package/generated/v1/openapi.json +12395 -6543
- package/generated/v1/policy-matrix.json +65 -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/forecast.read.request-headers.json +10 -0
- package/generated/v1/schemas/forecast.read.response.json +148 -0
- package/generated/v1/schemas/limits.read.response.json +79 -0
- package/generated/v1/schemas/occurrences.redeliver.response.json +15 -0
- 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/forecast.windows.json +1 -1
- package/generated/v1/snippets/limits.read.json +6 -0
- package/package.json +7 -2
package/dist/operations.d.ts
CHANGED
|
@@ -275,7 +275,149 @@ type BillingFundingContract = {
|
|
|
275
275
|
type NamedOperation<TId extends string> = OperationDefinition & {
|
|
276
276
|
readonly id: TId;
|
|
277
277
|
};
|
|
278
|
-
export declare const OPERATIONS: readonly [
|
|
278
|
+
export declare const OPERATIONS: readonly [{
|
|
279
|
+
readonly creates: false;
|
|
280
|
+
readonly description: "" | "Read the verified organization's execution-credit payments with bounded cursor continuation. Existing recent-history responses remain compatible.";
|
|
281
|
+
readonly example: {
|
|
282
|
+
data?: never;
|
|
283
|
+
freshness?: never;
|
|
284
|
+
} | {
|
|
285
|
+
data: never[];
|
|
286
|
+
freshness: {
|
|
287
|
+
kind: string;
|
|
288
|
+
};
|
|
289
|
+
};
|
|
290
|
+
readonly id: "billing.paymenthistory";
|
|
291
|
+
readonly idempotent: true;
|
|
292
|
+
readonly mcp: {
|
|
293
|
+
readonly destructive: false;
|
|
294
|
+
readonly kind: "tool";
|
|
295
|
+
readonly openWorld: false;
|
|
296
|
+
};
|
|
297
|
+
readonly method: "GET";
|
|
298
|
+
readonly mutates: false;
|
|
299
|
+
readonly path: "/v1/billing/payment-history";
|
|
300
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
301
|
+
readonly problems: readonly ["invalid_request", "service_unavailable"];
|
|
302
|
+
readonly query: import("zod").ZodObject<{
|
|
303
|
+
cursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
304
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
305
|
+
}, import("zod/v4/core").$strip>;
|
|
306
|
+
readonly response: import("zod").ZodObject<{
|
|
307
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
308
|
+
createdAt: import("zod").ZodString;
|
|
309
|
+
credit: import("zod").ZodObject<{
|
|
310
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
311
|
+
microdollars: import("zod").ZodString;
|
|
312
|
+
scale: import("zod").ZodLiteral<6>;
|
|
313
|
+
}, import("zod/v4/core").$strip>;
|
|
314
|
+
gross: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
315
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
316
|
+
microdollars: import("zod").ZodString;
|
|
317
|
+
scale: import("zod").ZodLiteral<6>;
|
|
318
|
+
}, import("zod/v4/core").$strip>>;
|
|
319
|
+
id: import("zod").ZodString;
|
|
320
|
+
kind: import("zod").ZodEnum<{
|
|
321
|
+
manual: "manual";
|
|
322
|
+
automatic: "automatic";
|
|
323
|
+
}>;
|
|
324
|
+
paymentUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
325
|
+
reason: import("zod").ZodOptional<import("zod").ZodString>;
|
|
326
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
327
|
+
state: import("zod").ZodEnum<{
|
|
328
|
+
pending: "pending";
|
|
329
|
+
paid: "paid";
|
|
330
|
+
failed: "failed";
|
|
331
|
+
"authentication-required": "authentication-required";
|
|
332
|
+
"action-required": "action-required";
|
|
333
|
+
canceled: "canceled";
|
|
334
|
+
refunded: "refunded";
|
|
335
|
+
reversed: "reversed";
|
|
336
|
+
disputed: "disputed";
|
|
337
|
+
}>;
|
|
338
|
+
tax: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
339
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
340
|
+
microdollars: import("zod").ZodString;
|
|
341
|
+
scale: import("zod").ZodLiteral<6>;
|
|
342
|
+
}, import("zod/v4/core").$strip>>;
|
|
343
|
+
taxStatus: import("zod").ZodEnum<{
|
|
344
|
+
confirmed: "confirmed";
|
|
345
|
+
"calculated-at-checkout": "calculated-at-checkout";
|
|
346
|
+
}>;
|
|
347
|
+
updatedAt: import("zod").ZodString;
|
|
348
|
+
}, import("zod/v4/core").$strict>>;
|
|
349
|
+
freshness: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
350
|
+
kind: import("zod").ZodLiteral<"authoritative">;
|
|
351
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
352
|
+
asOf: import("zod").ZodString;
|
|
353
|
+
kind: import("zod").ZodLiteral<"projected">;
|
|
354
|
+
lagSeconds: import("zod").ZodNumber;
|
|
355
|
+
}, import("zod/v4/core").$strip>], "kind">;
|
|
356
|
+
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
357
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
358
|
+
readonly scopes: readonly ["usage:read"];
|
|
359
|
+
readonly sessionAuthority: "headers";
|
|
360
|
+
readonly summary: "" | "Page execution-credit payments";
|
|
361
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
362
|
+
}, {
|
|
363
|
+
readonly creates: false;
|
|
364
|
+
readonly description: "" | "Read the verified organization's project subscription invoices with bounded cursor continuation. Existing recent-history responses remain compatible.";
|
|
365
|
+
readonly example: {
|
|
366
|
+
data?: never;
|
|
367
|
+
freshness?: never;
|
|
368
|
+
} | {
|
|
369
|
+
data: never[];
|
|
370
|
+
freshness: {
|
|
371
|
+
kind: string;
|
|
372
|
+
};
|
|
373
|
+
};
|
|
374
|
+
readonly id: "billing.invoicehistory";
|
|
375
|
+
readonly idempotent: true;
|
|
376
|
+
readonly mcp: {
|
|
377
|
+
readonly destructive: false;
|
|
378
|
+
readonly kind: "tool";
|
|
379
|
+
readonly openWorld: false;
|
|
380
|
+
};
|
|
381
|
+
readonly method: "GET";
|
|
382
|
+
readonly mutates: false;
|
|
383
|
+
readonly path: "/v1/billing/invoice-history";
|
|
384
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
385
|
+
readonly problems: readonly ["invalid_request", "service_unavailable"];
|
|
386
|
+
readonly query: import("zod").ZodObject<{
|
|
387
|
+
cursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
388
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
389
|
+
}, import("zod/v4/core").$strip>;
|
|
390
|
+
readonly response: import("zod").ZodObject<{
|
|
391
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
392
|
+
id: import("zod").ZodString;
|
|
393
|
+
createdAt: import("zod").ZodString;
|
|
394
|
+
amount: import("zod").ZodObject<{
|
|
395
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
396
|
+
microdollars: import("zod").ZodString;
|
|
397
|
+
scale: import("zod").ZodLiteral<6>;
|
|
398
|
+
}, import("zod/v4/core").$strip>;
|
|
399
|
+
state: import("zod").ZodEnum<{
|
|
400
|
+
void: "void";
|
|
401
|
+
paid: "paid";
|
|
402
|
+
open: "open";
|
|
403
|
+
uncollectible: "uncollectible";
|
|
404
|
+
}>;
|
|
405
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
406
|
+
}, import("zod/v4/core").$strict>>;
|
|
407
|
+
freshness: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
408
|
+
kind: import("zod").ZodLiteral<"authoritative">;
|
|
409
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
410
|
+
asOf: import("zod").ZodString;
|
|
411
|
+
kind: import("zod").ZodLiteral<"projected">;
|
|
412
|
+
lagSeconds: import("zod").ZodNumber;
|
|
413
|
+
}, import("zod/v4/core").$strip>], "kind">;
|
|
414
|
+
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
415
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
416
|
+
readonly scopes: readonly ["usage:read"];
|
|
417
|
+
readonly sessionAuthority: "headers";
|
|
418
|
+
readonly summary: "" | "Page project subscription invoices";
|
|
419
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
420
|
+
}, OperationDefinition & {
|
|
279
421
|
readonly id: "exports.create";
|
|
280
422
|
}, OperationDefinition & {
|
|
281
423
|
readonly id: "exports.read";
|
|
@@ -443,7 +585,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
443
585
|
readonly surfaces: readonly ["mock"];
|
|
444
586
|
}, {
|
|
445
587
|
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
|
|
588
|
+
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.";
|
|
447
589
|
readonly example: {
|
|
448
590
|
createdAt?: never;
|
|
449
591
|
environmentKind?: never;
|
|
@@ -771,7 +913,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
771
913
|
ETag: import("zod").ZodString;
|
|
772
914
|
}, import("zod/v4/core").$strip>;
|
|
773
915
|
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
|
|
916
|
+
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
917
|
readonly example: {
|
|
776
918
|
endpoint?: never;
|
|
777
919
|
keyId?: never;
|
|
@@ -3347,7 +3489,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3347
3489
|
readonly surfaces: readonly ["api", "mock"];
|
|
3348
3490
|
}, {
|
|
3349
3491
|
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
|
|
3492
|
+
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
3493
|
readonly example: {
|
|
3352
3494
|
buckets?: never;
|
|
3353
3495
|
freshness?: never;
|
|
@@ -3378,6 +3520,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3378
3520
|
to: string;
|
|
3379
3521
|
};
|
|
3380
3522
|
};
|
|
3523
|
+
readonly requestHeaders: import("zod").ZodObject<{
|
|
3524
|
+
"X-Greatwait-Accept-Partial-Forecast": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3525
|
+
}, import("zod/v4/core").$strip>;
|
|
3381
3526
|
readonly id: "forecast.read";
|
|
3382
3527
|
readonly idempotent: true;
|
|
3383
3528
|
readonly mcp: {
|
|
@@ -3400,6 +3545,52 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3400
3545
|
to: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3401
3546
|
}, import("zod/v4/core").$strip>;
|
|
3402
3547
|
readonly response: import("zod").ZodNever | import("zod").ZodObject<{
|
|
3548
|
+
coverage: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3549
|
+
complete: import("zod").ZodBoolean;
|
|
3550
|
+
countMeaning: import("zod").ZodEnum<{
|
|
3551
|
+
"complete-total": "complete-total";
|
|
3552
|
+
"lower-bound": "lower-bound";
|
|
3553
|
+
}>;
|
|
3554
|
+
projectedWindow: import("zod").ZodObject<{
|
|
3555
|
+
from: import("zod").ZodString;
|
|
3556
|
+
to: import("zod").ZodString;
|
|
3557
|
+
}, import("zod/v4/core").$strip>;
|
|
3558
|
+
completeThrough: import("zod").ZodString;
|
|
3559
|
+
heads: import("zod").ZodObject<{
|
|
3560
|
+
groupsRead: import("zod").ZodNumber;
|
|
3561
|
+
occurrencesCounted: import("zod").ZodNumber;
|
|
3562
|
+
complete: import("zod").ZodBoolean;
|
|
3563
|
+
selection: import("zod").ZodLiteral<"earliest bucket, latency class, partition key groups">;
|
|
3564
|
+
lastGroup: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3565
|
+
start: import("zod").ZodString;
|
|
3566
|
+
latencyClass: import("zod").ZodEnum<{
|
|
3567
|
+
realtime: "realtime";
|
|
3568
|
+
bulk: "bulk";
|
|
3569
|
+
}>;
|
|
3570
|
+
partitionKey: import("zod").ZodString;
|
|
3571
|
+
}, import("zod/v4/core").$strip>>;
|
|
3572
|
+
}, import("zod/v4/core").$strip>;
|
|
3573
|
+
recurring: import("zod").ZodObject<{
|
|
3574
|
+
schedulesRead: import("zod").ZodNumber;
|
|
3575
|
+
populationComplete: import("zod").ZodBoolean;
|
|
3576
|
+
selection: import("zod").ZodLiteral<"oldest eligible active recurring schedules by createdAt and scheduleId">;
|
|
3577
|
+
firstScheduleId: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3578
|
+
lastScheduleId: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3579
|
+
}, import("zod/v4/core").$strip>;
|
|
3580
|
+
work: import("zod").ZodObject<{
|
|
3581
|
+
usedUnits: import("zod").ZodNumber;
|
|
3582
|
+
limitUnits: import("zod").ZodNumber;
|
|
3583
|
+
}, import("zod/v4/core").$strip>;
|
|
3584
|
+
boundsReached: import("zod").ZodArray<import("zod").ZodObject<{
|
|
3585
|
+
kind: import("zod").ZodEnum<{
|
|
3586
|
+
"head-cells": "head-cells";
|
|
3587
|
+
"recurring-series": "recurring-series";
|
|
3588
|
+
"projection-work": "projection-work";
|
|
3589
|
+
"projection-cells": "projection-cells";
|
|
3590
|
+
}>;
|
|
3591
|
+
limit: import("zod").ZodNumber;
|
|
3592
|
+
}, import("zod/v4/core").$strip>>;
|
|
3593
|
+
}, import("zod/v4/core").$strip>>;
|
|
3403
3594
|
buckets: import("zod").ZodArray<import("zod").ZodObject<{
|
|
3404
3595
|
byLatencyClass: import("zod").ZodObject<{
|
|
3405
3596
|
bulk: import("zod").ZodNumber;
|
|
@@ -3428,7 +3619,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3428
3619
|
readonly surfaces: readonly ["api", "mock"];
|
|
3429
3620
|
}, {
|
|
3430
3621
|
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
|
|
3622
|
+
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
3623
|
readonly example: {};
|
|
3433
3624
|
readonly id: "billing.summary";
|
|
3434
3625
|
readonly idempotent: true;
|
|
@@ -3441,7 +3632,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3441
3632
|
readonly mutates: false;
|
|
3442
3633
|
readonly path: "/v1/billing/summary";
|
|
3443
3634
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3444
|
-
readonly problems: readonly [];
|
|
3635
|
+
readonly problems: readonly ["billing_not_ready", "service_unavailable"];
|
|
3445
3636
|
readonly response: import("zod").ZodObject<{
|
|
3446
3637
|
activation: import("zod").ZodObject<{
|
|
3447
3638
|
boundary: import("zod").ZodString;
|
|
@@ -3668,6 +3859,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3668
3859
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3669
3860
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "revision_conflict", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3670
3861
|
readonly request: import("zod").ZodObject<{
|
|
3862
|
+
automaticTopUp: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
3671
3863
|
confirmed: import("zod").ZodLiteral<true>;
|
|
3672
3864
|
expectedRevision: import("zod").ZodNumber;
|
|
3673
3865
|
quote: import("zod").ZodString;
|
|
@@ -3684,6 +3876,26 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3684
3876
|
readonly requestHeaders: import("zod").ZodObject<{
|
|
3685
3877
|
"Idempotency-Key": import("zod").ZodString;
|
|
3686
3878
|
}, import("zod/v4/core").$strip>;
|
|
3879
|
+
} & BillingFundingContract, {
|
|
3880
|
+
readonly creates: false;
|
|
3881
|
+
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.";
|
|
3882
|
+
readonly environments: readonly ["live"];
|
|
3883
|
+
readonly id: "billing.fundingconfirm";
|
|
3884
|
+
readonly idempotent: true;
|
|
3885
|
+
readonly mcp: {
|
|
3886
|
+
readonly destructive: false;
|
|
3887
|
+
readonly kind: "tool";
|
|
3888
|
+
readonly openWorld: false;
|
|
3889
|
+
};
|
|
3890
|
+
readonly method: "POST";
|
|
3891
|
+
readonly mutates: true;
|
|
3892
|
+
readonly path: "/v1/billing/funding/{paymentOperation}/confirm";
|
|
3893
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
3894
|
+
readonly problems: readonly ["not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3895
|
+
readonly scopes: readonly ["billing:write"];
|
|
3896
|
+
readonly sessionAuthority: "headers";
|
|
3897
|
+
readonly summary: "" | "Confirm one payment with the provider now";
|
|
3898
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
3687
3899
|
} & BillingFundingContract, {
|
|
3688
3900
|
readonly scopes: readonly ["billing:write"];
|
|
3689
3901
|
readonly sessionAuthority: "headers";
|
|
@@ -3731,14 +3943,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3731
3943
|
}, import("zod/v4/core").$strip>;
|
|
3732
3944
|
} & BillingFundingContract, NamedOperation<"billing.autotopuppreview">, NamedOperation<"billing.autotopup">, {
|
|
3733
3945
|
readonly scopes: readonly ["billing:write"];
|
|
3734
|
-
readonly
|
|
3735
|
-
readonly summary: "" | "Request operator-reviewed refund";
|
|
3946
|
+
readonly summary: "" | "Reserve credit against a payment for refund";
|
|
3736
3947
|
readonly surfaces: readonly ["api", "mock"];
|
|
3737
3948
|
readonly responseHeaders?: import("zod").ZodObject<{
|
|
3738
3949
|
"Idempotency-Replayed": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3739
3950
|
}, import("zod/v4/core").$strip>;
|
|
3740
3951
|
readonly creates: true;
|
|
3741
|
-
readonly description: "" | "
|
|
3952
|
+
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
3953
|
readonly environments: readonly ["live"];
|
|
3743
3954
|
readonly example: {
|
|
3744
3955
|
amount?: never;
|
|
@@ -3767,7 +3978,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3767
3978
|
readonly method: "POST";
|
|
3768
3979
|
readonly mutates: true;
|
|
3769
3980
|
readonly path: "/v1/billing/funding/refunds";
|
|
3770
|
-
readonly principals: readonly ["api-credential", "oauth"
|
|
3981
|
+
readonly principals: readonly ["api-credential", "oauth"];
|
|
3771
3982
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3772
3983
|
readonly request: import("zod").ZodObject<{
|
|
3773
3984
|
amount: import("zod").ZodObject<{
|
|
@@ -3810,14 +4021,13 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3810
4021
|
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
3811
4022
|
}, {
|
|
3812
4023
|
readonly scopes: readonly ["billing:write"];
|
|
3813
|
-
readonly
|
|
3814
|
-
readonly summary: "" | "Record a reviewed refund decision";
|
|
4024
|
+
readonly summary: "" | "Complete or decline a refund reservation";
|
|
3815
4025
|
readonly surfaces: readonly ["api", "mock"];
|
|
3816
4026
|
readonly responseHeaders?: import("zod").ZodObject<{
|
|
3817
4027
|
"Idempotency-Replayed": import("zod").ZodOptional<import("zod").ZodLiteral<"true">>;
|
|
3818
4028
|
}, import("zod/v4/core").$strip>;
|
|
3819
4029
|
readonly creates: false;
|
|
3820
|
-
readonly description: "" | "
|
|
4030
|
+
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
4031
|
readonly environments: readonly ["live"];
|
|
3822
4032
|
readonly id: "billing.refundresolution";
|
|
3823
4033
|
readonly idempotent: true;
|
|
@@ -3829,7 +4039,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
3829
4039
|
readonly method: "PATCH";
|
|
3830
4040
|
readonly mutates: true;
|
|
3831
4041
|
readonly path: "/v1/billing/funding/refunds/{refundRequest}";
|
|
3832
|
-
readonly principals: readonly ["api-credential", "oauth"
|
|
4042
|
+
readonly principals: readonly ["api-credential", "oauth"];
|
|
3833
4043
|
readonly problems: readonly ["idempotency_key_reused", "invalid_request", "not_found", "service_unavailable", "state_conflict", "test_to_live_escalation"];
|
|
3834
4044
|
readonly request: import("zod").ZodObject<{
|
|
3835
4045
|
confirmed: import("zod").ZodLiteral<true>;
|
|
@@ -4082,6 +4292,282 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4082
4292
|
};
|
|
4083
4293
|
readonly summary: "" | "Open hosted payment recovery";
|
|
4084
4294
|
readonly problems: readonly ["service_unavailable", "state_conflict", "not_found", "revision_conflict", "test_to_live_escalation"];
|
|
4295
|
+
}, {
|
|
4296
|
+
readonly creates: false;
|
|
4297
|
+
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.";
|
|
4298
|
+
readonly example: {
|
|
4299
|
+
card?: never;
|
|
4300
|
+
method?: never;
|
|
4301
|
+
} | {
|
|
4302
|
+
card: {
|
|
4303
|
+
brand: string;
|
|
4304
|
+
expMonth: number;
|
|
4305
|
+
expYear: number;
|
|
4306
|
+
last4: string;
|
|
4307
|
+
};
|
|
4308
|
+
method: {
|
|
4309
|
+
brand: string;
|
|
4310
|
+
expMonth: number;
|
|
4311
|
+
expYear: number;
|
|
4312
|
+
label: string;
|
|
4313
|
+
last4: string;
|
|
4314
|
+
type: string;
|
|
4315
|
+
};
|
|
4316
|
+
};
|
|
4317
|
+
readonly id: "billing.paymentmethod";
|
|
4318
|
+
readonly idempotent: true;
|
|
4319
|
+
readonly mcp: {
|
|
4320
|
+
readonly destructive: false;
|
|
4321
|
+
readonly kind: "tool";
|
|
4322
|
+
readonly openWorld: false;
|
|
4323
|
+
};
|
|
4324
|
+
readonly method: "GET";
|
|
4325
|
+
readonly mutates: false;
|
|
4326
|
+
readonly path: "/v1/billing/payment-method";
|
|
4327
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4328
|
+
readonly problems: readonly ["service_unavailable"];
|
|
4329
|
+
readonly response: import("zod").ZodObject<{
|
|
4330
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
4331
|
+
brand: import("zod").ZodString;
|
|
4332
|
+
last4: import("zod").ZodString;
|
|
4333
|
+
expMonth: import("zod").ZodNumber;
|
|
4334
|
+
expYear: import("zod").ZodNumber;
|
|
4335
|
+
}, import("zod/v4/core").$strict>>;
|
|
4336
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
4337
|
+
brand: import("zod").ZodString;
|
|
4338
|
+
last4: import("zod").ZodString;
|
|
4339
|
+
expMonth: import("zod").ZodNumber;
|
|
4340
|
+
expYear: import("zod").ZodNumber;
|
|
4341
|
+
type: import("zod").ZodLiteral<"card">;
|
|
4342
|
+
label: import("zod").ZodString;
|
|
4343
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4344
|
+
type: import("zod").ZodLiteral<"link">;
|
|
4345
|
+
label: import("zod").ZodString;
|
|
4346
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
4347
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4348
|
+
type: import("zod").ZodLiteral<"other">;
|
|
4349
|
+
label: import("zod").ZodString;
|
|
4350
|
+
providerType: import("zod").ZodString;
|
|
4351
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
4352
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4353
|
+
readonly scopes: readonly ["usage:read"];
|
|
4354
|
+
readonly sessionAuthority: "headers";
|
|
4355
|
+
readonly summary: "" | "Read the saved payment method";
|
|
4356
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4357
|
+
}, {
|
|
4358
|
+
readonly creates: false;
|
|
4359
|
+
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.";
|
|
4360
|
+
readonly example: {
|
|
4361
|
+
data?: never;
|
|
4362
|
+
} | {
|
|
4363
|
+
data: {
|
|
4364
|
+
amount: {
|
|
4365
|
+
currency: string;
|
|
4366
|
+
microdollars: string;
|
|
4367
|
+
scale: number;
|
|
4368
|
+
};
|
|
4369
|
+
createdAt: string;
|
|
4370
|
+
id: string;
|
|
4371
|
+
receiptUrl: string;
|
|
4372
|
+
state: string;
|
|
4373
|
+
}[];
|
|
4374
|
+
};
|
|
4375
|
+
readonly id: "billing.invoices";
|
|
4376
|
+
readonly idempotent: true;
|
|
4377
|
+
readonly mcp: {
|
|
4378
|
+
readonly destructive: false;
|
|
4379
|
+
readonly kind: "tool";
|
|
4380
|
+
readonly openWorld: false;
|
|
4381
|
+
};
|
|
4382
|
+
readonly method: "GET";
|
|
4383
|
+
readonly mutates: false;
|
|
4384
|
+
readonly path: "/v1/billing/invoices";
|
|
4385
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4386
|
+
readonly problems: readonly ["service_unavailable"];
|
|
4387
|
+
readonly response: import("zod").ZodObject<{
|
|
4388
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4389
|
+
id: import("zod").ZodString;
|
|
4390
|
+
createdAt: import("zod").ZodString;
|
|
4391
|
+
amount: import("zod").ZodObject<{
|
|
4392
|
+
currency: import("zod").ZodLiteral<"USD">;
|
|
4393
|
+
microdollars: import("zod").ZodString;
|
|
4394
|
+
scale: import("zod").ZodLiteral<6>;
|
|
4395
|
+
}, import("zod/v4/core").$strip>;
|
|
4396
|
+
state: import("zod").ZodEnum<{
|
|
4397
|
+
void: "void";
|
|
4398
|
+
paid: "paid";
|
|
4399
|
+
open: "open";
|
|
4400
|
+
uncollectible: "uncollectible";
|
|
4401
|
+
}>;
|
|
4402
|
+
receiptUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4403
|
+
}, import("zod/v4/core").$strict>>;
|
|
4404
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4405
|
+
readonly scopes: readonly ["usage:read"];
|
|
4406
|
+
readonly sessionAuthority: "headers";
|
|
4407
|
+
readonly summary: "" | "List project subscription charges";
|
|
4408
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4409
|
+
}, {
|
|
4410
|
+
readonly creates: false;
|
|
4411
|
+
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.";
|
|
4412
|
+
readonly environments: readonly ["live"];
|
|
4413
|
+
readonly example: {
|
|
4414
|
+
url?: never;
|
|
4415
|
+
} | {
|
|
4416
|
+
url: string;
|
|
4417
|
+
};
|
|
4418
|
+
readonly id: "billing.paymentmethodsetup";
|
|
4419
|
+
readonly idempotent: false;
|
|
4420
|
+
readonly mcp: {
|
|
4421
|
+
readonly destructive: false;
|
|
4422
|
+
readonly kind: "tool";
|
|
4423
|
+
readonly openWorld: false;
|
|
4424
|
+
};
|
|
4425
|
+
readonly method: "POST";
|
|
4426
|
+
readonly mutates: true;
|
|
4427
|
+
readonly path: "/v1/billing/payment-method/setup";
|
|
4428
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4429
|
+
readonly problems: readonly ["invalid_request", "service_unavailable", "state_conflict", "not_found", "revision_conflict", "test_to_live_escalation"];
|
|
4430
|
+
readonly request: import("zod").ZodObject<{
|
|
4431
|
+
returnUrl: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4432
|
+
}, import("zod/v4/core").$strict>;
|
|
4433
|
+
readonly requestExample: {};
|
|
4434
|
+
readonly response: import("zod").ZodObject<{
|
|
4435
|
+
url: import("zod").ZodString;
|
|
4436
|
+
}, import("zod/v4/core").$strip> | import("zod").ZodNever;
|
|
4437
|
+
readonly scopes: readonly ["billing:write"];
|
|
4438
|
+
readonly sessionAuthority: "headers";
|
|
4439
|
+
readonly summary: "" | "Start saving a payment method";
|
|
4440
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4441
|
+
}, {
|
|
4442
|
+
readonly creates: false;
|
|
4443
|
+
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.";
|
|
4444
|
+
readonly environments: readonly ["live"];
|
|
4445
|
+
readonly example: {
|
|
4446
|
+
card?: never;
|
|
4447
|
+
method?: never;
|
|
4448
|
+
} | {
|
|
4449
|
+
card: {
|
|
4450
|
+
brand: string;
|
|
4451
|
+
expMonth: number;
|
|
4452
|
+
expYear: number;
|
|
4453
|
+
last4: string;
|
|
4454
|
+
};
|
|
4455
|
+
method: {
|
|
4456
|
+
brand: string;
|
|
4457
|
+
expMonth: number;
|
|
4458
|
+
expYear: number;
|
|
4459
|
+
label: string;
|
|
4460
|
+
last4: string;
|
|
4461
|
+
type: string;
|
|
4462
|
+
};
|
|
4463
|
+
};
|
|
4464
|
+
readonly id: "billing.paymentmethodconfirm";
|
|
4465
|
+
readonly idempotent: true;
|
|
4466
|
+
readonly mcp: {
|
|
4467
|
+
readonly destructive: false;
|
|
4468
|
+
readonly kind: "tool";
|
|
4469
|
+
readonly openWorld: false;
|
|
4470
|
+
};
|
|
4471
|
+
readonly method: "POST";
|
|
4472
|
+
readonly mutates: true;
|
|
4473
|
+
readonly path: "/v1/billing/payment-method/confirm";
|
|
4474
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4475
|
+
readonly problems: readonly ["invalid_request", "not_found", "service_unavailable", "state_conflict", "revision_conflict", "test_to_live_escalation"];
|
|
4476
|
+
readonly request: import("zod").ZodObject<{
|
|
4477
|
+
checkoutSession: import("zod").ZodString;
|
|
4478
|
+
}, import("zod/v4/core").$strict>;
|
|
4479
|
+
readonly requestExample: {
|
|
4480
|
+
checkoutSession?: never;
|
|
4481
|
+
} | {
|
|
4482
|
+
checkoutSession: string;
|
|
4483
|
+
};
|
|
4484
|
+
readonly response: import("zod").ZodObject<{
|
|
4485
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
4486
|
+
brand: import("zod").ZodString;
|
|
4487
|
+
last4: import("zod").ZodString;
|
|
4488
|
+
expMonth: import("zod").ZodNumber;
|
|
4489
|
+
expYear: import("zod").ZodNumber;
|
|
4490
|
+
}, import("zod/v4/core").$strict>>;
|
|
4491
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
4492
|
+
brand: import("zod").ZodString;
|
|
4493
|
+
last4: import("zod").ZodString;
|
|
4494
|
+
expMonth: import("zod").ZodNumber;
|
|
4495
|
+
expYear: import("zod").ZodNumber;
|
|
4496
|
+
type: import("zod").ZodLiteral<"card">;
|
|
4497
|
+
label: import("zod").ZodString;
|
|
4498
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4499
|
+
type: import("zod").ZodLiteral<"link">;
|
|
4500
|
+
label: import("zod").ZodString;
|
|
4501
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
4502
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4503
|
+
type: import("zod").ZodLiteral<"other">;
|
|
4504
|
+
label: import("zod").ZodString;
|
|
4505
|
+
providerType: import("zod").ZodString;
|
|
4506
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
4507
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4508
|
+
readonly scopes: readonly ["billing:write"];
|
|
4509
|
+
readonly sessionAuthority: "headers";
|
|
4510
|
+
readonly summary: "" | "Confirm a saved payment method";
|
|
4511
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4512
|
+
}, {
|
|
4513
|
+
readonly creates: false;
|
|
4514
|
+
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.";
|
|
4515
|
+
readonly environments: readonly ["live"];
|
|
4516
|
+
readonly example: {
|
|
4517
|
+
card?: never;
|
|
4518
|
+
method?: never;
|
|
4519
|
+
} | {
|
|
4520
|
+
card: null;
|
|
4521
|
+
method: null;
|
|
4522
|
+
};
|
|
4523
|
+
readonly id: "billing.paymentmethodremove";
|
|
4524
|
+
readonly idempotent: true;
|
|
4525
|
+
readonly mcp: {
|
|
4526
|
+
readonly destructive: true;
|
|
4527
|
+
readonly kind: "tool";
|
|
4528
|
+
readonly openWorld: false;
|
|
4529
|
+
};
|
|
4530
|
+
readonly method: "POST";
|
|
4531
|
+
readonly mutates: true;
|
|
4532
|
+
readonly path: "/v1/billing/payment-method/remove";
|
|
4533
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4534
|
+
readonly problems: readonly ["invalid_request", "not_found", "service_unavailable", "state_conflict", "revision_conflict", "test_to_live_escalation"];
|
|
4535
|
+
readonly request: import("zod").ZodObject<{
|
|
4536
|
+
confirmed: import("zod").ZodLiteral<true>;
|
|
4537
|
+
}, import("zod/v4/core").$strict>;
|
|
4538
|
+
readonly requestExample: {
|
|
4539
|
+
confirmed?: never;
|
|
4540
|
+
} | {
|
|
4541
|
+
confirmed: boolean;
|
|
4542
|
+
};
|
|
4543
|
+
readonly response: import("zod").ZodObject<{
|
|
4544
|
+
card: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
4545
|
+
brand: import("zod").ZodString;
|
|
4546
|
+
last4: import("zod").ZodString;
|
|
4547
|
+
expMonth: import("zod").ZodNumber;
|
|
4548
|
+
expYear: import("zod").ZodNumber;
|
|
4549
|
+
}, import("zod/v4/core").$strict>>;
|
|
4550
|
+
method: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
4551
|
+
brand: import("zod").ZodString;
|
|
4552
|
+
last4: import("zod").ZodString;
|
|
4553
|
+
expMonth: import("zod").ZodNumber;
|
|
4554
|
+
expYear: import("zod").ZodNumber;
|
|
4555
|
+
type: import("zod").ZodLiteral<"card">;
|
|
4556
|
+
label: import("zod").ZodString;
|
|
4557
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4558
|
+
type: import("zod").ZodLiteral<"link">;
|
|
4559
|
+
label: import("zod").ZodString;
|
|
4560
|
+
email: import("zod").ZodNullable<import("zod").ZodString>;
|
|
4561
|
+
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
4562
|
+
type: import("zod").ZodLiteral<"other">;
|
|
4563
|
+
label: import("zod").ZodString;
|
|
4564
|
+
providerType: import("zod").ZodString;
|
|
4565
|
+
}, import("zod/v4/core").$strict>], "type">>;
|
|
4566
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
4567
|
+
readonly scopes: readonly ["billing:write"];
|
|
4568
|
+
readonly sessionAuthority: "headers";
|
|
4569
|
+
readonly summary: "" | "Remove the saved payment method";
|
|
4570
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4085
4571
|
}, {
|
|
4086
4572
|
readonly creates: false;
|
|
4087
4573
|
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 +4584,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4098
4584
|
readonly mutates: true;
|
|
4099
4585
|
readonly path: "/v1/billing/reconcile";
|
|
4100
4586
|
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4101
|
-
readonly problems: readonly ["service_unavailable", "test_to_live_escalation"];
|
|
4587
|
+
readonly problems: readonly ["billing_not_ready", "service_unavailable", "test_to_live_escalation"];
|
|
4102
4588
|
readonly response: import("zod").ZodObject<{
|
|
4103
4589
|
activation: import("zod").ZodObject<{
|
|
4104
4590
|
boundary: import("zod").ZodString;
|
|
@@ -4423,6 +4909,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4423
4909
|
service_blocked: "service_blocked";
|
|
4424
4910
|
service_restored: "service_restored";
|
|
4425
4911
|
}>;
|
|
4912
|
+
note: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
4913
|
+
"provider-details-attached": "provider-details-attached";
|
|
4914
|
+
}>>;
|
|
4426
4915
|
period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
4427
4916
|
recordedAt: import("zod").ZodString;
|
|
4428
4917
|
reference: import("zod").ZodObject<{
|
|
@@ -4442,6 +4931,83 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4442
4931
|
readonly sessionAuthority: "headers";
|
|
4443
4932
|
readonly summary: "" | "List immutable billing entries";
|
|
4444
4933
|
readonly surfaces: readonly ["api", "mock"];
|
|
4934
|
+
}, {
|
|
4935
|
+
readonly creates: false;
|
|
4936
|
+
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.";
|
|
4937
|
+
readonly example: {
|
|
4938
|
+
limits?: never;
|
|
4939
|
+
provenance?: never;
|
|
4940
|
+
revision?: never;
|
|
4941
|
+
} | {
|
|
4942
|
+
limits: {
|
|
4943
|
+
inlinePayloadBytes: number;
|
|
4944
|
+
forecastHorizonSeconds: number;
|
|
4945
|
+
usageWindowDays: number;
|
|
4946
|
+
};
|
|
4947
|
+
provenance: {
|
|
4948
|
+
inlinePayloadBytes: string;
|
|
4949
|
+
forecastHorizonSeconds: string;
|
|
4950
|
+
usageWindowDays: string;
|
|
4951
|
+
};
|
|
4952
|
+
revision: {
|
|
4953
|
+
global: number;
|
|
4954
|
+
organization: number;
|
|
4955
|
+
};
|
|
4956
|
+
};
|
|
4957
|
+
readonly id: "limits.read";
|
|
4958
|
+
readonly idempotent: true;
|
|
4959
|
+
readonly mcp: {
|
|
4960
|
+
readonly destructive: false;
|
|
4961
|
+
readonly kind: "tool";
|
|
4962
|
+
readonly openWorld: false;
|
|
4963
|
+
};
|
|
4964
|
+
readonly method: "GET";
|
|
4965
|
+
readonly mutates: false;
|
|
4966
|
+
readonly path: "/v1/limits";
|
|
4967
|
+
readonly principals: readonly ["api-credential", "oauth", "session"];
|
|
4968
|
+
readonly problems: readonly ["service_unavailable"];
|
|
4969
|
+
readonly response: import("zod").ZodObject<{
|
|
4970
|
+
limits: import("zod").ZodObject<{
|
|
4971
|
+
inlinePayloadBytes: import("zod").ZodNumber;
|
|
4972
|
+
partitionKeyCeiling: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
4973
|
+
forecastHorizonSeconds: import("zod").ZodNumber;
|
|
4974
|
+
usageWindowDays: import("zod").ZodNumber;
|
|
4975
|
+
}, import("zod/v4/core").$strict>;
|
|
4976
|
+
provenance: import("zod").ZodObject<{
|
|
4977
|
+
inlinePayloadBytes: import("zod").ZodEnum<{
|
|
4978
|
+
organization: "organization";
|
|
4979
|
+
default: "default";
|
|
4980
|
+
global: "global";
|
|
4981
|
+
deployment: "deployment";
|
|
4982
|
+
}>;
|
|
4983
|
+
partitionKeyCeiling: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
4984
|
+
organization: "organization";
|
|
4985
|
+
default: "default";
|
|
4986
|
+
global: "global";
|
|
4987
|
+
deployment: "deployment";
|
|
4988
|
+
}>>;
|
|
4989
|
+
forecastHorizonSeconds: import("zod").ZodEnum<{
|
|
4990
|
+
organization: "organization";
|
|
4991
|
+
default: "default";
|
|
4992
|
+
global: "global";
|
|
4993
|
+
deployment: "deployment";
|
|
4994
|
+
}>;
|
|
4995
|
+
usageWindowDays: import("zod").ZodEnum<{
|
|
4996
|
+
organization: "organization";
|
|
4997
|
+
default: "default";
|
|
4998
|
+
global: "global";
|
|
4999
|
+
deployment: "deployment";
|
|
5000
|
+
}>;
|
|
5001
|
+
}, import("zod/v4/core").$strict>;
|
|
5002
|
+
revision: import("zod").ZodObject<{
|
|
5003
|
+
global: import("zod").ZodNumber;
|
|
5004
|
+
organization: import("zod").ZodNumber;
|
|
5005
|
+
}, import("zod/v4/core").$strict>;
|
|
5006
|
+
}, import("zod/v4/core").$strict> | import("zod").ZodNever;
|
|
5007
|
+
readonly scopes: readonly ["schedules:read"];
|
|
5008
|
+
readonly sessionAuthority: "headers";
|
|
5009
|
+
readonly summary: "" | "Read effective customer limits";
|
|
5010
|
+
readonly surfaces: readonly ["api", "mock"];
|
|
4445
5011
|
}, {
|
|
4446
5012
|
readonly creates: false;
|
|
4447
5013
|
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 +5211,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4645
5211
|
readonly idempotent: true;
|
|
4646
5212
|
readonly mcp: {
|
|
4647
5213
|
readonly kind: "unavailable";
|
|
4648
|
-
readonly reason: "A transitional shape for the autoscaler migration,
|
|
5214
|
+
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
5215
|
};
|
|
4650
5216
|
readonly method: "GET";
|
|
4651
5217
|
readonly mutates: false;
|
|
@@ -4948,6 +5514,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4948
5514
|
data: {
|
|
4949
5515
|
attemptNumber: number;
|
|
4950
5516
|
classifiedAt: string;
|
|
5517
|
+
dispatchRecoveries: number;
|
|
5518
|
+
localReceiptRecoveries: number;
|
|
4951
5519
|
delivery: string;
|
|
4952
5520
|
diagnostic: string;
|
|
4953
5521
|
durationMs: number;
|
|
@@ -4989,7 +5557,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
4989
5557
|
readonly response: import("zod").ZodObject<{
|
|
4990
5558
|
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
4991
5559
|
id: import("zod").ZodString;
|
|
5560
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
4992
5561
|
occurrence: import("zod").ZodString;
|
|
5562
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
4993
5563
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
4994
5564
|
none: "none";
|
|
4995
5565
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5048,6 +5618,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5048
5618
|
network_ambiguous: "network_ambiguous";
|
|
5049
5619
|
payload_unavailable: "payload_unavailable";
|
|
5050
5620
|
}>>;
|
|
5621
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5051
5622
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5052
5623
|
}, import("zod/v4/core").$strip>>;
|
|
5053
5624
|
nextCursor: import("zod").ZodOptional<import("zod").ZodString>;
|
|
@@ -5069,6 +5640,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5069
5640
|
attempt: {
|
|
5070
5641
|
attemptNumber: number;
|
|
5071
5642
|
classifiedAt: string;
|
|
5643
|
+
dispatchRecoveries: number;
|
|
5644
|
+
localReceiptRecoveries: number;
|
|
5072
5645
|
delivery: string;
|
|
5073
5646
|
diagnostic: string;
|
|
5074
5647
|
durationMs: number;
|
|
@@ -5104,7 +5677,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5104
5677
|
readonly response: import("zod").ZodObject<{
|
|
5105
5678
|
attempt: import("zod").ZodObject<{
|
|
5106
5679
|
id: import("zod").ZodString;
|
|
5680
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5107
5681
|
occurrence: import("zod").ZodString;
|
|
5682
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5108
5683
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5109
5684
|
none: "none";
|
|
5110
5685
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5163,6 +5738,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5163
5738
|
network_ambiguous: "network_ambiguous";
|
|
5164
5739
|
payload_unavailable: "payload_unavailable";
|
|
5165
5740
|
}>>;
|
|
5741
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5166
5742
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5167
5743
|
}, import("zod/v4/core").$strip>;
|
|
5168
5744
|
freshness: import("zod").ZodObject<{
|
|
@@ -5189,6 +5765,8 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5189
5765
|
} | {
|
|
5190
5766
|
attempt: {
|
|
5191
5767
|
attemptNumber: number;
|
|
5768
|
+
dispatchRecoveries: number;
|
|
5769
|
+
localReceiptRecoveries: number;
|
|
5192
5770
|
delivery: string;
|
|
5193
5771
|
id: string;
|
|
5194
5772
|
occurrence: string;
|
|
@@ -5220,7 +5798,9 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5220
5798
|
readonly response: import("zod").ZodObject<{
|
|
5221
5799
|
attempt: import("zod").ZodObject<{
|
|
5222
5800
|
id: import("zod").ZodString;
|
|
5801
|
+
localReceiptRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5223
5802
|
occurrence: import("zod").ZodString;
|
|
5803
|
+
rescues: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5224
5804
|
remediation: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
5225
5805
|
none: "none";
|
|
5226
5806
|
review_retry_policy: "review_retry_policy";
|
|
@@ -5279,6 +5859,7 @@ export declare const OPERATIONS: readonly [OperationDefinition & {
|
|
|
5279
5859
|
network_ambiguous: "network_ambiguous";
|
|
5280
5860
|
payload_unavailable: "payload_unavailable";
|
|
5281
5861
|
}>>;
|
|
5862
|
+
dispatchRecoveries: import("zod").ZodOptional<import("zod").ZodInt>;
|
|
5282
5863
|
durationMs: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
5283
5864
|
}, import("zod/v4/core").$strip>;
|
|
5284
5865
|
freshness: import("zod").ZodObject<{
|