@nomalism-com/types 0.47.16 → 0.48.0

package/dist/main.d.ts

@@ -46,6 +46,8 @@ import * as EmailTemplateAttachment from "./modules/integration/emailTemplateAtt
 import * as EmailTemplateAttachmentRoutes from "./modules/integration/emailTemplateAttachment/route.schema";
 import * as EmailVerification from "./modules/integration/emailVerification/interfaces";
 import * as EmailVerificationRoutes from "./modules/integration/emailVerification/route.schema";
+import * as EuPago from "./modules/integration/eupago/interfaces";
+import * as EuPagoRoutes from "./modules/integration/eupago/route.schema";
 import * as GoogleFilePermission from "./modules/integration/googleFilePermission/interfaces";
 import * as GoogleFilePermissionRoutes from "./modules/integration/googleFilePermission/route.schema";
 import * as GoogleSheets from "./modules/integration/googleSheets/interfaces";
@@ -260,4 +262,4 @@ import * as stockErrors from "./shared/errors/stockErrors";
 import * as userErrors from "./shared/errors/userErrors";
 import * as viewErrors from "./shared/errors/viewErrors";
 import * as shared from "./shared/interface";
-export { AccountCode, AccountCodeRoutes, AdminPanel, AllowedDevice, AllowedDeviceRoutes, BankData, BankDataRoutes, BillOfLading, BillOfLadingRoutes, Catalogo, CatalogoRoutes, Channel, ChannelRoutes, Chat, ChatRapidMessage, ChatRapidMessageRoutes, ChatRoutes, ChatSubscriber, ChatSubscriberRoutes, Client, ClientRoutes, ClientType, ClientTypeRoutes, CLT, CLTRoutes, Commissioner, CommissionerRoutes, ConferirEncomenda, Country, CountryRoutes, CurrentAccount, CurrentAccountRoutes, Dashboard, DashboardRoutes, DeliveryMethods, DeliveryMethodsRoutes, DocumentHeader, DocumentHeaderHistory, DocumentHeaderRoutes, DocumentHeaderSubscriber, DocumentHeaderSubscriberRoutes, DocumentHeaderSurvey, DocumentHeaderSurveyRoutes, DocumentLine, DocumentLineAssoc, DocumentLineMt, DocumentLineMtRoutes, DocumentLineNote, DocumentLineNoteRoutes, DocumentLineRm, DocumentLineRmRoutes, DocumentLineRoutes, documentManagementErrors, DocumentSet, DocumentSetRoutes, DocumentType, DocumentTypeRoutes, EmailAccount, EmailAccountRoutes, EmailLog, EmailLogRoutes, EmailTemplate, EmailTemplateAttachment, EmailTemplateAttachmentRoutes, EmailTemplateRoutes, EmailVerification, EmailVerificationRoutes, ErrorLog, ErrorLogRoutes, ExternalDocumentHeader, ExternalDocumentHeaderRoutes, ExternalDocumentType, Favorites, FavoritesRoutes, File, FileRoutes, Gmails, GoogleCalendar, GoogleCalendarRoutes, GoogleFilePermission, GoogleFilePermissionRoutes, GoogleSheetPool, GoogleSheets, GoogleSheetsRoutes, integrationErrors, Inventario, InventarioRoutes, Language, LanguageRoutes, LLM, LLMRoutes, Location, LocationRoutes, MaterialEntrance, MaterialEntranceRoutes, MaturityDates, MaturityDatesRoutes, MobilePrint, MobilePrintRoutes, Multimedia, MultimediaRoutes, Npc, NpcRoutes, NPF, NPFRoutes, NRCL, NRCLRoutes, Observation, ObservationRoutes, ObservationType, ObservationTypeRoutes, Order, OrderManagement, OrderRoutes, Password, PasswordRoutes, PatchNotes, Payment, PaymentBatch, PaymentBatchRoutes, PaymentMethods, PaymentMethodsRoutes, PaymentRoutes, Persona, PersonaRoutes, Portal, PortalRoutes, PreSale, PreSaleProduct, PreSaleProductRoutes, PreSaleRoutes, Printer, PrinterRoutes, Prison, PrisonRoutes, ProductGoogleSheets, ProductGoogleSheetsRoutes, ProductImage, ProductImageRoutes, ProductionOrder, ProductionOrderRoutes, ProductLocation, Proforma, ProformaRoutes, ProjectInfo, ProjectInfoRoutes, Promotion, PromotionAssoc, PromotionAssocRoutes, PromotionRoutes, PropostaFornecedor, PropostaFornecedorRoutes, PropostaSheets, PropostaSheetsRoutes, ProviderCreditNoteFromReturn, ProviderCreditNoteFromReturnRoutes, ProviderFinancialCreditNote, ProviderFinancialCreditNoteRoutes, Providers, ProviderServiceInvoice, ProviderServiceInvoiceRoutes, ProvidersRoutes, ProviderType, ProviderTypeRoutes, Purchase, PurchaseConditions, PurchaseConditionsRoutes, PurchaseRoutes, Quebra, QuebraRoutes, QueryList, QueryListRoutes, QueryParameter, QueryParameterRoutes, ReasonForExemption, ReasonForExemptionRoutes, RecurrentTasks, RefreshToken, RefreshTokenRoutes, ReturnReason, ReturnReasonRoutes, ReturnToProvider, ReturnToProviderRoutes, SavedEmPicking, SavedEmPickingRoutes, SavedProviderProposal, SavedProviderProposalRoutes, Schedule, SchedulePrintJob, SchedulePrintJobRoutes, ScheduleRoutes, SegmentsArea, SegmentsAreaRoutes, Sessions, SessionsRoutes, Settings, SettingsRoutes, shared, Shippings, ShippingsRoutes, SideMenu, SidemenuHighlight, SidemenuHighlightRoutes, SideMenuRoutes, SmsSender, SmsTemplate, SmsTemplateRoutes, StartDocumentHeaderLastUpdate, stockErrors, StockMovement, StockMovementRoutes, StoreOperator, StoreOperatorRoutes, Swift, SwiftRoutes, SystemModule, SystemModuleRoutes, Tag, TagRoutes, Task, TaskMessage, TaskMessageRoutes, TaskRead, TaskReadRoutes, TaskRoutes, Tenant, TenantRoutes, Theme, ThemeRoutes, Tickets, TicketsLanguage, TicketsLanguageRoutes, TicketsRoutes, TimeSheet, TimeSheetRoutes, Transformado, TransformadoRoutes, TypeOfLocation, TypeOfLocationRoutes, UnitOfMeasure, UnitOfMeasureRoutes, UpfrontReturn, UpfrontReturnRoutes, userErrors, UserPositions, UserPositionsRoutes, Users, UsersRoutes, UserTokens, UserTokensRoutes, VatTax, VatTaxRoutes, VatTaxZone, VatTaxZoneRoutes, VatValidation, VatValidationRoutes, Vehicles, VehiclesRoutes, viewErrors, WebSocket, Workflow, WorkflowRoutes, };
+export { AccountCode, AccountCodeRoutes, AdminPanel, AllowedDevice, AllowedDeviceRoutes, BankData, BankDataRoutes, BillOfLading, BillOfLadingRoutes, Catalogo, CatalogoRoutes, Channel, ChannelRoutes, Chat, ChatRapidMessage, ChatRapidMessageRoutes, ChatRoutes, ChatSubscriber, ChatSubscriberRoutes, Client, ClientRoutes, ClientType, ClientTypeRoutes, CLT, CLTRoutes, Commissioner, CommissionerRoutes, ConferirEncomenda, Country, CountryRoutes, CurrentAccount, CurrentAccountRoutes, Dashboard, DashboardRoutes, DeliveryMethods, DeliveryMethodsRoutes, DocumentHeader, DocumentHeaderHistory, DocumentHeaderRoutes, DocumentHeaderSubscriber, DocumentHeaderSubscriberRoutes, DocumentHeaderSurvey, DocumentHeaderSurveyRoutes, DocumentLine, DocumentLineAssoc, DocumentLineMt, DocumentLineMtRoutes, DocumentLineNote, DocumentLineNoteRoutes, DocumentLineRm, DocumentLineRmRoutes, DocumentLineRoutes, documentManagementErrors, DocumentSet, DocumentSetRoutes, DocumentType, DocumentTypeRoutes, EmailAccount, EmailAccountRoutes, EmailLog, EmailLogRoutes, EmailTemplate, EmailTemplateAttachment, EmailTemplateAttachmentRoutes, EmailTemplateRoutes, EmailVerification, EmailVerificationRoutes, ErrorLog, ErrorLogRoutes, EuPago, EuPagoRoutes, ExternalDocumentHeader, ExternalDocumentHeaderRoutes, ExternalDocumentType, Favorites, FavoritesRoutes, File, FileRoutes, Gmails, GoogleCalendar, GoogleCalendarRoutes, GoogleFilePermission, GoogleFilePermissionRoutes, GoogleSheetPool, GoogleSheets, GoogleSheetsRoutes, integrationErrors, Inventario, InventarioRoutes, Language, LanguageRoutes, LLM, LLMRoutes, Location, LocationRoutes, MaterialEntrance, MaterialEntranceRoutes, MaturityDates, MaturityDatesRoutes, MobilePrint, MobilePrintRoutes, Multimedia, MultimediaRoutes, Npc, NpcRoutes, NPF, NPFRoutes, NRCL, NRCLRoutes, Observation, ObservationRoutes, ObservationType, ObservationTypeRoutes, Order, OrderManagement, OrderRoutes, Password, PasswordRoutes, PatchNotes, Payment, PaymentBatch, PaymentBatchRoutes, PaymentMethods, PaymentMethodsRoutes, PaymentRoutes, Persona, PersonaRoutes, Portal, PortalRoutes, PreSale, PreSaleProduct, PreSaleProductRoutes, PreSaleRoutes, Printer, PrinterRoutes, Prison, PrisonRoutes, ProductGoogleSheets, ProductGoogleSheetsRoutes, ProductImage, ProductImageRoutes, ProductionOrder, ProductionOrderRoutes, ProductLocation, Proforma, ProformaRoutes, ProjectInfo, ProjectInfoRoutes, Promotion, PromotionAssoc, PromotionAssocRoutes, PromotionRoutes, PropostaFornecedor, PropostaFornecedorRoutes, PropostaSheets, PropostaSheetsRoutes, ProviderCreditNoteFromReturn, ProviderCreditNoteFromReturnRoutes, ProviderFinancialCreditNote, ProviderFinancialCreditNoteRoutes, Providers, ProviderServiceInvoice, ProviderServiceInvoiceRoutes, ProvidersRoutes, ProviderType, ProviderTypeRoutes, Purchase, PurchaseConditions, PurchaseConditionsRoutes, PurchaseRoutes, Quebra, QuebraRoutes, QueryList, QueryListRoutes, QueryParameter, QueryParameterRoutes, ReasonForExemption, ReasonForExemptionRoutes, RecurrentTasks, RefreshToken, RefreshTokenRoutes, ReturnReason, ReturnReasonRoutes, ReturnToProvider, ReturnToProviderRoutes, SavedEmPicking, SavedEmPickingRoutes, SavedProviderProposal, SavedProviderProposalRoutes, Schedule, SchedulePrintJob, SchedulePrintJobRoutes, ScheduleRoutes, SegmentsArea, SegmentsAreaRoutes, Sessions, SessionsRoutes, Settings, SettingsRoutes, shared, Shippings, ShippingsRoutes, SideMenu, SidemenuHighlight, SidemenuHighlightRoutes, SideMenuRoutes, SmsSender, SmsTemplate, SmsTemplateRoutes, StartDocumentHeaderLastUpdate, stockErrors, StockMovement, StockMovementRoutes, StoreOperator, StoreOperatorRoutes, Swift, SwiftRoutes, SystemModule, SystemModuleRoutes, Tag, TagRoutes, Task, TaskMessage, TaskMessageRoutes, TaskRead, TaskReadRoutes, TaskRoutes, Tenant, TenantRoutes, Theme, ThemeRoutes, Tickets, TicketsLanguage, TicketsLanguageRoutes, TicketsRoutes, TimeSheet, TimeSheetRoutes, Transformado, TransformadoRoutes, TypeOfLocation, TypeOfLocationRoutes, UnitOfMeasure, UnitOfMeasureRoutes, UpfrontReturn, UpfrontReturnRoutes, userErrors, UserPositions, UserPositionsRoutes, Users, UsersRoutes, UserTokens, UserTokensRoutes, VatTax, VatTaxRoutes, VatTaxZone, VatTaxZoneRoutes, VatValidation, VatValidationRoutes, Vehicles, VehiclesRoutes, viewErrors, WebSocket, Workflow, WorkflowRoutes, };

