@postpaybr/contracts 1.0.1

package/enums/account-entry.enum.ts

@@ -0,0 +1,4 @@
+export enum AccountEntryTypeEnum {
+  CREDIT = 'CREDIT',
+  DEBIT = 'DEBIT',
+}

package/enums/anticipation.enum.ts

@@ -0,0 +1,7 @@
+export enum AnticipationStatusEnum {
+  PENDING = 'PENDING',
+  PROCESSING = 'PROCESSING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+  CANCELLED = 'CANCELLED',
+}

package/enums/bank-account.enum.ts

@@ -0,0 +1,12 @@
+export enum BankAccountTypeEnum {
+  CURRENT_ACCOUNT = 'CURRENT_ACCOUNT',
+}
+
+export type BankAccountType = `${BankAccountTypeEnum}`;
+
+export enum HolderTypeEnum {
+  INDIVIDUAL = 'INDIVIDUAL',
+  COMPANY = 'COMPANY',
+}
+
+export type HolderType = `${HolderTypeEnum}`;

package/enums/charge-status.enum.ts

@@ -0,0 +1,28 @@
+export enum ChargeStatusEnum {
+  LIQUIDATED = 'LIQUIDATED',
+  PENDING = 'PENDING',
+
+  CREATED = 'CREATED',
+  SCHEDULED = 'SCHEDULED',
+  PRE_AUTHORIZED = 'PRE_AUTHORIZED',
+  NOT_AUTHORIZED = 'NOT_AUTHORIZED',
+  AUTHORIZED = 'AUTHORIZED',
+
+  CONFIRMED = 'CONFIRMED',
+  FAILED = 'FAILED',
+  ERROR = 'ERROR',
+
+  CANCELLED = 'CANCELLED',
+  REFUNDED = 'REFUNDED',
+  REFUND_REQUESTED = 'REFUND_REQUESTED',
+  REFUND_IN_PROGRESS = 'REFUND_IN_PROGRESS',
+  REFUND_REJECTED = 'REFUND_REJECTED',
+  CHARGEBACK = 'CHARGEBACK',
+
+  MED = 'MED',
+}
+
+export enum ChargeTypeEnum {
+  STANDARD = 'STANDARD',
+  CARD_VERIFICATION = 'CARD_VERIFICATION',
+}

package/enums/customer.enum.ts

@@ -0,0 +1,40 @@
+export enum VerificationStatusEnum {
+  PENDING = 'PENDING',
+  IN_PROGRESS = 'IN_PROGRESS',
+  REJECTED = 'REJECTED',
+  APPROVED = 'APPROVED',
+}
+
+export enum DocumentRejectionReasonEnum {
+  FAILED_CHALLENGE = 'FAILED_CHALLENGE',
+  DOCUMENT_WITHOUT_PHOTO = 'DOCUMENT_WITHOUT_PHOTO',
+  FACE_OR_DOCUMENT_INVISIBLE = 'FACE_OR_DOCUMENT_INVISIBLE',
+  DOCUMENT_NOT_IN_HAND = 'DOCUMENT_NOT_IN_HAND',
+  UNREADABLE_PHOTOS = 'UNREADABLE_PHOTOS',
+  INCOMPATIBLE_DATA = 'INCOMPATIBLE_DATA',
+  DIFFERENT_DOCUMENTS = 'DIFFERENT_DOCUMENTS',
+  OTHER = 'OTHER',
+}
+
+export enum CardRejectionReasonEnum {
+  FAILED_CHALLENGE = 'FAILED_CHALLENGE',
+  FACE_OR_CARD_INVISIBLE = 'FACE_OR_CARD_INVISIBLE',
+  MISSING_CARD = 'MISSING_CARD',
+  UNREADABLE_PHOTO = 'UNREADABLE_PHOTO',
+  DIFFERENT_CARD = 'DIFFERENT_CARD',
+  PERSON_MISMATCH = 'PERSON_MISMATCH',
+  CARD_BACK_REQUIRED = 'CARD_BACK_REQUIRED',
+  OTHER = 'OTHER',
+}
+
+export enum CardChallengeEnum {
+  HOLD_BELOW_FACE = 'HOLD_BELOW_FACE',
+  HOLD_ABOVE_FACE = 'HOLD_ABOVE_FACE',
+  HOLD_NEXT_TO_FACE = 'HOLD_NEXT_TO_FACE',
+}
+
+export enum AccountLevelEnum {
+  BRONZE = 'BRONZE',
+  SILVER = 'SILVER',
+  GOLD = 'GOLD',
+}

