@dalmore/api-contracts 0.0.0-dev.c751882 → 0.0.0-dev.c81baa3

package/common/types/zapier.types.d.ts

@@ -0,0 +1,126 @@
+import { z } from 'zod';
+/**
+ * Source of the event - determines how the trigger fires
+ * - 'api': Event fired by ClientApiWebhookInterceptor when API is called
+ * - 'external': Event fired by external webhook (Persona, Stripe, etc.)
+ * - 'both': Can be triggered by API call OR external webhook
+ */
+export type TriggerSource = 'api' | 'external' | 'both';
+/**
+ * Defines a Zapier trigger (event that can be subscribed to)
+ */
+export interface ZapierTriggerType {
+    eventType: string;
+    displayName: string;
+    description: string;
+    source: TriggerSource;
+}
+/**
+ * Available trigger types for Zapier.
+ */
+export declare const ZAPIER_TRIGGER_TYPES: ZapierTriggerType[];
+/**
+ * Defines a Zapier action (API endpoint that can be called)
+ */
+export interface ZapierActionType {
+    key: string;
+    displayName: string;
+    description: string;
+    method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+    endpoint: string;
+    noun: string;
+}
+/**
+ * Available actions for Zapier.
+ * Maps directly to existing Client portal endpoints.
+ */
+export declare const ZAPIER_ACTION_TYPES: ZapierActionType[];
+export declare const ZapierTriggerTypeZod: z.ZodObject<{
+    eventType: z.ZodString;
+    displayName: z.ZodString;
+    description: z.ZodString;
+    source: z.ZodEnum<["api", "external", "both"]>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    source: "api" | "external" | "both";
+    eventType: string;
+    displayName: string;
+}, {
+    description: string;
+    source: "api" | "external" | "both";
+    eventType: string;
+    displayName: string;
+}>;
+export declare const ZapierActionTypeZod: z.ZodObject<{
+    key: z.ZodString;
+    displayName: z.ZodString;
+    description: z.ZodString;
+    method: z.ZodEnum<["GET", "POST", "PATCH", "PUT", "DELETE"]>;
+    endpoint: z.ZodString;
+    noun: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    description: string;
+    endpoint: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    displayName: string;
+    noun: string;
+}, {
+    key: string;
+    description: string;
+    endpoint: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    displayName: string;
+    noun: string;
+}>;
+export declare const WebhookSubscriptionZod: z.ZodObject<{
+    id: z.ZodString;
+    targetUrl: z.ZodString;
+    eventTypes: z.ZodArray<z.ZodString, "many">;
+    name: z.ZodNullable<z.ZodString>;
+    enabled: z.ZodBoolean;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string | null;
+    enabled: boolean;
+    targetUrl: string;
+    eventTypes: string[];
+}, {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string | null;
+    enabled: boolean;
+    targetUrl: string;
+    eventTypes: string[];
+}>;
+export type WebhookSubscriptionZod = z.infer<typeof WebhookSubscriptionZod>;
+export declare const CreateWebhookSubscriptionZod: z.ZodObject<{
+    targetUrl: z.ZodString;
+    eventTypes: z.ZodArray<z.ZodString, "many">;
+    name: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    targetUrl: string;
+    eventTypes: string[];
+    name?: string | undefined;
+}, {
+    targetUrl: string;
+    eventTypes: string[];
+    name?: string | undefined;
+}>;
+export type CreateWebhookSubscriptionZod = z.infer<typeof CreateWebhookSubscriptionZod>;
+export declare const WebhookSubscriptionResponseZod: z.ZodObject<{
+    id: z.ZodString;
+    hook0SubscriptionId: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    hook0SubscriptionId: string | null;
+}, {
+    id: string;
+    hook0SubscriptionId: string | null;
+}>;
+export type WebhookSubscriptionResponseZod = z.infer<typeof WebhookSubscriptionResponseZod>;

package/common/types/zapier.types.js