package/dist/modules/integration/eupago/interfaces.d.ts

@@ -0,0 +1,47 @@
+import { EuPagoTransaction } from "../../../shared/entities/integration";
+export type Entity = EuPagoTransaction;
+export declare const Route = "eupago";
+export declare const EuPagoMethodEnum: {
+    multibanco: "multibanco";
+    mbway: "mbway";
+    creditcard: "creditcard";
+};
+export type EuPagoMethod = (typeof EuPagoMethodEnum)[keyof typeof EuPagoMethodEnum];
+export declare const EuPagoStatusEnum: {
+    awaiting_method: "awaiting_method";
+    pending: "pending";
+    confirmed: "confirmed";
+    rejected: "rejected";
+};
+export type EuPagoStatus = (typeof EuPagoStatusEnum)[keyof typeof EuPagoStatusEnum];
+export interface ICreatePendingPaymentRequest {
+    from_document_header_id: string;
+    amount: number;
+}
+export interface IChooseMethodRequest {
+    id: string;
+    method: Extract<EuPagoMethod, "multibanco" | "mbway">;
+    client: {
+        name: string;
+        email?: string;
+        phone?: string;
+    };
+}
+export interface IWebhookTransaction {
+    entity?: number;
+    reference?: number;
+    identifier: string;
+    method: string;
+    amount: {
+        value: number;
+        currency?: string;
+    };
+    trid: number;
+    status: string;
+}
+export interface IWebhookBody {
+    transactions: IWebhookTransaction;
+    channel?: {
+        name: string;
+    };
+}

