@getbrevo/brevo 2.0.0-beta.4 → 2.1.0

package/.openapi-generator/FILES

@@ -0,0 +1,396 @@
+.gitignore
+api.ts
+api/accountApi.ts
+api/apis.ts
+api/companiesApi.ts
+api/contactsApi.ts
+api/conversationsApi.ts
+api/couponsApi.ts
+api/dealsApi.ts
+api/domainsApi.ts
+api/ecommerceApi.ts
+api/emailCampaignsApi.ts
+api/eventsApi.ts
+api/externalFeedsApi.ts
+api/filesApi.ts
+api/inboundParsingApi.ts
+api/masterAccountApi.ts
+api/notesApi.ts
+api/paymentsApi.ts
+api/processApi.ts
+api/resellerApi.ts
+api/sMSCampaignsApi.ts
+api/sendersApi.ts
+api/tasksApi.ts
+api/transactionalEmailsApi.ts
+api/transactionalSMSApi.ts
+api/transactionalWhatsAppApi.ts
+api/userApi.ts
+api/webhooksApi.ts
+api/whatsAppCampaignsApi.ts
+git_push.sh
+model/abTestCampaignResult.ts
+model/abTestCampaignResultClickedLinks.ts
+model/abTestCampaignResultStatistics.ts
+model/abTestVersionClicksInner.ts
+model/abTestVersionStats.ts
+model/addChildDomain.ts
+model/addContactToList.ts
+model/addCredits.ts
+model/authenticateDomainModel.ts
+model/blockDomain.ts
+model/cart.ts
+model/companiesIdPatchRequest.ts
+model/companiesLinkUnlinkIdPatchRequest.ts
+model/companiesList.ts
+model/companiesPost200Response.ts
+model/companiesPostRequest.ts
+model/company.ts
+model/companyAttributesInner.ts
+model/componentItems.ts
+model/configuration.ts
+model/conversationsAgentOnlinePingPostRequest.ts
+model/conversationsMessage.ts
+model/conversationsMessageFile.ts
+model/conversationsMessageFileImageInfo.ts
+model/conversationsMessagesIdPutRequest.ts
+model/conversationsMessagesPostRequest.ts
+model/conversationsPushedMessagesIdPutRequest.ts
+model/conversationsPushedMessagesPostRequest.ts
+model/conversionSourceMetrics.ts
+model/conversionSourceProduct.ts
+model/corporateGroupDetailsResponse.ts
+model/corporateGroupDetailsResponseGroup.ts
+model/corporateGroupDetailsResponseSubAccountsInner.ts
+model/corporateGroupDetailsResponseUsersInner.ts
+model/corporateGroupPost201Response.ts
+model/corporateGroupPostRequest.ts
+model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.ts
+model/corporateUserInvitationActionEmailPut200Response.ts
+model/createApiKeyRequest.ts
+model/createApiKeyResponse.ts
+model/createAttribute.ts
+model/createAttributeEnumerationInner.ts
+model/createCategoryModel.ts
+model/createChild.ts
+model/createContact.ts
+model/createCouponCollection201Response.ts
+model/createCouponCollectionRequest.ts
+model/createCouponsRequest.ts
+model/createDoiContact.ts
+model/createDomain.ts
+model/createDomainModel.ts
+model/createDomainModelDnsRecords.ts
+model/createDomainModelDnsRecordsDkimRecord.ts
+model/createEmailCampaign.ts
+model/createEmailCampaignRecipients.ts
+model/createEmailCampaignSender.ts
+model/createExternalFeed.ts
+model/createExternalFeed201Response.ts
+model/createList.ts
+model/createModel.ts
+model/createPaymentRequest.ts
+model/createProductModel.ts
+model/createReseller.ts
+model/createSender.ts
+model/createSenderIpsInner.ts
+model/createSenderModel.ts
+model/createSmsCampaign.ts
+model/createSmsCampaignRecipients.ts
+model/createSmtpEmail.ts
+model/createSmtpTemplate.ts
+model/createSmtpTemplateSender.ts
+model/createSubAccount.ts
+model/createSubAccountResponse.ts
+model/createUpdateBatchCategory.ts
+model/createUpdateBatchCategoryModel.ts
+model/createUpdateBatchProducts.ts
+model/createUpdateBatchProductsModel.ts
+model/createUpdateCategories.ts
+model/createUpdateCategory.ts
+model/createUpdateContactModel.ts
+model/createUpdateFolder.ts
+model/createUpdateProduct.ts
+model/createUpdateProducts.ts
+model/createWebhook.ts
+model/createWhatsAppCampaign.ts
+model/createWhatsAppCampaignRecipients.ts
+model/createWhatsAppTemplate.ts
+model/createdBatchId.ts
+model/createdProcessId.ts
+model/crmDealsIdPatchRequest.ts
+model/crmDealsLinkUnlinkIdPatchRequest.ts
+model/crmDealsPost201Response.ts
+model/crmDealsPostRequest.ts
+model/crmTasksIdPatchRequest.ts
+model/crmTasksPost201Response.ts
+model/crmTasksPostRequest.ts
+model/deal.ts
+model/dealAttributesInner.ts
+model/dealsList.ts
+model/deleteHardbounces.ts
+model/emailExportRecipients.ts
+model/errorModel.ts
+model/event.ts
+model/eventIdentifiers.ts
+model/exportWebhooksHistory.ts
+model/fileData.ts
+model/fileDownloadableLink.ts
+model/getAccount.ts
+model/getAccountActivity.ts
+model/getAccountActivityLogsInner.ts
+model/getAccountAllOfMarketingAutomation.ts
+model/getAccountAllOfPlan.ts
+model/getAccountAllOfRelay.ts
+model/getAccountAllOfRelayData.ts
+model/getAggregatedReport.ts
+model/getAllExternalFeeds.ts
+model/getAllExternalFeedsFeedsInner.ts
+model/getAttributes.ts
+model/getAttributesAttributesInner.ts
+model/getAttributesAttributesInnerEnumerationInner.ts
+model/getBlockedDomains.ts
+model/getCampaignOverview.ts
+model/getCampaignRecipients.ts
+model/getCampaignStats.ts
+model/getCategories.ts
+model/getCategoryDetails.ts
+model/getChildAccountCreationStatus.ts
+model/getChildDomain.ts
+model/getChildInfo.ts
+model/getChildInfoAllOfApiKeys.ts
+model/getChildInfoAllOfApiKeysV2.ts
+model/getChildInfoAllOfApiKeysV3.ts
+model/getChildInfoAllOfCredits.ts
+model/getChildInfoAllOfStatistics.ts
+model/getChildrenList.ts
+model/getChildrenListChildrenInner.ts
+model/getClient.ts
+model/getContactCampaignStats.ts
+model/getContactCampaignStatsClickedInner.ts
+model/getContactCampaignStatsClickedInnerLinksInner.ts
+model/getContactCampaignStatsMessagesSentInner.ts
+model/getContactCampaignStatsOpenedInner.ts
+model/getContactCampaignStatsTransacAttributesInner.ts
+model/getContactCampaignStatsUnsubscriptions.ts
+model/getContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner.ts
+model/getContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner.ts
+model/getContactDetails.ts
+model/getContacts.ts
+model/getCorporateInvitedUsersList.ts
+model/getCorporateInvitedUsersListUsersInner.ts
+model/getCorporateInvitedUsersListUsersInnerFeatureAccess.ts
+model/getCorporateInvitedUsersListUsersInnerGroups.ts
+model/getCorporateUserPermission.ts
+model/getCorporateUserPermissionFeatureAccess.ts
+model/getCorporateUserPermissionGroupsInner.ts
+model/getCouponCollection.ts
+model/getDeviceBrowserStats.ts
+model/getDomainConfigurationModel.ts
+model/getDomainsList.ts
+model/getDomainsListDomainsInner.ts
+model/getEmailCampaign.ts
+model/getEmailCampaigns.ts
+model/getEmailCampaignsCampaignsInner.ts
+model/getEmailEventReport.ts
+model/getEmailEventReportEventsInner.ts
+model/getExtendedCampaignOverview.ts
+model/getExtendedCampaignOverviewAllOfSender.ts
+model/getExtendedCampaignStats.ts
+model/getExtendedClient.ts
+model/getExtendedClientAllOfAddress.ts
+model/getExtendedContactDetails.ts
+model/getExtendedContactDetailsAllOfStatistics.ts
+model/getExtendedContactDetailsAllOfStatisticsClicked.ts
+model/getExtendedContactDetailsAllOfStatisticsLinks.ts
+model/getExtendedContactDetailsAllOfStatisticsMessagesSent.ts
+model/getExtendedContactDetailsAllOfStatisticsOpened.ts
+model/getExtendedContactDetailsAllOfStatisticsUnsubscriptions.ts
+model/getExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.ts
+model/getExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.ts
+model/getExtendedList.ts
+model/getExtendedListAllOfCampaignStats.ts
+model/getExternalFeedByUUID.ts
+model/getExternalFeedByUUIDHeadersInner.ts
+model/getFolder.ts
+model/getFolderLists.ts
+model/getFolders.ts
+model/getInboundEmailEvents.ts
+model/getInboundEmailEventsByUuid.ts
+model/getInboundEmailEventsByUuidAttachmentsInner.ts
+model/getInboundEmailEventsByUuidLogsInner.ts
+model/getInboundEmailEventsEventsInner.ts
+model/getInvitedUsersList.ts
+model/getInvitedUsersListUsersInner.ts
+model/getInvitedUsersListUsersInnerFeatureAccess.ts
+model/getIp.ts
+model/getIpFromSender.ts
+model/getIps.ts
+model/getIpsFromSender.ts
+model/getList.ts
+model/getLists.ts
+model/getListsListsInner.ts
+model/getOrders.ts
+model/getOrdersOrdersInner.ts
+model/getPaymentRequest.ts
+model/getProcess.ts
+model/getProcesses.ts
+model/getProductDetails.ts
+model/getProducts.ts
+model/getReports.ts
+model/getReportsReportsInner.ts
+model/getScheduledEmailByBatchId.ts
+model/getScheduledEmailByBatchIdBatchesInner.ts
+model/getScheduledEmailByMessageId.ts
+model/getSegments.ts
+model/getSegmentsSegments.ts
+model/getSendersList.ts
+model/getSendersListSendersInner.ts
+model/getSendersListSendersInnerIpsInner.ts
+model/getSharedTemplateUrl.ts
+model/getSmsCampaign.ts
+model/getSmsCampaignOverview.ts
+model/getSmsCampaignStats.ts
+model/getSmsCampaigns.ts
+model/getSmsCampaignsCampaignsInner.ts
+model/getSmsEventReport.ts
+model/getSmsEventReportEventsInner.ts
+model/getSmtpTemplateOverview.ts
+model/getSmtpTemplateOverviewSender.ts
+model/getSmtpTemplates.ts
+model/getSsoToken.ts
+model/getStatsByDevice.ts
+model/getSubAccountGroups200ResponseInner.ts
+model/getTransacAggregatedSmsReport.ts
+model/getTransacBlockedContacts.ts
+model/getTransacBlockedContactsContactsInner.ts
+model/getTransacBlockedContactsContactsInnerReason.ts
+model/getTransacEmailContent.ts
+model/getTransacEmailContentEventsInner.ts
+model/getTransacEmailsList.ts
+model/getTransacEmailsListTransactionalEmailsInner.ts
+model/getTransacSmsReport.ts
+model/getTransacSmsReportReportsInner.ts
+model/getUserPermission.ts
+model/getUserPermissionPrivilegesInner.ts
+model/getWATemplates.ts
+model/getWATemplatesTemplatesInner.ts
+model/getWebhook.ts
+model/getWebhookAuth.ts
+model/getWebhookHeadersInner.ts
+model/getWebhooks.ts
+model/getWhatsAppConfig.ts
+model/getWhatsappCampaignOverview.ts
+model/getWhatsappCampaigns.ts
+model/getWhatsappCampaignsCampaignsInner.ts
+model/getWhatsappEventReport.ts
+model/getWhatsappEventReportEventsInner.ts
+model/inviteAdminUser.ts
+model/inviteAdminUserPrivilegesInner.ts
+model/inviteuser.ts
+model/inviteuserPrivilegesInner.ts
+model/manageIp.ts
+model/masterDetailsResponse.ts
+model/masterDetailsResponseBillingInfo.ts
+model/masterDetailsResponseBillingInfoAddress.ts
+model/masterDetailsResponseBillingInfoName.ts
+model/masterDetailsResponsePlanInfo.ts
+model/masterDetailsResponsePlanInfoFeaturesInner.ts
+model/models.ts
+model/note.ts
+model/noteData.ts
+model/noteId.ts
+model/notification.ts
+model/order.ts
+model/orderBatch.ts
+model/orderBilling.ts
+model/orderProductsInner.ts
+model/otp.ts
+model/pipeline.ts
+model/pipelineStage.ts
+model/postContactInfo.ts
+model/postContactInfoContacts.ts
+model/postSendFailed.ts
+model/postSendSmsTestFailed.ts
+model/putRevokeUserPermission.ts
+model/putresendcancelinvitation.ts
+model/remainingCreditModel.ts
+model/remainingCreditModelChild.ts
+model/remainingCreditModelReseller.ts
+model/removeContactFromList.ts
+model/removeCredits.ts
+model/requestContactExport.ts
+model/requestContactExportCustomContactFilter.ts
+model/requestContactImport.ts
+model/requestContactImportJsonBodyInner.ts
+model/requestContactImportNewList.ts
+model/requestSmsRecipientExport.ts
+model/scheduleSmtpEmail.ts
+model/sendReport.ts
+model/sendReportEmail.ts
+model/sendSms.ts
+model/sendSmtpEmail.ts
+model/sendSmtpEmailAttachmentInner.ts
+model/sendSmtpEmailBccInner.ts
+model/sendSmtpEmailCcInner.ts
+model/sendSmtpEmailMessageVersionsInner.ts
+model/sendSmtpEmailMessageVersionsInnerReplyTo.ts
+model/sendSmtpEmailMessageVersionsInnerToInner.ts
+model/sendSmtpEmailReplyTo.ts
+model/sendSmtpEmailSender.ts
+model/sendSmtpEmailToInner.ts
+model/sendTestEmail.ts
+model/sendTestSms.ts
+model/sendTransacSms.ts
+model/sendWhatsappMessage.ts
+model/sendWhatsappMessage201Response.ts
+model/ssoTokenRequest.ts
+model/ssoTokenRequestCorporate.ts
+model/subAccountAppsToggleRequest.ts
+model/subAccountDetailsResponse.ts
+model/subAccountDetailsResponsePlanInfo.ts
+model/subAccountDetailsResponsePlanInfoCredits.ts
+model/subAccountDetailsResponsePlanInfoCreditsEmails.ts
+model/subAccountDetailsResponsePlanInfoFeatures.ts
+model/subAccountDetailsResponsePlanInfoFeaturesInbox.ts
+model/subAccountDetailsResponsePlanInfoFeaturesLandingPage.ts
+model/subAccountDetailsResponsePlanInfoFeaturesUsers.ts
+model/subAccountUpdatePlanRequest.ts
+model/subAccountUpdatePlanRequestCredits.ts
+model/subAccountUpdatePlanRequestFeatures.ts
+model/subAccountsResponse.ts
+model/subAccountsResponseSubAccountsInner.ts
+model/task.ts
+model/taskList.ts
+model/taskReminder.ts
+model/taskTypes.ts
+model/updateAttribute.ts
+model/updateAttributeEnumerationInner.ts
+model/updateBatchContacts.ts
+model/updateBatchContactsContactsInner.ts
+model/updateBatchContactsModel.ts
+model/updateCampaignStatus.ts
+model/updateChild.ts
+model/updateChildAccountStatus.ts
+model/updateChildDomain.ts
+model/updateContact.ts
+model/updateCouponCollection200Response.ts
+model/updateCouponCollectionRequest.ts
+model/updateEmailCampaign.ts
+model/updateEmailCampaignRecipients.ts
+model/updateEmailCampaignSender.ts
+model/updateExternalFeed.ts
+model/updateList.ts
+model/updateSender.ts
+model/updateSmsCampaign.ts
+model/updateSmtpTemplate.ts
+model/updateSmtpTemplateSender.ts
+model/updateWebhook.ts
+model/updateWhatsAppCampaign.ts
+model/uploadImageModel.ts
+model/uploadImageToGallery.ts
+model/variablesItems.ts
+model/whatsappCampStats.ts
+model/whatsappCampTemplate.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.1.0

