@rocketlink/crm-model 1.0.0

package/src/dtos/field.request.dto.ts

@@ -0,0 +1,4 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface FieldsRequest extends PaginatedRequest {
+}

package/src/dtos/hook.request.dto.ts

@@ -0,0 +1,14 @@
+import  { Hook } from "..";
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface HooksRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  event?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+
+export interface HookRequest extends Hook {
+ fieldIds?: number[];
+}

package/src/dtos/hookOutbox.request.dto.ts

@@ -0,0 +1,12 @@
+import { PaginatedRequest } from './common/paginated.request.dto';
+
+export interface HookOutboxesRequest extends PaginatedRequest {
+  id?: number;
+  hookId?: number;
+  campaignId?: number;
+  triggerId?: string;
+  status?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+

package/src/dtos/hookProfile.request.dto.ts

@@ -0,0 +1,7 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface HookProfilesRequest extends PaginatedRequest {
+  id?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/lead.request.dto.ts

@@ -0,0 +1,14 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface LeadsRequest extends PaginatedRequest {
+  id?: number;
+  email?: string;
+  firstName?: string;
+  lastName?: string;
+  visitId?: number;
+  csvRowId?: number;
+  csvId?: number;
+  isCustomer?: boolean;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/mid.request.dto.ts

@@ -0,0 +1,14 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface MidsRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  descriptor?: string;
+  providerAdapterId?: number;
+  currency?: string;
+  gatewayId?: number;
+  providerId?: number;
+  active?: boolean;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/offer.request.dto.ts

@@ -0,0 +1,15 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface OffersRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  type?: string;
+  productId?: number;
+  oneTimePayment?: boolean;
+  price?: string;
+  trialPrice?: string;
+  midId?: number;
+  campaignId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/order.request.dto.ts

@@ -0,0 +1,23 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface OrdersRequest extends PaginatedRequest {
+  id: number;
+  paymentId ?: number;
+  leadId ?: number;
+  leadFirstName?: string
+  leadEmail?: string
+  amount?: string
+  status ?: string;
+  statuses?: string[];
+  leadName ?:string;
+}
+
+export interface OrderItemsRequest extends PaginatedRequest {
+  id?: number;
+  orderId?: number;
+  offerId?: number;
+  currency?: string;
+  price?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/product.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface ProductsRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  categoryId?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/provider.request.dto.ts

@@ -0,0 +1,13 @@
+import type { Provider } from "@/model/gateway.model";
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface ProvidersRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  description?: string;
+  webhookUrl?: string;
+  webhookSecret?: string;
+  webhookToken?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/subscription.request.dto.ts

@@ -0,0 +1,22 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+import { BANKS } from "../model/gateway.model";
+
+export interface SubscriptionsRequest extends PaginatedRequest {
+  id?: number;
+  status?: string;
+  statuses?: string[];
+  username?: string;
+  bankName?: BANKS;
+  email?: string;
+  orderId?: number;
+  offerId?: number;
+  midId?: number;
+  paymentType?: string;
+  leadId?: number;
+  leadName?: string;
+  leadEmail?: string;
+  csvId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+  oneTimePayment?: boolean;
+}

package/src/dtos/transaction.request.dto.ts

@@ -0,0 +1,14 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+import { BANKS } from "../model/gateway.model";
+
+export interface TransactionsRequest extends PaginatedRequest {
+  id?: number;
+  bank?: BANKS;
+  midId?: number;
+  orderId?: number;
+  internalTransactionType?: string;
+  internalTransactionStatus?: string;
+  internalTransactionStatuses?: string[];
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/transactionError.request.dto.ts

@@ -0,0 +1,10 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface TransactionErrorRequest extends PaginatedRequest {
+  id?: number;
+  bank?: string;
+  midId?: number;
+  orderId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/gateways/adapters/dtos/transaction-emp.request.dto.ts

@@ -0,0 +1,22 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionEmp } from "../model/transactionEmp.model";
+
+export interface TransactionsEmpRequest extends PaginatedRequest, Omit<Partial<TransactionEmp>, 'transaction_id'> {
+  email?: string;
+  customerEmail?: string;
+  unique_id?: string;
+  transaction_id?: string;
+  iban_account_no?: string;
+  amount?: string;
+  merchant?: string;
+  paymentType?: string;
+  orderId?: number;
+  midId?: number;
+  reportDateFrom?: string;
+  reportDateTo?: string;
+  statuses?: string[];
+}
+
+export interface TransactionsEmpResponse extends PaginatedResponse<TransactionEmp> {
+}

package/src/gateways/adapters/dtos/transaction-finxp.request.dto.ts

@@ -0,0 +1,23 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionFinXP } from "../model/transactionFinXP.model";
+
+export interface TransactionsFinXPRequest extends PaginatedRequest {
+  id?: number;
+  midId?: number;
+  orderId?: number;
+  status?: string;
+  customerId?: string;
+  customerName?: string;
+  transactionInformation?: string;
+  endToEndId?: string;
+  amount?: string;
+  effectiveDate?: string;
+  merchant?: string;
+  errorCode?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+
+export interface TransactionsFinXPResponse extends PaginatedResponse<TransactionFinXP> {
+}

package/src/gateways/adapters/dtos/transaction-novalnet.request.dto.ts

@@ -0,0 +1,23 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionNovalNet } from "../model/transactionNovalNet.model";
+
+export interface TransactionsNovalNetRequest extends PaginatedRequest, Omit<Partial<TransactionNovalNet>, 'customerNumber' | 'orderNumber'> {
+  midId?: number;
+  orderId?: number;
+  tid?: string;
+  statusDesc?: string;
+  statuses?: string[];
+  statusDescs?: string[];
+  paymentType?: string;
+  amount?: string;
+  customerNumber?: string;
+  orderNumber?: string;
+  firstName?: string;
+  email?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+
+export interface TransactionsNovalNetResponse extends PaginatedResponse<TransactionNovalNet> {
+}

package/src/gateways/adapters/model/transactionEmp.model.ts

@@ -0,0 +1,223 @@
+import { Transaction } from "../../../model/transaction.model";
+import { BANKS } from "../../../model/gateway.model";
+
+export const TRANSACTION_EMP_STATUS = {
+  approved: "approved",
+  chargeback: "chargebacked",
+  rejected: "rejected",
+  declined: "declined",
+  pending_async: "pending_async",
+};
+
+export function isTransactionEmp(t: Transaction): t is TransactionEmp {
+  return t?.bank === BANKS.EMP;
+}
+
+export interface TransactionEmp extends Transaction {
+  bank: typeof BANKS.EMP;    //CRM info
+  id?: number;
+  type?: string;             //apiResponse.transaction_type
+  status?: string;
+  unique_id?: string;        //EMP transactionId 
+  transaction_id?: number;   //orderId
+  iban_account_no?: string;  //apiResponse.bank_account_number
+  bic_swift_code?: string;   //apiResponse.bank_identifier_code
+  technical_message?: string;// missing in CSV download
+  message?: string;          // missing in CSV download  
+  mode?: string;             // missing in CSV download
+  datetime_utc?: string;     // apiResponse.timestamp
+  descriptor?: string;
+  amount?: string;
+  currency?: string;
+  sent_to_acquirer?: boolean;// missing in CSV download
+  // the rest are coming only from the CSV download from the bank portal
+  merchant?: string;
+  terminal?: string;
+  paymentType?: string;
+  bankCode?: string;
+  merchantTransactionId?: string;
+  cardHolder?: string;
+  cardBrand?: string;
+  cardNumber?: string;
+  countryBilling?: string;
+  state?: string;
+  errorClass?: string;
+  errorMessage?: string;
+  authCode?: string;
+  rrn?: string;
+  responseCode?: string;
+  avsResponse?: string;
+  cvvResult?: string;
+  arn?: string;
+  customerEmail?: string;
+  binCountry?: string;
+  cardType?: string;
+  cardSubtype?: string;
+  fraud?: string;
+  regionClass?: string;
+  schemeResponseCode?: string;
+  schemeTransactionLinkId?: string;
+  recurringAdviceCode?: string;
+  recurringAdviceText?: string;
+  fxTradingRate?: string;
+  fxConvertedAmount?: string;
+  fxTierId?: string;
+  settlementTransactionCurrency?: string;
+  eci?: string;
+  mpi?: string;
+  preauthorization?: string;
+  captured?: string;
+  transactionDescriptor?: string;
+  customerName?: string;
+  fundsStatus?: string;
+  dateOfFundsStatus?: string;
+  accountHolder?: string;
+  digitableLine?: string;
+  expiryDate?: string;
+  schemeMaximumSettlementDate?: string;
+  schemeAuthenticationDataQuality?: string;
+  externalId?: string;     // what is this?
+  payeeId?: string;
+  payeeUniqueId?: string;
+  payeeName?: string;
+  cb_reportDate?: string;
+  cb_trxDate?: string;
+  cb_merchant?: string;
+  cb_terminal?: string;
+  cb_reportType?: string;
+  cb_transition?: string;
+  cb_reportMessage?: string;
+  cb_reportInfo?: string;
+  cb_status?: string;
+  cb_merchantTransactionId?: string;
+  cb_uniqueId?: string;
+  cb_referenceTransactionId?: string;
+  cb_referenceTransactionType?: string;
+  cb_currency?: string;
+  cb_amountInMinorCurrencyUnit?: string;
+  cb_cardHolder?: string;
+  cb_cardBrand?: string;
+  cb_cardNumber?: string;
+  cb_email?: string;
+  cb_country?: string;
+  cb_remoteIp?: string;
+  createdAt?: Date;         //CRM info  
+  updatedAt?: Date;         //CRM info
+}
+export interface TransactionEmpChargeback extends Transaction {
+  bank: typeof BANKS.EMP;
+  id?: number;
+  reportDate?: string;
+  trxDate?: string;
+  merchant?: string;
+  terminal?: string;
+  reportType?: string;
+  transition?: string;
+  reportMessage?: string;
+  reportInfo?: string;
+  status?: string;
+  merchantTransactionId?: string;
+  unique_id?: string;
+  referenceTransactionId?: string;
+  referenceTransactionType?: string;
+  currency?: string;
+  amountInMinorCurrencyUnit?: string;
+  cardHolder?: string;
+  cardBrand?: string;
+  cardNumber?: string;
+  email?: string;
+  country?: string;
+  remoteIp?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export const empTransactionColumnMapper: Partial<Record<keyof TransactionEmp, string>> = {
+  merchant: "Merchant",
+  terminal: "Terminal",
+  status: "Status",
+  type: "Type",
+  paymentType: "Payment Type",
+  bankCode: "Bank Code",
+  merchantTransactionId: "Merchant Transaction id",
+  transaction_id: "Transaction id", // orderId
+  currency: "Currency",
+  amount: "Amount (with decimal mark per currency exponent)",
+  cardHolder: "Card Holder",
+  cardBrand: "Card Brand",
+  cardNumber: "Card Number",
+  countryBilling: "Country (Billing)",
+  state: "State",
+  datetime_utc: "DateTime (UTC)",
+  errorClass: "ErrorClass",
+  errorMessage: "ErrorMessage",
+  authCode: "Auth Code",
+  rrn: "RRN",
+  responseCode: "Response Code",
+  avsResponse: "AVS Response",
+  cvvResult: "CVV Result",
+  unique_id: "Unique ID", //transactionId
+  arn: "ARN",
+  customerEmail: "Customer email",
+  binCountry: "BIN country",
+  cardType: "Card type",
+  cardSubtype: "Card subtype",
+  fraud: "Fraud",
+  descriptor: "Descriptor",
+  regionClass: "Region class",
+  schemeResponseCode: "Scheme Response Code",
+  schemeTransactionLinkId: "Scheme Transaction Link ID",
+  recurringAdviceCode: "Recurring Advice Code",
+  recurringAdviceText: "Recurring Advice text",
+  fxTradingRate: "FX trading rate",
+  fxConvertedAmount: "FX converted amount",
+  fxTierId: "FX tier ID",
+  settlementTransactionCurrency: "Settlement Transaction Currency",
+  eci: "ECI",
+  mpi: "MPI",
+  preauthorization: "Preauthorization",
+  captured: "Captured",
+  transactionDescriptor: "Transaction descriptor",
+  iban_account_no: "IBAN / Account No",
+  bic_swift_code: "BIC / SWIFT code",
+  customerName: "Customer name",
+  fundsStatus: "Funds status",
+  dateOfFundsStatus: "Date of funds status",
+  accountHolder: "Account holder",
+  digitableLine: "Digitable line",
+  expiryDate: "Expiry Date",
+  schemeMaximumSettlementDate: "Scheme Maximum Settlement Date",
+  schemeAuthenticationDataQuality: "Scheme Authentication Data Quality",
+  externalId: "External ID",
+  payeeId: "Payee ID",
+  payeeUniqueId: "Payee Unique ID",
+  payeeName: "Payee Name",
+};
+export const empTransactionColumnKeys = Object.keys(empTransactionColumnMapper);
+export const empTransactionColumnValues = Object.values(empTransactionColumnMapper);
+
+export const empChargebackColumnMapper: Partial<Record<keyof TransactionEmpChargeback, string>> = {
+  reportDate: "Report Date",
+  trxDate: "Trx Date",
+  merchant: "Merchant",
+  terminal: "Terminal",
+  reportType: "Report Type",
+  transition: "Transition",
+  reportMessage: "Report Message",
+  reportInfo: "Report Info",
+  status: "Status",
+  merchantTransactionId: "Merchant Transaction ID",
+  unique_id: "Unique ID",
+  referenceTransactionId: "Reference Transaction ID",
+  referenceTransactionType: "Reference Transaction Type",
+  currency: "Currency",
+  amountInMinorCurrencyUnit: "Amount (in minor currency unit)",
+  cardHolder: "Card Holder",
+  cardBrand: "Card Brand",
+  cardNumber: "Card Number",
+  email: "Email",
+  country: "Country",
+  remoteIp: "Remote IP"
+};
+export const empChargebackColumnKeys = Object.keys(empChargebackColumnMapper);
+export const empChargebackColumnValues = Object.values(empChargebackColumnMapper);

package/src/gateways/adapters/model/transactionFinXP.model.ts

@@ -0,0 +1,167 @@
+import { Transaction } from "../../../model/transaction.model";
+import { BANKS } from "../../../model/gateway.model";
+
+export type TransactionType = TransactionFinXP;
+
+export function isTransactionFinXP(t: Transaction): t is TransactionFinXP {
+  return t?.bank === BANKS.finXP;
+}
+
+export interface TransactionFinXP extends Transaction {
+  bank: typeof BANKS.finXP;
+  id?: number;
+  status?: string;
+  endToEndId?: string;
+  merchant?: string;
+  amount?: string;
+  effectiveDate?: string;
+  customerBic?: string;
+  customerIban?: string;
+  customerName?: string;
+  customerId?: string;
+  additionalInfo1?: string;
+  additionalInfo2?: string;
+  importedDate?: string;
+  mandateReference?: string;
+  transactionInformation?: string;
+  transactionTypeName?: string;
+  errorCode?: string;
+  importedFile?: string;
+  merchantProductName?: string;
+  bankFee?: string;
+  isChargeback?: string;
+  mandateDate?: string;
+  cb_status?: string;
+  cb_chargebackDate?: string;
+  cb_statementDate?: string;
+  cb_chargebackAmount?: string;
+  cb_initiatedAmount?: string;
+  cb_bankFees?: string;
+  cb_currency?: string;
+  cb_chargebackEntryInformation?: string;
+  cb_paymentAdviceIdentifier?: string;
+  cb_rejectCode?: string;
+  cb_chargebackRemittanceInformation?: string;
+  cb_chargebackReason?: string;
+  cb_paymentAdviceDate?: string;
+  cb_initiatedDate?: string;
+  cb_fileName?: string;
+  cb_sepaProduct?: string;
+  cb_product?: string;
+  cb_customerNumber?: string;
+  cb_customerName?: string;
+  cb_customerBic?: string;
+  cb_customerIban?: string;
+  cb_transactionInformation?: string;
+  cb_invoiceNumber?: string;
+  cb_additionalInformation?: string;
+  cb_additionalInformation2?: string;
+  cb_additionalInformation3?: string;
+  cb_additionalInformation4?: string;
+  cb_merchantName?: string;
+  cb_accountName?: string;
+  cb_endToEndId?: string;
+  cb_iban4u?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export interface TransactionFinXPChargeback extends Transaction {
+  bank: typeof BANKS.finXP;
+  id?: number;
+  status?: string;
+  chargebackDate?: string;
+  statementDate?: string;
+  chargebackAmount?: string;
+  initiatedAmount?: string;
+  bankFees?: string;
+  currency?: string;
+  chargebackEntryInformation?: string;
+  paymentAdviceIdentifier?: string;
+  rejectCode?: string;
+  chargebackRemittanceInformation?: string;
+  chargebackReason?: string;
+  paymentAdviceDate?: string;
+  initiatedDate?: string;
+  fileName?: string;
+  sepaProduct?: string;
+  product?: string;
+  customerNumber?: string;
+  customerName?: string;
+  customerBic?: string;
+  customerIban?: string;
+  transactionInformation?: string;
+  invoiceNumber?: string;
+  additionalInformation?: string;
+  additionalInformation2?: string;
+  additionalInformation3?: string;
+  additionalInformation4?: string;
+  merchantName?: string;
+  accountName?: string;
+  endToEndId?: string;
+  iban4u?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export const finXPCSVToTransactionColumn: Partial<Record<keyof TransactionFinXP, string>> = {
+  status: "STATUS",
+  endToEndId: "END TO END ID",
+  merchant: "MERCHANT",
+  amount: "AMOUNT",
+  effectiveDate: "EFFECTIVE DATE",
+  customerBic: "CUSTOMER BIC",
+  customerIban: "CUSTOMER IBAN",
+  customerName: "CUSTOMER NAME",
+  customerId: "CUSTOMER ID",
+  additionalInfo1: "ADDITIONAL INFO 1",
+  additionalInfo2: "ADDITIONAL INFO 2",
+  importedDate: "IMPORTED DATE",
+  mandateReference: "MANDATE REFERENCE",
+  transactionInformation: "TRANSACTION INFORMATION",
+  transactionTypeName: "TRANSACTION TYPE NAME",
+  errorCode: "ERROR CODE",
+  importedFile: "IMPORTED FILE",
+  merchantProductName: "MERCHANT PRODUCT NAME",
+  bankFee: "BANK FEE",
+  isChargeback: "IS CHARGEBACK",
+  mandateDate: "MANDATE DATE"
+};
+
+export const finXPCSVToChargebackColumn: Partial<Record<keyof TransactionFinXPChargeback, string>> = {
+  status: "Status",
+  chargebackDate: "Chargeback date",
+  statementDate: "Statement date",
+  chargebackAmount: "Chargeback amount",
+  initiatedAmount: "Initiated amount",
+  bankFees: "Bank fees",
+  currency: "Currency",
+  chargebackEntryInformation: "Chargeback entry information",
+  paymentAdviceIdentifier: "Payment advice identifier",
+  rejectCode: "Reject code",
+  chargebackRemittanceInformation: "Chargeback remittance information",
+  chargebackReason: "Chargeback reason",
+  paymentAdviceDate: "Payment advice date",
+  initiatedDate: "Initiated date",
+  fileName: "File name",
+  sepaProduct: "SEPA product",
+  product: "Product",
+  customerNumber: "Customer number",
+  customerName: "Customer name",
+  customerBic: "Customer BIC",
+  customerIban: "Customer IBAN",
+  transactionInformation: "Transaction Information",
+  invoiceNumber: "Invoice number",
+  additionalInformation: "Additional Information",
+  additionalInformation2: "Additional Information 2",
+  additionalInformation3: "Additional Information 3",
+  additionalInformation4: "Additional Information 4",
+  merchantName: "Merchant name",
+  accountName: "Account name",
+  endToEndId: "End to end id",
+  iban4u: "Iban4U",
+};
+
+export const finXPTransactionColumnMapper = finXPCSVToTransactionColumn;
+export const finXPChargebackColumnMapper = finXPCSVToChargebackColumn;
+export const finXPTransactionColumnValues = Object.values(finXPCSVToTransactionColumn);
+export const finXPChargebackColumnValues = Object.values(finXPCSVToChargebackColumn);