@dalmore/api-contracts 0.0.0-dev.d07da18 → 0.0.0-dev.d29fb02

package/contracts/issuers/data-rooms/index.ts

@@ -1,134 +0,0 @@
-import { z } from 'zod';
-import { initContract } from '@ts-rest/core';
-import {
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  dataRoomIdSchema,
-  DataRoomPasswordQueryZod,
-  DataRoomsFilters,
-  DataRoomsIncludeQuery,
-  DataRoomStructureZod,
-  DataRoomZod,
-  DeleteDataRoom,
-  IPaginatedDataRooms,
-  PatchDataRoomZod,
-  PostDataRoom,
-} from '../../../common/types/data-room.types';
-
-const c = initContract();
-
-export const dataRoomsContract = c.router(
-  {
-    getDataRooms: {
-      summary:
-        'Get Data Rooms - returns flat data room objects. See getDataRoomStructure for tree structure',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(DataRoomsFilters).merge(
-        DataRoomsIncludeQuery,
-      ),
-      responses: {
-        200: IPaginatedDataRooms,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    getDataRoom: {
-      summary:
-        'Get data room by id - returns a flat data room object. See getDataRoomStructure for tree structure',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: DataRoomsIncludeQuery.merge(DataRoomPasswordQueryZod),
-      pathParams: z.object({ id: dataRoomIdSchema }),
-      responses: {
-        200: DataRoomZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-    getDataRoomStructure: {
-      summary:
-        'Get data room structure by id - shows the proper tree structure of the data room',
-      method: 'GET',
-      path: '/:id/structure',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({ id: dataRoomIdSchema }),
-      query: DataRoomPasswordQueryZod,
-      responses: {
-        200: DataRoomStructureZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postDataRoom: {
-      summary: 'Create a data room',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostDataRoom,
-      responses: {
-        201: DataRoomZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    patchDataRoom: {
-      summary: 'Update data room',
-      method: 'PATCH',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({ id: dataRoomIdSchema }),
-      body: PatchDataRoomZod,
-      responses: {
-        201: DataRoomZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    deleteDataRoom: {
-      summary:
-        'Deletes a data room and optionally (force=true) all its contents (subfolders and file associations)',
-      method: 'DELETE',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: DeleteDataRoom,
-      responses: {
-        204: z.object({ success: z.boolean() }),
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'data-rooms',
-  },
-);

package/contracts/issuers/disbursement-approval-users/index.ts

@@ -1,82 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  UnauthorizedError,
-  PaginationOptionsZod,
-  BadRequestError,
-} from '../../../common/types';
-import { z } from 'zod';
-import {
-  DisbursementApprovalUserFiltersZod,
-  disbursementApprovalUserIdSchema,
-  DisbursementApprovalUsersIncludeQuery,
-  DisbursementApprovalUserZod,
-  IPaginatedDisbursementApprovalUser,
-  PostDisbursementApprovalUser,
-} from '../../../common/types/disbursement-approval-user.types';
-
-const c = initContract();
-
-export const disbursementApprovalUsersContract = c.router(
-  {
-    getDisbursementApprovalUsers: {
-      summary: 'Get disbursement approval users',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(
-        DisbursementApprovalUserFiltersZod,
-      ).merge(DisbursementApprovalUsersIncludeQuery),
-      responses: {
-        200: IPaginatedDisbursementApprovalUser,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postDisbursementApprovalUser: {
-      summary: 'Create disbursement approval user',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementApprovalUser,
-      responses: {
-        201: DisbursementApprovalUserZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-
-    deleteDisbursementApprovalUser: {
-      summary: '[ADMIN] Delete disbursement approval user',
-      method: 'DELETE',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: disbursementApprovalUserIdSchema,
-      }),
-      responses: {
-        200: z.object({ success: z.boolean() }),
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'disbursement-approval-users',
-  },
-);

package/contracts/issuers/disbursement-transactions/index.ts

@@ -1,53 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  DisbursementTransactionZod,
-  PostDisbursementTransactionZod,
-} from '../../../common/types/disbursement-transaction.types';
-
-const c = initContract();
-
-export const disbursementTransactionsContract = c.router(
-  {
-    postDisbursementTransaction: {
-      summary: 'Create a disbursement transaction',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementTransactionZod,
-      responses: {
-        201: DisbursementTransactionZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    getDisbursementTransactions: {
-      summary: 'Get disbursement transactions',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        200: DisbursementTransactionZod.array(),
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'disbursement-transactions',
-  },
-);

package/contracts/issuers/disbursements/index.ts

@@ -1,153 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-} from '../../../common/types';
-
-import { z } from 'zod';
-import { PostDisbursementReviewZod } from '../../../common/types/disbursement-review.types';
-import {
-  DisbursementBalanceZod,
-  DisbursementFiltersZod,
-  disbursementIdSchema,
-  DisbursementMissingConfigZod,
-  DisbursementsIncludeQuery,
-  DisbursementsMissingConfigQuery,
-  DisbursementSummaryZod,
-  DisbursementZod,
-  IPaginatedDisbursement,
-  PostDisbursementBalanceZod,
-  PostDisbursementSummaryZod,
-  PostDisbursementZod,
-} from '../../../common/types/disbursements.types';
-
-const c = initContract();
-
-export const disbursementsContract = c.router(
-  {
-    postDisbursement: {
-      summary: 'Create a disbursement',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementZod,
-      responses: {
-        201: DisbursementZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postDisbursementBalance: {
-      summary: 'Get a disbursement balance',
-      method: 'POST',
-      path: '/balance',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementBalanceZod,
-      responses: {
-        201: DisbursementBalanceZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postDisbursementSummary: {
-      summary: 'Get a disbursement summary',
-      method: 'POST',
-      path: '/summary',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementSummaryZod,
-      responses: {
-        201: DisbursementSummaryZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    getDisbursements: {
-      summary: 'Get disbursements',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(DisbursementFiltersZod).merge(
-        DisbursementsIncludeQuery,
-      ),
-      responses: {
-        200: IPaginatedDisbursement,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-
-    getDisbursementsMissingConfig: {
-      summary: 'Get mssing configurations for disbursements',
-      method: 'GET',
-      path: '/config',
-      metadata: {
-        auth: true,
-      },
-      query: DisbursementsMissingConfigQuery,
-      responses: {
-        200: DisbursementMissingConfigZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-
-    getDisbursement: {
-      summary: 'Get disbursement by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({}).merge(DisbursementsIncludeQuery),
-      pathParams: z.object({ id: disbursementIdSchema }),
-      responses: {
-        200: DisbursementZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    reviewDisbursements: {
-      summary: 'Review Disbursements',
-      method: 'POST',
-      path: '/review',
-      metadata: {
-        auth: true,
-      },
-      body: PostDisbursementReviewZod,
-      responses: {
-        201: z.object({ success: z.boolean() }),
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'disbursements',
-  },
-);

package/contracts/issuers/email-themes/index.ts

@@ -1,242 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import { z } from 'zod';
-import {
-  ForbiddenError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-  NotFoundError,
-  InternalError,
-} from '../../../common/types';
-import {} from '../../../common/types';
-import {
-  emailThemeIdSchema,
-  emailThemeSettingIdSchema,
-  EmailThemesList,
-  IEmailTheme,
-  IEmailThemeSetting,
-  PatchEmailThemeSetting,
-  IEmailThemeSettings,
-  PatchEmailThemeSettings,
-  PostEmailThemeZod,
-  ExportEmailThemeSettingsZod,
-  PatchEmailThemeNameZod,
-  ImportEmailThemeSettingsZod,
-  PreviewEmailThemeResponse,
-  SendPreviewEmailResponse,
-  SendPreviewEmailZod,
-  PreviewEmailThemeZod,
-  GenerateTemplatePreviewHtmlZod,
-} from '../../../common/types/email-theme.types';
-
-const c = initContract();
-
-export const emailThemesContract = c.router(
-  {
-    previewEmailTheme: {
-      summary: 'Preview an email theme',
-      method: 'GET',
-      path: '/preview',
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        200: PreviewEmailThemeResponse,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    getEmailThemes: {
-      summary: 'Get the email themes for the current account',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        200: EmailThemesList,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-
-    getEmailTheme: {
-      summary: 'Get the email theme for the current account',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod,
-      responses: {
-        200: IEmailTheme,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-    sendPreviewEmail: {
-      summary: 'Send a preview email',
-      method: 'POST',
-      path: '/send-preview-email',
-      metadata: {
-        auth: true,
-      },
-      body: SendPreviewEmailZod,
-      responses: {
-        201: SendPreviewEmailResponse,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    sendTemplateEmail: {
-      summary: 'Send a template email',
-      method: 'POST',
-      path: '/send-template-email',
-      metadata: {
-        auth: true,
-      },
-      body: PreviewEmailThemeZod,
-      responses: {
-        201: SendPreviewEmailResponse,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    generateTemplatePreviewHtml: {
-      summary: 'Generate HTML for a template email',
-      method: 'POST',
-      path: '/generate-template-preview-html',
-      metadata: {
-        auth: true,
-      },
-      body: GenerateTemplatePreviewHtmlZod,
-      responses: {
-        200: PreviewEmailThemeResponse,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postEmailTheme: {
-      summary: 'Post a email theme',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostEmailThemeZod,
-      responses: {
-        201: IEmailTheme,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-
-    patchEmailThemeSettings: {
-      summary: 'Patch email theme settings',
-      method: 'PATCH',
-      path: '/:id/email-theme-settings',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: emailThemeIdSchema,
-      }),
-      body: PatchEmailThemeSettings,
-      responses: {
-        201: IEmailThemeSettings,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    patchEmailThemeSetting: {
-      summary: 'Patch a email theme setting',
-      method: 'PATCH',
-      path: '/:id/email-theme/:emailThemeId',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: emailThemeSettingIdSchema,
-        emailThemeId: emailThemeIdSchema,
-      }),
-      body: PatchEmailThemeSetting,
-      responses: {
-        201: IEmailThemeSetting,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    importEmailThemeSettings: {
-      summary: 'Import email theme settings',
-      method: 'POST',
-      path: '/:id/import-theme-settings',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: emailThemeIdSchema,
-      }),
-      body: ImportEmailThemeSettingsZod,
-      responses: {
-        201: IEmailThemeSettings,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-
-    exportEmailThemeSettings: {
-      summary: 'Export email theme settings',
-      method: 'GET',
-      path: '/:id/export-theme-settings',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: emailThemeIdSchema,
-      }),
-      responses: {
-        200: ExportEmailThemeSettingsZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    patchEmailThemeName: {
-      summary: 'Patch the name of a email theme',
-      method: 'PATCH',
-      path: '/:id/name',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: emailThemeIdSchema,
-      }),
-      body: PatchEmailThemeNameZod,
-      responses: {
-        201: IEmailTheme,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'email-themes',
-  },
-);