package/api/apis.ts

@@ -16,6 +16,8 @@ export * from './ecommerceApi';
 import { EcommerceApi } from './ecommerceApi';
 export * from './emailCampaignsApi';
 import { EmailCampaignsApi } from './emailCampaignsApi';
+export * from './eventsApi';
+import { EventsApi } from './eventsApi';
 export * from './externalFeedsApi';
 import { ExternalFeedsApi } from './externalFeedsApi';
 export * from './filesApi';
@@ -26,6 +28,8 @@ export * from './masterAccountApi';
 import { MasterAccountApi } from './masterAccountApi';
 export * from './notesApi';
 import { NotesApi } from './notesApi';
+export * from './paymentsApi';
+import { PaymentsApi } from './paymentsApi';
 export * from './processApi';
 import { ProcessApi } from './processApi';
 export * from './resellerApi';
@@ -59,4 +63,4 @@ export class HttpError extends Error {
 
 export { RequestFile } from '../model/models';
 
-export const APIS = [AccountApi, CompaniesApi, ContactsApi, ConversationsApi, CouponsApi, DealsApi, DomainsApi, EcommerceApi, EmailCampaignsApi, ExternalFeedsApi, FilesApi, InboundParsingApi, MasterAccountApi, NotesApi, ProcessApi, ResellerApi, SMSCampaignsApi, SendersApi, TasksApi, TransactionalEmailsApi, TransactionalSMSApi, TransactionalWhatsAppApi, UserApi, WebhooksApi, WhatsAppCampaignsApi];
+export const APIS = [AccountApi, CompaniesApi, ContactsApi, ConversationsApi, CouponsApi, DealsApi, DomainsApi, EcommerceApi, EmailCampaignsApi, EventsApi, ExternalFeedsApi, FilesApi, InboundParsingApi, MasterAccountApi, NotesApi, PaymentsApi, ProcessApi, ResellerApi, SMSCampaignsApi, SendersApi, TasksApi, TransactionalEmailsApi, TransactionalSMSApi, TransactionalWhatsAppApi, UserApi, WebhooksApi, WhatsAppCampaignsApi];

package/api/contactsApi.ts

@@ -1136,8 +1136,10 @@ export class ContactsApi {
      * @param modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
      * @param createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
      * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+     * @param segmentId Id of the segment. **Either listIds or segmentId can be passed.**
+     * @param listIds Ids of the list. **Either listIds or segmentId can be passed.**
      */
-    public async getContacts (limit?: number, offset?: number, modifiedSince?: string, createdSince?: string, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetContacts;  }> {
+    public async getContacts (limit?: number, offset?: number, modifiedSince?: string, createdSince?: string, sort?: 'asc' | 'desc', segmentId?: number, listIds?: Array<number>, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetContacts;  }> {
         const localVarPath = this.basePath + '/contacts';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -1170,6 +1172,14 @@ export class ContactsApi {
             localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'asc' | 'desc'");
         }
 
+        if (segmentId !== undefined) {
+            localVarQueryParameters['segmentId'] = ObjectSerializer.serialize(segmentId, "number");
+        }
+
+        if (listIds !== undefined) {
+            localVarQueryParameters['listIds'] = ObjectSerializer.serialize(listIds, "Array<number>");
+        }
+
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -1836,7 +1846,7 @@ export class ContactsApi {
         });
     }
     /**
-     * It returns the background process ID which on completion calls the notify URL that you have set in the input.
+     * It returns the background process ID which on completion calls the notify URL that you have set in the input.  **Note**: - Any contact attribute that doesn\'t exist in your account will be ignored at import end. 
      * @summary Import contacts
      * @param requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at &#x60;&#x60;https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns&#x60;&#x60;
      */

package/api/couponsApi.ts

@@ -327,8 +327,9 @@ export class CouponsApi {
      * @param limit Number of documents returned per page
      * @param offset Index of the first document on the page
      * @param sort Sort the results by creation time in ascending/descending order
+     * @param sortBy The field used to sort coupon collections
      */
-    public async getCouponCollections (limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCouponCollection;  }> {
+    public async getCouponCollections (limit?: number, offset?: number, sort?: 'asc' | 'desc', sortBy?: any, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCouponCollection;  }> {
         const localVarPath = this.basePath + '/couponCollections';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -353,6 +354,10 @@ export class CouponsApi {
             localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'asc' | 'desc'");
         }
 
+        if (sortBy !== undefined) {
+            localVarQueryParameters['sortBy'] = ObjectSerializer.serialize(sortBy, "any");
+        }
+
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -410,7 +415,7 @@ export class CouponsApi {
      * @param id Id of the collection to update
      * @param updateCouponCollection Values to update the coupon collection
      */
-    public async updateCouponCollection (id: string, updateCouponCollection: UpdateCouponCollectionRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: UpdateCouponCollection200Response;  }> {
+    public async updateCouponCollection (id: string, updateCouponCollection?: UpdateCouponCollectionRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: UpdateCouponCollection200Response;  }> {
         const localVarPath = this.basePath + '/couponCollections/{id}'
             .replace('{' + 'id' + '}', encodeURIComponent(String(id)));
         let localVarQueryParameters: any = {};
@@ -429,11 +434,6 @@ export class CouponsApi {
             throw new Error('Required parameter id was null or undefined when calling updateCouponCollection.');
         }
 
-        // verify required parameter 'updateCouponCollection' is not null or undefined
-        if (updateCouponCollection === null || updateCouponCollection === undefined) {
-            throw new Error('Required parameter updateCouponCollection was null or undefined when calling updateCouponCollection.');
-        }
-
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;

package/api/dealsApi.ts

@@ -170,7 +170,7 @@ export class DealsApi {
     /**
      * 
      * @summary Get all deals
-     * @param filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\"
+     * @param filtersAttributesDealName Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
      * @param filtersLinkedCompaniesIds Filter by linked companies ids
      * @param filtersLinkedContactsIds Filter by linked companies ids
      * @param offset Index of the first document of the page