@greatwait/contracts 0.1.0-alpha.7 → 0.2.0

package/generated/v1/policy-matrix.json

@@ -526,6 +526,27 @@
     "roles": ["admin"],
     "scopes": ["members:manage"]
   },
+  {
+    "mutates": false,
+    "operation": "projectnotifications.read",
+    "principals": ["api-credential", "oauth", "session"],
+    "roles": ["admin", "billing", "member"],
+    "scopes": ["projects:read"]
+  },
+  {
+    "mutates": true,
+    "operation": "projectnotifications.rotateSigningKey",
+    "principals": ["api-credential", "oauth", "session"],
+    "roles": ["admin"],
+    "scopes": ["projects:administer"]
+  },
+  {
+    "mutates": true,
+    "operation": "projectnotifications.update",
+    "principals": ["api-credential", "oauth", "session"],
+    "roles": ["admin"],
+    "scopes": ["projects:administer"]
+  },
   {
     "mutates": true,
     "operation": "projects.archive",
@@ -633,6 +654,13 @@
     "roles": ["admin", "billing", "member"],
     "scopes": ["endpoints:read"]
   },
+  {
+    "mutates": false,
+    "operation": "statusdeliveries.list",
+    "principals": ["api-credential", "oauth", "session"],
+    "roles": ["admin", "billing", "member"],
+    "scopes": ["occurrences:read"]
+  },
   {
     "mutates": true,
     "operation": "testsinks.configure",

package/generated/v1/schemas/billing.notices.response.json

@@ -138,7 +138,8 @@
               "payment-authentication-required",
               "payment-outcome-unresolved",
               "service-restored",
-              "schedule-auto-paused"
+              "schedule-auto-paused",
+              "delivery-failed"
             ]
           },
           "occurredAt": {
@@ -190,7 +191,7 @@
               {
                 "type": "string",
                 "maxLength": 1024,
-                "pattern": "^\\/o\\/[A-Za-z0-9_%.-]+\\/p\\/proj_[0-9abcdefghjkmnpqrstvwxyz]{26}\\/(?:live|test)\\/schedules\\/sch_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+                "pattern": "^\\/o\\/[A-Za-z0-9_%.-]+\\/p\\/proj_[0-9abcdefghjkmnpqrstvwxyz]{26}\\/(?:live|test)\\/schedules(?:\\/sch_[0-9abcdefghjkmnpqrstvwxyz]{26}(?:\\/occurrences\\/occ_[0-9abcdefghjkmnpqrstvwxyz]{26})?)?$"
               }
             ]
           },

package/generated/v1/schemas/billing.purchase.request.json

@@ -19,6 +19,10 @@
       "type": "string",
       "minLength": 1,
       "maxLength": 128
+    },
+    "savePaymentMethod": {
+      "type": "boolean",
+      "description": "true: the customer also asks to keep the payment method they pay with, for automatic top-up and for projects past the free one. The hosted payment then saves it for later charges made without the customer present (it offers every method the account enables except Klarna, which cannot be charged that way), and once the provider confirms this payment paid, that method becomes the organization's saved payment method if it has none. An existing saved payment method is never replaced, and saving one never turns automatic top-up on. Omitted or false: the purchase does exactly what it always did."
     }
   },
   "required": ["confirmed", "expectedRevision", "quote"],

package/generated/v1/schemas/projectnotifications.read.response.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "pattern": "^proj_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+    },
+    "environmentKind": {
+      "type": "string",
+      "enum": ["test", "live"]
+    },
+    "revision": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "email": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "recipients": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "admins"
+                }
+              },
+              "required": ["kind"]
+            },
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "members"
+                },
+                "memberIds": {
+                  "minItems": 1,
+                  "maxItems": 100,
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^mem_[0-9a-f]{26}$"
+                  }
+                }
+              },
+              "required": ["kind", "memberIds"]
+            }
+          ]
+        },
+        "scheduleKinds": {
+          "type": "string",
+          "enum": ["both", "one-shot", "recurring"]
+        }
+      },
+      "required": ["enabled", "recipients", "scheduleKinds"]
+    },
+    "statusWebhook": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "maxLength": 2048,
+          "format": "uri"
+        },
+        "events": {
+          "minItems": 1,
+          "maxItems": 1,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["failed"]
+          }
+        },
+        "signingKey": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^csk_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+            }
+          },
+          "required": ["id"]
+        },
+        "revision": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": ["url", "events", "revision"]
+    }
+  },
+  "required": ["project", "environmentKind", "revision", "email"]
+}

