@greatwait/contracts 0.1.0-alpha.4 → 0.1.0-alpha.5

package/generated/v1/examples/billing.fundingconfirm.response.json

@@ -0,0 +1,120 @@
+{
+  "automaticExecutionTopUp": {
+    "ceiling": {
+      "currency": "USD",
+      "microdollars": "50000000",
+      "scale": 6
+    },
+    "currentPeriod": {
+      "end": "2026-10-01T00:00:00.000Z",
+      "pending": {
+        "currency": "USD",
+        "microdollars": "10830000",
+        "scale": 6
+      },
+      "remaining": {
+        "currency": "USD",
+        "microdollars": "29170000",
+        "scale": 6
+      },
+      "settled": {
+        "currency": "USD",
+        "microdollars": "10000000",
+        "scale": 6
+      },
+      "start": "2026-09-01T00:00:00.000Z"
+    },
+    "rule": {
+      "cooldownUntil": null,
+      "desired": {
+        "ceiling": {
+          "currency": "USD",
+          "microdollars": "50000000",
+          "scale": 6
+        },
+        "credit": {
+          "currency": "USD",
+          "microdollars": "10000000",
+          "scale": 6
+        },
+        "triggerBelow": {
+          "currency": "USD",
+          "microdollars": "2000000",
+          "scale": 6
+        }
+      },
+      "effective": {
+        "ceiling": {
+          "currency": "USD",
+          "microdollars": "50000000",
+          "scale": 6
+        },
+        "credit": {
+          "currency": "USD",
+          "microdollars": "10000000",
+          "scale": 6
+        },
+        "triggerBelow": {
+          "currency": "USD",
+          "microdollars": "2000000",
+          "scale": 6
+        }
+      },
+      "state": "ready",
+      "suspension": null
+    },
+    "revision": 3
+  },
+  "credit": {
+    "amountOwed": {
+      "currency": "USD",
+      "microdollars": "0",
+      "scale": 6
+    },
+    "available": {
+      "currency": "USD",
+      "microdollars": "9000000",
+      "scale": 6
+    },
+    "reserved": {
+      "currency": "USD",
+      "microdollars": "10",
+      "scale": 6
+    }
+  },
+  "freshness": {
+    "kind": "authoritative"
+  },
+  "paymentOperations": [
+    {
+      "createdAt": "2026-09-10T12:00:00.000Z",
+      "credit": {
+        "currency": "USD",
+        "microdollars": "10000000",
+        "scale": 6
+      },
+      "gross": {
+        "currency": "USD",
+        "microdollars": "10830000",
+        "scale": 6
+      },
+      "id": "funding-operation-example",
+      "kind": "automatic",
+      "paymentUrl": "https://pay.stripe.com/receipts/acct_example/example",
+      "reason": "payment-required",
+      "state": "pending",
+      "tax": {
+        "currency": "USD",
+        "microdollars": "830000",
+        "scale": 6
+      },
+      "taxStatus": "confirmed",
+      "updatedAt": "2026-09-10T12:00:01.000Z"
+    }
+  ],
+  "subscribedProjectFees": {
+    "currency": "USD",
+    "microdollars": "5000000",
+    "scale": 6
+  }
+}

package/generated/v1/examples/billing.invoicehistory.response.json

@@ -0,0 +1,6 @@
+{
+  "data": [],
+  "freshness": {
+    "kind": "authoritative"
+  }
+}

package/generated/v1/examples/billing.invoices.response.json

@@ -0,0 +1,15 @@
+{
+  "data": [
+    {
+      "id": "in_example_project_charge",
+      "createdAt": "2026-09-01T12:00:00.000Z",
+      "amount": {
+        "currency": "USD",
+        "microdollars": "5000000",
+        "scale": 6
+      },
+      "state": "paid",
+      "receiptUrl": "https://invoice.stripe.com/i/acct_example/example"
+    }
+  ]
+}

package/generated/v1/examples/billing.paymenthistory.response.json

@@ -0,0 +1,6 @@
+{
+  "data": [],
+  "freshness": {
+    "kind": "authoritative"
+  }
+}

