@getbrevo/brevo 2.2.0 → 2.3.0

package/.openapi-generator/FILES

@@ -2,6 +2,7 @@
 api.ts
 api/accountApi.ts
 api/apis.ts
+api/balanceApi.ts
 api/companiesApi.ts
 api/contactsApi.ts
 api/conversationsApi.ts
@@ -18,10 +19,12 @@ api/masterAccountApi.ts
 api/notesApi.ts
 api/paymentsApi.ts
 api/processApi.ts
-api/resellerApi.ts
+api/programApi.ts
+api/rewardApi.ts
 api/sMSCampaignsApi.ts
 api/sendersApi.ts
 api/tasksApi.ts
+api/tierApi.ts
 api/transactionalEmailsApi.ts
 api/transactionalSMSApi.ts
 api/transactionalWhatsAppApi.ts
@@ -36,11 +39,20 @@ model/abTestVersionClicksInner.ts
 model/abTestVersionStats.ts
 model/addChildDomain.ts
 model/addContactToList.ts
-model/addCredits.ts
+model/addSubscriptionMemberPayload.ts
+model/aggregateBalance.ts
 model/authenticateDomainModel.ts
+model/balance.ts
+model/balanceDataPerContact.ts
+model/balanceDefinition.ts
+model/balanceDefinitionPage.ts
+model/balanceLimit.ts
+model/balanceOrder.ts
 model/blockDomain.ts
 model/cart.ts
 model/companiesIdPatchRequest.ts
+model/companiesImportPost200Response.ts
+model/companiesImportPost400Response.ts
 model/companiesLinkUnlinkIdPatchRequest.ts
 model/companiesList.ts
 model/companiesPost200Response.ts
@@ -49,10 +61,17 @@ model/company.ts
 model/companyAttributesInner.ts
 model/componentItems.ts
 model/configuration.ts
+model/contactBalancesResp.ts
+model/contactErrorModel.ts
 model/conversationsAgentOnlinePingPostRequest.ts
 model/conversationsMessage.ts
+model/conversationsMessageAttachmentsInner.ts
 model/conversationsMessageFile.ts
 model/conversationsMessageFileImageInfo.ts
+model/conversationsMessageForwardedToSourceStatus.ts
+model/conversationsMessageFrom.ts
+model/conversationsMessageReplyTo.ts
+model/conversationsMessageToInner.ts
 model/conversationsMessagesIdPutRequest.ts
 model/conversationsMessagesPostRequest.ts
 model/conversationsPushedMessagesIdPutRequest.ts
@@ -68,11 +87,16 @@ model/corporateGroupPostRequest.ts
 model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.ts
 model/corporateSubAccountIpAssociatePostRequest.ts
 model/corporateSubAccountIpDissociatePutRequest.ts
+model/corporateUserEmailPermissionsPutRequest.ts
+model/corporateUserEmailPermissionsPutRequestPrivilegesInner.ts
 model/corporateUserInvitationActionEmailPut200Response.ts
 model/createApiKeyRequest.ts
 model/createApiKeyResponse.ts
 model/createAttribute.ts
 model/createAttributeEnumerationInner.ts
+model/createBalanceDefinitionPayload.ts
+model/createBalanceLimitPayload.ts
+model/createBalancePayload.ts
 model/createCategoryModel.ts
 model/createChild.ts
 model/createContact.ts
@@ -85,16 +109,18 @@ model/createDomainModel.ts
 model/createDomainModelDnsRecords.ts
 model/createDomainModelDnsRecordsDkimRecord.ts
 model/createEmailCampaign.ts
+model/createEmailCampaignEmailExpirationDate.ts
 model/createEmailCampaignRecipients.ts
 model/createEmailCampaignSender.ts
 model/createExternalFeed.ts
 model/createExternalFeed201Response.ts
 model/createList.ts
+model/createLoyaltyProgramPayload.ts
 model/createModel.ts
+model/createOrderPayload.ts
 model/createPaymentRequest.ts
 model/createPaymentResponse.ts
 model/createProductModel.ts
-model/createReseller.ts
 model/createSender.ts
 model/createSenderIpsInner.ts
 model/createSenderModel.ts
@@ -105,6 +131,10 @@ model/createSmtpTemplate.ts
 model/createSmtpTemplateSender.ts
 model/createSubAccount.ts
 model/createSubAccountResponse.ts