package/generated/v1/schemas/projectnotifications.rotateSigningKey.request.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "expectedRevision": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": ["expectedRevision"],
+  "additionalProperties": false
+}

package/generated/v1/schemas/projectnotifications.rotateSigningKey.response.json

@@ -0,0 +1,119 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "settings": {
+      "type": "object",
+      "properties": {
+        "project": {
+          "type": "string",
+          "pattern": "^proj_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+        },
+        "environmentKind": {
+          "type": "string",
+          "enum": ["test", "live"]
+        },
+        "revision": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        "email": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            },
+            "recipients": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "kind": {
+                      "type": "string",
+                      "const": "admins"
+                    }
+                  },
+                  "required": ["kind"]
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "kind": {
+                      "type": "string",
+                      "const": "members"
+                    },
+                    "memberIds": {
+                      "minItems": 1,
+                      "maxItems": 100,
+                      "type": "array",
+                      "items": {
+                        "type": "string",
+                        "pattern": "^mem_[0-9a-f]{26}$"
+                      }
+                    }
+                  },
+                  "required": ["kind", "memberIds"]
+                }
+              ]
+            },
+            "scheduleKinds": {
+              "type": "string",
+              "enum": ["both", "one-shot", "recurring"]
+            }
+          },
+          "required": ["enabled", "recipients", "scheduleKinds"]
+        },
+        "statusWebhook": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "maxLength": 2048,
+              "format": "uri"
+            },
+            "events": {
+              "minItems": 1,
+              "maxItems": 1,
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": ["failed"]
+              }
+            },
+            "signingKey": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "pattern": "^csk_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+                }
+              },
+              "required": ["id"]
+            },
+            "revision": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            }
+          },
+          "required": ["url", "events", "revision"]
+        }
+      },
+      "required": ["project", "environmentKind", "revision", "email"]
+    },
+    "keyId": {
+      "type": "string",
+      "pattern": "^csk_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+    },
+    "secret": {
+      "type": "string",
+      "minLength": 1
+    },
+    "shownOnce": {
+      "type": "boolean",
+      "const": true
+    }
+  },
+  "required": ["settings", "keyId", "secret", "shownOnce"]
+}

package/generated/v1/schemas/projectnotifications.update.request-headers.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "Idempotency-Key": {
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 255,
+      "pattern": "^[\\x20-\\x7e]+$"
+    }
+  },
+  "required": ["Idempotency-Key"]
+}

package/generated/v1/schemas/projectnotifications.update.request.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "expectedRevision": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "email": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "recipients": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "admins"
+                }
+              },
+              "required": ["kind"],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "members"
+                },
+                "memberIds": {
+                  "minItems": 1,
+                  "maxItems": 100,
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^mem_[0-9a-f]{26}$"
+                  }
+                }
+              },
+              "required": ["kind", "memberIds"],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "scheduleKinds": {
+          "type": "string",
+          "enum": ["both", "one-shot", "recurring"]
+        }
+      },
+      "required": ["enabled", "recipients", "scheduleKinds"],
+      "additionalProperties": false
+    },
+    "statusWebhook": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "maxLength": 2048,
+              "format": "uri"
+            },
+            "events": {
+              "minItems": 1,
+              "maxItems": 1,
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": ["failed"]
+              }
+            }
+          },
+          "required": ["url", "events"],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": ["expectedRevision"],
+  "additionalProperties": false
+}

