sib-api-v3-sdk 5.2.5 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +100 -75
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +2 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +136 -73
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +4 -1
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +17 -17
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +3 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +158 -91
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SendEmail.md +3 -3
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +2 -2
- data/docs/SendersApi.md +8 -8
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +4 -1
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UpdateWebhook.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +20 -3
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +62 -73
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +17 -26
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +53 -54
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +9 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +20 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +10 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +4 -33
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +10 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +11 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +78 -10
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**notify_url** | **String** | Webhook called once the export process is finished | [optional]
|
6
|
+
**notify_url** | **String** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional]
|
7
7
|
**recipients_type** | **String** | Type of recipients to export for a campaign |
|
8
8
|
|
9
9
|
|
data/docs/FoldersApi.md
CHANGED
@@ -6,10 +6,10 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
8
8
|
[**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
9
|
-
[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
10
|
-
[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
11
|
-
[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all
|
12
|
-
[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
9
|
+
[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
10
|
+
[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
11
|
+
[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
12
|
+
[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
13
13
|
|
14
14
|
|
15
15
|
# **create_folder**
|
@@ -128,7 +128,7 @@ nil (empty response body)
|
|
128
128
|
# **get_folder**
|
129
129
|
> GetFolder get_folder(folder_id)
|
130
130
|
|
131
|
-
Returns folder details
|
131
|
+
Returns a folder's details
|
132
132
|
|
133
133
|
### Example
|
134
134
|
```ruby
|
@@ -153,7 +153,7 @@ folder_id = 789 # Integer | id of the folder
|
|
153
153
|
|
154
154
|
|
155
155
|
begin
|
156
|
-
#Returns folder details
|
156
|
+
#Returns a folder's details
|
157
157
|
result = api_instance.get_folder(folder_id)
|
158
158
|
p result
|
159
159
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -185,7 +185,7 @@ Name | Type | Description | Notes
|
|
185
185
|
# **get_folder_lists**
|
186
186
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
187
187
|
|
188
|
-
Get
|
188
|
+
Get lists in a folder
|
189
189
|
|
190
190
|
### Example
|
191
191
|
```ruby
|
@@ -214,7 +214,7 @@ opts = {
|
|
214
214
|
}
|
215
215
|
|
216
216
|
begin
|
217
|
-
#Get
|
217
|
+
#Get lists in a folder
|
218
218
|
result = api_instance.get_folder_lists(folder_id, opts)
|
219
219
|
p result
|
220
220
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -248,7 +248,7 @@ Name | Type | Description | Notes
|
|
248
248
|
# **get_folders**
|
249
249
|
> GetFolders get_folders(limit, offset)
|
250
250
|
|
251
|
-
Get all
|
251
|
+
Get all folders
|
252
252
|
|
253
253
|
### Example
|
254
254
|
```ruby
|
@@ -275,7 +275,7 @@ offset = 0 # Integer | Index of the first document of the page
|
|
275
275
|
|
276
276
|
|
277
277
|
begin
|
278
|
-
#Get all
|
278
|
+
#Get all folders
|
279
279
|
result = api_instance.get_folders(limit, offset)
|
280
280
|
p result
|
281
281
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -308,7 +308,7 @@ Name | Type | Description | Notes
|
|
308
308
|
# **update_folder**
|
309
309
|
> update_folder(folder_id, update_folder)
|
310
310
|
|
311
|
-
Update a
|
311
|
+
Update a folder
|
312
312
|
|
313
313
|
### Example
|
314
314
|
```ruby
|
@@ -335,7 +335,7 @@ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name
|
|
335
335
|
|
336
336
|
|
337
337
|
begin
|
338
|
-
#Update a
|
338
|
+
#Update a folder
|
339
339
|
api_instance.update_folder(folder_id, update_folder)
|
340
340
|
rescue SibApiV3Sdk::ApiError => e
|
341
341
|
puts "Exception when calling FoldersApi->update_folder: #{e}"
|
data/docs/GetAggregatedReport.md
CHANGED
@@ -3,18 +3,18 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**range** | **String** | Time frame of the report |
|
7
|
-
**requests** | **Integer** | Number of requests for the timeframe |
|
8
|
-
**delivered** | **Integer** | Number of delivered emails for the timeframe |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the timeframe |
|
11
|
-
**clicks** | **Integer** | Number of clicks for the timeframe |
|
12
|
-
**unique_clicks** | **Integer** | Number of unique clicks for the timeframe |
|
13
|
-
**opens** | **Integer** | Number of openings for the timeframe |
|
14
|
-
**unique_opens** | **Integer** | Number of unique openings for the timeframe |
|
15
|
-
**spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe |
|
16
|
-
**blocked** | **Integer** | Number of blocked contact emails for the timeframe |
|
17
|
-
**invalid** | **Integer** | Number of invalid emails for the timeframe |
|
18
|
-
**unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe |
|
6
|
+
**range** | **String** | Time frame of the report | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the timeframe | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered emails for the timeframe | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional]
|
11
|
+
**clicks** | **Integer** | Number of clicks for the timeframe | [optional]
|
12
|
+
**unique_clicks** | **Integer** | Number of unique clicks for the timeframe | [optional]
|
13
|
+
**opens** | **Integer** | Number of openings for the timeframe | [optional]
|
14
|
+
**unique_opens** | **Integer** | Number of unique openings for the timeframe | [optional]
|
15
|
+
**spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe | [optional]
|
16
|
+
**blocked** | **Integer** | Number of blocked contact emails for the timeframe | [optional]
|
17
|
+
**invalid** | **Integer** | Number of invalid emails for the timeframe | [optional]
|
18
|
+
**unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe | [optional]
|
19
19
|
|
20
20
|
|
data/docs/GetCampaignStats.md
CHANGED
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
|
16
16
|
**viewed** | **Integer** | Number of openings for the campaign |
|
17
17
|
**deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
|
18
|
+
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
18
19
|
|
19
20
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# SibApiV3Sdk::GetChildAccountCreationStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**child_account_created** | **BOOLEAN** | Status of child account creation whether it is successfully created (exists) or not. |
|
7
|
+
|
8
|
+
|
data/docs/GetChildrenList.md
CHANGED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::GetDeviceBrowserStats
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**clickers** | **Integer** | Number of total clicks for the campaign using the particular browser |
|
7
|
+
**unique_clicks** | **Integer** | Number of unique clicks for the campaign using the particular browser |
|
8
|
+
**viewed** | **Integer** | Number of openings for the campaign using the particular browser |
|
9
|
+
**unique_views** | **Integer** | Number of unique openings for the campaign using the particular browser |
|
10
|
+
|
11
|
+
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
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
33
|
**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
|
+
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
34
35
|
**recipients** | **Object** | |
|
35
36
|
**statistics** | **Object** | |
|
36
37
|
|
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
|
|
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
33
|
**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
|
+
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
34
35
|
|
35
36
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Sender name of the campaign | [optional]
|
7
7
|
**email** | **String** | Sender email of the campaign | [optional]
|
8
|
+
**id** | **String** | Sender id of the campaign | [optional]
|
8
9
|
|
9
10
|
|
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**remaining** | **Integer** | Number of remaning emails to send |
|
10
10
|
**links_stats** | **Object** | Statistics about the number of clicks for the links |
|
11
11
|
**stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | |
|
12
|
+
**stats_by_device** | [**GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices |
|
13
|
+
**stats_by_browser** | [**GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers |
|
12
14
|
|
13
15
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**event_time** | **DateTime** | UTC date-time of the event |
|
7
|
-
**ip** | **String** | IP from which the user has been unsubscribed |
|
7
|
+
**ip** | **String** | IP from which the user has been unsubscribed | [optional]
|
8
8
|
|
9
9
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
7
|
**event_time** | **DateTime** | UTC date-time of the event |
|
8
|
-
**ip** | **String** | IP from which the user has unsubscribed |
|
8
|
+
**ip** | **String** | IP from which the user has unsubscribed | [optional]
|
9
9
|
|
10
10
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# SibApiV3Sdk::GetSharedTemplateUrl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**shared_url** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. |
|
7
|
+
|
8
|
+
|
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**html_content** | **String** | HTML content of the template |
|
16
16
|
**created_at** | **DateTime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
17
17
|
**modified_at** | **DateTime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
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]
|
18
19
|
|
19
20
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | From email for the template | [optional]
|
7
7
|
**email** | **String** | From email for the template | [optional]
|
8
|
+
**id** | **String** | Sender id of the template | [optional]
|
8
9
|
|
9
10
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::GetStatsByDevice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**desktop** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional]
|
7
|
+
**mobile** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional]
|
8
|
+
**tablet** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional]
|
9
|
+
**unknown** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacBlockedContacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | Count of blocked or unsubscribed contact | [optional]
|
7
|
+
**contacts** | [**Array<GetTransacBlockedContactsContacts>**](GetTransacBlockedContactsContacts.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacBlockedContactsContacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address of the blocked or unsubscribed contact |
|
7
|
+
**sender_email** | **String** | Sender email address of the blocked or unsubscribed contact |
|
8
|
+
**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
|
9
|
+
**blocked_at** | **DateTime** | Date when the contact was blocked or unsubscribed on |
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacBlockedContactsReason
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional]
|
7
|
+
**message** | **String** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional]
|
8
|
+
|
9
|
+
|
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
|
|
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
11
|
**date** | **DateTime** | Date on which transactional email was sent |
|
12
|
+
**from** | **String** | Email address of the sender from which the email was sent | [optional]
|
13
|
+
**tags** | **Array<String>** | Tags used for your email | [optional]
|
12
14
|
|
13
15
|
|
data/docs/ListsApi.md
CHANGED
@@ -7,11 +7,11 @@ Method | HTTP request | Description
|
|
7
7
|
[**add_contact_to_list**](ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8
8
|
[**create_list**](ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
9
9
|
[**delete_list**](ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
10
|
-
[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
11
|
-
[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
12
|
-
[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
10
|
+
[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
11
|
+
[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
12
|
+
[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
13
13
|
[**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
14
|
-
[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
14
|
+
[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
15
15
|
[**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
16
16
|
|
17
17
|
|
@@ -41,7 +41,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
41
41
|
|
42
42
|
list_id = 789 # Integer | Id of the list
|
43
43
|
|
44
|
-
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
|
44
|
+
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
|
45
45
|
|
46
46
|
|
47
47
|
begin
|
@@ -58,7 +58,7 @@ end
|
|
58
58
|
Name | Type | Description | Notes
|
59
59
|
------------- | ------------- | ------------- | -------------
|
60
60
|
**list_id** | **Integer**| Id of the list |
|
61
|
-
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
|
61
|
+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
62
62
|
|
63
63
|
### Return type
|
64
64
|
|
@@ -191,7 +191,7 @@ nil (empty response body)
|
|
191
191
|
# **get_contacts_from_list**
|
192
192
|
> GetContacts get_contacts_from_list(list_id, opts)
|
193
193
|
|
194
|
-
Get
|
194
|
+
Get contacts in a list
|
195
195
|
|
196
196
|
### Example
|
197
197
|
```ruby
|
@@ -215,13 +215,13 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
215
215
|
list_id = 789 # Integer | Id of the list
|
216
216
|
|
217
217
|
opts = {
|
218
|
-
modified_since: DateTime.parse(
|
218
|
+
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.
|
219
219
|
limit: 50, # Integer | Number of documents per page
|
220
220
|
offset: 0 # Integer | Index of the first document of the page
|
221
221
|
}
|
222
222
|
|
223
223
|
begin
|
224
|
-
#Get
|
224
|
+
#Get contacts in a list
|
225
225
|
result = api_instance.get_contacts_from_list(list_id, opts)
|
226
226
|
p result
|
227
227
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -256,7 +256,7 @@ Name | Type | Description | Notes
|
|
256
256
|
# **get_folder_lists**
|
257
257
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
258
258
|
|
259
|
-
Get
|
259
|
+
Get lists in a folder
|
260
260
|
|
261
261
|
### Example
|
262
262
|
```ruby
|
@@ -285,7 +285,7 @@ opts = {
|
|
285
285
|
}
|
286
286
|
|
287
287
|
begin
|
288
|
-
#Get
|
288
|
+
#Get lists in a folder
|
289
289
|
result = api_instance.get_folder_lists(folder_id, opts)
|
290
290
|
p result
|
291
291
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -319,7 +319,7 @@ Name | Type | Description | Notes
|
|
319
319
|
# **get_list**
|
320
320
|
> GetExtendedList get_list(list_id)
|
321
321
|
|
322
|
-
Get
|
322
|
+
Get a list's details
|
323
323
|
|
324
324
|
### Example
|
325
325
|
```ruby
|
@@ -344,7 +344,7 @@ list_id = 789 # Integer | Id of the list
|
|
344
344
|
|
345
345
|
|
346
346
|
begin
|
347
|
-
#Get
|
347
|
+
#Get a list's details
|
348
348
|
result = api_instance.get_list(list_id)
|
349
349
|
p result
|
350
350
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -436,7 +436,7 @@ Name | Type | Description | Notes
|
|
436
436
|
# **remove_contact_from_list**
|
437
437
|
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
438
438
|
|
439
|
-
|
439
|
+
Delete a contact from a list
|
440
440
|
|
441
441
|
### Example
|
442
442
|
```ruby
|
@@ -459,11 +459,11 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
459
459
|
|
460
460
|
list_id = 789 # Integer | Id of the list
|
461
461
|
|
462
|
-
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails
|
462
|
+
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
|
463
463
|
|
464
464
|
|
465
465
|
begin
|
466
|
-
#
|
466
|
+
#Delete a contact from a list
|
467
467
|
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
468
468
|
p result
|
469
469
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -476,7 +476,7 @@ end
|
|
476
476
|
Name | Type | Description | Notes
|
477
477
|
------------- | ------------- | ------------- | -------------
|
478
478
|
**list_id** | **Integer**| Id of the list |
|
479
|
-
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails
|
479
|
+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
480
480
|
|
481
481
|
### Return type
|
482
482
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**success** | **Array<String>** | | [optional]
|
7
7
|
**failure** | **Array<String>** | | [optional]
|
8
8
|
**total** | **Integer** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional]
|
9
|
+
**process_id** | **Integer** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional]
|
9
10
|
|
10
11
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**sms** | **
|
7
|
-
**email** | **
|
6
|
+
**sms** | **Float** | SMS Credits remaining for child account |
|
7
|
+
**email** | **Float** | Email Credits remaining for child account |
|
8
8
|
|
9
9
|
|