sib-api-v3-sdk 5.2.5 → 5.3.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/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +17 -1
- data/docs/AbTestCampaignResult.md +13 -0
- data/docs/AttributesApi.md +6 -6
- data/docs/ContactsApi.md +12 -12
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +3 -0
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +1 -1
- data/docs/EmailCampaignsApi.md +127 -7
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/ListsApi.md +1 -1
- data/docs/RequestContactExport.md +2 -1
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/ResellerApi.md +87 -20
- data/docs/SMSCampaignsApi.md +3 -3
- data/docs/SMTPApi.md +200 -19
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -1
- data/docs/SendSmtpEmail.md +2 -2
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +1 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendersApi.md +2 -2
- data/docs/TransactionalSMSApi.md +11 -11
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +3 -0
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +12 -2
- data/lib/sib-api-v3-sdk/api/account_api.rb +6 -9
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +15 -27
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +81 -155
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +141 -61
- data/lib/sib-api-v3-sdk/api/folders_api.rb +21 -39
- data/lib/sib-api-v3-sdk/api/lists_api.rb +30 -57
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +111 -92
- data/lib/sib-api-v3-sdk/api/senders_api.rb +21 -39
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +33 -59
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +213 -82
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +15 -27
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +10 -14
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +12 -17
- data/lib/sib-api-v3-sdk/models/create_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +79 -29
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sender.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +13 -17
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +11 -15
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +29 -33
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +27 -31
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +19 -24
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +9 -13
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +18 -19
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +11 -15
- data/lib/sib-api-v3-sdk/models/send_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +10 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +9 -13
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +9 -13
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +77 -27
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/spec/api/account_api_spec.rb +3 -4
- data/spec/api/attributes_api_spec.rb +6 -10
- data/spec/api/contacts_api_spec.rb +28 -52
- data/spec/api/email_campaigns_api_spec.rb +37 -22
- data/spec/api/folders_api_spec.rb +8 -14
- data/spec/api/lists_api_spec.rb +11 -20
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +31 -32
- data/spec/api/senders_api_spec.rb +8 -14
- data/spec/api/sms_campaigns_api_spec.rb +12 -20
- data/spec/api/smtp_api_spec.rb +53 -27
- data/spec/api/transactional_sms_api_spec.rb +6 -10
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_spec.rb +79 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +3 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +7 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +3 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +14 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +40 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +38 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +14 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +8 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +5 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +4 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +12 -13
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +4 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +5 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/spec_helper.rb +2 -2
- metadata +42 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 00b1f6463f5c659280d3d56e4a96798b38832fbdb80a3738fe27f05d031e0dbe
|
|
4
|
+
data.tar.gz: 44aae473188babf708d91c4a0c5cd71d960f2c7aa82778fd9c8760b7fb57c47b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cedb148f58eb2fc1ba91f4a0f51f857ef78c701775542f7cfba787373f1ee5511a9e07ef176f4461edaf19e4756fd94a3540e519b66169d8747a722d018dbb80
|
|
7
|
+
data.tar.gz: ee1d052ed95830eb5094cc1973cd2de5593758cbfb1dc224ac68721ef8e888744250d0300f46fa10f6140c3b1bc48b9e657baa6428856db03afad80347ee5ff3
|
data/Gemfile
CHANGED
data/LICENSE.md
CHANGED
data/README.md
CHANGED
|
@@ -118,9 +118,11 @@ Class | Method | HTTP request | Description
|
|
|
118
118
|
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
|
119
119
|
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
|
120
120
|
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
|
|
121
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result
|
|
121
122
|
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
|
|
122
123
|
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
|
123
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
|
124
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_shared_template_url**](docs/EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
|
125
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
|
124
126
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
|
|
125
127
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
|
126
128
|
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
|
|
@@ -149,6 +151,7 @@ Class | Method | HTTP request | Description
|
|
|
149
151
|
*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
|
|
150
152
|
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
|
|
151
153
|
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
|
|
154
|
+
*SibApiV3Sdk::ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
|
|
152
155
|
*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
|
|
153
156
|
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
|
|
154
157
|
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
|
|
@@ -175,11 +178,14 @@ Class | Method | HTTP request | Description
|
|
|
175
178
|
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
|
176
179
|
*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
|
|
177
180
|
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
|
|
181
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
|
178
182
|
*SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
|
179
183
|
*SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
|
180
184
|
*SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
|
181
185
|
*SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
|
182
186
|
*SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
|
187
|
+
*SibApiV3Sdk::SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
|
188
|
+
*SibApiV3Sdk::SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
|
183
189
|
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
|
|
184
190
|
*SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
|
|
185
191
|
*SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
|
|
@@ -200,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
|
200
206
|
|
|
201
207
|
## Documentation for Models
|
|
202
208
|
|
|
209
|
+
- [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
|
|
203
210
|
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
|
|
204
211
|
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
|
|
205
212
|
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
|
|
@@ -239,6 +246,7 @@ Class | Method | HTTP request | Description
|
|
|
239
246
|
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
|
|
240
247
|
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
|
|
241
248
|
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
|
|
249
|
+
- [SibApiV3Sdk::GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
|
|
242
250
|
- [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
|
|
243
251
|
- [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
|
|
244
252
|
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
|
|
@@ -255,6 +263,7 @@ Class | Method | HTTP request | Description
|
|
|
255
263
|
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
|
|
256
264
|
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
|
|
257
265
|
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
|
|
266
|
+
- [SibApiV3Sdk::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
|
|
258
267
|
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
|
|
259
268
|
- [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
|
|
260
269
|
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
|
|
@@ -286,6 +295,7 @@ Class | Method | HTTP request | Description
|
|
|
286
295
|
- [SibApiV3Sdk::GetSendersList](docs/GetSendersList.md)
|
|
287
296
|
- [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
|
|
288
297
|
- [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
|
|
298
|
+
- [SibApiV3Sdk::GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
|
|
289
299
|
- [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
|
|
290
300
|
- [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
|
|
291
301
|
- [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
|
|
@@ -295,8 +305,13 @@ Class | Method | HTTP request | Description
|
|
|
295
305
|
- [SibApiV3Sdk::GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
|
|
296
306
|
- [SibApiV3Sdk::GetSmtpTemplates](docs/GetSmtpTemplates.md)
|
|
297
307
|
- [SibApiV3Sdk::GetSsoToken](docs/GetSsoToken.md)
|
|
308
|
+
- [SibApiV3Sdk::GetStatsByBrowser](docs/GetStatsByBrowser.md)
|
|
309
|
+
- [SibApiV3Sdk::GetStatsByDevice](docs/GetStatsByDevice.md)
|
|
298
310
|
- [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
|
|
299
311
|
- [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
|
|
312
|
+
- [SibApiV3Sdk::GetTransacBlockedContacts](docs/GetTransacBlockedContacts.md)
|
|
313
|
+
- [SibApiV3Sdk::GetTransacBlockedContactsContacts](docs/GetTransacBlockedContactsContacts.md)
|
|
314
|
+
- [SibApiV3Sdk::GetTransacBlockedContactsReason](docs/GetTransacBlockedContactsReason.md)
|
|
300
315
|
- [SibApiV3Sdk::GetTransacEmailContent](docs/GetTransacEmailContent.md)
|
|
301
316
|
- [SibApiV3Sdk::GetTransacEmailContentEvents](docs/GetTransacEmailContentEvents.md)
|
|
302
317
|
- [SibApiV3Sdk::GetTransacEmailsList](docs/GetTransacEmailsList.md)
|
|
@@ -316,6 +331,7 @@ Class | Method | HTTP request | Description
|
|
|
316
331
|
- [SibApiV3Sdk::RemoveContactFromList](docs/RemoveContactFromList.md)
|
|
317
332
|
- [SibApiV3Sdk::RemoveCredits](docs/RemoveCredits.md)
|
|
318
333
|
- [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
|
|
334
|
+
- [SibApiV3Sdk::RequestContactExportCustomContactFilter](docs/RequestContactExportCustomContactFilter.md)
|
|
319
335
|
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
|
|
320
336
|
- [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
|
|
321
337
|
- [SibApiV3Sdk::RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# SibApiV3Sdk::AbTestCampaignResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**winning_version** | **String** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional]
|
|
7
|
+
**winning_criteria** | **String** | Criteria choosen for winning version (Open/Click) | [optional]
|
|
8
|
+
**winning_subject_line** | **String** | Subject Line of current winning version | [optional]
|
|
9
|
+
**open_rate** | **String** | Open rate for current winning version | [optional]
|
|
10
|
+
**click_rate** | **String** | Click rate for current winning version | [optional]
|
|
11
|
+
**winning_version_rate** | **String** | Open/Click rate for the winner version | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/AttributesApi.md
CHANGED
|
@@ -34,9 +34,9 @@ end
|
|
|
34
34
|
|
|
35
35
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
|
36
36
|
|
|
37
|
-
attribute_category =
|
|
37
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
38
38
|
|
|
39
|
-
attribute_name =
|
|
39
|
+
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
|
40
40
|
|
|
41
41
|
create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
|
42
42
|
|
|
@@ -96,9 +96,9 @@ end
|
|
|
96
96
|
|
|
97
97
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
|
98
98
|
|
|
99
|
-
attribute_category =
|
|
99
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
100
100
|
|
|
101
|
-
attribute_name =
|
|
101
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
102
102
|
|
|
103
103
|
|
|
104
104
|
begin
|
|
@@ -206,9 +206,9 @@ end
|
|
|
206
206
|
|
|
207
207
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
|
208
208
|
|
|
209
|
-
attribute_category =
|
|
209
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
210
210
|
|
|
211
|
-
attribute_name =
|
|
211
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
212
212
|
|
|
213
213
|
update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
|
214
214
|
|
data/docs/ContactsApi.md
CHANGED
|
@@ -116,9 +116,9 @@ end
|
|
|
116
116
|
|
|
117
117
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
118
118
|
|
|
119
|
-
attribute_category =
|
|
119
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
120
120
|
|
|
121
|
-
attribute_name =
|
|
121
|
+
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
|
122
122
|
|
|
123
123
|
create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
|
124
124
|
|
|
@@ -349,9 +349,9 @@ end
|
|
|
349
349
|
|
|
350
350
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
351
351
|
|
|
352
|
-
attribute_category =
|
|
352
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
353
353
|
|
|
354
|
-
attribute_name =
|
|
354
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
355
355
|
|
|
356
356
|
|
|
357
357
|
begin
|
|
@@ -408,7 +408,7 @@ end
|
|
|
408
408
|
|
|
409
409
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
410
410
|
|
|
411
|
-
email =
|
|
411
|
+
email = 'email_example' # String | Email (urlencoded) of the contact
|
|
412
412
|
|
|
413
413
|
|
|
414
414
|
begin
|
|
@@ -627,7 +627,7 @@ end
|
|
|
627
627
|
|
|
628
628
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
629
629
|
|
|
630
|
-
email =
|
|
630
|
+
email = 'email_example' # String | Email (urlencoded) of the contact OR its SMS attribute value
|
|
631
631
|
|
|
632
632
|
|
|
633
633
|
begin
|
|
@@ -684,7 +684,7 @@ end
|
|
|
684
684
|
|
|
685
685
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
686
686
|
|
|
687
|
-
email =
|
|
687
|
+
email = 'email_example' # String | Email address (urlencoded) of the contact
|
|
688
688
|
|
|
689
689
|
|
|
690
690
|
begin
|
|
@@ -744,7 +744,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
744
744
|
opts = {
|
|
745
745
|
limit: 50, # Integer | Number of documents per page
|
|
746
746
|
offset: 0, # Integer | Index of the first document of the page
|
|
747
|
-
modified_since: DateTime.parse(
|
|
747
|
+
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | 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.
|
|
748
748
|
}
|
|
749
749
|
|
|
750
750
|
begin
|
|
@@ -806,7 +806,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
|
806
806
|
list_id = 789 # Integer | Id of the list
|
|
807
807
|
|
|
808
808
|
opts = {
|
|
809
|
-
modified_since: DateTime.parse(
|
|
809
|
+
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
|
|
810
810
|
limit: 50, # Integer | Number of documents per page
|
|
811
811
|
offset: 0 # Integer | Index of the first document of the page
|
|
812
812
|
}
|
|
@@ -1343,9 +1343,9 @@ end
|
|
|
1343
1343
|
|
|
1344
1344
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1345
1345
|
|
|
1346
|
-
attribute_category =
|
|
1346
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
1347
1347
|
|
|
1348
|
-
attribute_name =
|
|
1348
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
1349
1349
|
|
|
1350
1350
|
update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
|
1351
1351
|
|
|
@@ -1405,7 +1405,7 @@ end
|
|
|
1405
1405
|
|
|
1406
1406
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1407
1407
|
|
|
1408
|
-
email =
|
|
1408
|
+
email = 'email_example' # String | Email (urlencoded) of the contact
|
|
1409
1409
|
|
|
1410
1410
|
update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
|
|
1411
1411
|
|
data/docs/CreateContact.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**email** | **String** | Email address of the user. Mandatory if \"
|
|
6
|
+
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {'SMS':'+91xxxxxxxxxx'} | [optional]
|
|
7
7
|
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
|
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
data/docs/CreateEmailCampaign.md
CHANGED
|
@@ -28,5 +28,8 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**split_rule** | **Integer** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
|
|
29
29
|
**winner_criteria** | **String** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
|
|
30
30
|
**winner_delay** | **Integer** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
|
|
31
|
+
**ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
|
|
32
|
+
**initial_quota** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
|
|
33
|
+
**increase_rate** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
|
31
34
|
|
|
32
35
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | Sender Name | [optional]
|
|
7
7
|
**email** | **String** | Sender email |
|
|
8
|
+
**id** | **Integer** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
|
|
7
7
|
**email** | **String** | Email of the sender |
|
|
8
|
+
**id** | **Integer** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
|
|
8
9
|
|
|
9
10
|
|
data/docs/CreateWebhook.md
CHANGED
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**url** | **String** | URL of the webhook |
|
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
|
8
8
|
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered |
|
|
9
|
-
**type** | **String** | Type of the webhook | [optional] [default to
|
|
9
|
+
**type** | **String** | Type of the webhook | [optional] [default to 'transactional']
|
|
10
10
|
|
|
11
11
|
|
data/docs/EmailCampaignsApi.md
CHANGED
|
@@ -7,9 +7,11 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
|
8
8
|
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
|
9
9
|
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
|
|
10
|
+
[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result
|
|
10
11
|
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
|
|
11
12
|
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
|
12
|
-
[**
|
|
13
|
+
[**get_shared_template_url**](EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
|
14
|
+
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
|
13
15
|
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
|
|
14
16
|
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
|
15
17
|
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
|
|
@@ -190,6 +192,65 @@ Name | Type | Description | Notes
|
|
|
190
192
|
|
|
191
193
|
|
|
192
194
|
|
|
195
|
+
# **get_ab_test_campaign_result**
|
|
196
|
+
> AbTestCampaignResult get_ab_test_campaign_result(campaign_id)
|
|
197
|
+
|
|
198
|
+
Get A/B test email campaign result
|
|
199
|
+
|
|
200
|
+
Obtain winning version of an A/B test email campaign
|
|
201
|
+
|
|
202
|
+
### Example
|
|
203
|
+
```ruby
|
|
204
|
+
# load the gem
|
|
205
|
+
require 'sib-api-v3-sdk'
|
|
206
|
+
# setup authorization
|
|
207
|
+
SibApiV3Sdk.configure do |config|
|
|
208
|
+
# Configure API key authorization: api-key
|
|
209
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
211
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
212
|
+
|
|
213
|
+
# Configure API key authorization: partner-key
|
|
214
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
215
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
216
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
|
220
|
+
|
|
221
|
+
campaign_id = 789 # Integer | Id of the A/B test campaign
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
begin
|
|
225
|
+
#Get A/B test email campaign result
|
|
226
|
+
result = api_instance.get_ab_test_campaign_result(campaign_id)
|
|
227
|
+
p result
|
|
228
|
+
rescue SibApiV3Sdk::ApiError => e
|
|
229
|
+
puts "Exception when calling EmailCampaignsApi->get_ab_test_campaign_result: #{e}"
|
|
230
|
+
end
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Parameters
|
|
234
|
+
|
|
235
|
+
Name | Type | Description | Notes
|
|
236
|
+
------------- | ------------- | ------------- | -------------
|
|
237
|
+
**campaign_id** | **Integer**| Id of the A/B test campaign |
|
|
238
|
+
|
|
239
|
+
### Return type
|
|
240
|
+
|
|
241
|
+
[**AbTestCampaignResult**](AbTestCampaignResult.md)
|
|
242
|
+
|
|
243
|
+
### Authorization
|
|
244
|
+
|
|
245
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
246
|
+
|
|
247
|
+
### HTTP request headers
|
|
248
|
+
|
|
249
|
+
- **Content-Type**: application/json
|
|
250
|
+
- **Accept**: application/json
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
193
254
|
# **get_email_campaign**
|
|
194
255
|
> GetEmailCampaign get_email_campaign(campaign_id)
|
|
195
256
|
|
|
@@ -272,10 +333,10 @@ end
|
|
|
272
333
|
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
|
273
334
|
|
|
274
335
|
opts = {
|
|
275
|
-
type:
|
|
276
|
-
status:
|
|
277
|
-
start_date: DateTime.parse(
|
|
278
|
-
end_date: DateTime.parse(
|
|
336
|
+
type: 'type_example', # String | Filter on the type of the campaigns
|
|
337
|
+
status: 'status_example', # String | Filter on the status of the campaign
|
|
338
|
+
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
339
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
279
340
|
limit: 500, # Integer | Number of documents per page
|
|
280
341
|
offset: 0 # Integer | Index of the first document in the page
|
|
281
342
|
}
|
|
@@ -315,10 +376,69 @@ Name | Type | Description | Notes
|
|
|
315
376
|
|
|
316
377
|
|
|
317
378
|
|
|
379
|
+
# **get_shared_template_url**
|
|
380
|
+
> GetSharedTemplateUrl get_shared_template_url(campaign_id)
|
|
381
|
+
|
|
382
|
+
Get a shared template url
|
|
383
|
+
|
|
384
|
+
Get a unique URL to share & import an email template from one Sendinblue account to another.
|
|
385
|
+
|
|
386
|
+
### Example
|
|
387
|
+
```ruby
|
|
388
|
+
# load the gem
|
|
389
|
+
require 'sib-api-v3-sdk'
|
|
390
|
+
# setup authorization
|
|
391
|
+
SibApiV3Sdk.configure do |config|
|
|
392
|
+
# Configure API key authorization: api-key
|
|
393
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
394
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
395
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
396
|
+
|
|
397
|
+
# Configure API key authorization: partner-key
|
|
398
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
399
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
400
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
|
404
|
+
|
|
405
|
+
campaign_id = 789 # Integer | Id of the campaign or template
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
begin
|
|
409
|
+
#Get a shared template url
|
|
410
|
+
result = api_instance.get_shared_template_url(campaign_id)
|
|
411
|
+
p result
|
|
412
|
+
rescue SibApiV3Sdk::ApiError => e
|
|
413
|
+
puts "Exception when calling EmailCampaignsApi->get_shared_template_url: #{e}"
|
|
414
|
+
end
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
|
|
419
|
+
Name | Type | Description | Notes
|
|
420
|
+
------------- | ------------- | ------------- | -------------
|
|
421
|
+
**campaign_id** | **Integer**| Id of the campaign or template |
|
|
422
|
+
|
|
423
|
+
### Return type
|
|
424
|
+
|
|
425
|
+
[**GetSharedTemplateUrl**](GetSharedTemplateUrl.md)
|
|
426
|
+
|
|
427
|
+
### Authorization
|
|
428
|
+
|
|
429
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
430
|
+
|
|
431
|
+
### HTTP request headers
|
|
432
|
+
|
|
433
|
+
- **Content-Type**: application/json
|
|
434
|
+
- **Accept**: application/json
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
318
438
|
# **send_email_campaign_now**
|
|
319
439
|
> send_email_campaign_now(campaign_id)
|
|
320
440
|
|
|
321
|
-
Send an email campaign
|
|
441
|
+
Send an email campaign immediately, based on campaignId
|
|
322
442
|
|
|
323
443
|
### Example
|
|
324
444
|
```ruby
|
|
@@ -343,7 +463,7 @@ campaign_id = 789 # Integer | Id of the campaign
|
|
|
343
463
|
|
|
344
464
|
|
|
345
465
|
begin
|
|
346
|
-
#Send an email campaign
|
|
466
|
+
#Send an email campaign immediately, based on campaignId
|
|
347
467
|
api_instance.send_email_campaign_now(campaign_id)
|
|
348
468
|
rescue SibApiV3Sdk::ApiError => e
|
|
349
469
|
puts "Exception when calling EmailCampaignsApi->send_email_campaign_now: #{e}"
|