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

package/generated/v1/examples/schedules.replace.response.json

@@ -14,6 +14,9 @@
     "generation": 2,
     "id": "sch_01h8xyz9k2m4n6p8r0t2v4w6y8",
     "latencyClass": "realtime",
+    "lateness": {
+      "policy": "catchUp"
+    },
     "partitionKey": "campaign.spring",
     "recurrence": {
       "kind": "at"

package/generated/v1/examples/schedules.resume.response.json

@@ -13,6 +13,9 @@
     "generation": 1,
     "id": "sch_01h8xyz9k2m4n6p8r0t2v4w6y8",
     "latencyClass": "realtime",
+    "lateness": {
+      "policy": "catchUp"
+    },
     "recurrence": {
       "kind": "at"
     },

package/generated/v1/examples/timing.summary.response.json

@@ -0,0 +1,35 @@
+{
+  "customerBlockedCount": 2,
+  "deliveredSampleCount": 98,
+  "freshness": {
+    "kind": "authoritative"
+  },
+  "missingEvidenceCount": 1,
+  "p95LatenessMs": 4200,
+  "p99LatenessMs": 12000,
+  "platformBlockedCount": 1,
+  "policyVersion": "timing-v1",
+  "skippedCount": 3,
+  "targets": [
+    {
+      "breachCount": 5,
+      "customerBlockedCount": 2,
+      "eligibleOutstandingBreachCount": 1,
+      "maturedCount": 100,
+      "targetMs": 5000,
+      "verdict": "met",
+      "withinTargetCount": 95
+    },
+    {
+      "breachCount": 1,
+      "customerBlockedCount": 2,
+      "eligibleOutstandingBreachCount": 1,
+      "maturedCount": 100,
+      "targetMs": 15000,
+      "verdict": "met",
+      "withinTargetCount": 99
+    }
+  ],
+  "windowEnd": "2026-09-09T12:00:00.000Z",
+  "windowStart": "2026-09-08T12:00:00.000Z"
+}

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

@@ -1,4 +1,5 @@
 {
+  "bucketSeconds": 86400,
   "days": [
     {
       "billableOccurrences": 42,

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,9 +80,11 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
+        "project_archived",
         "rate_limited",
         "scope_missing",
         "service_unavailable"
@@ -105,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.",
@@ -117,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": {
@@ -124,13 +134,16 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
         "plan_limit_reached",
+        "project_archived",
         "rate_limited",
         "scope_missing",
-        "service_unavailable"
+        "service_unavailable",
+        "state_conflict"
       ],
       "scopes": ["endpoints:write"],
       "successStatus": 201,
@@ -160,12 +173,12 @@
       "purpose": "Creates the one-shot. The delay is converted to an absolute instant when the request is accepted, so the schedule reads back the same afterwards however it was expressed.",
       "recovery": [
         {
-          "nextMove": "This deployment requires a destination to answer its ownership challenge before anything is delivered there, and yours has not. Answer the challenge with the secret the create call returned, then create the schedule.",
-          "when": "endpoint_unverified"
+          "nextMove": "The endpoint identifier is not one this credential's project can deliver to — it belongs to another project, or there is no such endpoint. Create a destination in this project, or check the identifier.",
+          "when": "not_found"
         },
         {
-          "nextMove": "The endpoint identifier is not one this credential's project can deliver to — it belongs to another project, or it has been disabled. Disabling is terminal, so create a new destination rather than trying to re-enable that one.",
-          "when": "not_found"
+          "nextMove": "The endpoint is disabled. Enable it with `endpoints.enable` and the schedule is accepted as sent, or point the schedule at another destination.",
+          "when": "state_conflict"
         },
         {
           "nextMove": "The same idempotency key was used for a different request. Use a new key, or send the byte-identical body the key was first used with.",
@@ -176,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"
         },
         {
@@ -196,16 +209,18 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
-        "endpoint_unverified",
         "idempotency_key_reused",
         "invalid_request",
         "not_found",
         "plan_limit_reached",
+        "project_archived",
         "rate_limited",
         "scope_missing",
-        "service_unavailable"
+        "service_unavailable",
+        "state_conflict"
       ],
       "scopes": ["schedules:write"],
       "successStatus": 201,
@@ -251,16 +266,18 @@
       },
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
-        "endpoint_unverified",
         "idempotency_key_reused",
         "invalid_request",
         "not_found",
         "plan_limit_reached",
+        "project_archived",
         "rate_limited",
         "scope_missing",
-        "service_unavailable"
+        "service_unavailable",
+        "state_conflict"
       ],
       "scopes": ["schedules:write"],
       "successStatus": 201,
@@ -283,10 +300,12 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
         "not_found",
+        "project_archived",
         "rate_limited",
         "scope_missing",
         "service_unavailable"
@@ -317,10 +336,12 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
         "not_found",
+        "project_archived",
         "rate_limited",
         "scope_missing",
         "service_unavailable"
@@ -344,16 +365,18 @@
           "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",
         "not_found",
+        "project_archived",
         "rate_limited",
         "scope_missing",
         "service_unavailable"
@@ -370,7 +393,7 @@
       "observe": "The endpoint in status `disabled`. Nothing further is delivered to it, and it stays readable so the attempts above keep their context.",
       "operationId": "endpoints.disable",
       "path": "/v1/endpoints/{endpointId}",
-      "purpose": "Stops delivery to the destination you registered for this walkthrough. Disabling is terminal and deliberate: it leaves the history intact rather than deleting evidence of what happened.",
+      "purpose": "Stops delivery to the destination you registered for this walkthrough. Disabling is deliberate rather than final: it leaves the history intact rather than deleting evidence of what happened, and `endpoints.enable` turns the destination back on if you want it again.",
       "recovery": [
         {
           "nextMove": "Already gone, or never in this project. Nothing to clean up.",
@@ -379,10 +402,12 @@
       ],
       "problems": [
         "authentication_required",
+        "capability_not_configured",
         "credential_expired",
         "credential_revoked",
         "invalid_request",
         "not_found",
+        "project_archived",
         "rate_limited",
         "scope_missing",
         "service_unavailable"