@dalmore/api-contracts 0.0.0-dev.7c97041 → 0.0.0-dev.988f3c3

package/common/types/user.types.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import {
   AccountStatus,
   AccountWithoutUsersZod,
@@ -7,12 +8,11 @@ import {
   ManagedByType,
   OfferingType,
   PortalType,
+  StringToBooleanSchema,
   UserRole,
-  UserStatus,
   UserType,
 } from './common.types';
 import { dateOrString, IBaseEntity } from './entity.types';
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { PhoneZodSchema } from './phone.type';
 import { IInvestorAccount } from './investor-account.types';
 import { TradeZod } from './trade.types';
@@ -51,6 +51,11 @@ export const UserDeleteResponse = z.object({
 });
 export type UserDeleteResponse = z.infer<typeof UserDeleteResponse>;
 
+export const UserRestoreResponse = z.object({
+  message: z.string(),
+});
+export type UserRestoreResponse = z.infer<typeof UserRestoreResponse>;
+
 export const GetMeResponse = IBaseEntity.extend({
   accountId: z.string().nullable(),
   accountName: z.string().nullable(),
@@ -59,7 +64,7 @@ export const GetMeResponse = IBaseEntity.extend({
   email: z.string().email(),
   provider: z.string(),
   active: z.boolean(),
-  status: z.lazy(() => z.nativeEnum(UserStatus)),
+  locked: z.boolean(),
   lastLoginAt: dateOrString.nullable(),
   loginCount: z.number(),
   role: z.string(),
@@ -157,7 +162,7 @@ export const UserZod = IBaseEntity.extend({
   onboarding: z.string().nullable(),
   account: AccountWithoutUsersZod.optional(),
   active: z.boolean(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
   userLogin: IBaseEntity.extend({
     firstName: z.string(),
     lastName: z.string(),
@@ -179,27 +184,9 @@ export const UserFiltersZod = z.object({
   search: z.string().max(50).optional(),
   role: z.nativeEnum(UserRole).optional(),
   portal: z.string().optional(),
-  status: z.nativeEnum(UserStatus).optional(),
-  active: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'active must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
-  twoFactorEnabled: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'twoFactorEnabled must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
+  locked: StringToBooleanSchema.optional(),
+  active: StringToBooleanSchema.optional(),
+  twoFactorEnabled: StringToBooleanSchema.optional(),
 });
 
 const usersInclude = z.enum(['account', 'role']);
@@ -274,7 +261,7 @@ export type IssuerUsersStatusUpdateResponse = z.infer<
 >;
 
 export const UpdateLockedStatus = z.object({
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 
 export type UpdateLockedStatus = z.infer<typeof UpdateLockedStatus>;
@@ -285,7 +272,7 @@ export const UsersSummaryFilterZod = z.object({
   portalType: z.nativeEnum(PortalType).optional(),
   search: z.string().trim().max(50).optional(),
   selectRole: z.nativeEnum(UserRole).optional(),
-  status: z.nativeEnum(UserStatus).optional(),
+  locked: StringToBooleanSchema.optional(),
 });
 export type UsersSummaryFilterZod = z.infer<typeof UsersSummaryFilterZod>;
 
@@ -299,7 +286,7 @@ export const UsersSummaryZod = z.object({
   portalType: z.string(),
   loginCount: z.number().int(),
   lastLogin: z.date(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 export type UsersSummaryZod = z.infer<typeof UsersSummaryZod>;
 

package/contracts/clients/cart/index.ts

@@ -10,7 +10,11 @@ import {
   userIdSchema,
   tradeIdSchema,
 } from '../../../common/types';
-import { PatchCartBody } from '../../../common/types/cart.types';
+import {
+  PatchCartBody,
+  ClientPlacetradeBody,
+  PlaceTradeResponse,
+} from '../../../common/types/cart.types';
 
 const c = initContract();
 
@@ -34,6 +38,22 @@ export const cartContract = c.router(
         500: InternalError,
       },
     },
+    postCheckout: {
+      summary: 'Place a trade (checkout button)',
+      method: 'POST',
+      path: '/checkout',
+      metadata: {
+        auth: true,
+      },
+      body: ClientPlacetradeBody,
+      responses: {
+        200: PlaceTradeResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
     patchCart: {
       summary: 'Patch a cart',
       method: 'PATCH',

package/contracts/clients/index.ts

@@ -19,6 +19,7 @@ import { sitesContract } from './sites';
 import { paymentMethodsContract } from './payment-methods';
 import { issuerPaymentMethodsContract } from './issuer-payment-methods';
 import { tradeLineItemsContract } from './trade-line-items';
+import { clientsTransactionsContract } from './transactions';
 
 const c = initContract();
 
@@ -45,6 +46,7 @@ export const clientsContract = c.router(
     sites: sitesContract,
     tradeLineItems: tradeLineItemsContract,
     trades: tradesContract,
+    transactions: clientsTransactionsContract,
   },
   {
     pathPrefix: '/clients/api/v1/',

package/contracts/clients/trade-line-items/index.ts

@@ -14,7 +14,7 @@ import {
   TradeLineItemQuery,
   TradeLineItemResponse,
   TradeLineItemUpdate,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 const c = initContract();
 

package/contracts/clients/trades/index.ts

@@ -26,7 +26,7 @@ import {
   PostTradeLineItem,
   TradeLineItemQuery,
   TradeLineItemResponse,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 const c = initContract();
 

package/contracts/clients/transactions/index.ts

@@ -0,0 +1,37 @@
+import { initContract } from '@ts-rest/core';
+import {
+  BadRequestError,
+  InternalError,
+  NotFoundError,
+  UnauthorizedError,
+} from '../../../common/types';
+import {
+  ClientPostTransactionZod,
+  TransactionZod,
+} from '../../../common/types/transaction.types';
+
+const c = initContract();
+
+export const clientsTransactionsContract = c.router(
+  {
+    postTransaction: {
+      summary: 'Create a transaction',
+      method: 'POST',
+      path: '',
+      metadata: {
+        auth: true,
+      },
+      body: ClientPostTransactionZod,
+      responses: {
+        201: TransactionZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'transactions',
+  },
+);

package/contracts/compliance/account-settings/index.ts

@@ -0,0 +1,59 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import {
+  accountSettingIdSchema,
+  AccountSettingsFilters,
+  AccountSettingsIncludeQuery,
+  IAccountSettingZod,
+  IPaginatedAccountSetting,
+} from '../../../common/types/account-setting.types';
+import {
+  InternalError,
+  NotFoundError,
+  PaginationOptionsZod,
+  UnauthorizedError,
+} from '../../../common/types';
+
+const c = initContract();
+
+export const accountSettingsContract = c.router(
+  {
+    getAccountSettings: {
+      summary: 'Get account settings',
+      method: 'GET',
+      path: '',
+      metadata: {
+        auth: true,
+      },
+      query: PaginationOptionsZod.merge(AccountSettingsFilters).merge(
+        AccountSettingsIncludeQuery,
+      ),
+      responses: {
+        200: IPaginatedAccountSetting,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
+    getAccountSetting: {
+      summary: 'Get account setting by id',
+      method: 'GET',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: accountSettingIdSchema,
+      }),
+      query: z.object({}).merge(AccountSettingsIncludeQuery),
+      responses: {
+        200: IAccountSettingZod,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'account-settings',
+  },
+);

package/contracts/compliance/bonus-tiers/index.ts

@@ -6,10 +6,12 @@ import {
   UnauthorizedError,
 } from '../../../common/types';
 import {
+  ComplianceEstimateBonusTierCalculationZod,
   CompliancePostBonusTierZod,
   EstimateBonusTierCalculationResponseZod,
-  EstimateBonusTierCalculationZod,
   IBonusTierList,
+  PurchaseCalculationResponseZod,
+  PurchaseCalculationZod,
 } from '../../../common/types/bonus-tier.types';
 
 const c = initContract();
@@ -23,7 +25,7 @@ export const bonusTiersContract = c.router(
       metadata: {
         auth: true,
       },
-      body: EstimateBonusTierCalculationZod,
+      body: ComplianceEstimateBonusTierCalculationZod,
       responses: {
         200: EstimateBonusTierCalculationResponseZod,
         400: BadRequestError,
@@ -32,6 +34,23 @@ export const bonusTiersContract = c.router(
         500: InternalError,
       },
     },
+    purchaseCalculation: {
+      summary:
+        '[ADMIN] Calculate the bonus shares that would be awarded for a trade',
+      method: 'POST',
+      path: '/purchase-calculation',
+      metadata: {
+        auth: true,
+      },
+      body: PurchaseCalculationZod,
+      responses: {
+        200: PurchaseCalculationResponseZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
     postBonusTier: {
       summary: 'Create a new bonus tier',
       method: 'POST',

package/contracts/compliance/index.ts

@@ -1,6 +1,7 @@
 import { accountsContract } from './accounts';
 import { accountContactsContract } from './account-contacts';
 import { accountManagersContract } from './account-managers';
+import { accountSettingsContract } from './account-settings';
 import { activitiesContract } from './activities';
 import { apiKeysContract } from './api-keys';
 import { assetsContract } from './assets';
@@ -31,6 +32,7 @@ import { kycsContract } from './kyc';
 import { legalEntitiesContract } from './legal-entities';
 import { loginHistoriesContract } from './login-histories';
 import { notesContract } from './notes';
+import { notificationChannelsContract } from './notification-channels';
 import { offeringsContract } from './offerings';
 import { pagesContract } from './pages';
 import { paymentMethodsContract } from './payment-methods';
@@ -75,6 +77,7 @@ export const complianceContract = c.router(
     accounts: accountsContract,
     accountContacts: accountContactsContract,
     accountManagers: accountManagersContract,
+    accountSettings: accountSettingsContract,
     activities: activitiesContract,
     apiKeys: apiKeysContract,
     assets: assetsContract,
@@ -112,6 +115,7 @@ export const complianceContract = c.router(
     legalEntities: legalEntitiesContract,
     loginHistories: loginHistoriesContract,
     notes: notesContract,
+    notificationChannels: notificationChannelsContract,
     offerings: offeringsContract,
     pages: pagesContract,
     paymentMethods: paymentMethodsContract,

package/contracts/compliance/notification-channels/index.ts

@@ -0,0 +1,251 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import {
+  CreateChannelInputSchema,
+  CreateTriggerInputSchema,
+  IAvailableTriggersResponse,
+  INotificationChannelTriggerZod,
+  INotificationChannelZod,
+  INotificationRecordZod,
+  IPaginatedNotificationChannel,
+  IPaginatedNotificationRecord,
+  NotificationChannelFilters,
+  NotificationChannelsIncludeQuery,
+  notificationChannelIdSchema,
+  notificationChannelTriggerIdSchema,
+  NotificationRecordFilters,
+  NotificationRecordsIncludeQuery,
+  notificationRecordIdSchema,
+  UpdateChannelInputSchema,
+} from '../../../common/types/notification.types';
+import {
+  BadRequestError,
+  InternalError,
+  NotFoundError,
+  PaginationOptionsZod,
+  UnauthorizedError,
+} from '../../../common/types';
+
+const c = initContract();
+
+export const notificationChannelsContract = c.router(
+  {
+    getChannels: {
+      summary: 'Get notification channels',
+      method: 'GET',
+      path: '',
+      metadata: {
+        auth: true,
+      },
+      query: PaginationOptionsZod.merge(NotificationChannelFilters).merge(
+        NotificationChannelsIncludeQuery,
+      ),
+      responses: {
+        200: IPaginatedNotificationChannel,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
+    getChannel: {
+      summary: 'Get notification channel by id',
+      method: 'GET',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+      }),
+      query: z.object({}).merge(NotificationChannelsIncludeQuery),
+      responses: {
+        200: INotificationChannelZod,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    createChannel: {
+      summary: 'Create notification channel',
+      method: 'POST',
+      path: '',
+      metadata: {
+        auth: true,
+      },
+      body: CreateChannelInputSchema,
+      responses: {
+        201: INotificationChannelZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
+    updateChannel: {
+      summary: 'Update notification channel',
+      method: 'PATCH',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+      }),
+      body: UpdateChannelInputSchema,
+      responses: {
+        200: INotificationChannelZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    deleteChannel: {
+      summary: 'Delete notification channel',
+      method: 'DELETE',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+      }),
+      body: z.object({}),
+      responses: {
+        200: z.object({ success: z.boolean() }),
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    createTrigger: {
+      summary: 'Create notification channel trigger',
+      method: 'POST',
+      path: '/:id/triggers',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+      }),
+      body: CreateTriggerInputSchema.omit({ notificationChannelId: true }),
+      responses: {
+        201: INotificationChannelTriggerZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getAvailableTriggers: {
+      summary: 'Get all available triggers for a channel',
+      method: 'GET',
+      path: '/:id/triggers/available',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+      }),
+      responses: {
+        200: IAvailableTriggersResponse,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    updateTrigger: {
+      summary: 'Update notification channel trigger',
+      method: 'PATCH',
+      path: '/:id/triggers/:triggerId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+        triggerId: notificationChannelTriggerIdSchema,
+      }),
+      body: z.object({ enabled: z.boolean() }),
+      responses: {
+        200: INotificationChannelTriggerZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    deleteTrigger: {
+      summary: 'Delete notification channel trigger',
+      method: 'DELETE',
+      path: '/:id/triggers/:triggerId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: notificationChannelIdSchema,
+        triggerId: notificationChannelTriggerIdSchema,
+      }),
+      body: z.object({}),
+      responses: {
+        200: z.object({ success: z.boolean() }),
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getRecords: {
+      summary: 'Get notification records',
+      method: 'GET',
+      path: '/records',
+      metadata: {
+        auth: true,
+      },
+      query: PaginationOptionsZod.merge(NotificationRecordFilters).merge(
+        NotificationRecordsIncludeQuery,
+      ),
+      responses: {
+        200: IPaginatedNotificationRecord,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
+    getRecord: {
+      summary: 'Get notification record by id',
+      method: 'GET',
+      path: '/records/:recordId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        recordId: notificationRecordIdSchema,
+      }),
+      query: z.object({}).merge(NotificationRecordsIncludeQuery),
+      responses: {
+        200: INotificationRecordZod,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    retryRecord: {
+      summary: 'Retry failed notification record',
+      method: 'POST',
+      path: '/records/:recordId/retry',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        recordId: notificationRecordIdSchema,
+      }),
+      body: z.object({}),
+      responses: {
+        200: INotificationRecordZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'notification-channels',
+  },
+);

package/contracts/compliance/trade-line-items/index.ts

@@ -13,7 +13,7 @@ import {
   ReviewTradeLineItemStatus,
   TradeLineItemFiltersQuery,
   TradeLineItemResponse,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 import { z } from 'zod';
 const c = initContract();

package/contracts/compliance/users/index.ts

@@ -21,6 +21,7 @@ import {
   IssuersActiveStatusUpdateZod,
   UpdateLockedStatus,
   UpdateUserRoleZod,
+  UserRestoreResponse,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -143,6 +144,26 @@ export const usersContract = c.router(
         500: InternalError,
       },
     },
+    restoreUser: {
+      summary: 'Restore user by id',
+      method: 'POST',
+      path: '/:id/restore',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: userIdSchema,
+      }),
+      body: z.object({}),
+      responses: {
+        200: UserRestoreResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
     updateActiveStatus: {
       summary: '[Admin] Update user active status',
       method: 'PATCH',

package/contracts/investors/bonus-tiers/index.ts

@@ -8,6 +8,8 @@ import {
 import {
   EstimateBonusTierCalculationResponseZod,
   EstimateBonusTierCalculationZod,
+  PurchaseCalculationResponseZod,
+  PurchaseCalculationZod,
 } from '../../../common/types/bonus-tier.types';
 
 const c = initContract();
@@ -30,6 +32,22 @@ export const bonusTiersContract = c.router(
         500: InternalError,
       },
     },
+    purchaseCalculation: {
+      summary: 'Calculate the bonus shares that would be awarded for a trade',
+      method: 'POST',
+      path: '/purchase-calculation',
+      metadata: {
+        auth: true,
+      },
+      body: PurchaseCalculationZod,
+      responses: {
+        200: PurchaseCalculationResponseZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
   },
   {
     pathPrefix: 'bonus-tiers',

package/contracts/investors/trade-line-items/index.ts

@@ -13,7 +13,7 @@ import {
   TradeLineItemResponse,
   TradeLineItemUpdate,
   TradeLineItemSignStatusUpdate,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 const c = initContract();