✨ Added pagination

panoratech · Aug 5, 2024 · 9fec88f · 9fec88f
1 parent 00a0b57
commit 9fec88f
Show file tree

Hide file tree

Showing 86 changed files with 2,810 additions and 197 deletions.
diff --git a/docs/mint.json b/docs/mint.json
@@ -739,14 +739,6 @@
             "api-reference/webhooks/update"
           ]
         },
-        {
-          "group": "Linked Users",
-          "pages": [
-            "api-reference/linked_users/create",
-            "api-reference/linked_users/list",
-            "api-reference/linked_users/retrieve"
-          ]
-        },
         {
           "group": "Organisations",
           "pages": [
@@ -767,14 +759,6 @@
             "api-reference/events/retrieve-events"
           ]
         },
-        {
-          "group": "Magic Links",
-          "pages": [
-            "api-reference/magic-link/create-a-magic-link",
-            "api-reference/magic-link/retrieve-magic-links",
-            "api-reference/magic-link/retrieve-a-magic-link"
-          ]
-        },
         {
           "group": "Passthrough",
           "pages": [

diff --git a/packages/api/scripts/commonObject.sh b/packages/api/scripts/commonObject.sh
@@ -315,7 +315,7 @@ private connectionUtils: ConnectionUtils
 @UseGuards(ApiKeyAuthGuard)  @Get()
   async list(
     @Headers('x-connection-token') connection_token: string,
-        @Query() query: FetchObjectsQueryDto,
+        @Query() query: QueryDto,
   ) {
     try{
       const { linkedUserId, remoteSource } =

diff --git a/...ore/utils/dtos/fetch-objects-query.dto.ts → ...ges/api/src/@core/utils/dtos/query.dto.ts b/...ore/utils/dtos/fetch-objects-query.dto.ts → ...ges/api/src/@core/utils/dtos/query.dto.ts
@@ -5,9 +5,11 @@ import { IsBoolean, IsNumber, IsOptional, IsUUID } from 'class-validator';
 // To provide a default limit
 const DEFAULT_PAGE_SIZE = 50;
 
-export class FetchObjectsQueryDto {
+export class QueryDto {
   @ApiProperty({
+    type: Boolean,
     name: 'remote_data',
+    example: true,
     description: 'Set to true to include data from the original software.',
     required: false,
   })
@@ -19,7 +21,9 @@ export class FetchObjectsQueryDto {
   remote_data: boolean;
 
   @ApiProperty({
+    type: Number,
     name: 'limit',
+    example: 10,
     required: false,
     description: 'Set to get the number of records.',
   })
@@ -29,6 +33,8 @@ export class FetchObjectsQueryDto {
   limit: number = DEFAULT_PAGE_SIZE;
 
   @ApiProperty({
+    type: String,
+    example: '1b8b05bb-5273-4012-b520-8657b0b90874',
     name: 'cursor',
     required: false,
     description: 'Set to get the number of records after this cursor.',

diff --git a/packages/api/src/accounting/account/account.controller.ts b/packages/api/src/accounting/account/account.controller.ts
@@ -27,7 +27,7 @@ import {
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
 import { AccountService } from './services/account.service';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -58,10 +58,19 @@ export class AccountController {
   })
   @ApiPaginatedResponse(UnifiedAccountingAccountOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getAccounts(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/address/address.controller.ts b/packages/api/src/accounting/address/address.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -57,10 +57,19 @@ export class AddressController {
   })
   @ApiPaginatedResponse(UnifiedAccountingAddressOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getAddresss(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/attachment/attachment.controller.ts b/packages/api/src/accounting/attachment/attachment.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -58,10 +58,19 @@ export class AttachmentController {
   })
   @ApiPaginatedResponse(UnifiedAccountingAttachmentOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getAttachments(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/balancesheet/balancesheet.controller.ts b/packages/api/src/accounting/balancesheet/balancesheet.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import { ApiGetCustomResponse, ApiPaginatedResponse } from '@@core/utils/dtos/openapi.respone.dto';
 
 
@@ -54,10 +54,19 @@ export class BalanceSheetController {
   })
   @ApiPaginatedResponse(UnifiedAccountingBalancesheetOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getBalanceSheets(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/cashflowstatement/cashflowstatement.controller.ts b/packages/api/src/accounting/cashflowstatement/cashflowstatement.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import { ApiGetCustomResponse, ApiPaginatedResponse } from '@@core/utils/dtos/openapi.respone.dto';
 
 
@@ -54,10 +54,19 @@ export class CashflowStatementController {
   })
   @ApiPaginatedResponse(UnifiedAccountingCashflowstatementOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getCashflowStatements(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/companyinfo/companyinfo.controller.ts b/packages/api/src/accounting/companyinfo/companyinfo.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import { ApiGetCustomResponse, ApiPaginatedResponse } from '@@core/utils/dtos/openapi.respone.dto';
 
 
@@ -54,10 +54,19 @@ export class CompanyInfoController {
   })
   @ApiPaginatedResponse(UnifiedAccountingCompanyinfoOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getCompanyInfos(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/contact/contact.controller.ts b/packages/api/src/accounting/contact/contact.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -58,10 +58,19 @@ export class ContactController {
   })
   @ApiPaginatedResponse(UnifiedAccountingContactOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getContacts(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/creditnote/creditnote.controller.ts b/packages/api/src/accounting/creditnote/creditnote.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -57,10 +57,19 @@ export class CreditNoteController {
   })
   @ApiPaginatedResponse(UnifiedAccountingCreditnoteOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getCreditNotes(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/expense/expense.controller.ts b/packages/api/src/accounting/expense/expense.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import {
   ApiGetCustomResponse,
   ApiPaginatedResponse,
@@ -58,10 +58,19 @@ export class ExpenseController {
   })
   @ApiPaginatedResponse(UnifiedAccountingExpenseOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getExpenses(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =

diff --git a/packages/api/src/accounting/incomestatement/incomestatement.controller.ts b/packages/api/src/accounting/incomestatement/incomestatement.controller.ts
@@ -27,7 +27,7 @@ import {
 } from './types/model.unified';
 import { ConnectionUtils } from '@@core/connections/@utils';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
-import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto';
+import { QueryDto } from '@@core/utils/dtos/query.dto';
 import { ApiGetCustomResponse, ApiPaginatedResponse } from '@@core/utils/dtos/openapi.respone.dto';
 
 
@@ -54,10 +54,19 @@ export class IncomeStatementController {
   })
   @ApiPaginatedResponse(UnifiedAccountingIncomestatementOutput)
   @UseGuards(ApiKeyAuthGuard)
+  @ApiQuery({
+    type: QueryDto,
+    example: {
+      remote_data: true,
+      limit: 10,
+      cursor: 'b008e199-eda9-4629-bd41-a01b6195864a',
+    },
+    required: false,
+  })
   @Get()
   async getIncomeStatements(
     @Headers('x-connection-token') connection_token: string,
-    @Query() query: FetchObjectsQueryDto,
+    @Query() query: QueryDto,
   ) {
     try {
       const { linkedUserId, remoteSource, connectionId, projectId } =