@whooshbang/contracts 1.0.0-rc.21 → 1.0.0-rc.22

package/schemas/whooshbang-v1.schema.json

@@ -1,19 +1,31 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://whooshbang.flowxo.com/schemas/whooshbang-v1.schema.json",
-  "x-contract-version": "1.0.0-rc.21",
+  "x-contract-version": "1.0.0-rc.22",
   "title": "WhooshBangV1ContractDocument",
   "description": "Public request, resource, summary, and Problem Details models for the WhooshBang V1 REST API.",
   "anyOf": [
     {
       "$ref": "#/$defs/AccountProjection"
     },
+    {
+      "$ref": "#/$defs/CloseAccountRequest"
+    },
+    {
+      "$ref": "#/$defs/AccountClosureResult"
+    },
     {
       "$ref": "#/$defs/CreateProjectRequest"
     },
     {
       "$ref": "#/$defs/Project"
     },
+    {
+      "$ref": "#/$defs/UpdateProjectRequest"
+    },
+    {
+      "$ref": "#/$defs/PrivacyMode"
+    },
     {
       "$ref": "#/$defs/ProjectCollection"
     },
@@ -182,6 +194,9 @@
     {
       "$ref": "#/$defs/Subscriber"
     },
+    {
+      "$ref": "#/$defs/SubscriberDataExport"
+    },
     {
       "$ref": "#/$defs/CreateRecipientGroupRequest"
     },
@@ -372,6 +387,59 @@
       },
       "additionalProperties": false
     },
+    "CloseAccountRequest": {
+      "type": "object",
+      "description": "Exact, explicit confirmation that the current account administrator intends to close the whole account.",
+      "required": ["confirmation"],
+      "properties": {
+        "confirmation": {
+          "type": "string",
+          "const": "close-account"
+        }
+      },
+      "additionalProperties": false
+    },
+    "AccountClosureProviderAction": {
+      "type": "object",
+      "description": "One provider-owned resource the customer must retire outside WhooshBang after account closure. It contains safe identifiers only, never provider credentials.",
+      "required": ["provider", "action", "connection_id"],
+      "properties": {
+        "provider": {
+          "type": "string",
+          "enum": ["telegram", "slack"]
+        },
+        "action": {
+          "type": "string",
+          "enum": ["revoke_bot_token", "delete_provider_application"]
+        },
+        "connection_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        }
+      },
+      "additionalProperties": false
+    },
+    "AccountClosureResult": {
+      "type": "object",
+      "description": "Terminal account-closure result. Repeating closure returns the same closed_at and any provider-owned resources that still require manual retirement.",
+      "required": ["status", "closed_at", "provider_actions_required"],
+      "properties": {
+        "status": {
+          "type": "string",
+          "const": "closed"
+        },
+        "closed_at": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "provider_actions_required": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/AccountClosureProviderAction"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     "CreateProjectRequest": {
       "type": "object",
       "description": "Creates one project inside the account selected by the authenticated human session.",
@@ -392,6 +460,10 @@
           "$ref": "#/$defs/RecipientLanguage",
           "default": "en",
           "description": "The application fallback locale for recipient-owned surfaces when no session, subscriber, or supported provider locale is available."
+        },
+        "privacy_mode": {
+          "$ref": "#/$defs/PrivacyMode",
+          "default": "minimal"
         }
       },
       "additionalProperties": false
@@ -463,7 +535,8 @@
         "environments",
         "created_at",
         "updated_at",
-        "diagnostic_id"
+        "diagnostic_id",
+        "privacy_mode"
       ],
       "properties": {
         "id": {
@@ -507,6 +580,9 @@
         },
         "diagnostic_id": {
           "$ref": "#/$defs/DiagnosticId"
+        },
+        "privacy_mode": {
+          "$ref": "#/$defs/PrivacyMode"
         }
       },
       "additionalProperties": false
@@ -1969,6 +2045,115 @@
       },
       "additionalProperties": false
     },
