From 9fec88fb6c82063c7b050427f6248be0dc7d939e Mon Sep 17 00:00:00 2001 From: nael Date: Tue, 6 Aug 2024 00:19:51 +0200 Subject: [PATCH] :sparkles: Added pagination --- docs/mint.json | 16 - packages/api/scripts/commonObject.sh | 2 +- ...etch-objects-query.dto.ts => query.dto.ts} | 8 +- .../accounting/account/account.controller.ts | 13 +- .../accounting/address/address.controller.ts | 13 +- .../attachment/attachment.controller.ts | 13 +- .../balancesheet/balancesheet.controller.ts | 13 +- .../cashflowstatement.controller.ts | 13 +- .../companyinfo/companyinfo.controller.ts | 13 +- .../accounting/contact/contact.controller.ts | 13 +- .../creditnote/creditnote.controller.ts | 13 +- .../accounting/expense/expense.controller.ts | 13 +- .../incomestatement.controller.ts | 13 +- .../accounting/invoice/invoice.controller.ts | 13 +- .../src/accounting/item/item.controller.ts | 13 +- .../journalentry/journalentry.controller.ts | 13 +- .../accounting/payment/payment.controller.ts | 23 +- .../phonenumber/phonenumber.controller.ts | 13 +- .../purchaseorder/purchaseorder.controller.ts | 13 +- .../accounting/taxrate/taxrate.controller.ts | 13 +- .../trackingcategory.controller.ts | 13 +- .../transaction/transaction.controller.ts | 13 +- .../vendorcredit/vendorcredit.controller.ts | 13 +- .../src/ats/activity/activity.controller.ts | 13 +- .../ats/application/application.controller.ts | 13 +- .../ats/attachment/attachment.controller.ts | 13 +- .../src/ats/candidate/candidate.controller.ts | 13 +- .../ats/department/department.controller.ts | 13 +- .../api/src/ats/eeocs/eeocs.controller.ts | 13 +- .../src/ats/interview/interview.controller.ts | 13 +- packages/api/src/ats/job/job.controller.ts | 13 +- .../jobinterviewstage.controller.ts | 13 +- .../api/src/ats/offer/offer.controller.ts | 13 +- .../api/src/ats/office/office.controller.ts | 13 +- .../rejectreason/rejectreason.controller.ts | 13 +- .../src/ats/scorecard/scorecard.controller.ts | 13 +- packages/api/src/ats/tag/tag.controller.ts | 13 +- packages/api/src/ats/user/user.controller.ts | 13 +- .../api/src/crm/company/company.controller.ts | 14 +- .../api/src/crm/contact/contact.controller.ts | 13 +- packages/api/src/crm/deal/deal.controller.ts | 13 +- .../crm/engagement/engagement.controller.ts | 13 +- packages/api/src/crm/note/note.controller.ts | 13 +- .../api/src/crm/stage/stage.controller.ts | 13 +- packages/api/src/crm/task/task.controller.ts | 13 +- packages/api/src/crm/user/user.controller.ts | 13 +- .../src/filestorage/drive/drive.controller.ts | 13 +- .../src/filestorage/file/file.controller.ts | 13 +- .../filestorage/folder/folder.controller.ts | 13 +- .../src/filestorage/group/group.controller.ts | 4 +- .../src/filestorage/user/user.controller.ts | 4 +- .../src/hris/bankinfo/bankinfo.controller.ts | 13 +- .../src/hris/benefit/benefit.controller.ts | 13 +- .../src/hris/company/company.controller.ts | 13 +- .../hris/dependent/dependent.controller.ts | 13 +- .../src/hris/employee/employee.controller.ts | 13 +- .../employeepayrollrun.controller.ts | 13 +- .../employerbenefit.controller.ts | 13 +- .../hris/employment/employment.controller.ts | 13 +- .../api/src/hris/group/group.controller.ts | 13 +- .../src/hris/location/location.controller.ts | 13 +- .../src/hris/paygroup/paygroup.controller.ts | 13 +- .../hris/payrollrun/payrollrun.controller.ts | 13 +- .../src/hris/timeoff/timeoff.controller.ts | 13 +- .../timeoffbalance.controller.ts | 13 +- packages/api/src/main.ts | 4 +- .../action/action.controller.ts | 13 +- .../automation/automation.controller.ts | 13 +- .../campaign/campaign.controller.ts | 13 +- .../contact/contact.controller.ts | 13 +- .../email/email.controller.ts | 13 +- .../event/event.controller.ts | 13 +- .../list/list.controller.ts | 13 +- .../message/message.controller.ts | 13 +- .../template/template.controller.ts | 13 +- .../user/user.controller.ts | 13 +- .../ticketing/account/account.controller.ts | 13 +- .../attachment/attachment.controller.ts | 13 +- .../collection/collection.controller.ts | 13 +- .../ticketing/comment/comment.controller.ts | 13 +- .../ticketing/contact/contact.controller.ts | 13 +- .../api/src/ticketing/tag/tag.controller.ts | 13 +- .../api/src/ticketing/team/team.controller.ts | 13 +- .../src/ticketing/ticket/ticket.controller.ts | 13 +- .../api/src/ticketing/user/user.controller.ts | 13 +- packages/api/swagger/swagger-spec.yaml | 1931 ++++++++++++++++- 86 files changed, 2810 insertions(+), 197 deletions(-) rename packages/api/src/@core/utils/dtos/{fetch-objects-query.dto.ts => query.dto.ts} (85%) diff --git a/docs/mint.json b/docs/mint.json index cf93848f7..af11858d0 100644 --- 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 index 02ce85fdc..bf622eb29 100755 --- 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/packages/api/src/@core/utils/dtos/fetch-objects-query.dto.ts b/packages/api/src/@core/utils/dtos/query.dto.ts similarity index 85% rename from packages/api/src/@core/utils/dtos/fetch-objects-query.dto.ts rename to packages/api/src/@core/utils/dtos/query.dto.ts index 8c93ad93f..ea2391d64 100644 --- a/packages/api/src/@core/utils/dtos/fetch-objects-query.dto.ts +++ b/packages/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 index 9e376e39d..0136ad057 100644 --- 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 index 1487edf1b..db183b3e9 100644 --- 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 index d2dcbf4aa..ee665602a 100644 --- 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 index c3057ade0..08d05802f 100644 --- 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 index f48ed9fff..b1b54509e 100644 --- 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 index 5891fbe0b..7ecdd1d49 100644 --- 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 index 8bd0717b4..3d36ef4de 100644 --- 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 index 8a1024951..371c11e92 100644 --- 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 index 63f42050d..8e08e98d0 100644 --- 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 index 47dd2cb98..aa487f7aa 100644 --- 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 } = diff --git a/packages/api/src/accounting/invoice/invoice.controller.ts b/packages/api/src/accounting/invoice/invoice.controller.ts index 31b010e18..71d4d4b25 100644 --- a/packages/api/src/accounting/invoice/invoice.controller.ts +++ b/packages/api/src/accounting/invoice/invoice.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 InvoiceController { }) @ApiPaginatedResponse(UnifiedAccountingInvoiceOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getInvoices( @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/item/item.controller.ts b/packages/api/src/accounting/item/item.controller.ts index 08adfdf03..7d21717c0 100644 --- a/packages/api/src/accounting/item/item.controller.ts +++ b/packages/api/src/accounting/item/item.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 ItemController { }) @ApiPaginatedResponse(UnifiedAccountingItemOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getItems( @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/journalentry/journalentry.controller.ts b/packages/api/src/accounting/journalentry/journalentry.controller.ts index f046e2fa4..312d4d31c 100644 --- a/packages/api/src/accounting/journalentry/journalentry.controller.ts +++ b/packages/api/src/accounting/journalentry/journalentry.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 JournalEntryController { }) @ApiPaginatedResponse(UnifiedAccountingJournalentryOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getJournalEntrys( @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/payment/payment.controller.ts b/packages/api/src/accounting/payment/payment.controller.ts index 3b797a109..df61cc3f8 100644 --- a/packages/api/src/accounting/payment/payment.controller.ts +++ b/packages/api/src/accounting/payment/payment.controller.ts @@ -27,14 +27,13 @@ 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, ApiPostCustomResponse, } from '@@core/utils/dtos/openapi.respone.dto'; - @ApiTags('accounting/payments') @Controller('accounting/payments') export class PaymentController { @@ -58,10 +57,28 @@ export class PaymentController { }) @ApiPaginatedResponse(UnifiedAccountingPaymentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getPayments( @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/phonenumber/phonenumber.controller.ts b/packages/api/src/accounting/phonenumber/phonenumber.controller.ts index 1a8dfcf35..354e562d1 100644 --- a/packages/api/src/accounting/phonenumber/phonenumber.controller.ts +++ b/packages/api/src/accounting/phonenumber/phonenumber.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 PhoneNumberController { }) @ApiPaginatedResponse(UnifiedAccountingPhonenumberOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getPhoneNumbers( @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/purchaseorder/purchaseorder.controller.ts b/packages/api/src/accounting/purchaseorder/purchaseorder.controller.ts index 5d6fd002d..ced20b683 100644 --- a/packages/api/src/accounting/purchaseorder/purchaseorder.controller.ts +++ b/packages/api/src/accounting/purchaseorder/purchaseorder.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 PurchaseOrderController { }) @ApiPaginatedResponse(UnifiedAccountingPurchaseorderOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getPurchaseOrders( @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/taxrate/taxrate.controller.ts b/packages/api/src/accounting/taxrate/taxrate.controller.ts index 0ea37f219..d8164966b 100644 --- a/packages/api/src/accounting/taxrate/taxrate.controller.ts +++ b/packages/api/src/accounting/taxrate/taxrate.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 TaxRateController { }) @ApiPaginatedResponse(UnifiedAccountingTaxrateOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTaxRates( @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/trackingcategory/trackingcategory.controller.ts b/packages/api/src/accounting/trackingcategory/trackingcategory.controller.ts index 3f15cc0a3..70f465d5f 100644 --- a/packages/api/src/accounting/trackingcategory/trackingcategory.controller.ts +++ b/packages/api/src/accounting/trackingcategory/trackingcategory.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 TrackingCategoryController { }) @ApiPaginatedResponse(UnifiedAccountingTrackingcategoryOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTrackingCategorys( @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/transaction/transaction.controller.ts b/packages/api/src/accounting/transaction/transaction.controller.ts index e40f1bfbb..a2232e022 100644 --- a/packages/api/src/accounting/transaction/transaction.controller.ts +++ b/packages/api/src/accounting/transaction/transaction.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 TransactionController { }) @ApiPaginatedResponse(UnifiedAccountingTransactionOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTransactions( @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/vendorcredit/vendorcredit.controller.ts b/packages/api/src/accounting/vendorcredit/vendorcredit.controller.ts index 2a62149d6..aafe64aa8 100644 --- a/packages/api/src/accounting/vendorcredit/vendorcredit.controller.ts +++ b/packages/api/src/accounting/vendorcredit/vendorcredit.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 VendorCreditController { }) @ApiPaginatedResponse(UnifiedAccountingVendorcreditOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getVendorCredits( @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/ats/activity/activity.controller.ts b/packages/api/src/ats/activity/activity.controller.ts index 0e9e9848d..30f24530c 100644 --- a/packages/api/src/ats/activity/activity.controller.ts +++ b/packages/api/src/ats/activity/activity.controller.ts @@ -26,7 +26,7 @@ import { import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ActivityService } from './services/activity.service'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { ApiGetCustomResponse, ApiPaginatedResponse, @@ -56,10 +56,19 @@ export class ActivityController { }) @ApiPaginatedResponse(UnifiedAtsActivityOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getActivitys( @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/ats/application/application.controller.ts b/packages/api/src/ats/application/application.controller.ts index 69f6d0082..2ab6033d7 100644 --- a/packages/api/src/ats/application/application.controller.ts +++ b/packages/api/src/ats/application/application.controller.ts @@ -27,7 +27,7 @@ import { import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ApplicationService } from './services/application.service'; -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 ApplicationController { }) @ApiPaginatedResponse(UnifiedAtsApplicationOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getApplications( @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/ats/attachment/attachment.controller.ts b/packages/api/src/ats/attachment/attachment.controller.ts index c5c64f975..264ffe513 100644 --- a/packages/api/src/ats/attachment/attachment.controller.ts +++ b/packages/api/src/ats/attachment/attachment.controller.ts @@ -27,7 +27,7 @@ import { import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { AttachmentService } from './services/attachment.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 AttachmentController { }) @ApiPaginatedResponse(UnifiedAtsAttachmentOutput) @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/ats/candidate/candidate.controller.ts b/packages/api/src/ats/candidate/candidate.controller.ts index 44204f418..3301c23ce 100644 --- a/packages/api/src/ats/candidate/candidate.controller.ts +++ b/packages/api/src/ats/candidate/candidate.controller.ts @@ -27,7 +27,7 @@ import { import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { CandidateService } from './services/candidate.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 CandidateController { }) @ApiPaginatedResponse(UnifiedAtsCandidateOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getCandidates( @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/ats/department/department.controller.ts b/packages/api/src/ats/department/department.controller.ts index fe76a8ba4..fda0421e1 100644 --- a/packages/api/src/ats/department/department.controller.ts +++ b/packages/api/src/ats/department/department.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 DepartmentController { }) @ApiPaginatedResponse(UnifiedAtsDepartmentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getDepartments( @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/ats/eeocs/eeocs.controller.ts b/packages/api/src/ats/eeocs/eeocs.controller.ts index 1f869caac..44b52062d 100644 --- a/packages/api/src/ats/eeocs/eeocs.controller.ts +++ b/packages/api/src/ats/eeocs/eeocs.controller.ts @@ -27,7 +27,7 @@ import { import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { EeocsService } from './services/eeocs.service'; -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 EeocsController { }) @ApiPaginatedResponse(UnifiedAtsEeocsOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEeocss( @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/ats/interview/interview.controller.ts b/packages/api/src/ats/interview/interview.controller.ts index b2bfde07a..88ecdf8a5 100644 --- a/packages/api/src/ats/interview/interview.controller.ts +++ b/packages/api/src/ats/interview/interview.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 InterviewController { }) @ApiPaginatedResponse(UnifiedAtsInterviewOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getInterviews( @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/ats/job/job.controller.ts b/packages/api/src/ats/job/job.controller.ts index 325399c1c..06e42b0ba 100644 --- a/packages/api/src/ats/job/job.controller.ts +++ b/packages/api/src/ats/job/job.controller.ts @@ -24,7 +24,7 @@ import { JobService } from './services/job.service'; import { UnifiedAtsJobInput, UnifiedAtsJobOutput } 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, @@ -54,10 +54,19 @@ export class JobController { }) @ApiPaginatedResponse(UnifiedAtsJobOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getJobs( @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/ats/jobinterviewstage/jobinterviewstage.controller.ts b/packages/api/src/ats/jobinterviewstage/jobinterviewstage.controller.ts index 0bab118f7..fe1b7127c 100644 --- a/packages/api/src/ats/jobinterviewstage/jobinterviewstage.controller.ts +++ b/packages/api/src/ats/jobinterviewstage/jobinterviewstage.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 JobInterviewStageController { }) @ApiPaginatedResponse(UnifiedAtsJobinterviewstageOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getJobInterviewStages( @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/ats/offer/offer.controller.ts b/packages/api/src/ats/offer/offer.controller.ts index 08c9ba079..54b0d2c95 100644 --- a/packages/api/src/ats/offer/offer.controller.ts +++ b/packages/api/src/ats/offer/offer.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 OfferController { }) @ApiPaginatedResponse(UnifiedAtsOfferOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getOffers( @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/ats/office/office.controller.ts b/packages/api/src/ats/office/office.controller.ts index b2bf50e25..0f596b7c1 100644 --- a/packages/api/src/ats/office/office.controller.ts +++ b/packages/api/src/ats/office/office.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 OfficeController { }) @ApiPaginatedResponse(UnifiedAtsOfficeOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getOffices( @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/ats/rejectreason/rejectreason.controller.ts b/packages/api/src/ats/rejectreason/rejectreason.controller.ts index c989c303e..09d2f2033 100644 --- a/packages/api/src/ats/rejectreason/rejectreason.controller.ts +++ b/packages/api/src/ats/rejectreason/rejectreason.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 RejectReasonController { }) @ApiPaginatedResponse(UnifiedAtsRejectreasonOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getRejectReasons( @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/ats/scorecard/scorecard.controller.ts b/packages/api/src/ats/scorecard/scorecard.controller.ts index 95ff06fff..12b858475 100644 --- a/packages/api/src/ats/scorecard/scorecard.controller.ts +++ b/packages/api/src/ats/scorecard/scorecard.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 ScoreCardController { }) @ApiPaginatedResponse(UnifiedAtsScorecardOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getScoreCards( @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/ats/tag/tag.controller.ts b/packages/api/src/ats/tag/tag.controller.ts index 7dbae2b54..5108a05c0 100644 --- a/packages/api/src/ats/tag/tag.controller.ts +++ b/packages/api/src/ats/tag/tag.controller.ts @@ -23,7 +23,7 @@ import { TagService } from './services/tag.service'; import { UnifiedAtsTagInput, UnifiedAtsTagOutput } 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, @@ -53,10 +53,19 @@ export class TagController { }) @ApiPaginatedResponse(UnifiedAtsTagOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTags( @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/ats/user/user.controller.ts b/packages/api/src/ats/user/user.controller.ts index 241d53dcf..3179164f0 100644 --- a/packages/api/src/ats/user/user.controller.ts +++ b/packages/api/src/ats/user/user.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, @@ -56,10 +56,19 @@ export class UserController { }) @ApiPaginatedResponse(UnifiedAtsUserOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getUsers( @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/crm/company/company.controller.ts b/packages/api/src/crm/company/company.controller.ts index 550153048..aed242872 100644 --- a/packages/api/src/crm/company/company.controller.ts +++ b/packages/api/src/crm/company/company.controller.ts @@ -1,7 +1,7 @@ import { LoggerService } from '@@core/@core-services/logger/logger.service'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ConnectionUtils } from '@@core/connections/@utils'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { Body, @@ -35,7 +35,6 @@ import { ApiPostCustomResponse, } from '@@core/utils/dtos/openapi.respone.dto'; - @ApiTags('crm/companies') @Controller('crm/companies') export class CompanyController { @@ -59,11 +58,20 @@ export class CompanyController { }) @ApiPaginatedResponse(UnifiedCrmCompanyOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getCompanies( @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/crm/contact/contact.controller.ts b/packages/api/src/crm/contact/contact.controller.ts index 705860ddd..11062d508 100644 --- a/packages/api/src/crm/contact/contact.controller.ts +++ b/packages/api/src/crm/contact/contact.controller.ts @@ -1,7 +1,7 @@ import { LoggerService } from '@@core/@core-services/logger/logger.service'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ConnectionUtils } from '@@core/connections/@utils'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { Body, @@ -62,11 +62,20 @@ export class ContactController { }) @ApiPaginatedResponse(UnifiedCrmContactOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) 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/crm/deal/deal.controller.ts b/packages/api/src/crm/deal/deal.controller.ts index 8691e662f..939e6bf70 100644 --- a/packages/api/src/crm/deal/deal.controller.ts +++ b/packages/api/src/crm/deal/deal.controller.ts @@ -29,7 +29,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, @@ -60,11 +60,20 @@ export class DealController { }) @ApiPaginatedResponse(UnifiedCrmDealOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getDeals( @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/crm/engagement/engagement.controller.ts b/packages/api/src/crm/engagement/engagement.controller.ts index e6f20c8e0..ebcdc5e2d 100644 --- a/packages/api/src/crm/engagement/engagement.controller.ts +++ b/packages/api/src/crm/engagement/engagement.controller.ts @@ -29,7 +29,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, @@ -60,11 +60,20 @@ export class EngagementController { }) @ApiPaginatedResponse(UnifiedCrmEngagementOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getEngagements( @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/crm/note/note.controller.ts b/packages/api/src/crm/note/note.controller.ts index 0d0a57b55..2b2d06cdc 100644 --- a/packages/api/src/crm/note/note.controller.ts +++ b/packages/api/src/crm/note/note.controller.ts @@ -28,7 +28,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, @@ -59,11 +59,20 @@ export class NoteController { }) @ApiPaginatedResponse(UnifiedCrmNoteOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getNotes( @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/crm/stage/stage.controller.ts b/packages/api/src/crm/stage/stage.controller.ts index edbddf0ec..d57fe7ac1 100644 --- a/packages/api/src/crm/stage/stage.controller.ts +++ b/packages/api/src/crm/stage/stage.controller.ts @@ -22,7 +22,7 @@ import { StageService } from './services/stage.service'; import { UnifiedCrmStageOutput } 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, @@ -52,11 +52,20 @@ export class StageController { }) @ApiPaginatedResponse(UnifiedCrmStageOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getStages( @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/crm/task/task.controller.ts b/packages/api/src/crm/task/task.controller.ts index 81f4ad4e9..c5e57db77 100644 --- a/packages/api/src/crm/task/task.controller.ts +++ b/packages/api/src/crm/task/task.controller.ts @@ -29,7 +29,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, @@ -60,11 +60,20 @@ export class TaskController { }) @ApiPaginatedResponse(UnifiedCrmTaskOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getTasks( @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/crm/user/user.controller.ts b/packages/api/src/crm/user/user.controller.ts index ae2d562f8..f3bc3479f 100644 --- a/packages/api/src/crm/user/user.controller.ts +++ b/packages/api/src/crm/user/user.controller.ts @@ -22,7 +22,7 @@ import { UserService } from './services/user.service'; import { UnifiedCrmUserOutput } 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, @@ -52,11 +52,20 @@ export class UserController { }) @ApiPaginatedResponse(UnifiedCrmUserOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getUsers( @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/filestorage/drive/drive.controller.ts b/packages/api/src/filestorage/drive/drive.controller.ts index 6613cebc3..38acffcb7 100644 --- a/packages/api/src/filestorage/drive/drive.controller.ts +++ b/packages/api/src/filestorage/drive/drive.controller.ts @@ -21,7 +21,7 @@ import { DriveService } from './services/drive.service'; import { UnifiedFilestorageDriveOutput } 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, @@ -52,10 +52,19 @@ export class DriveController { @ApiPaginatedResponse(UnifiedFilestorageDriveOutput) @UseGuards(ApiKeyAuthGuard) @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getDrives( @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/filestorage/file/file.controller.ts b/packages/api/src/filestorage/file/file.controller.ts index c947cace3..46d479a1e 100644 --- a/packages/api/src/filestorage/file/file.controller.ts +++ b/packages/api/src/filestorage/file/file.controller.ts @@ -28,7 +28,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, @@ -60,10 +60,19 @@ export class FileController { @ApiPaginatedResponse(UnifiedFilestorageFileOutput) @UseGuards(ApiKeyAuthGuard) @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getFiles( @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/filestorage/folder/folder.controller.ts b/packages/api/src/filestorage/folder/folder.controller.ts index 6a8f5a515..c6fdc46ef 100644 --- a/packages/api/src/filestorage/folder/folder.controller.ts +++ b/packages/api/src/filestorage/folder/folder.controller.ts @@ -28,7 +28,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, @@ -61,10 +61,19 @@ export class FolderController { @ApiPaginatedResponse(UnifiedFilestorageFolderOutput) @UseGuards(ApiKeyAuthGuard) @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getFolders( @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/filestorage/group/group.controller.ts b/packages/api/src/filestorage/group/group.controller.ts index c902653e0..ed1ea03bd 100644 --- a/packages/api/src/filestorage/group/group.controller.ts +++ b/packages/api/src/filestorage/group/group.controller.ts @@ -29,7 +29,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, @@ -63,7 +63,7 @@ export class GroupController { @Get() async list( @Headers('x-connection-token') connection_token: string, - @Query() query: FetchObjectsQueryDto, + @Query() query: QueryDto, ) { try { const { connectionId, projectId, linkedUserId, remoteSource } = diff --git a/packages/api/src/filestorage/user/user.controller.ts b/packages/api/src/filestorage/user/user.controller.ts index f7dd5ddae..7caffee44 100644 --- a/packages/api/src/filestorage/user/user.controller.ts +++ b/packages/api/src/filestorage/user/user.controller.ts @@ -21,7 +21,7 @@ import { UserService } from './services/user.service'; import { UnifiedFilestorageUserOutput } 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, @@ -55,7 +55,7 @@ export class UserController { @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async list( @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/hris/bankinfo/bankinfo.controller.ts b/packages/api/src/hris/bankinfo/bankinfo.controller.ts index ca8264617..05979dd78 100644 --- a/packages/api/src/hris/bankinfo/bankinfo.controller.ts +++ b/packages/api/src/hris/bankinfo/bankinfo.controller.ts @@ -26,7 +26,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, @@ -56,10 +56,19 @@ export class BankinfoController { }) @ApiPaginatedResponse(UnifiedHrisBankinfoOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getBankInfo( @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/hris/benefit/benefit.controller.ts b/packages/api/src/hris/benefit/benefit.controller.ts index e676ea6d6..4192070b3 100644 --- a/packages/api/src/hris/benefit/benefit.controller.ts +++ b/packages/api/src/hris/benefit/benefit.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 BenefitController { }) @ApiPaginatedResponse(UnifiedHrisBenefitOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getBenefits( @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/hris/company/company.controller.ts b/packages/api/src/hris/company/company.controller.ts index d1a00759d..dd3ccb347 100644 --- a/packages/api/src/hris/company/company.controller.ts +++ b/packages/api/src/hris/company/company.controller.ts @@ -24,7 +24,7 @@ import { UnifiedHrisCompanyOutput } from './types/model.unified'; import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { CompanyService } from './services/company.service'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { ApiGetCustomResponse, ApiPaginatedResponse, @@ -55,10 +55,19 @@ export class CompanyController { }) @ApiPaginatedResponse(UnifiedHrisCompanyOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getCompanies( @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/hris/dependent/dependent.controller.ts b/packages/api/src/hris/dependent/dependent.controller.ts index 7bd3e756b..4cc7e2ff8 100644 --- a/packages/api/src/hris/dependent/dependent.controller.ts +++ b/packages/api/src/hris/dependent/dependent.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 DependentController { }) @ApiPaginatedResponse(UnifiedHrisDependentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getDependents( @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/hris/employee/employee.controller.ts b/packages/api/src/hris/employee/employee.controller.ts index 68640c008..e2e02e66e 100644 --- a/packages/api/src/hris/employee/employee.controller.ts +++ b/packages/api/src/hris/employee/employee.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 EmployeeController { }) @ApiPaginatedResponse(UnifiedHrisEmployeeOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEmployees( @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/hris/employeepayrollrun/employeepayrollrun.controller.ts b/packages/api/src/hris/employeepayrollrun/employeepayrollrun.controller.ts index 7b0016a85..b855265c4 100644 --- a/packages/api/src/hris/employeepayrollrun/employeepayrollrun.controller.ts +++ b/packages/api/src/hris/employeepayrollrun/employeepayrollrun.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 EmployeePayrollRunController { }) @ApiPaginatedResponse(UnifiedHrisEmployeepayrollrunOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEmployeePayrollRuns( @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/hris/employerbenefit/employerbenefit.controller.ts b/packages/api/src/hris/employerbenefit/employerbenefit.controller.ts index c678b280d..351e58a45 100644 --- a/packages/api/src/hris/employerbenefit/employerbenefit.controller.ts +++ b/packages/api/src/hris/employerbenefit/employerbenefit.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 EmployerBenefitController { }) @ApiPaginatedResponse(UnifiedHrisEmployerbenefitOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEmployerBenefits( @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/hris/employment/employment.controller.ts b/packages/api/src/hris/employment/employment.controller.ts index 694d20fc3..d6abcd02b 100644 --- a/packages/api/src/hris/employment/employment.controller.ts +++ b/packages/api/src/hris/employment/employment.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 EmploymentController { }) @ApiPaginatedResponse(UnifiedHrisEmploymentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEmployments( @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/hris/group/group.controller.ts b/packages/api/src/hris/group/group.controller.ts index ef3438943..99bc9f68a 100644 --- a/packages/api/src/hris/group/group.controller.ts +++ b/packages/api/src/hris/group/group.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 GroupController { }) @ApiPaginatedResponse(UnifiedHrisGroupOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getGroups( @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/hris/location/location.controller.ts b/packages/api/src/hris/location/location.controller.ts index 39c102ae1..353cbbb0c 100644 --- a/packages/api/src/hris/location/location.controller.ts +++ b/packages/api/src/hris/location/location.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 LocationController { }) @ApiPaginatedResponse(UnifiedHrisLocationOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getLocations( @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/hris/paygroup/paygroup.controller.ts b/packages/api/src/hris/paygroup/paygroup.controller.ts index 6ac625150..046f60890 100644 --- a/packages/api/src/hris/paygroup/paygroup.controller.ts +++ b/packages/api/src/hris/paygroup/paygroup.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 PayGroupController { }) @ApiPaginatedResponse(UnifiedHrisPaygroupOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getPayGroups( @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/hris/payrollrun/payrollrun.controller.ts b/packages/api/src/hris/payrollrun/payrollrun.controller.ts index fddf254a4..69627d7e7 100644 --- a/packages/api/src/hris/payrollrun/payrollrun.controller.ts +++ b/packages/api/src/hris/payrollrun/payrollrun.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 PayrollRunController { }) @ApiPaginatedResponse(UnifiedHrisPayrollrunOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getPayrollRuns( @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/hris/timeoff/timeoff.controller.ts b/packages/api/src/hris/timeoff/timeoff.controller.ts index eab61443f..5b5aefbe4 100644 --- a/packages/api/src/hris/timeoff/timeoff.controller.ts +++ b/packages/api/src/hris/timeoff/timeoff.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 TimeoffController { }) @ApiPaginatedResponse(UnifiedHrisTimeoffOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTimeoffs( @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/hris/timeoffbalance/timeoffbalance.controller.ts b/packages/api/src/hris/timeoffbalance/timeoffbalance.controller.ts index 10282ae21..b3c6b5762 100644 --- a/packages/api/src/hris/timeoffbalance/timeoffbalance.controller.ts +++ b/packages/api/src/hris/timeoffbalance/timeoffbalance.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 TimeoffBalanceController { }) @ApiPaginatedResponse(UnifiedHrisTimeoffbalanceOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTimeoffBalances( @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/main.ts b/packages/api/src/main.ts index 197885c4f..5767d1c83 100644 --- a/packages/api/src/main.ts +++ b/packages/api/src/main.ts @@ -18,9 +18,9 @@ function addSpeakeasyGroup(document: any) { groupName = 'webhooks'; } else if (pathParts[0] === 'sync') { groupName = 'sync'; - } else if (pathParts[0] === 'linked-users') { + } else if (pathParts[0] === 'linked_users') { groupName = 'linkedUsers'; - } else if (pathParts[0] === 'field-mappings') { + } else if (pathParts[0] === 'field_mappings') { groupName = 'fieldMappings'; } else if (pathParts.length >= 2) { groupName = `${pathParts[0].toLowerCase()}.${pathParts[1].toLowerCase()}`; diff --git a/packages/api/src/marketingautomation/action/action.controller.ts b/packages/api/src/marketingautomation/action/action.controller.ts index b0a2e16f7..102ea1ce9 100644 --- a/packages/api/src/marketingautomation/action/action.controller.ts +++ b/packages/api/src/marketingautomation/action/action.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 ActionController { }) @ApiPaginatedResponse(UnifiedMarketingautomationActionOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getActions( @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/marketingautomation/automation/automation.controller.ts b/packages/api/src/marketingautomation/automation/automation.controller.ts index 34c643516..3607d772a 100644 --- a/packages/api/src/marketingautomation/automation/automation.controller.ts +++ b/packages/api/src/marketingautomation/automation/automation.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 AutomationController { }) @ApiPaginatedResponse(UnifiedMarketingautomationAutomationOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getAutomations( @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/marketingautomation/campaign/campaign.controller.ts b/packages/api/src/marketingautomation/campaign/campaign.controller.ts index f87b5df30..0dcaf790f 100644 --- a/packages/api/src/marketingautomation/campaign/campaign.controller.ts +++ b/packages/api/src/marketingautomation/campaign/campaign.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 CampaignController { }) @ApiPaginatedResponse(UnifiedMarketingautomationCampaignOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getCampaigns( @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/marketingautomation/contact/contact.controller.ts b/packages/api/src/marketingautomation/contact/contact.controller.ts index 5850c166b..542dbce4e 100644 --- a/packages/api/src/marketingautomation/contact/contact.controller.ts +++ b/packages/api/src/marketingautomation/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(UnifiedMarketingautomationContactOutput) @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/marketingautomation/email/email.controller.ts b/packages/api/src/marketingautomation/email/email.controller.ts index 6c515ead0..d6df042f7 100644 --- a/packages/api/src/marketingautomation/email/email.controller.ts +++ b/packages/api/src/marketingautomation/email/email.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 EmailController { }) @ApiPaginatedResponse(UnifiedMarketingautomationEmailOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEmails( @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/marketingautomation/event/event.controller.ts b/packages/api/src/marketingautomation/event/event.controller.ts index 861a39087..53c4385b3 100644 --- a/packages/api/src/marketingautomation/event/event.controller.ts +++ b/packages/api/src/marketingautomation/event/event.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 EventController { }) @ApiPaginatedResponse(UnifiedMarketingautomationEventOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getEvents( @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/marketingautomation/list/list.controller.ts b/packages/api/src/marketingautomation/list/list.controller.ts index 243ef32dc..91433395c 100644 --- a/packages/api/src/marketingautomation/list/list.controller.ts +++ b/packages/api/src/marketingautomation/list/list.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 ListController { }) @ApiPaginatedResponse(UnifiedMarketingautomationListOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getLists( @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/marketingautomation/message/message.controller.ts b/packages/api/src/marketingautomation/message/message.controller.ts index c3a26e4f8..594ef0e22 100644 --- a/packages/api/src/marketingautomation/message/message.controller.ts +++ b/packages/api/src/marketingautomation/message/message.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 MessageController { }) @ApiPaginatedResponse(UnifiedMarketingautomationMessageOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getMessages( @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/marketingautomation/template/template.controller.ts b/packages/api/src/marketingautomation/template/template.controller.ts index 3ba6ee205..5bf6f835f 100644 --- a/packages/api/src/marketingautomation/template/template.controller.ts +++ b/packages/api/src/marketingautomation/template/template.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 TemplateController { }) @ApiPaginatedResponse(UnifiedMarketingautomationTemplateOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getTemplates( @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/marketingautomation/user/user.controller.ts b/packages/api/src/marketingautomation/user/user.controller.ts index 9ebb600be..a28019de0 100644 --- a/packages/api/src/marketingautomation/user/user.controller.ts +++ b/packages/api/src/marketingautomation/user/user.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 UserController { }) @ApiPaginatedResponse(UnifiedMarketingautomationUserOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() async getUsers( @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/ticketing/account/account.controller.ts b/packages/api/src/ticketing/account/account.controller.ts index e742db840..c2deb0629 100644 --- a/packages/api/src/ticketing/account/account.controller.ts +++ b/packages/api/src/ticketing/account/account.controller.ts @@ -22,7 +22,7 @@ import { AccountService } from './services/account.service'; import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { UnifiedTicketingAccountOutput } from './types/model.unified'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { ApiGetCustomResponse, ApiPaginatedResponse, @@ -52,11 +52,20 @@ export class AccountController { }) @ApiPaginatedResponse(UnifiedTicketingAccountOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) 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/ticketing/attachment/attachment.controller.ts b/packages/api/src/ticketing/attachment/attachment.controller.ts index c518a6ebd..dfd4f6f0b 100644 --- a/packages/api/src/ticketing/attachment/attachment.controller.ts +++ b/packages/api/src/ticketing/attachment/attachment.controller.ts @@ -28,7 +28,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, @@ -59,11 +59,20 @@ export class AttachmentController { }) @ApiPaginatedResponse(UnifiedTicketingAttachmentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) 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/ticketing/collection/collection.controller.ts b/packages/api/src/ticketing/collection/collection.controller.ts index 3efb49c34..9d84efd90 100644 --- a/packages/api/src/ticketing/collection/collection.controller.ts +++ b/packages/api/src/ticketing/collection/collection.controller.ts @@ -29,7 +29,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, @@ -59,11 +59,20 @@ export class CollectionController { }) @ApiPaginatedResponse(UnifiedTicketingCollectionOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getCollections( @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/ticketing/comment/comment.controller.ts b/packages/api/src/ticketing/comment/comment.controller.ts index 2cd67b144..12a05dd1a 100644 --- a/packages/api/src/ticketing/comment/comment.controller.ts +++ b/packages/api/src/ticketing/comment/comment.controller.ts @@ -1,7 +1,7 @@ import { LoggerService } from '@@core/@core-services/logger/logger.service'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ConnectionUtils } from '@@core/connections/@utils'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { Body, @@ -60,11 +60,20 @@ export class CommentController { }) @ApiPaginatedResponse(UnifiedTicketingCommentOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getComments( @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/ticketing/contact/contact.controller.ts b/packages/api/src/ticketing/contact/contact.controller.ts index aa4336ad0..993cd3d8d 100644 --- a/packages/api/src/ticketing/contact/contact.controller.ts +++ b/packages/api/src/ticketing/contact/contact.controller.ts @@ -1,7 +1,7 @@ import { LoggerService } from '@@core/@core-services/logger/logger.service'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { ConnectionUtils } from '@@core/connections/@utils'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { Controller, @@ -52,11 +52,20 @@ export class ContactController { }) @ApiPaginatedResponse(UnifiedTicketingContactOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) 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/ticketing/tag/tag.controller.ts b/packages/api/src/ticketing/tag/tag.controller.ts index 9ed5b9fc3..9d6f3e209 100644 --- a/packages/api/src/ticketing/tag/tag.controller.ts +++ b/packages/api/src/ticketing/tag/tag.controller.ts @@ -22,7 +22,7 @@ import { TagService } from './services/tag.service'; import { ConnectionUtils } from '@@core/connections/@utils'; import { UnifiedTicketingTagOutput } from './types/model.unified'; 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, @@ -52,11 +52,20 @@ export class TagController { }) @ApiPaginatedResponse(UnifiedTicketingTagOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getTags( @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/ticketing/team/team.controller.ts b/packages/api/src/ticketing/team/team.controller.ts index 8fcc9a141..a6476e9f4 100644 --- a/packages/api/src/ticketing/team/team.controller.ts +++ b/packages/api/src/ticketing/team/team.controller.ts @@ -22,7 +22,7 @@ import { TeamService } from './services/team.service'; import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { UnifiedTicketingTeamOutput } from './types/model.unified'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { ApiGetCustomResponse, ApiPaginatedResponse, @@ -52,11 +52,20 @@ export class TeamController { }) @ApiPaginatedResponse(UnifiedTicketingTeamOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getTeams( @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/ticketing/ticket/ticket.controller.ts b/packages/api/src/ticketing/ticket/ticket.controller.ts index d9404e9b9..a2091211e 100644 --- a/packages/api/src/ticketing/ticket/ticket.controller.ts +++ b/packages/api/src/ticketing/ticket/ticket.controller.ts @@ -29,7 +29,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, @@ -61,11 +61,20 @@ export class TicketController { }) @ApiPaginatedResponse(UnifiedTicketingTicketOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getTickets( @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/ticketing/user/user.controller.ts b/packages/api/src/ticketing/user/user.controller.ts index 3beb5714e..f8cca8067 100644 --- a/packages/api/src/ticketing/user/user.controller.ts +++ b/packages/api/src/ticketing/user/user.controller.ts @@ -22,7 +22,7 @@ import { UserService } from './services/user.service'; import { ConnectionUtils } from '@@core/connections/@utils'; import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard'; import { UnifiedTicketingUserOutput } from './types/model.unified'; -import { FetchObjectsQueryDto } from '@@core/utils/dtos/fetch-objects-query.dto'; +import { QueryDto } from '@@core/utils/dtos/query.dto'; import { ApiGetCustomResponse, ApiPaginatedResponse, @@ -52,11 +52,20 @@ export class UserController { }) @ApiPaginatedResponse(UnifiedTicketingUserOutput) @UseGuards(ApiKeyAuthGuard) + @ApiQuery({ + type: QueryDto, + example: { + remote_data: true, + limit: 10, + cursor: 'b008e199-eda9-4629-bd41-a01b6195864a', + }, + required: false, + }) @Get() @UsePipes(new ValidationPipe({ transform: true, disableErrorMessages: true })) async getUsers( @Headers('x-connection-token') connection_token: string, - @Query() query: FetchObjectsQueryDto, + @Query() query: QueryDto, ) { const { linkedUserId, remoteSource, connectionId, projectId } = await this.connectionUtils.getConnectionMetadataFromConnectionToken( diff --git a/packages/api/swagger/swagger-spec.yaml b/packages/api/swagger/swagger-spec.yaml index 604c7ad72..f104ebf8c 100644 --- a/packages/api/swagger/swagger-spec.yaml +++ b/packages/api/swagger/swagger-spec.yaml @@ -173,19 +173,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -286,19 +310,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -366,19 +414,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -444,19 +516,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -568,19 +664,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -681,19 +801,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -794,21 +938,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -906,19 +1074,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1019,19 +1211,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1132,19 +1348,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1212,19 +1452,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1324,19 +1588,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1404,23 +1692,47 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string - responses: - '200': + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string + responses: + '200': description: '' content: application/json: @@ -1485,19 +1797,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1601,19 +1937,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1681,19 +2041,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -1767,6 +2151,7 @@ paths: $ref: '#/components/schemas/LinkedUserResponse' tags: &ref_18 - linkedUsers + x-speakeasy-group: linkedUsers get: operationId: listLinkedUsers summary: List Linked Users @@ -1781,6 +2166,7 @@ paths: items: $ref: '#/components/schemas/LinkedUserResponse' tags: *ref_18 + x-speakeasy-group: linkedUsers /linked_users/batch: post: operationId: importBatch @@ -1802,7 +2188,7 @@ paths: items: $ref: '#/components/schemas/LinkedUserResponse' tags: *ref_18 - x-speakeasy-group: linked_users.batch + x-speakeasy-group: linkedUsers /linked_users/{id}: get: operationId: retrieveLinkedUser @@ -1822,7 +2208,7 @@ paths: schema: $ref: '#/components/schemas/LinkedUserResponse' tags: *ref_18 - x-speakeasy-group: linked_users.{id} + x-speakeasy-group: linkedUsers /linked_users/fromRemoteId: get: operationId: remoteId @@ -1842,7 +2228,7 @@ paths: schema: $ref: '#/components/schemas/LinkedUserResponse' tags: *ref_18 - x-speakeasy-group: linked_users.fromremoteid + x-speakeasy-group: linkedUsers /projects: get: operationId: getProjects @@ -1897,7 +2283,7 @@ paths: $ref: '#/components/schemas/CustomFieldResponse' tags: &ref_20 - fieldMappings - x-speakeasy-group: field_mappings.define + x-speakeasy-group: fieldMappings /field_mappings: post: operationId: defineCustomField @@ -1917,6 +2303,7 @@ paths: schema: $ref: '#/components/schemas/CustomFieldResponse' tags: *ref_20 + x-speakeasy-group: fieldMappings /field_mappings/map: post: operationId: map @@ -1936,7 +2323,7 @@ paths: schema: $ref: '#/components/schemas/CustomFieldResponse' tags: *ref_20 - x-speakeasy-group: field_mappings.map + x-speakeasy-group: fieldMappings /events: get: operationId: getPanoraCoreEvents @@ -2012,19 +2399,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2092,19 +2503,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2172,21 +2607,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -2252,19 +2711,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2332,19 +2815,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2413,19 +2920,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2525,19 +3056,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2606,19 +3161,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2686,23 +3265,47 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string - responses: - '200': + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string + responses: + '200': description: '' content: application/json: @@ -2766,19 +3369,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2846,19 +3473,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -2926,19 +3577,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3006,19 +3681,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3118,19 +3817,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3198,21 +3921,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -3316,19 +4063,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3436,19 +4207,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3554,19 +4349,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3672,19 +4491,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3755,19 +4598,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -3838,23 +4705,47 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string - responses: - '200': + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string + responses: + '200': description: '' content: application/json: @@ -3955,19 +4846,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4038,19 +4953,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4155,19 +5094,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4238,19 +5201,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4351,19 +5338,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4464,21 +5475,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -4577,19 +5612,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4690,19 +5749,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4770,19 +5853,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4883,19 +5990,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -4964,19 +6095,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5044,23 +6199,47 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string - responses: - '200': + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string + responses: + '200': description: '' content: application/json: @@ -5124,19 +6303,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5204,19 +6407,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5284,19 +6511,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5364,19 +6615,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5444,19 +6719,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5524,21 +6823,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -5602,19 +6925,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5715,19 +7062,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5795,21 +7166,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -5909,19 +7304,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -5990,19 +7409,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -6071,21 +7514,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -6152,21 +7619,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -6265,21 +7756,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -6346,19 +7861,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -6459,21 +7998,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -6540,21 +8103,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -6653,19 +8240,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -6733,19 +8344,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -6847,19 +8482,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -6960,19 +8619,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7041,19 +8724,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7155,19 +8862,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7235,19 +8966,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7316,21 +9071,45 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false + description: Set to get the number of records after this cursor. + in: query + schema: + type: string responses: '200': description: '' @@ -7397,19 +9176,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7478,19 +9281,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7558,19 +9385,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7669,19 +9520,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: @@ -7780,18 +9655,21 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string @@ -7860,18 +9738,21 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 description: Set to get the number of records after this cursor. schema: type: string @@ -7940,19 +9821,43 @@ paths: - name: remote_data required: false in: query + example: true description: Set to true to include data from the original software. schema: type: boolean - name: limit required: false in: query + example: 10 description: Set to get the number of records. schema: type: number - name: cursor required: false in: query + example: 1b8b05bb-5273-4012-b520-8657b0b90874 + description: Set to get the number of records after this cursor. + schema: + type: string + - name: remote_data + example: true + description: Set to true to include data from the original software. + required: false + in: query + schema: + type: boolean + - name: limit + example: 10 + required: false + description: Set to get the number of records. + in: query + schema: + type: number + - example: 1b8b05bb-5273-4012-b520-8657b0b90874 + name: cursor + required: false description: Set to get the number of records after this cursor. + in: query schema: type: string responses: