feat: add swagger docs for responses

packages/server/src/modules/SaleInvoices/queries/GetSaleInvoice.service.ts

@@ -6,6 +6,7 @@ import { SaleInvoiceTransformer } from './SaleInvoice.transformer';
 import { CommandSaleInvoiceValidators } from '../commands/CommandSaleInvoiceValidators.service';
 import { events } from '@/common/events/events';
 import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { SaleInvoiceResponseDto } from '../dtos/SaleInvoiceResponse.dto';
 
 @Injectable()
 export class GetSaleInvoice {
@@ -24,7 +25,9 @@ export class GetSaleInvoice {
    * @param {ISystemUser} authorizedUser -
    * @return {Promise<ISaleInvoice>}
    */
-  public async getSaleInvoice(saleInvoiceId: number): Promise<SaleInvoice> {
+  public async getSaleInvoice(
+    saleInvoiceId: number,
+  ): Promise<SaleInvoiceResponseDto> {
     const saleInvoice = await this.saleInvoiceModel()
       .query()
       .findById(saleInvoiceId)

packages/server/src/modules/SaleInvoices/queries/GetSaleInvoiceState.service.ts

@@ -1,7 +1,7 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { PdfTemplateModel } from '@/modules/PdfTemplate/models/PdfTemplate';
-import { ISaleInvocieState } from '../SaleInvoice.types';
 import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { SaleInvoiceStateResponseDto } from '../dtos/SaleInvoiceState.dto';
 
 @Injectable()
 export class GetSaleInvoiceState {
@@ -12,9 +12,9 @@ export class GetSaleInvoiceState {
 
   /**
    * Retrieves the create/edit invoice state.
-   * @return {Promise<ISaleInvoice>}
+   * @returns {Promise<SaleInvoiceStateResponseDto>}
    */
-  public async getSaleInvoiceState(): Promise<ISaleInvocieState> {
+  public async getSaleInvoiceState(): Promise<SaleInvoiceStateResponseDto> {
     const defaultPdfTemplate = await this.pdfTemplateModel()
       .query()
       .findOne({ resource: 'SaleInvoice' })