Module: BrevoRuby

Defined in:
lib/brevo-ruby/version.rb,
lib/brevo-ruby.rb,
lib/brevo-ruby/api_error.rb,
lib/brevo-ruby/api_client.rb,
lib/brevo-ruby/models/otp.rb,
lib/brevo-ruby/models/body.rb,
lib/brevo-ruby/models/deal.rb,
lib/brevo-ruby/models/note.rb,
lib/brevo-ruby/models/task.rb,
lib/brevo-ruby/api/user_api.rb,
lib/brevo-ruby/models/order.rb,
lib/brevo-ruby/api/deals_api.rb,
lib/brevo-ruby/api/files_api.rb,
lib/brevo-ruby/api/notes_api.rb,
lib/brevo-ruby/api/tasks_api.rb,
lib/brevo-ruby/configuration.rb,
lib/brevo-ruby/models/body_1.rb,
lib/brevo-ruby/models/body_2.rb,
lib/brevo-ruby/models/body_3.rb,
lib/brevo-ruby/models/body_4.rb,
lib/brevo-ruby/models/body_5.rb,
lib/brevo-ruby/models/body_6.rb,
lib/brevo-ruby/models/body_7.rb,
lib/brevo-ruby/models/body_8.rb,
lib/brevo-ruby/models/body_9.rb,
lib/brevo-ruby/models/get_ip.rb,
lib/brevo-ruby/models/body_10.rb,
lib/brevo-ruby/models/body_11.rb,
lib/brevo-ruby/models/body_12.rb,
lib/brevo-ruby/models/company.rb,
lib/brevo-ruby/models/get_ips.rb,
lib/brevo-ruby/models/note_id.rb,
lib/brevo-ruby/api/account_api.rb,
lib/brevo-ruby/api/coupons_api.rb,
lib/brevo-ruby/api/domains_api.rb,
lib/brevo-ruby/api/process_api.rb,
lib/brevo-ruby/api/senders_api.rb,
lib/brevo-ruby/models/get_list.rb,
lib/brevo-ruby/models/pipeline.rb,
lib/brevo-ruby/models/send_sms.rb,
lib/brevo-ruby/api/contacts_api.rb,
lib/brevo-ruby/api/reseller_api.rb,
lib/brevo-ruby/api/webhooks_api.rb,
lib/brevo-ruby/models/file_data.rb,
lib/brevo-ruby/models/file_list.rb,
lib/brevo-ruby/models/get_lists.rb,
lib/brevo-ruby/models/manage_ip.rb,
lib/brevo-ruby/models/note_data.rb,
lib/brevo-ruby/models/note_list.rb,
lib/brevo-ruby/models/pipelines.rb,
lib/brevo-ruby/models/task_list.rb,
lib/brevo-ruby/api/companies_api.rb,
lib/brevo-ruby/api/ecommerce_api.rb,
lib/brevo-ruby/models/deals_list.rb,
lib/brevo-ruby/models/get_client.rb,
lib/brevo-ruby/models/get_folder.rb,
lib/brevo-ruby/models/task_types.rb,
lib/brevo-ruby/models/add_credits.rb,
lib/brevo-ruby/models/create_list.rb,
lib/brevo-ruby/models/error_model.rb,
lib/brevo-ruby/models/get_account.rb,
lib/brevo-ruby/models/get_folders.rb,
lib/brevo-ruby/models/get_process.rb,
lib/brevo-ruby/models/get_reports.rb,
lib/brevo-ruby/models/get_webhook.rb,
lib/brevo-ruby/models/order_batch.rb,
lib/brevo-ruby/models/send_report.rb,
lib/brevo-ruby/models/update_list.rb,
lib/brevo-ruby/models/block_domain.rb,
lib/brevo-ruby/models/create_child.rb,
lib/brevo-ruby/models/create_model.rb,
lib/brevo-ruby/models/get_contacts.rb,
lib/brevo-ruby/models/get_products.rb,
lib/brevo-ruby/models/get_segments.rb,
lib/brevo-ruby/models/get_webhooks.rb,
lib/brevo-ruby/models/update_child.rb,
lib/brevo-ruby/models/create_domain.rb,
lib/brevo-ruby/models/create_sender.rb,
lib/brevo-ruby/models/get_processes.rb,
lib/brevo-ruby/models/get_sso_token.rb,
lib/brevo-ruby/models/order_billing.rb,
lib/brevo-ruby/models/send_test_sms.rb,
lib/brevo-ruby/models/task_reminder.rb,
lib/brevo-ruby/models/update_sender.rb,
lib/brevo-ruby/api/conversations_api.rb,
lib/brevo-ruby/api/sms_campaigns_api.rb,
lib/brevo-ruby/models/companies_list.rb,
lib/brevo-ruby/models/create_contact.rb,
lib/brevo-ruby/models/create_coupons.rb,
lib/brevo-ruby/models/create_webhook.rb,
lib/brevo-ruby/models/get_attributes.rb,
lib/brevo-ruby/models/get_categories.rb,
lib/brevo-ruby/models/get_child_info.rb,
lib/brevo-ruby/models/order_products.rb,
lib/brevo-ruby/models/pipeline_stage.rb,
lib/brevo-ruby/models/remove_credits.rb,
lib/brevo-ruby/models/update_contact.rb,
lib/brevo-ruby/models/update_webhook.rb,
lib/brevo-ruby/api/external_feeds_api.rb,
lib/brevo-ruby/api/master_account_api.rb,
lib/brevo-ruby/models/component_items.rb,
lib/brevo-ruby/models/create_reseller.rb,
lib/brevo-ruby/models/deal_attributes.rb,
lib/brevo-ruby/models/send_smtp_email.rb,
lib/brevo-ruby/models/send_test_email.rb,
lib/brevo-ruby/models/variables_items.rb,
lib/brevo-ruby/api/email_campaigns_api.rb,
lib/brevo-ruby/api/inbound_parsing_api.rb,
lib/brevo-ruby/models/add_child_domain.rb,
lib/brevo-ruby/models/create_attribute.rb,
lib/brevo-ruby/models/created_batch_id.rb,
lib/brevo-ruby/models/get_account_plan.rb,
lib/brevo-ruby/models/get_child_domain.rb,
lib/brevo-ruby/models/get_domains_list.rb,
lib/brevo-ruby/models/get_folder_lists.rb,
lib/brevo-ruby/models/get_senders_list.rb,
lib/brevo-ruby/models/get_sms_campaign.rb,
lib/brevo-ruby/models/get_wa_templates.rb,
lib/brevo-ruby/models/post_send_failed.rb,
lib/brevo-ruby/models/send_transac_sms.rb,
lib/brevo-ruby/models/update_attribute.rb,
lib/brevo-ruby/models/create_sender_ips.rb,
lib/brevo-ruby/models/create_smtp_email.rb,
lib/brevo-ruby/models/get_account_relay.rb,
lib/brevo-ruby/models/get_child_domains.rb,
lib/brevo-ruby/models/get_children_list.rb,
lib/brevo-ruby/models/get_extended_list.rb,
lib/brevo-ruby/models/get_sms_campaigns.rb,
lib/brevo-ruby/models/post_contact_info.rb,
lib/brevo-ruby/models/send_report_email.rb,
lib/brevo-ruby/models/sso_token_request.rb,
lib/brevo-ruby/api/transactional_sms_api.rb,
lib/brevo-ruby/models/company_attributes.rb,
lib/brevo-ruby/models/create_doi_contact.rb,
lib/brevo-ruby/models/create_sub_account.rb,
lib/brevo-ruby/models/created_process_id.rb,
lib/brevo-ruby/models/delete_hardbounces.rb,
lib/brevo-ruby/models/get_campaign_stats.rb,
lib/brevo-ruby/models/get_email_campaign.rb,
lib/brevo-ruby/models/get_ip_from_sender.rb,
lib/brevo-ruby/models/get_smtp_templates.rb,
lib/brevo-ruby/models/send_smtp_email_cc.rb,
lib/brevo-ruby/models/send_smtp_email_to.rb,
lib/brevo-ruby/models/upload_image_model.rb,
lib/brevo-ruby/models/add_contact_to_list.rb,
lib/brevo-ruby/models/create_domain_model.rb,
lib/brevo-ruby/models/create_sender_model.rb,
lib/brevo-ruby/models/create_sms_campaign.rb,
lib/brevo-ruby/models/get_blocked_domains.rb,
lib/brevo-ruby/models/get_contact_details.rb,
lib/brevo-ruby/models/get_email_campaigns.rb,
lib/brevo-ruby/models/get_extended_client.rb,
lib/brevo-ruby/models/get_ips_from_sender.rb,
lib/brevo-ruby/models/get_product_details.rb,
lib/brevo-ruby/models/get_reports_reports.rb,
lib/brevo-ruby/models/get_stats_by_device.rb,
lib/brevo-ruby/models/get_stats_by_domain.rb,
lib/brevo-ruby/models/get_user_permission.rb,
lib/brevo-ruby/models/inline_response_200.rb,
lib/brevo-ruby/models/inline_response_201.rb,
lib/brevo-ruby/models/schedule_smtp_email.rb,
lib/brevo-ruby/models/send_smtp_email_bcc.rb,
lib/brevo-ruby/models/update_child_domain.rb,
lib/brevo-ruby/models/update_sms_campaign.rb,
lib/brevo-ruby/models/whatsapp_camp_stats.rb,
lib/brevo-ruby/api/whats_app_campaigns_api.rb,
lib/brevo-ruby/models/body_variables_items.rb,
lib/brevo-ruby/models/create_external_feed.rb,
lib/brevo-ruby/models/create_product_model.rb,
lib/brevo-ruby/models/create_smtp_template.rb,
lib/brevo-ruby/models/create_update_folder.rb,
lib/brevo-ruby/models/get_account_activity.rb,
lib/brevo-ruby/models/get_category_details.rb,
lib/brevo-ruby/models/get_senders_list_ips.rb,
lib/brevo-ruby/models/get_sms_event_report.rb,
lib/brevo-ruby/models/get_stats_by_browser.rb,
lib/brevo-ruby/models/get_whats_app_config.rb,
lib/brevo-ruby/models/send_smtp_email_to_1.rb,
lib/brevo-ruby/models/update_external_feed.rb,
lib/brevo-ruby/models/update_smtp_template.rb,
lib/brevo-ruby/api/transactional_emails_api.rb,
lib/brevo-ruby/models/ab_test_version_stats.rb,
lib/brevo-ruby/models/conversations_message.rb,
lib/brevo-ruby/models/create_category_model.rb,
lib/brevo-ruby/models/create_email_campaign.rb,
lib/brevo-ruby/models/create_update_product.rb,
lib/brevo-ruby/models/deal_attributes_inner.rb,
lib/brevo-ruby/models/get_aggregated_report.rb,
lib/brevo-ruby/models/get_campaign_overview.rb,
lib/brevo-ruby/models/get_coupon_collection.rb,
lib/brevo-ruby/models/get_segments_segments.rb,
lib/brevo-ruby/models/inline_response_200_1.rb,
lib/brevo-ruby/models/inline_response_201_1.rb,
lib/brevo-ruby/models/inline_response_201_2.rb,
lib/brevo-ruby/models/inline_response_201_3.rb,
lib/brevo-ruby/models/inline_response_201_4.rb,
lib/brevo-ruby/models/send_whatsapp_message.rb,
lib/brevo-ruby/models/sub_accounts_response.rb,
lib/brevo-ruby/models/update_batch_contacts.rb,
lib/brevo-ruby/models/update_email_campaign.rb,
lib/brevo-ruby/models/ab_test_version_clicks.rb,
lib/brevo-ruby/models/create_api_key_request.rb,
lib/brevo-ruby/models/create_update_category.rb,
lib/brevo-ruby/models/create_update_products.rb,
lib/brevo-ruby/models/file_downloadable_link.rb,
lib/brevo-ruby/models/get_account_relay_data.rb,
lib/brevo-ruby/models/get_all_external_feeds.rb,
lib/brevo-ruby/models/get_child_info_credits.rb,
lib/brevo-ruby/models/get_email_event_report.rb,
lib/brevo-ruby/models/get_invited_users_list.rb,
lib/brevo-ruby/models/get_sms_campaign_stats.rb,
lib/brevo-ruby/models/get_transac_sms_report.rb,
lib/brevo-ruby/models/get_whatsapp_campaigns.rb,
lib/brevo-ruby/models/remaining_credit_model.rb,
lib/brevo-ruby/models/request_contact_export.rb,
lib/brevo-ruby/models/request_contact_import.rb,
lib/brevo-ruby/models/send_smtp_email_sender.rb,
lib/brevo-ruby/models/update_campaign_status.rb,
lib/brevo-ruby/models/whatsapp_camp_template.rb,
lib/brevo-ruby/models/ab_test_campaign_result.rb,
lib/brevo-ruby/models/create_api_key_response.rb,
lib/brevo-ruby/models/email_export_recipients.rb,
lib/brevo-ruby/models/export_webhooks_history.rb,
lib/brevo-ruby/models/get_campaign_recipients.rb,
lib/brevo-ruby/models/get_child_info_api_keys.rb,
lib/brevo-ruby/models/get_shared_template_url.rb,
lib/brevo-ruby/models/get_transac_emails_list.rb,
lib/brevo-ruby/models/master_details_response.rb,
lib/brevo-ruby/models/upload_image_to_gallery.rb,
lib/brevo-ruby/api/transactional_whats_app_api.rb,
lib/brevo-ruby/models/company_attributes_inner.rb,
lib/brevo-ruby/models/create_coupon_collection.rb,
lib/brevo-ruby/models/create_update_categories.rb,
lib/brevo-ruby/models/get_device_browser_stats.rb,
lib/brevo-ruby/models/get_domains_list_domains.rb,
lib/brevo-ruby/models/get_inbound_email_events.rb,
lib/brevo-ruby/models/get_senders_list_senders.rb,
lib/brevo-ruby/models/remove_contact_from_list.rb,
lib/brevo-ruby/models/send_smtp_email_reply_to.rb,
lib/brevo-ruby/models/update_coupon_collection.rb,
lib/brevo-ruby/models/authenticate_domain_model.rb,
lib/brevo-ruby/models/create_whats_app_campaign.rb,
lib/brevo-ruby/models/create_whats_app_template.rb,
lib/brevo-ruby/models/get_account_activity_logs.rb,
lib/brevo-ruby/models/get_attributes_attributes.rb,
lib/brevo-ruby/models/get_child_info_statistics.rb,
lib/brevo-ruby/models/get_external_feed_by_uuid.rb,
lib/brevo-ruby/models/get_sms_campaign_overview.rb,
lib/brevo-ruby/models/get_transac_email_content.rb,
lib/brevo-ruby/models/get_whatsapp_event_report.rb,
lib/brevo-ruby/models/post_send_sms_test_failed.rb,
lib/brevo-ruby/models/update_whats_app_campaign.rb,
lib/brevo-ruby/models/conversations_message_file.rb,
lib/brevo-ruby/models/get_attributes_enumeration.rb,
lib/brevo-ruby/models/get_child_info_api_keys_v2.rb,
lib/brevo-ruby/models/get_child_info_api_keys_v3.rb,
lib/brevo-ruby/models/get_contact_campaign_stats.rb,
lib/brevo-ruby/models/get_smtp_template_overview.rb,
lib/brevo-ruby/models/get_wa_templates_templates.rb,
lib/brevo-ruby/models/post_contact_info_contacts.rb,
lib/brevo-ruby/models/send_smtp_email_attachment.rb,
lib/brevo-ruby/models/send_smtp_email_reply_to_1.rb,
lib/brevo-ruby/models/create_smtp_template_sender.rb,
lib/brevo-ruby/models/create_sub_account_response.rb,
lib/brevo-ruby/models/create_update_contact_model.rb,
lib/brevo-ruby/models/get_extended_campaign_stats.rb,
lib/brevo-ruby/models/get_extended_client_address.rb,
lib/brevo-ruby/models/get_sms_campaign_recipients.rb,
lib/brevo-ruby/models/get_sms_event_report_events.rb,
lib/brevo-ruby/models/update_batch_contacts_model.rb,
lib/brevo-ruby/models/update_child_account_status.rb,
lib/brevo-ruby/models/update_smtp_template_sender.rb,
lib/brevo-ruby/models/ab_test_version_clicks_inner.rb,
lib/brevo-ruby/models/create_attribute_enumeration.rb,
lib/brevo-ruby/models/create_email_campaign_sender.rb,
lib/brevo-ruby/models/create_update_batch_category.rb,
lib/brevo-ruby/models/create_update_batch_products.rb,
lib/brevo-ruby/models/get_all_external_feeds_feeds.rb,
lib/brevo-ruby/models/get_extended_contact_details.rb,
lib/brevo-ruby/models/get_invited_users_list_users.rb,
lib/brevo-ruby/models/get_transac_blocked_contacts.rb,
lib/brevo-ruby/models/remaining_credit_model_child.rb,
lib/brevo-ruby/models/request_sms_recipient_export.rb,
lib/brevo-ruby/models/sub_account_details_response.rb,
lib/brevo-ruby/models/update_attribute_enumeration.rb,
lib/brevo-ruby/models/update_email_campaign_sender.rb,
lib/brevo-ruby/models/get_email_event_report_events.rb,
lib/brevo-ruby/models/create_sms_campaign_recipients.rb,
lib/brevo-ruby/models/get_domain_configuration_model.rb,
lib/brevo-ruby/models/get_extended_campaign_overview.rb,
lib/brevo-ruby/models/get_transac_sms_report_reports.rb,
lib/brevo-ruby/models/get_user_permission_privileges.rb,
lib/brevo-ruby/models/get_whatsapp_campaign_overview.rb,
lib/brevo-ruby/models/update_batch_contacts_contacts.rb,
lib/brevo-ruby/models/create_domain_model_dns_records.rb,
lib/brevo-ruby/models/get_inbound_email_events_events.rb,
lib/brevo-ruby/models/get_scheduled_email_by_batch_id.rb,
lib/brevo-ruby/models/remaining_credit_model_reseller.rb,
lib/brevo-ruby/models/request_contact_import_new_list.rb,
lib/brevo-ruby/models/sub_account_update_plan_request.rb,
lib/brevo-ruby/models/create_email_campaign_recipients.rb,
lib/brevo-ruby/models/get_account_marketing_automation.rb,
lib/brevo-ruby/models/get_extended_list_campaign_stats.rb,
lib/brevo-ruby/models/get_inbound_email_events_by_uuid.rb,
lib/brevo-ruby/models/get_transac_email_content_events.rb,
lib/brevo-ruby/models/get_whatsapp_campaigns_campaigns.rb,
lib/brevo-ruby/models/get_whatsapp_event_report_events.rb,
lib/brevo-ruby/models/send_smtp_email_message_versions.rb,
lib/brevo-ruby/models/update_email_campaign_recipients.rb,
lib/brevo-ruby/models/get_child_account_creation_status.rb,
lib/brevo-ruby/models/get_contact_campaign_stats_opened.rb,
lib/brevo-ruby/models/get_external_feed_by_uuid_headers.rb,
lib/brevo-ruby/models/get_scheduled_email_by_message_id.rb,
lib/brevo-ruby/models/get_smtp_template_overview_sender.rb,
lib/brevo-ruby/models/get_transac_aggregated_sms_report.rb,
lib/brevo-ruby/models/master_details_response_plan_info.rb,
lib/brevo-ruby/models/ab_test_campaign_result_statistics.rb,
lib/brevo-ruby/models/create_update_batch_category_model.rb,
lib/brevo-ruby/models/create_update_batch_products_model.rb,
lib/brevo-ruby/models/get_contact_campaign_stats_clicked.rb,
lib/brevo-ruby/models/sub_accounts_response_sub_accounts.rb,
lib/brevo-ruby/models/get_transac_blocked_contacts_reason.rb,
lib/brevo-ruby/models/create_whats_app_campaign_recipients.rb,
lib/brevo-ruby/models/master_details_response_billing_info.rb,
lib/brevo-ruby/models/ab_test_campaign_result_clicked_links.rb,
lib/brevo-ruby/models/conversations_message_file_image_info.rb,
lib/brevo-ruby/models/get_extended_campaign_overview_sender.rb,
lib/brevo-ruby/models/get_inbound_email_events_by_uuid_logs.rb,
lib/brevo-ruby/models/get_invited_users_list_feature_access.rb,
lib/brevo-ruby/models/get_transac_blocked_contacts_contacts.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics.rb,
lib/brevo-ruby/models/get_scheduled_email_by_batch_id_batches.rb,
lib/brevo-ruby/models/sub_account_update_plan_request_credits.rb,
lib/brevo-ruby/models/get_extended_campaign_stats_global_stats.rb,
lib/brevo-ruby/models/sub_account_update_plan_request_features.rb,
lib/brevo-ruby/models/master_details_response_billing_info_name.rb,
lib/brevo-ruby/models/get_contact_campaign_stats_unsubscriptions.rb,
lib/brevo-ruby/models/master_details_response_plan_info_features.rb,
lib/brevo-ruby/models/create_domain_model_dns_records_dkim_record.rb,
lib/brevo-ruby/models/get_inbound_email_events_by_uuid_attachments.rb,
lib/brevo-ruby/models/get_transac_emails_list_transactional_emails.rb,
lib/brevo-ruby/models/master_details_response_billing_info_address.rb,
lib/brevo-ruby/models/request_contact_export_custom_contact_filter.rb,
lib/brevo-ruby/models/get_contact_campaign_stats_transac_attributes.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_links.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_opened.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_credits.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_clicked.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_features.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_delivered.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_messages_sent.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_credits_emails.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_features_inbox.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_features_users.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions.rb,
lib/brevo-ruby/models/sub_account_details_response_plan_info_features_landing_page.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb,
lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb

