sib-api-v3-sdk 5.5.0 → 7.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +44 -29
- data/docs/AbTestCampaignResult.md +2 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AddContactToList.md +2 -1
- data/docs/BlockDomain.md +8 -0
- data/docs/ContactsApi.md +45 -33
- data/docs/CreateDoiContact.md +1 -1
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +2 -2
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/CreateSmtpTemplateSender.md +1 -1
- data/docs/CreateWebhook.md +1 -1
- data/docs/EmailCampaignsApi.md +7 -5
- data/docs/FoldersApi.md +9 -3
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +1 -1
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildDomain.md +2 -2
- data/docs/GetChildrenList.md +1 -1
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactDetails.md +2 -2
- data/docs/GetEmailCampaign.md +8 -8
- data/docs/GetEmailCampaigns.md +1 -1
- data/docs/GetEmailEventReportEvents.md +2 -1
- data/docs/GetExtendedCampaignOverview.md +6 -6
- data/docs/GetExtendedCampaignStats.md +1 -1
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedContactDetails.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
- data/docs/GetExtendedList.md +1 -1
- data/docs/GetFolderLists.md +2 -2
- data/docs/GetLists.md +2 -2
- data/docs/GetProcesses.md +1 -1
- data/docs/GetSmsCampaign.md +5 -5
- data/docs/GetSmsCampaignOverview.md +3 -3
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaigns.md +1 -1
- data/docs/GetSmsEventReportEvents.md +4 -4
- data/docs/GetSmtpTemplateOverview.md +2 -2
- data/docs/GetTransacAggregatedSmsReport.md +10 -10
- data/docs/GetTransacBlockedContactsContacts.md +1 -1
- data/docs/GetTransacEmailContent.md +1 -1
- data/docs/GetTransacEmailContentEvents.md +1 -1
- data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
- data/docs/GetTransacSmsReportReports.md +10 -10
- data/docs/GetWebhook.md +2 -2
- data/docs/ListsApi.md +15 -9
- data/docs/ProcessApi.md +3 -1
- data/docs/RemoveContactFromList.md +2 -1
- data/docs/SMSCampaignsApi.md +7 -5
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +3 -2
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +3 -2
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTransacSms.md +1 -1
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +242 -60
- data/docs/TransactionalSMSApi.md +9 -5
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +2 -2
- data/docs/UpdateWebhook.md +1 -1
- data/lib/sib-api-v3-sdk.rb +22 -10
- data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +85 -45
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/lists_api.rb +35 -7
- data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +249 -55
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api_client.rb +6 -4
- data/lib/sib-api-v3-sdk/api_error.rb +1 -1
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +25 -6
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +176 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +206 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +20 -7
- data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/block_domain.rb +190 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +8 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +10 -9
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +4 -3
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -67
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +193 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -6
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -52
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +17 -4
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
- data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +9 -8
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +10 -9
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +4 -3
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
- data/lib/sib-api-v3-sdk/version.rb +2 -2
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +14 -9
- data/spec/api/email_campaigns_api_spec.rb +4 -3
- data/spec/api/folders_api_spec.rb +3 -1
- data/spec/api/lists_api_spec.rb +7 -4
- data/spec/api/process_api_spec.rb +2 -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 -3
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +47 -7
- data/spec/api/transactional_sms_api_spec.rb +3 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +13 -1
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +1 -1
- data/spec/models/add_contact_to_list_spec.rb +7 -1
- data/spec/models/add_credits_spec.rb +1 -1
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +1 -1
- data/spec/models/create_doi_contact_spec.rb +1 -1
- data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_reseller_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +1 -1
- data/spec/models/create_smtp_email_spec.rb +7 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_update_contact_model_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +1 -1
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +1 -1
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- 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 +7 -1
- data/spec/models/get_child_account_creation_status_spec.rb +1 -1
- data/spec/models/get_child_domain_spec.rb +1 -1
- data/spec/models/get_child_domains_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
- data/spec/models/get_child_info_credits_spec.rb +1 -1
- data/spec/models/get_child_info_spec.rb +1 -1
- data/spec/models/get_child_info_statistics_spec.rb +1 -1
- data/spec/models/get_children_list_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_device_browser_stats_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +1 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +8 -2
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +1 -1
- data/spec/models/get_folder_lists_spec.rb +1 -1
- data/spec/models/get_folder_spec.rb +1 -1
- data/spec/models/get_folders_spec.rb +1 -1
- data/spec/models/get_ip_from_sender_spec.rb +1 -1
- data/spec/models/get_ip_spec.rb +1 -1
- data/spec/models/get_ips_from_sender_spec.rb +1 -1
- data/spec/models/get_ips_spec.rb +1 -1
- data/spec/models/get_list_spec.rb +1 -1
- data/spec/models/get_lists_spec.rb +1 -1
- data/spec/models/get_process_spec.rb +1 -1
- data/spec/models/get_processes_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +1 -1
- data/spec/models/get_reports_spec.rb +1 -1
- data/spec/models/get_senders_list_ips_spec.rb +1 -1
- data/spec/models/get_senders_list_senders_spec.rb +1 -1
- data/spec/models/get_senders_list_spec.rb +1 -1
- data/spec/models/get_shared_template_url_spec.rb +1 -1
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +1 -1
- data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
- data/spec/models/get_sms_campaigns_spec.rb +1 -1
- data/spec/models/get_sms_event_report_events_spec.rb +1 -1
- data/spec/models/get_sms_event_report_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_spec.rb +1 -1
- data/spec/models/get_smtp_templates_spec.rb +1 -1
- data/spec/models/get_sso_token_spec.rb +1 -1
- data/spec/models/get_stats_by_browser_spec.rb +1 -1
- data/spec/models/get_stats_by_device_spec.rb +1 -1
- data/spec/models/get_stats_by_domain_spec.rb +1 -1
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
- data/spec/models/get_transac_email_content_events_spec.rb +1 -1
- data/spec/models/get_transac_email_content_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_spec.rb +1 -1
- data/spec/models/get_webhook_spec.rb +1 -1
- data/spec/models/get_webhooks_spec.rb +1 -1
- data/spec/models/manage_ip_spec.rb +1 -1
- data/spec/models/post_contact_info_contacts_spec.rb +1 -1
- data/spec/models/post_contact_info_spec.rb +1 -1
- data/spec/models/post_send_failed_spec.rb +1 -1
- data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
- data/spec/models/remaining_credit_model_child_spec.rb +1 -1
- data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
- data/spec/models/remaining_credit_model_spec.rb +1 -1
- data/spec/models/remove_contact_from_list_spec.rb +7 -1
- data/spec/models/remove_credits_spec.rb +1 -1
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
- data/spec/models/request_contact_export_spec.rb +1 -1
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +1 -1
- data/spec/models/request_sms_recipient_export_spec.rb +1 -1
- data/spec/models/send_email_attachment_spec.rb +1 -1
- data/spec/models/send_email_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -29
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +7 -1
- data/spec/models/send_smtp_email_spec.rb +7 -1
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_template_email_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +1 -1
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +1 -1
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_account_status_spec.rb +1 -1
- data/spec/models/update_child_domain_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +1 -1
- data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +1 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_webhook_spec.rb +1 -1
- data/spec/models/upload_image_to_gallery_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +58 -10
data/docs/TransactionalSMSApi.md
CHANGED
@@ -39,10 +39,11 @@ opts = {
|
|
39
39
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
40
40
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
41
41
|
offset: 0, # Integer | Index of the first document of the page
|
42
|
-
days:
|
42
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
43
43
|
phone_number: 'phone_number_example', # String | Filter the report for a specific phone number
|
44
44
|
event: 'event_example', # String | Filter the report for specific events
|
45
|
-
tags: 'tags_example' # String | Filter the report for specific tags passed as a serialized urlencoded array
|
45
|
+
tags: 'tags_example', # String | Filter the report for specific tags passed as a serialized urlencoded array
|
46
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
46
47
|
}
|
47
48
|
|
48
49
|
begin
|
@@ -66,6 +67,7 @@ Name | Type | Description | Notes
|
|
66
67
|
**phone_number** | **String**| Filter the report for a specific phone number | [optional]
|
67
68
|
**event** | **String**| Filter the report for specific events | [optional]
|
68
69
|
**tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
|
70
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
69
71
|
|
70
72
|
### Return type
|
71
73
|
|
@@ -109,7 +111,7 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
|
109
111
|
opts = {
|
110
112
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
111
113
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
112
|
-
days:
|
114
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
113
115
|
tag: 'tag_example' # String | Filter on a tag
|
114
116
|
}
|
115
117
|
|
@@ -173,8 +175,9 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
|
173
175
|
opts = {
|
174
176
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
175
177
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
176
|
-
days:
|
177
|
-
tag: 'tag_example' # String | Filter on a tag
|
178
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
179
|
+
tag: 'tag_example', # String | Filter on a tag
|
180
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
178
181
|
}
|
179
182
|
|
180
183
|
begin
|
@@ -194,6 +197,7 @@ Name | Type | Description | Notes
|
|
194
197
|
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
195
198
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
196
199
|
**tag** | **String**| Filter on a tag | [optional]
|
200
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
197
201
|
|
198
202
|
### Return type
|
199
203
|
|
data/docs/UpdateEmailCampaign.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**name** | **String** | Name of the campaign | [optional]
|
9
9
|
**html_content** | **String** | Body of the message (HTML version). 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
|
-
**scheduled_at** | **
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
12
12
|
**subject** | **String** | Subject of the campaign | [optional]
|
13
13
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
14
14
|
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
data/docs/UpdateSmsCampaign.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the campaign | [optional]
|
7
|
-
**sender** | **String** | Name of the sender. The number of characters is limited to 11 | [optional]
|
7
|
+
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional]
|
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** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
11
11
|
|
12
12
|
|
data/docs/UpdateWebhook.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook | [optional]
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
8
|
-
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – request
|
8
|
+
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered` | [optional]
|
9
9
|
|
10
10
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
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.4.
|
9
|
+
Swagger Codegen version: 2.4.18
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -18,9 +18,15 @@ require 'sib-api-v3-sdk/configuration'
|
|
18
18
|
|
19
19
|
# Models
|
20
20
|
require 'sib-api-v3-sdk/models/ab_test_campaign_result'
|
21
|
+
require 'sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links'
|
22
|
+
require 'sib-api-v3-sdk/models/ab_test_campaign_result_statistics'
|
23
|
+
require 'sib-api-v3-sdk/models/ab_test_version_clicks'
|
24
|
+
require 'sib-api-v3-sdk/models/ab_test_version_clicks_inner'
|
25
|
+
require 'sib-api-v3-sdk/models/ab_test_version_stats'
|
21
26
|
require 'sib-api-v3-sdk/models/add_child_domain'
|
22
27
|
require 'sib-api-v3-sdk/models/add_contact_to_list'
|
23
28
|
require 'sib-api-v3-sdk/models/add_credits'
|
29
|
+
require 'sib-api-v3-sdk/models/block_domain'
|
24
30
|
require 'sib-api-v3-sdk/models/create_attribute'
|
25
31
|
require 'sib-api-v3-sdk/models/create_attribute_enumeration'
|
26
32
|
require 'sib-api-v3-sdk/models/create_child'
|
@@ -47,6 +53,7 @@ require 'sib-api-v3-sdk/models/created_process_id'
|
|
47
53
|
require 'sib-api-v3-sdk/models/delete_hardbounces'
|
48
54
|
require 'sib-api-v3-sdk/models/email_export_recipients'
|
49
55
|
require 'sib-api-v3-sdk/models/error_model'
|
56
|
+
require 'sib-api-v3-sdk/models/get_account'
|
50
57
|
require 'sib-api-v3-sdk/models/get_account_marketing_automation'
|
51
58
|
require 'sib-api-v3-sdk/models/get_account_plan'
|
52
59
|
require 'sib-api-v3-sdk/models/get_account_relay'
|
@@ -55,12 +62,14 @@ require 'sib-api-v3-sdk/models/get_aggregated_report'
|
|
55
62
|
require 'sib-api-v3-sdk/models/get_attributes'
|
56
63
|
require 'sib-api-v3-sdk/models/get_attributes_attributes'
|
57
64
|
require 'sib-api-v3-sdk/models/get_attributes_enumeration'
|
65
|
+
require 'sib-api-v3-sdk/models/get_blocked_domains'
|
58
66
|
require 'sib-api-v3-sdk/models/get_campaign_overview'
|
59
67
|
require 'sib-api-v3-sdk/models/get_campaign_recipients'
|
60
68
|
require 'sib-api-v3-sdk/models/get_campaign_stats'
|
61
69
|
require 'sib-api-v3-sdk/models/get_child_account_creation_status'
|
62
70
|
require 'sib-api-v3-sdk/models/get_child_domain'
|
63
71
|
require 'sib-api-v3-sdk/models/get_child_domains'
|
72
|
+
require 'sib-api-v3-sdk/models/get_child_info'
|
64
73
|
require 'sib-api-v3-sdk/models/get_child_info_api_keys'
|
65
74
|
require 'sib-api-v3-sdk/models/get_child_info_api_keys_v2'
|
66
75
|
require 'sib-api-v3-sdk/models/get_child_info_api_keys_v3'
|
@@ -76,12 +85,17 @@ require 'sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions'
|
|
76
85
|
require 'sib-api-v3-sdk/models/get_contact_details'
|
77
86
|
require 'sib-api-v3-sdk/models/get_contacts'
|
78
87
|
require 'sib-api-v3-sdk/models/get_device_browser_stats'
|
88
|
+
require 'sib-api-v3-sdk/models/get_email_campaign'
|
79
89
|
require 'sib-api-v3-sdk/models/get_email_campaigns'
|
80
90
|
require 'sib-api-v3-sdk/models/get_email_event_report'
|
81
91
|
require 'sib-api-v3-sdk/models/get_email_event_report_events'
|
92
|
+
require 'sib-api-v3-sdk/models/get_extended_campaign_overview'
|
82
93
|
require 'sib-api-v3-sdk/models/get_extended_campaign_overview_sender'
|
83
94
|
require 'sib-api-v3-sdk/models/get_extended_campaign_stats'
|
95
|
+
require 'sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats'
|
96
|
+
require 'sib-api-v3-sdk/models/get_extended_client'
|
84
97
|
require 'sib-api-v3-sdk/models/get_extended_client_address'
|
98
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details'
|
85
99
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics'
|
86
100
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked'
|
87
101
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_links'
|
@@ -90,6 +104,7 @@ require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened'
|
|
90
104
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions'
|
91
105
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription'
|
92
106
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription'
|
107
|
+
require 'sib-api-v3-sdk/models/get_extended_list'
|
93
108
|
require 'sib-api-v3-sdk/models/get_extended_list_campaign_stats'
|
94
109
|
require 'sib-api-v3-sdk/models/get_folder'
|
95
110
|
require 'sib-api-v3-sdk/models/get_folder_lists'
|
@@ -108,7 +123,9 @@ require 'sib-api-v3-sdk/models/get_senders_list'
|
|
108
123
|
require 'sib-api-v3-sdk/models/get_senders_list_ips'
|
109
124
|
require 'sib-api-v3-sdk/models/get_senders_list_senders'
|
110
125
|
require 'sib-api-v3-sdk/models/get_shared_template_url'
|
126
|
+
require 'sib-api-v3-sdk/models/get_sms_campaign'
|
111
127
|
require 'sib-api-v3-sdk/models/get_sms_campaign_overview'
|
128
|
+
require 'sib-api-v3-sdk/models/get_sms_campaign_recipients'
|
112
129
|
require 'sib-api-v3-sdk/models/get_sms_campaign_stats'
|
113
130
|
require 'sib-api-v3-sdk/models/get_sms_campaigns'
|
114
131
|
require 'sib-api-v3-sdk/models/get_sms_event_report'
|
@@ -156,9 +173,12 @@ require 'sib-api-v3-sdk/models/send_smtp_email'
|
|
156
173
|
require 'sib-api-v3-sdk/models/send_smtp_email_attachment'
|
157
174
|
require 'sib-api-v3-sdk/models/send_smtp_email_bcc'
|
158
175
|
require 'sib-api-v3-sdk/models/send_smtp_email_cc'
|
176
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_message_versions'
|
159
177
|
require 'sib-api-v3-sdk/models/send_smtp_email_reply_to'
|
178
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_reply_to_1'
|
160
179
|
require 'sib-api-v3-sdk/models/send_smtp_email_sender'
|
161
180
|
require 'sib-api-v3-sdk/models/send_smtp_email_to'
|
181
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_to_1'
|
162
182
|
require 'sib-api-v3-sdk/models/send_template_email'
|
163
183
|
require 'sib-api-v3-sdk/models/send_test_email'
|
164
184
|
require 'sib-api-v3-sdk/models/send_test_sms'
|
@@ -180,14 +200,6 @@ require 'sib-api-v3-sdk/models/update_smtp_template'
|
|
180
200
|
require 'sib-api-v3-sdk/models/update_smtp_template_sender'
|
181
201
|
require 'sib-api-v3-sdk/models/update_webhook'
|
182
202
|
require 'sib-api-v3-sdk/models/upload_image_to_gallery'
|
183
|
-
require 'sib-api-v3-sdk/models/get_child_info'
|
184
|
-
require 'sib-api-v3-sdk/models/get_extended_campaign_overview'
|
185
|
-
require 'sib-api-v3-sdk/models/get_extended_client'
|
186
|
-
require 'sib-api-v3-sdk/models/get_extended_contact_details'
|
187
|
-
require 'sib-api-v3-sdk/models/get_extended_list'
|
188
|
-
require 'sib-api-v3-sdk/models/get_sms_campaign'
|
189
|
-
require 'sib-api-v3-sdk/models/get_account'
|
190
|
-
require 'sib-api-v3-sdk/models/get_email_campaign'
|
191
203
|
|
192
204
|
# APIs
|
193
205
|
require 'sib-api-v3-sdk/api/account_api'
|
@@ -199,8 +211,8 @@ require 'sib-api-v3-sdk/api/lists_api'
|
|
199
211
|
require 'sib-api-v3-sdk/api/process_api'
|
200
212
|
require 'sib-api-v3-sdk/api/reseller_api'
|
201
213
|
require 'sib-api-v3-sdk/api/sms_campaigns_api'
|
202
|
-
require 'sib-api-v3-sdk/api/smtp_api'
|
203
214
|
require 'sib-api-v3-sdk/api/senders_api'
|
215
|
+
require 'sib-api-v3-sdk/api/transactional_emails_api'
|
204
216
|
require 'sib-api-v3-sdk/api/transactional_sms_api'
|
205
217
|
require 'sib-api-v3-sdk/api/webhooks_api'
|
206
218
|
|
@@ -6,7 +6,7 @@
|
|
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.4.
|
9
|
+
Swagger Codegen version: 2.4.18
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,16 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
25
|
+
def setUserAgent(user_agent)
|
26
|
+
@user_agent = user_agent
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
22
32
|
# Get your account information, plan and credits details
|
23
33
|
# @param [Hash] opts the optional parameters
|
24
34
|
# @return [GetAccount]
|
@@ -6,7 +6,7 @@
|
|
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.4.
|
9
|
+
Swagger Codegen version: 2.4.18
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,16 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
25
|
+
def setUserAgent(user_agent)
|
26
|
+
@user_agent = user_agent
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
22
32
|
# Create contact attribute
|
23
33
|
# @param attribute_category Category of the attribute
|
24
34
|
# @param attribute_name Name of the attribute
|
@@ -6,7 +6,7 @@
|
|
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.4.
|
9
|
+
Swagger Codegen version: 2.4.18
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,9 +19,19 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
|
23
|
+
# Set custom user_agent if explicitly passed in api
|
24
|
+
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
25
|
+
def setUserAgent(user_agent)
|
26
|
+
@user_agent = user_agent
|
27
|
+
if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
|
28
|
+
@api_client.default_headers['User-Agent'] = @user_agent
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
22
32
|
# Add existing contacts to a list
|
23
33
|
# @param list_id Id of the list
|
24
|
-
# @param contact_emails Emails addresses of the contacts
|
34
|
+
# @param contact_emails Emails addresses OR IDs of the contacts
|
25
35
|
# @param [Hash] opts the optional parameters
|
26
36
|
# @return [PostContactInfo]
|
27
37
|
def add_contact_to_list(list_id, contact_emails, opts = {})
|
@@ -31,7 +41,7 @@ module SibApiV3Sdk
|
|
31
41
|
|
32
42
|
# Add existing contacts to a list
|
33
43
|
# @param list_id Id of the list
|
34
|
-
# @param contact_emails Emails addresses of the contacts
|
44
|
+
# @param contact_emails Emails addresses OR IDs of the contacts
|
35
45
|
# @param [Hash] opts the optional parameters
|
36
46
|
# @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
|
37
47
|
def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
|
@@ -413,28 +423,28 @@ module SibApiV3Sdk
|
|
413
423
|
return data, status_code, headers
|
414
424
|
end
|
415
425
|
# Delete a contact
|
416
|
-
# @param
|
426
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
417
427
|
# @param [Hash] opts the optional parameters
|
418
428
|
# @return [nil]
|
419
|
-
def delete_contact(
|
420
|
-
delete_contact_with_http_info(
|
429
|
+
def delete_contact(identifier, opts = {})
|
430
|
+
delete_contact_with_http_info(identifier, opts)
|
421
431
|
nil
|
422
432
|
end
|
423
433
|
|
424
434
|
# Delete a contact
|
425
|
-
# @param
|
435
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
426
436
|
# @param [Hash] opts the optional parameters
|
427
437
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
428
|
-
def delete_contact_with_http_info(
|
438
|
+
def delete_contact_with_http_info(identifier, opts = {})
|
429
439
|
if @api_client.config.debugging
|
430
440
|
@api_client.config.logger.debug 'Calling API: ContactsApi.delete_contact ...'
|
431
441
|
end
|
432
|
-
# verify the required parameter '
|
433
|
-
if @api_client.config.client_side_validation &&
|
434
|
-
fail ArgumentError, "Missing the required parameter '
|
442
|
+
# verify the required parameter 'identifier' is set
|
443
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
444
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.delete_contact"
|
435
445
|
end
|
436
446
|
# resource path
|
437
|
-
local_var_path = '/contacts/{
|
447
|
+
local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
|
438
448
|
|
439
449
|
# query parameters
|
440
450
|
query_params = {}
|
@@ -612,28 +622,28 @@ module SibApiV3Sdk
|
|
612
622
|
return data, status_code, headers
|
613
623
|
end
|
614
624
|
# Get a contact's details
|
615
|
-
# @param
|
625
|
+
# @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
616
626
|
# @param [Hash] opts the optional parameters
|
617
627
|
# @return [GetExtendedContactDetails]
|
618
|
-
def get_contact_info(
|
619
|
-
data, _status_code, _headers = get_contact_info_with_http_info(
|
628
|
+
def get_contact_info(identifier, opts = {})
|
629
|
+
data, _status_code, _headers = get_contact_info_with_http_info(identifier, opts)
|
620
630
|
data
|
621
631
|
end
|
622
632
|
|
623
633
|
# Get a contact's details
|
624
|
-
# @param
|
634
|
+
# @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
625
635
|
# @param [Hash] opts the optional parameters
|
626
636
|
# @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
|
627
|
-
def get_contact_info_with_http_info(
|
637
|
+
def get_contact_info_with_http_info(identifier, opts = {})
|
628
638
|
if @api_client.config.debugging
|
629
639
|
@api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_info ...'
|
630
640
|
end
|
631
|
-
# verify the required parameter '
|
632
|
-
if @api_client.config.client_side_validation &&
|
633
|
-
fail ArgumentError, "Missing the required parameter '
|
641
|
+
# verify the required parameter 'identifier' is set
|
642
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
643
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_info"
|
634
644
|
end
|
635
645
|
# resource path
|
636
|
-
local_var_path = '/contacts/{
|
646
|
+
local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
|
637
647
|
|
638
648
|
# query parameters
|
639
649
|
query_params = {}
|
@@ -664,32 +674,32 @@ module SibApiV3Sdk
|
|
664
674
|
return data, status_code, headers
|
665
675
|
end
|
666
676
|
# Get email campaigns' statistics for a contact
|
667
|
-
# @param
|
677
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
668
678
|
# @param [Hash] opts the optional parameters
|
669
679
|
# @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
670
680
|
# @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
671
681
|
# @return [GetContactCampaignStats]
|
672
|
-
def get_contact_stats(
|
673
|
-
data, _status_code, _headers = get_contact_stats_with_http_info(
|
682
|
+
def get_contact_stats(identifier, opts = {})
|
683
|
+
data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
|
674
684
|
data
|
675
685
|
end
|
676
686
|
|
677
687
|
# Get email campaigns' statistics for a contact
|
678
|
-
# @param
|
688
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
679
689
|
# @param [Hash] opts the optional parameters
|
680
690
|
# @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
681
691
|
# @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
682
692
|
# @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
|
683
|
-
def get_contact_stats_with_http_info(
|
693
|
+
def get_contact_stats_with_http_info(identifier, opts = {})
|
684
694
|
if @api_client.config.debugging
|
685
695
|
@api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_stats ...'
|
686
696
|
end
|
687
|
-
# verify the required parameter '
|
688
|
-
if @api_client.config.client_side_validation &&
|
689
|
-
fail ArgumentError, "Missing the required parameter '
|
697
|
+
# verify the required parameter 'identifier' is set
|
698
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
699
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_stats"
|
690
700
|
end
|
691
701
|
# resource path
|
692
|
-
local_var_path = '/contacts/{
|
702
|
+
local_var_path = '/contacts/{identifier}/campaignStats'.sub('{' + 'identifier' + '}', identifier.to_s)
|
693
703
|
|
694
704
|
# query parameters
|
695
705
|
query_params = {}
|
@@ -725,7 +735,8 @@ module SibApiV3Sdk
|
|
725
735
|
# @param [Hash] opts the optional parameters
|
726
736
|
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
727
737
|
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
728
|
-
# @option opts [
|
738
|
+
# @option opts [String] :modified_since 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.
|
739
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
729
740
|
# @return [GetContacts]
|
730
741
|
def get_contacts(opts = {})
|
731
742
|
data, _status_code, _headers = get_contacts_with_http_info(opts)
|
@@ -736,7 +747,8 @@ module SibApiV3Sdk
|
|
736
747
|
# @param [Hash] opts the optional parameters
|
737
748
|
# @option opts [Integer] :limit Number of documents per page
|
738
749
|
# @option opts [Integer] :offset Index of the first document of the page
|
739
|
-
# @option opts [
|
750
|
+
# @option opts [String] :modified_since 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.
|
751
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
740
752
|
# @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
|
741
753
|
def get_contacts_with_http_info(opts = {})
|
742
754
|
if @api_client.config.debugging
|
@@ -746,6 +758,9 @@ module SibApiV3Sdk
|
|
746
758
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts, must be smaller than or equal to 1000.'
|
747
759
|
end
|
748
760
|
|
761
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
762
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
763
|
+
end
|
749
764
|
# resource path
|
750
765
|
local_var_path = '/contacts'
|
751
766
|
|
@@ -754,6 +769,7 @@ module SibApiV3Sdk
|
|
754
769
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
755
770
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
756
771
|
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
772
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
757
773
|
|
758
774
|
# header parameters
|
759
775
|
header_params = {}
|
@@ -783,9 +799,10 @@ module SibApiV3Sdk
|
|
783
799
|
# Get contacts in a list
|
784
800
|
# @param list_id Id of the list
|
785
801
|
# @param [Hash] opts the optional parameters
|
786
|
-
# @option opts [
|
802
|
+
# @option opts [String] :modified_since 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.
|
787
803
|
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
788
804
|
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
805
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
789
806
|
# @return [GetContacts]
|
790
807
|
def get_contacts_from_list(list_id, opts = {})
|
791
808
|
data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
|
@@ -795,9 +812,10 @@ module SibApiV3Sdk
|
|
795
812
|
# Get contacts in a list
|
796
813
|
# @param list_id Id of the list
|
797
814
|
# @param [Hash] opts the optional parameters
|
798
|
-
# @option opts [
|
815
|
+
# @option opts [String] :modified_since 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.
|
799
816
|
# @option opts [Integer] :limit Number of documents per page
|
800
817
|
# @option opts [Integer] :offset Index of the first document of the page
|
818
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
801
819
|
# @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
|
802
820
|
def get_contacts_from_list_with_http_info(list_id, opts = {})
|
803
821
|
if @api_client.config.debugging
|
@@ -811,6 +829,9 @@ module SibApiV3Sdk
|
|
811
829
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts_from_list, must be smaller than or equal to 500.'
|
812
830
|
end
|
813
831
|
|
832
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
833
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
834
|
+
end
|
814
835
|
# resource path
|
815
836
|
local_var_path = '/contacts/lists/{listId}/contacts'.sub('{' + 'listId' + '}', list_id.to_s)
|
816
837
|
|
@@ -819,6 +840,7 @@ module SibApiV3Sdk
|
|
819
840
|
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
820
841
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
821
842
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
843
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
822
844
|
|
823
845
|
# header parameters
|
824
846
|
header_params = {}
|
@@ -902,6 +924,7 @@ module SibApiV3Sdk
|
|
902
924
|
# @param [Hash] opts the optional parameters
|
903
925
|
# @option opts [Integer] :limit Number of documents per page (default to 10)
|
904
926
|
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
927
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
905
928
|
# @return [GetFolderLists]
|
906
929
|
def get_folder_lists(folder_id, opts = {})
|
907
930
|
data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
|
@@ -913,6 +936,7 @@ module SibApiV3Sdk
|
|
913
936
|
# @param [Hash] opts the optional parameters
|
914
937
|
# @option opts [Integer] :limit Number of documents per page
|
915
938
|
# @option opts [Integer] :offset Index of the first document of the page
|
939
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
916
940
|
# @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
|
917
941
|
def get_folder_lists_with_http_info(folder_id, opts = {})
|
918
942
|
if @api_client.config.debugging
|
@@ -926,6 +950,9 @@ module SibApiV3Sdk
|
|
926
950
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_folder_lists, must be smaller than or equal to 50.'
|
927
951
|
end
|
928
952
|
|
953
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
954
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
955
|
+
end
|
929
956
|
# resource path
|
930
957
|
local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
|
931
958
|
|
@@ -933,6 +960,7 @@ module SibApiV3Sdk
|
|
933
960
|
query_params = {}
|
934
961
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
935
962
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
963
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
936
964
|
|
937
965
|
# header parameters
|
938
966
|
header_params = {}
|
@@ -963,6 +991,7 @@ module SibApiV3Sdk
|
|
963
991
|
# @param limit Number of documents per page
|
964
992
|
# @param offset Index of the first document of the page
|
965
993
|
# @param [Hash] opts the optional parameters
|
994
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
966
995
|
# @return [GetFolders]
|
967
996
|
def get_folders(limit, offset, opts = {})
|
968
997
|
data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
|
@@ -973,6 +1002,7 @@ module SibApiV3Sdk
|
|
973
1002
|
# @param limit Number of documents per page
|
974
1003
|
# @param offset Index of the first document of the page
|
975
1004
|
# @param [Hash] opts the optional parameters
|
1005
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
976
1006
|
# @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
|
977
1007
|
def get_folders_with_http_info(limit, offset, opts = {})
|
978
1008
|
if @api_client.config.debugging
|
@@ -990,6 +1020,9 @@ module SibApiV3Sdk
|
|
990
1020
|
if @api_client.config.client_side_validation && offset.nil?
|
991
1021
|
fail ArgumentError, "Missing the required parameter 'offset' when calling ContactsApi.get_folders"
|
992
1022
|
end
|
1023
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
1024
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
1025
|
+
end
|
993
1026
|
# resource path
|
994
1027
|
local_var_path = '/contacts/folders'
|
995
1028
|
|
@@ -997,6 +1030,7 @@ module SibApiV3Sdk
|
|
997
1030
|
query_params = {}
|
998
1031
|
query_params[:'limit'] = limit
|
999
1032
|
query_params[:'offset'] = offset
|
1033
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1000
1034
|
|
1001
1035
|
# header parameters
|
1002
1036
|
header_params = {}
|
@@ -1079,6 +1113,7 @@ module SibApiV3Sdk
|
|
1079
1113
|
# @param [Hash] opts the optional parameters
|
1080
1114
|
# @option opts [Integer] :limit Number of documents per page (default to 10)
|
1081
1115
|
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
1116
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
1082
1117
|
# @return [GetLists]
|
1083
1118
|
def get_lists(opts = {})
|
1084
1119
|
data, _status_code, _headers = get_lists_with_http_info(opts)
|
@@ -1089,6 +1124,7 @@ module SibApiV3Sdk
|
|
1089
1124
|
# @param [Hash] opts the optional parameters
|
1090
1125
|
# @option opts [Integer] :limit Number of documents per page
|
1091
1126
|
# @option opts [Integer] :offset Index of the first document of the page
|
1127
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1092
1128
|
# @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
|
1093
1129
|
def get_lists_with_http_info(opts = {})
|
1094
1130
|
if @api_client.config.debugging
|
@@ -1098,6 +1134,9 @@ module SibApiV3Sdk
|
|
1098
1134
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_lists, must be smaller than or equal to 50.'
|
1099
1135
|
end
|
1100
1136
|
|
1137
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
1138
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
1139
|
+
end
|
1101
1140
|
# resource path
|
1102
1141
|
local_var_path = '/contacts/lists'
|
1103
1142
|
|
@@ -1105,6 +1144,7 @@ module SibApiV3Sdk
|
|
1105
1144
|
query_params = {}
|
1106
1145
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
1107
1146
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
1147
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1108
1148
|
|
1109
1149
|
# header parameters
|
1110
1150
|
header_params = {}
|
@@ -1187,7 +1227,7 @@ module SibApiV3Sdk
|
|
1187
1227
|
end
|
1188
1228
|
# Delete a contact from a list
|
1189
1229
|
# @param list_id Id of the list
|
1190
|
-
# @param contact_emails Emails
|
1230
|
+
# @param contact_emails Emails addresses OR IDs of the contacts
|
1191
1231
|
# @param [Hash] opts the optional parameters
|
1192
1232
|
# @return [PostContactInfo]
|
1193
1233
|
def remove_contact_from_list(list_id, contact_emails, opts = {})
|
@@ -1197,7 +1237,7 @@ module SibApiV3Sdk
|
|
1197
1237
|
|
1198
1238
|
# Delete a contact from a list
|
1199
1239
|
# @param list_id Id of the list
|
1200
|
-
# @param contact_emails Emails
|
1240
|
+
# @param contact_emails Emails addresses OR IDs of the contacts
|
1201
1241
|
# @param [Hash] opts the optional parameters
|
1202
1242
|
# @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
|
1203
1243
|
def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
|
@@ -1365,34 +1405,34 @@ module SibApiV3Sdk
|
|
1365
1405
|
return data, status_code, headers
|
1366
1406
|
end
|
1367
1407
|
# Update a contact
|
1368
|
-
# @param
|
1408
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
1369
1409
|
# @param update_contact Values to update a contact
|
1370
1410
|
# @param [Hash] opts the optional parameters
|
1371
1411
|
# @return [nil]
|
1372
|
-
def update_contact(
|
1373
|
-
update_contact_with_http_info(
|
1412
|
+
def update_contact(identifier, update_contact, opts = {})
|
1413
|
+
update_contact_with_http_info(identifier, update_contact, opts)
|
1374
1414
|
nil
|
1375
1415
|
end
|
1376
1416
|
|
1377
1417
|
# Update a contact
|
1378
|
-
# @param
|
1418
|
+
# @param identifier Email (urlencoded) OR ID of the contact
|
1379
1419
|
# @param update_contact Values to update a contact
|
1380
1420
|
# @param [Hash] opts the optional parameters
|
1381
1421
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1382
|
-
def update_contact_with_http_info(
|
1422
|
+
def update_contact_with_http_info(identifier, update_contact, opts = {})
|
1383
1423
|
if @api_client.config.debugging
|
1384
1424
|
@api_client.config.logger.debug 'Calling API: ContactsApi.update_contact ...'
|
1385
1425
|
end
|
1386
|
-
# verify the required parameter '
|
1387
|
-
if @api_client.config.client_side_validation &&
|
1388
|
-
fail ArgumentError, "Missing the required parameter '
|
1426
|
+
# verify the required parameter 'identifier' is set
|
1427
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
1428
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.update_contact"
|
1389
1429
|
end
|
1390
1430
|
# verify the required parameter 'update_contact' is set
|
1391
1431
|
if @api_client.config.client_side_validation && update_contact.nil?
|
1392
1432
|
fail ArgumentError, "Missing the required parameter 'update_contact' when calling ContactsApi.update_contact"
|
1393
1433
|
end
|
1394
1434
|
# resource path
|
1395
|
-
local_var_path = '/contacts/{
|
1435
|
+
local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
|
1396
1436
|
|
1397
1437
|
# query parameters
|
1398
1438
|
query_params = {}
|