package/generated/v1/examples/billing.paymentmethod.response.json

@@ -0,0 +1,16 @@
+{
+  "card": {
+    "brand": "visa",
+    "last4": "4242",
+    "expMonth": 12,
+    "expYear": 2030
+  },
+  "method": {
+    "brand": "visa",
+    "last4": "4242",
+    "expMonth": 12,
+    "expYear": 2030,
+    "type": "card",
+    "label": "Visa ending in 4242"
+  }
+}

package/generated/v1/examples/billing.paymentmethodconfirm.request.json

@@ -0,0 +1,3 @@
+{
+  "checkoutSession": "cs_example_card_setup"
+}

package/generated/v1/examples/billing.paymentmethodconfirm.response.json

@@ -0,0 +1,16 @@
+{
+  "card": {
+    "brand": "visa",
+    "last4": "4242",
+    "expMonth": 12,
+    "expYear": 2030
+  },
+  "method": {
+    "brand": "visa",
+    "last4": "4242",
+    "expMonth": 12,
+    "expYear": 2030,
+    "type": "card",
+    "label": "Visa ending in 4242"
+  }
+}

package/generated/v1/examples/billing.paymentmethodremove.request.json

@@ -0,0 +1,3 @@
+{
+  "confirmed": true
+}

package/generated/v1/examples/billing.paymentmethodremove.response.json

@@ -0,0 +1,4 @@
+{
+  "card": null,
+  "method": null
+}

package/generated/v1/examples/billing.paymentmethodsetup.request.json

@@ -0,0 +1 @@
+{}

package/generated/v1/examples/billing.paymentmethodsetup.response.json

@@ -0,0 +1,3 @@
+{
+  "url": "https://checkout.stripe.com/c/pay/example-card-setup"
+}

package/generated/v1/examples/limits.read.response.json

@@ -0,0 +1,16 @@
+{
+  "limits": {
+    "inlinePayloadBytes": 65536,
+    "forecastHorizonSeconds": 90000,
+    "usageWindowDays": 366
+  },
+  "provenance": {
+    "inlinePayloadBytes": "default",
+    "forecastHorizonSeconds": "default",
+    "usageWindowDays": "default"
+  },
+  "revision": {
+    "global": 0,
+    "organization": 0
+  }
+}

package/generated/v1/examples/occurrences.redeliver.response.json