package/generated/v1/schemas/projectnotifications.update.response.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "pattern": "^proj_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+    },
+    "environmentKind": {
+      "type": "string",
+      "enum": ["test", "live"]
+    },
+    "revision": {
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "email": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "recipients": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "admins"
+                }
+              },
+              "required": ["kind"]
+            },
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "const": "members"
+                },
+                "memberIds": {
+                  "minItems": 1,
+                  "maxItems": 100,
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^mem_[0-9a-f]{26}$"
+                  }
+                }
+              },
+              "required": ["kind", "memberIds"]
+            }
+          ]
+        },
+        "scheduleKinds": {
+          "type": "string",
+          "enum": ["both", "one-shot", "recurring"]
+        }
+      },
+      "required": ["enabled", "recipients", "scheduleKinds"]
+    },
+    "statusWebhook": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "maxLength": 2048,
+          "format": "uri"
+        },
+        "events": {
+          "minItems": 1,
+          "maxItems": 1,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["failed"]
+          }
+        },
+        "signingKey": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^csk_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+            }
+          },
+          "required": ["id"]
+        },
+        "revision": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": ["url", "events", "revision"]
+    }
+  },
+  "required": ["project", "environmentKind", "revision", "email"]
+}

package/generated/v1/schemas/statusdeliveries.list.query.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "cursor": {
+      "type": "string",
+      "minLength": 1
+    },
+    "limit": {
+      "default": 25,
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100
+    }
+  }
+}

package/generated/v1/schemas/statusdeliveries.list.response.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "event": {
+            "type": "string",
+            "enum": ["failed"]
+          },
+          "schedule": {
+            "type": "string",
+            "pattern": "^sch_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+          },
+          "occurrence": {
+            "type": "string",
+            "pattern": "^occ_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+          },
+          "occurredAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "url": {
+            "type": "string",
+            "format": "uri"
+          },
+          "state": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "delivering",
+              "delivered",
+              "failed",
+              "suppressed"
+            ]
+          },
+          "attempts": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "nextAttemptAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "lastStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "lastError": {
+            "type": "string",
+            "maxLength": 128
+          }
+        },
+        "required": [
+          "id",
+          "event",
+          "schedule",
+          "occurrence",
+          "occurredAt",
+          "url",
+          "state",
+          "attempts"
+        ]
+      }
+    },
+    "nextCursor": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": ["data"]
+}

package/generated/v1/snippets/projectnotifications.read.json

@@ -0,0 +1,6 @@
+{
+  "curl": "curl -sS -X GET \"$GREATWAIT_API_URL/v1/projects/$GREATWAIT_PROJECTID/notification-settings\" \\\n  --variable %GREATWAIT_API_KEY \\\n  --expand-header \"Authorization: Bearer {{GREATWAIT_API_KEY}}\"",
+  "environments": ["test", "live"],
+  "javascript": "import { createGreatwaitClient } from \"@greatwait/api-client\";\n\nconst greatwait = createGreatwaitClient({\n  baseUrl: process.env.GREATWAIT_API_URL,\n  credential: process.env.GREATWAIT_API_KEY,\n  fetch,\n});\n\nconst projectId = process.env.GREATWAIT_PROJECTID;\n\nconst result = await greatwait.request(\"projectnotifications_read\", projectId);",
+  "mcp": "// Any MCP client, against $GREATWAIT_API_URL/mcp.\n{\n  \"arguments\": {\n    \"projectId\": \"$PROJECTID\"\n  },\n  \"name\": \"projectnotifications_read\"\n}"
+}

package/generated/v1/snippets/projectnotifications.rotateSigningKey.json

@@ -0,0 +1,6 @@
+{
+  "curl": "curl -sS -X POST \"$GREATWAIT_API_URL/v1/projects/$GREATWAIT_PROJECTID/notification-settings/status-signing-key\" \\\n  --variable %GREATWAIT_API_KEY \\\n  --expand-header \"Authorization: Bearer {{GREATWAIT_API_KEY}}\" \\\n  -H 'Content-Type: application/json' \\\n  --data-binary '{\"expectedRevision\":1}'",
+  "environments": ["test", "live"],
+  "javascript": "import { createGreatwaitClient } from \"@greatwait/api-client\";\n\nconst greatwait = createGreatwaitClient({\n  baseUrl: process.env.GREATWAIT_API_URL,\n  credential: process.env.GREATWAIT_API_KEY,\n  fetch,\n});\n\nconst projectId = process.env.GREATWAIT_PROJECTID;\n\nconst body = {\n  \"expectedRevision\": 1\n};\n\nconst result = await greatwait.request(\"projectnotifications_rotateSigningKey\", projectId, body);",
+  "mcp": "// projectnotifications.rotateSigningKey is not on the MCP surface.\n// Minting or rotating returns a one-time signing secret. MCP has no negotiated secure-result channel that keeps it out of ordinary tool history. Configure preferences with projectnotifications_update, then use the dashboard or an authenticated REST/SDK/CLI client for the secret."
+}