Overview

#Brevo API

#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 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 |

OpenAPI spec version: 3.0.0 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.19

Defined Under Namespace

Classes: AbTestCampaignResult, AbTestCampaignResultClickedLinks, AbTestCampaignResultStatistics, AbTestVersionClicks, AbTestVersionClicksInner, AbTestVersionStats, AccountApi, AddChildDomain, AddContactToList, AddCredits, ApiClient, ApiError, AuthenticateDomainModel, BlockDomain, Body, Body1, Body10, Body11, Body12, Body2, Body3, Body4, Body5, Body6, Body7, Body8, Body9, BodyVariablesItems, CompaniesApi, CompaniesList, Company, CompanyAttributes, CompanyAttributesInner, ComponentItems, Configuration, ContactsApi, ConversationsApi, ConversationsMessage, ConversationsMessageFile, ConversationsMessageFileImageInfo, CouponsApi, CreateApiKeyRequest, CreateApiKeyResponse, CreateAttribute, CreateAttributeEnumeration, CreateCategoryModel, CreateChild, CreateContact, CreateCouponCollection, CreateCoupons, CreateDoiContact, CreateDomain, CreateDomainModel, CreateDomainModelDnsRecords, CreateDomainModelDnsRecordsDkimRecord, CreateEmailCampaign, CreateEmailCampaignRecipients, CreateEmailCampaignSender, CreateExternalFeed, CreateList, CreateModel, CreateProductModel, CreateReseller, CreateSender, CreateSenderIps, CreateSenderModel, CreateSmsCampaign, CreateSmsCampaignRecipients, CreateSmtpEmail, CreateSmtpTemplate, CreateSmtpTemplateSender, CreateSubAccount, CreateSubAccountResponse, CreateUpdateBatchCategory, CreateUpdateBatchCategoryModel, CreateUpdateBatchProducts, CreateUpdateBatchProductsModel, CreateUpdateCategories, CreateUpdateCategory, CreateUpdateContactModel, CreateUpdateFolder, CreateUpdateProduct, CreateUpdateProducts, CreateWebhook, CreateWhatsAppCampaign, CreateWhatsAppCampaignRecipients, CreateWhatsAppTemplate, CreatedBatchId, CreatedProcessId, Deal, DealAttributes, DealAttributesInner, DealsApi, DealsList, DeleteHardbounces, DomainsApi, EcommerceApi, EmailCampaignsApi, EmailExportRecipients, ErrorModel, ExportWebhooksHistory, ExternalFeedsApi, FileData, FileDownloadableLink, FileList, FilesApi, GetAccount, GetAccountActivity, GetAccountActivityLogs, GetAccountMarketingAutomation, GetAccountPlan, GetAccountRelay, GetAccountRelayData, GetAggregatedReport, GetAllExternalFeeds, GetAllExternalFeedsFeeds, GetAttributes, GetAttributesAttributes, GetAttributesEnumeration, GetBlockedDomains, GetCampaignOverview, GetCampaignRecipients, GetCampaignStats, GetCategories, GetCategoryDetails, GetChildAccountCreationStatus, GetChildDomain, GetChildDomains, GetChildInfo, GetChildInfoApiKeys, GetChildInfoApiKeysV2, GetChildInfoApiKeysV3, GetChildInfoCredits, GetChildInfoStatistics, GetChildrenList, GetClient, GetContactCampaignStats, GetContactCampaignStatsClicked, GetContactCampaignStatsOpened, GetContactCampaignStatsTransacAttributes, GetContactCampaignStatsUnsubscriptions, GetContactDetails, GetContacts, GetCouponCollection, GetDeviceBrowserStats, GetDomainConfigurationModel, GetDomainsList, GetDomainsListDomains, GetEmailCampaign, GetEmailCampaigns, GetEmailEventReport, GetEmailEventReportEvents, GetExtendedCampaignOverview, GetExtendedCampaignOverviewSender, GetExtendedCampaignStats, GetExtendedCampaignStatsGlobalStats, GetExtendedClient, GetExtendedClientAddress, GetExtendedContactDetails, GetExtendedContactDetailsStatistics, GetExtendedContactDetailsStatisticsClicked, GetExtendedContactDetailsStatisticsDelivered, GetExtendedContactDetailsStatisticsLinks, GetExtendedContactDetailsStatisticsMessagesSent, GetExtendedContactDetailsStatisticsOpened, GetExtendedContactDetailsStatisticsUnsubscriptions, GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription, GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription, GetExtendedList, GetExtendedListCampaignStats, GetExternalFeedByUUID, GetExternalFeedByUUIDHeaders, GetFolder, GetFolderLists, GetFolders, GetInboundEmailEvents, GetInboundEmailEventsByUuid, GetInboundEmailEventsByUuidAttachments, GetInboundEmailEventsByUuidLogs, GetInboundEmailEventsEvents, GetInvitedUsersList, GetInvitedUsersListFeatureAccess, GetInvitedUsersListUsers, GetIp, GetIpFromSender, GetIps, GetIpsFromSender, GetList, GetLists, GetProcess, GetProcesses, GetProductDetails, GetProducts, GetReports, GetReportsReports, GetScheduledEmailByBatchId, GetScheduledEmailByBatchIdBatches, GetScheduledEmailByMessageId, GetSegments, GetSegmentsSegments, GetSendersList, GetSendersListIps, GetSendersListSenders, GetSharedTemplateUrl, GetSmsCampaign, GetSmsCampaignOverview, GetSmsCampaignRecipients, GetSmsCampaignStats, GetSmsCampaigns, GetSmsEventReport, GetSmsEventReportEvents, GetSmtpTemplateOverview, GetSmtpTemplateOverviewSender, GetSmtpTemplates, GetSsoToken, GetStatsByBrowser, GetStatsByDevice, GetStatsByDomain, GetTransacAggregatedSmsReport, GetTransacBlockedContacts, GetTransacBlockedContactsContacts, GetTransacBlockedContactsReason, GetTransacEmailContent, GetTransacEmailContentEvents, GetTransacEmailsList, GetTransacEmailsListTransactionalEmails, GetTransacSmsReport, GetTransacSmsReportReports, GetUserPermission, GetUserPermissionPrivileges, GetWATemplates, GetWATemplatesTemplates, GetWebhook, GetWebhooks, GetWhatsAppConfig, GetWhatsappCampaignOverview, GetWhatsappCampaigns, GetWhatsappCampaignsCampaigns, GetWhatsappEventReport, GetWhatsappEventReportEvents, InboundParsingApi, InlineResponse200, InlineResponse2001, InlineResponse201, InlineResponse2011, InlineResponse2012, InlineResponse2013, InlineResponse2014, ManageIp, MasterAccountApi, MasterDetailsResponse, MasterDetailsResponseBillingInfo, MasterDetailsResponseBillingInfoAddress, MasterDetailsResponseBillingInfoName, MasterDetailsResponsePlanInfo, MasterDetailsResponsePlanInfoFeatures, Note, NoteData, NoteId, NoteList, NotesApi, Order, OrderBatch, OrderBilling, OrderProducts, Otp, Pipeline, PipelineStage, Pipelines, PostContactInfo, PostContactInfoContacts, PostSendFailed, PostSendSmsTestFailed, ProcessApi, RemainingCreditModel, RemainingCreditModelChild, RemainingCreditModelReseller, RemoveContactFromList, RemoveCredits, RequestContactExport, RequestContactExportCustomContactFilter, RequestContactImport, RequestContactImportNewList, RequestSmsRecipientExport, ResellerApi, SMSCampaignsApi, ScheduleSmtpEmail, SendReport, SendReportEmail, SendSms, SendSmtpEmail, SendSmtpEmailAttachment, SendSmtpEmailBcc, SendSmtpEmailCc, SendSmtpEmailMessageVersions, SendSmtpEmailReplyTo, SendSmtpEmailReplyTo1, SendSmtpEmailSender, SendSmtpEmailTo, SendSmtpEmailTo1, SendTestEmail, SendTestSms, SendTransacSms, SendWhatsappMessage, SendersApi, SsoTokenRequest, SubAccountDetailsResponse, SubAccountDetailsResponsePlanInfo, SubAccountDetailsResponsePlanInfoCredits, SubAccountDetailsResponsePlanInfoCreditsEmails, SubAccountDetailsResponsePlanInfoFeatures, SubAccountDetailsResponsePlanInfoFeaturesInbox, SubAccountDetailsResponsePlanInfoFeaturesLandingPage, SubAccountDetailsResponsePlanInfoFeaturesUsers, SubAccountUpdatePlanRequest, SubAccountUpdatePlanRequestCredits, SubAccountUpdatePlanRequestFeatures, SubAccountsResponse, SubAccountsResponseSubAccounts, Task, TaskList, TaskReminder, TaskTypes, TasksApi, TransactionalEmailsApi, TransactionalSMSApi, TransactionalWhatsAppApi, UpdateAttribute, UpdateAttributeEnumeration, UpdateBatchContacts, UpdateBatchContactsContacts, UpdateBatchContactsModel, UpdateCampaignStatus, UpdateChild, UpdateChildAccountStatus, UpdateChildDomain, UpdateContact, UpdateCouponCollection, UpdateEmailCampaign, UpdateEmailCampaignRecipients, UpdateEmailCampaignSender, UpdateExternalFeed, UpdateList, UpdateSender, UpdateSmsCampaign, UpdateSmtpTemplate, UpdateSmtpTemplateSender, UpdateWebhook, UpdateWhatsAppCampaign, UploadImageModel, UploadImageToGallery, UserApi, VariablesItems, WebhooksApi, WhatsAppCampaignsApi, WhatsappCampStats, WhatsappCampTemplate

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

BrevoRuby.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



385
386
387
388
389
390
391
 
# File 'lib/brevo-ruby.rb', line 385

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end