+model/createSubscriptionPayload.ts
+model/createSubscriptionResponse.ts
+model/createTierGroupRequest.ts
+model/createTransactionPayload.ts
 model/createUpdateBatchCategory.ts
 model/createUpdateBatchCategoryModel.ts
 model/createUpdateBatchProducts.ts
@@ -121,6 +151,8 @@ model/createWhatsAppCampaignRecipients.ts
 model/createWhatsAppTemplate.ts
 model/createdBatchId.ts
 model/createdProcessId.ts
+model/crmAttributesPost200Response.ts
+model/crmAttributesPostRequest.ts
 model/crmDealsIdPatchRequest.ts
 model/crmDealsLinkUnlinkIdPatchRequest.ts
 model/crmDealsPost201Response.ts
@@ -139,9 +171,11 @@ model/ecommerceAttributionProductsConversionSourceConversionSourceIdGet200Respon
 model/ecommerceConfigDisplayCurrencyGet200Response.ts
 model/emailExportRecipients.ts
 model/errorModel.ts
+model/errorResponse.ts
 model/event.ts
 model/eventIdentifiers.ts
 model/exportWebhooksHistory.ts
+model/fetchTemplatePreview.ts
 model/fileData.ts
 model/fileDownloadableLink.ts
 model/getAccount.ts
@@ -163,26 +197,13 @@ 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
@@ -250,8 +271,8 @@ model/getReportsReportsInner.ts
 model/getScheduledEmailByBatchId.ts
 model/getScheduledEmailByBatchIdBatchesInner.ts
 model/getScheduledEmailByMessageId.ts
+model/getSegment.ts
 model/getSegments.ts
-model/getSegmentsSegments.ts
 model/getSendersList.ts
 model/getSendersListSendersInner.ts
 model/getSendersListSendersInnerIpsInner.ts
@@ -297,13 +318,51 @@ model/inviteAdminUser.ts
 model/inviteAdminUserPrivilegesInner.ts
 model/inviteuser.ts
 model/inviteuserPrivilegesInner.ts
-model/manageIp.ts
+model/loyaltyProgram.ts
+model/loyaltyProgramPage.ts
+model/loyaltyProgramValidationError.ts
+model/loyaltyTierPage.ts
+model/mainAttributeRewardPayload.ts
+model/mainBillingPayload.ts
+model/mainCodeCountHttpResponse.ts
+model/mainCreateRedeemPayload.ts
+model/mainCreateRewardPayload.ts
+model/mainCreateRewardResponse.ts
+model/mainErrorResponse.ts
+model/mainFilter.ts
+model/mainGenerator.ts
+model/mainGetContactRewardsPayload.ts
+model/mainIdentifiersPayload.ts
+model/mainLimit.ts
+model/mainModelContactReward.ts
+model/mainModelContactRewardsResp.ts
+model/mainNodeResponse.ts
+model/mainOrderPayload.ts
+model/mainProduct.ts
+model/mainProductPayload.ts
+model/mainRedeem.ts
+model/mainResultParameterResponse.ts
+model/mainReward.ts
+model/mainRewardAttribution.ts
+model/mainRewardConfigurations.ts
+model/mainRewardPage.ts
+model/mainRewardPageObj.ts
+model/mainRewardValidate.ts
+model/mainRule.ts
+model/mainRuleConditionResponse.ts
+model/mainRuleEventResponse.ts
+model/mainRuleResultResponse.ts
+model/mainValidateRewardPayload.ts
+model/mainValueResponse.ts
+model/mainVoucherRevokePayload.ts
 model/masterDetailsResponse.ts
 model/masterDetailsResponseBillingInfo.ts
 model/masterDetailsResponseBillingInfoAddress.ts
 model/masterDetailsResponseBillingInfoName.ts
 model/masterDetailsResponsePlanInfo.ts
 model/masterDetailsResponsePlanInfoFeaturesInner.ts
+model/memberContact.ts
+model/modelSubscriptionBalanceResp.ts
 model/models.ts
 model/note.ts
 model/noteData.ts
@@ -312,8 +371,10 @@ model/notification.ts
 model/order.ts
 model/orderBatch.ts
 model/orderBilling.ts
+model/orderIdentifiers.ts
 model/orderProductsInner.ts
 model/otp.ts
+model/patchLoyaltyProgramPayload.ts
 model/pipeline.ts
 model/pipelineStage.ts
 model/postContactInfo.ts
