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 GetExtendedCampaignOverview
|
18
17
|
# ID of the campaign
|
19
18
|
attr_accessor :id
|
@@ -98,6 +97,9 @@ module SibApiV3Sdk
|
|
98
97
|
# Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
|
99
98
|
attr_accessor :sent_date
|
100
99
|
|
100
|
+
# Total number of non-delivered campaigns for a particular campaign id.
|
101
|
+
attr_accessor :return_bounce
|
102
|
+
|
101
103
|
class EnumAttributeValidator
|
102
104
|
attr_reader :datatype
|
103
105
|
attr_reader :allowable_values
|
@@ -150,7 +152,8 @@ module SibApiV3Sdk
|
|
150
152
|
:'inline_image_activation' => :'inlineImageActivation',
|
151
153
|
:'mirror_active' => :'mirrorActive',
|
152
154
|
:'recurring' => :'recurring',
|
153
|
-
:'sent_date' => :'sentDate'
|
155
|
+
:'sent_date' => :'sentDate',
|
156
|
+
:'return_bounce' => :'returnBounce'
|
154
157
|
}
|
155
158
|
end
|
156
159
|
|
@@ -184,7 +187,8 @@ module SibApiV3Sdk
|
|
184
187
|
:'inline_image_activation' => :'BOOLEAN',
|
185
188
|
:'mirror_active' => :'BOOLEAN',
|
186
189
|
:'recurring' => :'BOOLEAN',
|
187
|
-
:'sent_date' => :'DateTime'
|
190
|
+
:'sent_date' => :'DateTime',
|
191
|
+
:'return_bounce' => :'Integer'
|
188
192
|
}
|
189
193
|
end
|
190
194
|
|
@@ -194,7 +198,7 @@ module SibApiV3Sdk
|
|
194
198
|
return unless attributes.is_a?(Hash)
|
195
199
|
|
196
200
|
# convert string to symbol for hash key
|
197
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
201
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
198
202
|
|
199
203
|
if attributes.has_key?(:'id')
|
200
204
|
self.id = attributes[:'id']
|
@@ -308,6 +312,9 @@ module SibApiV3Sdk
|
|
308
312
|
self.sent_date = attributes[:'sentDate']
|
309
313
|
end
|
310
314
|
|
315
|
+
if attributes.has_key?(:'returnBounce')
|
316
|
+
self.return_bounce = attributes[:'returnBounce']
|
317
|
+
end
|
311
318
|
end
|
312
319
|
|
313
320
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -315,62 +322,62 @@ module SibApiV3Sdk
|
|
315
322
|
def list_invalid_properties
|
316
323
|
invalid_properties = Array.new
|
317
324
|
if @id.nil?
|
318
|
-
invalid_properties.push(
|
325
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
319
326
|
end
|
320
327
|
|
321
328
|
if @name.nil?
|
322
|
-
invalid_properties.push(
|
329
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
323
330
|
end
|
324
331
|
|
325
332
|
if @type.nil?
|
326
|
-
invalid_properties.push(
|
333
|
+
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
327
334
|
end
|
328
335
|
|
329
336
|
if @status.nil?
|
330
|
-
invalid_properties.push(
|
337
|
+
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
331
338
|
end
|
332
339
|
|
333
340
|
if @test_sent.nil?
|
334
|
-
invalid_properties.push(
|
341
|
+
invalid_properties.push('invalid value for "test_sent", test_sent cannot be nil.')
|
335
342
|
end
|
336
343
|
|
337
344
|
if @header.nil?
|
338
|
-
invalid_properties.push(
|
345
|
+
invalid_properties.push('invalid value for "header", header cannot be nil.')
|
339
346
|
end
|
340
347
|
|
341
348
|
if @footer.nil?
|
342
|
-
invalid_properties.push(
|
349
|
+
invalid_properties.push('invalid value for "footer", footer cannot be nil.')
|
343
350
|
end
|
344
351
|
|
345
352
|
if @sender.nil?
|
346
|
-
invalid_properties.push(
|
353
|
+
invalid_properties.push('invalid value for "sender", sender cannot be nil.')
|
347
354
|
end
|
348
355
|
|
349
356
|
if @reply_to.nil?
|
350
|
-
invalid_properties.push(
|
357
|
+
invalid_properties.push('invalid value for "reply_to", reply_to cannot be nil.')
|
351
358
|
end
|
352
359
|
|
353
360
|
if @to_field.nil?
|
354
|
-
invalid_properties.push(
|
361
|
+
invalid_properties.push('invalid value for "to_field", to_field cannot be nil.')
|
355
362
|
end
|
356
363
|
|
357
364
|
if @html_content.nil?
|
358
|
-
invalid_properties.push(
|
365
|
+
invalid_properties.push('invalid value for "html_content", html_content cannot be nil.')
|
359
366
|
end
|
360
367
|
|
361
368
|
if @tag.nil?
|
362
|
-
invalid_properties.push(
|
369
|
+
invalid_properties.push('invalid value for "tag", tag cannot be nil.')
|
363
370
|
end
|
364
371
|
|
365
372
|
if @created_at.nil?
|
366
|
-
invalid_properties.push(
|
373
|
+
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
367
374
|
end
|
368
375
|
|
369
376
|
if @modified_at.nil?
|
370
|
-
invalid_properties.push(
|
377
|
+
invalid_properties.push('invalid value for "modified_at", modified_at cannot be nil.')
|
371
378
|
end
|
372
379
|
|
373
|
-
|
380
|
+
invalid_properties
|
374
381
|
end
|
375
382
|
|
376
383
|
# Check to see if the all the properties in the model are valid
|
@@ -379,10 +386,10 @@ module SibApiV3Sdk
|
|
379
386
|
return false if @id.nil?
|
380
387
|
return false if @name.nil?
|
381
388
|
return false if @type.nil?
|
382
|
-
type_validator = EnumAttributeValidator.new('String', [
|
389
|
+
type_validator = EnumAttributeValidator.new('String', ['classic', 'trigger'])
|
383
390
|
return false unless type_validator.valid?(@type)
|
384
391
|
return false if @status.nil?
|
385
|
-
status_validator = EnumAttributeValidator.new('String', [
|
392
|
+
status_validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process'])
|
386
393
|
return false unless status_validator.valid?(@status)
|
387
394
|
return false if @test_sent.nil?
|
388
395
|
return false if @header.nil?
|
@@ -394,15 +401,15 @@ module SibApiV3Sdk
|
|
394
401
|
return false if @tag.nil?
|
395
402
|
return false if @created_at.nil?
|
396
403
|
return false if @modified_at.nil?
|
397
|
-
|
404
|
+
true
|
398
405
|
end
|
399
406
|
|
400
407
|
# Custom attribute writer method checking allowed values (enum).
|
401
408
|
# @param [Object] type Object to be assigned
|
402
409
|
def type=(type)
|
403
|
-
validator = EnumAttributeValidator.new('String', [
|
410
|
+
validator = EnumAttributeValidator.new('String', ['classic', 'trigger'])
|
404
411
|
unless validator.valid?(type)
|
405
|
-
fail ArgumentError,
|
412
|
+
fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
|
406
413
|
end
|
407
414
|
@type = type
|
408
415
|
end
|
@@ -410,9 +417,9 @@ module SibApiV3Sdk
|
|
410
417
|
# Custom attribute writer method checking allowed values (enum).
|
411
418
|
# @param [Object] status Object to be assigned
|
412
419
|
def status=(status)
|
413
|
-
validator = EnumAttributeValidator.new('String', [
|
420
|
+
validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process'])
|
414
421
|
unless validator.valid?(status)
|
415
|
-
fail ArgumentError,
|
422
|
+
fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
|
416
423
|
end
|
417
424
|
@status = status
|
418
425
|
end
|
@@ -449,7 +456,8 @@ module SibApiV3Sdk
|
|
449
456
|
inline_image_activation == o.inline_image_activation &&
|
450
457
|
mirror_active == o.mirror_active &&
|
451
458
|
recurring == o.recurring &&
|
452
|
-
sent_date == o.sent_date
|
459
|
+
sent_date == o.sent_date &&
|
460
|
+
return_bounce == o.return_bounce
|
453
461
|
end
|
454
462
|
|
455
463
|
# @see the `==` method
|
@@ -461,7 +469,7 @@ module SibApiV3Sdk
|
|
461
469
|
# Calculates hash code according to all attributes.
|
462
470
|
# @return [Fixnum] Hash code
|
463
471
|
def hash
|
464
|
-
[id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date].hash
|
472
|
+
[id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date, return_bounce].hash
|
465
473
|
end
|
466
474
|
|
467
475
|
# Builds the object from hash
|
@@ -474,7 +482,7 @@ module SibApiV3Sdk
|
|
474
482
|
# check to ensure the input is an array given that the the attribute
|
475
483
|
# is documented as an array but the input is not
|
476
484
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
477
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
485
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
478
486
|
end
|
479
487
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
480
488
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -556,7 +564,7 @@ module SibApiV3Sdk
|
|
556
564
|
# @return [Hash] Returns the value in the form of hash
|
557
565
|
def _to_hash(value)
|
558
566
|
if value.is_a?(Array)
|
559
|
-
value.compact.map{ |v| _to_hash(v) }
|
567
|
+
value.compact.map { |v| _to_hash(v) }
|
560
568
|
elsif value.is_a?(Hash)
|
561
569
|
{}.tap do |hash|
|
562
570
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -567,7 +575,5 @@ module SibApiV3Sdk
|
|
567
575
|
value
|
568
576
|
end
|
569
577
|
end
|
570
|
-
|
571
578
|
end
|
572
|
-
|
573
579
|
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 GetExtendedCampaignOverviewSender
|
18
17
|
# Sender name of the campaign
|
19
18
|
attr_accessor :name
|
@@ -21,12 +20,15 @@ module SibApiV3Sdk
|
|
21
20
|
# Sender email of the campaign
|
22
21
|
attr_accessor :email
|
23
22
|
|
23
|
+
# Sender id of the campaign
|
24
|
+
attr_accessor :id
|
24
25
|
|
25
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
27
|
def self.attribute_map
|
27
28
|
{
|
28
29
|
:'name' => :'name',
|
29
|
-
:'email' => :'email'
|
30
|
+
:'email' => :'email',
|
31
|
+
:'id' => :'id'
|
30
32
|
}
|
31
33
|
end
|
32
34
|
|
@@ -34,7 +36,8 @@ module SibApiV3Sdk
|
|
34
36
|
def self.swagger_types
|
35
37
|
{
|
36
38
|
:'name' => :'String',
|
37
|
-
:'email' => :'String'
|
39
|
+
:'email' => :'String',
|
40
|
+
:'id' => :'String'
|
38
41
|
}
|
39
42
|
end
|
40
43
|
|
@@ -44,7 +47,7 @@ module SibApiV3Sdk
|
|
44
47
|
return unless attributes.is_a?(Hash)
|
45
48
|
|
46
49
|
# convert string to symbol for hash key
|
47
|
-
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 }
|
48
51
|
|
49
52
|
if attributes.has_key?(:'name')
|
50
53
|
self.name = attributes[:'name']
|
@@ -54,19 +57,22 @@ module SibApiV3Sdk
|
|
54
57
|
self.email = attributes[:'email']
|
55
58
|
end
|
56
59
|
|
60
|
+
if attributes.has_key?(:'id')
|
61
|
+
self.id = attributes[:'id']
|
62
|
+
end
|
57
63
|
end
|
58
64
|
|
59
65
|
# Show invalid properties with the reasons. Usually used together with valid?
|
60
66
|
# @return Array for valid properties with the reasons
|
61
67
|
def list_invalid_properties
|
62
68
|
invalid_properties = Array.new
|
63
|
-
|
69
|
+
invalid_properties
|
64
70
|
end
|
65
71
|
|
66
72
|
# Check to see if the all the properties in the model are valid
|
67
73
|
# @return true if the model is valid
|
68
74
|
def valid?
|
69
|
-
|
75
|
+
true
|
70
76
|
end
|
71
77
|
|
72
78
|
# Checks equality by comparing each attribute.
|
@@ -75,7 +81,8 @@ module SibApiV3Sdk
|
|
75
81
|
return true if self.equal?(o)
|
76
82
|
self.class == o.class &&
|
77
83
|
name == o.name &&
|
78
|
-
email == o.email
|
84
|
+
email == o.email &&
|
85
|
+
id == o.id
|
79
86
|
end
|
80
87
|
|
81
88
|
# @see the `==` method
|
@@ -87,7 +94,7 @@ module SibApiV3Sdk
|
|
87
94
|
# Calculates hash code according to all attributes.
|
88
95
|
# @return [Fixnum] Hash code
|
89
96
|
def hash
|
90
|
-
[name, email].hash
|
97
|
+
[name, email, id].hash
|
91
98
|
end
|
92
99
|
|
93
100
|
# Builds the object from hash
|
@@ -100,7 +107,7 @@ module SibApiV3Sdk
|
|
100
107
|
# check to ensure the input is an array given that the the attribute
|
101
108
|
# is documented as an array but the input is not
|
102
109
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
103
|
-
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) })
|
104
111
|
end
|
105
112
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
106
113
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -182,7 +189,7 @@ module SibApiV3Sdk
|
|
182
189
|
# @return [Hash] Returns the value in the form of hash
|
183
190
|
def _to_hash(value)
|
184
191
|
if value.is_a?(Array)
|
185
|
-
value.compact.map{ |v| _to_hash(v) }
|
192
|
+
value.compact.map { |v| _to_hash(v) }
|
186
193
|
elsif value.is_a?(Hash)
|
187
194
|
{}.tap do |hash|
|
188
195
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -193,7 +200,5 @@ module SibApiV3Sdk
|
|
193
200
|
value
|
194
201
|
end
|
195
202
|
end
|
196
|
-
|
197
203
|
end
|
198
|
-
|
199
204
|
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 GetExtendedCampaignStats
|
18
17
|
# Overall statistics of the campaign
|
19
18
|
attr_accessor :global_stats
|
@@ -32,6 +31,11 @@ module SibApiV3Sdk
|
|
32
31
|
|
33
32
|
attr_accessor :stats_by_domain
|
34
33
|
|
34
|
+
# Statistics about the campaign on the basis of various devices
|
35
|
+
attr_accessor :stats_by_device
|
36
|
+
|
37
|
+
# Statistics about the campaign on the basis of various browsers
|
38
|
+
attr_accessor :stats_by_browser
|
35
39
|
|
36
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
37
41
|
def self.attribute_map
|
@@ -41,7 +45,9 @@ module SibApiV3Sdk
|
|
41
45
|
:'mirror_click' => :'mirrorClick',
|
42
46
|
:'remaining' => :'remaining',
|
43
47
|
:'links_stats' => :'linksStats',
|
44
|
-
:'stats_by_domain' => :'statsByDomain'
|
48
|
+
:'stats_by_domain' => :'statsByDomain',
|
49
|
+
:'stats_by_device' => :'statsByDevice',
|
50
|
+
:'stats_by_browser' => :'statsByBrowser'
|
45
51
|
}
|
46
52
|
end
|
47
53
|
|
@@ -53,7 +59,9 @@ module SibApiV3Sdk
|
|
53
59
|
:'mirror_click' => :'Integer',
|
54
60
|
:'remaining' => :'Integer',
|
55
61
|
:'links_stats' => :'Object',
|
56
|
-
:'stats_by_domain' => :'GetStatsByDomain'
|
62
|
+
:'stats_by_domain' => :'GetStatsByDomain',
|
63
|
+
:'stats_by_device' => :'GetStatsByDevice',
|
64
|
+
:'stats_by_browser' => :'GetStatsByBrowser'
|
57
65
|
}
|
58
66
|
end
|
59
67
|
|
@@ -63,7 +71,7 @@ module SibApiV3Sdk
|
|
63
71
|
return unless attributes.is_a?(Hash)
|
64
72
|
|
65
73
|
# convert string to symbol for hash key
|
66
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
74
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
67
75
|
|
68
76
|
if attributes.has_key?(:'globalStats')
|
69
77
|
self.global_stats = attributes[:'globalStats']
|
@@ -91,6 +99,13 @@ module SibApiV3Sdk
|
|
91
99
|
self.stats_by_domain = attributes[:'statsByDomain']
|
92
100
|
end
|
93
101
|
|
102
|
+
if attributes.has_key?(:'statsByDevice')
|
103
|
+
self.stats_by_device = attributes[:'statsByDevice']
|
104
|
+
end
|
105
|
+
|
106
|
+
if attributes.has_key?(:'statsByBrowser')
|
107
|
+
self.stats_by_browser = attributes[:'statsByBrowser']
|
108
|
+
end
|
94
109
|
end
|
95
110
|
|
96
111
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -98,30 +113,38 @@ module SibApiV3Sdk
|
|
98
113
|
def list_invalid_properties
|
99
114
|
invalid_properties = Array.new
|
100
115
|
if @global_stats.nil?
|
101
|
-
invalid_properties.push(
|
116
|
+
invalid_properties.push('invalid value for "global_stats", global_stats cannot be nil.')
|
102
117
|
end
|
103
118
|
|
104
119
|
if @campaign_stats.nil?
|
105
|
-
invalid_properties.push(
|
120
|
+
invalid_properties.push('invalid value for "campaign_stats", campaign_stats cannot be nil.')
|
106
121
|
end
|
107
122
|
|
108
123
|
if @mirror_click.nil?
|
109
|
-
invalid_properties.push(
|
124
|
+
invalid_properties.push('invalid value for "mirror_click", mirror_click cannot be nil.')
|
110
125
|
end
|
111
126
|
|
112
127
|
if @remaining.nil?
|
113
|
-
invalid_properties.push(
|
128
|
+
invalid_properties.push('invalid value for "remaining", remaining cannot be nil.')
|
114
129
|
end
|
115
130
|
|
116
131
|
if @links_stats.nil?
|
117
|
-
invalid_properties.push(
|
132
|
+
invalid_properties.push('invalid value for "links_stats", links_stats cannot be nil.')
|
118
133
|
end
|
119
134
|
|
120
135
|
if @stats_by_domain.nil?
|
121
|
-
invalid_properties.push(
|
136
|
+
invalid_properties.push('invalid value for "stats_by_domain", stats_by_domain cannot be nil.')
|
122
137
|
end
|
123
138
|
|
124
|
-
|
139
|
+
if @stats_by_device.nil?
|
140
|
+
invalid_properties.push('invalid value for "stats_by_device", stats_by_device cannot be nil.')
|
141
|
+
end
|
142
|
+
|
143
|
+
if @stats_by_browser.nil?
|
144
|
+
invalid_properties.push('invalid value for "stats_by_browser", stats_by_browser cannot be nil.')
|
145
|
+
end
|
146
|
+
|
147
|
+
invalid_properties
|
125
148
|
end
|
126
149
|
|
127
150
|
# Check to see if the all the properties in the model are valid
|
@@ -133,7 +156,9 @@ module SibApiV3Sdk
|
|
133
156
|
return false if @remaining.nil?
|
134
157
|
return false if @links_stats.nil?
|
135
158
|
return false if @stats_by_domain.nil?
|
136
|
-
return
|
159
|
+
return false if @stats_by_device.nil?
|
160
|
+
return false if @stats_by_browser.nil?
|
161
|
+
true
|
137
162
|
end
|
138
163
|
|
139
164
|
# Checks equality by comparing each attribute.
|
@@ -146,7 +171,9 @@ module SibApiV3Sdk
|
|
146
171
|
mirror_click == o.mirror_click &&
|
147
172
|
remaining == o.remaining &&
|
148
173
|
links_stats == o.links_stats &&
|
149
|
-
stats_by_domain == o.stats_by_domain
|
174
|
+
stats_by_domain == o.stats_by_domain &&
|
175
|
+
stats_by_device == o.stats_by_device &&
|
176
|
+
stats_by_browser == o.stats_by_browser
|
150
177
|
end
|
151
178
|
|
152
179
|
# @see the `==` method
|
@@ -158,7 +185,7 @@ module SibApiV3Sdk
|
|
158
185
|
# Calculates hash code according to all attributes.
|
159
186
|
# @return [Fixnum] Hash code
|
160
187
|
def hash
|
161
|
-
[global_stats, campaign_stats, mirror_click, remaining, links_stats, stats_by_domain].hash
|
188
|
+
[global_stats, campaign_stats, mirror_click, remaining, links_stats, stats_by_domain, stats_by_device, stats_by_browser].hash
|
162
189
|
end
|
163
190
|
|
164
191
|
# Builds the object from hash
|
@@ -171,7 +198,7 @@ module SibApiV3Sdk
|
|
171
198
|
# check to ensure the input is an array given that the the attribute
|
172
199
|
# is documented as an array but the input is not
|
173
200
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
174
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
201
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
175
202
|
end
|
176
203
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
177
204
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -253,7 +280,7 @@ module SibApiV3Sdk
|
|
253
280
|
# @return [Hash] Returns the value in the form of hash
|
254
281
|
def _to_hash(value)
|
255
282
|
if value.is_a?(Array)
|
256
|
-
value.compact.map{ |v| _to_hash(v) }
|
283
|
+
value.compact.map { |v| _to_hash(v) }
|
257
284
|
elsif value.is_a?(Hash)
|
258
285
|
{}.tap do |hash|
|
259
286
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -264,7 +291,5 @@ module SibApiV3Sdk
|
|
264
291
|
value
|
265
292
|
end
|
266
293
|
end
|
267
|
-
|
268
294
|
end
|
269
|
-
|
270
295
|
end
|