brevo-ruby 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE.md +21 -0
- data/README.md +651 -0
- data/Rakefile +8 -0
- data/brevo-ruby.gemspec +46 -0
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +125 -0
- data/docs/AddChildDomain.md +8 -0
- data/docs/AddContactToList.md +9 -0
- data/docs/AddCredits.md +9 -0
- data/docs/AuthenticateDomainModel.md +9 -0
- data/docs/BlockDomain.md +8 -0
- data/docs/Body.md +10 -0
- data/docs/Body1.md +10 -0
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/BodyVariablesItems.md +7 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ComponentItems.md +9 -0
- data/docs/ContactsApi.md +1767 -0
- data/docs/ConversationsApi.md +542 -0
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CouponsApi.md +305 -0
- data/docs/CreateApiKeyRequest.md +9 -0
- data/docs/CreateApiKeyResponse.md +9 -0
- data/docs/CreateAttribute.md +11 -0
- data/docs/CreateAttributeEnumeration.md +9 -0
- data/docs/CreateCategoryModel.md +8 -0
- data/docs/CreateChild.md +13 -0
- data/docs/CreateContact.md +15 -0
- data/docs/CreateCouponCollection.md +9 -0
- data/docs/CreateCoupons.md +9 -0
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateDomain.md +8 -0
- data/docs/CreateDomainModel.md +11 -0
- data/docs/CreateDomainModelDnsRecords.md +9 -0
- data/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- data/docs/CreateEmailCampaign.md +37 -0
- data/docs/CreateEmailCampaignRecipients.md +10 -0
- data/docs/CreateEmailCampaignSender.md +10 -0
- data/docs/CreateExternalFeed.md +16 -0
- data/docs/CreateList.md +9 -0
- data/docs/CreateModel.md +8 -0
- data/docs/CreateProductModel.md +8 -0
- data/docs/CreateReseller.md +9 -0
- data/docs/CreateSender.md +10 -0
- data/docs/CreateSenderIps.md +10 -0
- data/docs/CreateSenderModel.md +10 -0
- data/docs/CreateSmsCampaign.md +15 -0
- data/docs/CreateSmsCampaignRecipients.md +9 -0
- data/docs/CreateSmtpEmail.md +9 -0
- data/docs/CreateSmtpTemplate.md +17 -0
- data/docs/CreateSmtpTemplateSender.md +10 -0
- data/docs/CreateSubAccount.md +11 -0
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/CreateUpdateBatchCategory.md +9 -0
- data/docs/CreateUpdateBatchCategoryModel.md +9 -0
- data/docs/CreateUpdateBatchProducts.md +9 -0
- data/docs/CreateUpdateBatchProductsModel.md +9 -0
- data/docs/CreateUpdateCategories.md +11 -0
- data/docs/CreateUpdateCategory.md +12 -0
- data/docs/CreateUpdateContactModel.md +8 -0
- data/docs/CreateUpdateFolder.md +8 -0
- data/docs/CreateUpdateProduct.md +18 -0
- data/docs/CreateUpdateProducts.md +17 -0
- data/docs/CreateWebhook.md +12 -0
- data/docs/CreateWhatsAppCampaign.md +11 -0
- data/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- data/docs/CreateWhatsAppTemplate.md +13 -0
- data/docs/CreatedBatchId.md +8 -0
- data/docs/CreatedProcessId.md +8 -0
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +536 -0
- data/docs/DealsList.md +8 -0
- data/docs/DeleteHardbounces.md +10 -0
- data/docs/DomainsApi.md +292 -0
- data/docs/EcommerceApi.md +675 -0
- data/docs/EmailCampaignsApi.md +799 -0
- data/docs/EmailExportRecipients.md +9 -0
- data/docs/ErrorModel.md +9 -0
- data/docs/ExportWebhooksHistory.md +16 -0
- data/docs/ExternalFeedsApi.md +322 -0
- data/docs/FileData.md +14 -0
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetAccount.md +15 -0
- data/docs/GetAccountActivity.md +8 -0
- data/docs/GetAccountActivityLogs.md +12 -0
- data/docs/GetAccountMarketingAutomation.md +9 -0
- data/docs/GetAccountPlan.md +13 -0
- data/docs/GetAccountRelay.md +9 -0
- data/docs/GetAccountRelayData.md +10 -0
- data/docs/GetAggregatedReport.md +20 -0
- data/docs/GetAllExternalFeeds.md +9 -0
- data/docs/GetAllExternalFeedsFeeds.md +19 -0
- data/docs/GetAttributes.md +8 -0
- data/docs/GetAttributesAttributes.md +12 -0
- data/docs/GetAttributesEnumeration.md +9 -0
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +20 -0
- data/docs/GetCampaignRecipients.md +9 -0
- data/docs/GetCampaignStats.md +23 -0
- data/docs/GetCategories.md +9 -0
- data/docs/GetCategoryDetails.md +13 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildDomain.md +9 -0
- data/docs/GetChildDomains.md +7 -0
- data/docs/GetChildInfo.md +16 -0
- data/docs/GetChildInfoApiKeys.md +9 -0
- data/docs/GetChildInfoApiKeysV2.md +9 -0
- data/docs/GetChildInfoApiKeysV3.md +9 -0
- data/docs/GetChildInfoCredits.md +9 -0
- data/docs/GetChildInfoStatistics.md +10 -0
- data/docs/GetChildrenList.md +9 -0
- data/docs/GetClient.md +11 -0
- data/docs/GetContactCampaignStats.md +16 -0
- data/docs/GetContactCampaignStatsClicked.md +9 -0
- data/docs/GetContactCampaignStatsOpened.md +11 -0
- data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- data/docs/GetContactDetails.md +16 -0
- data/docs/GetContacts.md +9 -0
- data/docs/GetCouponCollection.md +13 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetDomainConfigurationModel.md +11 -0
- data/docs/GetDomainsList.md +8 -0
- data/docs/GetDomainsListDomains.md +12 -0
- data/docs/GetEmailCampaign.md +38 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +18 -0
- data/docs/GetExtendedCampaignOverview.md +36 -0
- data/docs/GetExtendedCampaignOverviewSender.md +10 -0
- data/docs/GetExtendedCampaignStats.md +15 -0
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedClient.md +12 -0
- data/docs/GetExtendedClientAddress.md +11 -0
- data/docs/GetExtendedContactDetails.md +17 -0
- data/docs/GetExtendedContactDetailsStatistics.md +16 -0
- data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- data/docs/GetExtendedList.md +16 -0
- data/docs/GetExtendedListCampaignStats.md +9 -0
- data/docs/GetExternalFeedByUUID.md +19 -0
- data/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- data/docs/GetFolder.md +12 -0
- data/docs/GetFolderLists.md +9 -0
- data/docs/GetFolders.md +9 -0
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetInvitedUsersList.md +8 -0
- data/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- data/docs/GetInvitedUsersListUsers.md +11 -0
- data/docs/GetIp.md +11 -0
- data/docs/GetIpFromSender.md +11 -0
- data/docs/GetIps.md +8 -0
- data/docs/GetIpsFromSender.md +8 -0
- data/docs/GetList.md +12 -0
- data/docs/GetLists.md +9 -0
- data/docs/GetProcess.md +11 -0
- data/docs/GetProcesses.md +9 -0
- data/docs/GetProductDetails.md +22 -0
- data/docs/GetProducts.md +9 -0
- data/docs/GetReports.md +8 -0
- data/docs/GetReportsReports.md +20 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSegments.md +9 -0
- data/docs/GetSegmentsSegments.md +11 -0
- data/docs/GetSendersList.md +8 -0
- data/docs/GetSendersListIps.md +10 -0
- data/docs/GetSendersListSenders.md +12 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmsCampaign.md +17 -0
- data/docs/GetSmsCampaignOverview.md +15 -0
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaignStats.md +14 -0
- data/docs/GetSmsCampaigns.md +9 -0
- data/docs/GetSmsEventReport.md +8 -0
- data/docs/GetSmsEventReportEvents.md +14 -0
- data/docs/GetSmtpTemplateOverview.md +20 -0
- data/docs/GetSmtpTemplateOverviewSender.md +10 -0
- data/docs/GetSmtpTemplates.md +9 -0
- data/docs/GetSsoToken.md +8 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetStatsByDomain.md +7 -0
- data/docs/GetTransacAggregatedSmsReport.md +17 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/GetTransacSmsReport.md +8 -0
- data/docs/GetTransacSmsReportReports.md +17 -0
- data/docs/GetUserPermission.md +10 -0
- data/docs/GetUserPermissionPrivileges.md +9 -0
- data/docs/GetWATemplates.md +9 -0
- data/docs/GetWATemplatesTemplates.md +15 -0
- data/docs/GetWebhook.md +14 -0
- data/docs/GetWebhooks.md +8 -0
- data/docs/GetWhatsAppConfig.md +13 -0
- data/docs/GetWhatsappCampaignOverview.md +16 -0
- data/docs/GetWhatsappCampaigns.md +9 -0
- data/docs/GetWhatsappCampaignsCampaigns.md +18 -0
- data/docs/GetWhatsappEventReport.md +8 -0
- data/docs/GetWhatsappEventReportEvents.md +15 -0
- data/docs/InboundParsingApi.md +199 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +10 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineResponse2012.md +8 -0
- data/docs/InlineResponse2013.md +8 -0
- data/docs/InlineResponse2014.md +8 -0
- data/docs/ManageIp.md +8 -0
- data/docs/MasterAccountApi.md +549 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +11 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Order.md +16 -0
- data/docs/OrderBatch.md +9 -0
- data/docs/OrderBilling.md +14 -0
- data/docs/OrderProducts.md +11 -0
- data/docs/Otp.md +8 -0
- data/docs/Pipeline.md +10 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/Pipelines.md +7 -0
- data/docs/PostContactInfo.md +8 -0
- data/docs/PostContactInfoContacts.md +11 -0
- data/docs/PostSendFailed.md +12 -0
- data/docs/PostSendSmsTestFailed.md +11 -0
- data/docs/ProcessApi.md +129 -0
- data/docs/RemainingCreditModel.md +9 -0
- data/docs/RemainingCreditModelChild.md +9 -0
- data/docs/RemainingCreditModelReseller.md +9 -0
- data/docs/RemoveContactFromList.md +10 -0
- data/docs/RemoveCredits.md +9 -0
- data/docs/RequestContactExport.md +10 -0
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +17 -0
- data/docs/RequestContactImportNewList.md +9 -0
- data/docs/RequestSMSRecipientExport.md +9 -0
- data/docs/ResellerApi.md +964 -0
- data/docs/SMSCampaignsApi.md +613 -0
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendReport.md +9 -0
- data/docs/SendReportEmail.md +9 -0
- data/docs/SendSms.md +12 -0
- data/docs/SendSmtpEmail.md +23 -0
- data/docs/SendSmtpEmailAttachment.md +10 -0
- data/docs/SendSmtpEmailBcc.md +9 -0
- data/docs/SendSmtpEmailCc.md +9 -0
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo.md +9 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +10 -0
- data/docs/SendSmtpEmailTo.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +8 -0
- data/docs/SendTestSms.md +8 -0
- data/docs/SendTransacSms.md +15 -0
- data/docs/SendWhatsappMessage.md +11 -0
- data/docs/SendersApi.md +417 -0
- data/docs/SsoTokenRequest.md +10 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +13 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TaskTypes.md +9 -0
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +1390 -0
- data/docs/TransactionalSMSApi.md +273 -0
- data/docs/TransactionalWhatsAppApi.md +143 -0
- data/docs/UpdateAttribute.md +9 -0
- data/docs/UpdateAttributeEnumeration.md +9 -0
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +17 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateCampaignStatus.md +8 -0
- data/docs/UpdateChild.md +12 -0
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateChildDomain.md +8 -0
- data/docs/UpdateContact.md +14 -0
- data/docs/UpdateCouponCollection.md +8 -0
- data/docs/UpdateEmailCampaign.md +37 -0
- data/docs/UpdateEmailCampaignRecipients.md +10 -0
- data/docs/UpdateEmailCampaignSender.md +10 -0
- data/docs/UpdateExternalFeed.md +16 -0
- data/docs/UpdateList.md +9 -0
- data/docs/UpdateSender.md +10 -0
- data/docs/UpdateSmsCampaign.md +15 -0
- data/docs/UpdateSmtpTemplate.md +17 -0
- data/docs/UpdateSmtpTemplateSender.md +10 -0
- data/docs/UpdateWebhook.md +11 -0
- data/docs/UpdateWhatsAppCampaign.md +11 -0
- data/docs/UploadImageModel.md +8 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/UserApi.md +118 -0
- data/docs/VariablesItems.md +10 -0
- data/docs/WebhooksApi.md +362 -0
- data/docs/WhatsAppCampaignsApi.md +543 -0
- data/docs/WhatsappCampStats.md +12 -0
- data/docs/WhatsappCampTemplate.md +18 -0
- data/lib/brevo-ruby/api/account_api.rb +145 -0
- data/lib/brevo-ruby/api/companies_api.rb +419 -0
- data/lib/brevo-ruby/api/contacts_api.rb +1735 -0
- data/lib/brevo-ruby/api/conversations_api.rb +514 -0
- data/lib/brevo-ruby/api/coupons_api.rb +316 -0
- data/lib/brevo-ruby/api/deals_api.rb +518 -0
- data/lib/brevo-ruby/api/domains_api.rb +282 -0
- data/lib/brevo-ruby/api/ecommerce_api.rb +655 -0
- data/lib/brevo-ruby/api/email_campaigns_api.rb +782 -0
- data/lib/brevo-ruby/api/external_feeds_api.rb +336 -0
- data/lib/brevo-ruby/api/files_api.rb +323 -0
- data/lib/brevo-ruby/api/inbound_parsing_api.rb +218 -0
- data/lib/brevo-ruby/api/master_account_api.rb +535 -0
- data/lib/brevo-ruby/api/notes_api.rb +318 -0
- data/lib/brevo-ruby/api/process_api.rb +151 -0
- data/lib/brevo-ruby/api/reseller_api.rb +923 -0
- data/lib/brevo-ruby/api/senders_api.rb +388 -0
- data/lib/brevo-ruby/api/sms_campaigns_api.rb +603 -0
- data/lib/brevo-ruby/api/tasks_api.rb +385 -0
- data/lib/brevo-ruby/api/transactional_emails_api.rb +1370 -0
- data/lib/brevo-ruby/api/transactional_sms_api.rb +290 -0
- data/lib/brevo-ruby/api/transactional_whats_app_api.rb +173 -0
- data/lib/brevo-ruby/api/user_api.rb +131 -0
- data/lib/brevo-ruby/api/webhooks_api.rb +357 -0
- data/lib/brevo-ruby/api/whats_app_campaigns_api.rb +534 -0
- data/lib/brevo-ruby/api_client.rb +392 -0
- data/lib/brevo-ruby/api_error.rb +38 -0
- data/lib/brevo-ruby/configuration.rb +216 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result.rb +299 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks.rb +176 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/brevo-ruby/models/ab_test_version_stats.rb +206 -0
- data/lib/brevo-ruby/models/add_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/add_contact_to_list.rb +199 -0
- data/lib/brevo-ruby/models/add_credits.rb +195 -0
- data/lib/brevo-ruby/models/authenticate_domain_model.rb +205 -0
- data/lib/brevo-ruby/models/block_domain.rb +190 -0
- data/lib/brevo-ruby/models/body.rb +210 -0
- data/lib/brevo-ruby/models/body_1.rb +205 -0
- data/lib/brevo-ruby/models/body_10.rb +225 -0
- data/lib/brevo-ruby/models/body_11.rb +190 -0
- data/lib/brevo-ruby/models/body_12.rb +215 -0
- data/lib/brevo-ruby/models/body_2.rb +223 -0
- data/lib/brevo-ruby/models/body_3.rb +200 -0
- data/lib/brevo-ruby/models/body_4.rb +195 -0
- data/lib/brevo-ruby/models/body_5.rb +223 -0
- data/lib/brevo-ruby/models/body_6.rb +320 -0
- data/lib/brevo-ruby/models/body_7.rb +281 -0
- data/lib/brevo-ruby/models/body_8.rb +245 -0
- data/lib/brevo-ruby/models/body_9.rb +190 -0
- data/lib/brevo-ruby/models/body_variables_items.rb +175 -0
- data/lib/brevo-ruby/models/companies_list.rb +188 -0
- data/lib/brevo-ruby/models/company.rb +220 -0
- data/lib/brevo-ruby/models/company_attributes.rb +176 -0
- data/lib/brevo-ruby/models/company_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/component_items.rb +193 -0
- data/lib/brevo-ruby/models/conversations_message.rb +324 -0
- data/lib/brevo-ruby/models/conversations_message_file.rb +239 -0
- data/lib/brevo-ruby/models/conversations_message_file_image_info.rb +236 -0
- data/lib/brevo-ruby/models/create_api_key_request.rb +200 -0
- data/lib/brevo-ruby/models/create_api_key_response.rb +195 -0
- data/lib/brevo-ruby/models/create_attribute.rb +251 -0
- data/lib/brevo-ruby/models/create_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/create_category_model.rb +185 -0
- data/lib/brevo-ruby/models/create_child.rb +294 -0
- data/lib/brevo-ruby/models/create_contact.rb +261 -0
- data/lib/brevo-ruby/models/create_coupon_collection.rb +205 -0
- data/lib/brevo-ruby/models/create_coupons.rb +206 -0
- data/lib/brevo-ruby/models/create_doi_contact.rb +259 -0
- data/lib/brevo-ruby/models/create_domain.rb +190 -0
- data/lib/brevo-ruby/models/create_domain_model.rb +219 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records.rb +193 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records_dkim_record.rb +211 -0
- data/lib/brevo-ruby/models/create_email_campaign.rb +597 -0
- data/lib/brevo-ruby/models/create_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_email_campaign_sender.rb +211 -0
- data/lib/brevo-ruby/models/create_external_feed.rb +339 -0
- data/lib/brevo-ruby/models/create_list.rb +205 -0
- data/lib/brevo-ruby/models/create_model.rb +190 -0
- data/lib/brevo-ruby/models/create_product_model.rb +185 -0
- data/lib/brevo-ruby/models/create_reseller.rb +200 -0
- data/lib/brevo-ruby/models/create_sender.rb +217 -0
- data/lib/brevo-ruby/models/create_sender_ips.rb +239 -0
- data/lib/brevo-ruby/models/create_sender_model.rb +210 -0
- data/lib/brevo-ruby/models/create_sms_campaign.rb +290 -0
- data/lib/brevo-ruby/models/create_sms_campaign_recipients.rb +204 -0
- data/lib/brevo-ruby/models/create_smtp_email.rb +196 -0
- data/lib/brevo-ruby/models/create_smtp_template.rb +289 -0
- data/lib/brevo-ruby/models/create_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/create_sub_account.rb +259 -0
- data/lib/brevo-ruby/models/create_sub_account_response.rb +190 -0
- data/lib/brevo-ruby/models/create_update_batch_category.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_category_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_batch_products.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_products_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_categories.rb +220 -0
- data/lib/brevo-ruby/models/create_update_category.rb +232 -0
- data/lib/brevo-ruby/models/create_update_contact_model.rb +185 -0
- data/lib/brevo-ruby/models/create_update_folder.rb +185 -0
- data/lib/brevo-ruby/models/create_update_product.rb +301 -0
- data/lib/brevo-ruby/models/create_update_products.rb +289 -0
- data/lib/brevo-ruby/models/create_webhook.rb +273 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign.rb +234 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_whats_app_template.rb +289 -0
- data/lib/brevo-ruby/models/created_batch_id.rb +190 -0
- data/lib/brevo-ruby/models/created_process_id.rb +190 -0
- data/lib/brevo-ruby/models/deal.rb +220 -0
- data/lib/brevo-ruby/models/deal_attributes.rb +176 -0
- data/lib/brevo-ruby/models/deal_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/deals_list.rb +188 -0
- data/lib/brevo-ruby/models/delete_hardbounces.rb +205 -0
- data/lib/brevo-ruby/models/email_export_recipients.rb +234 -0
- data/lib/brevo-ruby/models/error_model.rb +239 -0
- data/lib/brevo-ruby/models/export_webhooks_history.rb +309 -0
- data/lib/brevo-ruby/models/file_data.rb +246 -0
- data/lib/brevo-ruby/models/file_downloadable_link.rb +190 -0
- data/lib/brevo-ruby/models/file_list.rb +176 -0
- data/lib/brevo-ruby/models/get_account.rb +289 -0
- data/lib/brevo-ruby/models/get_account_activity.rb +187 -0
- data/lib/brevo-ruby/models/get_account_activity_logs.rb +250 -0
- data/lib/brevo-ruby/models/get_account_marketing_automation.rb +200 -0
- data/lib/brevo-ruby/models/get_account_plan.rb +296 -0
- data/lib/brevo-ruby/models/get_account_relay.rb +205 -0
- data/lib/brevo-ruby/models/get_account_relay_data.rb +221 -0
- data/lib/brevo-ruby/models/get_aggregated_report.rb +305 -0
- data/lib/brevo-ruby/models/get_all_external_feeds.rb +196 -0
- data/lib/brevo-ruby/models/get_all_external_feeds_feeds.rb +404 -0
- data/lib/brevo-ruby/models/get_attributes.rb +192 -0
- data/lib/brevo-ruby/models/get_attributes_attributes.rb +283 -0
- data/lib/brevo-ruby/models/get_attributes_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/get_blocked_domains.rb +193 -0
- data/lib/brevo-ruby/models/get_campaign_overview.rb +371 -0
- data/lib/brevo-ruby/models/get_campaign_recipients.rb +207 -0
- data/lib/brevo-ruby/models/get_campaign_stats.rb +390 -0
- data/lib/brevo-ruby/models/get_categories.rb +206 -0
- data/lib/brevo-ruby/models/get_category_details.rb +255 -0
- data/lib/brevo-ruby/models/get_child_account_creation_status.rb +190 -0
- data/lib/brevo-ruby/models/get_child_domain.rb +195 -0
- data/lib/brevo-ruby/models/get_child_domains.rb +175 -0
- data/lib/brevo-ruby/models/get_child_info.rb +289 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys.rb +203 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v2.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v3.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_credits.rb +196 -0
- data/lib/brevo-ruby/models/get_child_info_statistics.rb +206 -0
- data/lib/brevo-ruby/models/get_children_list.rb +197 -0
- data/lib/brevo-ruby/models/get_client.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats.rb +273 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_clicked.rb +206 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
- data/lib/brevo-ruby/models/get_contact_details.rb +307 -0
- data/lib/brevo-ruby/models/get_contacts.rb +206 -0
- data/lib/brevo-ruby/models/get_coupon_collection.rb +265 -0
- data/lib/brevo-ruby/models/get_device_browser_stats.rb +235 -0
- data/lib/brevo-ruby/models/get_domain_configuration_model.rb +234 -0
- data/lib/brevo-ruby/models/get_domains_list.rb +187 -0
- data/lib/brevo-ruby/models/get_domains_list_domains.rb +245 -0
- data/lib/brevo-ruby/models/get_email_campaign.rb +598 -0
- data/lib/brevo-ruby/models/get_email_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_email_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_email_event_report_events.rb +339 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview.rb +570 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats.rb +295 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/brevo-ruby/models/get_extended_client.rb +249 -0
- data/lib/brevo-ruby/models/get_extended_client_address.rb +236 -0
- data/lib/brevo-ruby/models/get_extended_contact_details.rb +321 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics.rb +281 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_clicked.rb +207 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_links.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
- data/lib/brevo-ruby/models/get_extended_list.rb +301 -0
- data/lib/brevo-ruby/models/get_extended_list_campaign_stats.rb +204 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid.rb +404 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid_headers.rb +195 -0
- data/lib/brevo-ruby/models/get_folder.rb +250 -0
- data/lib/brevo-ruby/models/get_folder_lists.rb +196 -0
- data/lib/brevo-ruby/models/get_folders.rb +196 -0
- data/lib/brevo-ruby/models/get_inbound_email_events.rb +186 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_events.rb +235 -0
- data/lib/brevo-ruby/models/get_invited_users_list.rb +187 -0
- data/lib/brevo-ruby/models/get_invited_users_list_feature_access.rb +206 -0
- data/lib/brevo-ruby/models/get_invited_users_list_users.rb +234 -0
- data/lib/brevo-ruby/models/get_ip.rb +235 -0
- data/lib/brevo-ruby/models/get_ip_from_sender.rb +235 -0
- data/lib/brevo-ruby/models/get_ips.rb +192 -0
- data/lib/brevo-ruby/models/get_ips_from_sender.rb +192 -0
- data/lib/brevo-ruby/models/get_list.rb +250 -0
- data/lib/brevo-ruby/models/get_lists.rb +197 -0
- data/lib/brevo-ruby/models/get_process.rb +264 -0
- data/lib/brevo-ruby/models/get_processes.rb +197 -0
- data/lib/brevo-ruby/models/get_product_details.rb +357 -0
- data/lib/brevo-ruby/models/get_products.rb +206 -0
- data/lib/brevo-ruby/models/get_reports.rb +186 -0
- data/lib/brevo-ruby/models/get_reports_reports.rb +370 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/brevo-ruby/models/get_segments.rb +194 -0
- data/lib/brevo-ruby/models/get_segments_segments.rb +215 -0
- data/lib/brevo-ruby/models/get_senders_list.rb +187 -0
- data/lib/brevo-ruby/models/get_senders_list_ips.rb +220 -0
- data/lib/brevo-ruby/models/get_senders_list_senders.rb +247 -0
- data/lib/brevo-ruby/models/get_shared_template_url.rb +190 -0
- data/lib/brevo-ruby/models/get_sms_campaign.rb +352 -0
- data/lib/brevo-ruby/models/get_sms_campaign_overview.rb +324 -0
- data/lib/brevo-ruby/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/brevo-ruby/models/get_sms_campaign_stats.rb +280 -0
- data/lib/brevo-ruby/models/get_sms_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_sms_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_sms_event_report_events.rb +278 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview.rb +364 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_smtp_templates.rb +196 -0
- data/lib/brevo-ruby/models/get_sso_token.rb +190 -0
- data/lib/brevo-ruby/models/get_stats_by_browser.rb +175 -0
- data/lib/brevo-ruby/models/get_stats_by_device.rb +223 -0
- data/lib/brevo-ruby/models/get_stats_by_domain.rb +175 -0
- data/lib/brevo-ruby/models/get_transac_aggregated_sms_report.rb +275 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_contacts.rb +234 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_reason.rb +230 -0
- data/lib/brevo-ruby/models/get_transac_email_content.rb +277 -0
- data/lib/brevo-ruby/models/get_transac_email_content_events.rb +205 -0
- data/lib/brevo-ruby/models/get_transac_emails_list.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_emails_list_transactional_emails.rb +282 -0
- data/lib/brevo-ruby/models/get_transac_sms_report.rb +186 -0
- data/lib/brevo-ruby/models/get_transac_sms_report_reports.rb +275 -0
- data/lib/brevo-ruby/models/get_user_permission.rb +223 -0
- data/lib/brevo-ruby/models/get_user_permission_privileges.rb +205 -0
- data/lib/brevo-ruby/models/get_wa_templates.rb +206 -0
- data/lib/brevo-ruby/models/get_wa_templates_templates.rb +290 -0
- data/lib/brevo-ruby/models/get_webhook.rb +315 -0
- data/lib/brevo-ruby/models/get_webhooks.rb +191 -0
- data/lib/brevo-ruby/models/get_whats_app_config.rb +281 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaign_overview.rb +332 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns_campaigns.rb +353 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report_events.rb +314 -0
- data/lib/brevo-ruby/models/inline_response_200.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_200_1.rb +220 -0
- data/lib/brevo-ruby/models/inline_response_201.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_1.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_2.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_3.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_4.rb +190 -0
- data/lib/brevo-ruby/models/manage_ip.rb +185 -0
- data/lib/brevo-ruby/models/master_details_response.rb +243 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info.rb +214 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info.rb +272 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/brevo-ruby/models/note.rb +283 -0
- data/lib/brevo-ruby/models/note_data.rb +255 -0
- data/lib/brevo-ruby/models/note_id.rb +186 -0
- data/lib/brevo-ruby/models/note_list.rb +176 -0
- data/lib/brevo-ruby/models/order.rb +297 -0
- data/lib/brevo-ruby/models/order_batch.rb +202 -0
- data/lib/brevo-ruby/models/order_billing.rb +246 -0
- data/lib/brevo-ruby/models/order_products.rb +231 -0
- data/lib/brevo-ruby/models/otp.rb +185 -0
- data/lib/brevo-ruby/models/pipeline.rb +208 -0
- data/lib/brevo-ruby/models/pipeline_stage.rb +196 -0
- data/lib/brevo-ruby/models/pipelines.rb +176 -0
- data/lib/brevo-ruby/models/post_contact_info.rb +189 -0
- data/lib/brevo-ruby/models/post_contact_info_contacts.rb +217 -0
- data/lib/brevo-ruby/models/post_send_failed.rb +238 -0
- data/lib/brevo-ruby/models/post_send_sms_test_failed.rb +227 -0
- data/lib/brevo-ruby/models/remaining_credit_model.rb +203 -0
- data/lib/brevo-ruby/models/remaining_credit_model_child.rb +206 -0
- data/lib/brevo-ruby/models/remaining_credit_model_reseller.rb +205 -0
- data/lib/brevo-ruby/models/remove_contact_from_list.rb +209 -0
- data/lib/brevo-ruby/models/remove_credits.rb +195 -0
- data/lib/brevo-ruby/models/request_contact_export.rb +211 -0
- data/lib/brevo-ruby/models/request_contact_export_custom_contact_filter.rb +294 -0
- data/lib/brevo-ruby/models/request_contact_import.rb +286 -0
- data/lib/brevo-ruby/models/request_contact_import_new_list.rb +196 -0
- data/lib/brevo-ruby/models/request_sms_recipient_export.rb +234 -0
- data/lib/brevo-ruby/models/schedule_smtp_email.rb +206 -0
- data/lib/brevo-ruby/models/send_report.rb +235 -0
- data/lib/brevo-ruby/models/send_report_email.rb +208 -0
- data/lib/brevo-ruby/models/send_sms.rb +233 -0
- data/lib/brevo-ruby/models/send_smtp_email.rb +345 -0
- data/lib/brevo-ruby/models/send_smtp_email_attachment.rb +220 -0
- data/lib/brevo-ruby/models/send_smtp_email_bcc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_cc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_sender.rb +206 -0
- data/lib/brevo-ruby/models/send_smtp_email_to.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_to_1.rb +200 -0
- data/lib/brevo-ruby/models/send_test_email.rb +187 -0
- data/lib/brevo-ruby/models/send_test_sms.rb +185 -0
- data/lib/brevo-ruby/models/send_transac_sms.rb +327 -0
- data/lib/brevo-ruby/models/send_whatsapp_message.rb +227 -0
- data/lib/brevo-ruby/models/sso_token_request.rb +244 -0
- data/lib/brevo-ruby/models/sub_account_details_response.rb +214 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request.rb +194 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/brevo-ruby/models/sub_accounts_response.rb +196 -0
- data/lib/brevo-ruby/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/brevo-ruby/models/task.rb +252 -0
- data/lib/brevo-ruby/models/task_list.rb +188 -0
- data/lib/brevo-ruby/models/task_reminder.rb +257 -0
- data/lib/brevo-ruby/models/task_types.rb +196 -0
- data/lib/brevo-ruby/models/update_attribute.rb +197 -0
- data/lib/brevo-ruby/models/update_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/update_batch_contacts.rb +187 -0
- data/lib/brevo-ruby/models/update_batch_contacts_contacts.rb +283 -0
- data/lib/brevo-ruby/models/update_batch_contacts_model.rb +197 -0
- data/lib/brevo-ruby/models/update_campaign_status.rb +220 -0
- data/lib/brevo-ruby/models/update_child.rb +225 -0
- data/lib/brevo-ruby/models/update_child_account_status.rb +215 -0
- data/lib/brevo-ruby/models/update_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/update_contact.rb +251 -0
- data/lib/brevo-ruby/models/update_coupon_collection.rb +190 -0
- data/lib/brevo-ruby/models/update_email_campaign.rb +587 -0
- data/lib/brevo-ruby/models/update_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/update_email_campaign_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_external_feed.rb +327 -0
- data/lib/brevo-ruby/models/update_list.rb +195 -0
- data/lib/brevo-ruby/models/update_sender.rb +207 -0
- data/lib/brevo-ruby/models/update_sms_campaign.rb +271 -0
- data/lib/brevo-ruby/models/update_smtp_template.rb +274 -0
- data/lib/brevo-ruby/models/update_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_webhook.rb +239 -0
- data/lib/brevo-ruby/models/update_whats_app_campaign.rb +250 -0
- data/lib/brevo-ruby/models/upload_image_model.rb +190 -0
- data/lib/brevo-ruby/models/upload_image_to_gallery.rb +200 -0
- data/lib/brevo-ruby/models/variables_items.rb +202 -0
- data/lib/brevo-ruby/models/whatsapp_camp_stats.rb +245 -0
- data/lib/brevo-ruby/models/whatsapp_camp_template.rb +287 -0
- data/lib/brevo-ruby/version.rb +15 -0
- data/lib/brevo-ruby.rb +393 -0
- data/spec/api/account_api_spec.rb +59 -0
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +387 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/coupons_api_spec.rb +93 -0
- data/spec/api/deals_api_spec.rb +141 -0
- data/spec/api/domains_api_spec.rb +89 -0
- data/spec/api/ecommerce_api_spec.rb +173 -0
- data/spec/api/email_campaigns_api_spec.rb +195 -0
- data/spec/api/external_feeds_api_spec.rb +102 -0
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +76 -0
- data/spec/api/master_account_api_spec.rb +145 -0
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/process_api_spec.rb +59 -0
- data/spec/api/reseller_api_spec.rb +223 -0
- data/spec/api/senders_api_spec.rb +114 -0
- data/spec/api/sms_campaigns_api_spec.rb +157 -0
- data/spec/api/tasks_api_spec.rb +113 -0
- data/spec/api/transactional_emails_api_spec.rb +330 -0
- data/spec/api/transactional_sms_api_spec.rb +94 -0
- data/spec/api/transactional_whats_app_api_spec.rb +66 -0
- data/spec/api/user_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +104 -0
- data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +41 -0
- data/spec/models/add_contact_to_list_spec.rb +47 -0
- data/spec/models/add_credits_spec.rb +47 -0
- data/spec/models/authenticate_domain_model_spec.rb +47 -0
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +53 -0
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/body_7_spec.rb +95 -0
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +53 -0
- data/spec/models/body_variables_items_spec.rb +35 -0
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/component_items_spec.rb +47 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_api_key_request_spec.rb +47 -0
- data/spec/models/create_api_key_response_spec.rb +47 -0
- data/spec/models/create_attribute_enumeration_spec.rb +47 -0
- data/spec/models/create_attribute_spec.rb +63 -0
- data/spec/models/create_category_model_spec.rb +41 -0
- data/spec/models/create_child_spec.rb +75 -0
- data/spec/models/create_contact_spec.rb +83 -0
- data/spec/models/create_coupon_collection_spec.rb +47 -0
- data/spec/models/create_coupons_spec.rb +47 -0
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
- data/spec/models/create_domain_model_spec.rb +59 -0
- data/spec/models/create_domain_spec.rb +41 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_email_campaign_sender_spec.rb +53 -0
- data/spec/models/create_email_campaign_spec.rb +219 -0
- data/spec/models/create_external_feed_spec.rb +93 -0
- data/spec/models/create_list_spec.rb +47 -0
- data/spec/models/create_model_spec.rb +41 -0
- data/spec/models/create_product_model_spec.rb +41 -0
- data/spec/models/create_reseller_spec.rb +47 -0
- data/spec/models/create_sender_ips_spec.rb +53 -0
- data/spec/models/create_sender_model_spec.rb +53 -0
- data/spec/models/create_sender_spec.rb +53 -0
- data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
- data/spec/models/create_sms_campaign_spec.rb +83 -0
- data/spec/models/create_smtp_email_spec.rb +47 -0
- data/spec/models/create_smtp_template_sender_spec.rb +53 -0
- data/spec/models/create_smtp_template_spec.rb +95 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/create_sub_account_spec.rb +63 -0
- data/spec/models/create_update_batch_category_model_spec.rb +47 -0
- data/spec/models/create_update_batch_category_spec.rb +47 -0
- data/spec/models/create_update_batch_products_model_spec.rb +47 -0
- data/spec/models/create_update_batch_products_spec.rb +47 -0
- data/spec/models/create_update_categories_spec.rb +59 -0
- data/spec/models/create_update_category_spec.rb +65 -0
- data/spec/models/create_update_contact_model_spec.rb +41 -0
- data/spec/models/create_update_folder_spec.rb +41 -0
- data/spec/models/create_update_product_spec.rb +101 -0
- data/spec/models/create_update_products_spec.rb +95 -0
- data/spec/models/create_webhook_spec.rb +73 -0
- data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_whats_app_campaign_spec.rb +59 -0
- data/spec/models/create_whats_app_template_spec.rb +75 -0
- data/spec/models/created_batch_id_spec.rb +41 -0
- data/spec/models/created_process_id_spec.rb +41 -0
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/delete_hardbounces_spec.rb +53 -0
- data/spec/models/email_export_recipients_spec.rb +51 -0
- data/spec/models/error_model_spec.rb +51 -0
- data/spec/models/export_webhooks_history_spec.rb +93 -0
- data/spec/models/file_data_spec.rb +77 -0
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_account_activity_logs_spec.rb +65 -0
- data/spec/models/get_account_activity_spec.rb +41 -0
- data/spec/models/get_account_marketing_automation_spec.rb +47 -0
- data/spec/models/get_account_plan_spec.rb +79 -0
- data/spec/models/get_account_relay_data_spec.rb +53 -0
- data/spec/models/get_account_relay_spec.rb +47 -0
- data/spec/models/get_account_spec.rb +83 -0
- data/spec/models/get_aggregated_report_spec.rb +113 -0
- data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
- data/spec/models/get_all_external_feeds_spec.rb +47 -0
- data/spec/models/get_attributes_attributes_spec.rb +73 -0
- data/spec/models/get_attributes_enumeration_spec.rb +47 -0
- data/spec/models/get_attributes_spec.rb +41 -0
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +121 -0
- data/spec/models/get_campaign_recipients_spec.rb +47 -0
- data/spec/models/get_campaign_stats_spec.rb +131 -0
- data/spec/models/get_categories_spec.rb +47 -0
- data/spec/models/get_category_details_spec.rb +71 -0
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +47 -0
- data/spec/models/get_child_domains_spec.rb +35 -0
- data/spec/models/get_child_info_api_keys_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
- data/spec/models/get_child_info_credits_spec.rb +47 -0
- data/spec/models/get_child_info_spec.rb +89 -0
- data/spec/models/get_child_info_statistics_spec.rb +53 -0
- data/spec/models/get_children_list_spec.rb +47 -0
- data/spec/models/get_client_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_contact_details_spec.rb +89 -0
- data/spec/models/get_contacts_spec.rb +47 -0
- data/spec/models/get_coupon_collection_spec.rb +71 -0
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_domain_configuration_model_spec.rb +59 -0
- data/spec/models/get_domains_list_domains_spec.rb +65 -0
- data/spec/models/get_domains_list_spec.rb +41 -0
- data/spec/models/get_email_campaign_spec.rb +229 -0
- data/spec/models/get_email_campaigns_spec.rb +47 -0
- data/spec/models/get_email_event_report_events_spec.rb +105 -0
- data/spec/models/get_email_event_report_spec.rb +41 -0
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +217 -0
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
- data/spec/models/get_extended_client_address_spec.rb +59 -0
- data/spec/models/get_extended_client_spec.rb +65 -0
- data/spec/models/get_extended_contact_details_spec.rb +95 -0
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
- data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
- data/spec/models/get_extended_list_spec.rb +89 -0
- data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
- data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
- data/spec/models/get_folder_lists_spec.rb +47 -0
- data/spec/models/get_folder_spec.rb +65 -0
- data/spec/models/get_folders_spec.rb +47 -0
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
- data/spec/models/get_invited_users_list_spec.rb +41 -0
- data/spec/models/get_invited_users_list_users_spec.rb +59 -0
- data/spec/models/get_ip_from_sender_spec.rb +59 -0
- data/spec/models/get_ip_spec.rb +59 -0
- data/spec/models/get_ips_from_sender_spec.rb +41 -0
- data/spec/models/get_ips_spec.rb +41 -0
- data/spec/models/get_list_spec.rb +65 -0
- data/spec/models/get_lists_spec.rb +47 -0
- data/spec/models/get_process_spec.rb +63 -0
- data/spec/models/get_processes_spec.rb +47 -0
- data/spec/models/get_product_details_spec.rb +125 -0
- data/spec/models/get_products_spec.rb +47 -0
- data/spec/models/get_reports_reports_spec.rb +113 -0
- data/spec/models/get_reports_spec.rb +41 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/get_segments_segments_spec.rb +59 -0
- data/spec/models/get_segments_spec.rb +47 -0
- data/spec/models/get_senders_list_ips_spec.rb +53 -0
- data/spec/models/get_senders_list_senders_spec.rb +65 -0
- data/spec/models/get_senders_list_spec.rb +41 -0
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +99 -0
- data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
- data/spec/models/get_sms_campaigns_spec.rb +47 -0
- data/spec/models/get_sms_event_report_events_spec.rb +81 -0
- data/spec/models/get_sms_event_report_spec.rb +41 -0
- data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
- data/spec/models/get_smtp_template_overview_spec.rb +113 -0
- data/spec/models/get_smtp_templates_spec.rb +47 -0
- data/spec/models/get_sso_token_spec.rb +41 -0
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +35 -0
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +47 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
- data/spec/models/get_transac_sms_report_spec.rb +41 -0
- data/spec/models/get_user_permission_privileges_spec.rb +47 -0
- data/spec/models/get_user_permission_spec.rb +53 -0
- data/spec/models/get_wa_templates_spec.rb +47 -0
- data/spec/models/get_wa_templates_templates_spec.rb +83 -0
- data/spec/models/get_webhook_spec.rb +81 -0
- data/spec/models/get_webhooks_spec.rb +41 -0
- data/spec/models/get_whats_app_config_spec.rb +79 -0
- data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
- data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
- data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
- data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
- data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
- data/spec/models/inline_response_200_1_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_2_spec.rb +41 -0
- data/spec/models/inline_response_201_3_spec.rb +41 -0
- data/spec/models/inline_response_201_4_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/manage_ip_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +59 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/order_batch_spec.rb +47 -0
- data/spec/models/order_billing_spec.rb +77 -0
- data/spec/models/order_products_spec.rb +59 -0
- data/spec/models/order_spec.rb +89 -0
- data/spec/models/otp_spec.rb +41 -0
- data/spec/models/pipeline_spec.rb +53 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/pipelines_spec.rb +35 -0
- data/spec/models/post_contact_info_contacts_spec.rb +59 -0
- data/spec/models/post_contact_info_spec.rb +41 -0
- data/spec/models/post_send_failed_spec.rb +65 -0
- data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
- data/spec/models/remaining_credit_model_child_spec.rb +47 -0
- data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
- data/spec/models/remaining_credit_model_spec.rb +47 -0
- data/spec/models/remove_contact_from_list_spec.rb +53 -0
- data/spec/models/remove_credits_spec.rb +47 -0
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +53 -0
- data/spec/models/request_contact_import_new_list_spec.rb +47 -0
- data/spec/models/request_contact_import_spec.rb +95 -0
- data/spec/models/request_sms_recipient_export_spec.rb +51 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_report_email_spec.rb +47 -0
- data/spec/models/send_report_spec.rb +51 -0
- data/spec/models/send_sms_spec.rb +65 -0
- data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
- data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
- data/spec/models/send_smtp_email_cc_spec.rb +47 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
- data/spec/models/send_smtp_email_sender_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +131 -0
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +47 -0
- data/spec/models/send_test_email_spec.rb +41 -0
- data/spec/models/send_test_sms_spec.rb +41 -0
- data/spec/models/send_transac_sms_spec.rb +87 -0
- data/spec/models/send_whatsapp_message_spec.rb +59 -0
- data/spec/models/sso_token_request_spec.rb +57 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +71 -0
- data/spec/models/task_types_spec.rb +47 -0
- data/spec/models/update_attribute_enumeration_spec.rb +47 -0
- data/spec/models/update_attribute_spec.rb +47 -0
- data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/update_batch_contacts_spec.rb +41 -0
- data/spec/models/update_campaign_status_spec.rb +45 -0
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +41 -0
- data/spec/models/update_child_spec.rb +65 -0
- data/spec/models/update_contact_spec.rb +77 -0
- data/spec/models/update_coupon_collection_spec.rb +41 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/update_email_campaign_sender_spec.rb +53 -0
- data/spec/models/update_email_campaign_spec.rb +219 -0
- data/spec/models/update_external_feed_spec.rb +93 -0
- data/spec/models/update_list_spec.rb +47 -0
- data/spec/models/update_sender_spec.rb +53 -0
- data/spec/models/update_sms_campaign_spec.rb +83 -0
- data/spec/models/update_smtp_template_sender_spec.rb +53 -0
- data/spec/models/update_smtp_template_spec.rb +95 -0
- data/spec/models/update_webhook_spec.rb +63 -0
- data/spec/models/update_whats_app_campaign_spec.rb +63 -0
- data/spec/models/upload_image_model_spec.rb +41 -0
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/models/variables_items_spec.rb +53 -0
- data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
- data/spec/models/whatsapp_camp_template_spec.rb +101 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1675 -0
data/docs/ResellerApi.md
ADDED
|
@@ -0,0 +1,964 @@
|
|
|
1
|
+
# BrevoRuby::ResellerApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
|
8
|
+
[**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
|
9
|
+
[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
|
10
|
+
[**create_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
|
|
11
|
+
[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
12
|
+
[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
|
13
|
+
[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
|
14
|
+
[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
|
15
|
+
[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
|
16
|
+
[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
|
17
|
+
[**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
|
|
18
|
+
[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO)
|
|
19
|
+
[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
|
20
|
+
[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
|
21
|
+
[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
|
22
|
+
[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# **add_credits**
|
|
26
|
+
> RemainingCreditModel add_credits(child_identifier, add_credits)
|
|
27
|
+
|
|
28
|
+
Add Email and/or SMS credits to a specific child account
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
```ruby
|
|
32
|
+
# load the gem
|
|
33
|
+
require 'brevo-ruby'
|
|
34
|
+
# setup authorization
|
|
35
|
+
BrevoRuby.configure do |config|
|
|
36
|
+
# Configure API key authorization: api-key
|
|
37
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
39
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
40
|
+
|
|
41
|
+
# Configure API key authorization: partner-key
|
|
42
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
43
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
44
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
48
|
+
|
|
49
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
50
|
+
|
|
51
|
+
add_credits = BrevoRuby::AddCredits.new # AddCredits | Values to post to add credit to a specific child account
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
#Add Email and/or SMS credits to a specific child account
|
|
56
|
+
result = api_instance.add_credits(child_identifier, add_credits)
|
|
57
|
+
p result
|
|
58
|
+
rescue BrevoRuby::ApiError => e
|
|
59
|
+
puts "Exception when calling ResellerApi->add_credits: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
Name | Type | Description | Notes
|
|
66
|
+
------------- | ------------- | ------------- | -------------
|
|
67
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
68
|
+
**add_credits** | [**AddCredits**](AddCredits.md)| Values to post to add credit to a specific child account |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**RemainingCreditModel**](RemainingCreditModel.md)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: application/json
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
# **associate_ip_to_child**
|
|
86
|
+
> associate_ip_to_child(child_identifier, ip)
|
|
87
|
+
|
|
88
|
+
Associate a dedicated IP to the child
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
```ruby
|
|
92
|
+
# load the gem
|
|
93
|
+
require 'brevo-ruby'
|
|
94
|
+
# setup authorization
|
|
95
|
+
BrevoRuby.configure do |config|
|
|
96
|
+
# Configure API key authorization: api-key
|
|
97
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
98
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
99
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
100
|
+
|
|
101
|
+
# Configure API key authorization: partner-key
|
|
102
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
104
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
108
|
+
|
|
109
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
110
|
+
|
|
111
|
+
ip = BrevoRuby::ManageIp.new # ManageIp | IP to associate
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
begin
|
|
115
|
+
#Associate a dedicated IP to the child
|
|
116
|
+
api_instance.associate_ip_to_child(child_identifier, ip)
|
|
117
|
+
rescue BrevoRuby::ApiError => e
|
|
118
|
+
puts "Exception when calling ResellerApi->associate_ip_to_child: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
Name | Type | Description | Notes
|
|
125
|
+
------------- | ------------- | ------------- | -------------
|
|
126
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
127
|
+
**ip** | [**ManageIp**](ManageIp.md)| IP to associate |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
nil (empty response body)
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: application/json
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
# **create_child_domain**
|
|
145
|
+
> create_child_domain(child_identifier, add_child_domain)
|
|
146
|
+
|
|
147
|
+
Create a domain for a child account
|
|
148
|
+
|
|
149
|
+
### Example
|
|
150
|
+
```ruby
|
|
151
|
+
# load the gem
|
|
152
|
+
require 'brevo-ruby'
|
|
153
|
+
# setup authorization
|
|
154
|
+
BrevoRuby.configure do |config|
|
|
155
|
+
# Configure API key authorization: api-key
|
|
156
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
157
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
158
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
159
|
+
|
|
160
|
+
# Configure API key authorization: partner-key
|
|
161
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
162
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
163
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
167
|
+
|
|
168
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
169
|
+
|
|
170
|
+
add_child_domain = BrevoRuby::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
begin
|
|
174
|
+
#Create a domain for a child account
|
|
175
|
+
api_instance.create_child_domain(child_identifier, add_child_domain)
|
|
176
|
+
rescue BrevoRuby::ApiError => e
|
|
177
|
+
puts "Exception when calling ResellerApi->create_child_domain: #{e}"
|
|
178
|
+
end
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Parameters
|
|
182
|
+
|
|
183
|
+
Name | Type | Description | Notes
|
|
184
|
+
------------- | ------------- | ------------- | -------------
|
|
185
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
186
|
+
**add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. |
|
|
187
|
+
|
|
188
|
+
### Return type
|
|
189
|
+
|
|
190
|
+
nil (empty response body)
|
|
191
|
+
|
|
192
|
+
### Authorization
|
|
193
|
+
|
|
194
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
195
|
+
|
|
196
|
+
### HTTP request headers
|
|
197
|
+
|
|
198
|
+
- **Content-Type**: application/json
|
|
199
|
+
- **Accept**: application/json
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
# **create_reseller_child**
|
|
204
|
+
> CreateReseller create_reseller_child(opts)
|
|
205
|
+
|
|
206
|
+
Creates a reseller child
|
|
207
|
+
|
|
208
|
+
### Example
|
|
209
|
+
```ruby
|
|
210
|
+
# load the gem
|
|
211
|
+
require 'brevo-ruby'
|
|
212
|
+
# setup authorization
|
|
213
|
+
BrevoRuby.configure do |config|
|
|
214
|
+
# Configure API key authorization: api-key
|
|
215
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
217
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
218
|
+
|
|
219
|
+
# Configure API key authorization: partner-key
|
|
220
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
221
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
222
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
226
|
+
|
|
227
|
+
opts = {
|
|
228
|
+
reseller_child: BrevoRuby::CreateChild.new # CreateChild | reseller child to add
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
begin
|
|
232
|
+
#Creates a reseller child
|
|
233
|
+
result = api_instance.create_reseller_child(opts)
|
|
234
|
+
p result
|
|
235
|
+
rescue BrevoRuby::ApiError => e
|
|
236
|
+
puts "Exception when calling ResellerApi->create_reseller_child: #{e}"
|
|
237
|
+
end
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Parameters
|
|
241
|
+
|
|
242
|
+
Name | Type | Description | Notes
|
|
243
|
+
------------- | ------------- | ------------- | -------------
|
|
244
|
+
**reseller_child** | [**CreateChild**](CreateChild.md)| reseller child to add | [optional]
|
|
245
|
+
|
|
246
|
+
### Return type
|
|
247
|
+
|
|
248
|
+
[**CreateReseller**](CreateReseller.md)
|
|
249
|
+
|
|
250
|
+
### Authorization
|
|
251
|
+
|
|
252
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
253
|
+
|
|
254
|
+
### HTTP request headers
|
|
255
|
+
|
|
256
|
+
- **Content-Type**: application/json
|
|
257
|
+
- **Accept**: application/json
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
# **delete_child_domain**
|
|
262
|
+
> delete_child_domain(child_identifier, domain_name)
|
|
263
|
+
|
|
264
|
+
Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
265
|
+
|
|
266
|
+
### Example
|
|
267
|
+
```ruby
|
|
268
|
+
# load the gem
|
|
269
|
+
require 'brevo-ruby'
|
|
270
|
+
# setup authorization
|
|
271
|
+
BrevoRuby.configure do |config|
|
|
272
|
+
# Configure API key authorization: api-key
|
|
273
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
275
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
276
|
+
|
|
277
|
+
# Configure API key authorization: partner-key
|
|
278
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
279
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
280
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
284
|
+
|
|
285
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
286
|
+
|
|
287
|
+
domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be deleted
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
begin
|
|
291
|
+
#Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
292
|
+
api_instance.delete_child_domain(child_identifier, domain_name)
|
|
293
|
+
rescue BrevoRuby::ApiError => e
|
|
294
|
+
puts "Exception when calling ResellerApi->delete_child_domain: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
Name | Type | Description | Notes
|
|
301
|
+
------------- | ------------- | ------------- | -------------
|
|
302
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
303
|
+
**domain_name** | **String**| Pass the existing domain that needs to be deleted |
|
|
304
|
+
|
|
305
|
+
### Return type
|
|
306
|
+
|
|
307
|
+
nil (empty response body)
|
|
308
|
+
|
|
309
|
+
### Authorization
|
|
310
|
+
|
|
311
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
312
|
+
|
|
313
|
+
### HTTP request headers
|
|
314
|
+
|
|
315
|
+
- **Content-Type**: application/json
|
|
316
|
+
- **Accept**: application/json
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
# **delete_reseller_child**
|
|
321
|
+
> delete_reseller_child(child_identifier)
|
|
322
|
+
|
|
323
|
+
Delete a single reseller child based on the child identifier supplied
|
|
324
|
+
|
|
325
|
+
### Example
|
|
326
|
+
```ruby
|
|
327
|
+
# load the gem
|
|
328
|
+
require 'brevo-ruby'
|
|
329
|
+
# setup authorization
|
|
330
|
+
BrevoRuby.configure do |config|
|
|
331
|
+
# Configure API key authorization: api-key
|
|
332
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
333
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
334
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
335
|
+
|
|
336
|
+
# Configure API key authorization: partner-key
|
|
337
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
343
|
+
|
|
344
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or child id of reseller's child
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
begin
|
|
348
|
+
#Delete a single reseller child based on the child identifier supplied
|
|
349
|
+
api_instance.delete_reseller_child(child_identifier)
|
|
350
|
+
rescue BrevoRuby::ApiError => e
|
|
351
|
+
puts "Exception when calling ResellerApi->delete_reseller_child: #{e}"
|
|
352
|
+
end
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
Name | Type | Description | Notes
|
|
358
|
+
------------- | ------------- | ------------- | -------------
|
|
359
|
+
**child_identifier** | **String**| Either auth key or child id of reseller's child |
|
|
360
|
+
|
|
361
|
+
### Return type
|
|
362
|
+
|
|
363
|
+
nil (empty response body)
|
|
364
|
+
|
|
365
|
+
### Authorization
|
|
366
|
+
|
|
367
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
368
|
+
|
|
369
|
+
### HTTP request headers
|
|
370
|
+
|
|
371
|
+
- **Content-Type**: application/json
|
|
372
|
+
- **Accept**: application/json
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
# **dissociate_ip_from_child**
|
|
377
|
+
> dissociate_ip_from_child(child_identifier, ip)
|
|
378
|
+
|
|
379
|
+
Dissociate a dedicated IP to the child
|
|
380
|
+
|
|
381
|
+
### Example
|
|
382
|
+
```ruby
|
|
383
|
+
# load the gem
|
|
384
|
+
require 'brevo-ruby'
|
|
385
|
+
# setup authorization
|
|
386
|
+
BrevoRuby.configure do |config|
|
|
387
|
+
# Configure API key authorization: api-key
|
|
388
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
389
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
390
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
391
|
+
|
|
392
|
+
# Configure API key authorization: partner-key
|
|
393
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
394
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
395
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
396
|
+
end
|
|
397
|
+
|
|
398
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
399
|
+
|
|
400
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
401
|
+
|
|
402
|
+
ip = BrevoRuby::ManageIp.new # ManageIp | IP to dissociate
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
begin
|
|
406
|
+
#Dissociate a dedicated IP to the child
|
|
407
|
+
api_instance.dissociate_ip_from_child(child_identifier, ip)
|
|
408
|
+
rescue BrevoRuby::ApiError => e
|
|
409
|
+
puts "Exception when calling ResellerApi->dissociate_ip_from_child: #{e}"
|
|
410
|
+
end
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### Parameters
|
|
414
|
+
|
|
415
|
+
Name | Type | Description | Notes
|
|
416
|
+
------------- | ------------- | ------------- | -------------
|
|
417
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
418
|
+
**ip** | [**ManageIp**](ManageIp.md)| IP to dissociate |
|
|
419
|
+
|
|
420
|
+
### Return type
|
|
421
|
+
|
|
422
|
+
nil (empty response body)
|
|
423
|
+
|
|
424
|
+
### Authorization
|
|
425
|
+
|
|
426
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
427
|
+
|
|
428
|
+
### HTTP request headers
|
|
429
|
+
|
|
430
|
+
- **Content-Type**: application/json
|
|
431
|
+
- **Accept**: application/json
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
# **get_child_account_creation_status**
|
|
436
|
+
> GetChildAccountCreationStatus get_child_account_creation_status(child_identifier)
|
|
437
|
+
|
|
438
|
+
Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
|
439
|
+
|
|
440
|
+
### Example
|
|
441
|
+
```ruby
|
|
442
|
+
# load the gem
|
|
443
|
+
require 'brevo-ruby'
|
|
444
|
+
# setup authorization
|
|
445
|
+
BrevoRuby.configure do |config|
|
|
446
|
+
# Configure API key authorization: api-key
|
|
447
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
448
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
449
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
450
|
+
|
|
451
|
+
# Configure API key authorization: partner-key
|
|
452
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
453
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
454
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
458
|
+
|
|
459
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
begin
|
|
463
|
+
#Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
|
464
|
+
result = api_instance.get_child_account_creation_status(child_identifier)
|
|
465
|
+
p result
|
|
466
|
+
rescue BrevoRuby::ApiError => e
|
|
467
|
+
puts "Exception when calling ResellerApi->get_child_account_creation_status: #{e}"
|
|
468
|
+
end
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
Name | Type | Description | Notes
|
|
474
|
+
------------- | ------------- | ------------- | -------------
|
|
475
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**GetChildAccountCreationStatus**](GetChildAccountCreationStatus.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: application/json
|
|
488
|
+
- **Accept**: application/json
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
# **get_child_domains**
|
|
493
|
+
> GetChildDomains get_child_domains(child_identifier)
|
|
494
|
+
|
|
495
|
+
Get all sender domains for a specific child account
|
|
496
|
+
|
|
497
|
+
### Example
|
|
498
|
+
```ruby
|
|
499
|
+
# load the gem
|
|
500
|
+
require 'brevo-ruby'
|
|
501
|
+
# setup authorization
|
|
502
|
+
BrevoRuby.configure do |config|
|
|
503
|
+
# Configure API key authorization: api-key
|
|
504
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
505
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
506
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
507
|
+
|
|
508
|
+
# Configure API key authorization: partner-key
|
|
509
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
510
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
511
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
515
|
+
|
|
516
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
begin
|
|
520
|
+
#Get all sender domains for a specific child account
|
|
521
|
+
result = api_instance.get_child_domains(child_identifier)
|
|
522
|
+
p result
|
|
523
|
+
rescue BrevoRuby::ApiError => e
|
|
524
|
+
puts "Exception when calling ResellerApi->get_child_domains: #{e}"
|
|
525
|
+
end
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
### Parameters
|
|
529
|
+
|
|
530
|
+
Name | Type | Description | Notes
|
|
531
|
+
------------- | ------------- | ------------- | -------------
|
|
532
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
533
|
+
|
|
534
|
+
### Return type
|
|
535
|
+
|
|
536
|
+
[**GetChildDomains**](GetChildDomains.md)
|
|
537
|
+
|
|
538
|
+
### Authorization
|
|
539
|
+
|
|
540
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
541
|
+
|
|
542
|
+
### HTTP request headers
|
|
543
|
+
|
|
544
|
+
- **Content-Type**: application/json
|
|
545
|
+
- **Accept**: application/json
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
# **get_child_info**
|
|
550
|
+
> GetChildInfo get_child_info(child_identifier)
|
|
551
|
+
|
|
552
|
+
Get a child account's details
|
|
553
|
+
|
|
554
|
+
### Example
|
|
555
|
+
```ruby
|
|
556
|
+
# load the gem
|
|
557
|
+
require 'brevo-ruby'
|
|
558
|
+
# setup authorization
|
|
559
|
+
BrevoRuby.configure do |config|
|
|
560
|
+
# Configure API key authorization: api-key
|
|
561
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
562
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
563
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
564
|
+
|
|
565
|
+
# Configure API key authorization: partner-key
|
|
566
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
567
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
568
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
569
|
+
end
|
|
570
|
+
|
|
571
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
572
|
+
|
|
573
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
begin
|
|
577
|
+
#Get a child account's details
|
|
578
|
+
result = api_instance.get_child_info(child_identifier)
|
|
579
|
+
p result
|
|
580
|
+
rescue BrevoRuby::ApiError => e
|
|
581
|
+
puts "Exception when calling ResellerApi->get_child_info: #{e}"
|
|
582
|
+
end
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
### Parameters
|
|
586
|
+
|
|
587
|
+
Name | Type | Description | Notes
|
|
588
|
+
------------- | ------------- | ------------- | -------------
|
|
589
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
[**GetChildInfo**](GetChildInfo.md)
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: application/json
|
|
602
|
+
- **Accept**: application/json
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
# **get_reseller_childs**
|
|
607
|
+
> GetChildrenList get_reseller_childs(opts)
|
|
608
|
+
|
|
609
|
+
Get the list of all children accounts
|
|
610
|
+
|
|
611
|
+
### Example
|
|
612
|
+
```ruby
|
|
613
|
+
# load the gem
|
|
614
|
+
require 'brevo-ruby'
|
|
615
|
+
# setup authorization
|
|
616
|
+
BrevoRuby.configure do |config|
|
|
617
|
+
# Configure API key authorization: api-key
|
|
618
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
619
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
620
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
621
|
+
|
|
622
|
+
# Configure API key authorization: partner-key
|
|
623
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
624
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
625
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
629
|
+
|
|
630
|
+
opts = {
|
|
631
|
+
limit: 10, # Integer | Number of documents for child accounts information per page
|
|
632
|
+
offset: 0 # Integer | Index of the first document in the page
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
begin
|
|
636
|
+
#Get the list of all children accounts
|
|
637
|
+
result = api_instance.get_reseller_childs(opts)
|
|
638
|
+
p result
|
|
639
|
+
rescue BrevoRuby::ApiError => e
|
|
640
|
+
puts "Exception when calling ResellerApi->get_reseller_childs: #{e}"
|
|
641
|
+
end
|
|
642
|
+
```
|
|
643
|
+
|
|
644
|
+
### Parameters
|
|
645
|
+
|
|
646
|
+
Name | Type | Description | Notes
|
|
647
|
+
------------- | ------------- | ------------- | -------------
|
|
648
|
+
**limit** | **Integer**| Number of documents for child accounts information per page | [optional] [default to 10]
|
|
649
|
+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
650
|
+
|
|
651
|
+
### Return type
|
|
652
|
+
|
|
653
|
+
[**GetChildrenList**](GetChildrenList.md)
|
|
654
|
+
|
|
655
|
+
### Authorization
|
|
656
|
+
|
|
657
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
658
|
+
|
|
659
|
+
### HTTP request headers
|
|
660
|
+
|
|
661
|
+
- **Content-Type**: application/json
|
|
662
|
+
- **Accept**: application/json
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
# **get_sso_token**
|
|
667
|
+
> GetSsoToken get_sso_token(child_identifier)
|
|
668
|
+
|
|
669
|
+
Get session token to access Brevo (SSO)
|
|
670
|
+
|
|
671
|
+
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
|
672
|
+
|
|
673
|
+
### Example
|
|
674
|
+
```ruby
|
|
675
|
+
# load the gem
|
|
676
|
+
require 'brevo-ruby'
|
|
677
|
+
# setup authorization
|
|
678
|
+
BrevoRuby.configure do |config|
|
|
679
|
+
# Configure API key authorization: api-key
|
|
680
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
681
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
682
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
683
|
+
|
|
684
|
+
# Configure API key authorization: partner-key
|
|
685
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
686
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
687
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
688
|
+
end
|
|
689
|
+
|
|
690
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
691
|
+
|
|
692
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
begin
|
|
696
|
+
#Get session token to access Brevo (SSO)
|
|
697
|
+
result = api_instance.get_sso_token(child_identifier)
|
|
698
|
+
p result
|
|
699
|
+
rescue BrevoRuby::ApiError => e
|
|
700
|
+
puts "Exception when calling ResellerApi->get_sso_token: #{e}"
|
|
701
|
+
end
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
### Parameters
|
|
705
|
+
|
|
706
|
+
Name | Type | Description | Notes
|
|
707
|
+
------------- | ------------- | ------------- | -------------
|
|
708
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
709
|
+
|
|
710
|
+
### Return type
|
|
711
|
+
|
|
712
|
+
[**GetSsoToken**](GetSsoToken.md)
|
|
713
|
+
|
|
714
|
+
### Authorization
|
|
715
|
+
|
|
716
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
717
|
+
|
|
718
|
+
### HTTP request headers
|
|
719
|
+
|
|
720
|
+
- **Content-Type**: application/json
|
|
721
|
+
- **Accept**: application/json
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
# **remove_credits**
|
|
726
|
+
> RemainingCreditModel remove_credits(child_identifier, remove_credits)
|
|
727
|
+
|
|
728
|
+
Remove Email and/or SMS credits from a specific child account
|
|
729
|
+
|
|
730
|
+
### Example
|
|
731
|
+
```ruby
|
|
732
|
+
# load the gem
|
|
733
|
+
require 'brevo-ruby'
|
|
734
|
+
# setup authorization
|
|
735
|
+
BrevoRuby.configure do |config|
|
|
736
|
+
# Configure API key authorization: api-key
|
|
737
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
738
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
739
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
740
|
+
|
|
741
|
+
# Configure API key authorization: partner-key
|
|
742
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
743
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
744
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
745
|
+
end
|
|
746
|
+
|
|
747
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
748
|
+
|
|
749
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
750
|
+
|
|
751
|
+
remove_credits = BrevoRuby::RemoveCredits.new # RemoveCredits | Values to post to remove email or SMS credits from a specific child account
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
begin
|
|
755
|
+
#Remove Email and/or SMS credits from a specific child account
|
|
756
|
+
result = api_instance.remove_credits(child_identifier, remove_credits)
|
|
757
|
+
p result
|
|
758
|
+
rescue BrevoRuby::ApiError => e
|
|
759
|
+
puts "Exception when calling ResellerApi->remove_credits: #{e}"
|
|
760
|
+
end
|
|
761
|
+
```
|
|
762
|
+
|
|
763
|
+
### Parameters
|
|
764
|
+
|
|
765
|
+
Name | Type | Description | Notes
|
|
766
|
+
------------- | ------------- | ------------- | -------------
|
|
767
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
768
|
+
**remove_credits** | [**RemoveCredits**](RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account |
|
|
769
|
+
|
|
770
|
+
### Return type
|
|
771
|
+
|
|
772
|
+
[**RemainingCreditModel**](RemainingCreditModel.md)
|
|
773
|
+
|
|
774
|
+
### Authorization
|
|
775
|
+
|
|
776
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
777
|
+
|
|
778
|
+
### HTTP request headers
|
|
779
|
+
|
|
780
|
+
- **Content-Type**: application/json
|
|
781
|
+
- **Accept**: application/json
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
# **update_child_account_status**
|
|
786
|
+
> update_child_account_status(child_identifier, update_child_account_status)
|
|
787
|
+
|
|
788
|
+
Update info of reseller's child account status based on the childIdentifier supplied
|
|
789
|
+
|
|
790
|
+
### Example
|
|
791
|
+
```ruby
|
|
792
|
+
# load the gem
|
|
793
|
+
require 'brevo-ruby'
|
|
794
|
+
# setup authorization
|
|
795
|
+
BrevoRuby.configure do |config|
|
|
796
|
+
# Configure API key authorization: api-key
|
|
797
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
798
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
799
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
800
|
+
|
|
801
|
+
# Configure API key authorization: partner-key
|
|
802
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
803
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
804
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
805
|
+
end
|
|
806
|
+
|
|
807
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
808
|
+
|
|
809
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
810
|
+
|
|
811
|
+
update_child_account_status = BrevoRuby::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
begin
|
|
815
|
+
#Update info of reseller's child account status based on the childIdentifier supplied
|
|
816
|
+
api_instance.update_child_account_status(child_identifier, update_child_account_status)
|
|
817
|
+
rescue BrevoRuby::ApiError => e
|
|
818
|
+
puts "Exception when calling ResellerApi->update_child_account_status: #{e}"
|
|
819
|
+
end
|
|
820
|
+
```
|
|
821
|
+
|
|
822
|
+
### Parameters
|
|
823
|
+
|
|
824
|
+
Name | Type | Description | Notes
|
|
825
|
+
------------- | ------------- | ------------- | -------------
|
|
826
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
827
|
+
**update_child_account_status** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status |
|
|
828
|
+
|
|
829
|
+
### Return type
|
|
830
|
+
|
|
831
|
+
nil (empty response body)
|
|
832
|
+
|
|
833
|
+
### Authorization
|
|
834
|
+
|
|
835
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
836
|
+
|
|
837
|
+
### HTTP request headers
|
|
838
|
+
|
|
839
|
+
- **Content-Type**: application/json
|
|
840
|
+
- **Accept**: application/json
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
# **update_child_domain**
|
|
845
|
+
> update_child_domain(child_identifier, domain_name, update_child_domain)
|
|
846
|
+
|
|
847
|
+
Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
|
848
|
+
|
|
849
|
+
### Example
|
|
850
|
+
```ruby
|
|
851
|
+
# load the gem
|
|
852
|
+
require 'brevo-ruby'
|
|
853
|
+
# setup authorization
|
|
854
|
+
BrevoRuby.configure do |config|
|
|
855
|
+
# Configure API key authorization: api-key
|
|
856
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
857
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
858
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
859
|
+
|
|
860
|
+
# Configure API key authorization: partner-key
|
|
861
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
862
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
863
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
864
|
+
end
|
|
865
|
+
|
|
866
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
867
|
+
|
|
868
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
869
|
+
|
|
870
|
+
domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be updated
|
|
871
|
+
|
|
872
|
+
update_child_domain = BrevoRuby::UpdateChildDomain.new # UpdateChildDomain | value to update for sender domain
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
begin
|
|
876
|
+
#Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
|
877
|
+
api_instance.update_child_domain(child_identifier, domain_name, update_child_domain)
|
|
878
|
+
rescue BrevoRuby::ApiError => e
|
|
879
|
+
puts "Exception when calling ResellerApi->update_child_domain: #{e}"
|
|
880
|
+
end
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
### Parameters
|
|
884
|
+
|
|
885
|
+
Name | Type | Description | Notes
|
|
886
|
+
------------- | ------------- | ------------- | -------------
|
|
887
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
888
|
+
**domain_name** | **String**| Pass the existing domain that needs to be updated |
|
|
889
|
+
**update_child_domain** | [**UpdateChildDomain**](UpdateChildDomain.md)| value to update for sender domain |
|
|
890
|
+
|
|
891
|
+
### Return type
|
|
892
|
+
|
|
893
|
+
nil (empty response body)
|
|
894
|
+
|
|
895
|
+
### Authorization
|
|
896
|
+
|
|
897
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
898
|
+
|
|
899
|
+
### HTTP request headers
|
|
900
|
+
|
|
901
|
+
- **Content-Type**: application/json
|
|
902
|
+
- **Accept**: application/json
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
# **update_reseller_child**
|
|
907
|
+
> update_reseller_child(child_identifier, reseller_child)
|
|
908
|
+
|
|
909
|
+
Update info of reseller's child based on the child identifier supplied
|
|
910
|
+
|
|
911
|
+
### Example
|
|
912
|
+
```ruby
|
|
913
|
+
# load the gem
|
|
914
|
+
require 'brevo-ruby'
|
|
915
|
+
# setup authorization
|
|
916
|
+
BrevoRuby.configure do |config|
|
|
917
|
+
# Configure API key authorization: api-key
|
|
918
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
919
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
920
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
921
|
+
|
|
922
|
+
# Configure API key authorization: partner-key
|
|
923
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
924
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
925
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
926
|
+
end
|
|
927
|
+
|
|
928
|
+
api_instance = BrevoRuby::ResellerApi.new
|
|
929
|
+
|
|
930
|
+
child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
|
|
931
|
+
|
|
932
|
+
reseller_child = BrevoRuby::UpdateChild.new # UpdateChild | values to update in child profile
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
begin
|
|
936
|
+
#Update info of reseller's child based on the child identifier supplied
|
|
937
|
+
api_instance.update_reseller_child(child_identifier, reseller_child)
|
|
938
|
+
rescue BrevoRuby::ApiError => e
|
|
939
|
+
puts "Exception when calling ResellerApi->update_reseller_child: #{e}"
|
|
940
|
+
end
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
### Parameters
|
|
944
|
+
|
|
945
|
+
Name | Type | Description | Notes
|
|
946
|
+
------------- | ------------- | ------------- | -------------
|
|
947
|
+
**child_identifier** | **String**| Either auth key or id of reseller's child |
|
|
948
|
+
**reseller_child** | [**UpdateChild**](UpdateChild.md)| values to update in child profile |
|
|
949
|
+
|
|
950
|
+
### Return type
|
|
951
|
+
|
|
952
|
+
nil (empty response body)
|
|
953
|
+
|
|
954
|
+
### Authorization
|
|
955
|
+
|
|
956
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
957
|
+
|
|
958
|
+
### HTTP request headers
|
|
959
|
+
|
|
960
|
+
- **Content-Type**: application/json
|
|
961
|
+
- **Accept**: application/json
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|