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
|
@@ -0,0 +1,336 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/getbrevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.0.0
|
|
7
|
+
Contact: contact@brevo.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module BrevoRuby
|
|
16
|
+
class ExternalFeedsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
|
+
def setUserAgent(user_agent)
|
|
26
|
+
@user_agent = user_agent
|
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
|
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Create an external feed
|
|
33
|
+
# This endpoint will create an external feed.
|
|
34
|
+
# @param create_external_feed Values to create a feed
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [InlineResponse2014]
|
|
37
|
+
def create_external_feed(create_external_feed, opts = {})
|
|
38
|
+
data, _status_code, _headers = create_external_feed_with_http_info(create_external_feed, opts)
|
|
39
|
+
data
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Create an external feed
|
|
43
|
+
# This endpoint will create an external feed.
|
|
44
|
+
# @param create_external_feed Values to create a feed
|
|
45
|
+
# @param [Hash] opts the optional parameters
|
|
46
|
+
# @return [Array<(InlineResponse2014, Fixnum, Hash)>] InlineResponse2014 data, response status code and response headers
|
|
47
|
+
def create_external_feed_with_http_info(create_external_feed, opts = {})
|
|
48
|
+
if @api_client.config.debugging
|
|
49
|
+
@api_client.config.logger.debug 'Calling API: ExternalFeedsApi.create_external_feed ...'
|
|
50
|
+
end
|
|
51
|
+
# verify the required parameter 'create_external_feed' is set
|
|
52
|
+
if @api_client.config.client_side_validation && create_external_feed.nil?
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'create_external_feed' when calling ExternalFeedsApi.create_external_feed"
|
|
54
|
+
end
|
|
55
|
+
# resource path
|
|
56
|
+
local_var_path = '/feeds'
|
|
57
|
+
|
|
58
|
+
# query parameters
|
|
59
|
+
query_params = {}
|
|
60
|
+
|
|
61
|
+
# header parameters
|
|
62
|
+
header_params = {}
|
|
63
|
+
# HTTP header 'Accept' (if needed)
|
|
64
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
65
|
+
# HTTP header 'Content-Type'
|
|
66
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
67
|
+
|
|
68
|
+
# form parameters
|
|
69
|
+
form_params = {}
|
|
70
|
+
|
|
71
|
+
# http body (model)
|
|
72
|
+
post_body = @api_client.object_to_http_body(create_external_feed)
|
|
73
|
+
auth_names = ['api-key', 'partner-key']
|
|
74
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => 'InlineResponse2014')
|
|
81
|
+
if @api_client.config.debugging
|
|
82
|
+
@api_client.config.logger.debug "API called: ExternalFeedsApi#create_external_feed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
83
|
+
end
|
|
84
|
+
return data, status_code, headers
|
|
85
|
+
end
|
|
86
|
+
# Delete an external feed
|
|
87
|
+
# This endpoint will delete an external feed.
|
|
88
|
+
# @param uuid UUID of the feed to delete
|
|
89
|
+
# @param [Hash] opts the optional parameters
|
|
90
|
+
# @return [nil]
|
|
91
|
+
def delete_external_feed(uuid, opts = {})
|
|
92
|
+
delete_external_feed_with_http_info(uuid, opts)
|
|
93
|
+
nil
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Delete an external feed
|
|
97
|
+
# This endpoint will delete an external feed.
|
|
98
|
+
# @param uuid UUID of the feed to delete
|
|
99
|
+
# @param [Hash] opts the optional parameters
|
|
100
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
101
|
+
def delete_external_feed_with_http_info(uuid, opts = {})
|
|
102
|
+
if @api_client.config.debugging
|
|
103
|
+
@api_client.config.logger.debug 'Calling API: ExternalFeedsApi.delete_external_feed ...'
|
|
104
|
+
end
|
|
105
|
+
# verify the required parameter 'uuid' is set
|
|
106
|
+
if @api_client.config.client_side_validation && uuid.nil?
|
|
107
|
+
fail ArgumentError, "Missing the required parameter 'uuid' when calling ExternalFeedsApi.delete_external_feed"
|
|
108
|
+
end
|
|
109
|
+
# resource path
|
|
110
|
+
local_var_path = '/feeds/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)
|
|
111
|
+
|
|
112
|
+
# query parameters
|
|
113
|
+
query_params = {}
|
|
114
|
+
|
|
115
|
+
# header parameters
|
|
116
|
+
header_params = {}
|
|
117
|
+
# HTTP header 'Accept' (if needed)
|
|
118
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
119
|
+
# HTTP header 'Content-Type'
|
|
120
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
121
|
+
|
|
122
|
+
# form parameters
|
|
123
|
+
form_params = {}
|
|
124
|
+
|
|
125
|
+
# http body (model)
|
|
126
|
+
post_body = nil
|
|
127
|
+
auth_names = ['api-key', 'partner-key']
|
|
128
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
129
|
+
:header_params => header_params,
|
|
130
|
+
:query_params => query_params,
|
|
131
|
+
:form_params => form_params,
|
|
132
|
+
:body => post_body,
|
|
133
|
+
:auth_names => auth_names)
|
|
134
|
+
if @api_client.config.debugging
|
|
135
|
+
@api_client.config.logger.debug "API called: ExternalFeedsApi#delete_external_feed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
136
|
+
end
|
|
137
|
+
return data, status_code, headers
|
|
138
|
+
end
|
|
139
|
+
# Fetch all external feeds
|
|
140
|
+
# This endpoint can fetch all created external feeds.
|
|
141
|
+
# @param [Hash] opts the optional parameters
|
|
142
|
+
# @option opts [String] :search Can be used to filter records by search keyword on feed name
|
|
143
|
+
# @option opts [Date] :start_date Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
|
|
144
|
+
# @option opts [Date] :end_date Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
145
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (default to desc)
|
|
146
|
+
# @option opts [String] :auth_type Filter the records by `authType` of the feed.
|
|
147
|
+
# @option opts [Integer] :limit Number of documents returned per page. (default to 50)
|
|
148
|
+
# @option opts [Integer] :offset Index of the first document on the page. (default to 0)
|
|
149
|
+
# @return [GetAllExternalFeeds]
|
|
150
|
+
def get_all_external_feeds(opts = {})
|
|
151
|
+
data, _status_code, _headers = get_all_external_feeds_with_http_info(opts)
|
|
152
|
+
data
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Fetch all external feeds
|
|
156
|
+
# This endpoint can fetch all created external feeds.
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @option opts [String] :search Can be used to filter records by search keyword on feed name
|
|
159
|
+
# @option opts [Date] :start_date Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
|
|
160
|
+
# @option opts [Date] :end_date Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
161
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
|
|
162
|
+
# @option opts [String] :auth_type Filter the records by `authType` of the feed.
|
|
163
|
+
# @option opts [Integer] :limit Number of documents returned per page.
|
|
164
|
+
# @option opts [Integer] :offset Index of the first document on the page.
|
|
165
|
+
# @return [Array<(GetAllExternalFeeds, Fixnum, Hash)>] GetAllExternalFeeds data, response status code and response headers
|
|
166
|
+
def get_all_external_feeds_with_http_info(opts = {})
|
|
167
|
+
if @api_client.config.debugging
|
|
168
|
+
@api_client.config.logger.debug 'Calling API: ExternalFeedsApi.get_all_external_feeds ...'
|
|
169
|
+
end
|
|
170
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
|
171
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
|
172
|
+
end
|
|
173
|
+
if @api_client.config.client_side_validation && opts[:'auth_type'] && !['basic', 'token', 'noAuth'].include?(opts[:'auth_type'])
|
|
174
|
+
fail ArgumentError, 'invalid value for "auth_type", must be one of basic, token, noAuth'
|
|
175
|
+
end
|
|
176
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
|
|
177
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ExternalFeedsApi.get_all_external_feeds, must be smaller than or equal to 500.'
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
|
|
181
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ExternalFeedsApi.get_all_external_feeds, must be greater than or equal to 0.'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# resource path
|
|
185
|
+
local_var_path = '/feeds'
|
|
186
|
+
|
|
187
|
+
# query parameters
|
|
188
|
+
query_params = {}
|
|
189
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
190
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
191
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
192
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
193
|
+
query_params[:'authType'] = opts[:'auth_type'] if !opts[:'auth_type'].nil?
|
|
194
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
195
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
196
|
+
|
|
197
|
+
# header parameters
|
|
198
|
+
header_params = {}
|
|
199
|
+
# HTTP header 'Accept' (if needed)
|
|
200
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
201
|
+
# HTTP header 'Content-Type'
|
|
202
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
203
|
+
|
|
204
|
+
# form parameters
|
|
205
|
+
form_params = {}
|
|
206
|
+
|
|
207
|
+
# http body (model)
|
|
208
|
+
post_body = nil
|
|
209
|
+
auth_names = ['api-key', 'partner-key']
|
|
210
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
211
|
+
:header_params => header_params,
|
|
212
|
+
:query_params => query_params,
|
|
213
|
+
:form_params => form_params,
|
|
214
|
+
:body => post_body,
|
|
215
|
+
:auth_names => auth_names,
|
|
216
|
+
:return_type => 'GetAllExternalFeeds')
|
|
217
|
+
if @api_client.config.debugging
|
|
218
|
+
@api_client.config.logger.debug "API called: ExternalFeedsApi#get_all_external_feeds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
219
|
+
end
|
|
220
|
+
return data, status_code, headers
|
|
221
|
+
end
|
|
222
|
+
# Get an external feed by UUID
|
|
223
|
+
# This endpoint will update an external feed.
|
|
224
|
+
# @param uuid UUID of the feed to fetch
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @return [GetExternalFeedByUUID]
|
|
227
|
+
def get_external_feed_by_uuid(uuid, opts = {})
|
|
228
|
+
data, _status_code, _headers = get_external_feed_by_uuid_with_http_info(uuid, opts)
|
|
229
|
+
data
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
# Get an external feed by UUID
|
|
233
|
+
# This endpoint will update an external feed.
|
|
234
|
+
# @param uuid UUID of the feed to fetch
|
|
235
|
+
# @param [Hash] opts the optional parameters
|
|
236
|
+
# @return [Array<(GetExternalFeedByUUID, Fixnum, Hash)>] GetExternalFeedByUUID data, response status code and response headers
|
|
237
|
+
def get_external_feed_by_uuid_with_http_info(uuid, opts = {})
|
|
238
|
+
if @api_client.config.debugging
|
|
239
|
+
@api_client.config.logger.debug 'Calling API: ExternalFeedsApi.get_external_feed_by_uuid ...'
|
|
240
|
+
end
|
|
241
|
+
# verify the required parameter 'uuid' is set
|
|
242
|
+
if @api_client.config.client_side_validation && uuid.nil?
|
|
243
|
+
fail ArgumentError, "Missing the required parameter 'uuid' when calling ExternalFeedsApi.get_external_feed_by_uuid"
|
|
244
|
+
end
|
|
245
|
+
# resource path
|
|
246
|
+
local_var_path = '/feeds/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)
|
|
247
|
+
|
|
248
|
+
# query parameters
|
|
249
|
+
query_params = {}
|
|
250
|
+
|
|
251
|
+
# header parameters
|
|
252
|
+
header_params = {}
|
|
253
|
+
# HTTP header 'Accept' (if needed)
|
|
254
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
255
|
+
# HTTP header 'Content-Type'
|
|
256
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
257
|
+
|
|
258
|
+
# form parameters
|
|
259
|
+
form_params = {}
|
|
260
|
+
|
|
261
|
+
# http body (model)
|
|
262
|
+
post_body = nil
|
|
263
|
+
auth_names = ['api-key', 'partner-key']
|
|
264
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
265
|
+
:header_params => header_params,
|
|
266
|
+
:query_params => query_params,
|
|
267
|
+
:form_params => form_params,
|
|
268
|
+
:body => post_body,
|
|
269
|
+
:auth_names => auth_names,
|
|
270
|
+
:return_type => 'GetExternalFeedByUUID')
|
|
271
|
+
if @api_client.config.debugging
|
|
272
|
+
@api_client.config.logger.debug "API called: ExternalFeedsApi#get_external_feed_by_uuid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
273
|
+
end
|
|
274
|
+
return data, status_code, headers
|
|
275
|
+
end
|
|
276
|
+
# Update an external feed
|
|
277
|
+
# This endpoint will update an external feed.
|
|
278
|
+
# @param uuid UUID of the feed to update
|
|
279
|
+
# @param update_external_feed Values to update a feed
|
|
280
|
+
# @param [Hash] opts the optional parameters
|
|
281
|
+
# @return [nil]
|
|
282
|
+
def update_external_feed(uuid, update_external_feed, opts = {})
|
|
283
|
+
update_external_feed_with_http_info(uuid, update_external_feed, opts)
|
|
284
|
+
nil
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
# Update an external feed
|
|
288
|
+
# This endpoint will update an external feed.
|
|
289
|
+
# @param uuid UUID of the feed to update
|
|
290
|
+
# @param update_external_feed Values to update a feed
|
|
291
|
+
# @param [Hash] opts the optional parameters
|
|
292
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
293
|
+
def update_external_feed_with_http_info(uuid, update_external_feed, opts = {})
|
|
294
|
+
if @api_client.config.debugging
|
|
295
|
+
@api_client.config.logger.debug 'Calling API: ExternalFeedsApi.update_external_feed ...'
|
|
296
|
+
end
|
|
297
|
+
# verify the required parameter 'uuid' is set
|
|
298
|
+
if @api_client.config.client_side_validation && uuid.nil?
|
|
299
|
+
fail ArgumentError, "Missing the required parameter 'uuid' when calling ExternalFeedsApi.update_external_feed"
|
|
300
|
+
end
|
|
301
|
+
# verify the required parameter 'update_external_feed' is set
|
|
302
|
+
if @api_client.config.client_side_validation && update_external_feed.nil?
|
|
303
|
+
fail ArgumentError, "Missing the required parameter 'update_external_feed' when calling ExternalFeedsApi.update_external_feed"
|
|
304
|
+
end
|
|
305
|
+
# resource path
|
|
306
|
+
local_var_path = '/feeds/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)
|
|
307
|
+
|
|
308
|
+
# query parameters
|
|
309
|
+
query_params = {}
|
|
310
|
+
|
|
311
|
+
# header parameters
|
|
312
|
+
header_params = {}
|
|
313
|
+
# HTTP header 'Accept' (if needed)
|
|
314
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
315
|
+
# HTTP header 'Content-Type'
|
|
316
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
317
|
+
|
|
318
|
+
# form parameters
|
|
319
|
+
form_params = {}
|
|
320
|
+
|
|
321
|
+
# http body (model)
|
|
322
|
+
post_body = @api_client.object_to_http_body(update_external_feed)
|
|
323
|
+
auth_names = ['api-key', 'partner-key']
|
|
324
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
325
|
+
:header_params => header_params,
|
|
326
|
+
:query_params => query_params,
|
|
327
|
+
:form_params => form_params,
|
|
328
|
+
:body => post_body,
|
|
329
|
+
:auth_names => auth_names)
|
|
330
|
+
if @api_client.config.debugging
|
|
331
|
+
@api_client.config.logger.debug "API called: ExternalFeedsApi#update_external_feed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
332
|
+
end
|
|
333
|
+
return data, status_code, headers
|
|
334
|
+
end
|
|
335
|
+
end
|
|
336
|
+
end
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/getbrevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.0.0
|
|
7
|
+
Contact: contact@brevo.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module BrevoRuby
|
|
16
|
+
class FilesApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
|
+
def setUserAgent(user_agent)
|
|
26
|
+
@user_agent = user_agent
|
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
|
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get all files
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @option opts [String] :entity Filter by file entity type
|
|
35
|
+
# @option opts [String] :entity_ids Filter by file entity IDs
|
|
36
|
+
# @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
|
|
37
|
+
# @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
|
|
38
|
+
# @option opts [Integer] :offset Index of the first document of the page
|
|
39
|
+
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
|
40
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
|
41
|
+
# @return [FileList]
|
|
42
|
+
def crm_files_get(opts = {})
|
|
43
|
+
data, _status_code, _headers = crm_files_get_with_http_info(opts)
|
|
44
|
+
data
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Get all files
|
|
48
|
+
# @param [Hash] opts the optional parameters
|
|
49
|
+
# @option opts [String] :entity Filter by file entity type
|
|
50
|
+
# @option opts [String] :entity_ids Filter by file entity IDs
|
|
51
|
+
# @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
|
|
52
|
+
# @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
|
|
53
|
+
# @option opts [Integer] :offset Index of the first document of the page
|
|
54
|
+
# @option opts [Integer] :limit Number of documents per page
|
|
55
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
|
56
|
+
# @return [Array<(FileList, Fixnum, Hash)>] FileList data, response status code and response headers
|
|
57
|
+
def crm_files_get_with_http_info(opts = {})
|
|
58
|
+
if @api_client.config.debugging
|
|
59
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.crm_files_get ...'
|
|
60
|
+
end
|
|
61
|
+
if @api_client.config.client_side_validation && opts[:'entity'] && !['companies', 'deals', 'contacts'].include?(opts[:'entity'])
|
|
62
|
+
fail ArgumentError, 'invalid value for "entity", must be one of companies, deals, contacts'
|
|
63
|
+
end
|
|
64
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
|
65
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
|
66
|
+
end
|
|
67
|
+
# resource path
|
|
68
|
+
local_var_path = '/crm/files'
|
|
69
|
+
|
|
70
|
+
# query parameters
|
|
71
|
+
query_params = {}
|
|
72
|
+
query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?
|
|
73
|
+
query_params[:'entityIds'] = opts[:'entity_ids'] if !opts[:'entity_ids'].nil?
|
|
74
|
+
query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
|
|
75
|
+
query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
|
|
76
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
77
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
78
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
79
|
+
|
|
80
|
+
# header parameters
|
|
81
|
+
header_params = {}
|
|
82
|
+
# HTTP header 'Accept' (if needed)
|
|
83
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
84
|
+
# HTTP header 'Content-Type'
|
|
85
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
86
|
+
|
|
87
|
+
# form parameters
|
|
88
|
+
form_params = {}
|
|
89
|
+
|
|
90
|
+
# http body (model)
|
|
91
|
+
post_body = nil
|
|
92
|
+
auth_names = ['api-key', 'partner-key']
|
|
93
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
94
|
+
:header_params => header_params,
|
|
95
|
+
:query_params => query_params,
|
|
96
|
+
:form_params => form_params,
|
|
97
|
+
:body => post_body,
|
|
98
|
+
:auth_names => auth_names,
|
|
99
|
+
:return_type => 'FileList')
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug "API called: FilesApi#crm_files_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
102
|
+
end
|
|
103
|
+
return data, status_code, headers
|
|
104
|
+
end
|
|
105
|
+
# Get file details
|
|
106
|
+
# @param id File id to get file data.
|
|
107
|
+
# @param [Hash] opts the optional parameters
|
|
108
|
+
# @return [FileData]
|
|
109
|
+
def crm_files_id_data_get(id, opts = {})
|
|
110
|
+
data, _status_code, _headers = crm_files_id_data_get_with_http_info(id, opts)
|
|
111
|
+
data
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Get file details
|
|
115
|
+
# @param id File id to get file data.
|
|
116
|
+
# @param [Hash] opts the optional parameters
|
|
117
|
+
# @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
|
|
118
|
+
def crm_files_id_data_get_with_http_info(id, opts = {})
|
|
119
|
+
if @api_client.config.debugging
|
|
120
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_data_get ...'
|
|
121
|
+
end
|
|
122
|
+
# verify the required parameter 'id' is set
|
|
123
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
124
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.crm_files_id_data_get"
|
|
125
|
+
end
|
|
126
|
+
# resource path
|
|
127
|
+
local_var_path = '/crm/files/{id}/data'.sub('{' + 'id' + '}', id.to_s)
|
|
128
|
+
|
|
129
|
+
# query parameters
|
|
130
|
+
query_params = {}
|
|
131
|
+
|
|
132
|
+
# header parameters
|
|
133
|
+
header_params = {}
|
|
134
|
+
# HTTP header 'Accept' (if needed)
|
|
135
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
136
|
+
# HTTP header 'Content-Type'
|
|
137
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
138
|
+
|
|
139
|
+
# form parameters
|
|
140
|
+
form_params = {}
|
|
141
|
+
|
|
142
|
+
# http body (model)
|
|
143
|
+
post_body = nil
|
|
144
|
+
auth_names = ['api-key', 'partner-key']
|
|
145
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
146
|
+
:header_params => header_params,
|
|
147
|
+
:query_params => query_params,
|
|
148
|
+
:form_params => form_params,
|
|
149
|
+
:body => post_body,
|
|
150
|
+
:auth_names => auth_names,
|
|
151
|
+
:return_type => 'FileData')
|
|
152
|
+
if @api_client.config.debugging
|
|
153
|
+
@api_client.config.logger.debug "API called: FilesApi#crm_files_id_data_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
+
end
|
|
155
|
+
return data, status_code, headers
|
|
156
|
+
end
|
|
157
|
+
# Delete a file
|
|
158
|
+
# @param id File id to delete.
|
|
159
|
+
# @param [Hash] opts the optional parameters
|
|
160
|
+
# @return [nil]
|
|
161
|
+
def crm_files_id_delete(id, opts = {})
|
|
162
|
+
crm_files_id_delete_with_http_info(id, opts)
|
|
163
|
+
nil
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Delete a file
|
|
167
|
+
# @param id File id to delete.
|
|
168
|
+
# @param [Hash] opts the optional parameters
|
|
169
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
170
|
+
def crm_files_id_delete_with_http_info(id, opts = {})
|
|
171
|
+
if @api_client.config.debugging
|
|
172
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_delete ...'
|
|
173
|
+
end
|
|
174
|
+
# verify the required parameter 'id' is set
|
|
175
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
176
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.crm_files_id_delete"
|
|
177
|
+
end
|
|
178
|
+
# resource path
|
|
179
|
+
local_var_path = '/crm/files/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
180
|
+
|
|
181
|
+
# query parameters
|
|
182
|
+
query_params = {}
|
|
183
|
+
|
|
184
|
+
# header parameters
|
|
185
|
+
header_params = {}
|
|
186
|
+
# HTTP header 'Accept' (if needed)
|
|
187
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
188
|
+
# HTTP header 'Content-Type'
|
|
189
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
190
|
+
|
|
191
|
+
# form parameters
|
|
192
|
+
form_params = {}
|
|
193
|
+
|
|
194
|
+
# http body (model)
|
|
195
|
+
post_body = nil
|
|
196
|
+
auth_names = ['api-key', 'partner-key']
|
|
197
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
198
|
+
:header_params => header_params,
|
|
199
|
+
:query_params => query_params,
|
|
200
|
+
:form_params => form_params,
|
|
201
|
+
:body => post_body,
|
|
202
|
+
:auth_names => auth_names)
|
|
203
|
+
if @api_client.config.debugging
|
|
204
|
+
@api_client.config.logger.debug "API called: FilesApi#crm_files_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
205
|
+
end
|
|
206
|
+
return data, status_code, headers
|
|
207
|
+
end
|
|
208
|
+
# Download a file
|
|
209
|
+
# @param id File id to download.
|
|
210
|
+
# @param [Hash] opts the optional parameters
|
|
211
|
+
# @return [FileDownloadableLink]
|
|
212
|
+
def crm_files_id_get(id, opts = {})
|
|
213
|
+
data, _status_code, _headers = crm_files_id_get_with_http_info(id, opts)
|
|
214
|
+
data
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Download a file
|
|
218
|
+
# @param id File id to download.
|
|
219
|
+
# @param [Hash] opts the optional parameters
|
|
220
|
+
# @return [Array<(FileDownloadableLink, Fixnum, Hash)>] FileDownloadableLink data, response status code and response headers
|
|
221
|
+
def crm_files_id_get_with_http_info(id, opts = {})
|
|
222
|
+
if @api_client.config.debugging
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_get ...'
|
|
224
|
+
end
|
|
225
|
+
# verify the required parameter 'id' is set
|
|
226
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
227
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.crm_files_id_get"
|
|
228
|
+
end
|
|
229
|
+
# resource path
|
|
230
|
+
local_var_path = '/crm/files/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
231
|
+
|
|
232
|
+
# query parameters
|
|
233
|
+
query_params = {}
|
|
234
|
+
|
|
235
|
+
# header parameters
|
|
236
|
+
header_params = {}
|
|
237
|
+
# HTTP header 'Accept' (if needed)
|
|
238
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
239
|
+
# HTTP header 'Content-Type'
|
|
240
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = nil
|
|
247
|
+
auth_names = ['api-key', 'partner-key']
|
|
248
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
249
|
+
:header_params => header_params,
|
|
250
|
+
:query_params => query_params,
|
|
251
|
+
:form_params => form_params,
|
|
252
|
+
:body => post_body,
|
|
253
|
+
:auth_names => auth_names,
|
|
254
|
+
:return_type => 'FileDownloadableLink')
|
|
255
|
+
if @api_client.config.debugging
|
|
256
|
+
@api_client.config.logger.debug "API called: FilesApi#crm_files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
257
|
+
end
|
|
258
|
+
return data, status_code, headers
|
|
259
|
+
end
|
|
260
|
+
# Upload a file
|
|
261
|
+
# @param file File data to create a file.
|
|
262
|
+
# @param [Hash] opts the optional parameters
|
|
263
|
+
# @option opts [String] :deal_id Deal id linked to a file
|
|
264
|
+
# @option opts [Integer] :contact_id Contact id linked to a file
|
|
265
|
+
# @option opts [String] :company_id Company id linked to a file
|
|
266
|
+
# @return [FileData]
|
|
267
|
+
def crm_files_post(file, opts = {})
|
|
268
|
+
data, _status_code, _headers = crm_files_post_with_http_info(file, opts)
|
|
269
|
+
data
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
# Upload a file
|
|
273
|
+
# @param file File data to create a file.
|
|
274
|
+
# @param [Hash] opts the optional parameters
|
|
275
|
+
# @option opts [String] :deal_id Deal id linked to a file
|
|
276
|
+
# @option opts [Integer] :contact_id Contact id linked to a file
|
|
277
|
+
# @option opts [String] :company_id Company id linked to a file
|
|
278
|
+
# @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
|
|
279
|
+
def crm_files_post_with_http_info(file, opts = {})
|
|
280
|
+
if @api_client.config.debugging
|
|
281
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.crm_files_post ...'
|
|
282
|
+
end
|
|
283
|
+
# verify the required parameter 'file' is set
|
|
284
|
+
if @api_client.config.client_side_validation && file.nil?
|
|
285
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling FilesApi.crm_files_post"
|
|
286
|
+
end
|
|
287
|
+
# resource path
|
|
288
|
+
local_var_path = '/crm/files'
|
|
289
|
+
|
|
290
|
+
# query parameters
|
|
291
|
+
query_params = {}
|
|
292
|
+
|
|
293
|
+
# header parameters
|
|
294
|
+
header_params = {}
|
|
295
|
+
# HTTP header 'Accept' (if needed)
|
|
296
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
297
|
+
# HTTP header 'Content-Type'
|
|
298
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
299
|
+
|
|
300
|
+
# form parameters
|
|
301
|
+
form_params = {}
|
|
302
|
+
form_params['file'] = file
|
|
303
|
+
form_params['dealId'] = opts[:'deal_id'] if !opts[:'deal_id'].nil?
|
|
304
|
+
form_params['contactId'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
|
|
305
|
+
form_params['companyId'] = opts[:'company_id'] if !opts[:'company_id'].nil?
|
|
306
|
+
|
|
307
|
+
# http body (model)
|
|
308
|
+
post_body = nil
|
|
309
|
+
auth_names = ['api-key', 'partner-key']
|
|
310
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
311
|
+
:header_params => header_params,
|
|
312
|
+
:query_params => query_params,
|
|
313
|
+
:form_params => form_params,
|
|
314
|
+
:body => post_body,
|
|
315
|
+
:auth_names => auth_names,
|
|
316
|
+
:return_type => 'FileData')
|
|
317
|
+
if @api_client.config.debugging
|
|
318
|
+
@api_client.config.logger.debug "API called: FilesApi#crm_files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
319
|
+
end
|
|
320
|
+
return data, status_code, headers
|
|
321
|
+
end
|
|
322
|
+
end
|
|
323
|
+
end
|