sib-api-v3-sdk 5.2.5 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +100 -75
- 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 +3 -3
- data/docs/AddContactToList.md +2 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +136 -73
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +4 -1
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +17 -17
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +3 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +158 -91
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SendEmail.md +3 -3
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +2 -2
- data/docs/SendersApi.md +8 -8
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +4 -1
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UpdateWebhook.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +20 -3
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +62 -73
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +17 -26
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +53 -54
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- 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 +3 -4
- data/spec/models/add_contact_to_list_spec.rb +9 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +20 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- 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 +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- 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 +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +10 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +4 -33
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +10 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +11 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +78 -10
data/docs/CreateAttribute.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7
|
-
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{
|
7
|
+
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
|
8
8
|
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
|
9
9
|
|
10
10
|
|
data/docs/CreateChild.md
CHANGED
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
8
8
|
**last_name** | **String** | Last name to use to create the child account |
|
9
9
|
**company_name** | **String** | Company name to use to create the child account |
|
10
10
|
**password** | **String** | Password for the child account to login |
|
11
|
+
**language** | **String** | Language of the child account | [optional]
|
11
12
|
|
12
13
|
|
data/docs/CreateContact.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**email** | **String** | Email address of the user. Mandatory if \"
|
7
|
-
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {
|
6
|
+
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::CreateDoiContact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. |
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
|
8
|
+
**include_list_ids** | **Array<Integer>** | Lists under user account where contact should be added |
|
9
|
+
**exclude_list_ids** | **Array<Integer>** | Lists under user account where contact should not be added | [optional]
|
10
|
+
**template_id** | **Integer** | Id of the Double opt-in (DOI) template |
|
11
|
+
**redirection_url** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. |
|
12
|
+
|
13
|
+
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**footer** | **String** | Footer of the email campaign | [optional]
|
21
21
|
**header** | **String** | Header of the email campaign | [optional]
|
22
22
|
**utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
23
|
-
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {
|
23
|
+
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
24
24
|
**send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
|
25
25
|
**ab_testing** | **BOOLEAN** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
|
26
26
|
**subject_a** | **String** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
@@ -28,5 +28,8 @@ Name | Type | Description | Notes
|
|
28
28
|
**split_rule** | **Integer** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
|
29
29
|
**winner_criteria** | **String** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
|
30
30
|
**winner_delay** | **Integer** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
|
31
|
+
**ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
|
32
|
+
**initial_quota** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
|
33
|
+
**increase_rate** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
31
34
|
|
32
35
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Sender Name | [optional]
|
7
7
|
**email** | **String** | Sender email |
|
8
|
+
**id** | **Integer** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
|
8
9
|
|
9
10
|
|
data/docs/CreateReseller.md
CHANGED
data/docs/CreateSender.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | From Name to use for the sender |
|
7
|
-
**email** | **String** | From
|
7
|
+
**email** | **String** | From email to use for the sender. A verification email will be sent to this address. |
|
8
8
|
**ips** | [**Array<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional]
|
9
9
|
|
10
10
|
|
data/docs/CreateSmsCampaign.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the campaign |
|
7
|
-
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
|
7
|
+
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
8
8
|
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
10
|
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
|
7
7
|
**email** | **String** | Email of the sender |
|
8
|
+
**id** | **Integer** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
|
8
9
|
|
9
10
|
|
data/docs/CreateWebhook.md
CHANGED
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook |
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
8
|
-
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – request
|
9
|
-
**type** | **String** | Type of the webhook | [optional] [default to
|
8
|
+
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` |
|
9
|
+
**type** | **String** | Type of the webhook | [optional] [default to 'transactional']
|
10
10
|
|
11
11
|
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -6,14 +6,17 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
8
8
|
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
9
|
-
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
9
|
+
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
10
|
+
[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
11
|
+
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
12
|
+
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
13
|
+
[**get_shared_template_url**](EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
14
|
+
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
15
|
+
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
14
16
|
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
15
|
-
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update
|
16
|
-
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update
|
17
|
+
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
18
|
+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
19
|
+
[**upload_image_to_gallery**](EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
17
20
|
|
18
21
|
|
19
22
|
# **create_email_campaign**
|
@@ -132,7 +135,7 @@ nil (empty response body)
|
|
132
135
|
# **email_export_recipients**
|
133
136
|
> CreatedProcessId email_export_recipients(campaign_id, opts)
|
134
137
|
|
135
|
-
Export the recipients of
|
138
|
+
Export the recipients of an email campaign
|
136
139
|
|
137
140
|
### Example
|
138
141
|
```ruby
|
@@ -160,7 +163,7 @@ opts = {
|
|
160
163
|
}
|
161
164
|
|
162
165
|
begin
|
163
|
-
#Export the recipients of
|
166
|
+
#Export the recipients of an email campaign
|
164
167
|
result = api_instance.email_export_recipients(campaign_id, opts)
|
165
168
|
p result
|
166
169
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -190,10 +193,69 @@ Name | Type | Description | Notes
|
|
190
193
|
|
191
194
|
|
192
195
|
|
196
|
+
# **get_ab_test_campaign_result**
|
197
|
+
> AbTestCampaignResult get_ab_test_campaign_result(campaign_id)
|
198
|
+
|
199
|
+
Get an A/B test email campaign results
|
200
|
+
|
201
|
+
Obtain winning version of an A/B test email campaign
|
202
|
+
|
203
|
+
### Example
|
204
|
+
```ruby
|
205
|
+
# load the gem
|
206
|
+
require 'sib-api-v3-sdk'
|
207
|
+
# setup authorization
|
208
|
+
SibApiV3Sdk.configure do |config|
|
209
|
+
# Configure API key authorization: api-key
|
210
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
211
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
212
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
213
|
+
|
214
|
+
# Configure API key authorization: partner-key
|
215
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
217
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
218
|
+
end
|
219
|
+
|
220
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
221
|
+
|
222
|
+
campaign_id = 789 # Integer | Id of the A/B test campaign
|
223
|
+
|
224
|
+
|
225
|
+
begin
|
226
|
+
#Get an A/B test email campaign results
|
227
|
+
result = api_instance.get_ab_test_campaign_result(campaign_id)
|
228
|
+
p result
|
229
|
+
rescue SibApiV3Sdk::ApiError => e
|
230
|
+
puts "Exception when calling EmailCampaignsApi->get_ab_test_campaign_result: #{e}"
|
231
|
+
end
|
232
|
+
```
|
233
|
+
|
234
|
+
### Parameters
|
235
|
+
|
236
|
+
Name | Type | Description | Notes
|
237
|
+
------------- | ------------- | ------------- | -------------
|
238
|
+
**campaign_id** | **Integer**| Id of the A/B test campaign |
|
239
|
+
|
240
|
+
### Return type
|
241
|
+
|
242
|
+
[**AbTestCampaignResult**](AbTestCampaignResult.md)
|
243
|
+
|
244
|
+
### Authorization
|
245
|
+
|
246
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
247
|
+
|
248
|
+
### HTTP request headers
|
249
|
+
|
250
|
+
- **Content-Type**: application/json
|
251
|
+
- **Accept**: application/json
|
252
|
+
|
253
|
+
|
254
|
+
|
193
255
|
# **get_email_campaign**
|
194
256
|
> GetEmailCampaign get_email_campaign(campaign_id)
|
195
257
|
|
196
|
-
Get campaign
|
258
|
+
Get an email campaign report
|
197
259
|
|
198
260
|
### Example
|
199
261
|
```ruby
|
@@ -218,7 +280,7 @@ campaign_id = 789 # Integer | Id of the campaign
|
|
218
280
|
|
219
281
|
|
220
282
|
begin
|
221
|
-
#Get campaign
|
283
|
+
#Get an email campaign report
|
222
284
|
result = api_instance.get_email_campaign(campaign_id)
|
223
285
|
p result
|
224
286
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -250,7 +312,7 @@ Name | Type | Description | Notes
|
|
250
312
|
# **get_email_campaigns**
|
251
313
|
> GetEmailCampaigns get_email_campaigns(opts)
|
252
314
|
|
253
|
-
Return all your created campaigns
|
315
|
+
Return all your created email campaigns
|
254
316
|
|
255
317
|
### Example
|
256
318
|
```ruby
|
@@ -272,16 +334,16 @@ end
|
|
272
334
|
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
273
335
|
|
274
336
|
opts = {
|
275
|
-
type:
|
276
|
-
status:
|
277
|
-
start_date: DateTime.parse(
|
278
|
-
end_date: DateTime.parse(
|
337
|
+
type: 'type_example', # String | Filter on the type of the campaigns
|
338
|
+
status: 'status_example', # String | Filter on the status of the campaign
|
339
|
+
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
340
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
279
341
|
limit: 500, # Integer | Number of documents per page
|
280
342
|
offset: 0 # Integer | Index of the first document in the page
|
281
343
|
}
|
282
344
|
|
283
345
|
begin
|
284
|
-
#Return all your created campaigns
|
346
|
+
#Return all your created email campaigns
|
285
347
|
result = api_instance.get_email_campaigns(opts)
|
286
348
|
p result
|
287
349
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -315,10 +377,69 @@ Name | Type | Description | Notes
|
|
315
377
|
|
316
378
|
|
317
379
|
|
380
|
+
# **get_shared_template_url**
|
381
|
+
> GetSharedTemplateUrl get_shared_template_url(campaign_id)
|
382
|
+
|
383
|
+
Get a shared template url
|
384
|
+
|
385
|
+
Get a unique URL to share & import an email template from one Sendinblue account to another.
|
386
|
+
|
387
|
+
### Example
|
388
|
+
```ruby
|
389
|
+
# load the gem
|
390
|
+
require 'sib-api-v3-sdk'
|
391
|
+
# setup authorization
|
392
|
+
SibApiV3Sdk.configure do |config|
|
393
|
+
# Configure API key authorization: api-key
|
394
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
395
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
396
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
397
|
+
|
398
|
+
# Configure API key authorization: partner-key
|
399
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
400
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
401
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
402
|
+
end
|
403
|
+
|
404
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
405
|
+
|
406
|
+
campaign_id = 789 # Integer | Id of the campaign or template
|
407
|
+
|
408
|
+
|
409
|
+
begin
|
410
|
+
#Get a shared template url
|
411
|
+
result = api_instance.get_shared_template_url(campaign_id)
|
412
|
+
p result
|
413
|
+
rescue SibApiV3Sdk::ApiError => e
|
414
|
+
puts "Exception when calling EmailCampaignsApi->get_shared_template_url: #{e}"
|
415
|
+
end
|
416
|
+
```
|
417
|
+
|
418
|
+
### Parameters
|
419
|
+
|
420
|
+
Name | Type | Description | Notes
|
421
|
+
------------- | ------------- | ------------- | -------------
|
422
|
+
**campaign_id** | **Integer**| Id of the campaign or template |
|
423
|
+
|
424
|
+
### Return type
|
425
|
+
|
426
|
+
[**GetSharedTemplateUrl**](GetSharedTemplateUrl.md)
|
427
|
+
|
428
|
+
### Authorization
|
429
|
+
|
430
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
431
|
+
|
432
|
+
### HTTP request headers
|
433
|
+
|
434
|
+
- **Content-Type**: application/json
|
435
|
+
- **Accept**: application/json
|
436
|
+
|
437
|
+
|
438
|
+
|
318
439
|
# **send_email_campaign_now**
|
319
440
|
> send_email_campaign_now(campaign_id)
|
320
441
|
|
321
|
-
Send an email campaign
|
442
|
+
Send an email campaign immediately, based on campaignId
|
322
443
|
|
323
444
|
### Example
|
324
445
|
```ruby
|
@@ -343,7 +464,7 @@ campaign_id = 789 # Integer | Id of the campaign
|
|
343
464
|
|
344
465
|
|
345
466
|
begin
|
346
|
-
#Send an email campaign
|
467
|
+
#Send an email campaign immediately, based on campaignId
|
347
468
|
api_instance.send_email_campaign_now(campaign_id)
|
348
469
|
rescue SibApiV3Sdk::ApiError => e
|
349
470
|
puts "Exception when calling EmailCampaignsApi->send_email_campaign_now: #{e}"
|
@@ -374,7 +495,7 @@ nil (empty response body)
|
|
374
495
|
# **send_report**
|
375
496
|
> send_report(campaign_id, send_report)
|
376
497
|
|
377
|
-
Send the report of a
|
498
|
+
Send the report of a campaign
|
378
499
|
|
379
500
|
A PDF will be sent to the specified email addresses
|
380
501
|
|
@@ -403,7 +524,7 @@ send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a repor
|
|
403
524
|
|
404
525
|
|
405
526
|
begin
|
406
|
-
#Send the report of a
|
527
|
+
#Send the report of a campaign
|
407
528
|
api_instance.send_report(campaign_id, send_report)
|
408
529
|
rescue SibApiV3Sdk::ApiError => e
|
409
530
|
puts "Exception when calling EmailCampaignsApi->send_report: #{e}"
|
@@ -494,7 +615,7 @@ nil (empty response body)
|
|
494
615
|
# **update_campaign_status**
|
495
616
|
> update_campaign_status(campaign_id, status)
|
496
617
|
|
497
|
-
Update
|
618
|
+
Update an email campaign status
|
498
619
|
|
499
620
|
### Example
|
500
621
|
```ruby
|
@@ -521,7 +642,7 @@ status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status o
|
|
521
642
|
|
522
643
|
|
523
644
|
begin
|
524
|
-
#Update
|
645
|
+
#Update an email campaign status
|
525
646
|
api_instance.update_campaign_status(campaign_id, status)
|
526
647
|
rescue SibApiV3Sdk::ApiError => e
|
527
648
|
puts "Exception when calling EmailCampaignsApi->update_campaign_status: #{e}"
|
@@ -553,7 +674,7 @@ nil (empty response body)
|
|
553
674
|
# **update_email_campaign**
|
554
675
|
> update_email_campaign(campaign_id, email_campaign)
|
555
676
|
|
556
|
-
Update
|
677
|
+
Update an email campaign
|
557
678
|
|
558
679
|
### Example
|
559
680
|
```ruby
|
@@ -580,7 +701,7 @@ email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Va
|
|
580
701
|
|
581
702
|
|
582
703
|
begin
|
583
|
-
#Update
|
704
|
+
#Update an email campaign
|
584
705
|
api_instance.update_email_campaign(campaign_id, email_campaign)
|
585
706
|
rescue SibApiV3Sdk::ApiError => e
|
586
707
|
puts "Exception when calling EmailCampaignsApi->update_email_campaign: #{e}"
|
@@ -609,3 +730,59 @@ nil (empty response body)
|
|
609
730
|
|
610
731
|
|
611
732
|
|
733
|
+
# **upload_image_to_gallery**
|
734
|
+
> upload_image_to_gallery(upload_image)
|
735
|
+
|
736
|
+
Upload an image to your account's image gallery
|
737
|
+
|
738
|
+
### Example
|
739
|
+
```ruby
|
740
|
+
# load the gem
|
741
|
+
require 'sib-api-v3-sdk'
|
742
|
+
# setup authorization
|
743
|
+
SibApiV3Sdk.configure do |config|
|
744
|
+
# Configure API key authorization: api-key
|
745
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
747
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
748
|
+
|
749
|
+
# Configure API key authorization: partner-key
|
750
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
752
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
753
|
+
end
|
754
|
+
|
755
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
756
|
+
|
757
|
+
upload_image = SibApiV3Sdk::UploadImageToGallery.new # UploadImageToGallery | Parameters to upload an image
|
758
|
+
|
759
|
+
|
760
|
+
begin
|
761
|
+
#Upload an image to your account's image gallery
|
762
|
+
api_instance.upload_image_to_gallery(upload_image)
|
763
|
+
rescue SibApiV3Sdk::ApiError => e
|
764
|
+
puts "Exception when calling EmailCampaignsApi->upload_image_to_gallery: #{e}"
|
765
|
+
end
|
766
|
+
```
|
767
|
+
|
768
|
+
### Parameters
|
769
|
+
|
770
|
+
Name | Type | Description | Notes
|
771
|
+
------------- | ------------- | ------------- | -------------
|
772
|
+
**upload_image** | [**UploadImageToGallery**](UploadImageToGallery.md)| Parameters to upload an image |
|
773
|
+
|
774
|
+
### Return type
|
775
|
+
|
776
|
+
nil (empty response body)
|
777
|
+
|
778
|
+
### Authorization
|
779
|
+
|
780
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
781
|
+
|
782
|
+
### HTTP request headers
|
783
|
+
|
784
|
+
- **Content-Type**: application/json
|
785
|
+
- **Accept**: application/json
|
786
|
+
|
787
|
+
|
788
|
+
|