package/dist/modules/integration/eupago/route.schema.d.ts

@@ -0,0 +1,7 @@
+import joi from "joi";
+import * as IShared from "../../../shared/interface";
+import { IChooseMethodRequest, ICreatePendingPaymentRequest } from "./interfaces";
+export declare const generateBodyKeys: IShared.IRouteRequest<ICreatePendingPaymentRequest>;
+export declare const generateBody: joi.ObjectSchema<any>;
+export declare const chooseMethodBodyKeys: IShared.IRouteRequest<Omit<IChooseMethodRequest, "id">>;
+export declare const chooseMethodBody: joi.ObjectSchema<any>;

package/dist/modules/stock/chat/interfaces.d.ts

@@ -30,6 +30,7 @@ export interface ICreateRequest {
     message: string;
     username: string;
     is_customer: boolean;
+    skip_translation?: boolean;
 }
 export interface IUpdateRequest {
     chat_document_header_id?: string;

package/dist/modules/supply/documentHeader/interfaces.d.ts

@@ -1,6 +1,7 @@
 import { DocumentHeader, DocumentHeaderVirtuals, DocumentLineNote, DocumentType, StartDocumentHeaderVirtuals, VatTax } from "../../../shared/entities/stock";
 import * as IShared from "../../../shared/interface";
 import * as IProjectInfo from "../../integration/projectInfo/interfaces";
+import * as IDocumentLineNote from "../documentLineNote/interfaces";
 import * as IDocumentType from "../documentType/interfaces";
 import * as IPayment from "../payment/interface";
 export type Entity = Omit<DocumentHeader, "external_data">;
@@ -133,6 +134,15 @@ export interface ICreateFromHeaderRequest {
     store_operator_id?: string | null;
     copy_from_document?: string | null;
     owner_ref_document?: string | null;
+    /**
+     * Nota opcional a inserir nas linhas selecionadas (from_lines) aquando da
+     * criação do documento. Usada, por exemplo, na transição "Criar Devolução"
+     * (EM -> DF), onde o utilizador introduz uma nota do tipo "Devolucao".
+     */
+    document_line_note?: {
+        note: string;
+        type: IDocumentLineNote.IDocumentLineNoteType;
+    };
 }
 export interface IUpdateRequest {
     external_id?: string | null;

package/dist/shared/entities/integration.d.ts

@@ -1,3 +1,4 @@
+import type { EuPagoMethod, EuPagoStatus } from "../../modules/integration/eupago/interfaces";
 import type { IBudgetOptionsType, IProjectInfoOriginType, IProjectInfoType } from "../../modules/integration/projectInfo/interfaces";
 /**
  * Model Observation
@@ -167,3 +168,21 @@ export type PatchNotes = {
     created_at: string;
     updated_at: string;
 };
+/**
+ * Model EuPagoTransaction
+ *
+ */
+export type EuPagoTransaction = {
+    id: string;
+    identifier: string | null;
+    method: EuPagoMethod | null;
+    status: EuPagoStatus;
+    reference: string | null;
+    transaction_id: string | null;
+    amount: number;
+    from_document_header_id: string;
+    confirmation_dispatched: boolean;
+    raw_payload: unknown;
+    created_at: Date;
+    updated_at: Date;
+};

package/dist/shared/interface.d.ts

@@ -1,4 +1,5 @@
 import joi from "joi";
+import type { EuPagoMethod } from "../modules/integration/eupago/interfaces";
 import type { IGetUserData } from "../modules/integration/googleSheets/interfaces";
 import type { ITranslateRequest } from "../modules/stock/chat/interfaces";
 import type { IWarningType } from "../modules/supply/documentHeader/interfaces";
@@ -163,6 +164,7 @@ export declare enum IBrokerTopic {
     send_email_client_survey = "send_email_client_survey",
     perform_task = "perform_task",
     create_site_proposal = "create_site_proposal",
+    eupago_payment_confirmed = "eupago_payment_confirmed",
     translate_chat_message = "translate_chat_message",
     persona_updated = "persona_updated",
     persona_lang_change = "persona_lang_change",
@@ -411,6 +413,13 @@ export type IBrokerTopicPayload = {
         owner_id: string;
         event: SupplyDocumentSocketEvent;
     };
+    [IBrokerTopic.eupago_payment_confirmed]: {
+        from_document_header_id: string;
+        amount: number;
+        method: EuPagoMethod;
+        transaction_id: string;
+        reference?: string;
+    };
 };
 export interface IBrokerMessage<T extends IBrokerTopic = IBrokerTopic> {
     topic: T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nomalism-com/types",
   "description": "A nomalism package with all necessary types and validations for developing APIs",
-  "version": "0.47.16",
+  "version": "0.48.0",
   "author": "Nomalism <it.nomalism@gmail.com> (https://nomalism.com/)",
   "license": "UNLICENSED",
   "type": "module",