@postpaybr/contracts 1.0.2 → 1.0.3

package/enums/payable-status.enum.ts

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

package/enums/payment.enum.ts

@@ -1,11 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

@@ -1,44 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

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

package/types/address.type.ts

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

package/types/card.type.ts

@@ -1,14 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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/core.type.ts

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

package/types/environment.type.ts

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

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

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

package/types/notification.type.ts

@@ -1,48 +0,0 @@
-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/payment-provider.type.ts

@@ -1,22 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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/receipt-metadata.type.ts

@@ -1,16 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

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

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

@@ -1,26 +0,0 @@
-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 type { CardDetailsPayload, GetTokenizedCardEnigma, EnigmaToken };

package/types/tax.type.ts

@@ -1,97 +0,0 @@
-import { TaxPayload as TaxPayloadDto } from '@common/dtos/service-tax';
-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;
-};
-
-type TaxPayload = TaxPayloadDto;
-
-export type {
-  TaxDetail,
-  PropertyDetail,
-  TaxTypes,
-  TaxStatus,
-  Property,
-  Vehicle,
-  MetaType,
-  TaxPayload,
-};

package/types/user.type.ts

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