sib-api-v3-sdk 7.0.0 → 7.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -8
- data/docs/BlockDomain.md +8 -0
- data/docs/ContactsApi.md +25 -13
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/CreateSmtpTemplateSender.md +1 -1
- data/docs/EmailCampaignsApi.md +7 -5
- data/docs/FoldersApi.md +9 -3
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +1 -1
- 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 +2 -1
- data/docs/GetFolderLists.md +2 -2
- data/docs/GetList.md +1 -0
- 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/GetTransacEmailsList.md +1 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
- data/docs/GetTransacSmsReportReports.md +10 -10
- data/docs/GetWebhook.md +2 -2
- data/docs/ListsApi.md +11 -5
- data/docs/ProcessApi.md +3 -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 -3
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +1 -1
- data/docs/TransactionalEmailsApi.md +197 -11
- data/docs/TransactionalSMSApi.md +9 -5
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/WebhooksApi.md +3 -1
- data/lib/sib-api-v3-sdk.rb +16 -9
- 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 +49 -9
- 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 +31 -3
- 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/transactional_emails_api.rb +211 -7
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +17 -1
- data/lib/sib-api-v3-sdk/api_client.rb +8 -5
- 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 +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +3 -2
- 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 +3 -2
- 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 +3 -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 +4 -3
- 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 +3 -2
- 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 -2
- 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 +3 -2
- 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 +20 -4
- 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 +22 -6
- 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 +14 -3
- 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 +3 -2
- 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 +7 -11
- 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 +4 -3
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +3 -2
- 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 +4 -3
- 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 +3 -2
- 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 +10 -5
- 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 +5 -2
- 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/transactional_emails_api_spec.rb +45 -3
- data/spec/api/transactional_sms_api_spec.rb +3 -1
- data/spec/api/webhooks_api_spec.rb +2 -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 +1 -1
- data/spec/models/ab_test_campaign_result_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_spec.rb +1 -1
- data/spec/models/ab_test_version_stats_spec.rb +1 -1
- data/spec/models/add_child_domain_spec.rb +1 -1
- data/spec/models/add_contact_to_list_spec.rb +1 -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 +1 -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 +7 -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 +7 -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 +7 -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 +1 -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 +1 -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 +193 -167
- data/testfile.rb +0 -23
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a6830c58e4aa1385576b0a84dadff27b95f0e2a1d470e9db837ecf0ff14be012
|
|
4
|
+
data.tar.gz: 5db71baf1f08066d801883ea2a66ee048c58a53fc61e1e00bcdbcbe35000eee4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fc9189b8144c9c3c8df198edd216d03d73aa4e94e85435e3bbffae578c97f5cb0c9d07107724192dfe34762219aa1fa0c2b3e464ae384a026e93ca2ca245cebc
|
|
7
|
+
data.tar.gz: ed9f52d37d927c6df91079b21b3a78ea100f0d44337326df978c387e7bfa7c3f4dcf614645d0fadd526ae7dee77356fa14045c8c86193f1916b97e100f0d7b15
|
data/README.md
CHANGED
|
@@ -178,10 +178,13 @@ Class | Method | HTTP request | Description
|
|
|
178
178
|
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
|
179
179
|
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
|
|
180
180
|
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
|
|
181
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
|
181
182
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
|
183
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
|
182
184
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
|
183
185
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
|
184
186
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
|
187
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
|
185
188
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
|
186
189
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
|
187
190
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
|
@@ -217,6 +220,7 @@ Class | Method | HTTP request | Description
|
|
|
217
220
|
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
|
|
218
221
|
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
|
|
219
222
|
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
|
|
223
|
+
- [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
|
|
220
224
|
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
|
|
221
225
|
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
|
|
222
226
|
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
|
|
@@ -243,6 +247,7 @@ Class | Method | HTTP request | Description
|
|
|
243
247
|
- [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)
|
|
244
248
|
- [SibApiV3Sdk::EmailExportRecipients](docs/EmailExportRecipients.md)
|
|
245
249
|
- [SibApiV3Sdk::ErrorModel](docs/ErrorModel.md)
|
|
250
|
+
- [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
|
|
246
251
|
- [SibApiV3Sdk::GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
|
|
247
252
|
- [SibApiV3Sdk::GetAccountPlan](docs/GetAccountPlan.md)
|
|
248
253
|
- [SibApiV3Sdk::GetAccountRelay](docs/GetAccountRelay.md)
|
|
@@ -251,12 +256,14 @@ Class | Method | HTTP request | Description
|
|
|
251
256
|
- [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
|
|
252
257
|
- [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
|
|
253
258
|
- [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
|
|
259
|
+
- [SibApiV3Sdk::GetBlockedDomains](docs/GetBlockedDomains.md)
|
|
254
260
|
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
|
|
255
261
|
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
|
|
256
262
|
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
|
|
257
263
|
- [SibApiV3Sdk::GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
|
|
258
264
|
- [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
|
|
259
265
|
- [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
|
|
266
|
+
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
|
260
267
|
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
|
|
261
268
|
- [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
|
|
262
269
|
- [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
|
|
@@ -272,12 +279,17 @@ Class | Method | HTTP request | Description
|
|
|
272
279
|
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
|
|
273
280
|
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
|
|
274
281
|
- [SibApiV3Sdk::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
|
|
282
|
+
- [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
|
|
275
283
|
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
|
|
276
284
|
- [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
|
|
277
285
|
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
|
|
286
|
+
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
|
278
287
|
- [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
|
|
279
288
|
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
|
|
289
|
+
- [SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats](docs/GetExtendedCampaignStatsGlobalStats.md)
|
|
290
|
+
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
|
280
291
|
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
|
|
292
|
+
- [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
|
|
281
293
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
|
|
282
294
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
|
|
283
295
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
|
|
@@ -286,6 +298,7 @@ Class | Method | HTTP request | Description
|
|
|
286
298
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
|
|
287
299
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
|
|
288
300
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
|
|
301
|
+
- [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
|
|
289
302
|
- [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
|
|
290
303
|
- [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
|
|
291
304
|
- [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
|
|
@@ -304,7 +317,9 @@ Class | Method | HTTP request | Description
|
|
|
304
317
|
- [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
|
|
305
318
|
- [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
|
|
306
319
|
- [SibApiV3Sdk::GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
|
|
320
|
+
- [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
|
|
307
321
|
- [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
|
|
322
|
+
- [SibApiV3Sdk::GetSmsCampaignRecipients](docs/GetSmsCampaignRecipients.md)
|
|
308
323
|
- [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
|
|
309
324
|
- [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
|
|
310
325
|
- [SibApiV3Sdk::GetSmsEventReport](docs/GetSmsEventReport.md)
|
|
@@ -352,9 +367,12 @@ Class | Method | HTTP request | Description
|
|
|
352
367
|
- [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
|
|
353
368
|
- [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
|
|
354
369
|
- [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
|
|
370
|
+
- [SibApiV3Sdk::SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
|
|
355
371
|
- [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
|
|
372
|
+
- [SibApiV3Sdk::SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
|
|
356
373
|
- [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
|
|
357
374
|
- [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
|
|
375
|
+
- [SibApiV3Sdk::SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
|
|
358
376
|
- [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
|
|
359
377
|
- [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
|
|
360
378
|
- [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
|
|
@@ -376,14 +394,6 @@ Class | Method | HTTP request | Description
|
|
|
376
394
|
- [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
|
|
377
395
|
- [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
|
|
378
396
|
- [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
|
|
379
|
-
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
|
380
|
-
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
|
381
|
-
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
|
382
|
-
- [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
|
|
383
|
-
- [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
|
|
384
|
-
- [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
|
|
385
|
-
- [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
|
|
386
|
-
- [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
|
|
387
397
|
|
|
388
398
|
|
|
389
399
|
## Documentation for Authorization
|
data/docs/BlockDomain.md
ADDED
data/docs/ContactsApi.md
CHANGED
|
@@ -744,8 +744,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
744
744
|
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
|
745
745
|
|
|
746
746
|
opts = {
|
|
747
|
-
start_date:
|
|
748
|
-
end_date:
|
|
747
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
|
748
|
+
end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
|
749
749
|
}
|
|
750
750
|
|
|
751
751
|
begin
|
|
@@ -762,8 +762,8 @@ end
|
|
|
762
762
|
Name | Type | Description | Notes
|
|
763
763
|
------------- | ------------- | ------------- | -------------
|
|
764
764
|
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
|
765
|
-
**start_date** | **
|
|
766
|
-
**end_date** | **
|
|
765
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
|
|
766
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
|
|
767
767
|
|
|
768
768
|
### Return type
|
|
769
769
|
|
|
@@ -807,7 +807,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
807
807
|
opts = {
|
|
808
808
|
limit: 50, # Integer | Number of documents per page
|
|
809
809
|
offset: 0, # Integer | Index of the first document of the page
|
|
810
|
-
modified_since:
|
|
810
|
+
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.
|
|
811
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
811
812
|
}
|
|
812
813
|
|
|
813
814
|
begin
|
|
@@ -825,7 +826,8 @@ Name | Type | Description | Notes
|
|
|
825
826
|
------------- | ------------- | ------------- | -------------
|
|
826
827
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
827
828
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
828
|
-
**modified_since** | **
|
|
829
|
+
**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]
|
|
830
|
+
**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]
|
|
829
831
|
|
|
830
832
|
### Return type
|
|
831
833
|
|
|
@@ -869,9 +871,10 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
869
871
|
list_id = 789 # Integer | Id of the list
|
|
870
872
|
|
|
871
873
|
opts = {
|
|
872
|
-
modified_since:
|
|
874
|
+
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.
|
|
873
875
|
limit: 50, # Integer | Number of documents per page
|
|
874
|
-
offset: 0 # Integer | Index of the first document of the page
|
|
876
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
877
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
875
878
|
}
|
|
876
879
|
|
|
877
880
|
begin
|
|
@@ -888,9 +891,10 @@ end
|
|
|
888
891
|
Name | Type | Description | Notes
|
|
889
892
|
------------- | ------------- | ------------- | -------------
|
|
890
893
|
**list_id** | **Integer**| Id of the list |
|
|
891
|
-
**modified_since** | **
|
|
894
|
+
**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]
|
|
892
895
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
893
896
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
897
|
+
**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]
|
|
894
898
|
|
|
895
899
|
### Return type
|
|
896
900
|
|
|
@@ -992,7 +996,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
|
992
996
|
|
|
993
997
|
opts = {
|
|
994
998
|
limit: 10, # Integer | Number of documents per page
|
|
995
|
-
offset: 0 # Integer | Index of the first document of the page
|
|
999
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
1000
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
996
1001
|
}
|
|
997
1002
|
|
|
998
1003
|
begin
|
|
@@ -1011,6 +1016,7 @@ Name | Type | Description | Notes
|
|
|
1011
1016
|
**folder_id** | **Integer**| Id of the folder |
|
|
1012
1017
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
1013
1018
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
1019
|
+
**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]
|
|
1014
1020
|
|
|
1015
1021
|
### Return type
|
|
1016
1022
|
|
|
@@ -1028,7 +1034,7 @@ Name | Type | Description | Notes
|
|
|
1028
1034
|
|
|
1029
1035
|
|
|
1030
1036
|
# **get_folders**
|
|
1031
|
-
> GetFolders get_folders(limit, offset)
|
|
1037
|
+
> GetFolders get_folders(limit, offset, opts)
|
|
1032
1038
|
|
|
1033
1039
|
Get all folders
|
|
1034
1040
|
|
|
@@ -1055,10 +1061,13 @@ limit = 10 # Integer | Number of documents per page
|
|
|
1055
1061
|
|
|
1056
1062
|
offset = 0 # Integer | Index of the first document of the page
|
|
1057
1063
|
|
|
1064
|
+
opts = {
|
|
1065
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1066
|
+
}
|
|
1058
1067
|
|
|
1059
1068
|
begin
|
|
1060
1069
|
#Get all folders
|
|
1061
|
-
result = api_instance.get_folders(limit, offset)
|
|
1070
|
+
result = api_instance.get_folders(limit, offset, opts)
|
|
1062
1071
|
p result
|
|
1063
1072
|
rescue SibApiV3Sdk::ApiError => e
|
|
1064
1073
|
puts "Exception when calling ContactsApi->get_folders: #{e}"
|
|
@@ -1071,6 +1080,7 @@ Name | Type | Description | Notes
|
|
|
1071
1080
|
------------- | ------------- | ------------- | -------------
|
|
1072
1081
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
|
1073
1082
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
|
1083
|
+
**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]
|
|
1074
1084
|
|
|
1075
1085
|
### Return type
|
|
1076
1086
|
|
|
@@ -1170,7 +1180,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
1170
1180
|
|
|
1171
1181
|
opts = {
|
|
1172
1182
|
limit: 10, # Integer | Number of documents per page
|
|
1173
|
-
offset: 0 # Integer | Index of the first document of the page
|
|
1183
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
1184
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1174
1185
|
}
|
|
1175
1186
|
|
|
1176
1187
|
begin
|
|
@@ -1188,6 +1199,7 @@ Name | Type | Description | Notes
|
|
|
1188
1199
|
------------- | ------------- | ------------- | -------------
|
|
1189
1200
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
1190
1201
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
1202
|
+
**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]
|
|
1191
1203
|
|
|
1192
1204
|
### Return type
|
|
1193
1205
|
|
data/docs/CreateEmailCampaign.md
CHANGED
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**html_content** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
|
|
10
10
|
**html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
|
|
11
11
|
**template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
|
|
12
|
-
**scheduled_at** | **
|
|
12
|
+
**scheduled_at** | **String** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
|
13
13
|
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
|
14
14
|
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
|
|
15
15
|
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
data/docs/CreateSmsCampaign.md
CHANGED
|
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
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
|
-
**scheduled_at** | **
|
|
10
|
+
**scheduled_at** | **String** | 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]
|
|
11
11
|
|
|
12
12
|
|
data/docs/CreateSmtpEmail.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**message_id** | **String** | Message ID of the transactional email sent |
|
|
6
|
+
**message_id** | **String** | Message ID of the transactional email sent | [optional]
|
|
7
|
+
**message_ids** | **Array<String>** | | [optional]
|
|
7
8
|
|
|
8
9
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
|
|
7
|
-
**email** | **String** | Email of the sender |
|
|
7
|
+
**email** | **String** | Email of the sender | [optional]
|
|
8
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]
|
|
9
9
|
|
|
10
10
|
|
data/docs/EmailCampaignsApi.md
CHANGED
|
@@ -336,10 +336,11 @@ api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
|
|
336
336
|
opts = {
|
|
337
337
|
type: 'type_example', # String | Filter on the type of the campaigns
|
|
338
338
|
status: 'status_example', # String | Filter on the status of the campaign
|
|
339
|
-
start_date:
|
|
340
|
-
end_date:
|
|
339
|
+
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 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: 'end_date_example', # String | 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' )
|
|
341
341
|
limit: 500, # Integer | Number of documents per page
|
|
342
|
-
offset: 0 # Integer | Index of the first document in the page
|
|
342
|
+
offset: 0, # Integer | Index of the first document in the page
|
|
343
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
343
344
|
}
|
|
344
345
|
|
|
345
346
|
begin
|
|
@@ -357,10 +358,11 @@ Name | Type | Description | Notes
|
|
|
357
358
|
------------- | ------------- | ------------- | -------------
|
|
358
359
|
**type** | **String**| Filter on the type of the campaigns | [optional]
|
|
359
360
|
**status** | **String**| Filter on the status of the campaign | [optional]
|
|
360
|
-
**start_date** | **
|
|
361
|
-
**end_date** | **
|
|
361
|
+
**start_date** | **String**| 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' ) | [optional]
|
|
362
|
+
**end_date** | **String**| 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' ) | [optional]
|
|
362
363
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
|
|
363
364
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
365
|
+
**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]
|
|
364
366
|
|
|
365
367
|
### Return type
|
|
366
368
|
|
data/docs/FoldersApi.md
CHANGED
|
@@ -210,7 +210,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
|
210
210
|
|
|
211
211
|
opts = {
|
|
212
212
|
limit: 10, # Integer | Number of documents per page
|
|
213
|
-
offset: 0 # Integer | Index of the first document of the page
|
|
213
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
214
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
214
215
|
}
|
|
215
216
|
|
|
216
217
|
begin
|
|
@@ -229,6 +230,7 @@ Name | Type | Description | Notes
|
|
|
229
230
|
**folder_id** | **Integer**| Id of the folder |
|
|
230
231
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
231
232
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
233
|
+
**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]
|
|
232
234
|
|
|
233
235
|
### Return type
|
|
234
236
|
|
|
@@ -246,7 +248,7 @@ Name | Type | Description | Notes
|
|
|
246
248
|
|
|
247
249
|
|
|
248
250
|
# **get_folders**
|
|
249
|
-
> GetFolders get_folders(limit, offset)
|
|
251
|
+
> GetFolders get_folders(limit, offset, opts)
|
|
250
252
|
|
|
251
253
|
Get all folders
|
|
252
254
|
|
|
@@ -273,10 +275,13 @@ limit = 10 # Integer | Number of documents per page
|
|
|
273
275
|
|
|
274
276
|
offset = 0 # Integer | Index of the first document of the page
|
|
275
277
|
|
|
278
|
+
opts = {
|
|
279
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
280
|
+
}
|
|
276
281
|
|
|
277
282
|
begin
|
|
278
283
|
#Get all folders
|
|
279
|
-
result = api_instance.get_folders(limit, offset)
|
|
284
|
+
result = api_instance.get_folders(limit, offset, opts)
|
|
280
285
|
p result
|
|
281
286
|
rescue SibApiV3Sdk::ApiError => e
|
|
282
287
|
puts "Exception when calling FoldersApi->get_folders: #{e}"
|
|
@@ -289,6 +294,7 @@ Name | Type | Description | Notes
|
|
|
289
294
|
------------- | ------------- | ------------- | -------------
|
|
290
295
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
|
291
296
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
|
297
|
+
**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]
|
|
292
298
|
|
|
293
299
|
### Return type
|
|
294
300
|
|
data/docs/GetCampaignOverview.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
|
9
9
|
**type** | **String** | Type of campaign |
|
|
10
10
|
**status** | **String** | Status of the campaign |
|
|
11
|
-
**scheduled_at** | **
|
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
|
12
12
|
**ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
|
13
13
|
**subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
|
14
14
|
**subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
data/docs/GetChildDomain.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**domain** | **String** | Sender domain |
|
|
7
|
-
**active** | **BOOLEAN** | indicates whether a domain is verified or not |
|
|
6
|
+
**domain** | **String** | Sender domain | [optional]
|
|
7
|
+
**active** | **BOOLEAN** | indicates whether a domain is verified or not | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/GetChildrenList.md
CHANGED
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**children** | **Array<Object>** | Your children's account information | [optional]
|
|
7
|
-
**count** | **Integer** | Number of child accounts |
|
|
7
|
+
**count** | **Integer** | Number of child accounts | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
|
7
7
|
**count** | **Integer** | Number of openings of the campaign |
|
|
8
|
-
**event_time** | **
|
|
8
|
+
**event_time** | **String** | UTC date-time of the event |
|
|
9
9
|
**ip** | **String** | IP from which the user has opened the campaign |
|
|
10
10
|
|
|
11
11
|
|
data/docs/GetContactDetails.md
CHANGED
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **Integer** | ID of the contact for which you requested the details |
|
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
|
10
|
-
**created_at** | **
|
|
11
|
-
**modified_at** | **
|
|
10
|
+
**created_at** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
11
|
+
**modified_at** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
12
12
|
**list_ids** | **Array<Integer>** | |
|
|
13
13
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
|
14
14
|
**attributes** | **Object** | Set of attributes of the contact |
|
data/docs/GetEmailCampaign.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
|
9
9
|
**type** | **String** | Type of campaign |
|
|
10
10
|
**status** | **String** | Status of the campaign |
|
|
11
|
-
**scheduled_at** | **
|
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
|
12
12
|
**ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
|
13
13
|
**subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
|
14
14
|
**subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
|
@@ -21,18 +21,18 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**footer** | **String** | Footer of the campaign |
|
|
22
22
|
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
|
23
23
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
|
24
|
-
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
|
24
|
+
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
|
|
25
25
|
**html_content** | **String** | HTML content of the campaign |
|
|
26
26
|
**share_link** | **String** | Link to share the campaign on social medias | [optional]
|
|
27
|
-
**tag** | **String** | Tag of the campaign |
|
|
28
|
-
**created_at** | **
|
|
29
|
-
**modified_at** | **
|
|
27
|
+
**tag** | **String** | Tag of the campaign | [optional]
|
|
28
|
+
**created_at** | **String** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
29
|
+
**modified_at** | **String** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
30
30
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
|
31
31
|
**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
|
32
32
|
**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
|
33
|
-
**sent_date** | **
|
|
33
|
+
**sent_date** | **String** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
|
34
34
|
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
|
35
|
-
**recipients** | **
|
|
36
|
-
**statistics** | **
|
|
35
|
+
**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
|
36
|
+
**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
|
37
37
|
|
|
38
38
|
|