sib-api-v3-sdk 2.1.5 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -6
- data/docs/ContactsApi.md +4 -4
- data/docs/CreateContact.md +1 -0
- data/docs/CreateEmailCampaign.md +4 -4
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplate.md +3 -3
- data/docs/EmailCampaignsApi.md +10 -10
- data/docs/GetAccount.md +2 -2
- data/docs/GetAccountRelay.md +1 -1
- data/docs/GetCampaignRecipients.md +2 -2
- data/docs/GetEmailCampaign.md +1 -1
- data/docs/GetExtendedCampaignOverview.md +1 -1
- data/docs/GetExtendedClient.md +1 -1
- data/docs/GetExtendedContactDetails.md +1 -1
- data/docs/GetReportsReports.md +0 -1
- data/docs/GetSmsEventReportEvents.md +2 -2
- data/docs/GetSmtpTemplateOverview.md +1 -1
- data/docs/GetTransacSmsReportReports.md +0 -1
- data/docs/ListsApi.md +2 -2
- data/docs/PostContactInfo.md +1 -1
- data/docs/RemainingCreditModel.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/SMSCampaignsApi.md +7 -7
- data/docs/SendEmail.md +2 -2
- data/docs/SendReport.md +1 -1
- data/docs/SendSmtpEmail.md +2 -2
- data/docs/UpdateContact.md +1 -0
- data/docs/UpdateEmailCampaign.md +3 -3
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplate.md +2 -2
- data/lib/sib-api-v3-sdk/api/account_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +14 -14
- data/lib/sib-api-v3-sdk/api/folders_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/lists_api.rb +3 -3
- data/lib/sib-api-v3-sdk/api/process_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +9 -9
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api_client.rb +2 -2
- data/lib/sib-api-v3-sdk/api_error.rb +1 -1
- data/lib/sib-api-v3-sdk/configuration.rb +1 -1
- data/lib/sib-api-v3-sdk/models/add_credits.rb +2 -2
- data/lib/sib-api-v3-sdk/models/add_remove_contact_to_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_child.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_contact.rb +18 -6
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +10 -5
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_model.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +3 -3
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +9 -4
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +2 -2
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +2 -2
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +2 -2
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +2 -2
- data/lib/sib-api-v3-sdk/models/error_model.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_account.rb +12 -2
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +7 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +4 -6
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_ips.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_client.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +3 -3
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +7 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +3 -3
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +7 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +8 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_folder.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_folders.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_ip.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_ips.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_lists.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_process.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_reports.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -18
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +2 -12
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +7 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -18
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +2 -2
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +2 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +7 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +2 -2
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +2 -2
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +2 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +12 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +2 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +2 -2
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +2 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +2 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +2 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -3
- data/lib/sib-api-v3-sdk/models/send_email.rb +6 -6
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_report.rb +7 -2
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_sms.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +9 -4
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_child.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +19 -7
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +5 -5
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +3 -3
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +4 -4
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +2 -2
- data/lib/sib-api-v3-sdk/version.rb +2 -2
- data/lib/sib-api-v3-sdk.rb +1 -3
- data/sib-api-v3-sdk.gemspec +1 -1
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +3 -3
- data/spec/api/email_campaigns_api_spec.rb +5 -5
- data/spec/api/folders_api_spec.rb +1 -1
- data/spec/api/lists_api_spec.rb +2 -2
- data/spec/api/process_api_spec.rb +1 -1
- data/spec/api/reseller_api_spec.rb +1 -1
- data/spec/api/senders_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +4 -4
- data/spec/api/smtp_api_spec.rb +1 -1
- data/spec/api/transactional_sms_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_credits_spec.rb +1 -1
- data/spec/models/add_remove_contact_to_list_spec.rb +1 -1
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +7 -1
- data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +1 -1
- data/spec/models/create_smtp_email_spec.rb +1 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +1 -1
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +1 -1
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_campaign_overview_spec.rb +1 -1
- data/spec/models/get_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_spec.rb +1 -1
- data/spec/models/get_child_info_credits_spec.rb +1 -1
- data/spec/models/get_child_info_ips_spec.rb +1 -1
- data/spec/models/get_child_info_spec.rb +1 -1
- data/spec/models/get_child_info_statistics_spec.rb +1 -1
- data/spec/models/get_children_list_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +1 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +1 -1
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_links_stats_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +1 -1
- data/spec/models/get_folder_lists_spec.rb +1 -1
- data/spec/models/get_folder_spec.rb +1 -1
- data/spec/models/get_folders_spec.rb +1 -1
- data/spec/models/get_ip_from_sender_spec.rb +1 -1
- data/spec/models/get_ip_spec.rb +1 -1
- data/spec/models/get_ips_from_sender_spec.rb +1 -1
- data/spec/models/get_ips_spec.rb +1 -1
- data/spec/models/get_list_spec.rb +1 -1
- data/spec/models/get_lists_spec.rb +1 -1
- data/spec/models/get_process_spec.rb +1 -1
- data/spec/models/get_processes_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +1 -7
- data/spec/models/get_reports_spec.rb +1 -1
- data/spec/models/get_senders_list_ips_spec.rb +1 -1
- data/spec/models/get_senders_list_senders_spec.rb +1 -1
- data/spec/models/get_senders_list_spec.rb +1 -1
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
- data/spec/models/get_sms_campaign_spec.rb +1 -1
- data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
- data/spec/models/get_sms_campaigns_spec.rb +1 -1
- data/spec/models/get_sms_event_report_events_spec.rb +1 -1
- data/spec/models/get_sms_event_report_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_spec.rb +1 -1
- data/spec/models/get_smtp_templates_spec.rb +1 -1
- data/spec/models/get_stats_by_domain_spec.rb +1 -1
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_reports_spec.rb +1 -7
- data/spec/models/get_transac_sms_report_spec.rb +1 -1
- data/spec/models/get_webhook_spec.rb +1 -1
- data/spec/models/get_webhooks_spec.rb +1 -1
- data/spec/models/manage_ip_spec.rb +1 -1
- data/spec/models/post_contact_info_contacts_spec.rb +1 -1
- data/spec/models/post_contact_info_spec.rb +1 -1
- data/spec/models/post_send_failed_spec.rb +1 -1
- data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
- data/spec/models/remaining_credit_model_child_spec.rb +1 -1
- data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
- data/spec/models/remaining_credit_model_spec.rb +1 -1
- data/spec/models/remove_credits_spec.rb +1 -1
- data/spec/models/request_contact_export_spec.rb +1 -1
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +1 -1
- data/spec/models/request_sms_recipient_export_spec.rb +7 -7
- data/spec/models/send_email_attachment_spec.rb +1 -1
- data/spec/models/send_email_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -1
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +1 -1
- data/spec/models/send_smtp_email_spec.rb +1 -1
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_template_email_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +1 -1
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +1 -1
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +7 -1
- data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +1 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_webhook_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -10
- data/docs/GetCampaignRecipientsExclusionLists.md +0 -9
- data/docs/GetCampaignRecipientsLists.md +0 -9
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients_exclusion_lists.rb +0 -209
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients_lists.rb +0 -209
- data/spec/models/get_campaign_recipients_exclusion_lists_spec.rb +0 -48
- data/spec/models/get_campaign_recipients_lists_spec.rb +0 -48
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: efff1dd73196b8ddd08916617810d5d4af40eed5
|
4
|
+
data.tar.gz: 21fea8576af24a4c93d5fb62fe4e34c37aa59dfa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 254933bf57f20cb5ab08ab9ab742d3756f27e1cca0e8d4237a61d24f0c5db71f7b5238c7486a2bc1f6abf691945f0fa94141eef9bfae7b8c5b578658635ba460
|
7
|
+
data.tar.gz: 4f4eaed122bef9fbbd08854df5734939cbb78d87420fca372ff9ff04d95a200ae604d4d0023526a5ff8762d4b91f3847f2cc6d93d31e42af829493e47021f4b1
|
data/README.md
CHANGED
@@ -110,7 +110,7 @@ Class | Method | HTTP request | Description
|
|
110
110
|
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
|
111
111
|
*SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
112
112
|
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
113
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
113
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
114
114
|
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
|
115
115
|
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
|
116
116
|
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
@@ -118,7 +118,7 @@ Class | Method | HTTP request | Description
|
|
118
118
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
|
119
119
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
120
120
|
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
|
121
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
121
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
|
122
122
|
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
123
123
|
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
124
124
|
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
@@ -146,7 +146,7 @@ Class | Method | HTTP request | Description
|
|
146
146
|
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
147
147
|
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
|
148
148
|
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
149
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**
|
149
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
|
150
150
|
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
151
151
|
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
|
152
152
|
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
|
@@ -221,8 +221,6 @@ Class | Method | HTTP request | Description
|
|
221
221
|
- [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
|
222
222
|
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
|
223
223
|
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
|
224
|
-
- [SibApiV3Sdk::GetCampaignRecipientsExclusionLists](docs/GetCampaignRecipientsExclusionLists.md)
|
225
|
-
- [SibApiV3Sdk::GetCampaignRecipientsLists](docs/GetCampaignRecipientsLists.md)
|
226
224
|
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
|
227
225
|
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
|
228
226
|
- [SibApiV3Sdk::GetChildInfoCredits](docs/GetChildInfoCredits.md)
|
@@ -295,7 +293,7 @@ Class | Method | HTTP request | Description
|
|
295
293
|
- [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
|
296
294
|
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
|
297
295
|
- [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
|
298
|
-
- [SibApiV3Sdk::
|
296
|
+
- [SibApiV3Sdk::RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
|
299
297
|
- [SibApiV3Sdk::SendEmail](docs/SendEmail.md)
|
300
298
|
- [SibApiV3Sdk::SendEmailAttachment](docs/SendEmailAttachment.md)
|
301
299
|
- [SibApiV3Sdk::SendReport](docs/SendReport.md)
|
data/docs/ContactsApi.md
CHANGED
@@ -627,7 +627,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
627
627
|
opts = {
|
628
628
|
limit: 50, # Integer | Number of documents per page
|
629
629
|
offset: 0, # Integer | Index of the first document of the page
|
630
|
-
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)
|
630
|
+
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.
|
631
631
|
}
|
632
632
|
|
633
633
|
begin
|
@@ -645,7 +645,7 @@ Name | Type | Description | Notes
|
|
645
645
|
------------- | ------------- | ------------- | -------------
|
646
646
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
647
647
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
648
|
-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
648
|
+
**modified_since** | **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. | [optional]
|
649
649
|
|
650
650
|
### Return type
|
651
651
|
|
@@ -684,7 +684,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
684
684
|
list_id = 789 # Integer | Id of the list
|
685
685
|
|
686
686
|
opts = {
|
687
|
-
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)
|
687
|
+
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.
|
688
688
|
limit: 50, # Integer | Number of documents per page
|
689
689
|
offset: 0 # Integer | Index of the first document of the page
|
690
690
|
}
|
@@ -703,7 +703,7 @@ end
|
|
703
703
|
Name | Type | Description | Notes
|
704
704
|
------------- | ------------- | ------------- | -------------
|
705
705
|
**list_id** | **Integer**| Id of the list |
|
706
|
-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
706
|
+
**modified_since** | **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. | [optional]
|
707
707
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
708
708
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
709
709
|
|
data/docs/CreateContact.md
CHANGED
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
11
11
|
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
|
12
|
+
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
|
12
13
|
|
13
14
|
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -4,16 +4,16 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**tag** | **String** | Tag of the campaign | [optional]
|
7
|
-
**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
|
7
|
+
**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
|
8
8
|
**name** | **String** | Name of the campaign |
|
9
9
|
**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
|
10
10
|
**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
|
11
|
-
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
11
|
+
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
12
12
|
**subject** | **String** | Subject of the campaign |
|
13
13
|
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
|
14
|
-
**to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use
|
14
|
+
**to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database | [optional]
|
15
15
|
**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
|
16
|
-
**attachment_url** | **String** | Absolute url of the attachment (no local file).
|
16
|
+
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
17
17
|
**inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
|
18
18
|
**mirror_active** | **BOOLEAN** | Use true to enable the mirror link | [optional]
|
19
19
|
**recurring** | **BOOLEAN** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]
|
data/docs/CreateSmsCampaign.md
CHANGED
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
7
7
|
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
|
8
8
|
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional]
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
|
-
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
10
|
+
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
11
11
|
|
12
12
|
|
data/docs/CreateSmtpTemplate.md
CHANGED
@@ -4,14 +4,14 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**tag** | **String** | Tag of the template | [optional]
|
7
|
-
**sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | |
|
7
|
+
**sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | |
|
8
8
|
**template_name** | **String** | Name of the template |
|
9
9
|
**html_content** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional]
|
10
10
|
**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
|
11
11
|
**subject** | **String** | Subject of the template |
|
12
12
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
13
|
-
**to_field** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add
|
14
|
-
**attachment_url** | **String** | Absolute url of the attachment (no local file).
|
13
|
+
**to_field** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account | [optional]
|
14
|
+
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
15
15
|
**is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
|
16
16
|
|
17
17
|
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
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
10
|
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
|
11
11
|
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
|
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
13
13
|
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
|
14
14
|
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
15
15
|
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
|
16
|
-
[**
|
16
|
+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
|
17
17
|
|
18
18
|
|
19
19
|
# **create_email_campaign**
|
@@ -68,8 +68,8 @@ Name | Type | Description | Notes
|
|
68
68
|
|
69
69
|
|
70
70
|
|
71
|
-
# **
|
72
|
-
>
|
71
|
+
# **delete_email_campaign**
|
72
|
+
> delete_email_campaign(campaign_id)
|
73
73
|
|
74
74
|
Delete an email campaign
|
75
75
|
|
@@ -92,9 +92,9 @@ campaign_id = 789 # Integer | id of the campaign
|
|
92
92
|
|
93
93
|
begin
|
94
94
|
#Delete an email campaign
|
95
|
-
api_instance.
|
95
|
+
api_instance.delete_email_campaign(campaign_id)
|
96
96
|
rescue SibApiV3Sdk::ApiError => e
|
97
|
-
puts "Exception when calling EmailCampaignsApi->
|
97
|
+
puts "Exception when calling EmailCampaignsApi->delete_email_campaign: #{e}"
|
98
98
|
end
|
99
99
|
```
|
100
100
|
|
@@ -501,8 +501,8 @@ nil (empty response body)
|
|
501
501
|
|
502
502
|
|
503
503
|
|
504
|
-
# **
|
505
|
-
>
|
504
|
+
# **update_email_campaign**
|
505
|
+
> update_email_campaign(campaign_id, email_campaign)
|
506
506
|
|
507
507
|
Update a campaign
|
508
508
|
|
@@ -527,9 +527,9 @@ email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Va
|
|
527
527
|
|
528
528
|
begin
|
529
529
|
#Update a campaign
|
530
|
-
api_instance.
|
530
|
+
api_instance.update_email_campaign(campaign_id, email_campaign)
|
531
531
|
rescue SibApiV3Sdk::ApiError => e
|
532
|
-
puts "Exception when calling EmailCampaignsApi->
|
532
|
+
puts "Exception when calling EmailCampaignsApi->update_email_campaign: #{e}"
|
533
533
|
end
|
534
534
|
```
|
535
535
|
|
data/docs/GetAccount.md
CHANGED
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**first_name** | **String** | First Name |
|
8
8
|
**last_name** | **String** | Last Name |
|
9
9
|
**company_name** | **String** | Name of the company |
|
10
|
-
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
10
|
+
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
11
11
|
**plan** | [**Array<GetAccountPlan>**](GetAccountPlan.md) | Information about your plans and credits |
|
12
|
-
**relay** | [**GetAccountRelay**](GetAccountRelay.md) | |
|
12
|
+
**relay** | [**GetAccountRelay**](GetAccountRelay.md) | |
|
13
13
|
**marketing_automation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional]
|
14
14
|
|
15
15
|
|
data/docs/GetAccountRelay.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**enabled** | **BOOLEAN** | Status of your SMTP Account (true=Enabled, false=Disabled) |
|
7
|
-
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | |
|
7
|
+
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | |
|
8
8
|
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**lists** |
|
7
|
-
**exclusion_lists** |
|
6
|
+
**lists** | **Array<Integer>** | |
|
7
|
+
**exclusion_lists** | **Array<Integer>** | |
|
8
8
|
|
9
9
|
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
|
13
13
|
**header** | **String** | Header of the campaign |
|
14
14
|
**footer** | **String** | Footer of the campaign |
|
15
|
-
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
15
|
+
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
16
16
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
17
17
|
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
18
18
|
**html_content** | **String** | HTML content of the campaign |
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
|
13
13
|
**header** | **String** | Header of the campaign |
|
14
14
|
**footer** | **String** | Footer of the campaign |
|
15
|
-
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
15
|
+
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
16
16
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
17
17
|
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
18
18
|
**html_content** | **String** | HTML content of the campaign |
|
data/docs/GetExtendedClient.md
CHANGED
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
7
7
|
**first_name** | **String** | First Name |
|
8
8
|
**last_name** | **String** | Last Name |
|
9
9
|
**company_name** | **String** | Name of the company |
|
10
|
-
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
10
|
+
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
|
11
11
|
|
12
12
|
|
@@ -11,6 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**list_ids** | **Array<Integer>** | |
|
12
12
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
13
13
|
**attributes** | **Hash<String, String>** | |
|
14
|
-
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
|
14
|
+
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
|
15
15
|
|
16
16
|
|
data/docs/GetReportsReports.md
CHANGED
@@ -4,7 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**date** | **Date** | Date of the statistics |
|
7
|
-
**tag** | **String** | Reminder of the specified tag (only available if a specific tag has been specified in the request) |
|
8
7
|
**requests** | **Integer** | Number of requests for the date |
|
9
8
|
**delivered** | **Integer** | Number of delivered emails for the date |
|
10
9
|
**hard_bounces** | **Integer** | Number of hardbounces for the date |
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**date** | **Date** | Date on which the event has been generated |
|
8
8
|
**message_id** | **String** | Message ID which generated the event |
|
9
9
|
**event** | **String** | Event which occurred |
|
10
|
-
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) |
|
10
|
+
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
11
11
|
**reply** | **String** | | [optional]
|
12
|
-
**tag** | **String** | Tag of the SMS which generated the event |
|
12
|
+
**tag** | **String** | Tag of the SMS which generated the event | [optional]
|
13
13
|
|
14
14
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**subject** | **String** | Subject of the template |
|
9
9
|
**is_active** | **BOOLEAN** | Status of template (true=active, false=inactive) |
|
10
10
|
**test_sent** | **BOOLEAN** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) |
|
11
|
-
**sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | |
|
11
|
+
**sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | |
|
12
12
|
**reply_to** | **String** | Email defined as the \"Reply to\" for the template |
|
13
13
|
**to_field** | **String** | Customisation of the \"to\" field for the template |
|
14
14
|
**tag** | **String** | Tag of the template |
|
@@ -4,7 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**date** | **Date** | Date for which statistics are retrieved |
|
7
|
-
**tag** | **String** | Tag specified in request |
|
8
7
|
**requests** | **Integer** | Number of requests for the date |
|
9
8
|
**delivered** | **Integer** | Number of delivered SMS for the date |
|
10
9
|
**hard_bounces** | **Integer** | Number of hardbounces for the date |
|
data/docs/ListsApi.md
CHANGED
@@ -195,7 +195,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
195
195
|
list_id = 789 # Integer | Id of the list
|
196
196
|
|
197
197
|
opts = {
|
198
|
-
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)
|
198
|
+
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.
|
199
199
|
limit: 50, # Integer | Number of documents per page
|
200
200
|
offset: 0 # Integer | Index of the first document of the page
|
201
201
|
}
|
@@ -214,7 +214,7 @@ end
|
|
214
214
|
Name | Type | Description | Notes
|
215
215
|
------------- | ------------- | ------------- | -------------
|
216
216
|
**list_id** | **Integer**| Id of the list |
|
217
|
-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
217
|
+
**modified_since** | **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. | [optional]
|
218
218
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
219
219
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
220
220
|
|
data/docs/PostContactInfo.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) | |
|
6
|
+
**contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) | |
|
7
7
|
|
8
8
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) | |
|
7
|
-
**reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | |
|
6
|
+
**child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) | |
|
7
|
+
**reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | |
|
8
8
|
|
9
9
|
|
data/docs/SMSCampaignsApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
8
|
-
[**
|
8
|
+
[**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
|
9
9
|
[**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
10
10
|
[**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
|
11
11
|
[**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
|
@@ -68,8 +68,8 @@ Name | Type | Description | Notes
|
|
68
68
|
|
69
69
|
|
70
70
|
|
71
|
-
# **
|
72
|
-
>
|
71
|
+
# **delete_sms_campaign**
|
72
|
+
> delete_sms_campaign(campaign_id)
|
73
73
|
|
74
74
|
Delete the SMS campaign
|
75
75
|
|
@@ -92,9 +92,9 @@ campaign_id = 789 # Integer | id of the SMS campaign
|
|
92
92
|
|
93
93
|
begin
|
94
94
|
#Delete the SMS campaign
|
95
|
-
api_instance.
|
95
|
+
api_instance.delete_sms_campaign(campaign_id)
|
96
96
|
rescue SibApiV3Sdk::ApiError => e
|
97
|
-
puts "Exception when calling SMSCampaignsApi->
|
97
|
+
puts "Exception when calling SMSCampaignsApi->delete_sms_campaign: #{e}"
|
98
98
|
end
|
99
99
|
```
|
100
100
|
|
@@ -255,7 +255,7 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
|
255
255
|
campaign_id = 789 # Integer | id of the campaign
|
256
256
|
|
257
257
|
opts = {
|
258
|
-
recipient_export: SibApiV3Sdk::
|
258
|
+
recipient_export: SibApiV3Sdk::RequestSmsRecipientExport.new # RequestSmsRecipientExport | Values to send for a recipient export request
|
259
259
|
}
|
260
260
|
|
261
261
|
begin
|
@@ -272,7 +272,7 @@ end
|
|
272
272
|
Name | Type | Description | Notes
|
273
273
|
------------- | ------------- | ------------- | -------------
|
274
274
|
**campaign_id** | **Integer**| id of the campaign |
|
275
|
-
**recipient_export** | [**
|
275
|
+
**recipient_export** | [**RequestSmsRecipientExport**](RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional]
|
276
276
|
|
277
277
|
### Return type
|
278
278
|
|
data/docs/SendEmail.md
CHANGED
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**email_bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
|
8
8
|
**email_cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
|
9
9
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
10
|
-
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed:
|
11
|
-
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the base64 content of the attachment. Extension allowed:
|
10
|
+
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
11
|
+
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the base64 content of the attachment. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
12
12
|
**headers** | **Hash<String, String>** | | [optional]
|
13
13
|
**attributes** | **Hash<String, String>** | | [optional]
|
14
14
|
|
data/docs/SendReport.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**language** | **String** | Language of email content for campaign report sending. | [optional] [default to "fr"]
|
7
|
-
**email** | [**SendReportEmail**](SendReportEmail.md) | |
|
7
|
+
**email** | [**SendReportEmail**](SendReportEmail.md) | |
|
8
8
|
|
9
9
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | |
|
6
|
+
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | |
|
7
7
|
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Email addresses and names of the recipients |
|
8
8
|
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | Email addresses and names of the recipients in bcc | [optional]
|
9
9
|
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | Email addresses and names of the recipients in cc | [optional]
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**text_content** | **String** | Plain Text body of the message | [optional]
|
12
12
|
**subject** | **String** | Subject of the message |
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
|
-
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed:
|
14
|
+
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
15
15
|
**headers** | **Hash<String, String>** | | [optional]
|
16
16
|
|
17
17
|
|