opf-validator 0.0.1

package/dist/recurring-payments/successResponses/index.d.ts

@@ -0,0 +1,175 @@
+/**
+ * Interfaces de Sucesso para Respostas de Recurring Payments
+ */
+/**
+ * Resposta de sucesso para POST /recurring-consents (CreateRecurringConsent)
+ */
+export interface CreateRecurringConsentSuccessResponse {
+    data: {
+        recurringConsentId: string;
+        creationDateTime: string;
+        status: string;
+        statusUpdateDateTime: string;
+        permissions: string[];
+        recurringConfiguration: {
+            frequency: string;
+            frequencyAdditionalInfo?: string;
+            startDateTime?: string;
+            endDateTime?: string;
+        };
+        loggedUser?: {
+            document: {
+                identification: string;
+                rel: string;
+            };
+        };
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para GET /recurring-consents/:recurringConsentId (GetRecurringConsent)
+ */
+export interface GetRecurringConsentSuccessResponse {
+    data: {
+        recurringConsentId: string;
+        creationDateTime: string;
+        status: string;
+        statusUpdateDateTime: string;
+        permissions: string[];
+        recurringConfiguration: {
+            frequency: string;
+            frequencyAdditionalInfo?: string;
+            startDateTime?: string;
+            endDateTime?: string;
+        };
+        loggedUser?: {
+            document: {
+                identification: string;
+                rel: string;
+            };
+        };
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para PATCH /recurring-consents/:recurringConsentId (PatchRecurringConsent)
+ */
+export interface PatchRecurringConsentSuccessResponse {
+    data: {
+        recurringConsentId: string;
+        status: string;
+        statusUpdateDateTime: string;
+        permissions?: string[];
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para POST /recurring-pix-payments (CreateRecurringPixPayment)
+ */
+export interface CreateRecurringPixPaymentSuccessResponse {
+    data: {
+        paymentId: string;
+        endToEndId: string;
+        consentId: string;
+        creationDateTime: string;
+        status: string;
+        statusUpdateDateTime: string;
+        amount: string;
+        currency: string;
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para GET /recurring-pix-payments/:paymentId (GetRecurringPixPayment)
+ */
+export interface GetRecurringPixPaymentSuccessResponse {
+    data: {
+        paymentId: string;
+        endToEndId: string;
+        consentId: string;
+        creationDateTime: string;
+        status: string;
+        statusUpdateDateTime: string;
+        amount: string;
+        currency: string;
+        creditorAccount?: {
+            ispb: string;
+            issuer?: string;
+            number: string;
+            accountType: string;
+        };
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para POST /recurring-pix-payments/:paymentId/retry (CreateRecurringRetryPixPayment)
+ */
+export interface CreateRecurringRetryPixPaymentSuccessResponse {
+    data: {
+        paymentId: string;
+        endToEndId: string;
+        consentId: string;
+        creationDateTime: string;
+        status: string;
+        statusUpdateDateTime: string;
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+/**
+ * Resposta de sucesso para PATCH /recurring-pix-payments/:paymentId (PatchRecurringPixPayment)
+ */
+export interface PatchRecurringPixPaymentSuccessResponse {
+    data: {
+        paymentId: string;
+        status: string;
+        statusUpdateDateTime: string;
+        cancellation?: {
+            cancelledAt: string;
+            cancelledBy: {
+                document: {
+                    identification: string;
+                    rel: string;
+                };
+            };
+            reason: string;
+            cancelledFrom: string;
+        };
+    };
+    links?: {
+        self: string;
+    };
+    meta?: {
+        requestDateTime: string;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/recurring-payments/successResponses/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/recurring-payments/successResponses/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE;QACJ,kBAAkB,EAAE,MAAM,CAAC;QAC3B,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,sBAAsB,EAAE;YACtB,SAAS,EAAE,MAAM,CAAC;YAClB,uBAAuB,CAAC,EAAE,MAAM,CAAC;YACjC,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,UAAU,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,MAAM,CAAC;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb,CAAC;SACH,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE;QACJ,kBAAkB,EAAE,MAAM,CAAC;QAC3B,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,sBAAsB,EAAE;YACtB,SAAS,EAAE,MAAM,CAAC;YAClB,uBAAuB,CAAC,EAAE,MAAM,CAAC;YACjC,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,UAAU,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,MAAM,CAAC;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb,CAAC;SACH,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE;QACJ,kBAAkB,EAAE,MAAM,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE;YAChB,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,MAAM,EAAE,MAAM,CAAC;YACf,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,6CAA6C;IAC5D,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,CAAC,EAAE;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,WAAW,EAAE;gBACX,QAAQ,EAAE;oBACR,cAAc,EAAE,MAAM,CAAC;oBACvB,GAAG,EAAE,MAAM,CAAC;iBACb,CAAC;aACH,CAAC;YACF,MAAM,EAAE,MAAM,CAAC;YACf,aAAa,EAAE,MAAM,CAAC;SACvB,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH"}

package/dist/recurring-payments/successResponses/index.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Interfaces de Sucesso para Respostas de Recurring Payments
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/recurring-payments/successResponses/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/recurring-payments/successResponses/index.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/dist/recurring-payments/validators/createRecurringConsent.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Validações para CreateRecurringConsent
+ * Segue as regras especificadas no Open Finance Brasil - API de Pagamentos Automáticos
+ */
+import { ValidationResult } from "../../utils/openFinanceErrors";
+/**
+ * Interface para LoggedUser
+ */
+interface LoggedUser {
+    document: {
+        identification: string;
+        rel: string;
+    };
+}
+/**
+ * Interface para BusinessEntity
+ */
+interface BusinessEntity {
+    document: {
+        identification: string;
+        rel: string;
+    };
+}
+/**
+ * Interface para conta de débito
+ */
+interface DebtorAccount {
+    ispb: string;
+    issuer?: string;
+    number: string;
+    accountType: string;
+}
+/**
+ * Interface para recebedor (creditor)
+ */
+interface Creditor {
+    personType: string;
+    cpfCnpj: string;
+    name: string;
+}
+/**
+ * Interface para configuração de Pix Automático
+ */
+interface AutomaticRecurringConfig {
+    automatic: {
+        contractId: string;
+        interval: string;
+        contractDebtor: {
+            name: string;
+            document: {
+                identification: string;
+                rel: string;
+            };
+        };
+        isRetryAccepted: boolean;
+        referenceStartDate: string;
+        fixedAmount?: string;
+        maximumVariableAmount?: string;
+        minimumVariableAmount?: string;
+        firstPayment?: {
+            type: string;
+            date: string;
+            currency: string;
+            amount: string;
+            creditorAccount: {
+                ispb: string;
+                number: string;
+                accountType: string;
+            };
+        };
+    };
+}
+/**
+ * Interface para CreateRecurringConsent
+ */
+interface CreateRecurringConsentPayload {
+    data: {
+        loggedUser: LoggedUser;
+        businessEntity?: BusinessEntity;
+        creditors: Creditor[];
+        expirationDateTime?: string;
+        additionalInformation?: string;
+        debtorAccount?: DebtorAccount;
+        recurringConfiguration: AutomaticRecurringConfig | any;
+        journey?: {
+            isLinked: boolean;
+            linkId: string;
+        };
+    };
+}
+/**
+ * Valida o payload de criação de consentimento de pagamento recorrente
+ */
+declare function validateCreateRecurringConsent(payload: any): ValidationResult;
+export { validateCreateRecurringConsent, CreateRecurringConsentPayload, };
+//# sourceMappingURL=createRecurringConsent.d.ts.map

package/dist/recurring-payments/validators/createRecurringConsent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRecurringConsent.d.ts","sourceRoot":"","sources":["../../../src/recurring-payments/validators/createRecurringConsent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEL,gBAAgB,EAGjB,MAAM,+BAA+B,CAAC;AAsBvC;;GAEG;AACH,UAAU,UAAU;IAClB,QAAQ,EAAE;QACR,cAAc,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED;;GAEG;AACH,UAAU,cAAc;IACtB,QAAQ,EAAE;QACR,cAAc,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED;;GAEG;AACH,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,UAAU,QAAQ;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,UAAU,wBAAwB;IAChC,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE;YACd,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE;gBACR,cAAc,EAAE,MAAM,CAAC;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb,CAAC;SACH,CAAC;QACF,eAAe,EAAE,OAAO,CAAC;QACzB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,YAAY,CAAC,EAAE;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC;YACf,eAAe,EAAE;gBACf,IAAI,EAAE,MAAM,CAAC;gBACb,MAAM,EAAE,MAAM,CAAC;gBACf,WAAW,EAAE,MAAM,CAAC;aACrB,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,UAAU,6BAA6B;IACrC,IAAI,EAAE;QACJ,UAAU,EAAE,UAAU,CAAC;QACvB,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,SAAS,EAAE,QAAQ,EAAE,CAAC;QACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,sBAAsB,EAAE,wBAAwB,GAAG,GAAG,CAAC;QACvD,OAAO,CAAC,EAAE;YACR,QAAQ,EAAE,OAAO,CAAC;YAClB,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,iBAAS,8BAA8B,CACrC,OAAO,EAAE,GAAG,GACX,gBAAgB,CA8ElB;AAs9BD,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,GAC9B,CAAC"}