+    "SubscriberDataExportRecord": {
+      "type": "object",
+      "description": "One semantic record held about the subscriber. The source names the durable store or recovered semantic value; data contains plaintext business fields and excludes custody metadata and secrets.",
+      "required": ["source", "data"],
+      "properties": {
+        "source": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 96,
+          "pattern": "^[a-z][a-z0-9_.-]*$"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "SubscriberDataExportExcludedControllerData": {
+      "type": "object",
+      "description": "A category deliberately outside the customer-controller artifact because WhooshBang is controller for it.",
+      "required": ["category", "controller", "access"],
+      "properties": {
+        "category": {
+          "type": "string",
+          "enum": ["consent_lifecycle_audit", "service_logs"]
+        },
+        "controller": {
+          "type": "string",
+          "const": "whooshbang"
+        },
+        "access": {
+          "type": "string",
+          "const": "separate_recipient_request_required"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SubscriberDataExport": {
+      "type": "object",
+      "description": "A complete customer-controller access artifact for one subscriber across every environment in one project. provided_by_subscriber is the Article 20 portable subset; all three record groups together are the Article 15 access copy. WhooshBang-controller records are named but never mixed into the customer export.",
+      "required": [
+        "format",
+        "generated_at",
+        "controller_scope",
+        "project_id",
+        "environment_ids",
+        "subscriber_id",
+        "provided_by_subscriber",
+        "provided_by_customer",
+        "derived_by_service",
+        "excluded_controller_data"
+      ],
+      "properties": {
+        "format": {
+          "type": "string",
+          "const": "whooshbang.subscriber-data-export.v1"
+        },
+        "generated_at": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "controller_scope": {
+          "type": "string",
+          "const": "customer"
+        },
+        "project_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "environment_ids": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/OpaqueIdentifier"
+          }
+        },
+        "subscriber_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "provided_by_subscriber": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/SubscriberDataExportRecord"
+          }
+        },
+        "provided_by_customer": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/SubscriberDataExportRecord"
+          }
+        },
+        "derived_by_service": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/SubscriberDataExportRecord"
+          }
+        },
+        "excluded_controller_data": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/SubscriberDataExportExcludedControllerData"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     "CreateRecipientGroupRequest": {
       "type": "object",
       "description": "Creates one static, developer-managed recipient group.",
@@ -3237,7 +3422,7 @@
         },
         "delivery_target": {
           "$ref": "#/$defs/MessageDeliveryTarget",
-          "description": "Optional routing override. Omit for notifier-default connection delivery, except reserved simulator destinations retained for compatibility."
+          "description": "Optional routing override. Simulator delivery and the reserved test: subscriber prefix are test-environment-only; live requests are refused with 400 request_invalid. Omit for notifier-default connection delivery or the reserved test-environment simulator default."
         },
         "connection_id": {
           "allOf": [{ "$ref": "#/$defs/OpaqueIdentifier" }],
@@ -3828,6 +4013,7 @@
         "environment_mismatch",
         "idempotency_key_required",
         "idempotency_conflict",
+        "privacy_operation_in_progress",
         "project_slug_conflict",
         "request_invalid",
         "replay_unavailable",
@@ -4253,6 +4439,26 @@
             }
           }
         },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "https://whooshbang.flowxo.com/problems/privacy_operation_in_progress"
+            },
+            "title": {
+              "const": "Privacy operation in progress"
+            },
+            "status": {
+              "const": 409
+            },
+            "code": {
+              "const": "privacy_operation_in_progress"
+            },
+            "retryable": {
+              "const": true
+            }
+          }
+        },
         {
           "type": "object",
           "properties": {
@@ -6013,6 +6219,22 @@
         { "$ref": "#/$defs/TelegramConnectionIdentity" },
         { "$ref": "#/$defs/SlackConnectionIdentity" }
       ]
+    },
+    "PrivacyMode": {
+      "type": "string",
+      "enum": ["minimal", "standard", "private"],
+      "description": "Project profile collection policy. minimal (the default for new and existing projects) keeps recipient language only; standard permits messenger profile data; private retains delivery routing and the customer-supplied subscriber identifier, with no profile data. Lowering collection erases existing fields the new mode disallows."
+    },
+    "UpdateProjectRequest": {
+      "type": "object",
+      "description": "Sets the project privacy policy. Moving from standard to minimal erases stored identifying profile data; moving to private also erases recipient language. Increasing collection does not restore erased data.",
+      "required": ["privacy_mode"],
+      "properties": {
+        "privacy_mode": {
+          "$ref": "#/$defs/PrivacyMode"
+        }
+      },
+      "additionalProperties": false
     }
   }
 }