@@ -322,11 +383,7 @@ 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
@@ -350,6 +407,7 @@ model/sendSmtpEmailToInner.ts
 model/sendTestEmail.ts
 model/sendTestSms.ts
 model/sendTransacSms.ts
+model/sendTransacSmsTag.ts
 model/sendWhatsappMessage.ts
 model/sendWhatsappMessage201Response.ts
 model/ssoTokenRequest.ts
@@ -360,11 +418,14 @@ model/subAccountDetailsResponseGroupsInner.ts
 model/subAccountDetailsResponsePlanInfo.ts
 model/subAccountDetailsResponsePlanInfoCredits.ts
 model/subAccountDetailsResponsePlanInfoCreditsEmails.ts
+model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.ts
 model/subAccountDetailsResponsePlanInfoCreditsSms.ts
+model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.ts
 model/subAccountDetailsResponsePlanInfoCreditsWpSubscribers.ts
 model/subAccountDetailsResponsePlanInfoFeatures.ts
 model/subAccountDetailsResponsePlanInfoFeaturesInbox.ts
 model/subAccountDetailsResponsePlanInfoFeaturesLandingPage.ts
+model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.ts
 model/subAccountDetailsResponsePlanInfoFeaturesUsers.ts
 model/subAccountUpdatePlanRequest.ts
 model/subAccountUpdatePlanRequestCredits.ts
@@ -372,31 +433,59 @@ model/subAccountUpdatePlanRequestFeatures.ts
 model/subAccountsResponse.ts
 model/subAccountsResponseSubAccountsInner.ts
 model/subAccountsResponseSubAccountsInnerGroupsInner.ts
+model/subAccountsUpdatePlanRequest.ts
+model/subAccountsUpdatePlanRequestCredits.ts
+model/subAccountsUpdatePlanRequestFeatures.ts
+model/subscription.ts
+model/subscriptionAggregateBalance.ts
+model/subscriptionAttributedReward.ts
+model/subscriptionBalances.ts
+model/subscriptionHandlerInfo.ts
+model/subscriptionMember.ts
+model/subscriptionTier.ts
 model/task.ts
 model/taskList.ts
 model/taskReminder.ts
 model/taskTypes.ts
+model/templatePreview.ts
+model/tier.ts
+model/tierAccessConditionsInner.ts
+model/tierForContact.ts
+model/tierGroup.ts
+model/tierGroupPage.ts
+model/tierRequest.ts
+model/tierRequestAccessConditionsInner.ts
+model/tierRequestPutPayload.ts
+model/tierRequestTierRewardsInner.ts
+model/tierTierRewardsInner.ts
+model/transaction.ts
+model/transactionHistory.ts
+model/transactionHistoryResp.ts
+model/unauthorizedResponse.ts
 model/updateAttribute.ts
 model/updateAttributeEnumerationInner.ts
+model/updateBalanceDefinitionPayload.ts
+model/updateBalanceLimitPayload.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/updateEmailCampaignEmailExpirationDate.ts
 model/updateEmailCampaignRecipients.ts
 model/updateEmailCampaignSender.ts
 model/updateExternalFeed.ts
 model/updateList.ts
+model/updateLoyaltyProgramPayload.ts
 model/updateSender.ts
 model/updateSmsCampaign.ts
 model/updateSmtpTemplate.ts
 model/updateSmtpTemplateSender.ts
+model/updateTierGroupRequest.ts
 model/updateWebhook.ts
 model/updateWhatsAppCampaign.ts
 model/uploadImageModel.ts

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.1.0
+7.13.0

package/README.md

@@ -40,7 +40,7 @@ yarn add @getbrevo/brevo
 const brevo = require('@getbrevo/brevo');
 let defaultClient = brevo.ApiClient.instance;
 
-let apiKey = defaultClient.authentications['apiKey'];
+let apiKey = defaultClient.authentications['api-key'];
 apiKey.apiKey = 'YOUR API KEY';
 
 let apiInstance = new brevo.TransactionalEmailsApi();
