🐛 Swagger File Updated

panoratech · Jul 24, 2024 · 78a2294 · 78a2294
1 parent 9903d82
commit 78a2294
Show file tree

Hide file tree

Showing 83 changed files with 885 additions and 686 deletions.
diff --git a/packages/api/src/accounting/account/account.controller.ts b/packages/api/src/accounting/account/account.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import {
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/account')
 @Controller('accounting/account')
 export class AccountController {
@@ -40,7 +42,7 @@ export class AccountController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingAccounts',
+    operationId: 'listAccountingAccounts',
     summary: 'List a batch of Accounts',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class AccountController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingAccount',
+    operationId: 'retrieveAccountingAccount',
     summary: 'Retrieve a Account',
     description: 'Retrieve a account from any connected Accounting software',
   })
@@ -120,7 +122,7 @@ export class AccountController {
   }
 
   @ApiOperation({
-    operationId: 'addAccount',
+    operationId: 'createAccountingAccount',
     summary: 'Create a Account',
     description: 'Create a account in any supported Accounting software',
   })

diff --git a/packages/api/src/accounting/address/address.controller.ts b/packages/api/src/accounting/address/address.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { AddressService } from './services/address.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/address')
 @Controller('accounting/address')
 export class AddressController {
@@ -40,7 +42,7 @@ export class AddressController {
   }
 
   @ApiOperation({
-    operationId: 'getAddresss',
+    operationId: 'listAccountingAddress',
     summary: 'List a batch of Addresss',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class AddressController {
   }
 
   @ApiOperation({
-    operationId: 'getAddress',
+    operationId: 'retrieveAccountingAddress',
     summary: 'Retrieve a Address',
     description: 'Retrieve a address from any connected Accounting software',
   })

diff --git a/packages/api/src/accounting/attachment/attachment.controller.ts b/packages/api/src/accounting/attachment/attachment.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { AttachmentService } from './services/attachment.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/attachment')
 @Controller('accounting/attachment')
 export class AttachmentController {
@@ -40,7 +42,7 @@ export class AttachmentController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingAttachments',
+    operationId: 'listAccountingAttachments',
     summary: 'List a batch of Attachments',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class AttachmentController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingAttachment',
+    operationId: 'retrieveAccountingAttachment',
     summary: 'Retrieve a Attachment',
     description: 'Retrieve a attachment from any connected Accounting software',
   })
@@ -120,7 +122,7 @@ export class AttachmentController {
   }
 
   @ApiOperation({
-    operationId: 'addAccountingAttachment',
+    operationId: 'createAccountingAttachment',
     summary: 'Create a Attachment',
     description: 'Create a attachment in any supported Accounting software',
   })

diff --git a/packages/api/src/accounting/balancesheet/balancesheet.controller.ts b/packages/api/src/accounting/balancesheet/balancesheet.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { BalanceSheetService } from './services/balancesheet.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/balancesheet')
 @Controller('accounting/balancesheet')
 export class BalanceSheetController {
@@ -40,7 +42,7 @@ export class BalanceSheetController {
   }
 
   @ApiOperation({
-    operationId: 'getBalanceSheets',
+    operationId: 'listAccountingBalanceSheets',
     summary: 'List a batch of BalanceSheets',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class BalanceSheetController {
   }
 
   @ApiOperation({
-    operationId: 'getBalanceSheet',
+    operationId: 'retrieveAccountingBalanceSheet',
     summary: 'Retrieve a BalanceSheet',
     description:
       'Retrieve a balancesheet from any connected Accounting software',

diff --git a/packages/api/src/accounting/cashflowstatement/cashflowstatement.controller.ts b/packages/api/src/accounting/cashflowstatement/cashflowstatement.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { CashflowStatementService } from './services/cashflowstatement.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/cashflowstatement')
 @Controller('accounting/cashflowstatement')
 export class CashflowStatementController {
@@ -40,7 +42,7 @@ export class CashflowStatementController {
   }
 
   @ApiOperation({
-    operationId: 'getCashflowStatements',
+    operationId: 'listAccountingCashflowStatement',
     summary: 'List a batch of CashflowStatements',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class CashflowStatementController {
   }
 
   @ApiOperation({
-    operationId: 'getCashflowStatement',
+    operationId: 'retrieveAccountingCashflowStatement',
     summary: 'Retrieve a CashflowStatement',
     description:
       'Retrieve a cashflowstatement from any connected Accounting software',

diff --git a/packages/api/src/accounting/companyinfo/companyinfo.controller.ts b/packages/api/src/accounting/companyinfo/companyinfo.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { CompanyInfoService } from './services/companyinfo.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/companyinfo')
 @Controller('accounting/companyinfo')
 export class CompanyInfoController {
@@ -40,7 +42,7 @@ export class CompanyInfoController {
   }
 
   @ApiOperation({
-    operationId: 'getCompanyInfos',
+    operationId: 'listAccountingCompanyInfos',
     summary: 'List a batch of CompanyInfos',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class CompanyInfoController {
   }
 
   @ApiOperation({
-    operationId: 'getCompanyInfo',
+    operationId: 'retrieveAccountingCompanyInfo',
     summary: 'Retrieve a CompanyInfo',
     description:
       'Retrieve a companyinfo from any connected Accounting software',

diff --git a/packages/api/src/accounting/contact/contact.controller.ts b/packages/api/src/accounting/contact/contact.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { ContactService } from './services/contact.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/contact')
 @Controller('accounting/contact')
 export class ContactController {
@@ -40,7 +42,7 @@ export class ContactController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingContacts',
+    operationId: 'listAccountingContacts',
     summary: 'List a batch of Contacts',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class ContactController {
   }
 
   @ApiOperation({
-    operationId: 'getAccountingContact',
+    operationId: 'retrieveAccountingContact',
     summary: 'Retrieve a Contact',
     description: 'Retrieve a contact from any connected Accounting software',
   })
@@ -120,7 +122,7 @@ export class ContactController {
   }
 
   @ApiOperation({
-    operationId: 'addAccountingContact',
+    operationId: 'createAccountingContact',
     summary: 'Create a Contact',
     description: 'Create a contact in any supported Accounting software',
   })

diff --git a/packages/api/src/accounting/creditnote/creditnote.controller.ts b/packages/api/src/accounting/creditnote/creditnote.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { CreditNoteService } from './services/creditnote.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/creditnote')
 @Controller('accounting/creditnote')
 export class CreditNoteController {
@@ -40,7 +42,7 @@ export class CreditNoteController {
   }
 
   @ApiOperation({
-    operationId: 'getCreditNotes',
+    operationId: 'listAccountingCreditNote',
     summary: 'List a batch of CreditNotes',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class CreditNoteController {
   }
 
   @ApiOperation({
-    operationId: 'getCreditNote',
+    operationId: 'retrieveAccountingCreditNote',
     summary: 'Retrieve a CreditNote',
     description: 'Retrieve a creditnote from any connected Accounting software',
   })

diff --git a/packages/api/src/accounting/expense/expense.controller.ts b/packages/api/src/accounting/expense/expense.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { ExpenseService } from './services/expense.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/expense')
 @Controller('accounting/expense')
 export class ExpenseController {
@@ -40,7 +42,7 @@ export class ExpenseController {
   }
 
   @ApiOperation({
-    operationId: 'getExpenses',
+    operationId: 'listAccountingExpense',
     summary: 'List a batch of Expenses',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class ExpenseController {
   }
 
   @ApiOperation({
-    operationId: 'getExpense',
+    operationId: 'retrieveAccountingExpense',
     summary: 'Retrieve a Expense',
     description: 'Retrieve a expense from any connected Accounting software',
   })
@@ -120,7 +122,7 @@ export class ExpenseController {
   }
 
   @ApiOperation({
-    operationId: 'addExpense',
+    operationId: 'createAccountingExpense',
     summary: 'Create a Expense',
     description: 'Create a expense in any supported Accounting software',
   })

diff --git a/packages/api/src/accounting/incomestatement/incomestatement.controller.ts b/packages/api/src/accounting/incomestatement/incomestatement.controller.ts
@@ -17,6 +17,7 @@ import {
   ApiQuery,
   ApiTags,
   ApiHeader,
+  ApiBearerAuth,
 } from '@nestjs/swagger';
 import { ApiCustomResponse } from '@@core/utils/types';
 import { IncomeStatementService } from './services/incomestatement.service';
@@ -28,6 +29,7 @@ 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';
 
+@ApiBearerAuth('bearer')
 @ApiTags('accounting/incomestatement')
 @Controller('accounting/incomestatement')
 export class IncomeStatementController {
@@ -40,7 +42,7 @@ export class IncomeStatementController {
   }
 
   @ApiOperation({
-    operationId: 'getIncomeStatements',
+    operationId: 'listAccountingIncomeStatement',
     summary: 'List a batch of IncomeStatements',
   })
   @ApiHeader({
@@ -76,7 +78,7 @@ export class IncomeStatementController {
   }
 
   @ApiOperation({
-    operationId: 'getIncomeStatement',
+    operationId: 'retrieveAccountingIncomeStatement',
     summary: 'Retrieve a IncomeStatement',
     description:
       'Retrieve a incomestatement from any connected Accounting software',