package/enums/email.enum.ts

@@ -0,0 +1,11 @@
+export enum Templates {
+  ADMINISTRATOR_CHANGE_PASSWORD = 'administrator-change-password',
+  ADMINISTRATOR_CREATED = 'administrator-created',
+  CHANGE_EMAIL = 'change-email',
+  CONGRATULATIONS = 'congratulations',
+  KYC_EMAIL = 'kyc-email',
+  RECOVERY_PASSWORD = 'recovery-password',
+  REJECTED_DOCUMENT = 'rejected-document',
+  VALIDATED_DOCUMENT = 'validated-document',
+  VERIFICATION = 'verification',
+}

package/enums/failure-reason.enum.ts

@@ -0,0 +1,7 @@
+export enum FailureReasonEnum {
+  PROVIDERS_UNAVAILABLE = 'PROVIDERS_UNAVAILABLE',
+  TIME_EXPIRED = 'TIME_EXPIRED',
+  INVALID_DATA = 'INVALID_DATA',
+  LIMIT_EXCEEDED = 'LIMIT_EXCEEDED',
+  UNKNOWN = 'UNKNOWN',
+}

package/enums/gateway-identification.enum.ts

@@ -0,0 +1,7 @@
+export enum GatewayIdentificationEnum {
+  ASAAS = 'ASAAS',
+  SICOOB = 'SICOOB',
+  SICREDI = 'SICREDI',
+  RAKIM = 'RAKIM',
+  MOCK = 'MOCK',
+}

package/enums/index.ts

@@ -0,0 +1,16 @@
+export * from './account-entry.enum';
+export * from './anticipation.enum';
+export * from './bank-account.enum';
+export * from './charge-status.enum';
+export * from './customer.enum';
+export * from './email.enum';
+export * from './failure-reason.enum';
+export * from './gateway-identification.enum';
+export * from './notification.enum';
+export * from './orders-status.enum';
+export * from './payable-status.enum';
+export * from './payment.enum';
+export * from './recipient.enum';
+export * from './role.enum';
+export * from './tax.enum';
+export * from './user-status.enum';

package/enums/notification.enum.ts

@@ -0,0 +1,14 @@
+export enum NotificationCategoryEnum {
+  PAYMENT = 'PAYMENT',
+  PROFILE = 'PROFILE',
+  MARKETING = 'MARKETING',
+  SECURITY = 'SECURITY',
+  INFORMATION = 'INFORMATION',
+  ANNOUNCEMENT = 'ANNOUNCEMENT',
+}
+
+export enum NotificationImageTypeEnum {
+  STATIC = 'STATIC',
+  SVG = 'SVG',
+  ANIMATED = 'ANIMATED',
+}

package/enums/orders-status.enum.ts

@@ -0,0 +1,10 @@
+export enum OrderStatusEnum {
+  PENDING = 'PENDING',
+  CONFIRMED = 'CONFIRMED',
+  FAILED = 'FAILED',
+}
+
+export enum OrderTypeEnum {
+  IMMEDIATE = 'IMMEDIATE',
+  SCHEDULED = 'SCHEDULED',
+}

package/enums/payable-status.enum.ts

@@ -0,0 +1,7 @@
+export enum PayableStatusEnum {
+  PENDING = 'PENDING',
+  PROCESSING = 'PROCESSING',
+  TRANSFERRED = 'TRANSFERRED',
+  FAILED = 'FAILED',
+  CANCELLED = 'CANCELLED',
+}

package/enums/payment.enum.ts

@@ -0,0 +1,11 @@
+export enum PaymentMethodsEnum {
+  PIX = 'PIX',
+  CREDIT_CARD = 'CREDIT_CARD',
+  DEBIT_CARD = 'DEBIT_CARD',
+}
+
+export enum PaymentScheduleEnum {
+  CUSTOM_DATE = 'custom',
+  ON_DUE_DATE = 'dueAt',
+  IMMEDIATE = 'today',
+}