@@ -74,7 +74,7 @@ apiInstance.sendTransacEmail(sendSmtpEmail).then(function (data) {
 const brevo = require('@getbrevo/brevo');
 let apiInstance = new brevo.TransactionalEmailsApi();
 
-let apiKey = apiInstance.authentications['apiKey'];
+let apiKey = apiInstance.authentications['api-key'];
 apiKey.apiKey = 'YOUR API KEY';
 
 let sendSmtpEmail = new brevo.SendSmtpEmail();
@@ -105,7 +105,7 @@ const brevo = require('@getbrevo/brevo');
 
 let apiInstance = new brevo.ContactsApi()
 
-let apiKey = apiInstance.authentications['apiKey'];
+let apiKey = apiInstance.authentications['api-key'];
 apiKey.apiKey = 'YOUR API KEY';
 
 apiInstance.getAttributes().then(function(data) {
@@ -124,7 +124,7 @@ const brevo = require('@getbrevo/brevo');
 
 let apiInstance = new brevo.AccountApi()
 
-let apiKey = apiInstance.authentications['apiKey'];
+let apiKey = apiInstance.authentications['api-key'];
 apiKey.apiKey = 'YOUR API KEY';
 
 apiInstance.getAccount().then(function(data) {
@@ -142,7 +142,7 @@ const brevo = require('@getbrevo/brevo');
 
 let apiInstance = new brevo.ContactsApi()
 
-let apiKey = apiInstance.authentications['apiKey'];
+let apiKey = apiInstance.authentications['api-key'];
 apiKey.apiKey = 'YOUR API KEY';
 
 apiInstance.getContacts().then(function(data) {

package/api/accountApi.ts

@@ -166,10 +166,11 @@ export class AccountApi {
      * @summary Get user activity logs
      * @param startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
      * @param endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
+     * @param email Enter the user\'s email address to filter their activity in the account.
      * @param limit Number of documents per page
      * @param offset Index of the first document in the page.
      */
-    public async getAccountActivity (startDate?: string, endDate?: string, limit?: number, offset?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetAccountActivity;  }> {
+    public async getAccountActivity (startDate?: string, endDate?: string, email?: string, limit?: number, offset?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetAccountActivity;  }> {
         const localVarPath = this.basePath + '/organization/activities';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -190,6 +191,10 @@ export class AccountApi {
             localVarQueryParameters['endDate'] = ObjectSerializer.serialize(endDate, "string");
         }
 
+        if (email !== undefined) {
+            localVarQueryParameters['email'] = ObjectSerializer.serialize(email, "string");
+        }
+
         if (limit !== undefined) {
             localVarQueryParameters['limit'] = ObjectSerializer.serialize(limit, "number");
         }

package/api/apis.ts

@@ -1,5 +1,7 @@
 export * from './accountApi';
 import { AccountApi } from './accountApi';
+export * from './balanceApi';
+import { BalanceApi } from './balanceApi';
 export * from './companiesApi';
 import { CompaniesApi } from './companiesApi';
 export * from './contactsApi';
@@ -32,14 +34,18 @@ export * from './paymentsApi';
 import { PaymentsApi } from './paymentsApi';
 export * from './processApi';
 import { ProcessApi } from './processApi';
-export * from './resellerApi';
-import { ResellerApi } from './resellerApi';
+export * from './programApi';
+import { ProgramApi } from './programApi';
+export * from './rewardApi';
+import { RewardApi } from './rewardApi';
 export * from './sMSCampaignsApi';
 import { SMSCampaignsApi } from './sMSCampaignsApi';
 export * from './sendersApi';
 import { SendersApi } from './sendersApi';
 export * from './tasksApi';
 import { TasksApi } from './tasksApi';
+export * from './tierApi';
+import { TierApi } from './tierApi';
 export * from './transactionalEmailsApi';
 import { TransactionalEmailsApi } from './transactionalEmailsApi';
 export * from './transactionalSMSApi';
@@ -63,4 +69,4 @@ export class HttpError extends Error {
 
 export { RequestFile } from '../model/models';
 
-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];
+export const APIS = [AccountApi, BalanceApi, CompaniesApi, ContactsApi, ConversationsApi, CouponsApi, DealsApi, DomainsApi, EcommerceApi, EmailCampaignsApi, EventsApi, ExternalFeedsApi, FilesApi, InboundParsingApi, MasterAccountApi, NotesApi, PaymentsApi, ProcessApi, ProgramApi, RewardApi, SMSCampaignsApi, SendersApi, TasksApi, TierApi, TransactionalEmailsApi, TransactionalSMSApi, TransactionalWhatsAppApi, UserApi, WebhooksApi, WhatsAppCampaignsApi];