@workwae/sdk 0.1.0-alpha.1 → 0.1.0-alpha.3

package/contract/webhooks/routes.d.ts

@@ -27,6 +27,7 @@ export declare const webhooks: {
                     "send.retrying": "send.retrying";
                     "send.failed": "send.failed";
                     "send.rescheduled": "send.rescheduled";
+                    "send.cancelled": "send.cancelled";
                     "suppression.created": "suppression.created";
                     "calendar.initialized": "calendar.initialized";
                     "calendar.created": "calendar.created";
@@ -43,6 +44,8 @@ export declare const webhooks: {
                     "export.failed": "export.failed";
                     "meeting_connection.connected": "meeting_connection.connected";
                     "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                    "booking.created": "booking.created";
+                    "booking.cancelled": "booking.cancelled";
                     "webhook.test": "webhook.test";
                 }>>;
                 accountIds: z.ZodArray<z.ZodUUID>;
@@ -50,13 +53,13 @@ export declare const webhooks: {
                     mailboxIds: z.ZodArray<z.ZodUUID>;
                     mailboxRoles: z.ZodArray<z.ZodEnum<{
                         custom: "custom";
+                        all: "all";
                         inbox: "inbox";
                         sent: "sent";
                         drafts: "drafts";
                         trash: "trash";
                         junk: "junk";
                         archive: "archive";
-                        all: "all";
                         important: "important";
                     }>>;
                     from: z.ZodArray<z.ZodString>;
@@ -83,6 +86,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -117,6 +122,7 @@ export declare const webhooks: {
                 "send.retrying": "send.retrying";
                 "send.failed": "send.failed";
                 "send.rescheduled": "send.rescheduled";
+                "send.cancelled": "send.cancelled";
                 "suppression.created": "suppression.created";
                 "calendar.initialized": "calendar.initialized";
                 "calendar.created": "calendar.created";
@@ -133,6 +139,8 @@ export declare const webhooks: {
                 "export.failed": "export.failed";
                 "meeting_connection.connected": "meeting_connection.connected";
                 "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                "booking.created": "booking.created";
+                "booking.cancelled": "booking.cancelled";
                 "webhook.test": "webhook.test";
             }>>>;
             accountIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
@@ -140,13 +148,13 @@ export declare const webhooks: {
                 mailboxIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
                 mailboxRoles: z.ZodOptional<z.ZodArray<z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>>>;
                 from: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -186,6 +194,7 @@ export declare const webhooks: {
                     "send.retrying": "send.retrying";
                     "send.failed": "send.failed";
                     "send.rescheduled": "send.rescheduled";
+                    "send.cancelled": "send.cancelled";
                     "suppression.created": "suppression.created";
                     "calendar.initialized": "calendar.initialized";
                     "calendar.created": "calendar.created";
@@ -202,6 +211,8 @@ export declare const webhooks: {
                     "export.failed": "export.failed";
                     "meeting_connection.connected": "meeting_connection.connected";
                     "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                    "booking.created": "booking.created";
+                    "booking.cancelled": "booking.cancelled";
                     "webhook.test": "webhook.test";
                 }>>;
                 accountIds: z.ZodArray<z.ZodUUID>;
@@ -209,13 +220,13 @@ export declare const webhooks: {
                     mailboxIds: z.ZodArray<z.ZodUUID>;
                     mailboxRoles: z.ZodArray<z.ZodEnum<{
                         custom: "custom";
+                        all: "all";
                         inbox: "inbox";
                         sent: "sent";
                         drafts: "drafts";
                         trash: "trash";
                         junk: "junk";
                         archive: "archive";
-                        all: "all";
                         important: "important";
                     }>>;
                     from: z.ZodArray<z.ZodString>;
@@ -243,6 +254,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -252,10 +265,7 @@ export declare const webhooks: {
         readonly idempotency_key_reused: "POST only: the Idempotency-Key was used in the last 24 hours with another method, path or body.";
         readonly idempotency_key_in_progress: "POST only: the request first sent with this Idempotency-Key has not been answered yet.";
     }>>, {
-        plan_limit_webhooks: {
-            status: 403;
-            message: string;
-        };
+        plan_limit_webhooks: import("../errors.js").DeclaredError<"plan_limit_webhooks">;
         unknown_account: import("../errors.js").DeclaredError<"unknown_account">;
         unknown_mailbox: import("../errors.js").DeclaredError<"unknown_mailbox">;
         mailbox_outside_accounts: {
@@ -293,6 +303,7 @@ export declare const webhooks: {
                 "send.retrying": "send.retrying";
                 "send.failed": "send.failed";
                 "send.rescheduled": "send.rescheduled";
+                "send.cancelled": "send.cancelled";
                 "suppression.created": "suppression.created";
                 "calendar.initialized": "calendar.initialized";
                 "calendar.created": "calendar.created";
@@ -309,6 +320,8 @@ export declare const webhooks: {
                 "export.failed": "export.failed";
                 "meeting_connection.connected": "meeting_connection.connected";
                 "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                "booking.created": "booking.created";
+                "booking.cancelled": "booking.cancelled";
                 "webhook.test": "webhook.test";
             }>>>;
             accountIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
@@ -316,13 +329,13 @@ export declare const webhooks: {
                 mailboxIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
                 mailboxRoles: z.ZodOptional<z.ZodArray<z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>>>;
                 from: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -362,6 +375,7 @@ export declare const webhooks: {
                 "send.retrying": "send.retrying";
                 "send.failed": "send.failed";
                 "send.rescheduled": "send.rescheduled";
+                "send.cancelled": "send.cancelled";
                 "suppression.created": "suppression.created";
                 "calendar.initialized": "calendar.initialized";
                 "calendar.created": "calendar.created";
@@ -378,6 +392,8 @@ export declare const webhooks: {
                 "export.failed": "export.failed";
                 "meeting_connection.connected": "meeting_connection.connected";
                 "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                "booking.created": "booking.created";
+                "booking.cancelled": "booking.cancelled";
                 "webhook.test": "webhook.test";
             }>>;
             accountIds: z.ZodArray<z.ZodUUID>;
@@ -385,13 +401,13 @@ export declare const webhooks: {
                 mailboxIds: z.ZodArray<z.ZodUUID>;
                 mailboxRoles: z.ZodArray<z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>>;
                 from: z.ZodArray<z.ZodString>;
@@ -417,6 +433,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -450,6 +468,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -474,6 +494,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -507,6 +529,7 @@ export declare const webhooks: {
             "send.retrying": "send.retrying";
             "send.failed": "send.failed";
             "send.rescheduled": "send.rescheduled";
+            "send.cancelled": "send.cancelled";
             "suppression.created": "suppression.created";
             "calendar.initialized": "calendar.initialized";
             "calendar.created": "calendar.created";
@@ -523,6 +546,8 @@ export declare const webhooks: {
             "export.failed": "export.failed";
             "meeting_connection.connected": "meeting_connection.connected";
             "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+            "booking.created": "booking.created";
+            "booking.cancelled": "booking.cancelled";
             "webhook.test": "webhook.test";
         }>>;
         accountId: z.ZodOptional<z.ZodUUID>;
@@ -537,6 +562,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -581,6 +608,7 @@ export declare const webhooks: {
             "send.retrying": "send.retrying";
             "send.failed": "send.failed";
             "send.rescheduled": "send.rescheduled";
+            "send.cancelled": "send.cancelled";
             "suppression.created": "suppression.created";
             "calendar.initialized": "calendar.initialized";
             "calendar.created": "calendar.created";
@@ -597,6 +625,8 @@ export declare const webhooks: {
             "export.failed": "export.failed";
             "meeting_connection.connected": "meeting_connection.connected";
             "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+            "booking.created": "booking.created";
+            "booking.cancelled": "booking.cancelled";
             "webhook.test": "webhook.test";
         }>>;
         eventId: z.ZodOptional<z.ZodString>;
@@ -632,6 +662,7 @@ export declare const webhooks: {
                 "send.retrying": "send.retrying";
                 "send.failed": "send.failed";
                 "send.rescheduled": "send.rescheduled";
+                "send.cancelled": "send.cancelled";
                 "suppression.created": "suppression.created";
                 "calendar.initialized": "calendar.initialized";
                 "calendar.created": "calendar.created";
@@ -648,6 +679,8 @@ export declare const webhooks: {
                 "export.failed": "export.failed";
                 "meeting_connection.connected": "meeting_connection.connected";
                 "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+                "booking.created": "booking.created";
+                "booking.cancelled": "booking.cancelled";
                 "webhook.test": "webhook.test";
             }>;
             accountId: z.ZodNullable<z.ZodUUID>;
@@ -668,6 +701,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -704,6 +739,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -743,6 +780,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -778,6 +817,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";
@@ -810,6 +851,8 @@ export declare const webhooks: {
         readonly missing_scope: "The API key lacks the scope the operation needs.";
         readonly role_forbidden: "The member's role does not allow the operation.";
         readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
+        readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
         readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
         readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
         readonly overloaded: "The API is shedding load; retry after Retry-After.";

package/contract/webhooks/signing.d.ts

@@ -1,35 +1,19 @@
-/** Allowed clock skew between the platform and a receiver, per the specification. */
 export declare const WEBHOOK_TOLERANCE_SECONDS = 300;
-/** A fetch `Headers`, or a plain record such as Node's `req.headers` (any key case). */
 export type WebhookHeaders = Headers | Record<string, string | string[] | undefined>;
 export interface VerifyWebhookOptions {
-    /** Default WEBHOOK_TOLERANCE_SECONDS. */
     toleranceSeconds?: number;
-    /** The receiver's clock; default the current time. */
     now?: Date;
 }
-/** Why a delivery was refused: payload is a signed body that is not an event. */
 export type WebhookVerificationFailure = "missing_headers" | "timestamp" | "signature" | "payload";
-/** What each failure says, as WebhookVerificationError's message. */
 export declare const WEBHOOK_VERIFICATION_MESSAGES: Record<WebhookVerificationFailure, string>;
 export declare class WebhookVerificationError extends Error {
     readonly failure: WebhookVerificationFailure;
     constructor(failure: WebhookVerificationFailure, message?: string);
 }
-/** The webhook-signature header value for a delivery: `v1,<base64 HMAC>`. */
 export declare function signWebhook(secret: string, msg: {
     id: string;
     timestamp: number;
     body: string;
 }): Promise<string>;
-/**
- * Why the delivery's signature does not verify, or null when it does: it is signed with `secret`
- * and its timestamp is within the tolerance. Pass the raw request body exactly as received:
- * re-serialized JSON does not verify. The body itself is not looked at.
- */
 export declare function checkWebhookSignature(secret: string, headers: WebhookHeaders, body: string | Uint8Array | ArrayBuffer, options?: VerifyWebhookOptions): Promise<Exclude<WebhookVerificationFailure, "payload"> | null>;
-/**
- * True when the delivery is signed with `secret` and its timestamp is within the tolerance.
- * Pass the raw request body exactly as received: re-serialized JSON does not verify.
- */
 export declare function verifyWebhook(secret: string, headers: WebhookHeaders, body: string | Uint8Array | ArrayBuffer, options?: VerifyWebhookOptions): Promise<boolean>;