feat: add swagger docs for responses

packages/server/src/modules/Accounts/Accounts.controller.ts

@@ -12,7 +12,14 @@ import { AccountsApplication } from './AccountsApplication.service';
 import { CreateAccountDTO } from './CreateAccount.dto';
 import { EditAccountDTO } from './EditAccount.dto';
 import { IAccountsFilter, IAccountsTransactionsFilter } from './Accounts.types';
-import { ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger';
+import {
+  ApiOperation,
+  ApiParam,
+  ApiResponse,
+  ApiTags,
+  getSchemaPath,
+} from '@nestjs/swagger';
+import { AccountResponseDto } from './dtos/AccountResponse.dto';
 
 @Controller('accounts')
 @ApiTags('Accounts')
@@ -133,6 +140,11 @@ export class AccountsController {
     type: Number,
     description: 'The account id',
   })
+  @ApiResponse({
+    status: 200,
+    description: 'The account details have been successfully retrieved.',
+    schema: { $ref: getSchemaPath(AccountResponseDto) },
+  })
   async getAccount(@Param('id', ParseIntPipe) id: number) {
     return this.accountsApplication.getAccount(id);
   }
@@ -142,7 +154,12 @@ export class AccountsController {
   @ApiResponse({
     status: 200,
     description: 'The accounts have been successfully retrieved.',
+    schema: {
+      type: 'array',
+      items: { $ref: getSchemaPath(AccountResponseDto) },
+    },
   })
+  @ApiResponse({})
   async getAccounts(@Query() filter: Partial<IAccountsFilter>) {
     return this.accountsApplication.getAccounts(filter);
   }

packages/server/src/modules/Accounts/GetAccount.service.ts

@@ -6,6 +6,7 @@ import { TransformerInjectable } from '../Transformer/TransformerInjectable.serv
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { events } from '@/common/events/events';
 import { TenantModelProxy } from '../System/models/TenantBaseModel';
+import { AccountResponseDto } from './dtos/AccountResponse.dto';
 
 @Injectable()
 export class GetAccount {
@@ -19,9 +20,10 @@ export class GetAccount {
 
   /**
    * Retrieve the given account details.
-   * @param {number} accountId
+   * @param {number} accountId - The account id.
+   * @returns {Promise<IAccount>} - The account details.
    */
-  public getAccount = async (accountId: number) => {
+  public async getAccount(accountId: number): Promise<AccountResponseDto> {
     // Find the given account or throw not found error.
     const account = await this.accountModel()
       .query()
@@ -43,5 +45,5 @@ export class GetAccount {
     await this.eventEmitter.emitAsync(events.accounts.onViewed, eventPayload);
 
     return transformed;
-  };
+  }
 }

packages/server/src/modules/Accounts/dtos/AccountResponse.dto.ts

@@ -0,0 +1,171 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class AccountResponseDto {
+  @ApiProperty({
+    description: 'The unique identifier of the account',
+    example: 1,
+  })
+  id: number;
+
+  @ApiProperty({
+    description: 'The name of the account',
+    example: 'Cash Account',
+  })
+  name: string;
+
+  @ApiProperty({
+    description: 'The slug of the account',
+    example: 'cash-account',
+  })
+  slug: string;
+
+  @ApiProperty({
+    description: 'The code of the account',
+    example: '1001',
+  })
+  code: string;
+
+  @ApiProperty({
+    description: 'The index of the account',
+    example: 1,
+  })
+  index: number;
+
+  @ApiProperty({
+    description: 'The type of the account',
+    example: 'bank',
+  })
+  accountType: string;
+
+  @ApiProperty({
+    description: 'The formatted account type label',
+    example: 'Bank Account',
+  })
+  accountTypeLabel: string;
+
+  @ApiProperty({
+    description: 'The parent account ID',
+    example: null,
+  })
+  parentAccountId: number | null;
+
+  @ApiProperty({
+    description: 'Whether the account is predefined',
+    example: false,
+  })
+  predefined: boolean;
+
+  @ApiProperty({
+    description: 'The currency code of the account',
+    example: 'USD',
+  })
+  currencyCode: string;
+
+  @ApiProperty({
+    description: 'Whether the account is active',
+    example: true,
+  })
+  active: boolean;
+
+  @ApiProperty({
+    description: 'The bank balance of the account',
+    example: 5000.0,
+  })
+  bankBalance: number;
+
+  @ApiProperty({
+    description: 'The formatted bank balance',
+    example: '$5,000.00',
+  })
+  bankBalanceFormatted: string;
+
+  @ApiProperty({
+    description: 'The last feeds update timestamp',
+    example: '2024-03-20T10:30:00Z',
+  })
+  lastFeedsUpdatedAt: string | Date | null;
+
+  @ApiProperty({
+    description: 'The formatted last feeds update timestamp',
+    example: 'Mar 20, 2024 10:30 AM',
+  })
+  lastFeedsUpdatedAtFormatted: string;
+
+  @ApiProperty({
+    description: 'The amount of the account',
+    example: 5000.0,
+  })
+  amount: number;
+
+  @ApiProperty({
+    description: 'The formatted amount',
+    example: '$5,000.00',
+  })
+  formattedAmount: string;
+
+  @ApiProperty({
+    description: 'The Plaid item ID',
+    example: 'plaid-item-123',
+  })
+  plaidItemId: string;
+
+  @ApiProperty({
+    description: 'The Plaid account ID',
+    example: 'plaid-account-456',
+  })
+  plaidAccountId: string | null;
+
+  @ApiProperty({
+    description: 'Whether the feeds are active',
+    example: true,
+  })
+  isFeedsActive: boolean;
+
+  @ApiProperty({
+    description: 'Whether the account is syncing owner',
+    example: true,
+  })
+  isSyncingOwner: boolean;
+
+  @ApiProperty({
+    description: 'Whether the feeds are paused',
+    example: false,
+  })
+  isFeedsPaused: boolean;
+
+  @ApiProperty({
+    description: 'The account normal',
+    example: 'debit',
+  })
+  accountNormal: string;
+
+  @ApiProperty({
+    description: 'The formatted account normal',
+    example: 'Debit',
+  })
+  accountNormalFormatted: string;
+
+  @ApiProperty({
+    description: 'The flatten name with all dependant accounts names',
+    example: 'Assets: Cash Account',
+  })
+  flattenName: string;
+
+  @ApiProperty({
+    description: 'The account level in the hierarchy',
+    example: 2,
+  })
+  accountLevel?: number;
+
+  @ApiProperty({
+    description: 'The creation timestamp',
+    example: '2024-03-20T10:00:00Z',
+  })
+  createdAt: Date;
+
+  @ApiProperty({
+    description: 'The update timestamp',
+    example: '2024-03-20T10:30:00Z',
+  })
+  updatedAt: Date;
+}