@whooshbang/contracts 3.3.0 → 4.0.0

package/openapi/generated/whooshbang-v1.bundle.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.1",
   "info": {
     "title": "WhooshBang API",
-    "version": "3.3.0",
+    "version": "4.0.0",
     "description": "The V1 contract for human organization/project administration, project-scoped\nsubscription links, and asynchronous text messages. A Clerk session selects\none organization for administration. A project credential selects one organization,\nproject, and `test` or `live` environment for product operations; request\nbodies cannot override either authenticated scope.\n\nA person's OAuth grant selects one organization and carries scopes, but no\nproject. It names the project and environment it acts in through the URL\npath, on the environment-scoped form of each operation; the service checks\nthat path against the granting person's membership on every call. The flat\nforms remain credential-only and are unchanged.\n\nResource identifiers are opaque and are not authorization. Reads outside the\ncredential scope return the same `404` shape as absent resources. Provider\ncredentials, raw Telegram identity, and protected provider responses are\nnever part of this API.\n",
     "termsOfService": "https://flowxo.com/terms",
     "contact": {
@@ -12443,6 +12443,7 @@
           "dispatch_pending",
           "queued",
           "sending",
+          "intake_pending",
           "provider_accepted",
           "retry_wait",
           "terminal_failed",
@@ -12556,6 +12557,7 @@
               "accepted",
               "queued",
               "attempt_started",
+              "attempt_intake_pending",
               "attempt_sent",
               "attempt_retry_scheduled",
               "attempt_could_not_send",
@@ -17165,6 +17167,7 @@
                     "dispatch_pending",
                     "queued",
                     "sending",
+                    "intake_pending",
                     "provider_accepted",
                     "cancelled",
                     "expired"
@@ -17234,6 +17237,32 @@
               }
             }
           },
