@medalsocial/sdk 1.2.1 → 1.4.0

package/dist/openapi/medal-social.openapi.json

@@ -45,6 +45,14 @@
     {
       "name": "Workspaces",
       "description": "Inspect workspaces accessible to the current credential."
+    },
+    {
+      "name": "Helpdesk",
+      "description": "Read helpdesk conversations, reply, and manage assignment/status."
+    },
+    {
+      "name": "Webhooks",
+      "description": "Manage webhook endpoints and inspect their deliveries."
     }
   ],
   "paths": {
@@ -115,7 +123,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PostCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_PostCreateResult"
                 }
               }
             }
@@ -139,7 +147,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ChannelArray"
+                  "$ref": "#/components/schemas/ApiResponse_ChannelArray"
                 }
               }
             }
@@ -168,7 +176,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PostDetail"
+                  "$ref": "#/components/schemas/ApiResponse_PostDetail"
                 }
               }
             }
@@ -200,7 +208,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Success"
+                  "$ref": "#/components/schemas/ApiResponse_Success"
                 }
               }
             }
@@ -222,7 +230,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Success"
+                  "$ref": "#/components/schemas/ApiResponse_Success"
                 }
               }
             }
@@ -261,7 +269,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ScheduleResult"
+                  "$ref": "#/components/schemas/ApiResponse_ScheduleResult"
                 }
               }
             }
@@ -290,7 +298,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PublishResult"
+                  "$ref": "#/components/schemas/ApiResponse_PublishResult"
                 }
               }
             }
@@ -324,7 +332,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailSendResult"
+                  "$ref": "#/components/schemas/ApiResponse_EmailSendResult"
                 }
               }
             }
@@ -358,7 +366,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_BatchSendSummary"
+                  "$ref": "#/components/schemas/ApiResponse_BatchSendSummary"
                 }
               }
             }
@@ -382,7 +390,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailTemplateArray"
+                  "$ref": "#/components/schemas/ApiResponse_EmailTemplateArray"
                 }
               }
             }
@@ -427,7 +435,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailTemplateDetail"
+                  "$ref": "#/components/schemas/ApiResponse_EmailTemplateDetail"
                 }
               }
             }
@@ -456,7 +464,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailSend"
+                  "$ref": "#/components/schemas/ApiResponse_EmailSend"
                 }
               }
             }
@@ -549,7 +557,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactCreateResult"
                 }
               }
             }
@@ -595,7 +603,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ImportContactsResult"
+                  "$ref": "#/components/schemas/ApiResponse_ImportContactsResult"
                 }
               }
             }
@@ -624,7 +632,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Contact"
+                  "$ref": "#/components/schemas/ApiResponse_Contact"
                 }
               }
             }
@@ -656,7 +664,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactUpdateResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactUpdateResult"
                 }
               }
             }
@@ -678,7 +686,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactRemoveResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactRemoveResult"
                 }
               }
             }
@@ -754,7 +762,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactNoteResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactNoteResult"
                 }
               }
             }
@@ -832,7 +840,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealCreateResult"
                 }
               }
             }
@@ -861,7 +869,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Deal"
+                  "$ref": "#/components/schemas/ApiResponse_Deal"
                 }
               }
             }
@@ -893,7 +901,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealUpdateResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealUpdateResult"
                 }
               }
             }
@@ -915,7 +923,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealRemoveResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealRemoveResult"
                 }
               }
             }
@@ -939,7 +947,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExportRequest"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExportRequest"
                 }
               }
             }
@@ -963,7 +971,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExportArray"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExportArray"
                 }
               }
             }
@@ -992,7 +1000,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExport"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExport"
                 }
               }
             }
@@ -1026,7 +1034,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ConsentResult"
+                  "$ref": "#/components/schemas/ApiResponse_ConsentResult"
                 }
               }
             }
@@ -1061,7 +1069,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ConsentRecordArray"
+                  "$ref": "#/components/schemas/ApiResponse_ConsentRecordArray"
                 }
               }
             }
@@ -1119,7 +1127,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WorkspaceArray"
+                  "$ref": "#/components/schemas/ApiResponse_WorkspaceArray"
                 }
               }
             }
@@ -1129,111 +1137,550 @@
           }
         }
       }