package/enums/recipient.enum.ts

@@ -0,0 +1,32 @@
+export enum RecipientTypeEnum {
+  CUSTOMER = 'CUSTOMER',
+  ADMINISTRATOR = 'ADMINISTRATOR',
+}
+
+export type RecipientType = `${RecipientTypeEnum}`;
+
+export enum RecipientLegalTypeEnum {
+  SA = 'SA',
+  LTDA = 'LTDA',
+  MEI = 'MEI',
+  ME = 'ME',
+  EPP = 'EPP',
+  EIRELI = 'EIRELI',
+}
+
+export type RecipientLegalType = `${RecipientLegalTypeEnum}`;
+
+export enum ProviderStatusEnum {
+  ACTIVE = 'ACTIVE',
+  DELETED = 'DELETED',
+  INACTIVE = 'INACTIVE',
+  WAITING = 'WAITING',
+  REJECTED = 'REJECTED',
+}
+
+export type ProviderStatus = `${ProviderStatusEnum}`;
+
+export enum ProviderAction {
+  UPDATE_PROVIDER = 'UPDATE_PROVIDER',
+  NO_ACTION = 'NO_ACTION',
+}

package/enums/role.enum.ts

@@ -0,0 +1,44 @@
+export enum Action {
+  Manage = 'manage',
+  Create = 'create',
+  Read = 'read',
+  Update = 'update',
+  Delete = 'delete',
+  Enable = 'enable',
+  Disable = 'disable',
+  Resolve = 'resolve',
+}
+
+export enum Permission {
+  readDashboard = 'READ_DASHBOARD',
+
+  manageSupportTickets = 'MANAGE_SUPPORT_TICKETS',
+  readCustomerData = 'READ_CUSTOMER_DATA',
+  resolveIssues = 'RESOLVE_ISSUES',
+
+  updateInvoices = 'UPDATE_INVOICES',
+  managePayments = 'MANAGE_PAYMENTS',
+  readFinancialReports = 'READ_FINANCIAL_REPORTS',
+
+  manageCreditApplications = 'MANAGE_CREDIT_APPLICATIONS',
+  readCreditHistory = 'READ_CREDIT_HISTORY',
+  updateCreditLimits = 'UPDATE_CREDIT_LIMITS',
+
+  manageSystemSettings = 'MANAGE_SYSTEM_SETTINGS',
+  readAuditLogs = 'READ_AUDIT_LOGS',
+  manageUserAccounts = 'MANAGE_USER_ACCOUNTS',
+
+  manageReceivedPayments = 'MANAGE_RECEIVED_PAYMENTS',
+  updateAccounts = 'UPDATE_ACCOUNTS',
+  createFinancialStatements = 'CREATE_FINANCIAL_STATEMENTS',
+
+  manageTaxDocuments = 'MANAGE_TAX_DOCUMENTS',
+  createTaxReturns = 'CREATE_TAX_RETURNS',
+  createTaxReports = 'CREATE_TAX_REPORTS',
+
+  createRecipientFee = 'CREATE_RECIPIENT_FEE',
+  updateRecipientFee = 'UPDATE_RECIPIENT_FEE',
+  readRecipientFee = 'READ_RECIPIENT_FEE',
+  deleteRecipientFee = 'DELETE_RECIPIENT_FEE',
+  manageRecipientFee = 'MANAGE_RECIPIENT_FEE',
+}

package/enums/tax.enum.ts

@@ -0,0 +1,23 @@
+enum TaxTypesEnum {
+  IPTU = 'IPTU',
+  TCRS = 'TCRS',
+  ITBI = 'ITBI',
+  IPVA = 'IPVA',
+  LICENSING = 'LICENSING',
+  WASTE_COLLECTION = 'WASTE_COLLECTION',
+  SANITATION = 'SANITATION',
+}
+
+enum TaxStatusEnum {
+  PAID = 'PAID',
+  PROCESSING = 'PROCESSING',
+  PENDING = 'PENDING',
+  OVERDUE = 'OVERDUE',
+}
+
+enum MetaEnum {
+  PROPERTY = 'PROPERTY',
+  VEHICLE = 'VEHICLE',
+}
+
+export { TaxTypesEnum, TaxStatusEnum, MetaEnum };