package/generated/v1/snippets/projectnotifications.update.json

@@ -0,0 +1,6 @@
+{
+  "curl": "curl -sS -X PATCH \"$GREATWAIT_API_URL/v1/projects/$GREATWAIT_PROJECTID/notification-settings\" \\\n  --variable %GREATWAIT_API_KEY \\\n  --expand-header \"Authorization: Bearer {{GREATWAIT_API_KEY}}\" \\\n  -H 'Content-Type: application/json' \\\n  -H 'Idempotency-Key: $GREATWAIT_IDEMPOTENCY_KEY' \\\n  --data-binary '{\"expectedRevision\":1,\"email\":{\"enabled\":true,\"recipients\":{\"kind\":\"admins\"},\"scheduleKinds\":\"both\"}}'",
+  "environments": ["test", "live"],
+  "javascript": "import { createGreatwaitClient } from \"@greatwait/api-client\";\n\nconst greatwait = createGreatwaitClient({\n  baseUrl: process.env.GREATWAIT_API_URL,\n  credential: process.env.GREATWAIT_API_KEY,\n  fetch,\n});\n\nconst projectId = process.env.GREATWAIT_PROJECTID;\n\nconst body = {\n  \"expectedRevision\": 1,\n  \"email\": {\n    \"enabled\": true,\n    \"recipients\": {\n      \"kind\": \"admins\"\n    },\n    \"scheduleKinds\": \"both\"\n  }\n};\n\nconst result = await greatwait.request(\"projectnotifications_update\", projectId, body, { \"Idempotency-Key\": process.env.GREATWAIT_IDEMPOTENCY_KEY });",
+  "mcp": "// Any MCP client, against $GREATWAIT_API_URL/mcp.\n{\n  \"arguments\": {\n    \"Idempotency-Key\": \"$IDEMPOTENCY_KEY\",\n    \"expectedRevision\": 1,\n    \"projectId\": \"$PROJECTID\",\n    \"email\": {\n      \"enabled\": true,\n      \"recipients\": {\n        \"kind\": \"admins\"\n      },\n      \"scheduleKinds\": \"both\"\n    }\n  },\n  \"name\": \"projectnotifications_update\"\n}"
+}

package/generated/v1/snippets/statusdeliveries.list.json

@@ -0,0 +1,6 @@
+{
+  "curl": "curl -sS -X GET \"$GREATWAIT_API_URL/v1/projects/$GREATWAIT_PROJECTID/status-deliveries\" \\\n  --variable %GREATWAIT_API_KEY \\\n  --expand-header \"Authorization: Bearer {{GREATWAIT_API_KEY}}\"",
+  "environments": ["test", "live"],
+  "javascript": "import { createGreatwaitClient } from \"@greatwait/api-client\";\n\nconst greatwait = createGreatwaitClient({\n  baseUrl: process.env.GREATWAIT_API_URL,\n  credential: process.env.GREATWAIT_API_KEY,\n  fetch,\n});\n\nconst projectId = process.env.GREATWAIT_PROJECTID;\n\nconst result = await greatwait.request(\"statusdeliveries_list\", projectId);",
+  "mcp": "// Any MCP client, against $GREATWAIT_API_URL/mcp.\n{\n  \"arguments\": {\n    \"projectId\": \"$PROJECTID\"\n  },\n  \"name\": \"statusdeliveries_list\"\n}"
+}

package/package.json

@@ -154,5 +154,5 @@
   },
   "sideEffects": false,
   "type": "module",
-  "version": "0.1.0-alpha.7"
+  "version": "0.2.0"
 }