@dalmore/api-contracts 0.0.0-dev.b823e2b → 0.0.0-dev.bcc2eb2

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

@@ -20,8 +20,8 @@ export declare const offeringsContract: {
             enabled: z.ZodOptional<z.ZodEffects<z.ZodBoolean, boolean, unknown>>;
             managedBy: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").ManagedByType>>;
             versioningType: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").OfferingVersioningType>>;
-            combinedStatus: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").OfferingStatus>>;
             onboardingStatus: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").OfferingOnboardingStatus>>;
+            complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").ComplianceReview>>;
         }, "strip", z.ZodTypeAny, {
             page: number;
             limit: number;
@@ -31,12 +31,12 @@ export declare const offeringsContract: {
             accountId?: string | undefined;
             name?: string | undefined;
             managedBy?: import("../../..").ManagedByType | undefined;
+            complianceReview?: import("../../..").ComplianceReview | undefined;
             onboardingStatus?: import("../../..").OfferingOnboardingStatus | undefined;
             enabled?: boolean | undefined;
             issuerId?: string | undefined;
             issuerName?: string | undefined;
             versioningType?: import("../../..").OfferingVersioningType | undefined;
-            combinedStatus?: import("../../..").OfferingStatus | undefined;
         }, {
             type?: import("../../..").OfferingType | undefined;
             status?: import("../../..").ComplianceReview | undefined;
@@ -45,13 +45,13 @@ export declare const offeringsContract: {
             managedBy?: import("../../..").ManagedByType | undefined;
             page?: number | undefined;
             limit?: number | undefined;
+            complianceReview?: import("../../..").ComplianceReview | undefined;
             onboardingStatus?: import("../../..").OfferingOnboardingStatus | undefined;
             include?: string | undefined;
             enabled?: unknown;
             issuerId?: string | undefined;
             issuerName?: string | undefined;
             versioningType?: import("../../..").OfferingVersioningType | undefined;
-            combinedStatus?: import("../../..").OfferingStatus | undefined;
         }>;
         summary: "Get offerings";
         path: "offerings";
@@ -413,6 +413,7 @@ export declare const offeringsContract: {
             auth: boolean;
         };
         body: z.ZodEffects<z.ZodObject<{
+            shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
             name: z.ZodOptional<z.ZodString>;
             type: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").OfferingType>>;
             targetAmount: z.ZodOptional<z.ZodNumber>;
@@ -422,7 +423,7 @@ export declare const offeringsContract: {
             startAt: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
             endAt: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
             cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            description: z.ZodLazy<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>>;
             memorandumId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
             subscriptionAgreementId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
             coverArtId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
@@ -480,6 +481,13 @@ export declare const offeringsContract: {
                 startAmount: number;
                 endAmount: number;
             }>, "many">>;
+            warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
+            totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+            warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+            calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../..").WarrantSharesCalculationMethod>>>;
+            incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
         }, "strip", z.ZodTypeAny, {
             type?: import("../../..").OfferingType | undefined;
             name?: string | undefined;
@@ -502,6 +510,14 @@ export declare const offeringsContract: {
             escrowAgreementFileId?: string | null | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             assetName?: string | undefined;
             assetType?: import("../../..").AssetType | undefined;
             pricePerUnit?: number | null | undefined;
@@ -540,6 +556,14 @@ export declare const offeringsContract: {
             escrowAgreementFileId?: string | null | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             assetName?: string | undefined;
             assetType?: import("../../..").AssetType | undefined;
             pricePerUnit?: number | null | undefined;
@@ -578,6 +602,14 @@ export declare const offeringsContract: {
             escrowAgreementFileId?: string | null | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             assetName?: string | undefined;
             assetType?: import("../../..").AssetType | undefined;
             pricePerUnit?: number | null | undefined;
@@ -616,6 +648,14 @@ export declare const offeringsContract: {
             escrowAgreementFileId?: string | null | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             assetName?: string | undefined;
             assetType?: import("../../..").AssetType | undefined;
             pricePerUnit?: number | null | undefined;
@@ -718,6 +758,7 @@ export declare const offeringsContract: {
         };
         body: z.ZodEffects<z.ZodObject<{
             issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+            shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
             name: z.ZodString;
             type: z.ZodNativeEnum<typeof import("../../..").OfferingType>;
             targetAmount: z.ZodNumber;
@@ -729,7 +770,7 @@ export declare const offeringsContract: {
             endAt: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
             active: z.ZodOptional<z.ZodBoolean>;
             cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            description: z.ZodLazy<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>, string | null | undefined, string | null | undefined>>;
             managedBy: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").ManagedByType>>;
             assetName: z.ZodString;
             assetType: z.ZodNativeEnum<typeof import("../../..").AssetType>;
@@ -781,12 +822,21 @@ export declare const offeringsContract: {
                 startAmount: number;
                 endAmount: number;
             }>, "many">>;
+            warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+            warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+            calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof import("../../..").WarrantSharesCalculationMethod>>>;
+            incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+            showTotalRaised: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         }, "strip", z.ZodTypeAny, {
             type: import("../../..").OfferingType;
             name: string;
             template: import("../../../common/types/asset.types").AssetTemplateType;
             targetAmount: number;
             issuerId: string;
+            warrantsEnabled: boolean;
             assetName: string;
             assetType: import("../../..").AssetType;
             pricePerUnit: number | null;
@@ -801,9 +851,17 @@ export declare const offeringsContract: {
             startAt?: Date | null | undefined;
             endAt?: Date | null | undefined;
             cancellationPeriod?: number | null | undefined;
+            showTotalRaised?: boolean | undefined;
             hasEscrow?: boolean | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             yield?: number | null | undefined;
             duration?: number | null | undefined;
             durationType?: import("../../..").DurationType | null | undefined;
@@ -836,9 +894,18 @@ export declare const offeringsContract: {
             startAt?: string | null | undefined;
             endAt?: string | null | undefined;
             cancellationPeriod?: number | null | undefined;
+            showTotalRaised?: boolean | undefined;
             hasEscrow?: boolean | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             yield?: number | null | undefined;
             duration?: number | null | undefined;
             durationType?: import("../../..").DurationType | null | undefined;
@@ -857,6 +924,7 @@ export declare const offeringsContract: {
             template: import("../../../common/types/asset.types").AssetTemplateType;
             targetAmount: number;
             issuerId: string;
+            warrantsEnabled: boolean;
             assetName: string;
             assetType: import("../../..").AssetType;
             pricePerUnit: number | null;
@@ -871,9 +939,17 @@ export declare const offeringsContract: {
             startAt?: Date | null | undefined;
             endAt?: Date | null | undefined;
             cancellationPeriod?: number | null | undefined;
+            showTotalRaised?: boolean | undefined;
             hasEscrow?: boolean | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             yield?: number | null | undefined;
             duration?: number | null | undefined;
             durationType?: import("../../..").DurationType | null | undefined;
@@ -906,9 +982,18 @@ export declare const offeringsContract: {
             startAt?: string | null | undefined;
             endAt?: string | null | undefined;
             cancellationPeriod?: number | null | undefined;
+            showTotalRaised?: boolean | undefined;
             hasEscrow?: boolean | undefined;
             bankAccountId?: string | null | undefined;
             escrowAccountId?: string | null | undefined;
+            warrantsEnabled?: boolean | undefined;
+            totalShares?: number | null | undefined;
+            warrantTermYears?: number | null | undefined;
+            exercisePrice?: number | null | undefined;
+            warrantPercentage?: number | null | undefined;
+            calculationMethod?: import("../../..").WarrantSharesCalculationMethod | null | undefined;
+            incrementThreshold?: number | null | undefined;
+            shareClassId?: string | null | undefined;
             yield?: number | null | undefined;
             duration?: number | null | undefined;
             durationType?: import("../../..").DurationType | null | undefined;

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

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+export declare const reviewContract: {
+    postReviewKyc: {
+        method: "POST";
+        metadata: {
+            auth: boolean;
+        };
+        body: z.ZodObject<{
+            individualIds: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
+            status: z.ZodNativeEnum<typeof import("../../..").BaseStatus>;
+        }, "strip", z.ZodTypeAny, {
+            status: import("../../..").BaseStatus;
+            individualIds: string[];
+        }, {
+            status: import("../../..").BaseStatus;
+            individualIds: string[];
+        }>;
+        query: z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            userId: string;
+        }, {
+            userId: string;
+        }>;
+        summary: "Post KYC review for individuals";
+        path: "review/kyc";
+        responses: {
+            201: z.ZodObject<{
+                individualsUpdated: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
+                status: z.ZodNativeEnum<typeof import("../../..").BaseStatus>;
+                reviewedBy: z.ZodString;
+                targetObject: z.ZodAny;
+            }, "strip", z.ZodTypeAny, {
+                status: import("../../..").BaseStatus;
+                reviewedBy: string;
+                individualsUpdated: string[];
+                targetObject?: any;
+            }, {
+                status: import("../../..").BaseStatus;
+                reviewedBy: string;
+                individualsUpdated: string[];
+                targetObject?: any;
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            403: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            500: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+};

package/contracts/clients/review/index.js

@@ -0,0 +1,27 @@
+import { initContract } from '@ts-rest/core';
+import { ForbiddenError, InternalError, UnauthorizedError, PostReviewBody, PostReviewResponse, userIdSchema, } from '../../../common/types/index.js';
+import { z } from 'zod';
+const c = initContract();
+export const reviewContract = c.router({
+    postReviewKyc: {
+        summary: 'Post KYC review for individuals',
+        method: 'POST',
+        path: '/kyc',
+        metadata: {
+            auth: true,
+        },
+        query: z.object({
+            userId: userIdSchema,
+        }),
+        body: PostReviewBody,
+        responses: {
+            201: PostReviewResponse,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            500: InternalError,
+        },
+    },
+}, {
+    pathPrefix: 'review',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/review/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,EACL,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,YAAY,GACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CACpC;IACE,aAAa,EAAE;QACb,OAAO,EAAE,iCAAiC;QAC1C,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;YACd,MAAM,EAAE,YAAY;SACrB,CAAC;QACF,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE;YACT,GAAG,EAAE,kBAAkB;YACvB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,QAAQ;CACrB,CACF,CAAC"}