package/enums/user-status.enum.ts

@@ -0,0 +1,9 @@
+enum UserStatusEnum {
+  ACTIVE = 'ACTIVE',
+  INACTIVE = 'INACTIVE',
+  BLOCKED = 'BLOCKED',
+}
+
+type UserStatus = `${UserStatusEnum}`;
+
+export { UserStatusEnum, UserStatus };

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@postpaybr/contracts",
+  "version": "1.0.1",
+  "type": "module",
+  "main": "index.ts",
+  "types": "index.ts",
+  "files": [
+    "types",
+    "enums"
+  ],
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./types": "./types/index.ts",
+    "./enums": "./enums/index.ts"
+  }
+}

package/types/account-entry.type.ts

@@ -0,0 +1,3 @@
+import { AccountEntryTypeEnum } from '@common/enums';
+
+export type AccountEntryType = `${AccountEntryTypeEnum}`;

package/types/address.type.ts

@@ -0,0 +1,11 @@
+type Address = {
+  street: string;
+  complement: string;
+  city: string;
+  neighborhood: string;
+  number: string;
+  state: string;
+  zipCode: string;
+};
+
+export type { Address };

package/types/anticipation.type.ts

@@ -0,0 +1,3 @@
+import { AnticipationStatusEnum } from '@common/enums';
+
+export type AnticipationStatus = `${AnticipationStatusEnum}`;

package/types/card.type.ts

@@ -0,0 +1,14 @@
+export enum brandEnum {
+  VISA = 'VISA',
+  MASTERCARD = 'MASTERCARD',
+  ELO = 'ELO',
+  DISCOVER = 'DISCOVER',
+  AMERICAN_EXPRESS = 'AMERICAN_EXPRESS',
+  HIPERCARD = 'HIPERCARD',
+  MASTERCARD_MAESTRO = 'MASTERCARD_MAESTRO',
+  VISA_ELECTRON = 'VISA_ELECTRON',
+  PIX = 'PIX',
+  BOLETO = 'BOLETO',
+}
+
+export type brandType = `${brandEnum}`;

package/types/charge-metadata.type.ts

@@ -0,0 +1,43 @@
+import { GatewayIdentificationEnum } from '@common/enums';
+import { ExtractAnalyticsItemDto } from '@payment/modules/charge/consumers/dtos';
+import { ReceivingCreatePayloadDto } from '@payment-processing/modules';
+
+import {
+  PaymentSplitCreatePayloadDto,
+  PaymentCreatePayloadDto,
+} from '@common/dtos/service-payment-processing/card';
+
+import { FailureReason } from './failure-reason.type';
+import { PaymentMethods } from './payment.type';
+
+export type GatewayRequestPayload =
+  | PaymentSplitCreatePayloadDto
+  | PaymentCreatePayloadDto
+  | ReceivingCreatePayloadDto;
+
+export interface GatewaySpecificMeta {
+  responsePayload?: {
+    authorization?: string | null;
+    nsu?: string | null;
+    fees?: number | null;
+    liquid?: number | null;
+    [key: string]: unknown;
+  };
+  liquidationPayload?: ExtractAnalyticsItemDto;
+  failureDetails?: string | null;
+  failureReason?: FailureReason | null;
+  isRetry?: boolean;
+  [key: string]: unknown;
+}
+
+export interface PreviousPaymentData {
+  amount: number;
+  paymentMethod: PaymentMethods;
+  installments?: number | null;
+  installmentValue?: number | null;
+}
+
+export type ChargeMetadata = {
+  requestPayload: GatewayRequestPayload;
+  previousPaymentData?: PreviousPaymentData;
+} & Partial<Record<Lowercase<GatewayIdentificationEnum>, GatewaySpecificMeta>>;

package/types/charge-schedule.type.ts

@@ -0,0 +1,11 @@
+type JobWithDetail = {
+  id: string;
+  createdAt: number;
+  jobData: string;
+  jobState: 'waiting' | 'active' | 'completed' | 'failed' | 'delayed';
+  duration: number;
+  jobResult: string;
+  queueName: string;
+};
+
+export type { JobWithDetail };

