sib-api-v3-sdk 7.0.0 → 7.5.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 +18 -8
- data/docs/BlockDomain.md +8 -0
- data/docs/ContactsApi.md +25 -13
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/CreateSmtpTemplateSender.md +1 -1
- data/docs/EmailCampaignsApi.md +7 -5
- data/docs/FoldersApi.md +9 -3
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +1 -1
- data/docs/GetChildDomain.md +2 -2
- data/docs/GetChildrenList.md +1 -1
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactDetails.md +2 -2
- data/docs/GetEmailCampaign.md +8 -8
- data/docs/GetEmailCampaigns.md +1 -1
- data/docs/GetEmailEventReportEvents.md +2 -1
- data/docs/GetExtendedCampaignOverview.md +6 -6
- data/docs/GetExtendedCampaignStats.md +1 -1
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedContactDetails.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
- data/docs/GetExtendedList.md +2 -1
- data/docs/GetFolderLists.md +2 -2
- data/docs/GetList.md +1 -0
- data/docs/GetLists.md +2 -2
- data/docs/GetProcesses.md +1 -1
- data/docs/GetSmsCampaign.md +5 -5
- data/docs/GetSmsCampaignOverview.md +3 -3
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaigns.md +1 -1
- data/docs/GetSmsEventReportEvents.md +4 -4
- data/docs/GetSmtpTemplateOverview.md +2 -2
- data/docs/GetTransacAggregatedSmsReport.md +10 -10
- data/docs/GetTransacBlockedContactsContacts.md +1 -1
- data/docs/GetTransacEmailContent.md +1 -1
- data/docs/GetTransacEmailContentEvents.md +1 -1
- data/docs/GetTransacEmailsList.md +1 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
- data/docs/GetTransacSmsReportReports.md +10 -10
- data/docs/GetWebhook.md +2 -2
- data/docs/ListsApi.md +11 -5
- data/docs/ProcessApi.md +3 -1
- data/docs/SMSCampaignsApi.md +7 -5
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +3 -2
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +3 -3
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +1 -1
- data/docs/TransactionalEmailsApi.md +197 -11
- data/docs/TransactionalSMSApi.md +9 -5
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/WebhooksApi.md +3 -1
- data/lib/sib-api-v3-sdk.rb +16 -9
- data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +49 -9
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/lists_api.rb +31 -3
- data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +211 -7
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +17 -1
- 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 +190 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +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 +4 -3
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +3 -2
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -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 +193 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +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 -12
- data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_list.rb +22 -6
- data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
- data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +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 -52
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +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 +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
- data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +7 -11
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +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 +3 -2
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +4 -3
- 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 +3 -2
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
- data/lib/sib-api-v3-sdk/version.rb +2 -2
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/attributes_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +10 -5
- data/spec/api/email_campaigns_api_spec.rb +4 -3
- data/spec/api/folders_api_spec.rb +3 -1
- data/spec/api/lists_api_spec.rb +5 -2
- data/spec/api/process_api_spec.rb +2 -1
- data/spec/api/reseller_api_spec.rb +1 -1
- data/spec/api/senders_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +4 -3
- data/spec/api/transactional_emails_api_spec.rb +45 -3
- data/spec/api/transactional_sms_api_spec.rb +3 -1
- 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 +41 -0
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +1 -1
- data/spec/models/create_doi_contact_spec.rb +1 -1
- data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_reseller_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +1 -1
- data/spec/models/create_smtp_email_spec.rb +7 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_update_contact_model_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +1 -1
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +1 -1
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +1 -1
- data/spec/models/get_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +1 -1
- data/spec/models/get_child_account_creation_status_spec.rb +1 -1
- data/spec/models/get_child_domain_spec.rb +1 -1
- data/spec/models/get_child_domains_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
- data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
- data/spec/models/get_child_info_credits_spec.rb +1 -1
- data/spec/models/get_child_info_spec.rb +1 -1
- data/spec/models/get_child_info_statistics_spec.rb +1 -1
- data/spec/models/get_children_list_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_device_browser_stats_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +1 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +8 -2
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +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_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/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 -1
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +1 -1
- data/spec/models/request_sms_recipient_export_spec.rb +1 -1
- data/spec/models/send_email_attachment_spec.rb +1 -1
- data/spec/models/send_email_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -29
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +1 -1
- data/spec/models/send_smtp_email_spec.rb +7 -1
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_template_email_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +1 -1
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +1 -1
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_account_status_spec.rb +1 -1
- data/spec/models/update_child_domain_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +1 -1
- data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +1 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_webhook_spec.rb +1 -1
- data/spec/models/upload_image_to_gallery_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +193 -167
- data/testfile.rb +0 -23
data/docs/GetEmailCampaigns.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaigns** | **Array<Object>** | | [optional]
|
7
|
-
**count** | **Integer** | Number of Email campaigns retrieved |
|
7
|
+
**count** | **Integer** | Number of Email campaigns retrieved | [optional]
|
8
8
|
|
9
9
|
|
@@ -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 |
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
13
13
|
**ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
|
14
14
|
**link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
|
15
15
|
**from** | **String** | Sender email from which the emails are sent | [optional]
|
16
|
+
**template_id** | **Integer** | ID of the template (only available if the email is template based) | [optional]
|
16
17
|
|
17
18
|
|
@@ -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]
|
@@ -21,16 +21,16 @@ Name | Type | Description | Notes
|
|
21
21
|
**footer** | **String** | Footer of the campaign |
|
22
22
|
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
23
23
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
24
|
-
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
24
|
+
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
|
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
|
-
**tag** | **String** | Tag of the campaign |
|
28
|
-
**created_at** | **
|
29
|
-
**modified_at** | **
|
27
|
+
**tag** | **String** | Tag of the campaign | [optional]
|
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 |
|
@@ -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 |
|
@@ -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** | **
|
7
|
-
**ip** | **String** | IP from which the user has been unsubscribed |
|
6
|
+
**event_time** | **String** | UTC date-time of the event |
|
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** | **
|
8
|
-
**ip** | **String** | IP from which the user has unsubscribed |
|
7
|
+
**event_time** | **String** | UTC date-time of the event |
|
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
|
|
data/docs/GetFolderLists.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**lists** | **Array<Object>** | |
|
7
|
-
**count** | **Integer** | Number of lists in the folder |
|
6
|
+
**lists** | **Array<Object>** | | [optional]
|
7
|
+
**count** | **Integer** | Number of lists in the folder | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetList.md
CHANGED
@@ -7,5 +7,6 @@ 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
|
|
11
12
|
|
data/docs/GetLists.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**lists** | **Array<Object>** | Listing of all the lists available in your account |
|
7
|
-
**count** | **Integer** | Number of lists in your account |
|
6
|
+
**lists** | **Array<Object>** | Listing of all the lists available in your account | [optional]
|
7
|
+
**count** | **Integer** | Number of lists in your account | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetProcesses.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional]
|
7
|
-
**count** | **Integer** | Number of processes available on your account |
|
7
|
+
**count** | **Integer** | Number of processes available on your account | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetSmsCampaign.md
CHANGED
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
|
-
**created_at** | **
|
13
|
-
**modified_at** | **
|
14
|
-
**recipients** | **
|
15
|
-
**statistics** | **
|
12
|
+
**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
|
+
**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
|
+
**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
15
|
+
**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) | |
|
16
16
|
|
17
17
|
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **
|
10
|
+
**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
|
-
**created_at** | **
|
13
|
-
**modified_at** | **
|
12
|
+
**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
|
+
**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
14
|
|
15
15
|
|
data/docs/GetSmsCampaigns.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaigns** | **Array<Object>** | | [optional]
|
7
|
-
**count** | **Integer** | Number of SMS campaigns retrieved |
|
7
|
+
**count** | **Integer** | Number of SMS campaigns retrieved | [optional]
|
8
8
|
|
9
9
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**phone_number** | **String** | Phone number which has generated the event |
|
7
|
-
**date** | **
|
8
|
-
**message_id** | **String** | Message ID which generated the event |
|
9
|
-
**event** | **String** | Event which occurred |
|
6
|
+
**phone_number** | **String** | Phone number which has generated the event | [optional]
|
7
|
+
**date** | **String** | UTC date-time on which the event has been generated | [optional]
|
8
|
+
**message_id** | **String** | Message ID which generated the event | [optional]
|
9
|
+
**event** | **String** | Event which occurred | [optional]
|
10
10
|
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
11
11
|
**reply** | **String** | | [optional]
|
12
12
|
**tag** | **String** | Tag of the SMS which generated the event | [optional]
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
13
13
|
**to_field** | **String** | Customisation of the \"to\" field for the template |
|
14
14
|
**tag** | **String** | Tag of the template |
|
15
15
|
**html_content** | **String** | HTML content of the template |
|
16
|
-
**created_at** | **
|
17
|
-
**modified_at** | **
|
16
|
+
**created_at** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
17
|
+
**modified_at** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
18
18
|
**doi_template** | **BOOLEAN** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional]
|
19
19
|
|
20
20
|
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**range** | **String** | Time frame of the report |
|
7
|
-
**requests** | **Integer** | Number of requests for the timeframe |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the timeframe |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the timeframe |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the timeframe |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the timeframe |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the timeframe |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the timeframe |
|
6
|
+
**range** | **String** | Time frame of the report | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the timeframe | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the timeframe | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the timeframe | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the timeframe | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the timeframe | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the timeframe | [optional]
|
16
16
|
|
17
17
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**email** | **String** | Email address of the blocked or unsubscribed contact |
|
7
7
|
**sender_email** | **String** | Sender email address of the blocked or unsubscribed contact |
|
8
8
|
**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
|
9
|
-
**blocked_at** | **
|
9
|
+
**blocked_at** | **String** | Date when the contact was blocked or unsubscribed on |
|
10
10
|
|
11
11
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**email** | **String** | Email address to which transactional email has been sent |
|
7
7
|
**subject** | **String** | Subject of the sent email |
|
8
8
|
**template_id** | **Integer** | Id of the template | [optional]
|
9
|
-
**date** | **
|
9
|
+
**date** | **String** | Date on which transactional email was sent |
|
10
10
|
**events** | [**Array<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
|
11
11
|
**body** | **String** | Actual content of the transactional email that has been sent |
|
12
12
|
**attachment_count** | **Integer** | Count of the attachments that were sent in the email |
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the event that occurred on the sent email |
|
7
|
-
**time** | **
|
7
|
+
**time** | **String** | Time at which the event occurred |
|
8
8
|
|
9
9
|
|
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | Total number of transactional emails available on your account according to the passed filter | [optional]
|
6
7
|
**transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) | | [optional]
|
7
8
|
|
8
9
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**template_id** | **Integer** | Id of the template | [optional]
|
9
9
|
**message_id** | **String** | Message Id of the sent email |
|
10
10
|
**uuid** | **String** | Unique id of the email sent to a particular contact |
|
11
|
-
**date** | **
|
11
|
+
**date** | **String** | Date on which transactional email was sent |
|
12
12
|
**from** | **String** | Email address of the sender from which the email was sent | [optional]
|
13
13
|
**tags** | **Array<String>** | Tags used for your email | [optional]
|
14
14
|
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**date** | **Date** | Date for which statistics are retrieved |
|
7
|
-
**requests** | **Integer** | Number of requests for the date |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the date |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the date |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the date |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the date |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the date |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the date |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the date |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the date |
|
6
|
+
**date** | **Date** | Date for which statistics are retrieved | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the date | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the date | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the date | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the date | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the date | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the date | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the date | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the date | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the date | [optional]
|
16
16
|
|
17
17
|
|
data/docs/GetWebhook.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**description** | **String** | Description of the webhook |
|
9
9
|
**events** | **Array<String>** | |
|
10
10
|
**type** | **String** | Type of webhook (marketing or transac) |
|
11
|
-
**created_at** | **
|
12
|
-
**modified_at** | **
|
11
|
+
**created_at** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
12
|
+
**modified_at** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
13
|
|
14
14
|
|
data/docs/ListsApi.md
CHANGED
@@ -215,9 +215,10 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
215
215
|
list_id = 789 # Integer | Id of the list
|
216
216
|
|
217
217
|
opts = {
|
218
|
-
modified_since:
|
218
|
+
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.
|
219
219
|
limit: 50, # Integer | Number of documents per page
|
220
|
-
offset: 0 # Integer | Index of the first document of the page
|
220
|
+
offset: 0, # Integer | Index of the first document of the page
|
221
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
221
222
|
}
|
222
223
|
|
223
224
|
begin
|
@@ -234,9 +235,10 @@ end
|
|
234
235
|
Name | Type | Description | Notes
|
235
236
|
------------- | ------------- | ------------- | -------------
|
236
237
|
**list_id** | **Integer**| Id of the list |
|
237
|
-
**modified_since** | **
|
238
|
+
**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]
|
238
239
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
239
240
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
241
|
+
**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]
|
240
242
|
|
241
243
|
### Return type
|
242
244
|
|
@@ -281,7 +283,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
281
283
|
|
282
284
|
opts = {
|
283
285
|
limit: 10, # Integer | Number of documents per page
|
284
|
-
offset: 0 # Integer | Index of the first document of the page
|
286
|
+
offset: 0, # Integer | Index of the first document of the page
|
287
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
285
288
|
}
|
286
289
|
|
287
290
|
begin
|
@@ -300,6 +303,7 @@ Name | Type | Description | Notes
|
|
300
303
|
**folder_id** | **Integer**| Id of the folder |
|
301
304
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
302
305
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
306
|
+
**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]
|
303
307
|
|
304
308
|
### Return type
|
305
309
|
|
@@ -399,7 +403,8 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
399
403
|
|
400
404
|
opts = {
|
401
405
|
limit: 10, # Integer | Number of documents per page
|
402
|
-
offset: 0 # Integer | Index of the first document of the page
|
406
|
+
offset: 0, # Integer | Index of the first document of the page
|
407
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
403
408
|
}
|
404
409
|
|
405
410
|
begin
|
@@ -417,6 +422,7 @@ Name | Type | Description | Notes
|
|
417
422
|
------------- | ------------- | ------------- | -------------
|
418
423
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
419
424
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
425
|
+
**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]
|
420
426
|
|
421
427
|
### Return type
|
422
428
|
|
data/docs/ProcessApi.md
CHANGED
@@ -91,7 +91,8 @@ api_instance = SibApiV3Sdk::ProcessApi.new
|
|
91
91
|
|
92
92
|
opts = {
|
93
93
|
limit: 10, # Integer | Number limitation for the result returned
|
94
|
-
offset: 0 # Integer | Beginning point in the list to retrieve from.
|
94
|
+
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
95
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
95
96
|
}
|
96
97
|
|
97
98
|
begin
|
@@ -109,6 +110,7 @@ Name | Type | Description | Notes
|
|
109
110
|
------------- | ------------- | ------------- | -------------
|
110
111
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
|
111
112
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
113
|
+
**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]
|
112
114
|
|
113
115
|
### Return type
|
114
116
|
|