@dalmore/api-contracts 1.0.7 → 1.0.8

package/src/common/types/signer.types.ts

@@ -0,0 +1,651 @@
+import { z } from 'zod';
+import {
+  ComplianceReview,
+  IPaginationMeta,
+  PaginationOptionsZod,
+  SenderIdentityStatus,
+  TemplateStatus,
+  TemplateType,
+} from './common.types';
+import { TypeID } from 'typeid-js';
+
+/**
+ * Example error response:
+ * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
+ *
+ * Example Success response:
+ * https://developers.boldsign.com/documents/send-document-from-template/?region=us#example-response
+ * https://developers.boldsign.com/documents/send-document/?region=us#example-response
+ */
+export const BoldSignCreateDocumentResponseZod = z.object({
+  errors: z.record(z.string(), z.array(z.string())),
+  type: z.string(),
+  title: z.string(),
+  status: z.number().openapi({
+    example: 400,
+  }),
+  traceId: z.string(),
+  documentId: z.string(),
+});
+export type BoldSignCreateDocumentResponseZod = z.infer<
+  typeof BoldSignCreateDocumentResponseZod
+>;
+
+/**
+ * Example error response:
+ * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
+ *
+ * Example Success response:
+ * https://developers.boldsign.com/embedded-signing/get-embedded-signing-link/?region=us#example-response
+ */
+export const BoldSignGetEmbeddedDocumentLinkResponseZod = z.object({
+  errors: z.record(z.string(), z.array(z.string())),
+  type: z.string(),
+  title: z.string(),
+  status: z.number().openapi({
+    example: 400,
+  }),
+  traceId: z.string(),
+  signLink: z.string(),
+});
+export type BoldSignGetEmbeddedDocumentLinkResponseZod = z.infer<
+  typeof BoldSignGetEmbeddedDocumentLinkResponseZod
+>;
+
+/**
+ * Example error response:
+ * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
+ *
+ * Example Success response:
+ * https://developers.boldsign.com/branding/create-brand/?region=us#example-response
+ * https://developers.boldsign.com/branding/update-brand/?region=us#example-response
+ */
+export const BoldSignUpsertBrandResponseZod = z.object({
+  errors: z.record(z.string(), z.array(z.string())),
+  type: z.string(),
+  title: z.string(),
+  status: z.number().openapi({
+    example: 400,
+  }),
+  traceId: z.string(),
+  brandId: z.string(),
+});
+export type BoldSignUpsertBrandResponseZod = z.infer<
+  typeof BoldSignUpsertBrandResponseZod
+>;
+
+/**
+ * Example error response:
+ * https://support.boldsign.com/kb/article/15855/resolving-locale-mismatch-errors-in-boldsign-esignature-api#error-description
+ *
+ * Example Success response:
+ * https://developers.boldsign.com/branding/delete-brand/?region=us#example-response
+ */
+export const BoldSignDeleteBrandResponseZod = z.object({
+  errors: z.record(z.string(), z.array(z.string())),
+  type: z.string(),
+  title: z.string(),
+  status: z.number().openapi({
+    example: 400,
+  }),
+  traceId: z.string(),
+  message: z.string(),
+});
+export type BoldSignDeleteBrandResponseZod = z.infer<
+  typeof BoldSignDeleteBrandResponseZod
+>;
+
+export const SignerMessageResponseZod = z.object({
+  message: z.string(),
+});
+export type SignerMessageResponseZod = z.infer<typeof SignerMessageResponseZod>;
+
+const BoundsSchema = z.object({
+  x: z.number(),
+  y: z.number(),
+  width: z.number(),
+  height: z.number(),
+});
+
+export const FormFieldSchema = z.object({
+  id: z.string(),
+  value: z.union([z.string(), z.number(), z.null()]).optional(),
+  name: z.string().optional(),
+  fieldType: z.string().optional(),
+  pageNumber: z.number().optional(),
+  bounds: BoundsSchema.optional(),
+  isRequired: z.boolean().optional(),
+  editableDateFieldSettings: z.record(z.string(), z.string()).optional(),
+  validationType: z.string().optional(),
+});
+
+const BaseSignerSchema = z.object({
+  signerType: z.literal('Signer'),
+  signerRole: z.string(),
+});
+
+const TemplateSignerSchema = BaseSignerSchema.extend({
+  roleIndex: z.number(),
+  signerName: z.string(),
+  signerEmail: z.string().optional(),
+  signerOrder: z.number().optional(),
+  existingFormFields: z.array(FormFieldSchema),
+});
+
+const NonTemplateSignerSchema = BaseSignerSchema.extend({
+  name: z.string(),
+  emailAddress: z.string().optional(),
+  formFields: z.array(FormFieldSchema),
+});
+
+export const SignerDataSchema = z.union([
+  TemplateSignerSchema,
+  NonTemplateSignerSchema,
+]);
+
+const TemplateDetailFormFieldSchema = z.object({
+  id: z.string(),
+  fieldType: z.string(),
+  value: z.string(),
+  font: z.string(),
+  isRequired: z.boolean(),
+  isReadOnly: z.boolean(),
+  lineHeight: z.number(),
+  fontSize: z.number(),
+  fontHexColor: z.string(),
+  isUnderLineFont: z.boolean(),
+  isItalicFont: z.boolean(),
+  isBoldFont: z.boolean(),
+  groupName: z.string(),
+  placeholder: z.string(),
+  validationtype: z.string(),
+  validationCustomRegex: z.string(),
+  validationCustomRegexMessage: z.string().nullable(),
+  dateFormat: z.string(),
+  imageInfo: z.any().nullable(),
+  attachmentInfo: z.any().nullable(),
+  editableDateFieldSettings: z.any().nullable(),
+  conditionalRules: z.array(z.any()),
+  dropdownOptions: z.array(z.any()),
+  bounds: BoundsSchema,
+  pageNumber: z.number(),
+  dataSyncTag: z.string(),
+  textAlign: z.string(),
+  textDirection: z.string(),
+});
+
+export type TemplateDetailFormFieldSchema = z.infer<
+  typeof TemplateDetailFormFieldSchema
+>;
+
+const RecipientNotificationSettingsSchema = z.object({
+  signatureRequest: z.boolean(),
+  declined: z.boolean(),
+  revoked: z.boolean(),
+  signed: z.boolean(),
+  completed: z.boolean(),
+  expired: z.boolean(),
+  reassigned: z.boolean(),
+  deleted: z.boolean(),
+  reminders: z.boolean(),
+  editRecipient: z.boolean(),
+  editDocument: z.boolean(),
+  viewed: z.boolean().optional(), // only present in the outer object
+});
+
+const RoleSchema = z.object({
+  name: z.string(),
+  index: z.number(),
+  defaultSignerName: z.string(),
+  defaultSignerEmail: z.string(),
+  phoneNumber: z.string().nullable(),
+  signerOrder: z.number(),
+  signerType: z.string(),
+  hostEmail: z.string(),
+  hostName: z.string(),
+  language: z.number(),
+  allowRoleEdit: z.boolean(),
+  allowRoleDelete: z.boolean(),
+  enableAccessCode: z.boolean(),
+  enableEmailOTP: z.boolean(),
+  imposeAuthentication: z.string(),
+  deliveryMode: z.string(),
+  allowFieldConfiguration: z.boolean(),
+  formFields: z.array(TemplateDetailFormFieldSchema),
+  enableEditRecipients: z.boolean(),
+  enableDeleteRecipients: z.boolean(),
+  locale: z.string(),
+  recipientNotificationSettings: RecipientNotificationSettingsSchema,
+});
+
+export const TemplateRoleSchema = RoleSchema;
+
+const FileDetailSchema = z.object({
+  documentName: z.string(),
+  order: z.number(),
+  pageCount: z.number(),
+});
+
+const CreatedBySchema = z.object({
+  emailAddress: z.string(),
+  name: z.string(),
+});
+
+const DocumentInfoSchema = z.object({
+  language: z.number(),
+  title: z.string(),
+  description: z.string(),
+  locale: z.string(),
+});
+
+export const TemplateDataSchema = z.object({
+  templateId: z.string(),
+  title: z.string(),
+  description: z.string(),
+  documentTitle: z.string(),
+  documentMessage: z.string(),
+  files: z.array(FileDetailSchema),
+  roles: z.array(RoleSchema),
+  commonFields: z.array(z.any()),
+  cCDetails: z.array(z.any()),
+  brandId: z.string(),
+  allowMessageEditing: z.boolean(),
+  allowNewRoles: z.boolean(),
+  enableReassign: z.boolean(),
+  EnablePrintAndSign: z.boolean(),
+  enableSigningOrder: z.boolean(),
+  createdDate: z.number(),
+  createdBy: CreatedBySchema,
+  sharedTemplateDetail: z.array(z.any()),
+  documentInfo: z.array(DocumentInfoSchema),
+  labels: z.array(z.string()),
+  templateLabels: z.array(z.string()),
+  recipientNotificationSettings: RecipientNotificationSettingsSchema,
+});
+
+export type FormField = z.infer<typeof FormFieldSchema>;
+export type SignerData = z.infer<typeof SignerDataSchema>;
+export type TemplateDetailFormField = z.infer<
+  typeof TemplateDetailFormFieldSchema
+>;
+export type TemplateRole = z.infer<typeof TemplateRoleSchema>;
+export type TemplateData = z.infer<typeof TemplateDataSchema>;
+
+const DocumentFormFieldSchema = z.object({
+  id: z.string(),
+  type: z.string(),
+  value: z.string(),
+  font: z.string(),
+  isRequired: z.boolean(),
+  isReadOnly: z.boolean(),
+  lineHeight: z.number(),
+  fontSize: z.number(),
+  fontColor: z.string(),
+  isUnderline: z.boolean(),
+  isItalic: z.boolean(),
+  isBold: z.boolean(),
+  groupName: z.string(),
+  placeholder: z.string(),
+  validationtype: z.string(),
+  validationCustomRegex: z.string(),
+  validationCustomRegexMessage: z.string(),
+  dateFormat: z.string(),
+  imageInfo: z.null(),
+  attachmentInfo: z.null(),
+  fileInfo: z.null(),
+  editableDateFieldSettings: z.null(),
+  conditionalLogic: z.array(z.any()),
+  hyperlinkText: z.string(),
+  dropdownOptions: z.array(z.any()),
+  bounds: BoundsSchema,
+  pageNumber: z.number(),
+  dataSyncTag: z.string(),
+  textAlign: z.string(),
+  textDirection: z.string(),
+  characterSpacing: z.number(),
+});
+
+const IdVerificationSchema = z.object({
+  type: z.string(),
+  maximumRetryCount: z.number(),
+  status: z.string(),
+  nameMatcher: z.string(),
+  requireLiveCapture: z.boolean(),
+  requireMatchingSelfie: z.boolean(),
+  holdForPrefill: z.boolean(),
+  prefillCompleted: z.boolean(),
+});
+
+const SignerDetailSchema = z.object({
+  signerName: z.string(),
+  signerRole: z.string(),
+  signerEmail: z.string(),
+  status: z.string(),
+  enableAccessCode: z.boolean(),
+  isAuthenticationFailed: z.boolean().nullable(),
+  enableEmailOTP: z.boolean(),
+  authenticationType: z.string(),
+  isDeliveryFailed: z.boolean(),
+  isViewed: z.boolean(),
+  order: z.number(),
+  signerType: z.string(),
+  hostEmail: z.string(),
+  hostName: z.string(),
+  isReassigned: z.boolean(),
+  privateMessage: z.string(),
+  allowFieldConfiguration: z.boolean(),
+  idVerification: IdVerificationSchema,
+  formFields: z.array(DocumentFormFieldSchema),
+  language: z.number(),
+  locale: z.string(),
+  recipientNotificationSettings: RecipientNotificationSettingsSchema,
+  authenticationRetryCount: z.number().nullable(),
+});
+
+const SenderDetailSchema = z.object({
+  name: z.string(),
+  privateMessage: z.null(),
+  emailAddress: z.string(),
+  isViewed: z.boolean(),
+});
+
+const FileSchema = z.object({
+  documentName: z.string(),
+  order: z.number(),
+  pageCount: z.number(),
+});
+
+const ReminderSettingsSchema = z.object({
+  enableAutoReminder: z.boolean(),
+  reminderDays: z.number(),
+  reminderCount: z.number(),
+});
+
+const DocumentHistorySchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.string(),
+  toName: z.string(),
+  toEmail: z.string(),
+  ipaddress: z.string(),
+  action: z.string(),
+  timestamp: z.number(),
+});
+
+const DocumentSchema = z.object({
+  documentId: z.string(),
+  brandId: z.string(),
+  messageTitle: z.string(),
+  documentDescription: z.string(),
+  status: z.string(),
+  files: z.array(FileSchema),
+  senderDetail: SenderDetailSchema,
+  signerDetails: z.array(SignerDetailSchema),
+  behalfOf: z.null(),
+  ccDetails: z.array(z.any()),
+  reminderSettings: ReminderSettingsSchema,
+  reassign: z.array(z.any()),
+  documentHistory: z.array(DocumentHistorySchema),
+  activityBy: z.string(),
+  activityDate: z.number(),
+  activityAction: z.string(),
+  createdDate: z.number(),
+  expiryDays: z.number(),
+  expiryDate: z.null(),
+  enableSigningOrder: z.boolean(),
+  isDeleted: z.boolean(),
+  revokeMessage: z.string(),
+  declineMessage: z.string(),
+  applicationId: z.string(),
+  labels: z.array(z.any()),
+  disableEmails: z.boolean(),
+  disableExpiryAlert: z.boolean(),
+  hideDocumentId: z.boolean(),
+  enablePrintAndSign: z.boolean(),
+  enableReassign: z.boolean(),
+  recipientNotificationSettings: RecipientNotificationSettingsSchema,
+  scheduledSendTime: z.number(),
+});
+
+export type DocumentSchema = z.infer<typeof DocumentSchema>;
+
+export const TemplateZod = z.object({
+  documentId: z.string(),
+  templateName: z.string(),
+});
+export type TemplateZod = z.infer<typeof TemplateZod>;
+
+export const PageDetailZod = z.object({
+  totalRecordsCount: z.number(),
+  pageSize: z.number(),
+  totalPages: z.number(),
+  page: z.number(),
+});
+export type PageDetail = z.infer<typeof PageDetailZod>;
+
+export const TemplatesPaginatedZod = z.object({
+  items: z.array(TemplateZod),
+  meta: IPaginationMeta,
+});
+export type TemplatesPaginatedZod = z.infer<typeof TemplatesPaginatedZod>;
+export type SignerDetailSchema = z.infer<typeof SignerDetailSchema>;
+
+export const SignerTemplateSchema = z.object({
+  id: z.string(),
+  tid: z.string().max(255),
+  name: z.string().max(255).nullable(),
+  type: z.nativeEnum(TemplateType),
+  status: z.nativeEnum(TemplateStatus),
+  complianceStatus: z.nativeEnum(ComplianceReview),
+  log: z.string().nullable(),
+});
+
+export type SignerTemplateZod = z.infer<typeof SignerTemplateSchema>;
+
+export const SignerTemplatesPaginatedZod = z.object({
+  items: z.array(SignerTemplateSchema),
+  meta: IPaginationMeta,
+});
+export type SignerTemplatesPaginatedZod = z.infer<
+  typeof SignerTemplatesPaginatedZod
+>;
+
+export const SignerBrandSchema = z.object({
+  id: z.string(),
+  tid: z.string(),
+  brandName: z.string().nullable(),
+  brandLogoId: z.string().nullable(),
+  backgroundColor: z.string().nullable(),
+  buttonColor: z.string().nullable(),
+  buttonTextColor: z.string().nullable(),
+  complianceStatus: z.nativeEnum(ComplianceReview),
+});
+export type SignerBrandZod = z.infer<typeof SignerBrandSchema>;
+
+export const SignerBrandsPaginatedZod = z.object({
+  items: z.array(SignerBrandSchema),
+  meta: IPaginationMeta,
+});
+export type SignerBrandsPaginatedZod = z.infer<typeof SignerBrandsPaginatedZod>;
+
+export const SignerSenderIdentitySchema = z.object({
+  id: z.string(),
+  name: z.string().nullable(),
+  email: z.string().nullable(),
+  status: z.nativeEnum(SenderIdentityStatus),
+  complianceStatus: z.nativeEnum(ComplianceReview),
+});
+export type SignerSenderIdentityZod = z.infer<
+  typeof SignerSenderIdentitySchema
+>;
+
+export const SignerSenderIdentitiesPaginatedZod = z.object({
+  items: z.array(SignerSenderIdentitySchema),
+  meta: IPaginationMeta,
+});
+export type SignerSenderIdentitiesPaginatedZod = z.infer<
+  typeof SignerSenderIdentitiesPaginatedZod
+>;
+
+export const ValidatedTemplateResponse = z.object({
+  templateId: z.string().min(1).max(36),
+  errorMessage: z.string().min(1).max(255).optional(),
+  requiredVariables: z.record(z.string(), z.string()).optional(),
+  additionalVariables: z.record(z.string(), z.string()).optional(),
+  configCheck: z.string().min(1).max(5),
+});
+export type ValidatedTemplateResponse = z.infer<
+  typeof ValidatedTemplateResponse
+>;
+
+export const ValidatedTemplatesResponse = z.array(ValidatedTemplateResponse);
+export type ValidatedTemplatesResponse = z.infer<
+  typeof ValidatedTemplatesResponse
+>;
+
+export const TemplatePathParams = z.object({
+  templateId: z.string().min(1).max(36),
+});
+export type TemplatePathParams = z.infer<typeof TemplatePathParams>;
+
+export const brandIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'signer_brand';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid brand ID format. Must be a valid TypeID with "signer_brand" prefix. ex: signer_brand_00041061050r3gg28a1c60t3gf',
+  },
+);
+
+export const BrandPathParams = z.object({
+  id: brandIdSchema,
+});
+export type BrandPathParams = z.infer<typeof BrandPathParams>;
+
+export const senderIdentityIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'signer_sender_identity';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid sender identity ID format. Must be a valid TypeID with "signer_sender_identity" prefix. ex: signer_sender_identity_00041061050r3gg28a1c60t3gf',
+  },
+);
+
+export const SenderIdentityPathParams = z.object({
+  id: senderIdentityIdSchema,
+});
+export type SenderIdentityPathParams = z.infer<typeof SenderIdentityPathParams>;
+
+const BrandSchema = z.object({
+  brandId: z.string().uuid(),
+  brandLogo: z.string(),
+  brandName: z.string(),
+  backgroundColor: z.string(),
+  buttonColor: z.string(),
+  buttonTextColor: z.string(),
+  emailDisplayName: z.string(),
+  disclaimerTitle: z.string(),
+  disclaimerDescription: z.string(),
+  redirectUrl: z.string().url(),
+  isDefault: z.boolean(),
+  canHideTagLine: z.boolean(),
+  combineAuditTrail: z.boolean(),
+  emailSignedDocument: z.string(),
+  documentTimeZone: z.string(),
+  showBuiltInFormFields: z.boolean(),
+  allowCustomFieldCreation: z.boolean(),
+  showSharedCustomFields: z.boolean(),
+  hideDecline: z.boolean(),
+  hideSave: z.boolean(),
+  excludeAuditTrailFromEmail: z.boolean(),
+
+  documentExpirySettings: z.object({
+    expiryDateType: z.string(),
+    expiryValue: z.number(),
+    enableDefaultExpiryAlert: z.boolean(),
+    enableAutoReminder: z.boolean(),
+    reminderDays: z.number(),
+    reminderCount: z.number(),
+  }),
+
+  customDomainSettings: z.object({
+    domainName: z.string(),
+    fromName: z.string(),
+  }),
+
+  isDomainVerified: z.boolean(),
+});
+export type BrandSchema = z.infer<typeof BrandSchema>;
+
+export const UpdateSignerTemplateZod = z.object({
+  complianceStatus: z.nativeEnum(ComplianceReview).optional(),
+});
+export type UpdateSignerTemplateZod = z.infer<typeof UpdateSignerTemplateZod>;
+
+export const CreateSignerBrandZod = z.object({
+  brandName: z.string().min(1).max(255),
+  emailDisplayName: z.string().min(1).max(255),
+  backgroundColor: z.string().min(1).max(7),
+  buttonColor: z.string().min(1).max(7),
+  buttonTextColor: z.string().min(1).max(7),
+  accountId: z.string().min(1),
+});
+export type CreateSignerBrandZod = z.infer<typeof CreateSignerBrandZod>;
+
+export const UpdateSignerBrandZod = z.object({
+  brandName: z.string().min(1).max(255).optional(),
+  brandLogoId: z.string().min(1).optional(),
+  emailDisplayName: z.string().min(1).max(255).optional(),
+  backgroundColor: z.string().min(1).max(7).optional(),
+  buttonColor: z.string().min(1).max(7).optional(),
+  buttonTextColor: z.string().min(1).max(7).optional(),
+  complianceStatus: z.nativeEnum(ComplianceReview).optional(),
+});
+export type UpdateSignerBrandZod = z.infer<typeof UpdateSignerBrandZod>;
+
+export const CreateSignerSenderIdentityZod = z.object({
+  name: z.string().min(1).max(255),
+  email: z.string().email().openapi({ example: 'test@test.com' }),
+});
+export type CreateSignerSenderIdentityZod = z.infer<
+  typeof CreateSignerSenderIdentityZod
+>;
+
+export const UpdateSignerSenderIdentityZod = z.object({
+  name: z.string().min(1).max(255).optional(),
+  email: z.string().email().openapi({ example: 'test@test.com' }).optional(),
+  complianceStatus: z.nativeEnum(ComplianceReview).optional(),
+  status: z.nativeEnum(SenderIdentityStatus).optional(),
+});
+export type UpdateSignerSenderIdentityZod = z.infer<
+  typeof UpdateSignerSenderIdentityZod
+>;
+
+export const DocumentRecipientChangeBody = z.object({
+  newSignerName: z.string().min(1).max(255),
+  reason: z.string().min(1).max(255),
+  newSignerEmail: z.string().min(1).max(255),
+  oldSignerEmail: z.string().min(1).max(255),
+  order: z.number().optional(), // optional if not always provided
+});
+export type DocumentRecipientChangeBody = z.infer<
+  typeof DocumentRecipientChangeBody
+>;
+
+export const SignerPaginationQuery = PaginationOptionsZod.merge(
+  z.object({
+    status: z.nativeEnum(ComplianceReview).optional(),
+  }),
+);