sib-api-v3-sdk 5.5.0 → 7.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +44 -29
- data/docs/AbTestCampaignResult.md +2 -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/AddContactToList.md +2 -1
- data/docs/BlockDomain.md +8 -0
- data/docs/ContactsApi.md +45 -33
- data/docs/CreateDoiContact.md +1 -1
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +2 -2
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/CreateSmtpTemplateSender.md +1 -1
- data/docs/CreateWebhook.md +1 -1
- data/docs/EmailCampaignsApi.md +7 -5
- data/docs/FoldersApi.md +9 -3
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +1 -1
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildDomain.md +2 -2
- data/docs/GetChildrenList.md +1 -1
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactDetails.md +2 -2
- data/docs/GetEmailCampaign.md +8 -8
- data/docs/GetEmailCampaigns.md +1 -1
- data/docs/GetEmailEventReportEvents.md +2 -1
- data/docs/GetExtendedCampaignOverview.md +6 -6
- data/docs/GetExtendedCampaignStats.md +1 -1
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedContactDetails.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
- data/docs/GetExtendedList.md +1 -1
- data/docs/GetFolderLists.md +2 -2
- data/docs/GetLists.md +2 -2
- data/docs/GetProcesses.md +1 -1
- data/docs/GetSmsCampaign.md +5 -5
- data/docs/GetSmsCampaignOverview.md +3 -3
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaigns.md +1 -1
- data/docs/GetSmsEventReportEvents.md +4 -4
- data/docs/GetSmtpTemplateOverview.md +2 -2
- data/docs/GetTransacAggregatedSmsReport.md +10 -10
- data/docs/GetTransacBlockedContactsContacts.md +1 -1
- data/docs/GetTransacEmailContent.md +1 -1
- data/docs/GetTransacEmailContentEvents.md +1 -1
- data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
- data/docs/GetTransacSmsReportReports.md +10 -10
- data/docs/GetWebhook.md +2 -2
- data/docs/ListsApi.md +15 -9
- data/docs/ProcessApi.md +3 -1
- data/docs/RemoveContactFromList.md +2 -1
- data/docs/SMSCampaignsApi.md +7 -5
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +3 -2
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +3 -2
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTransacSms.md +1 -1
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +242 -60
- data/docs/TransactionalSMSApi.md +9 -5
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +2 -2
- data/docs/UpdateWebhook.md +1 -1
- data/lib/sib-api-v3-sdk.rb +22 -10
- data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +85 -45
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/lists_api.rb +35 -7
- data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +249 -55
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api_client.rb +6 -4
- data/lib/sib-api-v3-sdk/api_error.rb +1 -1
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +25 -6
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +176 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +206 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +20 -7
- data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/block_domain.rb +190 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +8 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +10 -9
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +4 -3
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -67
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +193 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -6
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -52
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +17 -4
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
- data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +9 -8
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +10 -9
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +4 -3
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
- data/lib/sib-api-v3-sdk/version.rb +2 -2
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +14 -9
- data/spec/api/email_campaigns_api_spec.rb +4 -3
- data/spec/api/folders_api_spec.rb +3 -1
- data/spec/api/lists_api_spec.rb +7 -4
- data/spec/api/process_api_spec.rb +2 -1
- data/spec/api/reseller_api_spec.rb +1 -1
- data/spec/api/senders_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +4 -3
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +47 -7
- data/spec/api/transactional_sms_api_spec.rb +3 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +13 -1
- 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 +1 -1
- data/spec/models/add_contact_to_list_spec.rb +7 -1
- data/spec/models/add_credits_spec.rb +1 -1
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +1 -1
- data/spec/models/create_doi_contact_spec.rb +1 -1
- data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_reseller_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +1 -1
- data/spec/models/create_smtp_email_spec.rb +7 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_update_contact_model_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +1 -1
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +1 -1
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +1 -1
- data/spec/models/get_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +7 -1
- data/spec/models/get_child_account_creation_status_spec.rb +1 -1
- data/spec/models/get_child_domain_spec.rb +1 -1
- data/spec/models/get_child_domains_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
- data/spec/models/get_child_info_credits_spec.rb +1 -1
- data/spec/models/get_child_info_spec.rb +1 -1
- data/spec/models/get_child_info_statistics_spec.rb +1 -1
- data/spec/models/get_children_list_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_device_browser_stats_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +1 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +8 -2
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +1 -1
- data/spec/models/get_folder_lists_spec.rb +1 -1
- data/spec/models/get_folder_spec.rb +1 -1
- data/spec/models/get_folders_spec.rb +1 -1
- data/spec/models/get_ip_from_sender_spec.rb +1 -1
- data/spec/models/get_ip_spec.rb +1 -1
- data/spec/models/get_ips_from_sender_spec.rb +1 -1
- data/spec/models/get_ips_spec.rb +1 -1
- data/spec/models/get_list_spec.rb +1 -1
- data/spec/models/get_lists_spec.rb +1 -1
- data/spec/models/get_process_spec.rb +1 -1
- data/spec/models/get_processes_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +1 -1
- data/spec/models/get_reports_spec.rb +1 -1
- data/spec/models/get_senders_list_ips_spec.rb +1 -1
- data/spec/models/get_senders_list_senders_spec.rb +1 -1
- data/spec/models/get_senders_list_spec.rb +1 -1
- data/spec/models/get_shared_template_url_spec.rb +1 -1
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +1 -1
- data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
- data/spec/models/get_sms_campaigns_spec.rb +1 -1
- data/spec/models/get_sms_event_report_events_spec.rb +1 -1
- data/spec/models/get_sms_event_report_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_spec.rb +1 -1
- data/spec/models/get_smtp_templates_spec.rb +1 -1
- data/spec/models/get_sso_token_spec.rb +1 -1
- data/spec/models/get_stats_by_browser_spec.rb +1 -1
- data/spec/models/get_stats_by_device_spec.rb +1 -1
- data/spec/models/get_stats_by_domain_spec.rb +1 -1
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
- data/spec/models/get_transac_email_content_events_spec.rb +1 -1
- data/spec/models/get_transac_email_content_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_spec.rb +1 -1
- data/spec/models/get_webhook_spec.rb +1 -1
- data/spec/models/get_webhooks_spec.rb +1 -1
- data/spec/models/manage_ip_spec.rb +1 -1
- data/spec/models/post_contact_info_contacts_spec.rb +1 -1
- data/spec/models/post_contact_info_spec.rb +1 -1
- data/spec/models/post_send_failed_spec.rb +1 -1
- data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
- data/spec/models/remaining_credit_model_child_spec.rb +1 -1
- data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
- data/spec/models/remaining_credit_model_spec.rb +1 -1
- data/spec/models/remove_contact_from_list_spec.rb +7 -1
- data/spec/models/remove_credits_spec.rb +1 -1
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
- data/spec/models/request_contact_export_spec.rb +1 -1
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +1 -1
- data/spec/models/request_sms_recipient_export_spec.rb +1 -1
- data/spec/models/send_email_attachment_spec.rb +1 -1
- data/spec/models/send_email_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -29
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +7 -1
- data/spec/models/send_smtp_email_spec.rb +7 -1
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_template_email_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +1 -1
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +1 -1
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_account_status_spec.rb +1 -1
- data/spec/models/update_child_domain_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +1 -1
- data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +1 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_webhook_spec.rb +1 -1
- data/spec/models/upload_image_to_gallery_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +58 -10
data/docs/GetProcesses.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional]
|
7
|
-
**count** | **Integer** | Number of processes available on your account |
|
7
|
+
**count** | **Integer** | Number of processes available on your account | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetSmsCampaign.md
CHANGED
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
|
-
**created_at** | **
|
13
|
-
**modified_at** | **
|
14
|
-
**recipients** | **
|
15
|
-
**statistics** | **
|
12
|
+
**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
|
+
**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
|
+
**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
15
|
+
**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
16
16
|
|
17
17
|
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
|
-
**created_at** | **
|
13
|
-
**modified_at** | **
|
12
|
+
**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
|
+
**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
14
|
|
15
15
|
|
data/docs/GetSmsCampaigns.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaigns** | **Array<Object>** | | [optional]
|
7
|
-
**count** | **Integer** | Number of SMS campaigns retrieved |
|
7
|
+
**count** | **Integer** | Number of SMS campaigns retrieved | [optional]
|
8
8
|
|
9
9
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**phone_number** | **String** | Phone number which has generated the event |
|
7
|
-
**date** | **
|
8
|
-
**message_id** | **String** | Message ID which generated the event |
|
9
|
-
**event** | **String** | Event which occurred |
|
6
|
+
**phone_number** | **String** | Phone number which has generated the event | [optional]
|
7
|
+
**date** | **String** | UTC date-time on which the event has been generated | [optional]
|
8
|
+
**message_id** | **String** | Message ID which generated the event | [optional]
|
9
|
+
**event** | **String** | Event which occurred | [optional]
|
10
10
|
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
11
11
|
**reply** | **String** | | [optional]
|
12
12
|
**tag** | **String** | Tag of the SMS which generated the event | [optional]
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
13
13
|
**to_field** | **String** | Customisation of the \"to\" field for the template |
|
14
14
|
**tag** | **String** | Tag of the template |
|
15
15
|
**html_content** | **String** | HTML content of the template |
|
16
|
-
**created_at** | **
|
17
|
-
**modified_at** | **
|
16
|
+
**created_at** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
17
|
+
**modified_at** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
18
18
|
**doi_template** | **BOOLEAN** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional]
|
19
19
|
|
20
20
|
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**range** | **String** | Time frame of the report |
|
7
|
-
**requests** | **Integer** | Number of requests for the timeframe |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the timeframe |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the timeframe |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the timeframe |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the timeframe |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the timeframe |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the timeframe |
|
6
|
+
**range** | **String** | Time frame of the report | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the timeframe | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the timeframe | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the timeframe | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the timeframe | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the timeframe | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the timeframe | [optional]
|
16
16
|
|
17
17
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**email** | **String** | Email address of the blocked or unsubscribed contact |
|
7
7
|
**sender_email** | **String** | Sender email address of the blocked or unsubscribed contact |
|
8
8
|
**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
|
9
|
-
**blocked_at** | **
|
9
|
+
**blocked_at** | **String** | Date when the contact was blocked or unsubscribed on |
|
10
10
|
|
11
11
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**email** | **String** | Email address to which transactional email has been sent |
|
7
7
|
**subject** | **String** | Subject of the sent email |
|
8
8
|
**template_id** | **Integer** | Id of the template | [optional]
|
9
|
-
**date** | **
|
9
|
+
**date** | **String** | Date on which transactional email was sent |
|
10
10
|
**events** | [**Array<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
|
11
11
|
**body** | **String** | Actual content of the transactional email that has been sent |
|
12
12
|
**attachment_count** | **Integer** | Count of the attachments that were sent in the email |
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the event that occurred on the sent email |
|
7
|
-
**time** | **
|
7
|
+
**time** | **String** | Time at which the event occurred |
|
8
8
|
|
9
9
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**template_id** | **Integer** | Id of the template | [optional]
|
9
9
|
**message_id** | **String** | Message Id of the sent email |
|
10
10
|
**uuid** | **String** | Unique id of the email sent to a particular contact |
|
11
|
-
**date** | **
|
11
|
+
**date** | **String** | Date on which transactional email was sent |
|
12
12
|
**from** | **String** | Email address of the sender from which the email was sent | [optional]
|
13
13
|
**tags** | **Array<String>** | Tags used for your email | [optional]
|
14
14
|
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**date** | **Date** | Date for which statistics are retrieved |
|
7
|
-
**requests** | **Integer** | Number of requests for the date |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the date |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the date |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the date |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the date |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the date |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the date |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the date |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the date |
|
6
|
+
**date** | **Date** | Date for which statistics are retrieved | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the date | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the date | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the date | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the date | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the date | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the date | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the date | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the date | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the date | [optional]
|
16
16
|
|
17
17
|
|
data/docs/GetWebhook.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**description** | **String** | Description of the webhook |
|
9
9
|
**events** | **Array<String>** | |
|
10
10
|
**type** | **String** | Type of webhook (marketing or transac) |
|
11
|
-
**created_at** | **
|
12
|
-
**modified_at** | **
|
11
|
+
**created_at** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
|
+
**modified_at** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
13
|
|
14
14
|
|
data/docs/ListsApi.md
CHANGED
@@ -41,7 +41,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
41
41
|
|
42
42
|
list_id = 789 # Integer | Id of the list
|
43
43
|
|
44
|
-
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
|
44
|
+
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
|
45
45
|
|
46
46
|
|
47
47
|
begin
|
@@ -58,7 +58,7 @@ end
|
|
58
58
|
Name | Type | Description | Notes
|
59
59
|
------------- | ------------- | ------------- | -------------
|
60
60
|
**list_id** | **Integer**| Id of the list |
|
61
|
-
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
|
61
|
+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
62
62
|
|
63
63
|
### Return type
|
64
64
|
|
@@ -215,9 +215,10 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
215
215
|
list_id = 789 # Integer | Id of the list
|
216
216
|
|
217
217
|
opts = {
|
218
|
-
modified_since:
|
218
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
219
219
|
limit: 50, # Integer | Number of documents per page
|
220
|
-
offset: 0 # Integer | Index of the first document of the page
|
220
|
+
offset: 0, # Integer | Index of the first document of the page
|
221
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
221
222
|
}
|
222
223
|
|
223
224
|
begin
|
@@ -234,9 +235,10 @@ end
|
|
234
235
|
Name | Type | Description | Notes
|
235
236
|
------------- | ------------- | ------------- | -------------
|
236
237
|
**list_id** | **Integer**| Id of the list |
|
237
|
-
**modified_since** | **
|
238
|
+
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
238
239
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
239
240
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
241
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
240
242
|
|
241
243
|
### Return type
|
242
244
|
|
@@ -281,7 +283,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
281
283
|
|
282
284
|
opts = {
|
283
285
|
limit: 10, # Integer | Number of documents per page
|
284
|
-
offset: 0 # Integer | Index of the first document of the page
|
286
|
+
offset: 0, # Integer | Index of the first document of the page
|
287
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
285
288
|
}
|
286
289
|
|
287
290
|
begin
|
@@ -300,6 +303,7 @@ Name | Type | Description | Notes
|
|
300
303
|
**folder_id** | **Integer**| Id of the folder |
|
301
304
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
302
305
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
306
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
303
307
|
|
304
308
|
### Return type
|
305
309
|
|
@@ -399,7 +403,8 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
399
403
|
|
400
404
|
opts = {
|
401
405
|
limit: 10, # Integer | Number of documents per page
|
402
|
-
offset: 0 # Integer | Index of the first document of the page
|
406
|
+
offset: 0, # Integer | Index of the first document of the page
|
407
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
403
408
|
}
|
404
409
|
|
405
410
|
begin
|
@@ -417,6 +422,7 @@ Name | Type | Description | Notes
|
|
417
422
|
------------- | ------------- | ------------- | -------------
|
418
423
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
419
424
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
425
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
420
426
|
|
421
427
|
### Return type
|
422
428
|
|
@@ -459,7 +465,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
459
465
|
|
460
466
|
list_id = 789 # Integer | Id of the list
|
461
467
|
|
462
|
-
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails
|
468
|
+
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
|
463
469
|
|
464
470
|
|
465
471
|
begin
|
@@ -476,7 +482,7 @@ end
|
|
476
482
|
Name | Type | Description | Notes
|
477
483
|
------------- | ------------- | ------------- | -------------
|
478
484
|
**list_id** | **Integer**| Id of the list |
|
479
|
-
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails
|
485
|
+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
480
486
|
|
481
487
|
### Return type
|
482
488
|
|
data/docs/ProcessApi.md
CHANGED
@@ -91,7 +91,8 @@ api_instance = SibApiV3Sdk::ProcessApi.new
|
|
91
91
|
|
92
92
|
opts = {
|
93
93
|
limit: 10, # Integer | Number limitation for the result returned
|
94
|
-
offset: 0 # Integer | Beginning point in the list to retrieve from.
|
94
|
+
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
95
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
95
96
|
}
|
96
97
|
|
97
98
|
begin
|
@@ -109,6 +110,7 @@ Name | Type | Description | Notes
|
|
109
110
|
------------- | ------------- | ------------- | -------------
|
110
111
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
|
111
112
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
113
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
112
114
|
|
113
115
|
### Return type
|
114
116
|
|
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional]
|
7
|
-
**
|
7
|
+
**ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
8
|
+
**all** | **BOOLEAN** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional]
|
8
9
|
|
9
10
|
|
data/docs/SMSCampaignsApi.md
CHANGED
@@ -212,10 +212,11 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
|
212
212
|
|
213
213
|
opts = {
|
214
214
|
status: 'status_example', # String | Status of campaign.
|
215
|
-
start_date:
|
216
|
-
end_date:
|
215
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
216
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
217
217
|
limit: 500, # Integer | Number limitation for the result returned
|
218
|
-
offset: 0 # Integer | Beginning point in the list to retrieve from.
|
218
|
+
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
219
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
219
220
|
}
|
220
221
|
|
221
222
|
begin
|
@@ -232,10 +233,11 @@ end
|
|
232
233
|
Name | Type | Description | Notes
|
233
234
|
------------- | ------------- | ------------- | -------------
|
234
235
|
**status** | **String**| Status of campaign. | [optional]
|
235
|
-
**start_date** | **
|
236
|
-
**end_date** | **
|
236
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' ) | [optional]
|
237
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' ) | [optional]
|
237
238
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
|
238
239
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
240
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
239
241
|
|
240
242
|
### Return type
|
241
243
|
|
data/docs/SendReportEmail.md
CHANGED
@@ -3,11 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**subject** | **String** | Subject of the email message |
|
7
6
|
**to** | **Array<String>** | Email addresses of the recipients |
|
8
|
-
**
|
9
|
-
**bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
|
10
|
-
**cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
|
11
|
-
**body** | **String** | Body of the email message |
|
7
|
+
**body** | **String** | Custom text message to be presented in the report email. |
|
12
8
|
|
13
9
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
|
7
|
-
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] |
|
7
|
+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
|
8
8
|
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9
9
|
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10
10
|
**html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
|
@@ -13,8 +13,9 @@ Name | Type | Description | Notes
|
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
14
|
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15
15
|
**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
|
16
|
-
**template_id** | **Integer** | Id of the template | [optional]
|
16
|
+
**template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional]
|
17
17
|
**params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
|
18
|
+
**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
|
18
19
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
19
20
|
|
20
21
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailMessageVersions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**to** | [**Array<SendSmtpEmailTo1>**](SendSmtpEmailTo1.md) | List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] |
|
7
|
+
**params** | **Hash<String, Object>** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
|
8
|
+
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9
|
+
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10
|
+
**reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional]
|
11
|
+
**subject** | **String** | Custom subject specific to message version | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailReplyTo1
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address in reply to |
|
7
|
+
**name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/SendSmtpEmailSender.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional]
|
7
|
-
**email** | **String** | Email of the sender from which the emails will be sent |
|
6
|
+
**name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional]
|
7
|
+
**email** | **String** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional]
|
8
|
+
**id** | **Integer** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional]
|
8
9
|
|
9
10
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailTo1
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address of the recipient |
|
7
|
+
**name** | **String** | Name of the recipient. **Maximum allowed characters are 70**. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/SendTransacSms.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**sender** | **String** | Name of the sender.
|
6
|
+
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
7
7
|
**recipient** | **String** | Mobile number to send SMS with the country code |
|
8
8
|
**content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
|
9
9
|
**type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
|
@@ -1,26 +1,87 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::TransactionalEmailsApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
8
|
-
[**
|
9
|
-
[**
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
18
|
-
[**
|
19
|
-
[**
|
20
|
-
[**
|
21
|
-
[**
|
22
|
-
[**
|
23
|
-
[**
|
7
|
+
[**block_new_domain**](TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
8
|
+
[**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
9
|
+
[**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
10
|
+
[**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
11
|
+
[**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
12
|
+
[**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
13
|
+
[**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
14
|
+
[**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
15
|
+
[**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
16
|
+
[**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
17
|
+
[**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
18
|
+
[**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
19
|
+
[**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
20
|
+
[**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
21
|
+
[**send_template**](TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
22
|
+
[**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
23
|
+
[**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
24
|
+
[**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
25
|
+
[**smtp_log_message_id_delete**](TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
26
|
+
[**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
27
|
+
|
28
|
+
|
29
|
+
# **block_new_domain**
|
30
|
+
> block_new_domain(block_domain)
|
31
|
+
|
32
|
+
Add a new domain to the list of blocked domains
|
33
|
+
|
34
|
+
Blocks a new domain in order to avoid messages being sent to the same
|
35
|
+
|
36
|
+
### Example
|
37
|
+
```ruby
|
38
|
+
# load the gem
|
39
|
+
require 'sib-api-v3-sdk'
|
40
|
+
# setup authorization
|
41
|
+
SibApiV3Sdk.configure do |config|
|
42
|
+
# Configure API key authorization: api-key
|
43
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
44
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
45
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
46
|
+
|
47
|
+
# Configure API key authorization: partner-key
|
48
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
49
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
50
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
51
|
+
end
|
52
|
+
|
53
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
54
|
+
|
55
|
+
block_domain = SibApiV3Sdk::BlockDomain.new # BlockDomain |
|
56
|
+
|
57
|
+
|
58
|
+
begin
|
59
|
+
#Add a new domain to the list of blocked domains
|
60
|
+
api_instance.block_new_domain(block_domain)
|
61
|
+
rescue SibApiV3Sdk::ApiError => e
|
62
|
+
puts "Exception when calling TransactionalEmailsApi->block_new_domain: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
Name | Type | Description | Notes
|
69
|
+
------------- | ------------- | ------------- | -------------
|
70
|
+
**block_domain** | [**BlockDomain**](BlockDomain.md)| |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
nil (empty response body)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
24
85
|
|
25
86
|
|
26
87
|
# **create_smtp_template**
|
@@ -45,7 +106,7 @@ SibApiV3Sdk.configure do |config|
|
|
45
106
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
46
107
|
end
|
47
108
|
|
48
|
-
api_instance = SibApiV3Sdk::
|
109
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
49
110
|
|
50
111
|
smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
|
51
112
|
|
@@ -55,7 +116,7 @@ begin
|
|
55
116
|
result = api_instance.create_smtp_template(smtp_template)
|
56
117
|
p result
|
57
118
|
rescue SibApiV3Sdk::ApiError => e
|
58
|
-
puts "Exception when calling
|
119
|
+
puts "Exception when calling TransactionalEmailsApi->create_smtp_template: #{e}"
|
59
120
|
end
|
60
121
|
```
|
61
122
|
|
@@ -80,6 +141,64 @@ Name | Type | Description | Notes
|
|
80
141
|
|
81
142
|
|
82
143
|
|
144
|
+
# **delete_blocked_domain**
|
145
|
+
> delete_blocked_domain(domain)
|
146
|
+
|
147
|
+
Unblock an existing domain from the list of blocked domains
|
148
|
+
|
149
|
+
Unblocks an existing domain from the list of blocked domains
|
150
|
+
|
151
|
+
### Example
|
152
|
+
```ruby
|
153
|
+
# load the gem
|
154
|
+
require 'sib-api-v3-sdk'
|
155
|
+
# setup authorization
|
156
|
+
SibApiV3Sdk.configure do |config|
|
157
|
+
# Configure API key authorization: api-key
|
158
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
159
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
160
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
161
|
+
|
162
|
+
# Configure API key authorization: partner-key
|
163
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
164
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
165
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
169
|
+
|
170
|
+
domain = 'domain_example' # String | The name of the domain to be deleted
|
171
|
+
|
172
|
+
|
173
|
+
begin
|
174
|
+
#Unblock an existing domain from the list of blocked domains
|
175
|
+
api_instance.delete_blocked_domain(domain)
|
176
|
+
rescue SibApiV3Sdk::ApiError => e
|
177
|
+
puts "Exception when calling TransactionalEmailsApi->delete_blocked_domain: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
### Parameters
|
182
|
+
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**domain** | **String**| The name of the domain to be deleted |
|
186
|
+
|
187
|
+
### Return type
|
188
|
+
|
189
|
+
nil (empty response body)
|
190
|
+
|
191
|
+
### Authorization
|
192
|
+
|
193
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
194
|
+
|
195
|
+
### HTTP request headers
|
196
|
+
|
197
|
+
- **Content-Type**: application/json
|
198
|
+
- **Accept**: application/json
|
199
|
+
|
200
|
+
|
201
|
+
|
83
202
|
# **delete_hardbounces**
|
84
203
|
> delete_hardbounces(opts)
|
85
204
|
|
@@ -104,7 +223,7 @@ SibApiV3Sdk.configure do |config|
|
|
104
223
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
105
224
|
end
|
106
225
|
|
107
|
-
api_instance = SibApiV3Sdk::
|
226
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
108
227
|
|
109
228
|
opts = {
|
110
229
|
delete_hardbounces: SibApiV3Sdk::DeleteHardbounces.new # DeleteHardbounces | values to delete hardbounces
|
@@ -114,7 +233,7 @@ begin
|
|
114
233
|
#Delete hardbounces
|
115
234
|
api_instance.delete_hardbounces(opts)
|
116
235
|
rescue SibApiV3Sdk::ApiError => e
|
117
|
-
puts "Exception when calling
|
236
|
+
puts "Exception when calling TransactionalEmailsApi->delete_hardbounces: #{e}"
|
118
237
|
end
|
119
238
|
```
|
120
239
|
|
@@ -161,7 +280,7 @@ SibApiV3Sdk.configure do |config|
|
|
161
280
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
162
281
|
end
|
163
282
|
|
164
|
-
api_instance = SibApiV3Sdk::
|
283
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
165
284
|
|
166
285
|
template_id = 789 # Integer | id of the template
|
167
286
|
|
@@ -170,7 +289,7 @@ begin
|
|
170
289
|
#Delete an inactive email template
|
171
290
|
api_instance.delete_smtp_template(template_id)
|
172
291
|
rescue SibApiV3Sdk::ApiError => e
|
173
|
-
puts "Exception when calling
|
292
|
+
puts "Exception when calling TransactionalEmailsApi->delete_smtp_template: #{e}"
|
174
293
|
end
|
175
294
|
```
|
176
295
|
|
@@ -217,12 +336,12 @@ SibApiV3Sdk.configure do |config|
|
|
217
336
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
218
337
|
end
|
219
338
|
|
220
|
-
api_instance = SibApiV3Sdk::
|
339
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
221
340
|
|
222
341
|
opts = {
|
223
342
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
224
343
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
225
|
-
days:
|
344
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
226
345
|
tag: 'tag_example' # String | Tag of the emails
|
227
346
|
}
|
228
347
|
|
@@ -231,7 +350,7 @@ begin
|
|
231
350
|
result = api_instance.get_aggregated_smtp_report(opts)
|
232
351
|
p result
|
233
352
|
rescue SibApiV3Sdk::ApiError => e
|
234
|
-
puts "Exception when calling
|
353
|
+
puts "Exception when calling TransactionalEmailsApi->get_aggregated_smtp_report: #{e}"
|
235
354
|
end
|
236
355
|
```
|
237
356
|
|
@@ -259,6 +378,59 @@ Name | Type | Description | Notes
|
|
259
378
|
|
260
379
|
|
261
380
|
|
381
|
+
# **get_blocked_domains**
|
382
|
+
> GetBlockedDomains get_blocked_domains
|
383
|
+
|
384
|
+
Get the list of blocked domains
|
385
|
+
|
386
|
+
Get the list of blocked domains
|
387
|
+
|
388
|
+
### Example
|
389
|
+
```ruby
|
390
|
+
# load the gem
|
391
|
+
require 'sib-api-v3-sdk'
|
392
|
+
# setup authorization
|
393
|
+
SibApiV3Sdk.configure do |config|
|
394
|
+
# Configure API key authorization: api-key
|
395
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
396
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
397
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
398
|
+
|
399
|
+
# Configure API key authorization: partner-key
|
400
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
401
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
402
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
403
|
+
end
|
404
|
+
|
405
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
406
|
+
|
407
|
+
begin
|
408
|
+
#Get the list of blocked domains
|
409
|
+
result = api_instance.get_blocked_domains
|
410
|
+
p result
|
411
|
+
rescue SibApiV3Sdk::ApiError => e
|
412
|
+
puts "Exception when calling TransactionalEmailsApi->get_blocked_domains: #{e}"
|
413
|
+
end
|
414
|
+
```
|
415
|
+
|
416
|
+
### Parameters
|
417
|
+
This endpoint does not need any parameter.
|
418
|
+
|
419
|
+
### Return type
|
420
|
+
|
421
|
+
[**GetBlockedDomains**](GetBlockedDomains.md)
|
422
|
+
|
423
|
+
### Authorization
|
424
|
+
|
425
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
426
|
+
|
427
|
+
### HTTP request headers
|
428
|
+
|
429
|
+
- **Content-Type**: application/json
|
430
|
+
- **Accept**: application/json
|
431
|
+
|
432
|
+
|
433
|
+
|
262
434
|
# **get_email_event_report**
|
263
435
|
> GetEmailEventReport get_email_event_report(opts)
|
264
436
|
|
@@ -281,19 +453,20 @@ SibApiV3Sdk.configure do |config|
|
|
281
453
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
282
454
|
end
|
283
455
|
|
284
|
-
api_instance = SibApiV3Sdk::
|
456
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
285
457
|
|
286
458
|
opts = {
|
287
459
|
limit: 50, # Integer | Number limitation for the result returned
|
288
460
|
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
289
461
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
290
462
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
291
|
-
days:
|
463
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
292
464
|
email: 'email_example', # String | Filter the report for a specific email addresses
|
293
465
|
event: 'event_example', # String | Filter the report for a specific event type
|
294
466
|
tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
|
295
467
|
message_id: 'message_id_example', # String | Filter on a specific message id
|
296
|
-
template_id: 789 # Integer | Filter on a specific template id
|
468
|
+
template_id: 789, # Integer | Filter on a specific template id
|
469
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
297
470
|
}
|
298
471
|
|
299
472
|
begin
|
@@ -301,7 +474,7 @@ begin
|
|
301
474
|
result = api_instance.get_email_event_report(opts)
|
302
475
|
p result
|
303
476
|
rescue SibApiV3Sdk::ApiError => e
|
304
|
-
puts "Exception when calling
|
477
|
+
puts "Exception when calling TransactionalEmailsApi->get_email_event_report: #{e}"
|
305
478
|
end
|
306
479
|
```
|
307
480
|
|
@@ -319,6 +492,7 @@ Name | Type | Description | Notes
|
|
319
492
|
**tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
|
320
493
|
**message_id** | **String**| Filter on a specific message id | [optional]
|
321
494
|
**template_id** | **Integer**| Filter on a specific template id | [optional]
|
495
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
322
496
|
|
323
497
|
### Return type
|
324
498
|
|
@@ -357,15 +531,16 @@ SibApiV3Sdk.configure do |config|
|
|
357
531
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
358
532
|
end
|
359
533
|
|
360
|
-
api_instance = SibApiV3Sdk::
|
534
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
361
535
|
|
362
536
|
opts = {
|
363
537
|
limit: 10, # Integer | Number of documents returned per page
|
364
538
|
offset: 0, # Integer | Index of the first document on the page
|
365
539
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
366
540
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
367
|
-
days:
|
368
|
-
tag: 'tag_example' # String | Tag of the emails
|
541
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
542
|
+
tag: 'tag_example', # String | Tag of the emails
|
543
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
369
544
|
}
|
370
545
|
|
371
546
|
begin
|
@@ -373,7 +548,7 @@ begin
|
|
373
548
|
result = api_instance.get_smtp_report(opts)
|
374
549
|
p result
|
375
550
|
rescue SibApiV3Sdk::ApiError => e
|
376
|
-
puts "Exception when calling
|
551
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_report: #{e}"
|
377
552
|
end
|
378
553
|
```
|
379
554
|
|
@@ -387,6 +562,7 @@ Name | Type | Description | Notes
|
|
387
562
|
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
|
388
563
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
389
564
|
**tag** | **String**| Tag of the emails | [optional]
|
565
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
390
566
|
|
391
567
|
### Return type
|
392
568
|
|
@@ -425,7 +601,7 @@ SibApiV3Sdk.configure do |config|
|
|
425
601
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
426
602
|
end
|
427
603
|
|
428
|
-
api_instance = SibApiV3Sdk::
|
604
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
429
605
|
|
430
606
|
template_id = 789 # Integer | id of the template
|
431
607
|
|
@@ -435,7 +611,7 @@ begin
|
|
435
611
|
result = api_instance.get_smtp_template(template_id)
|
436
612
|
p result
|
437
613
|
rescue SibApiV3Sdk::ApiError => e
|
438
|
-
puts "Exception when calling
|
614
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_template: #{e}"
|
439
615
|
end
|
440
616
|
```
|
441
617
|
|
@@ -482,12 +658,13 @@ SibApiV3Sdk.configure do |config|
|
|
482
658
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
483
659
|
end
|
484
660
|
|
485
|
-
api_instance = SibApiV3Sdk::
|
661
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
486
662
|
|
487
663
|
opts = {
|
488
664
|
template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
|
489
665
|
limit: 50, # Integer | Number of documents returned per page
|
490
|
-
offset: 0 # Integer | Index of the first document in the page
|
666
|
+
offset: 0, # Integer | Index of the first document in the page
|
667
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
491
668
|
}
|
492
669
|
|
493
670
|
begin
|
@@ -495,7 +672,7 @@ begin
|
|
495
672
|
result = api_instance.get_smtp_templates(opts)
|
496
673
|
p result
|
497
674
|
rescue SibApiV3Sdk::ApiError => e
|
498
|
-
puts "Exception when calling
|
675
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_templates: #{e}"
|
499
676
|
end
|
500
677
|
```
|
501
678
|
|
@@ -506,6 +683,7 @@ Name | Type | Description | Notes
|
|
506
683
|
**template_status** | **BOOLEAN**| Filter on the status of the template. Active = true, inactive = false | [optional]
|
507
684
|
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
508
685
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
686
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
509
687
|
|
510
688
|
### Return type
|
511
689
|
|
@@ -544,14 +722,15 @@ SibApiV3Sdk.configure do |config|
|
|
544
722
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
545
723
|
end
|
546
724
|
|
547
|
-
api_instance = SibApiV3Sdk::
|
725
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
548
726
|
|
549
727
|
opts = {
|
550
728
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
551
729
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
552
730
|
limit: 50, # Integer | Number of documents returned per page
|
553
731
|
offset: 0, # Integer | Index of the first document on the page
|
554
|
-
senders: ['senders_example'] # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
732
|
+
senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
733
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
555
734
|
}
|
556
735
|
|
557
736
|
begin
|
@@ -559,7 +738,7 @@ begin
|
|
559
738
|
result = api_instance.get_transac_blocked_contacts(opts)
|
560
739
|
p result
|
561
740
|
rescue SibApiV3Sdk::ApiError => e
|
562
|
-
puts "Exception when calling
|
741
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_blocked_contacts: #{e}"
|
563
742
|
end
|
564
743
|
```
|
565
744
|
|
@@ -572,6 +751,7 @@ Name | Type | Description | Notes
|
|
572
751
|
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
573
752
|
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
574
753
|
**senders** | [**Array<String>**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
|
754
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
575
755
|
|
576
756
|
### Return type
|
577
757
|
|
@@ -610,7 +790,7 @@ SibApiV3Sdk.configure do |config|
|
|
610
790
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
611
791
|
end
|
612
792
|
|
613
|
-
api_instance = SibApiV3Sdk::
|
793
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
614
794
|
|
615
795
|
uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
|
616
796
|
|
@@ -620,7 +800,7 @@ begin
|
|
620
800
|
result = api_instance.get_transac_email_content(uuid)
|
621
801
|
p result
|
622
802
|
rescue SibApiV3Sdk::ApiError => e
|
623
|
-
puts "Exception when calling
|
803
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_email_content: #{e}"
|
624
804
|
end
|
625
805
|
```
|
626
806
|
|
@@ -669,14 +849,15 @@ SibApiV3Sdk.configure do |config|
|
|
669
849
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
670
850
|
end
|
671
851
|
|
672
|
-
api_instance = SibApiV3Sdk::
|
852
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
673
853
|
|
674
854
|
opts = {
|
675
855
|
email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
676
856
|
template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
677
857
|
message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
678
858
|
start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
679
|
-
end_date: Date.parse('2013-10-20') # 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.
|
859
|
+
end_date: Date.parse('2013-10-20'), # 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.
|
860
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
680
861
|
}
|
681
862
|
|
682
863
|
begin
|
@@ -684,7 +865,7 @@ begin
|
|
684
865
|
result = api_instance.get_transac_emails_list(opts)
|
685
866
|
p result
|
686
867
|
rescue SibApiV3Sdk::ApiError => e
|
687
|
-
puts "Exception when calling
|
868
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_emails_list: #{e}"
|
688
869
|
end
|
689
870
|
```
|
690
871
|
|
@@ -697,6 +878,7 @@ Name | Type | Description | Notes
|
|
697
878
|
**message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
|
698
879
|
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
699
880
|
**end_date** | **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. | [optional]
|
881
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
700
882
|
|
701
883
|
### Return type
|
702
884
|
|
@@ -737,7 +919,7 @@ SibApiV3Sdk.configure do |config|
|
|
737
919
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
738
920
|
end
|
739
921
|
|
740
|
-
api_instance = SibApiV3Sdk::
|
922
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
741
923
|
|
742
924
|
template_id = 789 # Integer | Id of the template
|
743
925
|
|
@@ -749,7 +931,7 @@ begin
|
|
749
931
|
result = api_instance.send_template(template_id, send_email)
|
750
932
|
p result
|
751
933
|
rescue SibApiV3Sdk::ApiError => e
|
752
|
-
puts "Exception when calling
|
934
|
+
puts "Exception when calling TransactionalEmailsApi->send_template: #{e}"
|
753
935
|
end
|
754
936
|
```
|
755
937
|
|
@@ -797,7 +979,7 @@ SibApiV3Sdk.configure do |config|
|
|
797
979
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
798
980
|
end
|
799
981
|
|
800
|
-
api_instance = SibApiV3Sdk::
|
982
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
801
983
|
|
802
984
|
template_id = 789 # Integer | Id of the template
|
803
985
|
|
@@ -808,7 +990,7 @@ begin
|
|
808
990
|
#Send a template to your test list
|
809
991
|
api_instance.send_test_template(template_id, send_test_email)
|
810
992
|
rescue SibApiV3Sdk::ApiError => e
|
811
|
-
puts "Exception when calling
|
993
|
+
puts "Exception when calling TransactionalEmailsApi->send_test_template: #{e}"
|
812
994
|
end
|
813
995
|
```
|
814
996
|
|
@@ -856,7 +1038,7 @@ SibApiV3Sdk.configure do |config|
|
|
856
1038
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
857
1039
|
end
|
858
1040
|
|
859
|
-
api_instance = SibApiV3Sdk::
|
1041
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
860
1042
|
|
861
1043
|
send_smtp_email = SibApiV3Sdk::SendSmtpEmail.new # SendSmtpEmail | Values to send a transactional email
|
862
1044
|
|
@@ -866,7 +1048,7 @@ begin
|
|
866
1048
|
result = api_instance.send_transac_email(send_smtp_email)
|
867
1049
|
p result
|
868
1050
|
rescue SibApiV3Sdk::ApiError => e
|
869
|
-
puts "Exception when calling
|
1051
|
+
puts "Exception when calling TransactionalEmailsApi->send_transac_email: #{e}"
|
870
1052
|
end
|
871
1053
|
```
|
872
1054
|
|
@@ -913,7 +1095,7 @@ SibApiV3Sdk.configure do |config|
|
|
913
1095
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
914
1096
|
end
|
915
1097
|
|
916
|
-
api_instance = SibApiV3Sdk::
|
1098
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
917
1099
|
|
918
1100
|
email = 'email_example' # String | contact email (urlencoded) to unblock.
|
919
1101
|
|
@@ -922,7 +1104,7 @@ begin
|
|
922
1104
|
#Unblock or resubscribe a transactional contact
|
923
1105
|
api_instance.smtp_blocked_contacts_email_delete(email)
|
924
1106
|
rescue SibApiV3Sdk::ApiError => e
|
925
|
-
puts "Exception when calling
|
1107
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_blocked_contacts_email_delete: #{e}"
|
926
1108
|
end
|
927
1109
|
```
|
928
1110
|
|
@@ -969,7 +1151,7 @@ SibApiV3Sdk.configure do |config|
|
|
969
1151
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
970
1152
|
end
|
971
1153
|
|
972
|
-
api_instance = SibApiV3Sdk::
|
1154
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
973
1155
|
|
974
1156
|
message_id = 'message_id_example' # String | MessageId of the transactional log to delete
|
975
1157
|
|
@@ -978,7 +1160,7 @@ begin
|
|
978
1160
|
#Delete an SMTP transactional log
|
979
1161
|
api_instance.smtp_log_message_id_delete(message_id)
|
980
1162
|
rescue SibApiV3Sdk::ApiError => e
|
981
|
-
puts "Exception when calling
|
1163
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_log_message_id_delete: #{e}"
|
982
1164
|
end
|
983
1165
|
```
|
984
1166
|
|
@@ -1025,7 +1207,7 @@ SibApiV3Sdk.configure do |config|
|
|
1025
1207
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
1026
1208
|
end
|
1027
1209
|
|
1028
|
-
api_instance = SibApiV3Sdk::
|
1210
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
1029
1211
|
|
1030
1212
|
template_id = 789 # Integer | id of the template
|
1031
1213
|
|
@@ -1036,7 +1218,7 @@ begin
|
|
1036
1218
|
#Update an email template
|
1037
1219
|
api_instance.update_smtp_template(template_id, smtp_template)
|
1038
1220
|
rescue SibApiV3Sdk::ApiError => e
|
1039
|
-
puts "Exception when calling
|
1221
|
+
puts "Exception when calling TransactionalEmailsApi->update_smtp_template: #{e}"
|
1040
1222
|
end
|
1041
1223
|
```
|
1042
1224
|
|