sib-api-v3-sdk 7.3.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 +10 -8
- data/docs/ContactsApi.md +4 -4
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/EmailCampaignsApi.md +4 -4
- data/docs/GetCampaignOverview.md +1 -1
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactDetails.md +2 -2
- data/docs/GetEmailCampaign.md +6 -6
- data/docs/GetEmailEventReportEvents.md +1 -1
- data/docs/GetExtendedCampaignOverview.md +4 -4
- 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 +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetExtendedList.md +1 -1
- data/docs/GetSmsCampaign.md +5 -5
- data/docs/GetSmsCampaignOverview.md +3 -3
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsEventReportEvents.md +1 -1
- data/docs/GetSmtpTemplateOverview.md +2 -2
- 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/GetWebhook.md +2 -2
- data/docs/ListsApi.md +2 -2
- data/docs/SMSCampaignsApi.md +4 -4
- data/docs/TransactionalEmailsApi.md +3 -3
- data/docs/TransactionalSMSApi.md +3 -3
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +1 -1
- data/lib/sib-api-v3-sdk.rb +11 -9
- data/lib/sib-api-v3-sdk/api/account_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/folders_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/lists_api.rb +3 -3
- data/lib/sib-api-v3-sdk/api/process_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +1 -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 +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 +3 -2
- 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 +3 -2
- 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 -2
- 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 +3 -2
- 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 -2
- 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 -2
- 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 -8
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -2
- 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 +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -6
- 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 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -3
- 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 -2
- 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 -2
- data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -2
- 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 -7
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -5
- 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 -2
- 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 -3
- 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 -2
- 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 -2
- 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 +3 -2
- data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +3 -2
- 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 +3 -2
- 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 +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +3 -2
- 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 +3 -2
- 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 +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 +3 -3
- data/spec/api/email_campaigns_api_spec.rb +3 -3
- data/spec/api/folders_api_spec.rb +1 -1
- data/spec/api/lists_api_spec.rb +2 -2
- data/spec/api/process_api_spec.rb +1 -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 +3 -3
- data/spec/api/transactional_emails_api_spec.rb +1 -1
- data/spec/api/transactional_sms_api_spec.rb +1 -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 +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 +1 -1
- 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 +1 -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 +1 -1
- 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 +1 -1
- 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 +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 -1
- 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 +1 -1
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/send_smtp_email_to_1_spec.rb +1 -1
- 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 +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30ce4095a80ff1d1c8650786dae1e129230c6d4a7f7ff0e19f489bf747c31be1
|
4
|
+
data.tar.gz: 9f82e028135b54b8d52d15682a3808c812effb59a0b8aa7fced5f24ca0ea15a7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6f6315fc12b200fbac89fb8948240e932da3161e6a281351e8d9341f5226e344cc9b619e1aef4992a3459e39552f810646b739057024254e2bfa6f78367baa2a
|
7
|
+
data.tar.gz: 1077e37a3a31f1f0df35e14247ee013118f7a646b95838bce8dd26594925673965a1d66dd692504e76891656cdc48b394bcdf9e61b759ef8aa4ad96f357fac35
|
data/README.md
CHANGED
@@ -247,6 +247,7 @@ Class | Method | HTTP request | Description
|
|
247
247
|
- [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)
|
248
248
|
- [SibApiV3Sdk::EmailExportRecipients](docs/EmailExportRecipients.md)
|
249
249
|
- [SibApiV3Sdk::ErrorModel](docs/ErrorModel.md)
|
250
|
+
- [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
|
250
251
|
- [SibApiV3Sdk::GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
|
251
252
|
- [SibApiV3Sdk::GetAccountPlan](docs/GetAccountPlan.md)
|
252
253
|
- [SibApiV3Sdk::GetAccountRelay](docs/GetAccountRelay.md)
|
@@ -262,6 +263,7 @@ Class | Method | HTTP request | Description
|
|
262
263
|
- [SibApiV3Sdk::GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
|
263
264
|
- [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
|
264
265
|
- [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
|
266
|
+
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
265
267
|
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
|
266
268
|
- [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
|
267
269
|
- [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
|
@@ -277,12 +279,17 @@ Class | Method | HTTP request | Description
|
|
277
279
|
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
|
278
280
|
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
|
279
281
|
- [SibApiV3Sdk::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
|
282
|
+
- [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
|
280
283
|
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
|
281
284
|
- [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
|
282
285
|
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
|
286
|
+
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
283
287
|
- [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
|
284
288
|
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
|
289
|
+
- [SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats](docs/GetExtendedCampaignStatsGlobalStats.md)
|
290
|
+
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
285
291
|
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
|
292
|
+
- [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
|
286
293
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
|
287
294
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
|
288
295
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
|
@@ -291,6 +298,7 @@ Class | Method | HTTP request | Description
|
|
291
298
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
|
292
299
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
|
293
300
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
|
301
|
+
- [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
|
294
302
|
- [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
|
295
303
|
- [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
|
296
304
|
- [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
|
@@ -309,7 +317,9 @@ Class | Method | HTTP request | Description
|
|
309
317
|
- [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
|
310
318
|
- [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
|
311
319
|
- [SibApiV3Sdk::GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
|
320
|
+
- [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
|
312
321
|
- [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
|
322
|
+
- [SibApiV3Sdk::GetSmsCampaignRecipients](docs/GetSmsCampaignRecipients.md)
|
313
323
|
- [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
|
314
324
|
- [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
|
315
325
|
- [SibApiV3Sdk::GetSmsEventReport](docs/GetSmsEventReport.md)
|
@@ -384,14 +394,6 @@ Class | Method | HTTP request | Description
|
|
384
394
|
- [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
|
385
395
|
- [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
|
386
396
|
- [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
|
387
|
-
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
388
|
-
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
389
|
-
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
390
|
-
- [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
|
391
|
-
- [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
|
392
|
-
- [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
|
393
|
-
- [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
|
394
|
-
- [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
|
395
397
|
|
396
398
|
|
397
399
|
## Documentation for Authorization
|
data/docs/ContactsApi.md
CHANGED
@@ -807,7 +807,7 @@ 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
811
|
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
812
812
|
}
|
813
813
|
|
@@ -826,7 +826,7 @@ Name | Type | Description | Notes
|
|
826
826
|
------------- | ------------- | ------------- | -------------
|
827
827
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
828
828
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
829
|
-
**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
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]
|
831
831
|
|
832
832
|
### Return type
|
@@ -871,7 +871,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
871
871
|
list_id = 789 # Integer | Id of the list
|
872
872
|
|
873
873
|
opts = {
|
874
|
-
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.
|
875
875
|
limit: 50, # Integer | Number of documents per page
|
876
876
|
offset: 0, # Integer | Index of the first document of the page
|
877
877
|
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
@@ -891,7 +891,7 @@ end
|
|
891
891
|
Name | Type | Description | Notes
|
892
892
|
------------- | ------------- | ------------- | -------------
|
893
893
|
**list_id** | **Integer**| Id of the list |
|
894
|
-
**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]
|
895
895
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
896
896
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
897
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]
|
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/EmailCampaignsApi.md
CHANGED
@@ -336,8 +336,8 @@ 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
342
|
offset: 0, # Integer | Index of the first document in the page
|
343
343
|
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
@@ -358,8 +358,8 @@ Name | Type | Description | Notes
|
|
358
358
|
------------- | ------------- | ------------- | -------------
|
359
359
|
**type** | **String**| Filter on the type of the campaigns | [optional]
|
360
360
|
**status** | **String**| Filter on the status of the campaign | [optional]
|
361
|
-
**start_date** | **
|
362
|
-
**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]
|
363
363
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
|
364
364
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
365
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]
|
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]
|
@@ -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]
|
@@ -25,14 +25,14 @@ Name | Type | Description | Notes
|
|
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
27
|
**tag** | **String** | Tag of the campaign | [optional]
|
28
|
-
**created_at** | **
|
29
|
-
**modified_at** | **
|
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
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email** | **String** | Email address which generates the event |
|
7
|
-
**date** | **
|
7
|
+
**date** | **String** | UTC date-time on which the event has been generated |
|
8
8
|
**subject** | **String** | Subject of the event | [optional]
|
9
9
|
**message_id** | **String** | Message ID which generated the event |
|
10
10
|
**event** | **String** | Event which occurred |
|
@@ -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]
|
@@ -25,12 +25,12 @@ Name | Type | Description | Notes
|
|
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
27
|
**tag** | **String** | Tag of the campaign | [optional]
|
28
|
-
**created_at** | **
|
29
|
-
**modified_at** | **
|
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
35
|
|
36
36
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**global_stats** | **
|
6
|
+
**global_stats** | [**GetExtendedCampaignStatsGlobalStats**](GetExtendedCampaignStatsGlobalStats.md) | |
|
7
7
|
**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. |
|
8
8
|
**mirror_click** | **Integer** | Number of clicks on mirror link |
|
9
9
|
**remaining** | **Integer** | Number of remaning emails to send |
|
@@ -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 |
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**count** | **Integer** | Number of clicks on this link for the campaign |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
8
|
**ip** | **String** | IP from which the user has clicked on the link |
|
9
9
|
**url** | **String** | URL of the clicked link |
|
10
10
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
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 for 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 email |
|
10
10
|
|
11
11
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**event_time** | **
|
6
|
+
**event_time** | **String** | UTC date-time of the event |
|
7
7
|
**ip** | **String** | IP from which the user has been unsubscribed | [optional]
|
8
8
|
|
9
9
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
8
|
**ip** | **String** | IP from which the user has unsubscribed | [optional]
|
9
9
|
|
10
10
|
|
data/docs/GetExtendedList.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
|
9
9
|
**total_subscribers** | **Integer** | Number of contacts in the list |
|
10
10
|
**folder_id** | **Integer** | ID of the folder |
|
11
|
-
**created_at** | **
|
11
|
+
**created_at** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
12
|
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
|
13
13
|
**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
|
14
14
|
|
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
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**phone_number** | **String** | Phone number which has generated the event | [optional]
|
7
|
-
**date** | **
|
7
|
+
**date** | **String** | UTC date-time on which the event has been generated | [optional]
|
8
8
|
**message_id** | **String** | Message ID which generated the event | [optional]
|
9
9
|
**event** | **String** | Event which occurred | [optional]
|
10
10
|
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [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
|
|
@@ -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
|
|