@@ -0,0 +1,247 @@
+import { z } from 'zod';
+/**
+ * Available trigger types for Zapier.
+ */
+export const ZAPIER_TRIGGER_TYPES = [
+    // === API-sourced triggers (from Client portal calls) ===
+    {
+        eventType: 'client.trades.create',
+        displayName: 'Trade Created',
+        description: 'Triggers when a new trade/investment is placed',
+        source: 'api',
+    },
+    {
+        eventType: 'client.trades.update',
+        displayName: 'Trade Updated',
+        description: 'Triggers when a trade is updated',
+        source: 'api',
+    },
+    {
+        eventType: 'client.investor_accounts.create',
+        displayName: 'Investor Created',
+        description: 'Triggers when a new investor account is created',
+        source: 'api',
+    },
+    {
+        eventType: 'client.investor_accounts.update',
+        displayName: 'Investor Updated',
+        description: 'Triggers when an investor account is updated',
+        source: 'api',
+    },
+    {
+        eventType: 'client.offerings.create',
+        displayName: 'Offering Created',
+        description: 'Triggers when a new offering is created',
+        source: 'api',
+    },
+    {
+        eventType: 'client.offerings.update',
+        displayName: 'Offering Updated',
+        description: 'Triggers when an offering is updated',
+        source: 'api',
+    },
+    // === Users (common for email marketing integrations) ===
+    {
+        eventType: 'client.users.create',
+        displayName: 'User Signed Up',
+        description: 'Triggers when a new user signs up (ideal for adding to email marketing lists)',
+        source: 'api',
+    },
+    {
+        eventType: 'client.users.update',
+        displayName: 'User Updated',
+        description: 'Triggers when a user profile is updated',
+        source: 'api',
+    },
+    // === External-sourced triggers (from third-party webhooks) ===
+    {
+        eventType: 'client.kycs.approved',
+        displayName: 'KYC Approved',
+        description: 'Triggers when KYC verification is approved (via Persona)',
+        source: 'external',
+    },
+    {
+        eventType: 'client.kycs.rejected',
+        displayName: 'KYC Rejected',
+        description: 'Triggers when KYC verification is rejected (via Persona)',
+        source: 'external',
+    },
+    {
+        eventType: 'client.amls.approved',
+        displayName: 'AML Approved',
+        description: 'Triggers when AML screening is approved (via ComplyAdvantage)',
+        source: 'external',
+    },
+    {
+        eventType: 'client.amls.rejected',
+        displayName: 'AML Rejected',
+        description: 'Triggers when AML screening is rejected (via ComplyAdvantage)',
+        source: 'external',
+    },
+    {
+        eventType: 'client.transactions.completed',
+        displayName: 'Transaction Completed',
+        description: 'Triggers when a payment transaction is completed (via Stripe)',
+        source: 'external',
+    },
+    {
+        eventType: 'client.transactions.failed',
+        displayName: 'Transaction Failed',
+        description: 'Triggers when a payment transaction fails (via Stripe)',
+        source: 'external',
+    },
+    // === Both API and external triggers ===
+    {
+        eventType: 'client.trades.approved',
+        displayName: 'Trade Approved',
+        description: 'Triggers when a trade is approved (manual or automatic)',
+        source: 'both',
+    },
+    {
+        eventType: 'client.trades.rejected',
+        displayName: 'Trade Rejected',
+        description: 'Triggers when a trade is rejected (manual or automatic)',
+        source: 'both',
+    },
+];
+/**
+ * Available actions for Zapier.
+ * Maps directly to existing Client portal endpoints.
+ */
+export const ZAPIER_ACTION_TYPES = [
+    // === Trades ===
+    {
+        key: 'create_trade',
+        displayName: 'Create Trade',
+        description: 'Create a new trade/investment',
+        method: 'POST',
+        endpoint: '/clients/api/v1/trades',
+        noun: 'Trade',
+    },
+    {
+        key: 'update_trade',
+        displayName: 'Update Trade',
+        description: 'Update an existing trade',
+        method: 'PATCH',
+        endpoint: '/clients/api/v1/trades/:id',
+        noun: 'Trade',
+    },
+    {
+        key: 'get_trade',
+        displayName: 'Find Trade',
+        description: 'Find a trade by ID',
+        method: 'GET',
+        endpoint: '/clients/api/v1/trades/:id',
+        noun: 'Trade',
+    },
+    {
+        key: 'search_trades',
+        displayName: 'Search Trades',
+        description: 'Search for trades with filters',
+        method: 'GET',
+        endpoint: '/clients/api/v1/trades',
+        noun: 'Trade',
+    },
+    // === Investor Accounts ===
+    {
+        key: 'create_investor',
+        displayName: 'Create Investor',
+        description: 'Create a new investor account',
+        method: 'POST',
+        endpoint: '/clients/api/v1/investor-accounts',
+        noun: 'Investor',
+    },
+    {
+        key: 'update_investor',
+        displayName: 'Update Investor',
+        description: 'Update an investor account',
+        method: 'PATCH',
+        endpoint: '/clients/api/v1/investor-accounts/:id',
+        noun: 'Investor',
+    },
+    {
+        key: 'get_investor',
+        displayName: 'Find Investor',
+        description: 'Find an investor by ID',
+        method: 'GET',
+        endpoint: '/clients/api/v1/investor-accounts/:id',
+        noun: 'Investor',
+    },
+    {
+        key: 'search_investors',
+        displayName: 'Search Investors',
+        description: 'Search for investors with filters',
+        method: 'GET',
+        endpoint: '/clients/api/v1/investor-accounts',
+        noun: 'Investor',
+    },
+    // === Offerings ===
+    {
+        key: 'get_offering',
+        displayName: 'Find Offering',
+        description: 'Find an offering by ID',
+        method: 'GET',
+        endpoint: '/clients/api/v1/offerings/:id',
+        noun: 'Offering',
+    },
+    {
+        key: 'list_offerings',
+        displayName: 'List Offerings',
+        description: 'List all offerings',
+        method: 'GET',
+        endpoint: '/clients/api/v1/offerings',
+        noun: 'Offering',
+    },
+    // === KYC ===
+    {
+        key: 'create_kyc',
+        displayName: 'Start KYC',
+        description: 'Initiate KYC verification for an investor',
+        method: 'POST',
+        endpoint: '/clients/api/v1/kycs',
+        noun: 'KYC',
+    },
+    {
+        key: 'get_kyc',
+        displayName: 'Find KYC',
+        description: 'Find KYC status by ID',
+        method: 'GET',
+        endpoint: '/clients/api/v1/kycs/:id',
+        noun: 'KYC',
+    },
+];
+// Zod schemas for API responses
+export const ZapierTriggerTypeZod = z.object({
+    eventType: z.string(),
+    displayName: z.string(),
+    description: z.string(),
+    source: z.enum(['api', 'external', 'both']),
+});
+export const ZapierActionTypeZod = z.object({
+    key: z.string(),
+    displayName: z.string(),
+    description: z.string(),
+    method: z.enum(['GET', 'POST', 'PATCH', 'PUT', 'DELETE']),
+    endpoint: z.string(),
+    noun: z.string(),
+});
+// Webhook subscription schemas
+export const WebhookSubscriptionZod = z.object({
+    id: z.string(),
+    targetUrl: z.string().url(),
+    eventTypes: z.array(z.string()),
+    name: z.string().nullable(),
+    enabled: z.boolean(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+});
+export const CreateWebhookSubscriptionZod = z.object({
+    targetUrl: z.string().url(),
+    eventTypes: z.array(z.string()).min(1),
+    name: z.string().optional(),
+});
+export const WebhookSubscriptionResponseZod = z.object({
+    id: z.string(),
+    hook0SubscriptionId: z.string().nullable(),
+});
+//# sourceMappingURL=zapier.types.js.map

package/common/types/zapier.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zapier.types.js","sourceRoot":"","sources":["zapier.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAoBxB;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAwB;IACvD,0DAA0D;IAC1D;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,gDAAgD;QAC7D,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,kCAAkC;QAC/C,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,iCAAiC;QAC5C,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,iDAAiD;QAC9D,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,iCAAiC;QAC5C,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,8CAA8C;QAC3D,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,yBAAyB;QACpC,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,yCAAyC;QACtD,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,yBAAyB;QACpC,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,sCAAsC;QACnD,MAAM,EAAE,KAAK;KACd;IAED,0DAA0D;IAC1D;QACE,SAAS,EAAE,qBAAqB;QAChC,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EACT,+EAA+E;QACjF,MAAM,EAAE,KAAK;KACd;IACD;QACE,SAAS,EAAE,qBAAqB;QAChC,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,yCAAyC;QACtD,MAAM,EAAE,KAAK;KACd;IAED,gEAAgE;IAChE;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,0DAA0D;QACvE,MAAM,EAAE,UAAU;KACnB;IACD;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,0DAA0D;QACvE,MAAM,EAAE,UAAU;KACnB;IACD;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,cAAc;QAC3B,WAAW,EACT,+DAA+D;QACjE,MAAM,EAAE,UAAU;KACnB;IACD;QACE,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,cAAc;QAC3B,WAAW,EACT,+DAA+D;QACjE,MAAM,EAAE,UAAU;KACnB;IACD;QACE,SAAS,EAAE,+BAA+B;QAC1C,WAAW,EAAE,uBAAuB;QACpC,WAAW,EACT,+DAA+D;QACjE,MAAM,EAAE,UAAU;KACnB;IACD;QACE,SAAS,EAAE,4BAA4B;QACvC,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,wDAAwD;QACrE,MAAM,EAAE,UAAU;KACnB;IAED,yCAAyC;IACzC;QACE,SAAS,EAAE,wBAAwB;QACnC,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,yDAAyD;QACtE,MAAM,EAAE,MAAM;KACf;IACD;QACE,SAAS,EAAE,wBAAwB;QACnC,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,yDAAyD;QACtE,MAAM,EAAE,MAAM;KACf;CACF,CAAC;AAcF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAuB;IACrD,iBAAiB;IACjB;QACE,GAAG,EAAE,cAAc;QACnB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,+BAA+B;QAC5C,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,wBAAwB;QAClC,IAAI,EAAE,OAAO;KACd;IACD;QACE,GAAG,EAAE,cAAc;QACnB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,0BAA0B;QACvC,MAAM,EAAE,OAAO;QACf,QAAQ,EAAE,4BAA4B;QACtC,IAAI,EAAE,OAAO;KACd;IACD;QACE,GAAG,EAAE,WAAW;QAChB,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,oBAAoB;QACjC,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,4BAA4B;QACtC,IAAI,EAAE,OAAO;KACd;IACD;QACE,GAAG,EAAE,eAAe;QACpB,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,gCAAgC;QAC7C,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,wBAAwB;QAClC,IAAI,EAAE,OAAO;KACd;IAED,4BAA4B;IAC5B;QACE,GAAG,EAAE,iBAAiB;QACtB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,+BAA+B;QAC5C,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,UAAU;KACjB;IACD;QACE,GAAG,EAAE,iBAAiB;QACtB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,4BAA4B;QACzC,MAAM,EAAE,OAAO;QACf,QAAQ,EAAE,uCAAuC;QACjD,IAAI,EAAE,UAAU;KACjB;IACD;QACE,GAAG,EAAE,cAAc;QACnB,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,wBAAwB;QACrC,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,uCAAuC;QACjD,IAAI,EAAE,UAAU;KACjB;IACD;QACE,GAAG,EAAE,kBAAkB;QACvB,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,mCAAmC;QAChD,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,UAAU;KACjB;IAED,oBAAoB;IACpB;QACE,GAAG,EAAE,cAAc;QACnB,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,wBAAwB;QACrC,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,UAAU;KACjB;IACD;QACE,GAAG,EAAE,gBAAgB;QACrB,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,oBAAoB;QACjC,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,UAAU;KACjB;IAED,cAAc;IACd;QACE,GAAG,EAAE,YAAY;QACjB,WAAW,EAAE,WAAW;QACxB,WAAW,EAAE,2CAA2C;QACxD,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,KAAK;KACZ;IACD;QACE,GAAG,EAAE,SAAS;QACd,WAAW,EAAE,UAAU;QACvB,WAAW,EAAE,uBAAuB;QACpC,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,0BAA0B;QACpC,IAAI,EAAE,KAAK;KACZ;CACF,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACzD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,+BAA+B;AAC/B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC"}

package/contracts/clients/cart/index.d.ts

@@ -87,10 +87,13 @@ export declare const cartContract: {
         responses: {
             200: z.ZodObject<{
                 tradeStatus: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").TradeStatus>>;
+                tradeId: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 tradeStatus?: import("../../..").TradeStatus | undefined;
+                tradeId?: string | undefined;
             }, {
                 tradeStatus?: import("../../..").TradeStatus | undefined;
+                tradeId?: string | undefined;
             }>;
             400: z.ZodObject<{
                 status: z.ZodNumber;