@dalmore/api-contracts 1.0.0

package/contracts/compliance/signer/index.ts

@@ -0,0 +1,369 @@
+import { ContractAnyType, initContract } from '@ts-rest/core';
+import {
+  BadRequestError,
+  ForbiddenError,
+  InternalError,
+  NotFoundError,
+  UnauthorizedError,
+} from '../../../common/types';
+import {
+  SignerMessageResponseZod,
+  SignerTemplatesPaginatedZod,
+  TemplatePathParams,
+  ValidatedTemplateResponse,
+  ValidatedTemplatesResponse,
+  SignerBrandSchema,
+  BrandPathParams,
+  CreateSignerBrandZod,
+  UpdateSignerBrandZod,
+  SignerBrandsPaginatedZod,
+  SignerSenderIdentitySchema,
+  CreateSignerSenderIdentityZod,
+  UpdateSignerSenderIdentityZod,
+  SignerSenderIdentitiesPaginatedZod,
+  SignerTemplateSchema,
+  SenderIdentityPathParams,
+  SignerPaginationQuery,
+  UpdateSignerTemplateZod,
+} from '../../../common/types/signer.types';
+import { authHeader, generateApiDescription } from '../../../common/helpers';
+import z from 'zod';
+
+const c = initContract();
+
+export const signerContract = c.router(
+  {
+    validateTemplate: {
+      summary: 'validate signer template by id',
+      method: 'POST',
+      path: '/templates/:templateId/check',
+      pathParams: TemplatePathParams,
+      metadata: {
+        auth: true,
+      },
+      body: {} as ContractAnyType,
+      responses: {
+        200: ValidatedTemplateResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    validateTemplates: {
+      summary: 'validate all signer templates',
+      method: 'POST',
+      path: '/templates/check-all',
+      metadata: {
+        auth: true,
+      },
+      body: {} as ContractAnyType,
+      responses: {
+        200: ValidatedTemplatesResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getPaginatedSignerTemplates: {
+      summary: 'Get paginated signer templates',
+      method: 'GET',
+      path: '/templates',
+      metadata: {
+        auth: true,
+      },
+      query: SignerPaginationQuery,
+      responses: {
+        200: SignerTemplatesPaginatedZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getSignerTemplate: {
+      summary: 'Get signer template',
+      method: 'GET',
+      path: '/templates/:id',
+      pathParams: TemplatePathParams,
+      metadata: {
+        auth: true,
+      },
+      responses: {
+        200: SignerTemplateSchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    updateSignerTemplate: {
+      summary: 'Update signer template',
+      method: 'PATCH',
+      path: '/templates/:id',
+      pathParams: TemplatePathParams,
+      metadata: {
+        auth: true,
+      },
+      body: UpdateSignerTemplateZod,
+      responses: {
+        200: SignerTemplateSchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    syncSignerTemplates: {
+      summary: 'Sync signer templates',
+      method: 'POST',
+      path: '/templates/sync',
+      metadata: {
+        auth: true,
+      },
+      body: z.object({}),
+      responses: {
+        200: SignerMessageResponseZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    createSignerBrand: {
+      summary: 'Create signer brand',
+      description: generateApiDescription(
+        'Create a new signer brand with the provided data.',
+        'POST',
+        '/brands',
+        {
+          headers: authHeader,
+          formData: {
+            brandName: 'My Brand Name',
+            emailDisplayName: 'Brand Display Name',
+            backgroundColor: '#FFFFFF',
+            buttonColor: '#007BFF',
+            buttonTextColor: '#FFFFFF',
+            accountId: 'account_01j5tkg6k2fygr0x06fegt27aj',
+            brandLogo: '@/path/to/logo.png',
+          },
+        },
+      ),
+      method: 'POST',
+      path: '/brands',
+      metadata: {
+        auth: true,
+      },
+      body: CreateSignerBrandZod,
+      contentType: 'multipart/form-data',
+      responses: {
+        200: SignerBrandSchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    updateSignerBrand: {
+      summary: 'Updated signer brand',
+      description: generateApiDescription(
+        'Update an existing signer brand with the provided data.',
+        'PUT',
+        '/brands/:id',
+        {
+          headers: authHeader,
+          formData: {
+            brandName: 'Updated Brand Name',
+            emailDisplayName: 'Updated Display Name',
+            backgroundColor: '#FFFFFF',
+            buttonColor: '#007BFF',
+            buttonTextColor: '#FFFFFF',
+            brandLogo: '@/path/to/updated-logo.png',
+          },
+        },
+      ),
+      method: 'PUT',
+      path: '/brands/:id',
+      pathParams: BrandPathParams,
+      metadata: {
+        auth: true,
+      },
+      body: UpdateSignerBrandZod,
+      contentType: 'multipart/form-data',
+      responses: {
+        200: SignerBrandSchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    deleteSignerBrand: {
+      summary: 'Delete signer brand',
+      method: 'GET',
+      path: '/brands/:id',
+      pathParams: BrandPathParams,
+      metadata: {
+        auth: true,
+      },
+      responses: {
+        200: SignerMessageResponseZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getPaginatedSignerBrands: {
+      summary: 'Get paginated signer brands',
+      method: 'GET',
+      path: '/brands',
+      metadata: {
+        auth: true,
+      },
+      query: SignerPaginationQuery,
+      responses: {
+        200: SignerBrandsPaginatedZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getSignerBrand: {
+      summary: 'Get signer brand',
+      method: 'GET',
+      path: '/brands/:id',
+      pathParams: BrandPathParams,
+      metadata: {
+        auth: true,
+      },
+      responses: {
+        200: SignerBrandSchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    syncSignerBrands: {
+      summary: 'Sync signer brands',
+      method: 'POST',
+      path: '/brands/sync',
+      metadata: {
+        auth: true,
+      },
+      body: z.object({}),
+      responses: {
+        200: SignerMessageResponseZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    createSignerSenderIdentity: {
+      summary: 'Create signer sender identity',
+      method: 'POST',
+      path: '/sender-identities',
+      metadata: {
+        auth: true,
+      },
+      body: CreateSignerSenderIdentityZod,
+      responses: {
+        200: SignerSenderIdentitySchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    updateSignerSenderIdentity: {
+      summary: 'update signer sender identity',
+      method: 'PUT',
+      path: '/sender-identities/:id',
+      pathParams: SenderIdentityPathParams,
+      metadata: {
+        auth: true,
+      },
+      body: UpdateSignerSenderIdentityZod,
+      responses: {
+        200: SignerSenderIdentitySchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    deleteSignerSenderIdentity: {
+      summary: 'Delete signer sender identity',
+      method: 'DELETE',
+      path: '/sender-identities/:id',
+      pathParams: SenderIdentityPathParams,
+      metadata: {
+        auth: true,
+      },
+      responses: {
+        200: SignerMessageResponseZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getPaginatedSignerSenderIdentities: {
+      summary: 'Get paginated signer sender identites',
+      method: 'GET',
+      path: '/sender-identities',
+      metadata: {
+        auth: true,
+      },
+      query: SignerPaginationQuery,
+      responses: {
+        200: SignerSenderIdentitiesPaginatedZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    getSignerSenderidentity: {
+      summary: 'Get signer sender identity',
+      method: 'GET',
+      path: '/sender-identities/:id',
+      pathParams: SenderIdentityPathParams,
+      metadata: {
+        auth: true,
+      },
+      responses: {
+        200: SignerSenderIdentitySchema,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    syncSignerSenderIdentities: {
+      summary: 'Sync signer sender identities',
+      method: 'POST',
+      path: '/sender-identities',
+      metadata: {
+        auth: true,
+      },
+      body: z.object({}),
+      responses: {
+        200: SignerMessageResponseZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'signers',
+  },
+);

package/contracts/compliance/site-links/index.ts

@@ -0,0 +1,128 @@
+import { initContract } from '@ts-rest/core';
+import {
+  PaginationOptionsZod,
+  UnauthorizedError,
+  SiteLinkFiltersZod,
+  IPaginatedSiteLink,
+  PostSiteLinkZod,
+  ISiteLink,
+  BadRequestError,
+  NotFoundError,
+  ForbiddenError,
+  InternalError,
+  siteLinkIdSchema,
+  SiteLinkDeleteResponse,
+  SiteLinksIncludeQuery,
+  accountIdSchema,
+} from '../../../common/types';
+import { z } from 'zod';
+const c = initContract();
+
+export const siteLinksContract = c.router(
+  {
+    getSiteLinks: {
+      summary: 'Get site links',
+      method: 'GET',
+      path: '/account/:accountId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        accountId: accountIdSchema,
+      }),
+      query: PaginationOptionsZod.merge(SiteLinksIncludeQuery).merge(
+        SiteLinkFiltersZod,
+      ),
+      responses: {
+        200: IPaginatedSiteLink,
+        400: BadRequestError,
+        401: UnauthorizedError,
+      },
+    },
+    getSiteLink: {
+      summary: 'Get a site link',
+      method: 'GET',
+      path: '/:id/account/:accountId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: siteLinkIdSchema,
+        accountId: accountIdSchema,
+      }),
+      query: z.object({}).merge(SiteLinksIncludeQuery),
+      responses: {
+        200: ISiteLink,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    postSiteLink: {
+      summary: '[ADMIN] Create a site link',
+      method: 'POST',
+      path: '/account/:accountId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        accountId: accountIdSchema,
+      }),
+      body: PostSiteLinkZod,
+      responses: {
+        201: ISiteLink,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    patchSiteLink: {
+      summary: '[ADMIN] Update a site link',
+      method: 'PATCH',
+      path: '/:id/account/:accountId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: siteLinkIdSchema,
+        accountId: accountIdSchema,
+      }),
+      body: PostSiteLinkZod,
+      responses: {
+        201: ISiteLink,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    deleteSiteLink: {
+      summary: '[ADMIN] Delete a site link',
+      method: 'DELETE',
+      path: '/:id/account/:accountId',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: siteLinkIdSchema,
+        accountId: accountIdSchema,
+      }),
+      responses: {
+        204: SiteLinkDeleteResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'site-links',
+  },
+);