sib-api-v3-sdk 7.2.0 → 8.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +72 -12
- data/docs/Body.md +18 -0
- data/docs/Body1.md +18 -0
- data/docs/CRMApi.md +710 -0
- data/docs/Contact.md +15 -0
- data/docs/ContactsApi.md +77 -18
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +2 -1
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/CreateSubAccount.md +10 -0
- data/docs/CreateWebhook.md +2 -1
- data/docs/EmailCampaignsApi.md +6 -6
- data/docs/FileData.md +17 -0
- data/docs/FoldersApi.md +4 -4
- data/docs/GetCampaignOverview.md +1 -1
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetContactCampaignStats.md +1 -0
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactDetails.md +2 -2
- data/docs/GetEmailCampaign.md +6 -6
- data/docs/GetEmailEventReportEvents.md +1 -1
- data/docs/GetExtendedCampaignOverview.md +4 -4
- data/docs/GetExtendedCampaignStats.md +1 -1
- data/docs/{SendTemplateEmail.md → GetExtendedCampaignStatsGlobalStats.md} +1 -2
- data/docs/GetExtendedContactDetails.md +2 -2
- data/docs/GetExtendedContactDetailsStatistics.md +1 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetExtendedList.md +2 -1
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetList.md +1 -0
- data/docs/GetSmsCampaign.md +5 -5
- data/docs/GetSmsCampaignOverview.md +3 -3
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsEventReportEvents.md +1 -1
- data/docs/GetSmtpTemplateOverview.md +2 -2
- data/docs/GetTransacBlockedContactsContacts.md +1 -1
- data/docs/GetTransacEmailContent.md +1 -1
- data/docs/GetTransacEmailContentEvents.md +1 -1
- data/docs/GetTransacEmailsList.md +1 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
- data/docs/GetWebhook.md +2 -2
- data/docs/InboundParsingApi.md +139 -0
- data/docs/ListsApi.md +8 -8
- data/docs/MasterAccountApi.md +367 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +10 -0
- data/docs/ProcessApi.md +2 -2
- data/docs/RequestContactExport.md +1 -2
- data/docs/SMSCampaignsApi.md +6 -6
- data/docs/SendSmtpEmail.md +5 -4
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +1 -1
- data/docs/SendTransacSms.md +1 -0
- data/docs/SsoTokenRequest.md +9 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +24 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TransactionalEmailsApi.md +25 -80
- data/docs/TransactionalSMSApi.md +7 -7
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +16 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +2 -1
- data/docs/UpdateWebhook.md +2 -1
- data/docs/WebhooksApi.md +3 -1
- data/lib/sib-api-v3-sdk/api/account_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +72 -19
- data/lib/sib-api-v3-sdk/api/crm_api.rb +670 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +7 -7
- data/lib/sib-api-v3-sdk/api/folders_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +161 -0
- data/lib/sib-api-v3-sdk/api/lists_api.rb +9 -9
- data/lib/sib-api-v3-sdk/api/master_account_api.rb +365 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +3 -3
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +7 -7
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +29 -75
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +5 -5
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +9 -3
- data/lib/sib-api-v3-sdk/api_client.rb +8 -5
- data/lib/sib-api-v3-sdk/api_error.rb +1 -1
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +3 -2
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/block_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/body.rb +305 -0
- data/lib/sib-api-v3-sdk/models/body_1.rb +305 -0
- data/lib/sib-api-v3-sdk/models/contact.rb +266 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +19 -6
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_sub_account.rb +244 -0
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +20 -9
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/file_data.rb +278 -0
- data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +19 -3
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +18 -6
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -8
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -6
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +19 -6
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +20 -4
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/{send_template_email.rb → get_inbound_email_events.rb} +13 -16
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_events.rb +235 -0
- data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_list.rb +22 -6
- data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -7
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -5
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +14 -3
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/master_details_response.rb +243 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info.rb +214 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_plan_info.rb +272 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/sib-api-v3-sdk/models/note.rb +283 -0
- data/lib/sib-api-v3-sdk/models/note_data.rb +243 -0
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +9 -13
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +4 -3
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +20 -12
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/{send_email.rb → send_smtp_email_message_versions.rb} +51 -83
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/{send_email_attachment.rb → send_smtp_email_reply_to_1.rb} +17 -39
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +4 -3
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +19 -6
- data/lib/sib-api-v3-sdk/models/sso_token_request.rb +200 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response.rb +214 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request.rb +194 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/sib-api-v3-sdk/models/sub_accounts_response.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/sib-api-v3-sdk/models/task.rb +367 -0
- data/lib/sib-api-v3-sdk/models/task_reminder.rb +257 -0
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_batch_contacts.rb +187 -0
- data/lib/sib-api-v3-sdk/models/update_batch_contacts_contacts.rb +273 -0
- data/lib/sib-api-v3-sdk/models/update_batch_contacts_model.rb +197 -0
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +19 -6
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +18 -7
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
- data/lib/sib-api-v3-sdk/version.rb +2 -2
- data/lib/sib-api-v3-sdk.rb +55 -12
- data/sib-api-v3-sdk.gemspec +2 -1
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +22 -10
- data/spec/api/crm_api_spec.rb +170 -0
- data/spec/api/email_campaigns_api_spec.rb +4 -4
- data/spec/api/folders_api_spec.rb +3 -3
- data/spec/api/inbound_parsing_api_spec.rb +64 -0
- data/spec/api/lists_api_spec.rb +5 -5
- data/spec/api/master_account_api_spec.rb +108 -0
- data/spec/api/process_api_spec.rb +2 -2
- data/spec/api/reseller_api_spec.rb +1 -1
- data/spec/api/senders_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +4 -4
- data/spec/api/transactional_emails_api_spec.rb +12 -21
- data/spec/api/transactional_sms_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +2 -1
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_spec.rb +1 -1
- data/spec/models/ab_test_version_stats_spec.rb +1 -1
- data/spec/models/add_child_domain_spec.rb +1 -1
- data/spec/models/add_contact_to_list_spec.rb +1 -1
- data/spec/models/add_credits_spec.rb +1 -1
- data/spec/models/block_domain_spec.rb +1 -1
- data/spec/models/body_1_spec.rb +101 -0
- data/spec/models/body_spec.rb +101 -0
- data/spec/models/contact_spec.rb +83 -0
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +1 -1
- data/spec/models/create_doi_contact_spec.rb +1 -1
- data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_reseller_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +7 -1
- data/spec/models/create_smtp_email_spec.rb +7 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_sub_account_spec.rb +57 -0
- data/spec/models/create_update_contact_model_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_webhook_spec.rb +9 -3
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +1 -1
- data/spec/models/file_data_spec.rb +95 -0
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +1 -1
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_blocked_domains_spec.rb +1 -1
- data/spec/models/get_campaign_overview_spec.rb +1 -1
- data/spec/models/get_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +7 -1
- data/spec/models/get_child_account_creation_status_spec.rb +1 -1
- data/spec/models/get_child_domain_spec.rb +1 -1
- data/spec/models/get_child_domains_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
- data/spec/models/get_child_info_credits_spec.rb +1 -1
- data/spec/models/get_child_info_spec.rb +1 -1
- data/spec/models/get_child_info_statistics_spec.rb +1 -1
- data/spec/models/get_children_list_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +7 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_device_browser_stats_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +1 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +1 -1
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +7 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +7 -1
- data/spec/models/get_folder_lists_spec.rb +1 -1
- data/spec/models/get_folder_spec.rb +1 -1
- data/spec/models/get_folders_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_ip_from_sender_spec.rb +1 -1
- data/spec/models/get_ip_spec.rb +1 -1
- data/spec/models/get_ips_from_sender_spec.rb +1 -1
- data/spec/models/get_ips_spec.rb +1 -1
- data/spec/models/get_list_spec.rb +7 -1
- data/spec/models/get_lists_spec.rb +1 -1
- data/spec/models/get_process_spec.rb +1 -1
- data/spec/models/get_processes_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +1 -1
- data/spec/models/get_reports_spec.rb +1 -1
- data/spec/models/get_senders_list_ips_spec.rb +1 -1
- data/spec/models/get_senders_list_senders_spec.rb +1 -1
- data/spec/models/get_senders_list_spec.rb +1 -1
- data/spec/models/get_shared_template_url_spec.rb +1 -1
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +1 -1
- data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
- data/spec/models/get_sms_campaigns_spec.rb +1 -1
- data/spec/models/get_sms_event_report_events_spec.rb +1 -1
- data/spec/models/get_sms_event_report_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_spec.rb +1 -1
- data/spec/models/get_smtp_templates_spec.rb +1 -1
- data/spec/models/get_sso_token_spec.rb +1 -1
- data/spec/models/get_stats_by_browser_spec.rb +1 -1
- data/spec/models/get_stats_by_device_spec.rb +1 -1
- data/spec/models/get_stats_by_domain_spec.rb +1 -1
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
- data/spec/models/get_transac_email_content_events_spec.rb +1 -1
- data/spec/models/get_transac_email_content_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_spec.rb +7 -1
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_spec.rb +1 -1
- data/spec/models/get_webhook_spec.rb +1 -1
- data/spec/models/get_webhooks_spec.rb +1 -1
- data/spec/models/manage_ip_spec.rb +1 -1
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +53 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/post_contact_info_contacts_spec.rb +1 -1
- data/spec/models/post_contact_info_spec.rb +1 -1
- data/spec/models/post_send_failed_spec.rb +1 -1
- data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
- data/spec/models/remaining_credit_model_child_spec.rb +1 -1
- data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
- data/spec/models/remaining_credit_model_spec.rb +1 -1
- data/spec/models/remove_contact_from_list_spec.rb +1 -1
- data/spec/models/remove_credits_spec.rb +1 -1
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
- data/spec/models/request_contact_export_spec.rb +1 -7
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +1 -1
- data/spec/models/request_sms_recipient_export_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -1
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +1 -1
- data/spec/models/send_smtp_email_spec.rb +7 -1
- data/spec/models/{send_email_attachment_spec.rb → send_smtp_email_to_1_spec.rb} +8 -8
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +7 -1
- data/spec/models/sso_token_request_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +137 -0
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +1 -1
- data/spec/models/{send_email_spec.rb → update_batch_contacts_contacts_spec.rb} +16 -16
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/{send_template_email_spec.rb → update_batch_contacts_spec.rb} +8 -8
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_account_status_spec.rb +1 -1
- data/spec/models/update_child_domain_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +1 -1
- data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +7 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_webhook_spec.rb +8 -2
- data/spec/models/upload_image_to_gallery_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +368 -178
- data/docs/SendEmail.md +0 -16
- data/docs/SendEmailAttachment.md +0 -9
- data/testfile.rb +0 -26
data/docs/ContactsApi.md
CHANGED
@@ -28,6 +28,7 @@ Method | HTTP request | Description
|
|
28
28
|
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
29
29
|
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
30
30
|
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
31
|
+
[**update_batch_contacts**](ContactsApi.md#update_batch_contacts) | **POST** /contacts/batch | Update multiple contacts
|
31
32
|
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
|
32
33
|
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
33
34
|
[**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
@@ -665,6 +666,8 @@ This endpoint does not need any parameter.
|
|
665
666
|
|
666
667
|
Get a contact's details
|
667
668
|
|
669
|
+
Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
670
|
+
|
668
671
|
### Example
|
669
672
|
```ruby
|
670
673
|
# load the gem
|
@@ -744,8 +747,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
744
747
|
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
745
748
|
|
746
749
|
opts = {
|
747
|
-
start_date:
|
748
|
-
end_date:
|
750
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
751
|
+
end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
|
749
752
|
}
|
750
753
|
|
751
754
|
begin
|
@@ -762,8 +765,8 @@ end
|
|
762
765
|
Name | Type | Description | Notes
|
763
766
|
------------- | ------------- | ------------- | -------------
|
764
767
|
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
765
|
-
**start_date** | **
|
766
|
-
**end_date** | **
|
768
|
+
**start_date** | **String**| 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]
|
769
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]
|
767
770
|
|
768
771
|
### Return type
|
769
772
|
|
@@ -807,8 +810,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
807
810
|
opts = {
|
808
811
|
limit: 50, # Integer | Number of documents per page
|
809
812
|
offset: 0, # Integer | Index of the first document of the page
|
810
|
-
modified_since:
|
811
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
813
|
+
modified_since: 'modified_since_example', # String | 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.
|
814
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
812
815
|
}
|
813
816
|
|
814
817
|
begin
|
@@ -826,8 +829,8 @@ Name | Type | Description | Notes
|
|
826
829
|
------------- | ------------- | ------------- | -------------
|
827
830
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
828
831
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
829
|
-
**modified_since** | **
|
830
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
832
|
+
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
833
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
831
834
|
|
832
835
|
### Return type
|
833
836
|
|
@@ -871,10 +874,10 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
871
874
|
list_id = 789 # Integer | Id of the list
|
872
875
|
|
873
876
|
opts = {
|
874
|
-
modified_since:
|
877
|
+
modified_since: 'modified_since_example', # String | 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.
|
875
878
|
limit: 50, # Integer | Number of documents per page
|
876
879
|
offset: 0, # Integer | Index of the first document of the page
|
877
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
880
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
878
881
|
}
|
879
882
|
|
880
883
|
begin
|
@@ -891,10 +894,10 @@ end
|
|
891
894
|
Name | Type | Description | Notes
|
892
895
|
------------- | ------------- | ------------- | -------------
|
893
896
|
**list_id** | **Integer**| Id of the list |
|
894
|
-
**modified_since** | **
|
897
|
+
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
895
898
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
896
899
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
897
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
900
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
898
901
|
|
899
902
|
### Return type
|
900
903
|
|
@@ -997,7 +1000,7 @@ folder_id = 789 # Integer | Id of the folder
|
|
997
1000
|
opts = {
|
998
1001
|
limit: 10, # Integer | Number of documents per page
|
999
1002
|
offset: 0, # Integer | Index of the first document of the page
|
1000
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1003
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1001
1004
|
}
|
1002
1005
|
|
1003
1006
|
begin
|
@@ -1016,7 +1019,7 @@ Name | Type | Description | Notes
|
|
1016
1019
|
**folder_id** | **Integer**| Id of the folder |
|
1017
1020
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1018
1021
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1019
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1022
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1020
1023
|
|
1021
1024
|
### Return type
|
1022
1025
|
|
@@ -1062,7 +1065,7 @@ limit = 10 # Integer | Number of documents per page
|
|
1062
1065
|
offset = 0 # Integer | Index of the first document of the page
|
1063
1066
|
|
1064
1067
|
opts = {
|
1065
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1068
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1066
1069
|
}
|
1067
1070
|
|
1068
1071
|
begin
|
@@ -1080,7 +1083,7 @@ Name | Type | Description | Notes
|
|
1080
1083
|
------------- | ------------- | ------------- | -------------
|
1081
1084
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
1082
1085
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
1083
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1086
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1084
1087
|
|
1085
1088
|
### Return type
|
1086
1089
|
|
@@ -1181,7 +1184,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1181
1184
|
opts = {
|
1182
1185
|
limit: 10, # Integer | Number of documents per page
|
1183
1186
|
offset: 0, # Integer | Index of the first document of the page
|
1184
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1187
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1185
1188
|
}
|
1186
1189
|
|
1187
1190
|
begin
|
@@ -1199,7 +1202,7 @@ Name | Type | Description | Notes
|
|
1199
1202
|
------------- | ------------- | ------------- | -------------
|
1200
1203
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1201
1204
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1202
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1205
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1203
1206
|
|
1204
1207
|
### Return type
|
1205
1208
|
|
@@ -1456,6 +1459,62 @@ nil (empty response body)
|
|
1456
1459
|
|
1457
1460
|
|
1458
1461
|
|
1462
|
+
# **update_batch_contacts**
|
1463
|
+
> update_batch_contacts(update_batch_contacts)
|
1464
|
+
|
1465
|
+
Update multiple contacts
|
1466
|
+
|
1467
|
+
### Example
|
1468
|
+
```ruby
|
1469
|
+
# load the gem
|
1470
|
+
require 'sib-api-v3-sdk'
|
1471
|
+
# setup authorization
|
1472
|
+
SibApiV3Sdk.configure do |config|
|
1473
|
+
# Configure API key authorization: api-key
|
1474
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
1475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1476
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
1477
|
+
|
1478
|
+
# Configure API key authorization: partner-key
|
1479
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
1480
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1481
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
1482
|
+
end
|
1483
|
+
|
1484
|
+
api_instance = SibApiV3Sdk::ContactsApi.new
|
1485
|
+
|
1486
|
+
update_batch_contacts = SibApiV3Sdk::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts
|
1487
|
+
|
1488
|
+
|
1489
|
+
begin
|
1490
|
+
#Update multiple contacts
|
1491
|
+
api_instance.update_batch_contacts(update_batch_contacts)
|
1492
|
+
rescue SibApiV3Sdk::ApiError => e
|
1493
|
+
puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
|
1494
|
+
end
|
1495
|
+
```
|
1496
|
+
|
1497
|
+
### Parameters
|
1498
|
+
|
1499
|
+
Name | Type | Description | Notes
|
1500
|
+
------------- | ------------- | ------------- | -------------
|
1501
|
+
**update_batch_contacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts |
|
1502
|
+
|
1503
|
+
### Return type
|
1504
|
+
|
1505
|
+
nil (empty response body)
|
1506
|
+
|
1507
|
+
### Authorization
|
1508
|
+
|
1509
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
1510
|
+
|
1511
|
+
### HTTP request headers
|
1512
|
+
|
1513
|
+
- **Content-Type**: application/json
|
1514
|
+
- **Accept**: application/json
|
1515
|
+
|
1516
|
+
|
1517
|
+
|
1459
1518
|
# **update_contact**
|
1460
1519
|
> update_contact(identifier, update_contact)
|
1461
1520
|
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**html_content** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
|
10
10
|
**html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
|
11
11
|
**template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
|
12
|
-
**scheduled_at** | **
|
12
|
+
**scheduled_at** | **String** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
13
13
|
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
14
14
|
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
|
15
15
|
**to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
data/docs/CreateSmsCampaign.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
8
8
|
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
|
-
**scheduled_at** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
11
|
+
**unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
|
11
12
|
|
12
13
|
|
data/docs/CreateSmtpEmail.md
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**message_id** | **String** | Message ID of the transactional email sent |
|
6
|
+
**message_id** | **String** | Message ID of the transactional email sent | [optional]
|
7
|
+
**message_ids** | **Array<String>** | | [optional]
|
7
8
|
|
8
9
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SibApiV3Sdk::CreateSubAccount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**company_name** | **String** | Name of the organization |
|
7
|
+
**language** | **String** | Language for identifying localization information | [optional]
|
8
|
+
**timezone** | **String** | Request timezone of the client | [optional]
|
9
|
+
|
10
|
+
|
data/docs/CreateWebhook.md
CHANGED
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook |
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
8
|
-
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook
|
8
|
+
**events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` |
|
9
9
|
**type** | **String** | Type of the webhook | [optional] [default to 'transactional']
|
10
|
+
**domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional]
|
10
11
|
|
11
12
|
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -336,11 +336,11 @@ api_instance = SibApiV3Sdk::EmailCampaignsApi.new
|
|
336
336
|
opts = {
|
337
337
|
type: 'type_example', # String | Filter on the type of the campaigns
|
338
338
|
status: 'status_example', # String | Filter on the status of the campaign
|
339
|
-
start_date:
|
340
|
-
end_date:
|
339
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
340
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
341
341
|
limit: 500, # Integer | Number of documents per page
|
342
342
|
offset: 0, # Integer | Index of the first document in the page
|
343
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
343
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
344
344
|
}
|
345
345
|
|
346
346
|
begin
|
@@ -358,11 +358,11 @@ Name | Type | Description | Notes
|
|
358
358
|
------------- | ------------- | ------------- | -------------
|
359
359
|
**type** | **String**| Filter on the type of the campaigns | [optional]
|
360
360
|
**status** | **String**| Filter on the status of the campaign | [optional]
|
361
|
-
**start_date** | **
|
362
|
-
**end_date** | **
|
361
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
362
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
363
363
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
|
364
364
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
365
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
365
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
366
366
|
|
367
367
|
### Return type
|
368
368
|
|
data/docs/FileData.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# SibApiV3Sdk::FileData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | Url of uploaded file | [optional]
|
7
|
+
**id** | **String** | Id of uploaded file | [optional]
|
8
|
+
**name** | **String** | Name of uploaded file | [optional]
|
9
|
+
**author_id** | **String** | Account id of user which created the file | [optional]
|
10
|
+
**author** | **Object** | Account details of user which created the file | [optional]
|
11
|
+
**contact_id** | **Integer** | Contact id of contact on which file is uploaded | [optional]
|
12
|
+
**deal_ids** | **Array<String>** | Deal ids linked to a file | [optional]
|
13
|
+
**size** | **Integer** | Size of file uploaded | [optional]
|
14
|
+
**created_at** | **DateTime** | File created date/time | [optional]
|
15
|
+
**updated_at** | **DateTime** | File updated date/time | [optional]
|
16
|
+
|
17
|
+
|
data/docs/FoldersApi.md
CHANGED
@@ -211,7 +211,7 @@ folder_id = 789 # Integer | Id of the folder
|
|
211
211
|
opts = {
|
212
212
|
limit: 10, # Integer | Number of documents per page
|
213
213
|
offset: 0, # Integer | Index of the first document of the page
|
214
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
214
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
215
215
|
}
|
216
216
|
|
217
217
|
begin
|
@@ -230,7 +230,7 @@ Name | Type | Description | Notes
|
|
230
230
|
**folder_id** | **Integer**| Id of the folder |
|
231
231
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
232
232
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
233
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
233
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
234
234
|
|
235
235
|
### Return type
|
236
236
|
|
@@ -276,7 +276,7 @@ limit = 10 # Integer | Number of documents per page
|
|
276
276
|
offset = 0 # Integer | Index of the first document of the page
|
277
277
|
|
278
278
|
opts = {
|
279
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
279
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
280
280
|
}
|
281
281
|
|
282
282
|
begin
|
@@ -294,7 +294,7 @@ Name | Type | Description | Notes
|
|
294
294
|
------------- | ------------- | ------------- | -------------
|
295
295
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
296
296
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
297
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
297
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
298
298
|
|
299
299
|
### Return type
|
300
300
|
|
data/docs/GetCampaignOverview.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9
9
|
**type** | **String** | Type of campaign |
|
10
10
|
**status** | **String** | Status of the campaign |
|
11
|
-
**scheduled_at** | **
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12
12
|
**ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13
13
|
**subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14
14
|
**subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
data/docs/GetCampaignStats.md
CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**soft_bounces** | **Integer** | Number of softbounce for the campaign |
|
13
13
|
**hard_bounces** | **Integer** | Number of harbounce for the campaign |
|
14
14
|
**unique_views** | **Integer** | Number of unique openings for the campaign |
|
15
|
+
**trackable_views** | **Integer** | Recipients without any privacy protection option enabled in their email client |
|
15
16
|
**unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
|
16
17
|
**viewed** | **Integer** | Number of openings for the campaign |
|
17
18
|
**deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
|
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional]
|
12
12
|
**clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional]
|
13
13
|
**transac_attributes** | [**Array<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) | | [optional]
|
14
|
+
**delivered** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
|
14
15
|
|
15
16
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
7
|
**count** | **Integer** | Number of openings of the campaign |
|
8
|
-
**event_time** | **
|
8
|
+
**event_time** | **String** | UTC date-time of the event |
|
9
9
|
**ip** | **String** | IP from which the user has opened the campaign |
|
10
10
|
|
11
11
|
|
data/docs/GetContactDetails.md
CHANGED
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **Integer** | ID of the contact for which you requested the details |
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
10
|
-
**created_at** | **
|
11
|
-
**modified_at** | **
|
10
|
+
**created_at** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11
|
+
**modified_at** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
12
|
**list_ids** | **Array<Integer>** | |
|
13
13
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
14
14
|
**attributes** | **Object** | Set of attributes of the contact |
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9
9
|
**type** | **String** | Type of campaign |
|
10
10
|
**status** | **String** | Status of the campaign |
|
11
|
-
**scheduled_at** | **
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12
12
|
**ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13
13
|
**subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14
14
|
**subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
@@ -25,14 +25,14 @@ Name | Type | Description | Notes
|
|
25
25
|
**html_content** | **String** | HTML content of the campaign |
|
26
26
|
**share_link** | **String** | Link to share the campaign on social medias | [optional]
|
27
27
|
**tag** | **String** | Tag of the campaign | [optional]
|
28
|
-
**created_at** | **
|
29
|
-
**modified_at** | **
|
28
|
+
**created_at** | **String** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29
|
+
**modified_at** | **String** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30
30
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
31
31
|
**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32
32
|
**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33
|
-
**sent_date** | **
|
33
|
+
**sent_date** | **String** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
34
|
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
35
|
-
**recipients** | **
|
36
|
-
**statistics** | **
|
35
|
+
**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
36
|
+
**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
37
37
|
|
38
38
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email** | **String** | Email address which generates the event |
|
7
|
-
**date** | **
|
7
|
+
**date** | **String** | UTC date-time on which the event has been generated |
|
8
8
|
**subject** | **String** | Subject of the event | [optional]
|
9
9
|
**message_id** | **String** | Message ID which generated the event |
|
10
10
|
**event** | **String** | Event which occurred |
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
|
9
9
|
**type** | **String** | Type of campaign |
|
10
10
|
**status** | **String** | Status of the campaign |
|
11
|
-
**scheduled_at** | **
|
11
|
+
**scheduled_at** | **String** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
|
12
12
|
**ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
|
13
13
|
**subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
14
14
|
**subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
|
@@ -25,12 +25,12 @@ Name | Type | Description | Notes
|
|
25
25
|
**html_content** | **String** | HTML content of the campaign |
|
26
26
|
**share_link** | **String** | Link to share the campaign on social medias | [optional]
|
27
27
|
**tag** | **String** | Tag of the campaign | [optional]
|
28
|
-
**created_at** | **
|
29
|
-
**modified_at** | **
|
28
|
+
**created_at** | **String** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29
|
+
**modified_at** | **String** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30
30
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
31
31
|
**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
|
32
32
|
**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
|
33
|
-
**sent_date** | **
|
33
|
+
**sent_date** | **String** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
|
34
34
|
**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional]
|
35
35
|
|
36
36
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**global_stats** | **
|
6
|
+
**global_stats** | [**GetExtendedCampaignStatsGlobalStats**](GetExtendedCampaignStatsGlobalStats.md) | |
|
7
7
|
**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. |
|
8
8
|
**mirror_click** | **Integer** | Number of clicks on mirror link |
|
9
9
|
**remaining** | **Integer** | Number of remaning emails to send |
|
@@ -1,8 +1,7 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**message_id** | **String** | Message ID of the template Email sent |
|
7
6
|
|
8
7
|
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **Integer** | ID of the contact for which you requested the details |
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
10
|
-
**created_at** | **
|
11
|
-
**modified_at** | **
|
10
|
+
**created_at** | **String** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11
|
+
**modified_at** | **String** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
12
|
**list_ids** | **Array<Integer>** | |
|
13
13
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
14
14
|
**attributes** | **Object** | Set of attributes of the contact |
|
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**opened** | [**Array<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional]
|
12
12
|
**clicked** | [**Array<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional]
|
13
13
|
**transac_attributes** | **Array<Object>** | Listing of the transactional attributes for the contact | [optional]
|
14
|
+
**delivered** | [**Array<GetExtendedContactDetailsStatisticsDelivered>**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional]
|
14
15
|
|
15
16
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsDelivered
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
|
+
|
9
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**count** | **Integer** | Number of clicks on this link for the campaign |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
8
|
**ip** | **String** | IP from which the user has clicked on the link |
|
9
9
|
**url** | **String** | URL of the clicked link |
|
10
10
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
8
|
|
9
9
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
7
|
**count** | **Integer** | Number of openings for the campaign |
|
8
|
-
**event_time** | **
|
8
|
+
**event_time** | **String** | UTC date-time of the event |
|
9
9
|
**ip** | **String** | IP from which the user has opened the email |
|
10
10
|
|
11
11
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**event_time** | **
|
6
|
+
**event_time** | **String** | UTC date-time of the event |
|
7
7
|
**ip** | **String** | IP from which the user has been unsubscribed | [optional]
|
8
8
|
|
9
9
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
8
8
|
**ip** | **String** | IP from which the user has unsubscribed | [optional]
|
9
9
|
|
10
10
|
|
data/docs/GetExtendedList.md
CHANGED
@@ -7,8 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the list |
|
8
8
|
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
|
9
9
|
**total_subscribers** | **Integer** | Number of contacts in the list |
|
10
|
+
**unique_subscribers** | **Integer** | Number of unique contacts in the list |
|
10
11
|
**folder_id** | **Integer** | ID of the folder |
|
11
|
-
**created_at** | **
|
12
|
+
**created_at** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
13
|
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
|
13
14
|
**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
|
14
15
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# SibApiV3Sdk::GetInboundEmailEvents
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**events** | [**Array<GetInboundEmailEventsEvents>**](GetInboundEmailEventsEvents.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# SibApiV3Sdk::GetInboundEmailEventsByUuid
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**received_at** | **DateTime** | Date when email was received on SMTP relay | [optional]
|
7
|
+
**delivered_at** | **DateTime** | Date when email was delivered successfully to client’s webhook | [optional]
|
8
|
+
**recipient** | **String** | Recipient’s email address | [optional]
|
9
|
+
**sender** | **String** | Sender’s email address | [optional]
|
10
|
+
**message_id** | **String** | Value of the Message-ID header. This will be present only after the processing is done. | [optional]
|
11
|
+
**subject** | **String** | Value of the Subject header. This will be present only after the processing is done. | [optional]
|
12
|
+
**attachments** | [**Array<GetInboundEmailEventsByUuidAttachments>**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional]
|
13
|
+
**logs** | [**Array<GetInboundEmailEventsByUuidLogs>**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional]
|
14
|
+
|
15
|
+
|