@dalmore/api-contracts 0.0.0-dev.686830 → 0.0.0-dev.6d952b2

package/contracts/clients/webhooks/index.js

@@ -0,0 +1,118 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { BadRequestError, ForbiddenError, NotFoundError, UnauthorizedError, PaginationOptionsZod, IPaginationMeta, } from '../../../common/types/index.js';
+import { CreateWebhookSubscriptionZod, WebhookSubscriptionResponseZod, WebhookSubscriptionZod, ZapierActionTypeZod, ZapierTriggerTypeZod, } from '../../../common/types/zapier.types.js';
+const c = initContract();
+export const IPaginatedWebhookSubscriptions = z.object({
+    items: z.array(WebhookSubscriptionZod),
+    meta: IPaginationMeta,
+});
+export const webhooksContract = c.router({
+    // Subscribe to events (Zapier REST Hook)
+    subscribe: {
+        summary: 'Subscribe to webhook events',
+        description: 'Creates a new webhook subscription for the specified event types. Used by Zapier REST Hook.',
+        method: 'POST',
+        path: '/subscribe',
+        metadata: {
+            auth: true,
+        },
+        body: CreateWebhookSubscriptionZod,
+        responses: {
+            201: WebhookSubscriptionResponseZod,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    // Unsubscribe (Zapier REST Hook)
+    unsubscribe: {
+        summary: 'Unsubscribe from webhook',
+        description: 'Deletes a webhook subscription by ID. Used by Zapier REST Hook.',
+        method: 'DELETE',
+        path: '/:id',
+        metadata: {
+            auth: true,
+        },
+        pathParams: z.object({
+            id: z.string(),
+        }),
+        body: z.object({}),
+        responses: {
+            204: z.undefined(),
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+        },
+    },
+    // List subscriptions
+    list: {
+        summary: 'List webhook subscriptions',
+        description: 'Returns a paginated list of webhook subscriptions.',
+        method: 'GET',
+        path: '',
+        metadata: {
+            auth: true,
+        },
+        query: PaginationOptionsZod,
+        responses: {
+            200: IPaginatedWebhookSubscriptions,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    // Get available trigger event types
+    triggerTypes: {
+        summary: 'Get available trigger types',
+        description: 'Returns a list of event types that can be subscribed to for triggers.',
+        method: 'GET',
+        path: '/trigger-types',
+        metadata: {
+            auth: true,
+        },
+        responses: {
+            200: z.array(ZapierTriggerTypeZod),
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    // Get available actions (endpoints that can be called)
+    actionTypes: {
+        summary: 'Get available action types',
+        description: 'Returns a list of API endpoints available as Zapier actions.',
+        method: 'GET',
+        path: '/action-types',
+        metadata: {
+            auth: true,
+        },
+        responses: {
+            200: z.array(ZapierActionTypeZod),
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    // Perform List - polling fallback for Zapier
+    performList: {
+        summary: 'Perform list for event type',
+        description: 'Returns recent events for a specific event type. Used as a polling fallback by Zapier.',
+        method: 'GET',
+        path: '/perform/:eventType',
+        metadata: {
+            auth: true,
+        },
+        pathParams: z.object({
+            eventType: z.string(),
+        }),
+        query: z.object({
+            limit: z.coerce.number().optional().default(50),
+        }),
+        responses: {
+            200: z.array(z.record(z.unknown())),
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+}, {
+    pathPrefix: 'webhooks',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/webhooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,eAAe,EACf,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,GAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,4BAA4B,EAC5B,8BAA8B,EAC9B,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IACtC,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CACtC;IACE,yCAAyC;IACzC,SAAS,EAAE;QACT,OAAO,EAAE,6BAA6B;QACtC,WAAW,EACT,6FAA6F;QAC/F,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,4BAA4B;QAClC,SAAS,EAAE;YACT,GAAG,EAAE,8BAA8B;YACnC,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IAED,iCAAiC;IACjC,WAAW,EAAE;QACX,OAAO,EAAE,0BAA0B;QACnC,WAAW,EACT,iEAAiE;QACnE,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;SACf,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAClB,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,SAAS,EAAE;YAClB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;SACnB;KACF;IAED,qBAAqB;IACrB,IAAI,EAAE;QACJ,OAAO,EAAE,4BAA4B;QACrC,WAAW,EAAE,oDAAoD;QACjE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,oBAAoB;QAC3B,SAAS,EAAE;YACT,GAAG,EAAE,8BAA8B;YACnC,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IAED,oCAAoC;IACpC,YAAY,EAAE;QACZ,OAAO,EAAE,6BAA6B;QACtC,WAAW,EACT,uEAAuE;QACzE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;YAClC,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IAED,uDAAuD;IACvD,WAAW,EAAE;QACX,OAAO,EAAE,4BAA4B;QACrC,WAAW,EACT,8DAA8D;QAChE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;YACjC,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IAED,6CAA6C;IAC7C,WAAW,EAAE;QACX,OAAO,EAAE,6BAA6B;QACtC,WAAW,EACT,wFAAwF;QAC1F,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,qBAAqB;QAC3B,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;SACtB,CAAC;QACF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;YACd,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;SAChD,CAAC;QACF,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACnC,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;CACF,EACD;IACE,UAAU,EAAE,UAAU;CACvB,CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "0.0.0-dev.686830",
+  "version": "0.0.0-dev.6d952b2",
   "description": "Type-safe API contracts for Dalmore Client Portal",
   "type": "module",
   "main": "./index.js",