-    }
-  },
-  "components": {
-    "securitySchemes": {
-      "bearerAuth": {
-        "type": "http",
-        "scheme": "bearer"
-      }
     },
-    "parameters": {
-      "Id": {
-        "name": "id",
-        "in": "path",
-        "required": true,
-        "schema": {
-          "type": "string"
+    "/api/v1/helpdesk/conversations": {
+      "get": {
+        "tags": [
+          "Helpdesk"
+        ],
+        "operationId": "listHelpdeskConversations",
+        "summary": "List helpdesk conversations",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 100
+            }
+          },
+          {
+            "$ref": "#/components/parameters/Cursor"
+          },
+          {
+            "name": "status",
+            "in": "query",
+            "schema": {
+              "$ref": "#/components/schemas/HelpdeskConversationStatus"
+            }
+          },
+          {
+            "name": "assignee_user_id",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Only conversations assigned to this user."
+          },
+          {
+            "name": "requester",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Match against visitor name/email."
+          },
+          {
+            "name": "query",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Free-text search query."
+          },
+          {
+            "name": "channels",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Comma-separated channel types (e.g. `widget,whatsapp`)."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Conversations page.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaginatedResponse_HelpdeskConversation"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
         }
-      },
-      "Slug": {
-        "name": "slug",
-        "in": "path",
-        "required": true,
-        "schema": {
-          "type": "string"
+      }
+    },
+    "/api/v1/helpdesk/conversations/{id}": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
         }
-      },
-      "Cursor": {
-        "name": "cursor",
-        "in": "query",
-        "schema": {
-          "type": "string"
+      ],
+      "get": {
+        "tags": [
+          "Helpdesk"
+        ],
+        "operationId": "getHelpdeskConversation",
+        "summary": "Get a helpdesk conversation",
+        "responses": {
+          "200": {
+            "description": "Conversation.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskConversation"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
         }
       },
-      "Limit": {
-        "name": "limit",
-        "in": "query",
-        "schema": {
-          "type": "integer",
-          "minimum": 1,
-          "maximum": 500
+      "patch": {
+        "tags": [
+          "Helpdesk"
+        ],
+        "operationId": "updateHelpdeskConversation",
+        "summary": "Update a conversation's status or assignee",
+        "description": "Set `status` and/or `assignee_user_id` (`null` unassigns). At least one field is required. Capability-scoped tokens must send `Idempotency-Key` and `X-Capability-Confirmation` headers on this route; API keys with legacy scopes may omit them.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateHelpdeskConversationInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Update result.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskConversationUpdateResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
         }
       }
     },
-    "responses": {
-      "ApiError": {
-        "description": "API error.",
-        "content": {
-          "application/json": {
+    "/api/v1/helpdesk/conversations/{id}/messages": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "get": {
+        "tags": [
+          "Helpdesk"
+        ],
+        "operationId": "listHelpdeskConversationMessages",
+        "summary": "List conversation messages",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
             "schema": {
-              "$ref": "#/components/schemas/ApiError"
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 50
+            }
+          },
+          {
+            "$ref": "#/components/parameters/Cursor"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Messages page.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaginatedResponse_HelpdeskMessage"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Conversation not found.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
             }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
           }
         }
       }
     },
-    "schemas": {
-      "ApiError": {
-        "type": "object",
-        "required": [
-          "error"
+    "/api/v1/helpdesk/replies": {
+      "post": {
+        "tags": [
+          "Helpdesk"
         ],
-        "properties": {
-          "error": {
-            "type": "object",
-            "required": [
-              "code",
-              "message"
-            ],
-            "properties": {
-              "code": {
-                "type": "string"
-              },
-              "message": {
-                "type": "string"
-              },
-              "details": true
+        "operationId": "createHelpdeskReply",
+        "summary": "Send an operator reply or internal note",
+        "description": "Send an `Idempotency-Key` header so retried requests do not create duplicate messages — it is required for capability-scoped tokens (together with `X-Capability-Confirmation`).",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateHelpdeskReplyInput"
+              }
             }
           }
+        },
+        "responses": {
+          "201": {
+            "description": "Created reply reference.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskReplyCreateResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
         }
-      },
-      "Pagination": {
-        "type": "object",
-        "required": [
-          "has_more",
-          "next_cursor"
+      }
+    },
+    "/api/v1/webhooks": {
+      "get": {
+        "tags": [
+          "Webhooks"
         ],
-        "properties": {
-          "has_more": {
-            "type": "boolean"
+        "operationId": "listWebhooks",
+        "summary": "List webhook endpoints",
+        "responses": {
+          "200": {
+            "description": "Webhook endpoints.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpointArray"
+                }
+              }
+            }
           },
-          "next_cursor": {
-            "type": [
-              "string",
-              "null"
-            ]
+          "default": {
+            "$ref": "#/components/responses/ApiError"
           }
         }
       },
-      "Success": {
-        "type": "object",
-        "required": [
-          "success"
+      "post": {
+        "tags": [
+          "Webhooks"
         ],
-        "properties": {
-          "success": {
+        "operationId": "createWebhook",
+        "summary": "Create a webhook endpoint",
+        "description": "The response's `data.secret` contains the signing secret EXACTLY ONCE — it can never be retrieved again, so store it securely immediately. An idempotent replay (same `Idempotency-Key`) returns the existing endpoint WITHOUT `secret`. Deliveries are HTTP POSTs signed with `X-Medal-Signature: sha256=<base64(HMAC-SHA256(\"{timestamp}.{rawBody}\", secret))>` plus `X-Medal-Timestamp`, `X-Medal-Event`, and `X-Medal-Delivery-Id` / `Idempotency-Key` headers.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateWebhookInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Created endpoint, including the one-time `secret`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/webhooks/{id}": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "get": {
+        "tags": [
+          "Webhooks"
+        ],
+        "operationId": "getWebhook",
+        "summary": "Get a webhook endpoint",
+        "responses": {
+          "200": {
+            "description": "Webhook endpoint.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      },
+      "patch": {
+        "tags": [
+          "Webhooks"
+        ],
+        "operationId": "updateWebhook",
+        "summary": "Update a webhook endpoint",
+        "description": "Only provided fields change. Pass `null` for `channels` or `channel_connection_ids` to clear that filter.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateWebhookInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Updated endpoint.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Webhooks"
+        ],
+        "operationId": "deleteWebhook",
+        "summary": "Delete a webhook endpoint",
+        "description": "Permanently deletes the endpoint and stops all outbound deliveries. Capability-scoped tokens must send `Idempotency-Key` and `X-Capability-Confirmation` headers on this route; API keys with legacy scopes may omit them.",
+        "responses": {
+          "200": {
+            "description": "Delete result.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookDeleteResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/webhooks/{id}/deliveries": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "get": {
+        "tags": [
+          "Webhooks"
+        ],
+        "operationId": "listWebhookDeliveries",
+        "summary": "List recent deliveries",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 100
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Recent deliveries, most recent first.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookDeliveryArray"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/webhooks/{id}/test": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "post": {
+        "tags": [
+          "Webhooks"
+        ],
+        "operationId": "testWebhook",
+        "summary": "Queue a test delivery",
+        "description": "Queues a signed `test.ping` delivery to the endpoint.",
+        "responses": {
+          "202": {
+            "description": "Test delivery queued.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_WebhookTestResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer"
+      }
+    },
+    "parameters": {
+      "Id": {
+        "name": "id",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
+      "Slug": {
+        "name": "slug",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
+      "Cursor": {
+        "name": "cursor",
+        "in": "query",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "Limit": {
+        "name": "limit",
+        "in": "query",
+        "schema": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 500
+        }
+      }
+    },
+    "responses": {
+      "ApiError": {
+        "description": "API error.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ApiError"
+            }
+          }
+        }
+      }
+    },
+    "schemas": {
+      "ApiError": {
+        "type": "object",
+        "required": [
+          "error"
+        ],
+        "properties": {
+          "error": {
+            "type": "object",
+            "required": [
+              "code",
+              "message"
+            ],
+            "properties": {
+              "code": {
+                "type": "string"
+              },
+              "message": {
+                "type": "string"
+              },
+              "details": true
+            }
+          }
+        }
+      },
+      "Pagination": {
+        "type": "object",
+        "required": [
+          "has_more",
+          "next_cursor"
+        ],
+        "properties": {
+          "has_more": {
+            "type": "boolean"
+          },
+          "next_cursor": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      },
+      "Success": {
+        "type": "object",
+        "required": [
+          "success"
+        ],
+        "properties": {
+          "success": {
             "type": "boolean"
           }
         }
@@ -1593,6 +2040,17 @@
           },
           "contact_id": {
             "type": "string"
+          },
+          "idempotency_key": {
+            "type": "string"
+          },
+          "copy_to": {
+            "type": "string",
+            "format": "email"
+          },
+          "copy_reply_to": {
+            "type": "string",
+            "format": "email"
           }
         }
       },
@@ -1600,11 +2058,30 @@
         "type": "object",
         "required": [
           "id",
+          "copy_id",
+          "contact_id",
           "status"
         ],
         "properties": {
           "id": {
-            "type": "string"
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Email send id — poll GET /api/v1/emails/{id} with it."
+          },
+          "copy_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Send id of the copy_to copy, or null when no copy was requested."
+          },
+          "contact_id": {
+            "type": [
+              "string",
+              "null"
+            ]
           },
           "status": {
             "type": "string"
@@ -1755,7 +2232,8 @@
           "batch_id",
           "total",
           "queued",
-          "failed"
+          "failed",
+          "results"
         ],
         "properties": {
           "batch_id": {
@@ -1769,6 +2247,49 @@
           },
           "failed": {
             "type": "integer"
+          },
+          "results": {
+            "type": "array",
+            "description": "Per-recipient outcome, in request order.",
+            "items": {
+              "$ref": "#/components/schemas/BatchSendRecipientResult"
+            }
+          }
+        }
+      },
+      "BatchSendRecipientResult": {
+        "type": "object",
+        "required": [
+          "email",
+          "id",
+          "status",
+          "error"
+        ],
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email"
+          },
+          "id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Email send id — poll GET /api/v1/emails/{id} with it. Null when not queued."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "queued",
+              "failed"
+            ]
+          },
+          "error": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Failure reason for recipients that were not queued."
           }
         }
       },
@@ -2825,141 +3346,711 @@
           "consent_type": {
             "$ref": "#/components/schemas/ConsentType"
           },
-          "granted": {
-            "type": "boolean"
+          "granted": {
+            "type": "boolean"
+          },
+          "granted_at": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "format": "date-time"
+          },
+          "revoked_at": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "format": "date-time"
+          },
+          "source": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          }
+        }
+      },
+      "ConsentResult": {
+        "type": "object",
+        "required": [
+          "id"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          }
+        }
+      },
+      "CookieConsentInput": {
+        "type": "object",
+        "required": [
+          "domain",
+          "consentStatus",
+          "consentTimestamp",
+          "cookiePreferences"
+        ],
+        "properties": {
+          "domain": {
+            "type": "string"
+          },
+          "consentStatus": {
+            "type": "string"
+          },
+          "consentTimestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "ipAddress": {
+            "type": "string"
+          },
+          "userAgent": {
+            "type": "string"
+          },
+          "cookiePreferences": {
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CookieCategoryConsent"
+            }
+          }
+        }
+      },
+      "CookieCategoryConsent": {
+        "type": "object",
+        "required": [
+          "allowed"
+        ],
+        "properties": {
+          "allowed": {
+            "type": "boolean"
+          },
+          "cookieRecords": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "cookie",
+                "duration",
+                "description"
+              ],
+              "properties": {
+                "cookie": {
+                  "type": "string"
+                },
+                "duration": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "CookieConsentResult": {
+        "type": "object",
+        "required": [
+          "success"
+        ],
+        "properties": {
+          "success": {
+            "type": "boolean"
+          },
+          "logId": {
+            "type": "string"
+          }
+        }
+      },
+      "Workspace": {
+        "type": "object",
+        "required": [
+          "id",
+          "name",
+          "slug"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "slug": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "HelpdeskConversationStatus": {
+        "type": "string",
+        "enum": [
+          "open",
+          "snoozed",
+          "closed"
+        ]
+      },
+      "HelpdeskMessageAuthorType": {
+        "type": "string",
+        "enum": [
+          "visitor",
+          "operator",
+          "ai",
+          "system"
+        ]
+      },
+      "HelpdeskMessageType": {
+        "type": "string",
+        "enum": [
+          "chat",
+          "email",
+          "note"
+        ],
+        "description": "`note` is operator-internal and never delivered to the customer."
+      },
+      "HelpdeskConversation": {
+        "type": "object",
+        "required": [
+          "id",
+          "channel",
+          "channel_connection_id",
+          "status",
+          "subject",
+          "assignee_user_id",
+          "contact_id",
+          "visitor_name",
+          "visitor_email",
+          "external_conversation_id",
+          "channel_account_id",
+          "message_count",
+          "unread_for_operator",
+          "last_message_at",
+          "last_message_preview",
+          "last_message_author_type",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "channel": {
+            "type": "string",
+            "description": "Channel type, e.g. `widget`, `instagram`, `messenger`, `whatsapp`, `email`."
+          },
+          "channel_connection_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "status": {
+            "$ref": "#/components/schemas/HelpdeskConversationStatus"
+          },
+          "subject": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "assignee_user_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "contact_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "visitor_name": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "visitor_email": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "external_conversation_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "channel_account_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "message_count": {
+            "type": "integer"
+          },
+          "unread_for_operator": {
+            "type": "integer"
+          },
+          "last_message_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          },
+          "last_message_preview": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "last_message_author_type": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/HelpdeskMessageAuthorType"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "created_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          },
+          "updated_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          }
+        }
+      },
+      "HelpdeskMessage": {
+        "type": "object",
+        "required": [
+          "id",
+          "conversation_id",
+          "author_type",
+          "message_type",
+          "author_user_id",
+          "author_name",
+          "body",
+          "created_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "conversation_id": {
+            "type": "string"
+          },
+          "author_type": {
+            "$ref": "#/components/schemas/HelpdeskMessageAuthorType"
+          },
+          "message_type": {
+            "$ref": "#/components/schemas/HelpdeskMessageType"
+          },
+          "author_user_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "author_name": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "body": {
+            "type": "string"
+          },
+          "created_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          }
+        }
+      },
+      "UpdateHelpdeskConversationInput": {
+        "type": "object",
+        "minProperties": 1,
+        "description": "At least one field is required.",
+        "properties": {
+          "status": {
+            "$ref": "#/components/schemas/HelpdeskConversationStatus"
+          },
+          "assignee_user_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "User ID to assign, or `null` to unassign."
+          }
+        }
+      },
+      "HelpdeskConversationUpdateResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "status",
+          "assignee_user_id"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "status": {
+            "$ref": "#/components/schemas/HelpdeskConversationStatus"
+          },
+          "assignee_user_id": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      },
+      "CreateHelpdeskReplyInput": {
+        "type": "object",
+        "required": [
+          "conversation_id",
+          "body"
+        ],
+        "properties": {
+          "conversation_id": {
+            "type": "string"
+          },
+          "body": {
+            "type": "string",
+            "maxLength": 20000
+          },
+          "message_type": {
+            "type": "string",
+            "enum": [
+              "chat",
+              "note"
+            ],
+            "description": "`note` = operator-internal note (not delivered to the customer). Default `chat`."
+          },
+          "author_name": {
+            "type": "string",
+            "description": "Agent display name for bridged replies (shown in widget + inbox)."
+          }
+        }
+      },
+      "HelpdeskReplyCreateResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "conversation_id",
+          "status"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "conversation_id": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "const": "created"
+          }
+        }
+      },
+      "WebhookEndpoint": {
+        "type": "object",
+        "required": [
+          "id",
+          "name",
+          "url",
+          "enabled",
+          "event_types",
+          "channels",
+          "channel_connection_ids",
+          "secret_last4",
+          "consecutive_failures",
+          "last_delivery_at",
+          "last_success_at",
+          "last_error_at",
+          "last_error",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "description": "Destination URL (must be https)."
+          },
+          "enabled": {
+            "type": "boolean"
+          },
+          "event_types": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Subscribed event types. Empty array = all events."
+          },
+          "channels": {
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "type": "string"
+            },
+            "description": "Channel-type filter (e.g. `['widget', 'whatsapp']`), or `null` for all channels."
+          },
+          "channel_connection_ids": {
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "type": "string"
+            },
+            "description": "Channel-connection filter, or `null` for all connections."
+          },
+          "secret_last4": {
+            "type": "string",
+            "description": "Last 4 characters of the signing secret, for identification."
+          },
+          "consecutive_failures": {
+            "type": "integer"
+          },
+          "last_delivery_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds, or `null` if never."
+          },
+          "last_success_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds, or `null` if never."
+          },
+          "last_error_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds, or `null` if never."
+          },
+          "last_error": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "created_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          },
+          "updated_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          },
+          "secret": {
+            "type": "string",
+            "description": "Full signing secret (`whsec_…`) — present ONLY in the create response, exactly once. It can never be retrieved again; store it securely immediately. An idempotent replay of the create request omits it."
+          }
+        }
+      },
+      "CreateWebhookInput": {
+        "type": "object",
+        "required": [
+          "name",
+          "url",
+          "event_types"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "maxLength": 100
+          },
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "description": "Destination URL — must be https."
+          },
+          "event_types": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Event types to subscribe to (e.g. `helpdesk.message_received`). Empty = all."
+          },
+          "channels": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Restrict to these channel types (e.g. `['widget', 'whatsapp']`)."
+          },
+          "channel_connection_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Restrict to these channel connection IDs."
+          }
+        }
+      },
+      "UpdateWebhookInput": {
+        "type": "object",
+        "description": "Only provided fields change.",
+        "properties": {
+          "name": {
+            "type": "string",
+            "maxLength": 100
+          },
+          "url": {
+            "type": "string",
+            "format": "uri"
+          },
+          "event_types": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           },
-          "granted_at": {
+          "channels": {
             "type": [
-              "string",
+              "array",
               "null"
             ],
-            "format": "date-time"
+            "items": {
+              "type": "string"
+            },
+            "description": "New channel-type filter, or `null` to clear the filter."
           },
-          "revoked_at": {
+          "channel_connection_ids": {
             "type": [
-              "string",
+              "array",
               "null"
             ],
-            "format": "date-time"
-          },
-          "source": {
-            "type": "string"
+            "items": {
+              "type": "string"
+            },
+            "description": "New channel-connection filter, or `null` to clear the filter."
           },
-          "version": {
-            "type": "string"
+          "enabled": {
+            "type": "boolean"
           }
         }
       },
-      "ConsentResult": {
+      "WebhookDeleteResult": {
         "type": "object",
         "required": [
-          "id"
+          "id",
+          "status"
         ],
         "properties": {
           "id": {
             "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "const": "deleted"
           }
         }
       },
-      "CookieConsentInput": {
+      "WebhookDelivery": {
         "type": "object",
         "required": [
-          "domain",
-          "consentStatus",
-          "consentTimestamp",
-          "cookiePreferences"
+          "id",
+          "event_type",
+          "status",
+          "attempt_count",
+          "next_attempt_at",
+          "response_status",
+          "duration_ms",
+          "last_error",
+          "delivered_at",
+          "created_at"
         ],
         "properties": {
-          "domain": {
+          "id": {
             "type": "string"
           },
-          "consentStatus": {
+          "event_type": {
             "type": "string"
           },
-          "consentTimestamp": {
+          "status": {
             "type": "string",
-            "format": "date-time"
+            "enum": [
+              "pending",
+              "delivered",
+              "dead_letter"
+            ]
           },
-          "ipAddress": {
-            "type": "string"
+          "attempt_count": {
+            "type": "integer"
           },
-          "userAgent": {
-            "type": "string"
+          "next_attempt_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds of the next retry, or `null`."
           },
-          "cookiePreferences": {
-            "type": "object",
-            "additionalProperties": {
-              "$ref": "#/components/schemas/CookieCategoryConsent"
-            }
-          }
-        }
-      },
-      "CookieCategoryConsent": {
-        "type": "object",
-        "required": [
-          "allowed"
-        ],
-        "properties": {
-          "allowed": {
-            "type": "boolean"
+          "response_status": {
+            "type": [
+              "integer",
+              "null"
+            ]
           },
-          "cookieRecords": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "required": [
-                "cookie",
-                "duration",
-                "description"
-              ],
-              "properties": {
-                "cookie": {
-                  "type": "string"
-                },
-                "duration": {
-                  "type": "string"
-                },
-                "description": {
-                  "type": "string"
-                }
-              }
-            }
-          }
-        }
-      },
-      "CookieConsentResult": {
-        "type": "object",
-        "required": [
-          "success"
-        ],
-        "properties": {
-          "success": {
-            "type": "boolean"
+          "duration_ms": {
+            "type": [
+              "integer",
+              "null"
+            ]
           },
-          "logId": {
-            "type": "string"
+          "last_error": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "delivered_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds, or `null` if not delivered."
+          },
+          "created_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
           }
         }
       },
-      "Workspace": {
+      "WebhookTestResult": {
         "type": "object",
         "required": [
-          "id",
-          "name",
-          "slug"
+          "delivery_id",
+          "status"
         ],
         "properties": {
-          "id": {
+          "delivery_id": {
             "type": "string"
           },
-          "name": {
-            "type": "string"
-          },
-          "slug": {
-            "type": "string"
+          "status": {
+            "type": "string",
+            "const": "queued"
           }
-        },
-        "additionalProperties": true
+        }
       },
       "ApiResponse_PostCreateResult": {
         "$ref": "#/components/schemas/Envelope_PostCreateResult"
@@ -3042,6 +4133,30 @@
       "ApiResponse_WorkspaceArray": {
         "$ref": "#/components/schemas/Envelope_WorkspaceArray"
       },
+      "ApiResponse_HelpdeskConversation": {
+        "$ref": "#/components/schemas/Envelope_HelpdeskConversation"
+      },
+      "ApiResponse_HelpdeskConversationUpdateResult": {
+        "$ref": "#/components/schemas/Envelope_HelpdeskConversationUpdateResult"
+      },
+      "ApiResponse_HelpdeskReplyCreateResult": {
+        "$ref": "#/components/schemas/Envelope_HelpdeskReplyCreateResult"
+      },
+      "ApiResponse_WebhookEndpoint": {
+        "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
+      },
+      "ApiResponse_WebhookEndpointArray": {
+        "$ref": "#/components/schemas/Envelope_WebhookEndpointArray"
+      },
+      "ApiResponse_WebhookDeleteResult": {
+        "$ref": "#/components/schemas/Envelope_WebhookDeleteResult"
+      },
+      "ApiResponse_WebhookDeliveryArray": {
+        "$ref": "#/components/schemas/Envelope_WebhookDeliveryArray"
+      },
+      "ApiResponse_WebhookTestResult": {
+        "$ref": "#/components/schemas/Envelope_WebhookTestResult"
+      },
       "PaginatedResponse_Post": {
         "type": "object",
         "required": [
@@ -3114,6 +4229,42 @@
           }
         }
       },
+      "PaginatedResponse_HelpdeskConversation": {
+        "type": "object",
+        "required": [
+          "data",
+          "pagination"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/HelpdeskConversation"
+            }
+          },
+          "pagination": {
+            "$ref": "#/components/schemas/Pagination"
+          }
+        }
+      },
+      "PaginatedResponse_HelpdeskMessage": {
+        "type": "object",
+        "required": [
+          "data",
+          "pagination"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/HelpdeskMessage"
+            }
+          },
+          "pagination": {
+            "$ref": "#/components/schemas/Pagination"
+          }
+        }
+      },
       "Envelope_PostCreateResult": {
         "type": "object",
         "required": [
@@ -3425,6 +4576,100 @@
             }
           }
         }
+      },
+      "Envelope_HelpdeskConversation": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/HelpdeskConversation"
+          }
+        }
+      },
+      "Envelope_HelpdeskConversationUpdateResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/HelpdeskConversationUpdateResult"
+          }
+        }
+      },
+      "Envelope_HelpdeskReplyCreateResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/HelpdeskReplyCreateResult"
+          }
+        }
+      },
+      "Envelope_WebhookEndpoint": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/WebhookEndpoint"
+          }
+        }
+      },
+      "Envelope_WebhookEndpointArray": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/WebhookEndpoint"
+            }
+          }
+        }
+      },
+      "Envelope_WebhookDeleteResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/WebhookDeleteResult"
+          }
+        }
+      },
+      "Envelope_WebhookDeliveryArray": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/WebhookDelivery"
+            }
+          }
+        }
+      },
+      "Envelope_WebhookTestResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/WebhookTestResult"
+          }
+        }
       }
     }
   }