sib-api-v3-sdk 5.2.5 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +100 -75
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +2 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +136 -73
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +4 -1
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
- data/docs/ListsApi.md +17 -17
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +3 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +158 -91
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SendEmail.md +3 -3
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +2 -2
- data/docs/SendersApi.md +8 -8
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +4 -1
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UpdateWebhook.md +1 -1
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +20 -3
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +62 -73
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +17 -26
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +53 -54
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +9 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +20 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +4 -5
- data/spec/models/get_transac_email_content_spec.rb +9 -10
- data/spec/models/get_transac_emails_list_spec.rb +3 -4
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +10 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +4 -33
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +10 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +11 -6
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +78 -10
@@ -1,24 +1,23 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateAttribute
|
18
17
|
# Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
|
19
18
|
attr_accessor :value
|
20
19
|
|
21
|
-
# List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{
|
20
|
+
# List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
|
22
21
|
attr_accessor :enumeration
|
23
22
|
|
24
23
|
# Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
|
@@ -70,7 +69,7 @@ module SibApiV3Sdk
|
|
70
69
|
return unless attributes.is_a?(Hash)
|
71
70
|
|
72
71
|
# convert string to symbol for hash key
|
73
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
72
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
74
73
|
|
75
74
|
if attributes.has_key?(:'value')
|
76
75
|
self.value = attributes[:'value']
|
@@ -85,30 +84,29 @@ module SibApiV3Sdk
|
|
85
84
|
if attributes.has_key?(:'type')
|
86
85
|
self.type = attributes[:'type']
|
87
86
|
end
|
88
|
-
|
89
87
|
end
|
90
88
|
|
91
89
|
# Show invalid properties with the reasons. Usually used together with valid?
|
92
90
|
# @return Array for valid properties with the reasons
|
93
91
|
def list_invalid_properties
|
94
92
|
invalid_properties = Array.new
|
95
|
-
|
93
|
+
invalid_properties
|
96
94
|
end
|
97
95
|
|
98
96
|
# Check to see if the all the properties in the model are valid
|
99
97
|
# @return true if the model is valid
|
100
98
|
def valid?
|
101
|
-
type_validator = EnumAttributeValidator.new('String', [
|
99
|
+
type_validator = EnumAttributeValidator.new('String', ['text', 'date', 'float', 'boolean', 'id', 'category'])
|
102
100
|
return false unless type_validator.valid?(@type)
|
103
|
-
|
101
|
+
true
|
104
102
|
end
|
105
103
|
|
106
104
|
# Custom attribute writer method checking allowed values (enum).
|
107
105
|
# @param [Object] type Object to be assigned
|
108
106
|
def type=(type)
|
109
|
-
validator = EnumAttributeValidator.new('String', [
|
107
|
+
validator = EnumAttributeValidator.new('String', ['text', 'date', 'float', 'boolean', 'id', 'category'])
|
110
108
|
unless validator.valid?(type)
|
111
|
-
fail ArgumentError,
|
109
|
+
fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
|
112
110
|
end
|
113
111
|
@type = type
|
114
112
|
end
|
@@ -145,7 +143,7 @@ module SibApiV3Sdk
|
|
145
143
|
# check to ensure the input is an array given that the the attribute
|
146
144
|
# is documented as an array but the input is not
|
147
145
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
148
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
146
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
149
147
|
end
|
150
148
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
151
149
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -227,7 +225,7 @@ module SibApiV3Sdk
|
|
227
225
|
# @return [Hash] Returns the value in the form of hash
|
228
226
|
def _to_hash(value)
|
229
227
|
if value.is_a?(Array)
|
230
|
-
value.compact.map{ |v| _to_hash(v) }
|
228
|
+
value.compact.map { |v| _to_hash(v) }
|
231
229
|
elsif value.is_a?(Hash)
|
232
230
|
{}.tap do |hash|
|
233
231
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -238,7 +236,5 @@ module SibApiV3Sdk
|
|
238
236
|
value
|
239
237
|
end
|
240
238
|
end
|
241
|
-
|
242
239
|
end
|
243
|
-
|
244
240
|
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 CreateAttributeEnumeration
|
18
17
|
# Id of the value
|
19
18
|
attr_accessor :value
|
@@ -21,7 +20,6 @@ module SibApiV3Sdk
|
|
21
20
|
# Label of the value
|
22
21
|
attr_accessor :label
|
23
22
|
|
24
|
-
|
25
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
24
|
def self.attribute_map
|
27
25
|
{
|
@@ -44,7 +42,7 @@ module SibApiV3Sdk
|
|
44
42
|
return unless attributes.is_a?(Hash)
|
45
43
|
|
46
44
|
# convert string to symbol for hash key
|
47
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
45
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
48
46
|
|
49
47
|
if attributes.has_key?(:'value')
|
50
48
|
self.value = attributes[:'value']
|
@@ -53,7 +51,6 @@ module SibApiV3Sdk
|
|
53
51
|
if attributes.has_key?(:'label')
|
54
52
|
self.label = attributes[:'label']
|
55
53
|
end
|
56
|
-
|
57
54
|
end
|
58
55
|
|
59
56
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -61,14 +58,14 @@ module SibApiV3Sdk
|
|
61
58
|
def list_invalid_properties
|
62
59
|
invalid_properties = Array.new
|
63
60
|
if @value.nil?
|
64
|
-
invalid_properties.push(
|
61
|
+
invalid_properties.push('invalid value for "value", value cannot be nil.')
|
65
62
|
end
|
66
63
|
|
67
64
|
if @label.nil?
|
68
|
-
invalid_properties.push(
|
65
|
+
invalid_properties.push('invalid value for "label", label cannot be nil.')
|
69
66
|
end
|
70
67
|
|
71
|
-
|
68
|
+
invalid_properties
|
72
69
|
end
|
73
70
|
|
74
71
|
# Check to see if the all the properties in the model are valid
|
@@ -76,7 +73,7 @@ module SibApiV3Sdk
|
|
76
73
|
def valid?
|
77
74
|
return false if @value.nil?
|
78
75
|
return false if @label.nil?
|
79
|
-
|
76
|
+
true
|
80
77
|
end
|
81
78
|
|
82
79
|
# 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,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 CreateChild
|
18
17
|
# Email address to create the child account
|
19
18
|
attr_accessor :email
|
@@ -30,6 +29,30 @@ module SibApiV3Sdk
|
|
30
29
|
# Password for the child account to login
|
31
30
|
attr_accessor :password
|
32
31
|
|
32
|
+
# Language of the child account
|
33
|
+
attr_accessor :language
|
34
|
+
|
35
|
+
class EnumAttributeValidator
|
36
|
+
attr_reader :datatype
|
37
|
+
attr_reader :allowable_values
|
38
|
+
|
39
|
+
def initialize(datatype, allowable_values)
|
40
|
+
@allowable_values = allowable_values.map do |value|
|
41
|
+
case datatype.to_s
|
42
|
+
when /Integer/i
|
43
|
+
value.to_i
|
44
|
+
when /Float/i
|
45
|
+
value.to_f
|
46
|
+
else
|
47
|
+
value
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def valid?(value)
|
53
|
+
!value || allowable_values.include?(value)
|
54
|
+
end
|
55
|
+
end
|
33
56
|
|
34
57
|
# Attribute mapping from ruby-style variable name to JSON key.
|
35
58
|
def self.attribute_map
|
@@ -38,7 +61,8 @@ module SibApiV3Sdk
|
|
38
61
|
:'first_name' => :'firstName',
|
39
62
|
:'last_name' => :'lastName',
|
40
63
|
:'company_name' => :'companyName',
|
41
|
-
:'password' => :'password'
|
64
|
+
:'password' => :'password',
|
65
|
+
:'language' => :'language'
|
42
66
|
}
|
43
67
|
end
|
44
68
|
|
@@ -49,7 +73,8 @@ module SibApiV3Sdk
|
|
49
73
|
:'first_name' => :'String',
|
50
74
|
:'last_name' => :'String',
|
51
75
|
:'company_name' => :'String',
|
52
|
-
:'password' => :'String'
|
76
|
+
:'password' => :'String',
|
77
|
+
:'language' => :'String'
|
53
78
|
}
|
54
79
|
end
|
55
80
|
|
@@ -59,7 +84,7 @@ module SibApiV3Sdk
|
|
59
84
|
return unless attributes.is_a?(Hash)
|
60
85
|
|
61
86
|
# convert string to symbol for hash key
|
62
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
87
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
63
88
|
|
64
89
|
if attributes.has_key?(:'email')
|
65
90
|
self.email = attributes[:'email']
|
@@ -81,6 +106,9 @@ module SibApiV3Sdk
|
|
81
106
|
self.password = attributes[:'password']
|
82
107
|
end
|
83
108
|
|
109
|
+
if attributes.has_key?(:'language')
|
110
|
+
self.language = attributes[:'language']
|
111
|
+
end
|
84
112
|
end
|
85
113
|
|
86
114
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -88,26 +116,26 @@ module SibApiV3Sdk
|
|
88
116
|
def list_invalid_properties
|
89
117
|
invalid_properties = Array.new
|
90
118
|
if @email.nil?
|
91
|
-
invalid_properties.push(
|
119
|
+
invalid_properties.push('invalid value for "email", email cannot be nil.')
|
92
120
|
end
|
93
121
|
|
94
122
|
if @first_name.nil?
|
95
|
-
invalid_properties.push(
|
123
|
+
invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
|
96
124
|
end
|
97
125
|
|
98
126
|
if @last_name.nil?
|
99
|
-
invalid_properties.push(
|
127
|
+
invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
|
100
128
|
end
|
101
129
|
|
102
130
|
if @company_name.nil?
|
103
|
-
invalid_properties.push(
|
131
|
+
invalid_properties.push('invalid value for "company_name", company_name cannot be nil.')
|
104
132
|
end
|
105
133
|
|
106
134
|
if @password.nil?
|
107
|
-
invalid_properties.push(
|
135
|
+
invalid_properties.push('invalid value for "password", password cannot be nil.')
|
108
136
|
end
|
109
137
|
|
110
|
-
|
138
|
+
invalid_properties
|
111
139
|
end
|
112
140
|
|
113
141
|
# Check to see if the all the properties in the model are valid
|
@@ -118,7 +146,19 @@ module SibApiV3Sdk
|
|
118
146
|
return false if @last_name.nil?
|
119
147
|
return false if @company_name.nil?
|
120
148
|
return false if @password.nil?
|
121
|
-
|
149
|
+
language_validator = EnumAttributeValidator.new('String', ['fr', 'es', 'pt', 'it', 'de', 'en'])
|
150
|
+
return false unless language_validator.valid?(@language)
|
151
|
+
true
|
152
|
+
end
|
153
|
+
|
154
|
+
# Custom attribute writer method checking allowed values (enum).
|
155
|
+
# @param [Object] language Object to be assigned
|
156
|
+
def language=(language)
|
157
|
+
validator = EnumAttributeValidator.new('String', ['fr', 'es', 'pt', 'it', 'de', 'en'])
|
158
|
+
unless validator.valid?(language)
|
159
|
+
fail ArgumentError, 'invalid value for "language", must be one of #{validator.allowable_values}.'
|
160
|
+
end
|
161
|
+
@language = language
|
122
162
|
end
|
123
163
|
|
124
164
|
# Checks equality by comparing each attribute.
|
@@ -130,7 +170,8 @@ module SibApiV3Sdk
|
|
130
170
|
first_name == o.first_name &&
|
131
171
|
last_name == o.last_name &&
|
132
172
|
company_name == o.company_name &&
|
133
|
-
password == o.password
|
173
|
+
password == o.password &&
|
174
|
+
language == o.language
|
134
175
|
end
|
135
176
|
|
136
177
|
# @see the `==` method
|
@@ -142,7 +183,7 @@ module SibApiV3Sdk
|
|
142
183
|
# Calculates hash code according to all attributes.
|
143
184
|
# @return [Fixnum] Hash code
|
144
185
|
def hash
|
145
|
-
[email, first_name, last_name, company_name, password].hash
|
186
|
+
[email, first_name, last_name, company_name, password, language].hash
|
146
187
|
end
|
147
188
|
|
148
189
|
# Builds the object from hash
|
@@ -155,7 +196,7 @@ module SibApiV3Sdk
|
|
155
196
|
# check to ensure the input is an array given that the the attribute
|
156
197
|
# is documented as an array but the input is not
|
157
198
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
158
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
199
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
159
200
|
end
|
160
201
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
161
202
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -237,7 +278,7 @@ module SibApiV3Sdk
|
|
237
278
|
# @return [Hash] Returns the value in the form of hash
|
238
279
|
def _to_hash(value)
|
239
280
|
if value.is_a?(Array)
|
240
|
-
value.compact.map{ |v| _to_hash(v) }
|
281
|
+
value.compact.map { |v| _to_hash(v) }
|
241
282
|
elsif value.is_a?(Hash)
|
242
283
|
{}.tap do |hash|
|
243
284
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -248,7 +289,5 @@ module SibApiV3Sdk
|
|
248
289
|
value
|
249
290
|
end
|
250
291
|
end
|
251
|
-
|
252
292
|
end
|
253
|
-
|
254
293
|
end
|
@@ -1,24 +1,23 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
17
16
|
class CreateContact
|
18
|
-
# Email address of the user. Mandatory if \"
|
17
|
+
# Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
|
19
18
|
attr_accessor :email
|
20
19
|
|
21
|
-
# Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {
|
20
|
+
# Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
|
22
21
|
attr_accessor :attributes
|
23
22
|
|
24
23
|
# Set this field to blacklist the contact for emails (emailBlacklisted = true)
|
@@ -36,7 +35,6 @@ module SibApiV3Sdk
|
|
36
35
|
# transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
|
37
36
|
attr_accessor :smtp_blacklist_sender
|
38
37
|
|
39
|
-
|
40
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
41
39
|
def self.attribute_map
|
42
40
|
{
|
@@ -69,7 +67,7 @@ module SibApiV3Sdk
|
|
69
67
|
return unless attributes.is_a?(Hash)
|
70
68
|
|
71
69
|
# convert string to symbol for hash key
|
72
|
-
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
70
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
73
71
|
|
74
72
|
if attributes.has_key?(:'email')
|
75
73
|
self.email = attributes[:'email']
|
@@ -104,20 +102,19 @@ module SibApiV3Sdk
|
|
104
102
|
self.smtp_blacklist_sender = value
|
105
103
|
end
|
106
104
|
end
|
107
|
-
|
108
105
|
end
|
109
106
|
|
110
107
|
# Show invalid properties with the reasons. Usually used together with valid?
|
111
108
|
# @return Array for valid properties with the reasons
|
112
109
|
def list_invalid_properties
|
113
110
|
invalid_properties = Array.new
|
114
|
-
|
111
|
+
invalid_properties
|
115
112
|
end
|
116
113
|
|
117
114
|
# Check to see if the all the properties in the model are valid
|
118
115
|
# @return true if the model is valid
|
119
116
|
def valid?
|
120
|
-
|
117
|
+
true
|
121
118
|
end
|
122
119
|
|
123
120
|
# Checks equality by comparing each attribute.
|
@@ -156,7 +153,7 @@ module SibApiV3Sdk
|
|
156
153
|
# check to ensure the input is an array given that the the attribute
|
157
154
|
# is documented as an array but the input is not
|
158
155
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
159
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) }
|
156
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
160
157
|
end
|
161
158
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
162
159
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -238,7 +235,7 @@ module SibApiV3Sdk
|
|
238
235
|
# @return [Hash] Returns the value in the form of hash
|
239
236
|
def _to_hash(value)
|
240
237
|
if value.is_a?(Array)
|
241
|
-
value.compact.map{ |v| _to_hash(v) }
|
238
|
+
value.compact.map { |v| _to_hash(v) }
|
242
239
|
elsif value.is_a?(Hash)
|
243
240
|
{}.tap do |hash|
|
244
241
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -249,7 +246,5 @@ module SibApiV3Sdk
|
|
249
246
|
value
|
250
247
|
end
|
251
248
|
end
|
252
|
-
|
253
249
|
end
|
254
|
-
|
255
250
|
end
|