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

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

@@ -59,12 +59,22 @@ export declare enum BaseStatus {
     INACTIVE = "INACTIVE",
     PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
     VOIDED = "VOIDED",
-    JOIN = "JOIN",
+    REFUND_INITIATED = "REFUND_INITIATED",
+    REFUND_COMPLETED = "REFUND_COMPLETED",
+    REFUND_FAILED = "REFUND_FAILED",
+    VOID_INITIATED = "VOID_INITIATED",
+    VOID_COMPLETED = "VOID_COMPLETED",
+    VOID_FAILED = "VOID_FAILED",
     RESTORE = "RESTORE",
+    JOIN = "JOIN",
     ACTIVE = "ACTIVE",
     LOCKED = "LOCKED",
     ENABLED = "ENABLED",
-    DISABLED = "DISABLED"
+    DISABLED = "DISABLED",
+    PROCESSING_VOID = "PROCESSING_VOID",
+    PROCESSING_REFUND = "PROCESSING_REFUND",
+    PAUSED = "PAUSED",
+    CLOSED = "CLOSED"
 }
 export declare const UserWithoutPasswordAccountZod: z.ZodObject<{
     id: z.ZodString;
@@ -118,9 +128,13 @@ export declare enum ManagedByType {
     DALMORE = "DALMORE",
     ISSUER = "ISSUER"
 }
+/**
+ * Unified platform enum used across accounts and trades
+ * Values: DALMORE, IMPORT
+ */
 export declare enum Platform {
     DALMORE = "DALMORE",
-    INTEGRATION = "INTEGRATION"
+    IMPORT = "IMPORT"
 }
 export declare enum HttpMethod {
     GET = "GET",
@@ -151,6 +165,59 @@ export declare enum PaymentMethodType {
     CHECK = "CHECK",
     RETIREMENT = "RETIREMENT"
 }
+export declare const accountSettingIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export type accountSettingIdSchema = z.infer<typeof accountSettingIdSchema>;
+export declare const IAccountSettingZod: z.ZodObject<{
+    __entity: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+} & {
+    id: z.ZodEffects<z.ZodString, string, string>;
+    accountId: z.ZodString;
+    offeringSetup: z.ZodBoolean;
+    investorPortalSetup: z.ZodBoolean;
+    paymentMethodSetup: z.ZodBoolean;
+    accountContactsSetup: z.ZodBoolean;
+    productPrimaries: z.ZodBoolean;
+    productSecondaries: z.ZodBoolean;
+    featureDisbursements: z.ZodBoolean;
+    apiPortal: z.ZodBoolean;
+    investorSiteEnabled: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    accountId: string;
+    offeringSetup: boolean;
+    investorPortalSetup: boolean;
+    paymentMethodSetup: boolean;
+    accountContactsSetup: boolean;
+    productPrimaries: boolean;
+    productSecondaries: boolean;
+    featureDisbursements: boolean;
+    apiPortal: boolean;
+    investorSiteEnabled: boolean;
+    __entity?: string | undefined;
+}, {
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    accountId: string;
+    offeringSetup: boolean;
+    investorPortalSetup: boolean;
+    paymentMethodSetup: boolean;
+    accountContactsSetup: boolean;
+    productPrimaries: boolean;
+    productSecondaries: boolean;
+    featureDisbursements: boolean;
+    apiPortal: boolean;
+    investorSiteEnabled: boolean;
+    __entity?: string | undefined;
+}>;
+export type IAccountSettingZod = z.infer<typeof IAccountSettingZod>;
 export declare const AccountZod: z.ZodObject<{
     id: z.ZodString;
     __entity: z.ZodOptional<z.ZodString>;
@@ -302,6 +369,56 @@ export declare const BaseAuthReq: z.ZodObject<{
     role: z.ZodNativeEnum<typeof UserRole>;
     type: z.ZodNativeEnum<typeof PortalType>;
     roleId: z.ZodString;
+    accountSettings: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodEffects<z.ZodString, string, string>;
+        accountId: z.ZodString;
+        offeringSetup: z.ZodBoolean;
+        investorPortalSetup: z.ZodBoolean;
+        paymentMethodSetup: z.ZodBoolean;
+        accountContactsSetup: z.ZodBoolean;
+        productPrimaries: z.ZodBoolean;
+        productSecondaries: z.ZodBoolean;
+        featureDisbursements: z.ZodBoolean;
+        apiPortal: z.ZodBoolean;
+        investorSiteEnabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     type: PortalType;
     id: string;
@@ -310,6 +427,23 @@ export declare const BaseAuthReq: z.ZodObject<{
     isInactiveAccount: boolean;
     role: UserRole;
     roleId: string;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
 }, {
     type: PortalType;
     id: string;
@@ -318,6 +452,23 @@ export declare const BaseAuthReq: z.ZodObject<{
     isInactiveAccount: boolean;
     role: UserRole;
     roleId: string;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
 }>;
 export declare const AuthUserReq: z.ZodObject<{
     id: z.ZodString;
@@ -327,6 +478,56 @@ export declare const AuthUserReq: z.ZodObject<{
     role: z.ZodNativeEnum<typeof UserRole>;
     type: z.ZodNativeEnum<typeof PortalType>;
     roleId: z.ZodString;
+    accountSettings: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodEffects<z.ZodString, string, string>;
+        accountId: z.ZodString;
+        offeringSetup: z.ZodBoolean;
+        investorPortalSetup: z.ZodBoolean;
+        paymentMethodSetup: z.ZodBoolean;
+        accountContactsSetup: z.ZodBoolean;
+        productPrimaries: z.ZodBoolean;
+        productSecondaries: z.ZodBoolean;
+        featureDisbursements: z.ZodBoolean;
+        apiPortal: z.ZodBoolean;
+        investorSiteEnabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }>>>;
 } & {
     userLoginId: z.ZodString;
     firstName: z.ZodString;
@@ -341,6 +542,7 @@ export declare const AuthUserReq: z.ZodObject<{
     twoFactorMethod: z.ZodOptional<z.ZodNativeEnum<typeof TwoFactorMethod>>;
     managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
     userType: z.ZodOptional<z.ZodNativeEnum<typeof UserType>>;
+    accountStatus: z.ZodLazy<z.ZodNativeEnum<typeof AccountStatus>>;
 }, "strip", z.ZodTypeAny, {
     type: PortalType;
     id: string;
@@ -357,7 +559,25 @@ export declare const AuthUserReq: z.ZodObject<{
     roleId: string;
     userLoginId: string;
     locked: boolean;
+    accountStatus: AccountStatus;
     managedBy?: ManagedByType | undefined;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
     requiresTwoFactorSetup?: boolean | undefined;
     twoFactorEnabled?: boolean | undefined;
     twoFactorMethod?: TwoFactorMethod | undefined;
@@ -378,7 +598,25 @@ export declare const AuthUserReq: z.ZodObject<{
     roleId: string;
     userLoginId: string;
     locked: boolean;
+    accountStatus: AccountStatus;
     managedBy?: ManagedByType | undefined;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
     requiresTwoFactorSetup?: boolean | undefined;
     twoFactorEnabled?: boolean | undefined;
     twoFactorMethod?: TwoFactorMethod | undefined;
@@ -392,6 +630,56 @@ export declare const AuthApiKeyReq: z.ZodObject<{
     role: z.ZodNativeEnum<typeof UserRole>;
     type: z.ZodNativeEnum<typeof PortalType>;
     roleId: z.ZodString;
+    accountSettings: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodEffects<z.ZodString, string, string>;
+        accountId: z.ZodString;
+        offeringSetup: z.ZodBoolean;
+        investorPortalSetup: z.ZodBoolean;
+        paymentMethodSetup: z.ZodBoolean;
+        accountContactsSetup: z.ZodBoolean;
+        productPrimaries: z.ZodBoolean;
+        productSecondaries: z.ZodBoolean;
+        featureDisbursements: z.ZodBoolean;
+        apiPortal: z.ZodBoolean;
+        investorSiteEnabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }, {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    }>>>;
 } & {
     name: z.ZodString;
     description: z.ZodNullable<z.ZodString>;
@@ -407,6 +695,23 @@ export declare const AuthApiKeyReq: z.ZodObject<{
     roleId: string;
     description: string | null;
     lastUsedAt: Date | null;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
 }, {
     type: PortalType;
     id: string;
@@ -418,6 +723,23 @@ export declare const AuthApiKeyReq: z.ZodObject<{
     roleId: string;
     description: string | null;
     lastUsedAt: Date | null;
+    accountSettings?: {
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        offeringSetup: boolean;
+        investorPortalSetup: boolean;
+        paymentMethodSetup: boolean;
+        accountContactsSetup: boolean;
+        productPrimaries: boolean;
+        productSecondaries: boolean;
+        featureDisbursements: boolean;
+        apiPortal: boolean;
+        investorSiteEnabled: boolean;
+        __entity?: string | undefined;
+    } | undefined;
 }>;
 export type BaseAuthReq = z.infer<typeof BaseAuthReq>;
 export type AuthUserReq = z.infer<typeof AuthUserReq>;
@@ -717,7 +1039,8 @@ export declare enum OfferingType {
 }
 export declare enum AssetType {
     BOND = "BOND",
-    STOCK = "STOCK"
+    STOCK = "STOCK",
+    PROMISSORY_NOTE = "PROMISSORY_NOTE"
 }
 export declare enum AdjustmentType {
     CREDIT_CARD_FEES = "CREDIT_CARD_FEES",
@@ -798,7 +1121,8 @@ export declare enum IssuerFileLabels {
 export declare enum OfferingFileLabels {
     MEMORANDUM = "MEMORANDUM",
     SUBSCRIPTION_AGREEMENT = "SUBSCRIPTION_AGREEMENT",
-    COVER_ART = "COVER_ART"
+    COVER_ART = "COVER_ART",
+    ESCROW_AGREEMENT = "ESCROW_AGREEMENT"
 }
 export declare enum SiteBrandingFileLabels {
     LOGO = "LOGO",
@@ -823,7 +1147,9 @@ export declare enum AccreditationFileLabels {
 export declare enum OtherFileLabels {
     OTHER = "OTHER",
     COMPLIANCE_REQUEST = "COMPLIANCE_REQUEST",
-    SUB_DOC = "SUB_DOC"
+    SUB_DOC = "SUB_DOC",
+    CONTENT_FILE = "CONTENT_FILE",
+    CSV_EXPORT_FILE = "CSV_EXPORT_FILE"
 }
 export declare const FileLabels: {
     readonly TRADE_DOCUMENT: TradeFileLables.TRADE_DOCUMENT;
@@ -835,6 +1161,7 @@ export declare const FileLabels: {
     readonly COVER_ART: IssuerFileLabels.COVER_ART;
     readonly MEMORANDUM: OfferingFileLabels.MEMORANDUM;
     readonly SUBSCRIPTION_AGREEMENT: OfferingFileLabels.SUBSCRIPTION_AGREEMENT;
+    readonly ESCROW_AGREEMENT: OfferingFileLabels.ESCROW_AGREEMENT;
     readonly LOGO: SiteBrandingFileLabels.LOGO;
     readonly FAVICON: SiteBrandingFileLabels.FAVICON;
     readonly BACKGROUND_IMAGE: SiteBrandingFileLabels.BACKGROUND_IMAGE;
@@ -842,6 +1169,8 @@ export declare const FileLabels: {
     readonly OTHER: OtherFileLabels.OTHER;
     readonly COMPLIANCE_REQUEST: OtherFileLabels.COMPLIANCE_REQUEST;
     readonly SUB_DOC: OtherFileLabels.SUB_DOC;
+    readonly CONTENT_FILE: OtherFileLabels.CONTENT_FILE;
+    readonly CSV_EXPORT_FILE: OtherFileLabels.CSV_EXPORT_FILE;
     readonly BAD_ACTOR_REPORT_FILE: CoveredPersonFileLabels.BAD_ACTOR_REPORT_FILE;
     readonly PROOF_OF_INCOME: AccreditationFileLabels.PROOF_OF_INCOME;
     readonly PROOF_OF_NET_WORTH: AccreditationFileLabels.PROOF_OF_NET_WORTH;
@@ -975,7 +1304,8 @@ export declare enum EventField {
     ONBOARDING_STATUS = "onboardingStatus",
     TRANSACTION_STATUS = "transactionStatus",
     ACTIVE = "active",
-    LOCKED = "locked"
+    LOCKED = "locked",
+    SOLD_OUT = "soldOut"
 }
 export declare enum EventName {
     STATUS_CHANGED = "status.changed",
@@ -983,7 +1313,9 @@ export declare enum EventName {
     ACTION_PERFORMED = "action.performed",
     PENDING_OVERDUE_TRADES_ALERT = "pending_overdue.trades.alert",
     IN_REVIEW_TRADES_ALERT = "trade.inreview.alert",
-    INDIVIDUAL_AML_STATUS_CHANGED = "individual.aml_status.changed"
+    INDIVIDUAL_AML_STATUS_CHANGED = "individual.aml_status.changed",
+    ISSUER_CREATED = "issuer.created",
+    TRADE_SETTLED = "trade.settled"
 }
 export declare enum TransactionStatus {
     PENDING = "PENDING",
@@ -997,7 +1329,9 @@ export declare enum TransactionStatus {
     AUTHORIZING = "AUTHORIZING",
     FUNDING = "FUNDING",
     PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    VOIDED = "VOIDED"
+    VOIDED = "VOIDED",
+    PROCESSING_VOID = "PROCESSING_VOID",
+    PROCESSING_REFUND = "PROCESSING_REFUND"
 }
 export declare enum TransactionType {
     CHARGE = "CHARGE",
@@ -1156,6 +1490,26 @@ export declare const TargetTableConfig: {
         readonly table: "theme_settings";
         readonly idPrefix: "theme_setting";
     };
+    readonly CAP_TABLES: {
+        readonly table: "cap_tables";
+        readonly idPrefix: "cap_table";
+    };
+    readonly CAP_TABLE_SHARE_CLASSES: {
+        readonly table: "cap_table_share_classes";
+        readonly idPrefix: "cap_table_share_class";
+    };
+    readonly CAP_TABLE_ENTRIES: {
+        readonly table: "cap_table_entries";
+        readonly idPrefix: "cap_table_entry";
+    };
+    readonly EMAIL_THEMES: {
+        readonly table: "email_themes";
+        readonly idPrefix: "email_theme";
+    };
+    readonly EMAIL_THEME_SETTINGS: {
+        readonly table: "email_theme_settings";
+        readonly idPrefix: "email_theme_setting";
+    };
 };
 export type TargetTableType = keyof typeof TargetTableConfig;
 export declare const TargetTableEnum: [TargetTableType, ...TargetTableType[]];
@@ -1492,4 +1846,16 @@ export type StringToBooleanSchema = z.infer<typeof StringToBooleanSchema>;
  * EmailSchema.optional().parse(undefined); // returns undefined
  */
 export declare const EmailSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare enum WarrantSharesCalculationMethod {
+    NONE = "NONE",
+    PRORATA = "PRORATA",
+    INCREMENT = "INCREMENT"
+}
+export declare enum OfferingStatus {
+    ONBOARDING = "ONBOARDING",
+    IN_REVIEW = "IN_REVIEW",
+    ACTIVE = "ACTIVE",
+    PAUSED = "PAUSED",
+    CLOSED = "CLOSED"
+}
 export {};