sib-api-v3-sdk 5.2.5 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +100 -75
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +2 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +136 -73
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +4 -1
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +17 -17
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +3 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +158 -91
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SendEmail.md +3 -3
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +2 -2
- data/docs/SendersApi.md +8 -8
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +4 -1
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UpdateWebhook.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +20 -3
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +62 -73
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +17 -26
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +53 -54
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +9 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +20 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +10 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +4 -33
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +10 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +11 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +78 -10
data/docs/ContactsApi.md
CHANGED
@@ -5,30 +5,31 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
8
|
-
[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
8
|
+
[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
9
9
|
[**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
|
10
|
+
[**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
10
11
|
[**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
11
12
|
[**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
12
|
-
[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
13
|
-
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{
|
13
|
+
[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
14
|
+
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
|
14
15
|
[**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
15
16
|
[**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
16
|
-
[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes |
|
17
|
-
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{
|
18
|
-
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{
|
17
|
+
[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
18
|
+
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
|
19
|
+
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
|
19
20
|
[**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
|
20
|
-
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
21
|
-
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
22
|
-
[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
23
|
-
[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all
|
24
|
-
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
21
|
+
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
22
|
+
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
23
|
+
[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
24
|
+
[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
25
|
+
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
25
26
|
[**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
26
27
|
[**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
|
27
|
-
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
28
|
+
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
28
29
|
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
29
|
-
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
30
|
-
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{
|
31
|
-
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
30
|
+
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
31
|
+
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
|
32
|
+
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
32
33
|
[**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
33
34
|
|
34
35
|
|
@@ -58,7 +59,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
58
59
|
|
59
60
|
list_id = 789 # Integer | Id of the list
|
60
61
|
|
61
|
-
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
|
62
|
+
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
|
62
63
|
|
63
64
|
|
64
65
|
begin
|
@@ -75,7 +76,7 @@ end
|
|
75
76
|
Name | Type | Description | Notes
|
76
77
|
------------- | ------------- | ------------- | -------------
|
77
78
|
**list_id** | **Integer**| Id of the list |
|
78
|
-
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
|
79
|
+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
79
80
|
|
80
81
|
### Return type
|
81
82
|
|
@@ -95,7 +96,7 @@ Name | Type | Description | Notes
|
|
95
96
|
# **create_attribute**
|
96
97
|
> create_attribute(attribute_category, attribute_name, create_attribute)
|
97
98
|
|
98
|
-
|
99
|
+
Create contact attribute
|
99
100
|
|
100
101
|
### Example
|
101
102
|
```ruby
|
@@ -116,15 +117,15 @@ end
|
|
116
117
|
|
117
118
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
118
119
|
|
119
|
-
attribute_category =
|
120
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
120
121
|
|
121
|
-
attribute_name =
|
122
|
+
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
122
123
|
|
123
124
|
create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
124
125
|
|
125
126
|
|
126
127
|
begin
|
127
|
-
#
|
128
|
+
#Create contact attribute
|
128
129
|
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
129
130
|
rescue SibApiV3Sdk::ApiError => e
|
130
131
|
puts "Exception when calling ContactsApi->create_attribute: #{e}"
|
@@ -211,6 +212,62 @@ Name | Type | Description | Notes
|
|
211
212
|
|
212
213
|
|
213
214
|
|
215
|
+
# **create_doi_contact**
|
216
|
+
> create_doi_contact(create_doi_contact)
|
217
|
+
|
218
|
+
Create Contact via DOI (Double-Opt-In) Flow
|
219
|
+
|
220
|
+
### Example
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'sib-api-v3-sdk'
|
224
|
+
# setup authorization
|
225
|
+
SibApiV3Sdk.configure do |config|
|
226
|
+
# Configure API key authorization: api-key
|
227
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
229
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
230
|
+
|
231
|
+
# Configure API key authorization: partner-key
|
232
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
233
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
234
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
235
|
+
end
|
236
|
+
|
237
|
+
api_instance = SibApiV3Sdk::ContactsApi.new
|
238
|
+
|
239
|
+
create_doi_contact = SibApiV3Sdk::CreateDoiContact.new # CreateDoiContact | Values to create the Double opt-in (DOI) contact
|
240
|
+
|
241
|
+
|
242
|
+
begin
|
243
|
+
#Create Contact via DOI (Double-Opt-In) Flow
|
244
|
+
api_instance.create_doi_contact(create_doi_contact)
|
245
|
+
rescue SibApiV3Sdk::ApiError => e
|
246
|
+
puts "Exception when calling ContactsApi->create_doi_contact: #{e}"
|
247
|
+
end
|
248
|
+
```
|
249
|
+
|
250
|
+
### Parameters
|
251
|
+
|
252
|
+
Name | Type | Description | Notes
|
253
|
+
------------- | ------------- | ------------- | -------------
|
254
|
+
**create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
nil (empty response body)
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: application/json
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
270
|
+
|
214
271
|
# **create_folder**
|
215
272
|
> CreateModel create_folder(create_folder)
|
216
273
|
|
@@ -328,7 +385,7 @@ Name | Type | Description | Notes
|
|
328
385
|
# **delete_attribute**
|
329
386
|
> delete_attribute(attribute_category, attribute_name)
|
330
387
|
|
331
|
-
|
388
|
+
Delete an attribute
|
332
389
|
|
333
390
|
### Example
|
334
391
|
```ruby
|
@@ -349,13 +406,13 @@ end
|
|
349
406
|
|
350
407
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
351
408
|
|
352
|
-
attribute_category =
|
409
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
353
410
|
|
354
|
-
attribute_name =
|
411
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
355
412
|
|
356
413
|
|
357
414
|
begin
|
358
|
-
#
|
415
|
+
#Delete an attribute
|
359
416
|
api_instance.delete_attribute(attribute_category, attribute_name)
|
360
417
|
rescue SibApiV3Sdk::ApiError => e
|
361
418
|
puts "Exception when calling ContactsApi->delete_attribute: #{e}"
|
@@ -385,9 +442,9 @@ nil (empty response body)
|
|
385
442
|
|
386
443
|
|
387
444
|
# **delete_contact**
|
388
|
-
> delete_contact(
|
445
|
+
> delete_contact(identifier)
|
389
446
|
|
390
|
-
|
447
|
+
Delete a contact
|
391
448
|
|
392
449
|
### Example
|
393
450
|
```ruby
|
@@ -408,12 +465,12 @@ end
|
|
408
465
|
|
409
466
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
410
467
|
|
411
|
-
|
468
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
412
469
|
|
413
470
|
|
414
471
|
begin
|
415
|
-
#
|
416
|
-
api_instance.delete_contact(
|
472
|
+
#Delete a contact
|
473
|
+
api_instance.delete_contact(identifier)
|
417
474
|
rescue SibApiV3Sdk::ApiError => e
|
418
475
|
puts "Exception when calling ContactsApi->delete_contact: #{e}"
|
419
476
|
end
|
@@ -423,7 +480,7 @@ end
|
|
423
480
|
|
424
481
|
Name | Type | Description | Notes
|
425
482
|
------------- | ------------- | ------------- | -------------
|
426
|
-
**
|
483
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
427
484
|
|
428
485
|
### Return type
|
429
486
|
|
@@ -555,7 +612,7 @@ nil (empty response body)
|
|
555
612
|
# **get_attributes**
|
556
613
|
> GetAttributes get_attributes
|
557
614
|
|
558
|
-
|
615
|
+
List all attributes
|
559
616
|
|
560
617
|
### Example
|
561
618
|
```ruby
|
@@ -577,7 +634,7 @@ end
|
|
577
634
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
578
635
|
|
579
636
|
begin
|
580
|
-
#
|
637
|
+
#List all attributes
|
581
638
|
result = api_instance.get_attributes
|
582
639
|
p result
|
583
640
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -604,9 +661,9 @@ This endpoint does not need any parameter.
|
|
604
661
|
|
605
662
|
|
606
663
|
# **get_contact_info**
|
607
|
-
> GetExtendedContactDetails get_contact_info(
|
664
|
+
> GetExtendedContactDetails get_contact_info(identifier)
|
608
665
|
|
609
|
-
|
666
|
+
Get a contact's details
|
610
667
|
|
611
668
|
### Example
|
612
669
|
```ruby
|
@@ -627,12 +684,12 @@ end
|
|
627
684
|
|
628
685
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
629
686
|
|
630
|
-
|
687
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
631
688
|
|
632
689
|
|
633
690
|
begin
|
634
|
-
#
|
635
|
-
result = api_instance.get_contact_info(
|
691
|
+
#Get a contact's details
|
692
|
+
result = api_instance.get_contact_info(identifier)
|
636
693
|
p result
|
637
694
|
rescue SibApiV3Sdk::ApiError => e
|
638
695
|
puts "Exception when calling ContactsApi->get_contact_info: #{e}"
|
@@ -643,7 +700,7 @@ end
|
|
643
700
|
|
644
701
|
Name | Type | Description | Notes
|
645
702
|
------------- | ------------- | ------------- | -------------
|
646
|
-
**
|
703
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
|
647
704
|
|
648
705
|
### Return type
|
649
706
|
|
@@ -661,9 +718,9 @@ Name | Type | Description | Notes
|
|
661
718
|
|
662
719
|
|
663
720
|
# **get_contact_stats**
|
664
|
-
> GetContactCampaignStats get_contact_stats(
|
721
|
+
> GetContactCampaignStats get_contact_stats(identifier, opts)
|
665
722
|
|
666
|
-
Get
|
723
|
+
Get email campaigns' statistics for a contact
|
667
724
|
|
668
725
|
### Example
|
669
726
|
```ruby
|
@@ -684,12 +741,16 @@ end
|
|
684
741
|
|
685
742
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
686
743
|
|
687
|
-
|
744
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
688
745
|
|
746
|
+
opts = {
|
747
|
+
start_date: Date.parse('2013-10-20'), # 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
|
748
|
+
end_date: Date.parse('2013-10-20') # 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
|
749
|
+
}
|
689
750
|
|
690
751
|
begin
|
691
|
-
#Get
|
692
|
-
result = api_instance.get_contact_stats(
|
752
|
+
#Get email campaigns' statistics for a contact
|
753
|
+
result = api_instance.get_contact_stats(identifier, opts)
|
693
754
|
p result
|
694
755
|
rescue SibApiV3Sdk::ApiError => e
|
695
756
|
puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
|
@@ -700,7 +761,9 @@ end
|
|
700
761
|
|
701
762
|
Name | Type | Description | Notes
|
702
763
|
------------- | ------------- | ------------- | -------------
|
703
|
-
**
|
764
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
765
|
+
**start_date** | **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 | [optional]
|
766
|
+
**end_date** | **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 | [optional]
|
704
767
|
|
705
768
|
### Return type
|
706
769
|
|
@@ -744,7 +807,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
744
807
|
opts = {
|
745
808
|
limit: 50, # Integer | Number of documents per page
|
746
809
|
offset: 0, # Integer | Index of the first document of the page
|
747
|
-
modified_since: DateTime.parse(
|
810
|
+
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
748
811
|
}
|
749
812
|
|
750
813
|
begin
|
@@ -782,7 +845,7 @@ Name | Type | Description | Notes
|
|
782
845
|
# **get_contacts_from_list**
|
783
846
|
> GetContacts get_contacts_from_list(list_id, opts)
|
784
847
|
|
785
|
-
Get
|
848
|
+
Get contacts in a list
|
786
849
|
|
787
850
|
### Example
|
788
851
|
```ruby
|
@@ -806,13 +869,13 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
806
869
|
list_id = 789 # Integer | Id of the list
|
807
870
|
|
808
871
|
opts = {
|
809
|
-
modified_since: DateTime.parse(
|
872
|
+
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
810
873
|
limit: 50, # Integer | Number of documents per page
|
811
874
|
offset: 0 # Integer | Index of the first document of the page
|
812
875
|
}
|
813
876
|
|
814
877
|
begin
|
815
|
-
#Get
|
878
|
+
#Get contacts in a list
|
816
879
|
result = api_instance.get_contacts_from_list(list_id, opts)
|
817
880
|
p result
|
818
881
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -847,7 +910,7 @@ Name | Type | Description | Notes
|
|
847
910
|
# **get_folder**
|
848
911
|
> GetFolder get_folder(folder_id)
|
849
912
|
|
850
|
-
Returns folder details
|
913
|
+
Returns a folder's details
|
851
914
|
|
852
915
|
### Example
|
853
916
|
```ruby
|
@@ -872,7 +935,7 @@ folder_id = 789 # Integer | id of the folder
|
|
872
935
|
|
873
936
|
|
874
937
|
begin
|
875
|
-
#Returns folder details
|
938
|
+
#Returns a folder's details
|
876
939
|
result = api_instance.get_folder(folder_id)
|
877
940
|
p result
|
878
941
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -904,7 +967,7 @@ Name | Type | Description | Notes
|
|
904
967
|
# **get_folder_lists**
|
905
968
|
> GetFolderLists get_folder_lists(folder_id, opts)
|
906
969
|
|
907
|
-
Get
|
970
|
+
Get lists in a folder
|
908
971
|
|
909
972
|
### Example
|
910
973
|
```ruby
|
@@ -933,7 +996,7 @@ opts = {
|
|
933
996
|
}
|
934
997
|
|
935
998
|
begin
|
936
|
-
#Get
|
999
|
+
#Get lists in a folder
|
937
1000
|
result = api_instance.get_folder_lists(folder_id, opts)
|
938
1001
|
p result
|
939
1002
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -967,7 +1030,7 @@ Name | Type | Description | Notes
|
|
967
1030
|
# **get_folders**
|
968
1031
|
> GetFolders get_folders(limit, offset)
|
969
1032
|
|
970
|
-
Get all
|
1033
|
+
Get all folders
|
971
1034
|
|
972
1035
|
### Example
|
973
1036
|
```ruby
|
@@ -994,7 +1057,7 @@ offset = 0 # Integer | Index of the first document of the page
|
|
994
1057
|
|
995
1058
|
|
996
1059
|
begin
|
997
|
-
#Get all
|
1060
|
+
#Get all folders
|
998
1061
|
result = api_instance.get_folders(limit, offset)
|
999
1062
|
p result
|
1000
1063
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1027,7 +1090,7 @@ Name | Type | Description | Notes
|
|
1027
1090
|
# **get_list**
|
1028
1091
|
> GetExtendedList get_list(list_id)
|
1029
1092
|
|
1030
|
-
Get
|
1093
|
+
Get a list's details
|
1031
1094
|
|
1032
1095
|
### Example
|
1033
1096
|
```ruby
|
@@ -1052,7 +1115,7 @@ list_id = 789 # Integer | Id of the list
|
|
1052
1115
|
|
1053
1116
|
|
1054
1117
|
begin
|
1055
|
-
#Get
|
1118
|
+
#Get a list's details
|
1056
1119
|
result = api_instance.get_list(list_id)
|
1057
1120
|
p result
|
1058
1121
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1203,7 +1266,7 @@ Name | Type | Description | Notes
|
|
1203
1266
|
# **remove_contact_from_list**
|
1204
1267
|
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
1205
1268
|
|
1206
|
-
|
1269
|
+
Delete a contact from a list
|
1207
1270
|
|
1208
1271
|
### Example
|
1209
1272
|
```ruby
|
@@ -1226,11 +1289,11 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1226
1289
|
|
1227
1290
|
list_id = 789 # Integer | Id of the list
|
1228
1291
|
|
1229
|
-
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails
|
1292
|
+
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
|
1230
1293
|
|
1231
1294
|
|
1232
1295
|
begin
|
1233
|
-
#
|
1296
|
+
#Delete a contact from a list
|
1234
1297
|
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
1235
1298
|
p result
|
1236
1299
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -1243,7 +1306,7 @@ end
|
|
1243
1306
|
Name | Type | Description | Notes
|
1244
1307
|
------------- | ------------- | ------------- | -------------
|
1245
1308
|
**list_id** | **Integer**| Id of the list |
|
1246
|
-
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails
|
1309
|
+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
1247
1310
|
|
1248
1311
|
### Return type
|
1249
1312
|
|
@@ -1322,7 +1385,7 @@ Name | Type | Description | Notes
|
|
1322
1385
|
# **update_attribute**
|
1323
1386
|
> update_attribute(attribute_category, attribute_name, update_attribute)
|
1324
1387
|
|
1325
|
-
|
1388
|
+
Update contact attribute
|
1326
1389
|
|
1327
1390
|
### Example
|
1328
1391
|
```ruby
|
@@ -1343,15 +1406,15 @@ end
|
|
1343
1406
|
|
1344
1407
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
1345
1408
|
|
1346
|
-
attribute_category =
|
1409
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
1347
1410
|
|
1348
|
-
attribute_name =
|
1411
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
1349
1412
|
|
1350
1413
|
update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
1351
1414
|
|
1352
1415
|
|
1353
1416
|
begin
|
1354
|
-
#
|
1417
|
+
#Update contact attribute
|
1355
1418
|
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
1356
1419
|
rescue SibApiV3Sdk::ApiError => e
|
1357
1420
|
puts "Exception when calling ContactsApi->update_attribute: #{e}"
|
@@ -1382,9 +1445,9 @@ nil (empty response body)
|
|
1382
1445
|
|
1383
1446
|
|
1384
1447
|
# **update_contact**
|
1385
|
-
> update_contact(
|
1448
|
+
> update_contact(identifier, update_contact)
|
1386
1449
|
|
1387
|
-
|
1450
|
+
Update a contact
|
1388
1451
|
|
1389
1452
|
### Example
|
1390
1453
|
```ruby
|
@@ -1405,14 +1468,14 @@ end
|
|
1405
1468
|
|
1406
1469
|
api_instance = SibApiV3Sdk::ContactsApi.new
|
1407
1470
|
|
1408
|
-
|
1471
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
1409
1472
|
|
1410
1473
|
update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
|
1411
1474
|
|
1412
1475
|
|
1413
1476
|
begin
|
1414
|
-
#
|
1415
|
-
api_instance.update_contact(
|
1477
|
+
#Update a contact
|
1478
|
+
api_instance.update_contact(identifier, update_contact)
|
1416
1479
|
rescue SibApiV3Sdk::ApiError => e
|
1417
1480
|
puts "Exception when calling ContactsApi->update_contact: #{e}"
|
1418
1481
|
end
|
@@ -1422,7 +1485,7 @@ end
|
|
1422
1485
|
|
1423
1486
|
Name | Type | Description | Notes
|
1424
1487
|
------------- | ------------- | ------------- | -------------
|
1425
|
-
**
|
1488
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
1426
1489
|
**update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
|
1427
1490
|
|
1428
1491
|
### Return type
|
@@ -1443,7 +1506,7 @@ nil (empty response body)
|
|
1443
1506
|
# **update_folder**
|
1444
1507
|
> update_folder(folder_id, update_folder)
|
1445
1508
|
|
1446
|
-
Update a
|
1509
|
+
Update a folder
|
1447
1510
|
|
1448
1511
|
### Example
|
1449
1512
|
```ruby
|
@@ -1470,7 +1533,7 @@ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name
|
|
1470
1533
|
|
1471
1534
|
|
1472
1535
|
begin
|
1473
|
-
#Update a
|
1536
|
+
#Update a folder
|
1474
1537
|
api_instance.update_folder(folder_id, update_folder)
|
1475
1538
|
rescue SibApiV3Sdk::ApiError => e
|
1476
1539
|
puts "Exception when calling ContactsApi->update_folder: #{e}"
|