@@ -2,7 +2,9 @@
   "attempt": {
     "attemptNumber": 3,
     "delivery": "dlv_21h8xyz9k2m4n6p8r0t2v4w6y8",
+    "dispatchRecoveries": 0,
     "id": "att_21h8xyz9k2m4n6p8r0t2v4w6y8",
+    "localReceiptRecoveries": 0,
     "occurrence": "occ_01h8xyz9k2m4n6p8r0t2v4w6y8",
     "startedAt": "2026-07-28T15:05:00.000Z",
     "trigger": {

package/generated/v1/first-value-journey.json

@@ -2,20 +2,20 @@
   "contractVersion": "2026-08-22",
   "prerequisites": [
     {
-      "action": "Accept your Greatwait invitation, sign in, and create a project in the dashboard.",
+      "action": "Accept your GreatWait invitation, sign in, and create a project in the dashboard.",
       "because": "projects.create accepts only a signed-in member, so a project is created by a person rather than by an API credential.",
       "id": "project",
       "title": "A project"
     },
     {
-      "action": "In that project, create an API credential and copy the secret it shows once.",
+      "action": "In that project, create an API credential with endpoints:write, occurrences:read, schedules:read and schedules:write, and copy the secret it shows once. The key picker starts with nothing selected and refuses an empty one, so those four are the boxes to tick.",
       "because": "credentials.create accepts only a signed-in member: a credential that could mint another credential would make revoking one meaningless.",
       "id": "credential",
       "title": "An API credential"
     },
     {
       "action": "Have an HTTPS URL of your own that answers POST with a 2xx status, and can be reached from the public internet.",
-      "because": "Greatwait delivers your callback to an address you control. It does not offer a shared receiver to try, and it will not send your payload to a third-party inspection service on your behalf.",
+      "because": "GreatWait delivers your callback to an address you control. It does not offer a shared receiver to try, and it will not send your payload to a third-party inspection service on your behalf.",
       "id": "receiver",
       "title": "An HTTPS receiver you control"
     }
@@ -28,7 +28,7 @@
       "observe": "The service name and the environment you meant to work in. If the environment is not the one you expect, stop and fix GREATWAIT_API_URL before creating anything.",
       "operationId": "meta.version",
       "path": "/__greatwait/version",
-      "purpose": "Confirms the origin you are pointed at is a Greatwait API and says which environment it serves. It needs no credential, so it separates 'wrong URL' from 'wrong key'.",
+      "purpose": "Confirms the origin you are pointed at is a GreatWait API and says which environment it serves. It needs no credential, so it separates 'wrong URL' from 'wrong key'.",
       "recovery": [
         {
           "nextMove": "Something answered, but not this service. Check GREATWAIT_API_URL — a 404 here comes from a proxy in front of the API rather than from the API, so it carries no problem document to read.",
@@ -39,7 +39,11 @@
           "when": "no-response"
         }
       ],
-      "problems": ["rate_limited", "service_unavailable"],
+      "problems": [
+        "capability_not_configured",
+        "rate_limited",
+        "service_unavailable"
+      ],
       "scopes": [],
       "successStatus": 200,
       "title": "Check which service and environment you reached",
@@ -76,6 +80,7 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
@@ -106,7 +111,7 @@
       ],
       "key": "create-destination",
       "method": "POST",
-      "observe": "An endpoint identifier, and a signing secret returned by this call and by no other. Store the secret now: reading the endpoint back later will not show it again.",
+      "observe": "An endpoint identifier, and a signing secret. Store it now: this is the only call that returns it, and reading the endpoint back shows a redacted prefix instead. It is not gone if you lose it — a signed-in member can read it again on the endpoint's own page in the dashboard, which is the one caller `endpoints.revealSigningSecret` accepts.",
       "operationId": "endpoints.create",
       "path": "/v1/endpoints",
       "purpose": "Registers the address every occurrence of this schedule is delivered to, and mints the per-endpoint signing key your receiver verifies callbacks with.",
@@ -118,6 +123,10 @@
         {
           "nextMove": "This project is at its destination ceiling. Disable a destination you no longer deliver to; disabled ones still count, because they stay readable for audit.",
           "when": "plan_limit_reached"
+        },
+        {
+          "nextMove": "An active destination already delivers to this address in this project — usually one a previous run of this journey created. Reuse that destination, disable it first, or give the new one a name of its own.",
+          "when": "state_conflict"
         }
       ],
       "request": {
@@ -125,6 +134,7 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
@@ -179,7 +189,7 @@
           "when": "invalid_request"
         },
         {
-          "nextMove": "This organization is at a plan ceiling — live schedules, distinct partition keys, or payload size. Nothing was created; reduce the payload or archive a schedule and retry.",
+          "nextMove": "This organization is at a plan ceiling — the payload is larger than its plan carries, or the schedule names a new partition key when the organization's keys are full. Nothing was created; send a smaller payload or reuse a partition key that is already live, and retry.",
           "when": "plan_limit_reached"
         },
         {
@@ -199,6 +209,7 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "idempotency_key_reused",
@@ -255,6 +266,7 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "idempotency_key_reused",
@@ -288,6 +300,7 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
@@ -323,6 +336,7 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
@@ -351,12 +365,13 @@
           "when": "attempt-failed"
         },
         {
-          "nextMove": "Nothing reached your receiver. Confirm the URL answers a POST from the public internet, and that it is not behind an allowlist Greatwait is not on.",
+          "nextMove": "Nothing reached your receiver. Confirm the URL answers a POST from the public internet, and that it is not behind an allowlist GreatWait is not on.",
           "when": "receiver-unreachable"
         }
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
@@ -387,6 +402,7 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",