package/types/charge.type.ts

@@ -0,0 +1,11 @@
+import { ChargeStatusEnum, ChargeTypeEnum } from '@common/enums';
+
+export type ChargeStatus = `${ChargeStatusEnum}`;
+export type ChargeType = `${ChargeTypeEnum}`;
+
+export type ChargeSummaryStatus =
+  | 'PENDING'
+  | 'PROCESSING'
+  | 'SCHEDULED'
+  | 'LIQUIDATED'
+  | 'CANCELLED';

package/types/core.type.ts

@@ -0,0 +1,7 @@
+import { GatewayIdentification } from './gateway-identification.type';
+
+export interface RoutingInfo {
+  routingKey: string;
+  pixKey: string;
+  gatewayId: GatewayIdentification;
+}

package/types/customer.type.ts

@@ -0,0 +1,14 @@
+import {
+  AccountLevelEnum,
+  CardChallengeEnum,
+  CardRejectionReasonEnum,
+  DocumentRejectionReasonEnum,
+  VerificationStatusEnum,
+} from '@common/enums';
+
+export type AccountLevel = `${AccountLevelEnum}`;
+export type CardRejectionReason = `${CardRejectionReasonEnum}`;
+
+export type DocumentRejectionReason = `${DocumentRejectionReasonEnum}`;
+export type VerificationStatus = `${VerificationStatusEnum}`;
+export type CardChallenge = `${CardChallengeEnum}`;

package/types/environment.type.ts

@@ -0,0 +1,8 @@
+export type Environment =
+  | 'local'
+  | 'dev'
+  | 'sandbox'
+  | 'staging'
+  | 'live'
+  | 'integration'
+  | 'e2e';

package/types/failure-reason.type.ts

@@ -0,0 +1,3 @@
+import { FailureReasonEnum } from '@common/enums';
+
+export type FailureReason = `${FailureReasonEnum}`;

package/types/fee.type.ts

@@ -0,0 +1 @@
+export type FeeType = 'MIXED' | 'FIXED';

package/types/gateway-identification.type.ts

@@ -0,0 +1,3 @@
+import { GatewayIdentificationEnum } from '@common/enums';
+
+export type GatewayIdentification = `${GatewayIdentificationEnum}`;

package/types/health-check-plugin.type.ts

@@ -0,0 +1,11 @@
+type HealthCheckPlugin = {
+  name: string;
+  check: () => Promise<{
+    name: string;
+    status: string;
+    details?: any;
+    error?: string;
+  }>;
+};
+
+export type { HealthCheckPlugin };

package/types/index.ts

@@ -0,0 +1,25 @@
+export * from './account-entry.type';
+export * from './address.type';
+export * from './anticipation.type';
+export * from './card.type';
+export * from './charge-metadata.type';
+export * from './charge.type';
+export * from './core.type';
+export * from './customer.type';
+export * from './environment.type';
+export * from './failure-reason.type';
+export * from './fee.type';
+export * from './gateway-identification.type';
+export * from './health-check-plugin.type';
+export * from './notification.type';
+export * from './order.type';
+export * from './payable.type';
+export * from './payment-provider.type';
+export * from './role.type';
+export * from './charge-schedule.type';
+export * from './payment-service.type';
+export * from './receipt.type';
+export * from './payment.type';
+export * from './tax.type';
+export * from './receipt-metadata.type';
+export * from './user.type';

package/types/notification.type.ts

@@ -0,0 +1,48 @@
+import {
+  NotificationCategoryEnum,
+  NotificationImageTypeEnum,
+} from '@common/enums';
+
+export type NotificationImageType = `${NotificationImageTypeEnum}`;
+export type NotificationCategory = `${NotificationCategoryEnum}`;
+
+export type ChangesFieldType = 'FIRST_NAME' | 'LAST_NAME' | 'EMAIL' | 'PHONE';
+
+export interface NotificationMetadata {
+  callToAction?: string;
+  actionButtonVariant?: 'default' | 'ghost';
+  actionLabel?: string;
+  url?: string;
+
+  deviceInfo?: string;
+  location?: string;
+  eventDate?: Date;
+  securityAction?: string;
+
+  changes?: {
+    field: ChangesFieldType;
+    oldValue: string;
+    newValue: string;
+  }[];
+
+  startDate?: Date;
+  endDate?: Date;
+  impactDescription?: string;
+
+  updateReason?: string;
+  changePoints?: {
+    title: string;
+    description: string;
+  }[];
+
+  receiptId?: string;
+  chargeId?: string;
+  taxId?: string;
+
+  userId?: string;
+  scheduledPaymentDate?: Date;
+  paymentAmount?: number;
+  paymentStatus?: string;
+  paymentMethod?: string;
+  params?: Record<string, any>;
+}

