sib-api-v3-sdk 5.2.5 → 5.3.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 +17 -1
- data/docs/AbTestCampaignResult.md +13 -0
- data/docs/AttributesApi.md +6 -6
- data/docs/ContactsApi.md +12 -12
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +3 -0
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +1 -1
- data/docs/EmailCampaignsApi.md +127 -7
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/ListsApi.md +1 -1
- data/docs/RequestContactExport.md +2 -1
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/ResellerApi.md +87 -20
- data/docs/SMSCampaignsApi.md +3 -3
- data/docs/SMTPApi.md +200 -19
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -1
- data/docs/SendSmtpEmail.md +2 -2
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +1 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendersApi.md +2 -2
- data/docs/TransactionalSMSApi.md +11 -11
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +3 -0
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +12 -2
- data/lib/sib-api-v3-sdk/api/account_api.rb +6 -9
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +15 -27
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +81 -155
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +141 -61
- data/lib/sib-api-v3-sdk/api/folders_api.rb +21 -39
- data/lib/sib-api-v3-sdk/api/lists_api.rb +30 -57
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +111 -92
- data/lib/sib-api-v3-sdk/api/senders_api.rb +21 -39
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +33 -59
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +213 -82
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +15 -27
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +10 -14
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +12 -17
- data/lib/sib-api-v3-sdk/models/create_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +79 -29
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sender.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +13 -17
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +11 -15
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +29 -33
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +27 -31
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +19 -24
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +9 -13
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +18 -19
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +11 -15
- data/lib/sib-api-v3-sdk/models/send_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +10 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +9 -13
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +9 -13
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +77 -27
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/spec/api/account_api_spec.rb +3 -4
- data/spec/api/attributes_api_spec.rb +6 -10
- data/spec/api/contacts_api_spec.rb +28 -52
- data/spec/api/email_campaigns_api_spec.rb +37 -22
- data/spec/api/folders_api_spec.rb +8 -14
- data/spec/api/lists_api_spec.rb +11 -20
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +31 -32
- data/spec/api/senders_api_spec.rb +8 -14
- data/spec/api/sms_campaigns_api_spec.rb +12 -20
- data/spec/api/smtp_api_spec.rb +53 -27
- data/spec/api/transactional_sms_api_spec.rb +6 -10
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_spec.rb +79 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +3 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +7 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +3 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +14 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +40 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +38 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +14 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +8 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +5 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +4 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +12 -13
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +4 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +5 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/spec_helper.rb +2 -2
- metadata +42 -2
@@ -1,16 +1,16 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require
|
13
|
+
require 'uri'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
class SMTPApi
|
@@ -19,32 +19,29 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
|
23
22
|
# Create a transactional email template
|
24
|
-
#
|
25
23
|
# @param smtp_template values to update in transactional email template
|
26
24
|
# @param [Hash] opts the optional parameters
|
27
25
|
# @return [CreateModel]
|
28
26
|
def create_smtp_template(smtp_template, opts = {})
|
29
27
|
data, _status_code, _headers = create_smtp_template_with_http_info(smtp_template, opts)
|
30
|
-
|
28
|
+
data
|
31
29
|
end
|
32
30
|
|
33
31
|
# Create a transactional email template
|
34
|
-
#
|
35
32
|
# @param smtp_template values to update in transactional email template
|
36
33
|
# @param [Hash] opts the optional parameters
|
37
34
|
# @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
|
38
35
|
def create_smtp_template_with_http_info(smtp_template, opts = {})
|
39
36
|
if @api_client.config.debugging
|
40
|
-
@api_client.config.logger.debug
|
37
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.create_smtp_template ...'
|
41
38
|
end
|
42
39
|
# verify the required parameter 'smtp_template' is set
|
43
40
|
if @api_client.config.client_side_validation && smtp_template.nil?
|
44
41
|
fail ArgumentError, "Missing the required parameter 'smtp_template' when calling SMTPApi.create_smtp_template"
|
45
42
|
end
|
46
43
|
# resource path
|
47
|
-
local_var_path =
|
44
|
+
local_var_path = '/smtp/templates'
|
48
45
|
|
49
46
|
# query parameters
|
50
47
|
query_params = {}
|
@@ -74,7 +71,6 @@ module SibApiV3Sdk
|
|
74
71
|
end
|
75
72
|
return data, status_code, headers
|
76
73
|
end
|
77
|
-
|
78
74
|
# Delete hardbounces
|
79
75
|
# Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
80
76
|
# @param [Hash] opts the optional parameters
|
@@ -82,7 +78,7 @@ module SibApiV3Sdk
|
|
82
78
|
# @return [nil]
|
83
79
|
def delete_hardbounces(opts = {})
|
84
80
|
delete_hardbounces_with_http_info(opts)
|
85
|
-
|
81
|
+
nil
|
86
82
|
end
|
87
83
|
|
88
84
|
# Delete hardbounces
|
@@ -92,10 +88,10 @@ module SibApiV3Sdk
|
|
92
88
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
93
89
|
def delete_hardbounces_with_http_info(opts = {})
|
94
90
|
if @api_client.config.debugging
|
95
|
-
@api_client.config.logger.debug
|
91
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.delete_hardbounces ...'
|
96
92
|
end
|
97
93
|
# resource path
|
98
|
-
local_var_path =
|
94
|
+
local_var_path = '/smtp/deleteHardbounces'
|
99
95
|
|
100
96
|
# query parameters
|
101
97
|
query_params = {}
|
@@ -124,32 +120,29 @@ module SibApiV3Sdk
|
|
124
120
|
end
|
125
121
|
return data, status_code, headers
|
126
122
|
end
|
127
|
-
|
128
123
|
# Delete an inactive transactional email template
|
129
|
-
#
|
130
124
|
# @param template_id id of the template
|
131
125
|
# @param [Hash] opts the optional parameters
|
132
126
|
# @return [nil]
|
133
127
|
def delete_smtp_template(template_id, opts = {})
|
134
128
|
delete_smtp_template_with_http_info(template_id, opts)
|
135
|
-
|
129
|
+
nil
|
136
130
|
end
|
137
131
|
|
138
132
|
# Delete an inactive transactional email template
|
139
|
-
#
|
140
133
|
# @param template_id id of the template
|
141
134
|
# @param [Hash] opts the optional parameters
|
142
135
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
143
136
|
def delete_smtp_template_with_http_info(template_id, opts = {})
|
144
137
|
if @api_client.config.debugging
|
145
|
-
@api_client.config.logger.debug
|
138
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.delete_smtp_template ...'
|
146
139
|
end
|
147
140
|
# verify the required parameter 'template_id' is set
|
148
141
|
if @api_client.config.client_side_validation && template_id.nil?
|
149
142
|
fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.delete_smtp_template"
|
150
143
|
end
|
151
144
|
# resource path
|
152
|
-
local_var_path =
|
145
|
+
local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
|
153
146
|
|
154
147
|
# query parameters
|
155
148
|
query_params = {}
|
@@ -178,9 +171,7 @@ module SibApiV3Sdk
|
|
178
171
|
end
|
179
172
|
return data, status_code, headers
|
180
173
|
end
|
181
|
-
|
182
174
|
# Get your transactional email activity aggregated over a period of time
|
183
|
-
#
|
184
175
|
# @param [Hash] opts the optional parameters
|
185
176
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
186
177
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
@@ -189,11 +180,10 @@ module SibApiV3Sdk
|
|
189
180
|
# @return [GetAggregatedReport]
|
190
181
|
def get_aggregated_smtp_report(opts = {})
|
191
182
|
data, _status_code, _headers = get_aggregated_smtp_report_with_http_info(opts)
|
192
|
-
|
183
|
+
data
|
193
184
|
end
|
194
185
|
|
195
186
|
# Get your transactional email activity aggregated over a period of time
|
196
|
-
#
|
197
187
|
# @param [Hash] opts the optional parameters
|
198
188
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
199
189
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
@@ -202,10 +192,10 @@ module SibApiV3Sdk
|
|
202
192
|
# @return [Array<(GetAggregatedReport, Fixnum, Hash)>] GetAggregatedReport data, response status code and response headers
|
203
193
|
def get_aggregated_smtp_report_with_http_info(opts = {})
|
204
194
|
if @api_client.config.debugging
|
205
|
-
@api_client.config.logger.debug
|
195
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_aggregated_smtp_report ...'
|
206
196
|
end
|
207
197
|
# resource path
|
208
|
-
local_var_path =
|
198
|
+
local_var_path = '/smtp/statistics/aggregatedReport'
|
209
199
|
|
210
200
|
# query parameters
|
211
201
|
query_params = {}
|
@@ -239,9 +229,7 @@ module SibApiV3Sdk
|
|
239
229
|
end
|
240
230
|
return data, status_code, headers
|
241
231
|
end
|
242
|
-
|
243
232
|
# Get all your transactional email activity (unaggregated events)
|
244
|
-
#
|
245
233
|
# @param [Hash] opts the optional parameters
|
246
234
|
# @option opts [Integer] :limit Number limitation for the result returned (default to 50)
|
247
235
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
|
@@ -256,11 +244,10 @@ module SibApiV3Sdk
|
|
256
244
|
# @return [GetEmailEventReport]
|
257
245
|
def get_email_event_report(opts = {})
|
258
246
|
data, _status_code, _headers = get_email_event_report_with_http_info(opts)
|
259
|
-
|
247
|
+
data
|
260
248
|
end
|
261
249
|
|
262
250
|
# Get all your transactional email activity (unaggregated events)
|
263
|
-
#
|
264
251
|
# @param [Hash] opts the optional parameters
|
265
252
|
# @option opts [Integer] :limit Number limitation for the result returned
|
266
253
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
@@ -275,7 +262,7 @@ module SibApiV3Sdk
|
|
275
262
|
# @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
|
276
263
|
def get_email_event_report_with_http_info(opts = {})
|
277
264
|
if @api_client.config.debugging
|
278
|
-
@api_client.config.logger.debug
|
265
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_email_event_report ...'
|
279
266
|
end
|
280
267
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
281
268
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_email_event_report, must be smaller than or equal to 100.'
|
@@ -285,7 +272,7 @@ module SibApiV3Sdk
|
|
285
272
|
fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed'
|
286
273
|
end
|
287
274
|
# resource path
|
288
|
-
local_var_path =
|
275
|
+
local_var_path = '/smtp/statistics/events'
|
289
276
|
|
290
277
|
# query parameters
|
291
278
|
query_params = {}
|
@@ -325,11 +312,9 @@ module SibApiV3Sdk
|
|
325
312
|
end
|
326
313
|
return data, status_code, headers
|
327
314
|
end
|
328
|
-
|
329
315
|
# Get your transactional email activity aggregated per day
|
330
|
-
#
|
331
316
|
# @param [Hash] opts the optional parameters
|
332
|
-
# @option opts [Integer] :limit Number of documents returned per page (default to
|
317
|
+
# @option opts [Integer] :limit Number of documents returned per page (default to 10)
|
333
318
|
# @option opts [Integer] :offset Index of the first document on the page (default to 0)
|
334
319
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
335
320
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
@@ -338,11 +323,10 @@ module SibApiV3Sdk
|
|
338
323
|
# @return [GetReports]
|
339
324
|
def get_smtp_report(opts = {})
|
340
325
|
data, _status_code, _headers = get_smtp_report_with_http_info(opts)
|
341
|
-
|
326
|
+
data
|
342
327
|
end
|
343
328
|
|
344
329
|
# Get your transactional email activity aggregated per day
|
345
|
-
#
|
346
330
|
# @param [Hash] opts the optional parameters
|
347
331
|
# @option opts [Integer] :limit Number of documents returned per page
|
348
332
|
# @option opts [Integer] :offset Index of the first document on the page
|
@@ -353,14 +337,14 @@ module SibApiV3Sdk
|
|
353
337
|
# @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
|
354
338
|
def get_smtp_report_with_http_info(opts = {})
|
355
339
|
if @api_client.config.debugging
|
356
|
-
@api_client.config.logger.debug
|
340
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_smtp_report ...'
|
357
341
|
end
|
358
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] >
|
359
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_smtp_report, must be smaller than or equal to
|
342
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 30
|
343
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_smtp_report, must be smaller than or equal to 30.'
|
360
344
|
end
|
361
345
|
|
362
346
|
# resource path
|
363
|
-
local_var_path =
|
347
|
+
local_var_path = '/smtp/statistics/reports'
|
364
348
|
|
365
349
|
# query parameters
|
366
350
|
query_params = {}
|
@@ -396,32 +380,29 @@ module SibApiV3Sdk
|
|
396
380
|
end
|
397
381
|
return data, status_code, headers
|
398
382
|
end
|
399
|
-
|
400
383
|
# Returns the template informations
|
401
|
-
#
|
402
384
|
# @param template_id id of the template
|
403
385
|
# @param [Hash] opts the optional parameters
|
404
386
|
# @return [GetSmtpTemplateOverview]
|
405
387
|
def get_smtp_template(template_id, opts = {})
|
406
388
|
data, _status_code, _headers = get_smtp_template_with_http_info(template_id, opts)
|
407
|
-
|
389
|
+
data
|
408
390
|
end
|
409
391
|
|
410
392
|
# Returns the template informations
|
411
|
-
#
|
412
393
|
# @param template_id id of the template
|
413
394
|
# @param [Hash] opts the optional parameters
|
414
395
|
# @return [Array<(GetSmtpTemplateOverview, Fixnum, Hash)>] GetSmtpTemplateOverview data, response status code and response headers
|
415
396
|
def get_smtp_template_with_http_info(template_id, opts = {})
|
416
397
|
if @api_client.config.debugging
|
417
|
-
@api_client.config.logger.debug
|
398
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_smtp_template ...'
|
418
399
|
end
|
419
400
|
# verify the required parameter 'template_id' is set
|
420
401
|
if @api_client.config.client_side_validation && template_id.nil?
|
421
402
|
fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.get_smtp_template"
|
422
403
|
end
|
423
404
|
# resource path
|
424
|
-
local_var_path =
|
405
|
+
local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
|
425
406
|
|
426
407
|
# query parameters
|
427
408
|
query_params = {}
|
@@ -451,9 +432,7 @@ module SibApiV3Sdk
|
|
451
432
|
end
|
452
433
|
return data, status_code, headers
|
453
434
|
end
|
454
|
-
|
455
435
|
# Get the list of transactional email templates
|
456
|
-
#
|
457
436
|
# @param [Hash] opts the optional parameters
|
458
437
|
# @option opts [BOOLEAN] :template_status Filter on the status of the template. Active = true, inactive = false
|
459
438
|
# @option opts [Integer] :limit Number of documents returned per page (default to 50)
|
@@ -461,11 +440,10 @@ module SibApiV3Sdk
|
|
461
440
|
# @return [GetSmtpTemplates]
|
462
441
|
def get_smtp_templates(opts = {})
|
463
442
|
data, _status_code, _headers = get_smtp_templates_with_http_info(opts)
|
464
|
-
|
443
|
+
data
|
465
444
|
end
|
466
445
|
|
467
446
|
# Get the list of transactional email templates
|
468
|
-
#
|
469
447
|
# @param [Hash] opts the optional parameters
|
470
448
|
# @option opts [BOOLEAN] :template_status Filter on the status of the template. Active = true, inactive = false
|
471
449
|
# @option opts [Integer] :limit Number of documents returned per page
|
@@ -473,14 +451,14 @@ module SibApiV3Sdk
|
|
473
451
|
# @return [Array<(GetSmtpTemplates, Fixnum, Hash)>] GetSmtpTemplates data, response status code and response headers
|
474
452
|
def get_smtp_templates_with_http_info(opts = {})
|
475
453
|
if @api_client.config.debugging
|
476
|
-
@api_client.config.logger.debug
|
454
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_smtp_templates ...'
|
477
455
|
end
|
478
456
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
|
479
457
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_smtp_templates, must be smaller than or equal to 1000.'
|
480
458
|
end
|
481
459
|
|
482
460
|
# resource path
|
483
|
-
local_var_path =
|
461
|
+
local_var_path = '/smtp/templates'
|
484
462
|
|
485
463
|
# query parameters
|
486
464
|
query_params = {}
|
@@ -513,32 +491,94 @@ module SibApiV3Sdk
|
|
513
491
|
end
|
514
492
|
return data, status_code, headers
|
515
493
|
end
|
494
|
+
# Get the list of blocked or unsubscribed transactional contacts
|
495
|
+
# @param [Hash] opts the optional parameters
|
496
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
497
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
498
|
+
# @option opts [Integer] :limit Number of documents returned per page (default to 50)
|
499
|
+
# @option opts [Integer] :offset Index of the first document on the page (default to 0)
|
500
|
+
# @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
501
|
+
# @return [GetTransacBlockedContacts]
|
502
|
+
def get_transac_blocked_contacts(opts = {})
|
503
|
+
data, _status_code, _headers = get_transac_blocked_contacts_with_http_info(opts)
|
504
|
+
data
|
505
|
+
end
|
506
|
+
|
507
|
+
# Get the list of blocked or unsubscribed transactional contacts
|
508
|
+
# @param [Hash] opts the optional parameters
|
509
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
510
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
511
|
+
# @option opts [Integer] :limit Number of documents returned per page
|
512
|
+
# @option opts [Integer] :offset Index of the first document on the page
|
513
|
+
# @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
514
|
+
# @return [Array<(GetTransacBlockedContacts, Fixnum, Hash)>] GetTransacBlockedContacts data, response status code and response headers
|
515
|
+
def get_transac_blocked_contacts_with_http_info(opts = {})
|
516
|
+
if @api_client.config.debugging
|
517
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_transac_blocked_contacts ...'
|
518
|
+
end
|
519
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
520
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_transac_blocked_contacts, must be smaller than or equal to 100.'
|
521
|
+
end
|
522
|
+
|
523
|
+
# resource path
|
524
|
+
local_var_path = '/smtp/blockedContacts'
|
525
|
+
|
526
|
+
# query parameters
|
527
|
+
query_params = {}
|
528
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
529
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
530
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
531
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
532
|
+
query_params[:'senders'] = @api_client.build_collection_param(opts[:'senders'], :csv) if !opts[:'senders'].nil?
|
533
|
+
|
534
|
+
# header parameters
|
535
|
+
header_params = {}
|
536
|
+
# HTTP header 'Accept' (if needed)
|
537
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
538
|
+
# HTTP header 'Content-Type'
|
539
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
516
540
|
|
541
|
+
# form parameters
|
542
|
+
form_params = {}
|
543
|
+
|
544
|
+
# http body (model)
|
545
|
+
post_body = nil
|
546
|
+
auth_names = ['api-key', 'partner-key']
|
547
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
548
|
+
:header_params => header_params,
|
549
|
+
:query_params => query_params,
|
550
|
+
:form_params => form_params,
|
551
|
+
:body => post_body,
|
552
|
+
:auth_names => auth_names,
|
553
|
+
:return_type => 'GetTransacBlockedContacts')
|
554
|
+
if @api_client.config.debugging
|
555
|
+
@api_client.config.logger.debug "API called: SMTPApi#get_transac_blocked_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
556
|
+
end
|
557
|
+
return data, status_code, headers
|
558
|
+
end
|
517
559
|
# Get the personalized content of a sent transactional email
|
518
|
-
#
|
519
560
|
# @param uuid Unique id of the transactional email that has been sent to a particular contact
|
520
561
|
# @param [Hash] opts the optional parameters
|
521
562
|
# @return [GetTransacEmailContent]
|
522
563
|
def get_transac_email_content(uuid, opts = {})
|
523
564
|
data, _status_code, _headers = get_transac_email_content_with_http_info(uuid, opts)
|
524
|
-
|
565
|
+
data
|
525
566
|
end
|
526
567
|
|
527
568
|
# Get the personalized content of a sent transactional email
|
528
|
-
#
|
529
569
|
# @param uuid Unique id of the transactional email that has been sent to a particular contact
|
530
570
|
# @param [Hash] opts the optional parameters
|
531
571
|
# @return [Array<(GetTransacEmailContent, Fixnum, Hash)>] GetTransacEmailContent data, response status code and response headers
|
532
572
|
def get_transac_email_content_with_http_info(uuid, opts = {})
|
533
573
|
if @api_client.config.debugging
|
534
|
-
@api_client.config.logger.debug
|
574
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_transac_email_content ...'
|
535
575
|
end
|
536
576
|
# verify the required parameter 'uuid' is set
|
537
577
|
if @api_client.config.client_side_validation && uuid.nil?
|
538
578
|
fail ArgumentError, "Missing the required parameter 'uuid' when calling SMTPApi.get_transac_email_content"
|
539
579
|
end
|
540
580
|
# resource path
|
541
|
-
local_var_path =
|
581
|
+
local_var_path = '/smtp/emails/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)
|
542
582
|
|
543
583
|
# query parameters
|
544
584
|
query_params = {}
|
@@ -568,7 +608,6 @@ module SibApiV3Sdk
|
|
568
608
|
end
|
569
609
|
return data, status_code, headers
|
570
610
|
end
|
571
|
-
|
572
611
|
# Get the list of transactional emails on the basis of allowed filters
|
573
612
|
# This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
574
613
|
# @param [Hash] opts the optional parameters
|
@@ -580,7 +619,7 @@ module SibApiV3Sdk
|
|
580
619
|
# @return [GetTransacEmailsList]
|
581
620
|
def get_transac_emails_list(opts = {})
|
582
621
|
data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
|
583
|
-
|
622
|
+
data
|
584
623
|
end
|
585
624
|
|
586
625
|
# Get the list of transactional emails on the basis of allowed filters
|
@@ -594,10 +633,10 @@ module SibApiV3Sdk
|
|
594
633
|
# @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
|
595
634
|
def get_transac_emails_list_with_http_info(opts = {})
|
596
635
|
if @api_client.config.debugging
|
597
|
-
@api_client.config.logger.debug
|
636
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.get_transac_emails_list ...'
|
598
637
|
end
|
599
638
|
# resource path
|
600
|
-
local_var_path =
|
639
|
+
local_var_path = '/smtp/emails'
|
601
640
|
|
602
641
|
# query parameters
|
603
642
|
query_params = {}
|
@@ -632,7 +671,6 @@ module SibApiV3Sdk
|
|
632
671
|
end
|
633
672
|
return data, status_code, headers
|
634
673
|
end
|
635
|
-
|
636
674
|
# Send a template
|
637
675
|
# This endpoint is deprecated. Prefer v3/smtp/email instead.
|
638
676
|
# @param template_id Id of the template
|
@@ -641,7 +679,7 @@ module SibApiV3Sdk
|
|
641
679
|
# @return [SendTemplateEmail]
|
642
680
|
def send_template(template_id, send_email, opts = {})
|
643
681
|
data, _status_code, _headers = send_template_with_http_info(template_id, send_email, opts)
|
644
|
-
|
682
|
+
data
|
645
683
|
end
|
646
684
|
|
647
685
|
# Send a template
|
@@ -652,7 +690,7 @@ module SibApiV3Sdk
|
|
652
690
|
# @return [Array<(SendTemplateEmail, Fixnum, Hash)>] SendTemplateEmail data, response status code and response headers
|
653
691
|
def send_template_with_http_info(template_id, send_email, opts = {})
|
654
692
|
if @api_client.config.debugging
|
655
|
-
@api_client.config.logger.debug
|
693
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.send_template ...'
|
656
694
|
end
|
657
695
|
# verify the required parameter 'template_id' is set
|
658
696
|
if @api_client.config.client_side_validation && template_id.nil?
|
@@ -663,7 +701,7 @@ module SibApiV3Sdk
|
|
663
701
|
fail ArgumentError, "Missing the required parameter 'send_email' when calling SMTPApi.send_template"
|
664
702
|
end
|
665
703
|
# resource path
|
666
|
-
local_var_path =
|
704
|
+
local_var_path = '/smtp/templates/{templateId}/send'.sub('{' + 'templateId' + '}', template_id.to_s)
|
667
705
|
|
668
706
|
# query parameters
|
669
707
|
query_params = {}
|
@@ -693,27 +731,24 @@ module SibApiV3Sdk
|
|
693
731
|
end
|
694
732
|
return data, status_code, headers
|
695
733
|
end
|
696
|
-
|
697
734
|
# Send a template to your test list
|
698
|
-
#
|
699
735
|
# @param template_id Id of the template
|
700
736
|
# @param send_test_email
|
701
737
|
# @param [Hash] opts the optional parameters
|
702
738
|
# @return [nil]
|
703
739
|
def send_test_template(template_id, send_test_email, opts = {})
|
704
740
|
send_test_template_with_http_info(template_id, send_test_email, opts)
|
705
|
-
|
741
|
+
nil
|
706
742
|
end
|
707
743
|
|
708
744
|
# Send a template to your test list
|
709
|
-
#
|
710
745
|
# @param template_id Id of the template
|
711
746
|
# @param send_test_email
|
712
747
|
# @param [Hash] opts the optional parameters
|
713
748
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
714
749
|
def send_test_template_with_http_info(template_id, send_test_email, opts = {})
|
715
750
|
if @api_client.config.debugging
|
716
|
-
@api_client.config.logger.debug
|
751
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.send_test_template ...'
|
717
752
|
end
|
718
753
|
# verify the required parameter 'template_id' is set
|
719
754
|
if @api_client.config.client_side_validation && template_id.nil?
|
@@ -724,7 +759,7 @@ module SibApiV3Sdk
|
|
724
759
|
fail ArgumentError, "Missing the required parameter 'send_test_email' when calling SMTPApi.send_test_template"
|
725
760
|
end
|
726
761
|
# resource path
|
727
|
-
local_var_path =
|
762
|
+
local_var_path = '/smtp/templates/{templateId}/sendTest'.sub('{' + 'templateId' + '}', template_id.to_s)
|
728
763
|
|
729
764
|
# query parameters
|
730
765
|
query_params = {}
|
@@ -753,32 +788,29 @@ module SibApiV3Sdk
|
|
753
788
|
end
|
754
789
|
return data, status_code, headers
|
755
790
|
end
|
756
|
-
|
757
791
|
# Send a transactional email
|
758
|
-
#
|
759
792
|
# @param send_smtp_email Values to send a transactional email
|
760
793
|
# @param [Hash] opts the optional parameters
|
761
794
|
# @return [CreateSmtpEmail]
|
762
795
|
def send_transac_email(send_smtp_email, opts = {})
|
763
796
|
data, _status_code, _headers = send_transac_email_with_http_info(send_smtp_email, opts)
|
764
|
-
|
797
|
+
data
|
765
798
|
end
|
766
799
|
|
767
800
|
# Send a transactional email
|
768
|
-
#
|
769
801
|
# @param send_smtp_email Values to send a transactional email
|
770
802
|
# @param [Hash] opts the optional parameters
|
771
803
|
# @return [Array<(CreateSmtpEmail, Fixnum, Hash)>] CreateSmtpEmail data, response status code and response headers
|
772
804
|
def send_transac_email_with_http_info(send_smtp_email, opts = {})
|
773
805
|
if @api_client.config.debugging
|
774
|
-
@api_client.config.logger.debug
|
806
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.send_transac_email ...'
|
775
807
|
end
|
776
808
|
# verify the required parameter 'send_smtp_email' is set
|
777
809
|
if @api_client.config.client_side_validation && send_smtp_email.nil?
|
778
810
|
fail ArgumentError, "Missing the required parameter 'send_smtp_email' when calling SMTPApi.send_transac_email"
|
779
811
|
end
|
780
812
|
# resource path
|
781
|
-
local_var_path =
|
813
|
+
local_var_path = '/smtp/email'
|
782
814
|
|
783
815
|
# query parameters
|
784
816
|
query_params = {}
|
@@ -808,27 +840,126 @@ module SibApiV3Sdk
|
|
808
840
|
end
|
809
841
|
return data, status_code, headers
|
810
842
|
end
|
843
|
+
# Unblock or resubscribe a transactional contact
|
844
|
+
# @param email contact email (urlencoded) to unblock.
|
845
|
+
# @param [Hash] opts the optional parameters
|
846
|
+
# @return [nil]
|
847
|
+
def smtp_blocked_contacts_email_delete(email, opts = {})
|
848
|
+
smtp_blocked_contacts_email_delete_with_http_info(email, opts)
|
849
|
+
nil
|
850
|
+
end
|
811
851
|
|
852
|
+
# Unblock or resubscribe a transactional contact
|
853
|
+
# @param email contact email (urlencoded) to unblock.
|
854
|
+
# @param [Hash] opts the optional parameters
|
855
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
856
|
+
def smtp_blocked_contacts_email_delete_with_http_info(email, opts = {})
|
857
|
+
if @api_client.config.debugging
|
858
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.smtp_blocked_contacts_email_delete ...'
|
859
|
+
end
|
860
|
+
# verify the required parameter 'email' is set
|
861
|
+
if @api_client.config.client_side_validation && email.nil?
|
862
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling SMTPApi.smtp_blocked_contacts_email_delete"
|
863
|
+
end
|
864
|
+
# resource path
|
865
|
+
local_var_path = '/smtp/blockedContacts/{email}'.sub('{' + 'email' + '}', email.to_s)
|
866
|
+
|
867
|
+
# query parameters
|
868
|
+
query_params = {}
|
869
|
+
|
870
|
+
# header parameters
|
871
|
+
header_params = {}
|
872
|
+
# HTTP header 'Accept' (if needed)
|
873
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
874
|
+
# HTTP header 'Content-Type'
|
875
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
876
|
+
|
877
|
+
# form parameters
|
878
|
+
form_params = {}
|
879
|
+
|
880
|
+
# http body (model)
|
881
|
+
post_body = nil
|
882
|
+
auth_names = ['api-key', 'partner-key']
|
883
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
884
|
+
:header_params => header_params,
|
885
|
+
:query_params => query_params,
|
886
|
+
:form_params => form_params,
|
887
|
+
:body => post_body,
|
888
|
+
:auth_names => auth_names)
|
889
|
+
if @api_client.config.debugging
|
890
|
+
@api_client.config.logger.debug "API called: SMTPApi#smtp_blocked_contacts_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
891
|
+
end
|
892
|
+
return data, status_code, headers
|
893
|
+
end
|
894
|
+
# Delete an SMTP transactional log
|
895
|
+
# @param message_id MessageId of the transactional log to delete
|
896
|
+
# @param [Hash] opts the optional parameters
|
897
|
+
# @return [nil]
|
898
|
+
def smtp_log_message_id_delete(message_id, opts = {})
|
899
|
+
smtp_log_message_id_delete_with_http_info(message_id, opts)
|
900
|
+
nil
|
901
|
+
end
|
902
|
+
|
903
|
+
# Delete an SMTP transactional log
|
904
|
+
# @param message_id MessageId of the transactional log to delete
|
905
|
+
# @param [Hash] opts the optional parameters
|
906
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
907
|
+
def smtp_log_message_id_delete_with_http_info(message_id, opts = {})
|
908
|
+
if @api_client.config.debugging
|
909
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.smtp_log_message_id_delete ...'
|
910
|
+
end
|
911
|
+
# verify the required parameter 'message_id' is set
|
912
|
+
if @api_client.config.client_side_validation && message_id.nil?
|
913
|
+
fail ArgumentError, "Missing the required parameter 'message_id' when calling SMTPApi.smtp_log_message_id_delete"
|
914
|
+
end
|
915
|
+
# resource path
|
916
|
+
local_var_path = '/smtp/log/{messageId}'.sub('{' + 'messageId' + '}', message_id.to_s)
|
917
|
+
|
918
|
+
# query parameters
|
919
|
+
query_params = {}
|
920
|
+
|
921
|
+
# header parameters
|
922
|
+
header_params = {}
|
923
|
+
# HTTP header 'Accept' (if needed)
|
924
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
925
|
+
# HTTP header 'Content-Type'
|
926
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
927
|
+
|
928
|
+
# form parameters
|
929
|
+
form_params = {}
|
930
|
+
|
931
|
+
# http body (model)
|
932
|
+
post_body = nil
|
933
|
+
auth_names = ['api-key', 'partner-key']
|
934
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
935
|
+
:header_params => header_params,
|
936
|
+
:query_params => query_params,
|
937
|
+
:form_params => form_params,
|
938
|
+
:body => post_body,
|
939
|
+
:auth_names => auth_names)
|
940
|
+
if @api_client.config.debugging
|
941
|
+
@api_client.config.logger.debug "API called: SMTPApi#smtp_log_message_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
942
|
+
end
|
943
|
+
return data, status_code, headers
|
944
|
+
end
|
812
945
|
# Updates a transactional email templates
|
813
|
-
#
|
814
946
|
# @param template_id id of the template
|
815
947
|
# @param smtp_template values to update in transactional email template
|
816
948
|
# @param [Hash] opts the optional parameters
|
817
949
|
# @return [nil]
|
818
950
|
def update_smtp_template(template_id, smtp_template, opts = {})
|
819
951
|
update_smtp_template_with_http_info(template_id, smtp_template, opts)
|
820
|
-
|
952
|
+
nil
|
821
953
|
end
|
822
954
|
|
823
955
|
# Updates a transactional email templates
|
824
|
-
#
|
825
956
|
# @param template_id id of the template
|
826
957
|
# @param smtp_template values to update in transactional email template
|
827
958
|
# @param [Hash] opts the optional parameters
|
828
959
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
829
960
|
def update_smtp_template_with_http_info(template_id, smtp_template, opts = {})
|
830
961
|
if @api_client.config.debugging
|
831
|
-
@api_client.config.logger.debug
|
962
|
+
@api_client.config.logger.debug 'Calling API: SMTPApi.update_smtp_template ...'
|
832
963
|
end
|
833
964
|
# verify the required parameter 'template_id' is set
|
834
965
|
if @api_client.config.client_side_validation && template_id.nil?
|
@@ -839,7 +970,7 @@ module SibApiV3Sdk
|
|
839
970
|
fail ArgumentError, "Missing the required parameter 'smtp_template' when calling SMTPApi.update_smtp_template"
|
840
971
|
end
|
841
972
|
# resource path
|
842
|
-
local_var_path =
|
973
|
+
local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
|
843
974
|
|
844
975
|
# query parameters
|
845
976
|
query_params = {}
|