+          {
+            "if": {
+              "type": "object",
+              "properties": { "state": { "const": "intake_pending" } },
+              "required": ["state"]
+            },
+            "then": {
+              "type": "object",
+              "properties": {
+                "delivery": {
+                  "allOf": [
+                    { "$ref": "#/components/schemas/DeliveryAttemptSummary" },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "attempt_count": { "type": "integer", "minimum": 1 },
+                        "highest_proven_provider_state": { "const": "none" },
+                        "retry_scheduled": { "const": false },
+                        "classified_error": false
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          },
           {
             "if": {
               "type": "object",
@@ -17391,7 +17420,12 @@
               "type": "object",
               "properties": {
                 "state": {
-                  "enum": ["sending", "provider_accepted", "outcome_unknown"]
+                  "enum": [
+                    "sending",
+                    "intake_pending",
+                    "provider_accepted",
+                    "outcome_unknown"
+                  ]
                 },
                 "cancellation_effective": { "type": "boolean" }
               },
@@ -18419,6 +18453,10 @@
         "type": "object",
         "required": ["items", "total"],
         "properties": {
+          "managed_domain_available": {
+            "type": "boolean",
+            "description": "Whether this deployment is configured to offer service-managed custom-domain setup. False is a deployment capability, not a domain readiness verdict."
+          },
           "items": {
             "type": "array",
             "maxItems": 100,
@@ -18486,20 +18524,37 @@
         "additionalProperties": false
       },
       "CreateEmailDomainRequest": {
-        "type": "object",
-        "description": "Creates or safely adopts one dedicated domain inside an authorized account-owned installation. No provider team id, API key or OAuth credential can be supplied.",
-        "required": ["installation_id", "domain"],
-        "properties": {
-          "installation_id": {
-            "$ref": "#/components/schemas/OpaqueIdentifier"
+        "description": "Creates or safely adopts an account-owned domain. Omit backend and installation_id for the default FlowXO Mail service. An existing legacy OAuth installation may still be selected by id.",
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["installation_id", "domain"],
+            "properties": {
+              "installation_id": {
+                "$ref": "#/components/schemas/OpaqueIdentifier"
+              },
+              "domain": { "$ref": "#/components/schemas/EmailDomainName" },
+              "tls": {
+                "enum": ["opportunistic", "enforced"],
+                "default": "opportunistic"
+              }
+            },
+            "additionalProperties": false
           },
-          "domain": { "$ref": "#/components/schemas/EmailDomainName" },
-          "tls": {
-            "enum": ["opportunistic", "enforced"],
-            "default": "opportunistic"
+          {
+            "type": "object",
+            "required": ["domain"],
+            "properties": {
+              "backend": { "const": "flowxo_mail" },
+              "domain": { "$ref": "#/components/schemas/EmailDomainName" },
+              "tls": {
+                "enum": ["opportunistic", "enforced"],
+                "default": "opportunistic"
+              }
+            },
+            "additionalProperties": false
           }
-        },
-        "additionalProperties": false
+        ]
       },
       "CreateEmailBindingImportRequest": {
         "type": "object",
@@ -20902,7 +20957,7 @@
         "additionalProperties": false
       },
       "EmailDnsRecord": {
-        "description": "One exact neutral DNS record. `name` is preserved exactly as the provider returns it and is relative to the registrable domain (for example `send.notify`, not `send.notify.example.com`).",
+        "description": "One exact neutral DNS record. `name` and `value` are preserved exactly as supplied; a record name may be relative to the registrable domain or a full hostname. DNS consoles differ in whether they append the zone automatically.",
         "oneOf": [
           {
             "type": "object",
@@ -21202,7 +21257,7 @@
           "binding_id": { "$ref": "#/components/schemas/OpaqueIdentifier-2" },
           "channel": {
             "type": "string",
-            "enum": ["telegram"],
+            "enum": ["telegram", "email"],
             "description": "Which channel the person answered on. An enum rather than a fixed value, so that a second channel adds a member instead of changing the type every generated client holds. The vocabulary grows additively; a consumer that meets a member it does not know should treat the answer as valid and the channel as unfamiliar rather than refusing it."
           },
           "conversation_kind": {
@@ -22126,7 +22181,7 @@
       "provider-capabilities-v1.schema": {
         "$schema": "https://json-schema.org/draft/2020-12/schema",
         "$id": "https://whooshbang.flowxo.com/schemas/provider-capabilities-v1.schema.json",
-        "x-contract-version": "3.3.0",
+        "x-contract-version": "4.0.0",
         "title": "ProviderCapabilitiesV1",
         "description": "Provider-neutral, renderer-facing delivery and interaction capabilities with explicit degradation.",
         "type": "object",
@@ -22928,5 +22983,5 @@
       }
     }
   },
-  "x-contract-version": "3.3.0"
+  "x-contract-version": "4.0.0"
 }

package/openapi/whooshbang-v1.yaml

@@ -1,10 +1,10 @@
 openapi: 3.1.1
 jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
 # whooshbang:public-origin production api https://api.whooshbang.com
-x-contract-version: 3.3.0
+x-contract-version: 4.0.0
 info:
   title: WhooshBang API
-  version: 3.3.0
+  version: 4.0.0
   description: |
     The V1 contract for human organization/project administration, project-scoped
     subscription links, and asynchronous text messages. A Clerk session selects

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whooshbang/contracts",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "Versioned public contracts for WhooshBang",
   "private": false,
   "license": "MIT",

package/schemas/core-scenario.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/core-scenario.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "CoreContractScenario",
   "description": "A deterministic C0-02 semantic, state, idempotency, or isolation scenario.",
   "type": "object",

package/schemas/events/agent-binding-degraded-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/agent-binding-degraded-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "AgentBindingDegradedEventV1",
   "description": "An agent binding entered a provider-neutral degraded state.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/AgentBindingDegradedEvent"

package/schemas/events/interaction-expired-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/interaction-expired-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "InteractionExpiredEventV1",
   "description": "An interaction reached its terminal expiry without a valid answer.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/InteractionExpiredEvent"

package/schemas/events/interaction-received-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/interaction-received-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "InteractionReceivedEventV1",
   "description": "One authenticated, provider-neutral interaction answer was received.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/InteractionReceivedEvent"

package/schemas/events/message-delivered-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/message-delivered-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "MessageDeliveredEventV1",
   "description": "A provider supplied trustworthy evidence that a message was delivered.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageDeliveredEvent"

package/schemas/events/message-expired-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/message-expired-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "MessageExpiredEventV1",
   "description": "A message expired before reaching a later delivery state.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageExpiredEvent"

package/schemas/events/message-failed-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/message-failed-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "MessageFailedEventV1",
   "description": "A message reached a classified terminal failure.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageFailedEvent"

package/schemas/events/message-provider-accepted-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/message-provider-accepted-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "MessageProviderAcceptedEventV1",
   "description": "The provider accepted a message without implying delivery.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageProviderAcceptedEvent"

package/schemas/events/subscription-activated-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/subscription-activated-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "SubscriptionActivatedEventV1",
   "description": "A subscription became active with a safe public channel binding.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/SubscriptionActivatedEvent"

package/schemas/events/subscription-revoked-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/subscription-revoked-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "SubscriptionRevokedEventV1",
   "description": "A subscription and its safe public channel binding were revoked.",
   "$ref": "whooshbang-event-v1.schema.json#/$defs/SubscriptionRevokedEvent"

package/schemas/events/whooshbang-event-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/events/whooshbang-event-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "WhooshBangEventV1ContractDocument",
   "description": "Strict public customer-event envelope and initial WhooshBang event union.",
   "oneOf": [

package/schemas/fixture-index.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/fixture-index.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "CoreFixtureIndex",
   "description": "The machine-readable index of deterministic C0-02 through C0-04 golden fixtures.",
   "type": "object",

package/schemas/interaction-machine-scenario.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/interaction-machine-scenario.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "InteractionMachineScenario",
   "description": "A deterministic C0-03 interaction, credential, authorization, polling, acknowledgement, or quarantine scenario.",
   "type": "object",

package/schemas/interaction-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/interaction-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "InteractionV1ContractDocument",
   "description": "Provider-neutral confirm, single-select, input, lifecycle, callback-token, and authenticated answer-event contracts.",
   "$defs": {
@@ -369,7 +369,7 @@
         },
         "channel": {
           "type": "string",
-          "enum": ["telegram"],
+          "enum": ["telegram", "email"],
           "description": "Which channel the person answered on. An enum rather than a fixed value, so that a second channel adds a member instead of changing the type every generated client holds. The vocabulary grows additively; a consumer that meets a member it does not know should treat the answer as valid and the channel as unfamiliar rather than refusing it."
         },
         "conversation_kind": {

package/schemas/machine-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/machine-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "MachineV1ContractDocument",
   "description": "Machine-client administration, locally generated credential metadata, durable long-poll, and contiguous acknowledgement contracts.",
   "oneOf": [

package/schemas/provider-capabilities-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/provider-capabilities-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "ProviderCapabilitiesV1",
   "description": "Provider-neutral, renderer-facing delivery and interaction capabilities with explicit degradation.",
   "type": "object",

package/schemas/webhooks/webhook-delivery-case-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/webhooks/webhook-delivery-case-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "WebhookDeliveryCaseSetV1",
   "description": "Deterministic customer webhook response classification, Retry-After, and delivery-bound cases.",
   "type": "object",

package/schemas/webhooks/webhook-signing-vector-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/webhooks/webhook-signing-vector-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "WebhookSigningVectorSetV1",
   "description": "Language-neutral deterministic Standard Webhooks V1 verification vectors. All key material is public synthetic test data and must never be used outside fixtures.",
   "type": "object",

package/schemas/whooshbang-v1.schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/whooshbang-v1.schema.json",
-  "x-contract-version": "3.3.0",
+  "x-contract-version": "4.0.0",
   "title": "WhooshBangV1ContractDocument",
   "description": "Public request, resource, summary, and Problem Details models for the WhooshBang V1 REST API.",
   "anyOf": [
@@ -5783,6 +5783,7 @@
         "dispatch_pending",
         "queued",
         "sending",
+        "intake_pending",
         "provider_accepted",
         "retry_wait",
         "terminal_failed",
@@ -5984,6 +5985,7 @@
                   "dispatch_pending",
                   "queued",
                   "sending",
+                  "intake_pending",
                   "provider_accepted",
                   "cancelled",
                   "expired"
@@ -6077,6 +6079,36 @@
             }
           }
         },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "state": {
+                "const": "intake_pending"
+              }
+            },
+            "required": ["state"]
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "delivery": {
+                "allOf": [
+                  { "$ref": "#/$defs/DeliveryAttemptSummary" },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "attempt_count": { "type": "integer", "minimum": 1 },
+                      "highest_proven_provider_state": { "const": "none" },
+                      "retry_scheduled": { "const": false },
+                      "classified_error": false
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        },
         {
           "if": {
             "type": "object",
@@ -6276,7 +6308,12 @@
             "type": "object",
             "properties": {
               "state": {
-                "enum": ["sending", "provider_accepted", "outcome_unknown"]
+                "enum": [
+                  "sending",
+                  "intake_pending",
+                  "provider_accepted",
+                  "outcome_unknown"
+                ]
               },
               "cancellation_effective": {
                 "type": "boolean"
@@ -8016,7 +8053,7 @@
       "additionalProperties": false
     },
     "EmailDnsRecord": {
-      "description": "One exact neutral DNS record. `name` is preserved exactly as the provider returns it and is relative to the registrable domain (for example `send.notify`, not `send.notify.example.com`).",
+      "description": "One exact neutral DNS record. `name` and `value` are preserved exactly as supplied; a record name may be relative to the registrable domain or a full hostname. DNS consoles differ in whether they append the zone automatically.",
       "oneOf": [
         {
           "type": "object",
@@ -8304,6 +8341,10 @@
       "type": "object",
       "required": ["items", "total"],
       "properties": {
+        "managed_domain_available": {
+          "type": "boolean",
+          "description": "Whether this deployment is configured to offer service-managed custom-domain setup. False is a deployment capability, not a domain readiness verdict."
+        },
         "items": {
           "type": "array",
           "maxItems": 100,
@@ -8330,22 +8371,41 @@
       "additionalProperties": false
     },
     "CreateEmailDomainRequest": {
-      "type": "object",
-      "description": "Creates or safely adopts one dedicated domain inside an authorized account-owned installation. No provider team id, API key or OAuth credential can be supplied.",
-      "required": ["installation_id", "domain"],
-      "properties": {
-        "installation_id": {
-          "$ref": "#/$defs/OpaqueIdentifier"
-        },
-        "domain": {
-          "$ref": "#/$defs/EmailDomainName"
+      "description": "Creates or safely adopts an account-owned domain. Omit backend and installation_id for the default FlowXO Mail service. An existing legacy OAuth installation may still be selected by id.",
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["installation_id", "domain"],
+          "properties": {
+            "installation_id": {
+              "$ref": "#/$defs/OpaqueIdentifier"
+            },
+            "domain": {
+              "$ref": "#/$defs/EmailDomainName"
+            },
+            "tls": {
+              "enum": ["opportunistic", "enforced"],
+              "default": "opportunistic"
+            }
+          },
+          "additionalProperties": false
         },
-        "tls": {
-          "enum": ["opportunistic", "enforced"],
-          "default": "opportunistic"
+        {
+          "type": "object",
+          "required": ["domain"],
+          "properties": {
+            "backend": { "const": "flowxo_mail" },
+            "domain": {
+              "$ref": "#/$defs/EmailDomainName"
+            },
+            "tls": {
+              "enum": ["opportunistic", "enforced"],
+              "default": "opportunistic"
+            }
+          },
+          "additionalProperties": false
         }
-      },
-      "additionalProperties": false
+      ]
     },
     "EmailBindingImportRow": {
       "type": "object",
@@ -10386,6 +10446,7 @@
             "accepted",
             "queued",
             "attempt_started",
+            "attempt_intake_pending",
             "attempt_sent",
             "attempt_retry_scheduled",
             "attempt_could_not_send",