package/types/order.type.ts

@@ -0,0 +1,4 @@
+import { OrderStatusEnum, OrderTypeEnum } from '@common/enums';
+
+export type OrderStatus = `${OrderStatusEnum}`;
+export type OrderType = `${OrderTypeEnum}`;

package/types/payable.type.ts

@@ -0,0 +1,3 @@
+import { PayableStatusEnum } from '@common/enums';
+
+export type PayableStatus = `${PayableStatusEnum}`;

package/types/payment-provider.type.ts

@@ -0,0 +1,22 @@
+import { PaymentMethods } from './payment.type';
+
+export enum PaymentGatewayTypeEnum {
+  PRIMARY = 'PRIMARY',
+  SECONDARY = 'SECONDARY',
+}
+
+export type PaymentGatewayType = `${PaymentGatewayTypeEnum}`;
+
+export type PaymentProviderInfo = {
+  id: string;
+  code: string;
+  name: string;
+  method: PaymentMethods;
+};
+
+export enum OperationTypeEnum {
+  PAYMENT = 'PAYMENT',
+  RECEIVING = 'RECEIVING',
+}
+
+export type OperationType = `${OperationTypeEnum}`;

package/types/payment-service.type.ts

@@ -0,0 +1,18 @@
+import { OrderEntity } from '@order/database/entities/order.entity';
+import { TaxEntity } from '@tax/database';
+
+import { PaymentDetailsDto } from '@common/dtos/service-context';
+
+import { RoutingInfo } from './core.type';
+import { OrderType } from './order.type';
+
+export interface PaymentContext {
+  customerId: string;
+  payment: PaymentDetailsDto;
+  taxes: TaxEntity[];
+  order: OrderEntity;
+  orderType?: OrderType;
+  pushToken: string;
+  routingInfo: RoutingInfo;
+  firstRecipientId?: string;
+}

package/types/payment.type.ts

@@ -0,0 +1,15 @@
+import { PaymentScheduleEnum } from '@common/enums';
+
+type PaymentMethods = 'PIX' | 'CREDIT_CARD' | 'DEBIT_CARD';
+type NonPixPaymentMethods = Exclude<PaymentMethods, 'PIX'>;
+
+export enum PaymentVariantEnum {
+  SCHEDULED = 'SCHEDULED',
+  IMMEDIATE = 'IMMEDIATE',
+}
+
+export type PaymentScheduleType = `${PaymentScheduleEnum}`;
+
+type PaymentVariant = `${PaymentVariantEnum}`;
+
+export type { PaymentMethods, NonPixPaymentMethods, PaymentVariant };

package/types/receipt-metadata.type.ts

@@ -0,0 +1,16 @@
+import {
+  NfseCancelSuccessDto,
+  NfseCreatedSuccessDto,
+} from '@payment/modules/receipt/consumers/dtos';
+
+import { CreateNfseDto } from '@common/dtos/service-payment';
+
+export type ReceiptMetadata = {
+  requestPayload?: CreateNfseDto;
+  responsePayload?: NfseCreatedSuccessDto;
+  cancelResponsePayload?: NfseCancelSuccessDto;
+  errorDetails?: string;
+  createAttempts?: number;
+  cancelAttempts?: number;
+  lastErrorAt?: string;
+};

package/types/receipt.type.ts

