sib-api-v3-sdk 5.2.5 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +100 -75
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +2 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +136 -73
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +4 -1
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +17 -17
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +3 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +158 -91
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SendEmail.md +3 -3
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +2 -2
- data/docs/SendersApi.md +8 -8
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +4 -1
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UpdateWebhook.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +20 -3
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +62 -73
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +17 -26
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +53 -54
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +9 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +20 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +10 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +4 -33
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +10 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +11 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +78 -10
@@ -1,30 +1,28 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateSender
|
18
17
|
# From Name to use for the sender
|
19
18
|
attr_accessor :name
|
20
19
|
|
21
|
-
# From
|
20
|
+
# From email to use for the sender. A verification email will be sent to this address.
|
22
21
|
attr_accessor :email
|
23
22
|
|
24
23
|
# Mandatory in case of dedicated IP, IPs to associate to the sender
|
25
24
|
attr_accessor :ips
|
26
25
|
|
27
|
-
|
28
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
29
27
|
def self.attribute_map
|
30
28
|
{
|
@@ -49,7 +47,7 @@ module SibApiV3Sdk
|
|
49
47
|
return unless attributes.is_a?(Hash)
|
50
48
|
|
51
49
|
# convert string to symbol for hash key
|
52
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
50
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
53
51
|
|
54
52
|
if attributes.has_key?(:'name')
|
55
53
|
self.name = attributes[:'name']
|
@@ -64,7 +62,6 @@ module SibApiV3Sdk
|
|
64
62
|
self.ips = value
|
65
63
|
end
|
66
64
|
end
|
67
|
-
|
68
65
|
end
|
69
66
|
|
70
67
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -72,14 +69,14 @@ module SibApiV3Sdk
|
|
72
69
|
def list_invalid_properties
|
73
70
|
invalid_properties = Array.new
|
74
71
|
if @name.nil?
|
75
|
-
invalid_properties.push(
|
72
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
76
73
|
end
|
77
74
|
|
78
75
|
if @email.nil?
|
79
|
-
invalid_properties.push(
|
76
|
+
invalid_properties.push('invalid value for "email", email cannot be nil.')
|
80
77
|
end
|
81
78
|
|
82
|
-
|
79
|
+
invalid_properties
|
83
80
|
end
|
84
81
|
|
85
82
|
# Check to see if the all the properties in the model are valid
|
@@ -87,7 +84,7 @@ module SibApiV3Sdk
|
|
87
84
|
def valid?
|
88
85
|
return false if @name.nil?
|
89
86
|
return false if @email.nil?
|
90
|
-
|
87
|
+
true
|
91
88
|
end
|
92
89
|
|
93
90
|
# Checks equality by comparing each attribute.
|
@@ -122,7 +119,7 @@ module SibApiV3Sdk
|
|
122
119
|
# check to ensure the input is an array given that the the attribute
|
123
120
|
# is documented as an array but the input is not
|
124
121
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
125
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
122
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
126
123
|
end
|
127
124
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
128
125
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -204,7 +201,7 @@ module SibApiV3Sdk
|
|
204
201
|
# @return [Hash] Returns the value in the form of hash
|
205
202
|
def _to_hash(value)
|
206
203
|
if value.is_a?(Array)
|
207
|
-
value.compact.map{ |v| _to_hash(v) }
|
204
|
+
value.compact.map { |v| _to_hash(v) }
|
208
205
|
elsif value.is_a?(Hash)
|
209
206
|
{}.tap do |hash|
|
210
207
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -215,7 +212,5 @@ module SibApiV3Sdk
|
|
215
212
|
value
|
216
213
|
end
|
217
214
|
end
|
218
|
-
|
219
215
|
end
|
220
|
-
|
221
216
|
end
|
@@ -1,19 +1,18 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateSenderIps
|
18
17
|
# Dedicated IP available in your account
|
19
18
|
attr_accessor :ip
|
@@ -24,7 +23,6 @@ module SibApiV3Sdk
|
|
24
23
|
# Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs.
|
25
24
|
attr_accessor :weight
|
26
25
|
|
27
|
-
|
28
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
29
27
|
def self.attribute_map
|
30
28
|
{
|
@@ -49,7 +47,7 @@ module SibApiV3Sdk
|
|
49
47
|
return unless attributes.is_a?(Hash)
|
50
48
|
|
51
49
|
# convert string to symbol for hash key
|
52
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
50
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
53
51
|
|
54
52
|
if attributes.has_key?(:'ip')
|
55
53
|
self.ip = attributes[:'ip']
|
@@ -62,7 +60,6 @@ module SibApiV3Sdk
|
|
62
60
|
if attributes.has_key?(:'weight')
|
63
61
|
self.weight = attributes[:'weight']
|
64
62
|
end
|
65
|
-
|
66
63
|
end
|
67
64
|
|
68
65
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -70,22 +67,22 @@ module SibApiV3Sdk
|
|
70
67
|
def list_invalid_properties
|
71
68
|
invalid_properties = Array.new
|
72
69
|
if @ip.nil?
|
73
|
-
invalid_properties.push(
|
70
|
+
invalid_properties.push('invalid value for "ip", ip cannot be nil.')
|
74
71
|
end
|
75
72
|
|
76
73
|
if @domain.nil?
|
77
|
-
invalid_properties.push(
|
74
|
+
invalid_properties.push('invalid value for "domain", domain cannot be nil.')
|
78
75
|
end
|
79
76
|
|
80
77
|
if !@weight.nil? && @weight > 100
|
81
|
-
invalid_properties.push(
|
78
|
+
invalid_properties.push('invalid value for "weight", must be smaller than or equal to 100.')
|
82
79
|
end
|
83
80
|
|
84
81
|
if !@weight.nil? && @weight < 1
|
85
|
-
invalid_properties.push(
|
82
|
+
invalid_properties.push('invalid value for "weight", must be greater than or equal to 1.')
|
86
83
|
end
|
87
84
|
|
88
|
-
|
85
|
+
invalid_properties
|
89
86
|
end
|
90
87
|
|
91
88
|
# Check to see if the all the properties in the model are valid
|
@@ -95,19 +92,18 @@ module SibApiV3Sdk
|
|
95
92
|
return false if @domain.nil?
|
96
93
|
return false if !@weight.nil? && @weight > 100
|
97
94
|
return false if !@weight.nil? && @weight < 1
|
98
|
-
|
95
|
+
true
|
99
96
|
end
|
100
97
|
|
101
98
|
# Custom attribute writer method with validation
|
102
99
|
# @param [Object] weight Value to be assigned
|
103
100
|
def weight=(weight)
|
104
|
-
|
105
101
|
if !weight.nil? && weight > 100
|
106
|
-
fail ArgumentError,
|
102
|
+
fail ArgumentError, 'invalid value for "weight", must be smaller than or equal to 100.'
|
107
103
|
end
|
108
104
|
|
109
105
|
if !weight.nil? && weight < 1
|
110
|
-
fail ArgumentError,
|
106
|
+
fail ArgumentError, 'invalid value for "weight", must be greater than or equal to 1.'
|
111
107
|
end
|
112
108
|
|
113
109
|
@weight = weight
|
@@ -145,7 +141,7 @@ module SibApiV3Sdk
|
|
145
141
|
# check to ensure the input is an array given that the the attribute
|
146
142
|
# is documented as an array but the input is not
|
147
143
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
148
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
144
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
149
145
|
end
|
150
146
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
151
147
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -227,7 +223,7 @@ module SibApiV3Sdk
|
|
227
223
|
# @return [Hash] Returns the value in the form of hash
|
228
224
|
def _to_hash(value)
|
229
225
|
if value.is_a?(Array)
|
230
|
-
value.compact.map{ |v| _to_hash(v) }
|
226
|
+
value.compact.map { |v| _to_hash(v) }
|
231
227
|
elsif value.is_a?(Hash)
|
232
228
|
{}.tap do |hash|
|
233
229
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -238,7 +234,5 @@ module SibApiV3Sdk
|
|
238
234
|
value
|
239
235
|
end
|
240
236
|
end
|
241
|
-
|
242
237
|
end
|
243
|
-
|
244
238
|
end
|
@@ -1,19 +1,18 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateSenderModel
|
18
17
|
# ID of the Sender created
|
19
18
|
attr_accessor :id
|
@@ -24,7 +23,6 @@ module SibApiV3Sdk
|
|
24
23
|
# Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured)
|
25
24
|
attr_accessor :dkim_error
|
26
25
|
|
27
|
-
|
28
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
29
27
|
def self.attribute_map
|
30
28
|
{
|
@@ -49,7 +47,7 @@ module SibApiV3Sdk
|
|
49
47
|
return unless attributes.is_a?(Hash)
|
50
48
|
|
51
49
|
# convert string to symbol for hash key
|
52
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
50
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
53
51
|
|
54
52
|
if attributes.has_key?(:'id')
|
55
53
|
self.id = attributes[:'id']
|
@@ -62,7 +60,6 @@ module SibApiV3Sdk
|
|
62
60
|
if attributes.has_key?(:'dkimError')
|
63
61
|
self.dkim_error = attributes[:'dkimError']
|
64
62
|
end
|
65
|
-
|
66
63
|
end
|
67
64
|
|
68
65
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -70,17 +67,17 @@ module SibApiV3Sdk
|
|
70
67
|
def list_invalid_properties
|
71
68
|
invalid_properties = Array.new
|
72
69
|
if @id.nil?
|
73
|
-
invalid_properties.push(
|
70
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
74
71
|
end
|
75
72
|
|
76
|
-
|
73
|
+
invalid_properties
|
77
74
|
end
|
78
75
|
|
79
76
|
# Check to see if the all the properties in the model are valid
|
80
77
|
# @return true if the model is valid
|
81
78
|
def valid?
|
82
79
|
return false if @id.nil?
|
83
|
-
|
80
|
+
true
|
84
81
|
end
|
85
82
|
|
86
83
|
# Checks equality by comparing each attribute.
|
@@ -115,7 +112,7 @@ module SibApiV3Sdk
|
|
115
112
|
# check to ensure the input is an array given that the the attribute
|
116
113
|
# is documented as an array but the input is not
|
117
114
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
118
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
115
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
119
116
|
end
|
120
117
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
121
118
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -197,7 +194,7 @@ module SibApiV3Sdk
|
|
197
194
|
# @return [Hash] Returns the value in the form of hash
|
198
195
|
def _to_hash(value)
|
199
196
|
if value.is_a?(Array)
|
200
|
-
value.compact.map{ |v| _to_hash(v) }
|
197
|
+
value.compact.map { |v| _to_hash(v) }
|
201
198
|
elsif value.is_a?(Hash)
|
202
199
|
{}.tap do |hash|
|
203
200
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -208,7 +205,5 @@ module SibApiV3Sdk
|
|
208
205
|
value
|
209
206
|
end
|
210
207
|
end
|
211
|
-
|
212
208
|
end
|
213
|
-
|
214
209
|
end
|
@@ -1,24 +1,23 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateSmsCampaign
|
18
17
|
# Name of the campaign
|
19
18
|
attr_accessor :name
|
20
19
|
|
21
|
-
# Name of the sender. The number of characters is limited to 11
|
20
|
+
# Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
|
22
21
|
attr_accessor :sender
|
23
22
|
|
24
23
|
# 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
|
@@ -29,7 +28,6 @@ module SibApiV3Sdk
|
|
29
28
|
# 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.
|
30
29
|
attr_accessor :scheduled_at
|
31
30
|
|
32
|
-
|
33
31
|
# Attribute mapping from ruby-style variable name to JSON key.
|
34
32
|
def self.attribute_map
|
35
33
|
{
|
@@ -58,7 +56,7 @@ module SibApiV3Sdk
|
|
58
56
|
return unless attributes.is_a?(Hash)
|
59
57
|
|
60
58
|
# convert string to symbol for hash key
|
61
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
62
60
|
|
63
61
|
if attributes.has_key?(:'name')
|
64
62
|
self.name = attributes[:'name']
|
@@ -79,7 +77,6 @@ module SibApiV3Sdk
|
|
79
77
|
if attributes.has_key?(:'scheduledAt')
|
80
78
|
self.scheduled_at = attributes[:'scheduledAt']
|
81
79
|
end
|
82
|
-
|
83
80
|
end
|
84
81
|
|
85
82
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -87,22 +84,22 @@ module SibApiV3Sdk
|
|
87
84
|
def list_invalid_properties
|
88
85
|
invalid_properties = Array.new
|
89
86
|
if @name.nil?
|
90
|
-
invalid_properties.push(
|
87
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
91
88
|
end
|
92
89
|
|
93
90
|
if @sender.nil?
|
94
|
-
invalid_properties.push(
|
91
|
+
invalid_properties.push('invalid value for "sender", sender cannot be nil.')
|
95
92
|
end
|
96
93
|
|
97
|
-
if @sender.to_s.length >
|
98
|
-
invalid_properties.push(
|
94
|
+
if @sender.to_s.length > 15
|
95
|
+
invalid_properties.push('invalid value for "sender", the character length must be smaller than or equal to 15.')
|
99
96
|
end
|
100
97
|
|
101
98
|
if @content.nil?
|
102
|
-
invalid_properties.push(
|
99
|
+
invalid_properties.push('invalid value for "content", content cannot be nil.')
|
103
100
|
end
|
104
101
|
|
105
|
-
|
102
|
+
invalid_properties
|
106
103
|
end
|
107
104
|
|
108
105
|
# Check to see if the all the properties in the model are valid
|
@@ -110,20 +107,20 @@ module SibApiV3Sdk
|
|
110
107
|
def valid?
|
111
108
|
return false if @name.nil?
|
112
109
|
return false if @sender.nil?
|
113
|
-
return false if @sender.to_s.length >
|
110
|
+
return false if @sender.to_s.length > 15
|
114
111
|
return false if @content.nil?
|
115
|
-
|
112
|
+
true
|
116
113
|
end
|
117
114
|
|
118
115
|
# Custom attribute writer method with validation
|
119
116
|
# @param [Object] sender Value to be assigned
|
120
117
|
def sender=(sender)
|
121
118
|
if sender.nil?
|
122
|
-
fail ArgumentError,
|
119
|
+
fail ArgumentError, 'sender cannot be nil'
|
123
120
|
end
|
124
121
|
|
125
|
-
if sender.to_s.length >
|
126
|
-
fail ArgumentError,
|
122
|
+
if sender.to_s.length > 15
|
123
|
+
fail ArgumentError, 'invalid value for "sender", the character length must be smaller than or equal to 15.'
|
127
124
|
end
|
128
125
|
|
129
126
|
@sender = sender
|
@@ -163,7 +160,7 @@ module SibApiV3Sdk
|
|
163
160
|
# check to ensure the input is an array given that the the attribute
|
164
161
|
# is documented as an array but the input is not
|
165
162
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
166
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
163
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
167
164
|
end
|
168
165
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
169
166
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -245,7 +242,7 @@ module SibApiV3Sdk
|
|
245
242
|
# @return [Hash] Returns the value in the form of hash
|
246
243
|
def _to_hash(value)
|
247
244
|
if value.is_a?(Array)
|
248
|
-
value.compact.map{ |v| _to_hash(v) }
|
245
|
+
value.compact.map { |v| _to_hash(v) }
|
249
246
|
elsif value.is_a?(Hash)
|
250
247
|
{}.tap do |hash|
|
251
248
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -256,7 +253,5 @@ module SibApiV3Sdk
|
|
256
253
|
value
|
257
254
|
end
|
258
255
|
end
|
259
|
-
|
260
256
|
end
|
261
|
-
|
262
257
|
end
|
@@ -1,19 +1,18 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateSmsCampaignRecipients
|
18
17
|
# Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty
|
19
18
|
attr_accessor :list_ids
|
@@ -21,7 +20,6 @@ module SibApiV3Sdk
|
|
21
20
|
# List ids which have to be excluded from a campaign
|
22
21
|
attr_accessor :exclusion_list_ids
|
23
22
|
|
24
|
-
|
25
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
24
|
def self.attribute_map
|
27
25
|
{
|
@@ -44,7 +42,7 @@ module SibApiV3Sdk
|
|
44
42
|
return unless attributes.is_a?(Hash)
|
45
43
|
|
46
44
|
# convert string to symbol for hash key
|
47
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
45
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
48
46
|
|
49
47
|
if attributes.has_key?(:'listIds')
|
50
48
|
if (value = attributes[:'listIds']).is_a?(Array)
|
@@ -57,7 +55,6 @@ module SibApiV3Sdk
|
|
57
55
|
self.exclusion_list_ids = value
|
58
56
|
end
|
59
57
|
end
|
60
|
-
|
61
58
|
end
|
62
59
|
|
63
60
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -65,17 +62,17 @@ module SibApiV3Sdk
|
|
65
62
|
def list_invalid_properties
|
66
63
|
invalid_properties = Array.new
|
67
64
|
if @list_ids.nil?
|
68
|
-
invalid_properties.push(
|
65
|
+
invalid_properties.push('invalid value for "list_ids", list_ids cannot be nil.')
|
69
66
|
end
|
70
67
|
|
71
|
-
|
68
|
+
invalid_properties
|
72
69
|
end
|
73
70
|
|
74
71
|
# Check to see if the all the properties in the model are valid
|
75
72
|
# @return true if the model is valid
|
76
73
|
def valid?
|
77
74
|
return false if @list_ids.nil?
|
78
|
-
|
75
|
+
true
|
79
76
|
end
|
80
77
|
|
81
78
|
# Checks equality by comparing each attribute.
|
@@ -109,7 +106,7 @@ module SibApiV3Sdk
|
|
109
106
|
# check to ensure the input is an array given that the the attribute
|
110
107
|
# is documented as an array but the input is not
|
111
108
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
112
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
109
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
113
110
|
end
|
114
111
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
115
112
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -191,7 +188,7 @@ module SibApiV3Sdk
|
|
191
188
|
# @return [Hash] Returns the value in the form of hash
|
192
189
|
def _to_hash(value)
|
193
190
|
if value.is_a?(Array)
|
194
|
-
value.compact.map{ |v| _to_hash(v) }
|
191
|
+
value.compact.map { |v| _to_hash(v) }
|
195
192
|
elsif value.is_a?(Hash)
|
196
193
|
{}.tap do |hash|
|
197
194
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -202,7 +199,5 @@ module SibApiV3Sdk
|
|
202
199
|
value
|
203
200
|
end
|
204
201
|
end
|
205
|
-
|
206
202
|
end
|
207
|
-
|
208
203
|
end
|