sib-api-v3-sdk 5.2.3 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +96 -68
- data/docs/AbTestCampaignResult.md +13 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +1 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +123 -60
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +3 -3
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +6 -3
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmtpEmail.md +1 -1
- data/docs/CreateSmtpTemplate.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAccountRelay.md +1 -1
- data/docs/GetAccountRelayData.md +1 -1
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetSmtpTemplates.md +1 -1
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +8 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/ListsApi.md +13 -13
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +2 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +215 -86
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SMTPApi.md +350 -42
- data/docs/SendEmail.md +2 -2
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -1
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +1 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendersApi.md +8 -8
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateContact.md +2 -2
- data/docs/UpdateEmailCampaign.md +5 -2
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +19 -2
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +169 -186
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +38 -65
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +342 -92
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +276 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +10 -15
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +214 -0
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +57 -68
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +15 -24
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +64 -52
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/smtp_api_spec.rb +88 -34
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_spec.rb +79 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +3 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +14 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +41 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +4 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +12 -13
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +4 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +70 -2
@@ -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 CreateWebhook
|
18
17
|
# URL of the webhook
|
19
18
|
attr_accessor :url
|
@@ -21,7 +20,7 @@ module SibApiV3Sdk
|
|
21
20
|
# Description of the webhook
|
22
21
|
attr_accessor :description
|
23
22
|
|
24
|
-
# Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered
|
23
|
+
# Events triggering the webhook. Possible values for Transactional type webhook – sent, request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered
|
25
24
|
attr_accessor :events
|
26
25
|
|
27
26
|
# Type of the webhook
|
@@ -75,7 +74,7 @@ module SibApiV3Sdk
|
|
75
74
|
return unless attributes.is_a?(Hash)
|
76
75
|
|
77
76
|
# convert string to symbol for hash key
|
78
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
77
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
79
78
|
|
80
79
|
if attributes.has_key?(:'url')
|
81
80
|
self.url = attributes[:'url']
|
@@ -94,9 +93,8 @@ module SibApiV3Sdk
|
|
94
93
|
if attributes.has_key?(:'type')
|
95
94
|
self.type = attributes[:'type']
|
96
95
|
else
|
97
|
-
self.type =
|
96
|
+
self.type = 'transactional'
|
98
97
|
end
|
99
|
-
|
100
98
|
end
|
101
99
|
|
102
100
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -104,14 +102,14 @@ module SibApiV3Sdk
|
|
104
102
|
def list_invalid_properties
|
105
103
|
invalid_properties = Array.new
|
106
104
|
if @url.nil?
|
107
|
-
invalid_properties.push(
|
105
|
+
invalid_properties.push('invalid value for "url", url cannot be nil.')
|
108
106
|
end
|
109
107
|
|
110
108
|
if @events.nil?
|
111
|
-
invalid_properties.push(
|
109
|
+
invalid_properties.push('invalid value for "events", events cannot be nil.')
|
112
110
|
end
|
113
111
|
|
114
|
-
|
112
|
+
invalid_properties
|
115
113
|
end
|
116
114
|
|
117
115
|
# Check to see if the all the properties in the model are valid
|
@@ -119,17 +117,17 @@ module SibApiV3Sdk
|
|
119
117
|
def valid?
|
120
118
|
return false if @url.nil?
|
121
119
|
return false if @events.nil?
|
122
|
-
type_validator = EnumAttributeValidator.new('String', [
|
120
|
+
type_validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
|
123
121
|
return false unless type_validator.valid?(@type)
|
124
|
-
|
122
|
+
true
|
125
123
|
end
|
126
124
|
|
127
125
|
# Custom attribute writer method checking allowed values (enum).
|
128
126
|
# @param [Object] type Object to be assigned
|
129
127
|
def type=(type)
|
130
|
-
validator = EnumAttributeValidator.new('String', [
|
128
|
+
validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
|
131
129
|
unless validator.valid?(type)
|
132
|
-
fail ArgumentError,
|
130
|
+
fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
|
133
131
|
end
|
134
132
|
@type = type
|
135
133
|
end
|
@@ -167,7 +165,7 @@ module SibApiV3Sdk
|
|
167
165
|
# check to ensure the input is an array given that the the attribute
|
168
166
|
# is documented as an array but the input is not
|
169
167
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
170
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
168
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
171
169
|
end
|
172
170
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
173
171
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -249,7 +247,7 @@ module SibApiV3Sdk
|
|
249
247
|
# @return [Hash] Returns the value in the form of hash
|
250
248
|
def _to_hash(value)
|
251
249
|
if value.is_a?(Array)
|
252
|
-
value.compact.map{ |v| _to_hash(v) }
|
250
|
+
value.compact.map { |v| _to_hash(v) }
|
253
251
|
elsif value.is_a?(Hash)
|
254
252
|
{}.tap do |hash|
|
255
253
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -260,7 +258,5 @@ module SibApiV3Sdk
|
|
260
258
|
value
|
261
259
|
end
|
262
260
|
end
|
263
|
-
|
264
261
|
end
|
265
|
-
|
266
262
|
end
|
@@ -1,24 +1,22 @@
|
|
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 CreatedProcessId
|
18
17
|
# Id of the process created
|
19
18
|
attr_accessor :process_id
|
20
19
|
|
21
|
-
|
22
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
23
21
|
def self.attribute_map
|
24
22
|
{
|
@@ -39,12 +37,11 @@ module SibApiV3Sdk
|
|
39
37
|
return unless attributes.is_a?(Hash)
|
40
38
|
|
41
39
|
# convert string to symbol for hash key
|
42
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
40
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
43
41
|
|
44
42
|
if attributes.has_key?(:'processId')
|
45
43
|
self.process_id = attributes[:'processId']
|
46
44
|
end
|
47
|
-
|
48
45
|
end
|
49
46
|
|
50
47
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -52,17 +49,17 @@ module SibApiV3Sdk
|
|
52
49
|
def list_invalid_properties
|
53
50
|
invalid_properties = Array.new
|
54
51
|
if @process_id.nil?
|
55
|
-
invalid_properties.push(
|
52
|
+
invalid_properties.push('invalid value for "process_id", process_id cannot be nil.')
|
56
53
|
end
|
57
54
|
|
58
|
-
|
55
|
+
invalid_properties
|
59
56
|
end
|
60
57
|
|
61
58
|
# Check to see if the all the properties in the model are valid
|
62
59
|
# @return true if the model is valid
|
63
60
|
def valid?
|
64
61
|
return false if @process_id.nil?
|
65
|
-
|
62
|
+
true
|
66
63
|
end
|
67
64
|
|
68
65
|
# Checks equality by comparing each attribute.
|
@@ -95,7 +92,7 @@ module SibApiV3Sdk
|
|
95
92
|
# check to ensure the input is an array given that the the attribute
|
96
93
|
# is documented as an array but the input is not
|
97
94
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
98
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
95
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
99
96
|
end
|
100
97
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
101
98
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -177,7 +174,7 @@ module SibApiV3Sdk
|
|
177
174
|
# @return [Hash] Returns the value in the form of hash
|
178
175
|
def _to_hash(value)
|
179
176
|
if value.is_a?(Array)
|
180
|
-
value.compact.map{ |v| _to_hash(v) }
|
177
|
+
value.compact.map { |v| _to_hash(v) }
|
181
178
|
elsif value.is_a?(Hash)
|
182
179
|
{}.tap do |hash|
|
183
180
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -188,7 +185,5 @@ module SibApiV3Sdk
|
|
188
185
|
value
|
189
186
|
end
|
190
187
|
end
|
191
|
-
|
192
188
|
end
|
193
|
-
|
194
189
|
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 DeleteHardbounces
|
18
17
|
# Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate
|
19
18
|
attr_accessor :start_date
|
@@ -24,7 +23,6 @@ module SibApiV3Sdk
|
|
24
23
|
# Target a specific email address
|
25
24
|
attr_accessor :contact_email
|
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?(:'startDate')
|
55
53
|
self.start_date = attributes[:'startDate']
|
@@ -62,20 +60,19 @@ module SibApiV3Sdk
|
|
62
60
|
if attributes.has_key?(:'contactEmail')
|
63
61
|
self.contact_email = attributes[:'contactEmail']
|
64
62
|
end
|
65
|
-
|
66
63
|
end
|
67
64
|
|
68
65
|
# Show invalid properties with the reasons. Usually used together with valid?
|
69
66
|
# @return Array for valid properties with the reasons
|
70
67
|
def list_invalid_properties
|
71
68
|
invalid_properties = Array.new
|
72
|
-
|
69
|
+
invalid_properties
|
73
70
|
end
|
74
71
|
|
75
72
|
# Check to see if the all the properties in the model are valid
|
76
73
|
# @return true if the model is valid
|
77
74
|
def valid?
|
78
|
-
|
75
|
+
true
|
79
76
|
end
|
80
77
|
|
81
78
|
# Checks equality by comparing each attribute.
|
@@ -110,7 +107,7 @@ module SibApiV3Sdk
|
|
110
107
|
# check to ensure the input is an array given that the the attribute
|
111
108
|
# is documented as an array but the input is not
|
112
109
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
113
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
110
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
114
111
|
end
|
115
112
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
116
113
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -192,7 +189,7 @@ module SibApiV3Sdk
|
|
192
189
|
# @return [Hash] Returns the value in the form of hash
|
193
190
|
def _to_hash(value)
|
194
191
|
if value.is_a?(Array)
|
195
|
-
value.compact.map{ |v| _to_hash(v) }
|
192
|
+
value.compact.map { |v| _to_hash(v) }
|
196
193
|
elsif value.is_a?(Hash)
|
197
194
|
{}.tap do |hash|
|
198
195
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -203,7 +200,5 @@ module SibApiV3Sdk
|
|
203
200
|
value
|
204
201
|
end
|
205
202
|
end
|
206
|
-
|
207
203
|
end
|
208
|
-
|
209
204
|
end
|
@@ -1,21 +1,20 @@
|
|
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 EmailExportRecipients
|
18
|
-
# Webhook called once the export process is finished
|
17
|
+
# Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
|
19
18
|
attr_accessor :notify_url
|
20
19
|
|
21
20
|
# Type of recipients to export for a campaign
|
@@ -65,7 +64,7 @@ module SibApiV3Sdk
|
|
65
64
|
return unless attributes.is_a?(Hash)
|
66
65
|
|
67
66
|
# convert string to symbol for hash key
|
68
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
67
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
69
68
|
|
70
69
|
if attributes.has_key?(:'notifyURL')
|
71
70
|
self.notify_url = attributes[:'notifyURL']
|
@@ -74,7 +73,6 @@ module SibApiV3Sdk
|
|
74
73
|
if attributes.has_key?(:'recipientsType')
|
75
74
|
self.recipients_type = attributes[:'recipientsType']
|
76
75
|
end
|
77
|
-
|
78
76
|
end
|
79
77
|
|
80
78
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -82,27 +80,27 @@ module SibApiV3Sdk
|
|
82
80
|
def list_invalid_properties
|
83
81
|
invalid_properties = Array.new
|
84
82
|
if @recipients_type.nil?
|
85
|
-
invalid_properties.push(
|
83
|
+
invalid_properties.push('invalid value for "recipients_type", recipients_type cannot be nil.')
|
86
84
|
end
|
87
85
|
|
88
|
-
|
86
|
+
invalid_properties
|
89
87
|
end
|
90
88
|
|
91
89
|
# Check to see if the all the properties in the model are valid
|
92
90
|
# @return true if the model is valid
|
93
91
|
def valid?
|
94
92
|
return false if @recipients_type.nil?
|
95
|
-
recipients_type_validator = EnumAttributeValidator.new('String', [
|
93
|
+
recipients_type_validator = EnumAttributeValidator.new('String', ['all', 'nonClickers', 'nonOpeners', 'clickers', 'openers', 'softBounces', 'hardBounces', 'unsubscribed'])
|
96
94
|
return false unless recipients_type_validator.valid?(@recipients_type)
|
97
|
-
|
95
|
+
true
|
98
96
|
end
|
99
97
|
|
100
98
|
# Custom attribute writer method checking allowed values (enum).
|
101
99
|
# @param [Object] recipients_type Object to be assigned
|
102
100
|
def recipients_type=(recipients_type)
|
103
|
-
validator = EnumAttributeValidator.new('String', [
|
101
|
+
validator = EnumAttributeValidator.new('String', ['all', 'nonClickers', 'nonOpeners', 'clickers', 'openers', 'softBounces', 'hardBounces', 'unsubscribed'])
|
104
102
|
unless validator.valid?(recipients_type)
|
105
|
-
fail ArgumentError,
|
103
|
+
fail ArgumentError, 'invalid value for "recipients_type", must be one of #{validator.allowable_values}.'
|
106
104
|
end
|
107
105
|
@recipients_type = recipients_type
|
108
106
|
end
|
@@ -138,7 +136,7 @@ module SibApiV3Sdk
|
|
138
136
|
# check to ensure the input is an array given that the the attribute
|
139
137
|
# is documented as an array but the input is not
|
140
138
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
141
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
139
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
142
140
|
end
|
143
141
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
144
142
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -220,7 +218,7 @@ module SibApiV3Sdk
|
|
220
218
|
# @return [Hash] Returns the value in the form of hash
|
221
219
|
def _to_hash(value)
|
222
220
|
if value.is_a?(Array)
|
223
|
-
value.compact.map{ |v| _to_hash(v) }
|
221
|
+
value.compact.map { |v| _to_hash(v) }
|
224
222
|
elsif value.is_a?(Hash)
|
225
223
|
{}.tap do |hash|
|
226
224
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -231,7 +229,5 @@ module SibApiV3Sdk
|
|
231
229
|
value
|
232
230
|
end
|
233
231
|
end
|
234
|
-
|
235
232
|
end
|
236
|
-
|
237
233
|
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 ErrorModel
|
18
17
|
# Error code displayed in case of a failure
|
19
18
|
attr_accessor :code
|
@@ -65,7 +64,7 @@ module SibApiV3Sdk
|
|
65
64
|
return unless attributes.is_a?(Hash)
|
66
65
|
|
67
66
|
# convert string to symbol for hash key
|
68
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
67
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
69
68
|
|
70
69
|
if attributes.has_key?(:'code')
|
71
70
|
self.code = attributes[:'code']
|
@@ -74,7 +73,6 @@ module SibApiV3Sdk
|
|
74
73
|
if attributes.has_key?(:'message')
|
75
74
|
self.message = attributes[:'message']
|
76
75
|
end
|
77
|
-
|
78
76
|
end
|
79
77
|
|
80
78
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -82,32 +80,32 @@ module SibApiV3Sdk
|
|
82
80
|
def list_invalid_properties
|
83
81
|
invalid_properties = Array.new
|
84
82
|
if @code.nil?
|
85
|
-
invalid_properties.push(
|
83
|
+
invalid_properties.push('invalid value for "code", code cannot be nil.')
|
86
84
|
end
|
87
85
|
|
88
86
|
if @message.nil?
|
89
|
-
invalid_properties.push(
|
87
|
+
invalid_properties.push('invalid value for "message", message cannot be nil.')
|
90
88
|
end
|
91
89
|
|
92
|
-
|
90
|
+
invalid_properties
|
93
91
|
end
|
94
92
|
|
95
93
|
# Check to see if the all the properties in the model are valid
|
96
94
|
# @return true if the model is valid
|
97
95
|
def valid?
|
98
96
|
return false if @code.nil?
|
99
|
-
code_validator = EnumAttributeValidator.new('String', [
|
97
|
+
code_validator = EnumAttributeValidator.new('String', ['invalid_parameter', 'missing_parameter', 'out_of_range', 'campaign_processing', 'campaign_sent', 'document_not_found', 'reseller_permission_denied', 'not_enough_credits', 'permission_denied', 'duplicate_parameter', 'duplicate_request', 'method_not_allowed', 'unauthorized', 'account_under_validation', 'not_acceptable'])
|
100
98
|
return false unless code_validator.valid?(@code)
|
101
99
|
return false if @message.nil?
|
102
|
-
|
100
|
+
true
|
103
101
|
end
|
104
102
|
|
105
103
|
# Custom attribute writer method checking allowed values (enum).
|
106
104
|
# @param [Object] code Object to be assigned
|
107
105
|
def code=(code)
|
108
|
-
validator = EnumAttributeValidator.new('String', [
|
106
|
+
validator = EnumAttributeValidator.new('String', ['invalid_parameter', 'missing_parameter', 'out_of_range', 'campaign_processing', 'campaign_sent', 'document_not_found', 'reseller_permission_denied', 'not_enough_credits', 'permission_denied', 'duplicate_parameter', 'duplicate_request', 'method_not_allowed', 'unauthorized', 'account_under_validation', 'not_acceptable'])
|
109
107
|
unless validator.valid?(code)
|
110
|
-
fail ArgumentError,
|
108
|
+
fail ArgumentError, 'invalid value for "code", must be one of #{validator.allowable_values}.'
|
111
109
|
end
|
112
110
|
@code = code
|
113
111
|
end
|
@@ -143,7 +141,7 @@ module SibApiV3Sdk
|
|
143
141
|
# check to ensure the input is an array given that the the attribute
|
144
142
|
# is documented as an array but the input is not
|
145
143
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
146
|
-
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) })
|
147
145
|
end
|
148
146
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
149
147
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -225,7 +223,7 @@ module SibApiV3Sdk
|
|
225
223
|
# @return [Hash] Returns the value in the form of hash
|
226
224
|
def _to_hash(value)
|
227
225
|
if value.is_a?(Array)
|
228
|
-
value.compact.map{ |v| _to_hash(v) }
|
226
|
+
value.compact.map { |v| _to_hash(v) }
|
229
227
|
elsif value.is_a?(Hash)
|
230
228
|
{}.tap do |hash|
|
231
229
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -236,7 +234,5 @@ module SibApiV3Sdk
|
|
236
234
|
value
|
237
235
|
end
|
238
236
|
end
|
239
|
-
|
240
237
|
end
|
241
|
-
|
242
238
|
end
|