@@ -0,0 +1,34 @@
+import { ChargeStatus } from './charge.type';
+import { PaymentMethods } from './payment.type';
+import { TaxTypes } from './tax.type';
+
+type PaymentSummary = {
+  totalPaymentsMade?: number;
+  totalScheduledPayments?: number;
+  timestamp: string;
+};
+
+type IndividualPayment = {
+  id: string;
+  createdAt: Date;
+  status: ChargeStatus;
+  paymentMethod: PaymentMethods;
+  propertyDocument: string;
+  propertyDetail: string;
+  amount?: number;
+  installmentNumber: number;
+  installmentValue: number;
+  schedule?: {
+    executionDate: Date;
+    isExecuted: boolean;
+  };
+  taxType: TaxTypes;
+};
+
+type PaymentSummaryPreview = {
+  summary: PaymentSummary;
+  paymentsMade?: IndividualPayment[];
+  scheduledPayments?: IndividualPayment[];
+};
+
+export type { PaymentSummaryPreview, PaymentSummary, IndividualPayment };

package/types/role.type.ts

@@ -0,0 +1,9 @@
+import { Permission } from '@common/enums';
+
+interface PermissionGroup {
+  group: string;
+  description: string;
+  permissions: Permission[];
+}
+
+export type { PermissionGroup };

package/types/service-card-vault.type.ts

@@ -0,0 +1,26 @@
+type GetTokenizedCardEnigma = {
+  firstSix: string;
+  lastFour: string;
+  ccn?: string;
+  expMonth: number;
+  expYear: number;
+  fullName: string;
+  cardType: string;
+  token: string;
+  cvvTtl: number;
+  ttl: number;
+};
+
+type CardDetailsPayload = {
+  token: string;
+  tokenCvv: string;
+};
+
+type EnigmaToken = {
+  access_token: string;
+  token_type: string;
+  expires_in: number;
+  scope: string;
+};
+
+export { CardDetailsPayload, GetTokenizedCardEnigma, EnigmaToken };

package/types/tax.type.ts

@@ -0,0 +1,93 @@
+import { TaxStatusEnum, TaxTypesEnum } from '@common/enums';
+
+import { Address } from './address.type';
+
+type TaxTypes = `${TaxTypesEnum}`;
+type TaxStatus = `${TaxStatusEnum}`;
+type MetaType = 'PROPERTY' | 'VEHICLE';
+
+type Tax = {
+  id: string;
+  type: TaxTypes;
+  description: string;
+  year: number;
+  documentId: string;
+};
+
+type Payer = {
+  name: string;
+  document: string;
+  phone?: string;
+};
+
+type locationInfo = {
+  state: number;
+  city: number;
+  recipientId: string;
+};
+
+type TaxItem = {
+  id: string;
+  code: string;
+  quota: number;
+  dueAt: string;
+  amount: number;
+  isSingleQuota: boolean;
+  status: TaxStatus;
+  discountPercentage: number;
+  discountAmount: number;
+  fee: number;
+  fine: number;
+};
+
+type Property = {
+  address?: Address;
+  documentId?: string | undefined;
+};
+
+type Vehicle = {
+  licensePlate?: string;
+  model?: string;
+  yearManufacture?: number;
+  renavam?: string;
+};
+
+export type Meta = Property | Vehicle;
+
+type TaxDetail = {
+  tax: Tax;
+  payer: Payer;
+  location: locationInfo;
+  metaType: MetaType;
+  meta: Meta | undefined;
+  items: TaxItem[];
+};
+
+type TaxDueDate = {
+  id: string;
+  dueDate: string;
+};
+
+type PropertyDetail = {
+  property: Property;
+  payer: Payer;
+  taxTypes: Set<TaxTypes> | TaxTypes[];
+  pendingTaxesAmount?: number;
+  paidTaxesAmount?: number;
+  overdueTaxesAmount?: number;
+  lastPaidTaxDate?: string | null;
+  nextDueDate?: string | null;
+  nearDueTaxesDates?: TaxDueDate[];
+  overdueTaxesDates?: TaxDueDate[];
+  receiptId: string | null;
+};
+
+export type {
+  TaxDetail,
+  PropertyDetail,
+  TaxTypes,
+  TaxStatus,
+  Property,
+  Vehicle,
+  MetaType,
+};

package/types/user.type.ts

@@ -0,0 +1,6 @@
+export enum AccountTypeEnum {
+  CUSTOMER = 'CUSTOMER',
+  ADMINISTRATOR = 'ADMINISTRATOR',
+}
+
+export type AccountType = `${AccountTypeEnum}`;