sib-api-v3-sdk 5.2.3 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +96 -68
- data/docs/AbTestCampaignResult.md +13 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +1 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +123 -60
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +3 -3
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +6 -3
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmtpEmail.md +1 -1
- data/docs/CreateSmtpTemplate.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/GetAccountRelay.md +1 -1
- data/docs/GetAccountRelayData.md +1 -1
- 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/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetSmtpTemplates.md +1 -1
- 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/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +8 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/ListsApi.md +13 -13
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +2 -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 +215 -86
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SMTPApi.md +350 -42
- data/docs/SendEmail.md +2 -2
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -1
- 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 +1 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendersApi.md +8 -8
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateContact.md +2 -2
- data/docs/UpdateEmailCampaign.md +5 -2
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +19 -2
- 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 +169 -186
- 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 +38 -65
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
- 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 +342 -92
- 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 +280 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
- 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 +10 -15
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
- 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 +13 -18
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
- 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 +11 -15
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +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 +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +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 +8 -13
- 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 +276 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
- 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 +9 -14
- 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 +10 -15
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +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 +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +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 +214 -0
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
- data/lib/sib-api-v3-sdk/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 +57 -68
- 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 +15 -24
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +64 -52
- 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 +88 -34
- 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_spec.rb +79 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +3 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +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 +14 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +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 +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +41 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- 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 +4 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +12 -13
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +4 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +59 -0
- 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 +70 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f95ab1900ea673f64cf7a1edee7db7c1810e8bc1018ea2e1933fbbb6d94a0059
|
4
|
+
data.tar.gz: 5545aac0b0762fdf65b9b105350a9699d49562d0e0626f77beadffeb17bec006
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40d877f79b569f7f4d44f8972e72f7b64ce1a4068d309ba9c3007705ba4b7e62c102a61286aae544f7c450ee3c2c80f58ede98b103afe1aacf1dde544d509e05
|
7
|
+
data.tar.gz: fb703e781f1730fbfe885c3ae6bfe4e2d1cdc585945591a8dcbe43ba66cf5fbedee0263ecc83071e4edb1a02b0e031311061852c59b813c80de3171c255fcbfe
|
data/Gemfile
CHANGED
data/LICENSE.md
CHANGED
data/README.md
CHANGED
@@ -69,7 +69,7 @@ end
|
|
69
69
|
api_instance = SibApiV3Sdk::AccountApi.new
|
70
70
|
|
71
71
|
begin
|
72
|
-
#Get your account
|
72
|
+
#Get your account information, plan and credits details
|
73
73
|
result = api_instance.get_account
|
74
74
|
p result
|
75
75
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -84,110 +84,121 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
84
84
|
|
85
85
|
Class | Method | HTTP request | Description
|
86
86
|
------------ | ------------- | ------------- | -------------
|
87
|
-
*SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account
|
88
|
-
*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
89
|
-
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
90
|
-
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes |
|
91
|
-
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
87
|
+
*SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
|
88
|
+
*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
89
|
+
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
90
|
+
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
91
|
+
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
92
92
|
*SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
93
|
-
*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
93
|
+
*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
94
94
|
*SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
|
95
|
+
*SibApiV3Sdk::ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
95
96
|
*SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
96
97
|
*SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
97
|
-
*SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
98
|
-
*SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} |
|
98
|
+
*SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
99
|
+
*SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
|
99
100
|
*SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
100
101
|
*SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
101
|
-
*SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes |
|
102
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} |
|
103
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get
|
102
|
+
*SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
103
|
+
*SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
|
104
|
+
*SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
|
104
105
|
*SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
|
105
|
-
*SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
106
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
107
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
108
|
-
*SibApiV3Sdk::ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all
|
109
|
-
*SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
106
|
+
*SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
107
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
108
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
109
|
+
*SibApiV3Sdk::ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
110
|
+
*SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
110
111
|
*SibApiV3Sdk::ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
111
112
|
*SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
|
112
|
-
*SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
113
|
+
*SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
113
114
|
*SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
114
|
-
*SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
115
|
-
*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} |
|
116
|
-
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
115
|
+
*SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
116
|
+
*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
|
117
|
+
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
117
118
|
*SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
118
119
|
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
119
120
|
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
120
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of
|
121
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
122
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
123
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
124
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**
|
121
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
122
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
123
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
124
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
125
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**get_shared_template_url**](docs/EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
126
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
127
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
125
128
|
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
126
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update
|
127
|
-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update
|
129
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
130
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
131
|
+
*SibApiV3Sdk::EmailCampaignsApi* | [**upload_image_to_gallery**](docs/EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
128
132
|
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
129
133
|
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
130
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
|
131
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
132
|
-
*SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all
|
133
|
-
*SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a
|
134
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
135
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
136
|
+
*SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
137
|
+
*SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
134
138
|
*SibApiV3Sdk::ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
135
139
|
*SibApiV3Sdk::ListsApi* | [**create_list**](docs/ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
136
140
|
*SibApiV3Sdk::ListsApi* | [**delete_list**](docs/ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
137
|
-
*SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get
|
138
|
-
*SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get
|
139
|
-
*SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get
|
141
|
+
*SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
142
|
+
*SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
143
|
+
*SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
140
144
|
*SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
141
|
-
*SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove |
|
145
|
+
*SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
142
146
|
*SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
143
147
|
*SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
|
144
148
|
*SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
|
145
|
-
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{
|
146
|
-
*SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{
|
147
|
-
*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{
|
149
|
+
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
150
|
+
*SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
151
|
+
*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
148
152
|
*SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
|
149
|
-
*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{
|
150
|
-
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{
|
151
|
-
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{
|
152
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
153
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
154
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
155
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
156
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
157
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
158
|
-
*SibApiV3Sdk::ResellerApi* | [**
|
153
|
+
*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
154
|
+
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
155
|
+
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
156
|
+
*SibApiV3Sdk::ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
157
|
+
*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
158
|
+
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
159
|
+
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
|
160
|
+
*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO)
|
161
|
+
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
162
|
+
*SibApiV3Sdk::ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
163
|
+
*SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
164
|
+
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
159
165
|
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
160
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete
|
166
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
161
167
|
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
162
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the
|
163
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients |
|
168
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
169
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
164
170
|
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_campaign_now**](docs/SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
165
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send
|
166
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send
|
167
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} |
|
168
|
-
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update
|
169
|
-
*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an
|
171
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
172
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
173
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
174
|
+
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
175
|
+
*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
170
176
|
*SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
171
|
-
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive
|
172
|
-
*SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your
|
173
|
-
*SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your
|
174
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your
|
175
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template
|
176
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of
|
177
|
+
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
178
|
+
*SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
179
|
+
*SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
180
|
+
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
181
|
+
*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
182
|
+
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
183
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
184
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
185
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
177
186
|
*SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
178
187
|
*SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
179
188
|
*SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
180
|
-
*SibApiV3Sdk::SMTPApi* | [**
|
189
|
+
*SibApiV3Sdk::SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
190
|
+
*SibApiV3Sdk::SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
191
|
+
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
181
192
|
*SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
|
182
193
|
*SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
|
183
|
-
*SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips |
|
184
|
-
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips |
|
194
|
+
*SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
195
|
+
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
185
196
|
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
|
186
197
|
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
|
187
|
-
*SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all
|
198
|
+
*SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
188
199
|
*SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
189
200
|
*SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
190
|
-
*SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send
|
201
|
+
*SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
191
202
|
*SibApiV3Sdk::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
|
192
203
|
*SibApiV3Sdk::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
193
204
|
*SibApiV3Sdk::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
@@ -197,6 +208,7 @@ Class | Method | HTTP request | Description
|
|
197
208
|
|
198
209
|
## Documentation for Models
|
199
210
|
|
211
|
+
- [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
|
200
212
|
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
|
201
213
|
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
|
202
214
|
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
|
@@ -204,6 +216,7 @@ Class | Method | HTTP request | Description
|
|
204
216
|
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
|
205
217
|
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
|
206
218
|
- [SibApiV3Sdk::CreateContact](docs/CreateContact.md)
|
219
|
+
- [SibApiV3Sdk::CreateDoiContact](docs/CreateDoiContact.md)
|
207
220
|
- [SibApiV3Sdk::CreateEmailCampaign](docs/CreateEmailCampaign.md)
|
208
221
|
- [SibApiV3Sdk::CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md)
|
209
222
|
- [SibApiV3Sdk::CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
|
@@ -236,6 +249,7 @@ Class | Method | HTTP request | Description
|
|
236
249
|
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
|
237
250
|
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
|
238
251
|
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
|
252
|
+
- [SibApiV3Sdk::GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
|
239
253
|
- [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
|
240
254
|
- [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
|
241
255
|
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
|
@@ -252,6 +266,7 @@ Class | Method | HTTP request | Description
|
|
252
266
|
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
|
253
267
|
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
|
254
268
|
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
|
269
|
+
- [SibApiV3Sdk::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
|
255
270
|
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
|
256
271
|
- [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
|
257
272
|
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
|
@@ -283,6 +298,7 @@ Class | Method | HTTP request | Description
|
|
283
298
|
- [SibApiV3Sdk::GetSendersList](docs/GetSendersList.md)
|
284
299
|
- [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
|
285
300
|
- [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
|
301
|
+
- [SibApiV3Sdk::GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
|
286
302
|
- [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
|
287
303
|
- [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
|
288
304
|
- [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
|
@@ -292,8 +308,17 @@ Class | Method | HTTP request | Description
|
|
292
308
|
- [SibApiV3Sdk::GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
|
293
309
|
- [SibApiV3Sdk::GetSmtpTemplates](docs/GetSmtpTemplates.md)
|
294
310
|
- [SibApiV3Sdk::GetSsoToken](docs/GetSsoToken.md)
|
311
|
+
- [SibApiV3Sdk::GetStatsByBrowser](docs/GetStatsByBrowser.md)
|
312
|
+
- [SibApiV3Sdk::GetStatsByDevice](docs/GetStatsByDevice.md)
|
295
313
|
- [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
|
296
314
|
- [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
|
315
|
+
- [SibApiV3Sdk::GetTransacBlockedContacts](docs/GetTransacBlockedContacts.md)
|
316
|
+
- [SibApiV3Sdk::GetTransacBlockedContactsContacts](docs/GetTransacBlockedContactsContacts.md)
|
317
|
+
- [SibApiV3Sdk::GetTransacBlockedContactsReason](docs/GetTransacBlockedContactsReason.md)
|
318
|
+
- [SibApiV3Sdk::GetTransacEmailContent](docs/GetTransacEmailContent.md)
|
319
|
+
- [SibApiV3Sdk::GetTransacEmailContentEvents](docs/GetTransacEmailContentEvents.md)
|
320
|
+
- [SibApiV3Sdk::GetTransacEmailsList](docs/GetTransacEmailsList.md)
|
321
|
+
- [SibApiV3Sdk::GetTransacEmailsListTransactionalEmails](docs/GetTransacEmailsListTransactionalEmails.md)
|
297
322
|
- [SibApiV3Sdk::GetTransacSmsReport](docs/GetTransacSmsReport.md)
|
298
323
|
- [SibApiV3Sdk::GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
|
299
324
|
- [SibApiV3Sdk::GetWebhook](docs/GetWebhook.md)
|
@@ -309,6 +334,7 @@ Class | Method | HTTP request | Description
|
|
309
334
|
- [SibApiV3Sdk::RemoveContactFromList](docs/RemoveContactFromList.md)
|
310
335
|
- [SibApiV3Sdk::RemoveCredits](docs/RemoveCredits.md)
|
311
336
|
- [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
|
337
|
+
- [SibApiV3Sdk::RequestContactExportCustomContactFilter](docs/RequestContactExportCustomContactFilter.md)
|
312
338
|
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
|
313
339
|
- [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
|
314
340
|
- [SibApiV3Sdk::RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
|
@@ -332,6 +358,7 @@ Class | Method | HTTP request | Description
|
|
332
358
|
- [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
|
333
359
|
- [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
|
334
360
|
- [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
|
361
|
+
- [SibApiV3Sdk::UpdateChildAccountStatus](docs/UpdateChildAccountStatus.md)
|
335
362
|
- [SibApiV3Sdk::UpdateChildDomain](docs/UpdateChildDomain.md)
|
336
363
|
- [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)
|
337
364
|
- [SibApiV3Sdk::UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
|
@@ -343,6 +370,7 @@ Class | Method | HTTP request | Description
|
|
343
370
|
- [SibApiV3Sdk::UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
|
344
371
|
- [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
|
345
372
|
- [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
|
373
|
+
- [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
|
346
374
|
- [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
|
347
375
|
- [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
|
348
376
|
- [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::AbTestCampaignResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**winning_version** | **String** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional]
|
7
|
+
**winning_criteria** | **String** | Criteria choosen for winning version (Open/Click) | [optional]
|
8
|
+
**winning_subject_line** | **String** | Subject Line of current winning version | [optional]
|
9
|
+
**open_rate** | **String** | Open rate for current winning version | [optional]
|
10
|
+
**click_rate** | **String** | Click rate for current winning version | [optional]
|
11
|
+
**winning_version_rate** | **String** | Open/Click rate for the winner version | [optional]
|
12
|
+
|
13
|
+
|
data/docs/AccountApi.md
CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account
|
7
|
+
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
|
8
8
|
|
9
9
|
|
10
10
|
# **get_account**
|
11
11
|
> GetAccount get_account
|
12
12
|
|
13
|
-
Get your account
|
13
|
+
Get your account information, plan and credits details
|
14
14
|
|
15
15
|
### Example
|
16
16
|
```ruby
|
@@ -32,7 +32,7 @@ end
|
|
32
32
|
api_instance = SibApiV3Sdk::AccountApi.new
|
33
33
|
|
34
34
|
begin
|
35
|
-
#Get your account
|
35
|
+
#Get your account information, plan and credits details
|
36
36
|
result = api_instance.get_account
|
37
37
|
p result
|
38
38
|
rescue SibApiV3Sdk::ApiError => e
|
data/docs/AddContactToList.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**emails** | **Array<String>** | Emails to add to a list | [optional]
|
6
|
+
**emails** | **Array<String>** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
7
7
|
|
8
8
|
|
data/docs/AttributesApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} |
|
8
|
-
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} |
|
9
|
-
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes |
|
10
|
-
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} |
|
7
|
+
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
8
|
+
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
9
|
+
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
10
|
+
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
11
11
|
|
12
12
|
|
13
13
|
# **create_attribute**
|
14
14
|
> create_attribute(attribute_category, attribute_name, create_attribute)
|
15
15
|
|
16
|
-
|
16
|
+
Create contact attribute
|
17
17
|
|
18
18
|
### Example
|
19
19
|
```ruby
|
@@ -34,15 +34,15 @@ end
|
|
34
34
|
|
35
35
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
36
36
|
|
37
|
-
attribute_category =
|
37
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
38
38
|
|
39
|
-
attribute_name =
|
39
|
+
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
40
40
|
|
41
41
|
create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
42
42
|
|
43
43
|
|
44
44
|
begin
|
45
|
-
#
|
45
|
+
#Create contact attribute
|
46
46
|
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
47
47
|
rescue SibApiV3Sdk::ApiError => e
|
48
48
|
puts "Exception when calling AttributesApi->create_attribute: #{e}"
|
@@ -75,7 +75,7 @@ nil (empty response body)
|
|
75
75
|
# **delete_attribute**
|
76
76
|
> delete_attribute(attribute_category, attribute_name)
|
77
77
|
|
78
|
-
|
78
|
+
Delete an attribute
|
79
79
|
|
80
80
|
### Example
|
81
81
|
```ruby
|
@@ -96,13 +96,13 @@ end
|
|
96
96
|
|
97
97
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
98
98
|
|
99
|
-
attribute_category =
|
99
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
100
100
|
|
101
|
-
attribute_name =
|
101
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
102
102
|
|
103
103
|
|
104
104
|
begin
|
105
|
-
#
|
105
|
+
#Delete an attribute
|
106
106
|
api_instance.delete_attribute(attribute_category, attribute_name)
|
107
107
|
rescue SibApiV3Sdk::ApiError => e
|
108
108
|
puts "Exception when calling AttributesApi->delete_attribute: #{e}"
|
@@ -134,7 +134,7 @@ nil (empty response body)
|
|
134
134
|
# **get_attributes**
|
135
135
|
> GetAttributes get_attributes
|
136
136
|
|
137
|
-
|
137
|
+
List all attributes
|
138
138
|
|
139
139
|
### Example
|
140
140
|
```ruby
|
@@ -156,7 +156,7 @@ end
|
|
156
156
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
157
157
|
|
158
158
|
begin
|
159
|
-
#
|
159
|
+
#List all attributes
|
160
160
|
result = api_instance.get_attributes
|
161
161
|
p result
|
162
162
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -185,7 +185,7 @@ This endpoint does not need any parameter.
|
|
185
185
|
# **update_attribute**
|
186
186
|
> update_attribute(attribute_category, attribute_name, update_attribute)
|
187
187
|
|
188
|
-
|
188
|
+
Update contact attribute
|
189
189
|
|
190
190
|
### Example
|
191
191
|
```ruby
|
@@ -206,15 +206,15 @@ end
|
|
206
206
|
|
207
207
|
api_instance = SibApiV3Sdk::AttributesApi.new
|
208
208
|
|
209
|
-
attribute_category =
|
209
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
210
210
|
|
211
|
-
attribute_name =
|
211
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
212
212
|
|
213
213
|
update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
214
214
|
|
215
215
|
|
216
216
|
begin
|
217
|
-
#
|
217
|
+
#Update contact attribute
|
218
218
|
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
219
219
|
rescue SibApiV3Sdk::ApiError => e
|
220
220
|
puts "Exception when calling AttributesApi->update_attribute: #{e}"
|