fix(server): rename term to

2026-02-18 05:40:31 +00:00 · 2024-08-13 13:41:09 +02:00
parent cd90fede54
commit 9991eebaaf
35 changed files with 89 additions and 93 deletions
--- a/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts
+++ b/packages/server/src/services/Sales/PaymentReceived/PaymentReceivedApplication.ts
@@ -0,0 +1,226 @@
+import {
+  IFilterMeta,
+  IPaginationMeta,
+  IPaymentReceive,
+  IPaymentReceiveCreateDTO,
+  IPaymentReceiveEditDTO,
+  IPaymentReceiveSmsDetails,
+  IPaymentReceivesFilter,
+  ISystemUser,
+  PaymentReceiveMailOptsDTO,
+} from '@/interfaces';
+import { Inject, Service } from 'typedi';
+import { CreatePaymentReceived } from './CreatePaymentReceived';
+import { EditPaymentReceived } from './EditPaymentReceived';
+import { DeletePaymentReceived } from './DeletePaymentReceived';
+import { GetPaymentReceives } from './GetPaymentsReceived';
+import { GetPaymentReceived } from './GetPaymentReceived';
+import { GetPaymentReceivedInvoices } from './GetPaymentReceivedInvoices';
+import { PaymentReceiveNotifyBySms } from './PaymentReceivedSmsNotify';
+import GetPaymentReceivePdf from './GetPaymentReceivedPdf';
+import { SendPaymentReceiveMailNotification } from './PaymentReceivedMailNotification';
+
+@Service()
+export class PaymentReceivesApplication {
+  @Inject()
+  private createPaymentReceivedService: CreatePaymentReceived;
+
+  @Inject()
+  private editPaymentReceivedService: EditPaymentReceived;
+
+  @Inject()
+  private deletePaymentReceivedService: DeletePaymentReceived;
+
+  @Inject()
+  private getPaymentsReceivedService: GetPaymentReceives;
+
+  @Inject()
+  private getPaymentReceivedService: GetPaymentReceived;
+
+  @Inject()
+  private getPaymentReceiveInvoicesService: GetPaymentReceivedInvoices;
+
+  @Inject()
+  private paymentSmsNotify: PaymentReceiveNotifyBySms;
+
+  @Inject()
+  private paymentMailNotify: SendPaymentReceiveMailNotification;
+
+  @Inject()
+  private getPaymentReceivePdfService: GetPaymentReceivePdf;
+
+  /**
+   * Creates a new payment receive.
+   * @param {number} tenantId
+   * @param {IPaymentReceiveCreateDTO} paymentReceiveDTO
+   * @param {ISystemUser} authorizedUser
+   * @returns
+   */
+  public createPaymentReceived(
+    tenantId: number,
+    paymentReceiveDTO: IPaymentReceiveCreateDTO,
+    authorizedUser: ISystemUser
+  ) {
+    return this.createPaymentReceivedService.createPaymentReceived(
+      tenantId,
+      paymentReceiveDTO,
+      authorizedUser
+    );
+  }
+
+  /**
+   * Edit details the given payment receive with associated entries.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @param {IPaymentReceiveEditDTO} paymentReceiveDTO
+   * @param {ISystemUser} authorizedUser
+   * @returns
+   */
+  public editPaymentReceive(
+    tenantId: number,
+    paymentReceiveId: number,
+    paymentReceiveDTO: IPaymentReceiveEditDTO,
+    authorizedUser: ISystemUser
+  ) {
+    return this.editPaymentReceivedService.editPaymentReceive(
+      tenantId,
+      paymentReceiveId,
+      paymentReceiveDTO,
+      authorizedUser
+    );
+  }
+
+  /**
+   * Deletes the given payment receive.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @param {ISystemUser} authorizedUser
+   * @returns
+   */
+  public deletePaymentReceive(
+    tenantId: number,
+    paymentReceiveId: number,
+    authorizedUser: ISystemUser
+  ) {
+    return this.deletePaymentReceivedService.deletePaymentReceive(
+      tenantId,
+      paymentReceiveId,
+      authorizedUser
+    );
+  }
+
+  /**
+   * Retrieve payment receives paginated and filterable.
+   * @param {number} tenantId
+   * @param {IPaymentReceivesFilter} filterDTO
+   * @returns
+   */
+  public async getPaymentReceives(
+    tenantId: number,
+    filterDTO: IPaymentReceivesFilter
+  ): Promise<{
+    paymentReceives: IPaymentReceive[];
+    pagination: IPaginationMeta;
+    filterMeta: IFilterMeta;
+  }> {
+    return this.getPaymentsReceivedService.getPaymentReceives(
+      tenantId,
+      filterDTO
+    );
+  }
+
+  /**
+   * Retrieves the given payment receive.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @returns  {Promise<IPaymentReceive>}
+   */
+  public async getPaymentReceive(
+    tenantId: number,
+    paymentReceiveId: number
+  ): Promise<IPaymentReceive> {
+    return this.getPaymentReceivedService.getPaymentReceive(
+      tenantId,
+      paymentReceiveId
+    );
+  }
+
+  /**
+   * Retrieves associated sale invoices of the given payment receive.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @returns
+   */
+  public getPaymentReceiveInvoices(tenantId: number, paymentReceiveId: number) {
+    return this.getPaymentReceiveInvoicesService.getPaymentReceiveInvoices(
+      tenantId,
+      paymentReceiveId
+    );
+  }
+
+  /**
+   * Notify customer via sms about payment receive details.
+   * @param {number} tenantId - Tenant id.
+   * @param {number} paymentReceiveid - Payment receive id.
+   */
+  public notifyPaymentBySms(tenantId: number, paymentReceiveid: number) {
+    return this.paymentSmsNotify.notifyBySms(tenantId, paymentReceiveid);
+  }
+
+  /**
+   * Retrieve the SMS details of the given invoice.
+   * @param {number} tenantId - Tenant id.
+   * @param {number} paymentReceiveid - Payment receive id.
+   */
+  public getPaymentSmsDetails = async (
+    tenantId: number,
+    paymentReceiveId: number
+  ): Promise<IPaymentReceiveSmsDetails> => {
+    return this.paymentSmsNotify.smsDetails(tenantId, paymentReceiveId);
+  };
+
+  /**
+   * Notify customer via mail about payment receive details.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @param {IPaymentReceiveMailOpts} messageOpts
+   * @returns {Promise<void>}
+   */
+  public notifyPaymentByMail(
+    tenantId: number,
+    paymentReceiveId: number,
+    messageOpts: PaymentReceiveMailOptsDTO
+  ): Promise<void> {
+    return this.paymentMailNotify.triggerMail(
+      tenantId,
+      paymentReceiveId,
+      messageOpts
+    );
+  }
+
+  /**
+   * Retrieves the default mail options of the given payment transaction.
+   * @param {number} tenantId
+   * @param {number} paymentReceiveId
+   * @returns {Promise<void>}
+   */
+  public getPaymentMailOptions(tenantId: number, paymentReceiveId: number) {
+    return this.paymentMailNotify.getMailOptions(tenantId, paymentReceiveId);
+  }
+
+  /**
+   * Retrieve pdf content of the given payment receive.
+   * @param {number} tenantId
+   * @param {PaymentReceive} paymentReceive
+   * @returns
+   */
+  public getPaymentReceivePdf = (
+    tenantId: number,
+    paymentReceiveId: number
+  ) => {
+    return this.getPaymentReceivePdfService.getPaymentReceivePdf(
+      tenantId,
+      paymentReceiveId
+    );
+  };
+}