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
data/spec/api/smtp_api_spec.rb
CHANGED
@@ -1,12 +1,12 @@
|
|
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
|
|
@@ -33,13 +33,12 @@ describe 'SMTPApi' do
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# unit tests for create_smtp_template
|
36
|
-
# Create an
|
37
|
-
#
|
38
|
-
# @param smtp_template values to update in smtp template
|
36
|
+
# Create an email template
|
37
|
+
# @param smtp_template values to update in transactional email template
|
39
38
|
# @param [Hash] opts the optional parameters
|
40
39
|
# @return [CreateModel]
|
41
40
|
describe 'create_smtp_template test' do
|
42
|
-
it
|
41
|
+
it 'should work' do
|
43
42
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
43
|
end
|
45
44
|
end
|
@@ -51,26 +50,24 @@ describe 'SMTPApi' do
|
|
51
50
|
# @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
|
52
51
|
# @return [nil]
|
53
52
|
describe 'delete_hardbounces test' do
|
54
|
-
it
|
53
|
+
it 'should work' do
|
55
54
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
55
|
end
|
57
56
|
end
|
58
57
|
|
59
58
|
# unit tests for delete_smtp_template
|
60
|
-
# Delete an inactive
|
61
|
-
#
|
59
|
+
# Delete an inactive email template
|
62
60
|
# @param template_id id of the template
|
63
61
|
# @param [Hash] opts the optional parameters
|
64
62
|
# @return [nil]
|
65
63
|
describe 'delete_smtp_template test' do
|
66
|
-
it
|
64
|
+
it 'should work' do
|
67
65
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
66
|
end
|
69
67
|
end
|
70
68
|
|
71
69
|
# unit tests for get_aggregated_smtp_report
|
72
|
-
# Get your
|
73
|
-
#
|
70
|
+
# Get your transactional email activity aggregated over a period of time
|
74
71
|
# @param [Hash] opts the optional parameters
|
75
72
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
76
73
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
@@ -78,14 +75,13 @@ describe 'SMTPApi' do
|
|
78
75
|
# @option opts [String] :tag Tag of the emails
|
79
76
|
# @return [GetAggregatedReport]
|
80
77
|
describe 'get_aggregated_smtp_report test' do
|
81
|
-
it
|
78
|
+
it 'should work' do
|
82
79
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
83
80
|
end
|
84
81
|
end
|
85
82
|
|
86
83
|
# unit tests for get_email_event_report
|
87
|
-
# Get all your
|
88
|
-
#
|
84
|
+
# Get all your transactional email activity (unaggregated events)
|
89
85
|
# @param [Hash] opts the optional parameters
|
90
86
|
# @option opts [Integer] :limit Number limitation for the result returned
|
91
87
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
@@ -99,14 +95,13 @@ describe 'SMTPApi' do
|
|
99
95
|
# @option opts [Integer] :template_id Filter on a specific template id
|
100
96
|
# @return [GetEmailEventReport]
|
101
97
|
describe 'get_email_event_report test' do
|
102
|
-
it
|
98
|
+
it 'should work' do
|
103
99
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
104
100
|
end
|
105
101
|
end
|
106
102
|
|
107
103
|
# unit tests for get_smtp_report
|
108
|
-
# Get your
|
109
|
-
#
|
104
|
+
# Get your transactional email activity aggregated per day
|
110
105
|
# @param [Hash] opts the optional parameters
|
111
106
|
# @option opts [Integer] :limit Number of documents returned per page
|
112
107
|
# @option opts [Integer] :offset Index of the first document on the page
|
@@ -116,33 +111,73 @@ describe 'SMTPApi' do
|
|
116
111
|
# @option opts [String] :tag Tag of the emails
|
117
112
|
# @return [GetReports]
|
118
113
|
describe 'get_smtp_report test' do
|
119
|
-
it
|
114
|
+
it 'should work' do
|
120
115
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
121
116
|
end
|
122
117
|
end
|
123
118
|
|
124
119
|
# unit tests for get_smtp_template
|
125
|
-
# Returns the template
|
126
|
-
#
|
120
|
+
# Returns the template information
|
127
121
|
# @param template_id id of the template
|
128
122
|
# @param [Hash] opts the optional parameters
|
129
123
|
# @return [GetSmtpTemplateOverview]
|
130
124
|
describe 'get_smtp_template test' do
|
131
|
-
it
|
125
|
+
it 'should work' do
|
132
126
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
133
127
|
end
|
134
128
|
end
|
135
129
|
|
136
130
|
# unit tests for get_smtp_templates
|
137
|
-
# Get the list of
|
138
|
-
#
|
131
|
+
# Get the list of email templates
|
139
132
|
# @param [Hash] opts the optional parameters
|
140
133
|
# @option opts [BOOLEAN] :template_status Filter on the status of the template. Active = true, inactive = false
|
141
134
|
# @option opts [Integer] :limit Number of documents returned per page
|
142
135
|
# @option opts [Integer] :offset Index of the first document in the page
|
143
136
|
# @return [GetSmtpTemplates]
|
144
137
|
describe 'get_smtp_templates test' do
|
145
|
-
it
|
138
|
+
it 'should work' do
|
139
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# unit tests for get_transac_blocked_contacts
|
144
|
+
# Get the list of blocked or unsubscribed transactional contacts
|
145
|
+
# @param [Hash] opts the optional parameters
|
146
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
147
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
148
|
+
# @option opts [Integer] :limit Number of documents returned per page
|
149
|
+
# @option opts [Integer] :offset Index of the first document on the page
|
150
|
+
# @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
151
|
+
# @return [GetTransacBlockedContacts]
|
152
|
+
describe 'get_transac_blocked_contacts test' do
|
153
|
+
it 'should work' do
|
154
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# unit tests for get_transac_email_content
|
159
|
+
# Get the personalized content of a sent transactional email
|
160
|
+
# @param uuid Unique id of the transactional email that has been sent to a particular contact
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [GetTransacEmailContent]
|
163
|
+
describe 'get_transac_email_content test' do
|
164
|
+
it 'should work' do
|
165
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
166
|
+
end
|
167
|
+
end
|
168
|
+
|
169
|
+
# unit tests for get_transac_emails_list
|
170
|
+
# Get the list of transactional emails on the basis of allowed filters
|
171
|
+
# This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
172
|
+
# @param [Hash] opts the optional parameters
|
173
|
+
# @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
174
|
+
# @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
175
|
+
# @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
176
|
+
# @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
177
|
+
# @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
178
|
+
# @return [GetTransacEmailsList]
|
179
|
+
describe 'get_transac_emails_list test' do
|
180
|
+
it 'should work' do
|
146
181
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
147
182
|
end
|
148
183
|
end
|
@@ -155,45 +190,64 @@ describe 'SMTPApi' do
|
|
155
190
|
# @param [Hash] opts the optional parameters
|
156
191
|
# @return [SendTemplateEmail]
|
157
192
|
describe 'send_template test' do
|
158
|
-
it
|
193
|
+
it 'should work' do
|
159
194
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
160
195
|
end
|
161
196
|
end
|
162
197
|
|
163
198
|
# unit tests for send_test_template
|
164
199
|
# Send a template to your test list
|
165
|
-
#
|
166
200
|
# @param template_id Id of the template
|
167
201
|
# @param send_test_email
|
168
202
|
# @param [Hash] opts the optional parameters
|
169
203
|
# @return [nil]
|
170
204
|
describe 'send_test_template test' do
|
171
|
-
it
|
205
|
+
it 'should work' do
|
172
206
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
173
207
|
end
|
174
208
|
end
|
175
209
|
|
176
210
|
# unit tests for send_transac_email
|
177
211
|
# Send a transactional email
|
178
|
-
#
|
179
212
|
# @param send_smtp_email Values to send a transactional email
|
180
213
|
# @param [Hash] opts the optional parameters
|
181
214
|
# @return [CreateSmtpEmail]
|
182
215
|
describe 'send_transac_email test' do
|
183
|
-
it
|
216
|
+
it 'should work' do
|
217
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
218
|
+
end
|
219
|
+
end
|
220
|
+
|
221
|
+
# unit tests for smtp_blocked_contacts_email_delete
|
222
|
+
# Unblock or resubscribe a transactional contact
|
223
|
+
# @param email contact email (urlencoded) to unblock.
|
224
|
+
# @param [Hash] opts the optional parameters
|
225
|
+
# @return [nil]
|
226
|
+
describe 'smtp_blocked_contacts_email_delete test' do
|
227
|
+
it 'should work' do
|
228
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
229
|
+
end
|
230
|
+
end
|
231
|
+
|
232
|
+
# unit tests for smtp_log_message_id_delete
|
233
|
+
# Delete an SMTP transactional log
|
234
|
+
# @param message_id MessageId of the transactional log to delete
|
235
|
+
# @param [Hash] opts the optional parameters
|
236
|
+
# @return [nil]
|
237
|
+
describe 'smtp_log_message_id_delete test' do
|
238
|
+
it 'should work' do
|
184
239
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
185
240
|
end
|
186
241
|
end
|
187
242
|
|
188
243
|
# unit tests for update_smtp_template
|
189
|
-
#
|
190
|
-
#
|
244
|
+
# Update an email template
|
191
245
|
# @param template_id id of the template
|
192
|
-
# @param smtp_template values to update in
|
246
|
+
# @param smtp_template values to update in transactional email template
|
193
247
|
# @param [Hash] opts the optional parameters
|
194
248
|
# @return [nil]
|
195
249
|
describe 'update_smtp_template test' do
|
196
|
-
it
|
250
|
+
it 'should work' do
|
197
251
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
198
252
|
end
|
199
253
|
end
|
@@ -1,12 +1,12 @@
|
|
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
|
|
@@ -33,8 +33,7 @@ describe 'TransactionalSMSApi' do
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# unit tests for get_sms_events
|
36
|
-
# Get all
|
37
|
-
#
|
36
|
+
# Get all your SMS activity (unaggregated events)
|
38
37
|
# @param [Hash] opts the optional parameters
|
39
38
|
# @option opts [Integer] :limit Number of documents per page
|
40
39
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
@@ -46,14 +45,13 @@ describe 'TransactionalSMSApi' do
|
|
46
45
|
# @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
|
47
46
|
# @return [GetSmsEventReport]
|
48
47
|
describe 'get_sms_events test' do
|
49
|
-
it
|
48
|
+
it 'should work' do
|
50
49
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
51
50
|
end
|
52
51
|
end
|
53
52
|
|
54
53
|
# unit tests for get_transac_aggregated_sms_report
|
55
54
|
# Get your SMS activity aggregated over a period of time
|
56
|
-
#
|
57
55
|
# @param [Hash] opts the optional parameters
|
58
56
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
59
57
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
@@ -61,14 +59,13 @@ describe 'TransactionalSMSApi' do
|
|
61
59
|
# @option opts [String] :tag Filter on a tag
|
62
60
|
# @return [GetTransacAggregatedSmsReport]
|
63
61
|
describe 'get_transac_aggregated_sms_report test' do
|
64
|
-
it
|
62
|
+
it 'should work' do
|
65
63
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
66
64
|
end
|
67
65
|
end
|
68
66
|
|
69
67
|
# unit tests for get_transac_sms_report
|
70
68
|
# Get your SMS activity aggregated per day
|
71
|
-
#
|
72
69
|
# @param [Hash] opts the optional parameters
|
73
70
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
74
71
|
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
@@ -76,19 +73,18 @@ describe 'TransactionalSMSApi' do
|
|
76
73
|
# @option opts [String] :tag Filter on a tag
|
77
74
|
# @return [GetTransacSmsReport]
|
78
75
|
describe 'get_transac_sms_report test' do
|
79
|
-
it
|
76
|
+
it 'should work' do
|
80
77
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
81
78
|
end
|
82
79
|
end
|
83
80
|
|
84
81
|
# unit tests for send_transac_sms
|
85
|
-
# Send
|
86
|
-
#
|
82
|
+
# Send SMS message to a mobile number
|
87
83
|
# @param send_transac_sms Values to send a transactional SMS
|
88
84
|
# @param [Hash] opts the optional parameters
|
89
85
|
# @return [SendSms]
|
90
86
|
describe 'send_transac_sms test' do
|
91
|
-
it
|
87
|
+
it 'should work' do
|
92
88
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
93
89
|
end
|
94
90
|
end
|
@@ -1,12 +1,12 @@
|
|
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
|
|
@@ -34,61 +34,56 @@ describe 'WebhooksApi' do
|
|
34
34
|
|
35
35
|
# unit tests for create_webhook
|
36
36
|
# Create a webhook
|
37
|
-
#
|
38
37
|
# @param create_webhook Values to create a webhook
|
39
38
|
# @param [Hash] opts the optional parameters
|
40
39
|
# @return [CreateModel]
|
41
40
|
describe 'create_webhook test' do
|
42
|
-
it
|
41
|
+
it 'should work' do
|
43
42
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
43
|
end
|
45
44
|
end
|
46
45
|
|
47
46
|
# unit tests for delete_webhook
|
48
47
|
# Delete a webhook
|
49
|
-
#
|
50
48
|
# @param webhook_id Id of the webhook
|
51
49
|
# @param [Hash] opts the optional parameters
|
52
50
|
# @return [nil]
|
53
51
|
describe 'delete_webhook test' do
|
54
|
-
it
|
52
|
+
it 'should work' do
|
55
53
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
54
|
end
|
57
55
|
end
|
58
56
|
|
59
57
|
# unit tests for get_webhook
|
60
58
|
# Get a webhook details
|
61
|
-
#
|
62
59
|
# @param webhook_id Id of the webhook
|
63
60
|
# @param [Hash] opts the optional parameters
|
64
61
|
# @return [GetWebhook]
|
65
62
|
describe 'get_webhook test' do
|
66
|
-
it
|
63
|
+
it 'should work' do
|
67
64
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
65
|
end
|
69
66
|
end
|
70
67
|
|
71
68
|
# unit tests for get_webhooks
|
72
69
|
# Get all webhooks
|
73
|
-
#
|
74
70
|
# @param [Hash] opts the optional parameters
|
75
71
|
# @option opts [String] :type Filter on webhook type
|
76
72
|
# @return [GetWebhooks]
|
77
73
|
describe 'get_webhooks test' do
|
78
|
-
it
|
74
|
+
it 'should work' do
|
79
75
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
80
76
|
end
|
81
77
|
end
|
82
78
|
|
83
79
|
# unit tests for update_webhook
|
84
80
|
# Update a webhook
|
85
|
-
#
|
86
81
|
# @param webhook_id Id of the webhook
|
87
82
|
# @param update_webhook Values to update a webhook
|
88
83
|
# @param [Hash] opts the optional parameters
|
89
84
|
# @return [nil]
|
90
85
|
describe 'update_webhook test' do
|
91
|
-
it
|
86
|
+
it 'should work' do
|
92
87
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
93
88
|
end
|
94
89
|
end
|
data/spec/api_client_spec.rb
CHANGED
@@ -1,12 +1,12 @@
|
|
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
|
|
@@ -51,11 +51,11 @@ describe SibApiV3Sdk::ApiClient do
|
|
51
51
|
end
|
52
52
|
end
|
53
53
|
|
54
|
-
describe
|
54
|
+
describe 'params_encoding in #build_request' do
|
55
55
|
let(:config) { SibApiV3Sdk::Configuration.new }
|
56
56
|
let(:api_client) { SibApiV3Sdk::ApiClient.new(config) }
|
57
57
|
|
58
|
-
it
|
58
|
+
it 'defaults to nil' do
|
59
59
|
expect(SibApiV3Sdk::Configuration.default.params_encoding).to eq(nil)
|
60
60
|
expect(config.params_encoding).to eq(nil)
|
61
61
|
|
@@ -63,18 +63,18 @@ describe SibApiV3Sdk::ApiClient do
|
|
63
63
|
expect(request.options[:params_encoding]).to eq(nil)
|
64
64
|
end
|
65
65
|
|
66
|
-
it
|
66
|
+
it 'can be customized' do
|
67
67
|
config.params_encoding = :multi
|
68
68
|
request = api_client.build_request(:get, '/test')
|
69
69
|
expect(request.options[:params_encoding]).to eq(:multi)
|
70
70
|
end
|
71
71
|
end
|
72
72
|
|
73
|
-
describe
|
73
|
+
describe 'timeout in #build_request' do
|
74
74
|
let(:config) { SibApiV3Sdk::Configuration.new }
|
75
75
|
let(:api_client) { SibApiV3Sdk::ApiClient.new(config) }
|
76
76
|
|
77
|
-
it
|
77
|
+
it 'defaults to 0' do
|
78
78
|
expect(SibApiV3Sdk::Configuration.default.timeout).to eq(0)
|
79
79
|
expect(config.timeout).to eq(0)
|
80
80
|
|
@@ -82,88 +82,88 @@ describe SibApiV3Sdk::ApiClient do
|
|
82
82
|
expect(request.options[:timeout]).to eq(0)
|
83
83
|
end
|
84
84
|
|
85
|
-
it
|
85
|
+
it 'can be customized' do
|
86
86
|
config.timeout = 100
|
87
87
|
request = api_client.build_request(:get, '/test')
|
88
88
|
expect(request.options[:timeout]).to eq(100)
|
89
89
|
end
|
90
90
|
end
|
91
91
|
|
92
|
-
describe
|
92
|
+
describe '#deserialize' do
|
93
93
|
it "handles Array<Integer>" do
|
94
94
|
api_client = SibApiV3Sdk::ApiClient.new
|
95
|
-
headers = {'Content-Type' => 'application/json'}
|
95
|
+
headers = { 'Content-Type' => 'application/json' }
|
96
96
|
response = double('response', headers: headers, body: '[12, 34]')
|
97
97
|
data = api_client.deserialize(response, 'Array<Integer>')
|
98
98
|
expect(data).to be_instance_of(Array)
|
99
99
|
expect(data).to eq([12, 34])
|
100
100
|
end
|
101
101
|
|
102
|
-
it
|
102
|
+
it 'handles Array<Array<Integer>>' do
|
103
103
|
api_client = SibApiV3Sdk::ApiClient.new
|
104
|
-
headers = {'Content-Type' => 'application/json'}
|
104
|
+
headers = { 'Content-Type' => 'application/json' }
|
105
105
|
response = double('response', headers: headers, body: '[[12, 34], [56]]')
|
106
106
|
data = api_client.deserialize(response, 'Array<Array<Integer>>')
|
107
107
|
expect(data).to be_instance_of(Array)
|
108
108
|
expect(data).to eq([[12, 34], [56]])
|
109
109
|
end
|
110
110
|
|
111
|
-
it
|
111
|
+
it 'handles Hash<String, String>' do
|
112
112
|
api_client = SibApiV3Sdk::ApiClient.new
|
113
|
-
headers = {'Content-Type' => 'application/json'}
|
113
|
+
headers = { 'Content-Type' => 'application/json' }
|
114
114
|
response = double('response', headers: headers, body: '{"message": "Hello"}')
|
115
115
|
data = api_client.deserialize(response, 'Hash<String, String>')
|
116
116
|
expect(data).to be_instance_of(Hash)
|
117
|
-
expect(data).to eq(
|
117
|
+
expect(data).to eq(:message => 'Hello')
|
118
118
|
end
|
119
119
|
end
|
120
120
|
|
121
121
|
describe "#object_to_hash" do
|
122
|
-
it
|
122
|
+
it 'ignores nils and includes empty arrays' do
|
123
123
|
# uncomment below to test object_to_hash for model
|
124
|
-
#api_client = SibApiV3Sdk::ApiClient.new
|
125
|
-
#_model = SibApiV3Sdk::ModelName.new
|
124
|
+
# api_client = SibApiV3Sdk::ApiClient.new
|
125
|
+
# _model = SibApiV3Sdk::ModelName.new
|
126
126
|
# update the model attribute below
|
127
|
-
#_model.id = 1
|
127
|
+
# _model.id = 1
|
128
128
|
# update the expected value (hash) below
|
129
|
-
#expected = {id: 1, name: '', tags: []}
|
130
|
-
#expect(api_client.object_to_hash(_model)).to eq(expected)
|
129
|
+
# expected = {id: 1, name: '', tags: []}
|
130
|
+
# expect(api_client.object_to_hash(_model)).to eq(expected)
|
131
131
|
end
|
132
132
|
end
|
133
133
|
|
134
|
-
describe
|
134
|
+
describe '#build_collection_param' do
|
135
135
|
let(:param) { ['aa', 'bb', 'cc'] }
|
136
136
|
let(:api_client) { SibApiV3Sdk::ApiClient.new }
|
137
137
|
|
138
|
-
it
|
138
|
+
it 'works for csv' do
|
139
139
|
expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
|
140
140
|
end
|
141
141
|
|
142
|
-
it
|
142
|
+
it 'works for ssv' do
|
143
143
|
expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
|
144
144
|
end
|
145
145
|
|
146
|
-
it
|
146
|
+
it 'works for tsv' do
|
147
147
|
expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
|
148
148
|
end
|
149
149
|
|
150
|
-
it
|
150
|
+
it 'works for pipes' do
|
151
151
|
expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
|
152
152
|
end
|
153
153
|
|
154
|
-
it
|
154
|
+
it 'works for multi' do
|
155
155
|
expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
|
156
156
|
end
|
157
157
|
|
158
|
-
it
|
158
|
+
it 'fails for invalid collection format' do
|
159
159
|
expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
|
160
160
|
end
|
161
161
|
end
|
162
162
|
|
163
|
-
describe
|
163
|
+
describe '#json_mime?' do
|
164
164
|
let(:api_client) { SibApiV3Sdk::ApiClient.new }
|
165
165
|
|
166
|
-
it
|
166
|
+
it 'works' do
|
167
167
|
expect(api_client.json_mime?(nil)).to eq false
|
168
168
|
expect(api_client.json_mime?('')).to eq false
|
169
169
|
|
@@ -177,10 +177,10 @@ describe SibApiV3Sdk::ApiClient do
|
|
177
177
|
end
|
178
178
|
end
|
179
179
|
|
180
|
-
describe
|
180
|
+
describe '#select_header_accept' do
|
181
181
|
let(:api_client) { SibApiV3Sdk::ApiClient.new }
|
182
182
|
|
183
|
-
it
|
183
|
+
it 'works' do
|
184
184
|
expect(api_client.select_header_accept(nil)).to be_nil
|
185
185
|
expect(api_client.select_header_accept([])).to be_nil
|
186
186
|
|
@@ -193,10 +193,10 @@ describe SibApiV3Sdk::ApiClient do
|
|
193
193
|
end
|
194
194
|
end
|
195
195
|
|
196
|
-
describe
|
196
|
+
describe '#select_header_content_type' do
|
197
197
|
let(:api_client) { SibApiV3Sdk::ApiClient.new }
|
198
198
|
|
199
|
-
it
|
199
|
+
it 'works' do
|
200
200
|
expect(api_client.select_header_content_type(nil)).to eq('application/json')
|
201
201
|
expect(api_client.select_header_content_type([])).to eq('application/json')
|
202
202
|
|
@@ -208,10 +208,10 @@ describe SibApiV3Sdk::ApiClient do
|
|
208
208
|
end
|
209
209
|
end
|
210
210
|
|
211
|
-
describe
|
211
|
+
describe '#sanitize_filename' do
|
212
212
|
let(:api_client) { SibApiV3Sdk::ApiClient.new }
|
213
213
|
|
214
|
-
it
|
214
|
+
it 'works' do
|
215
215
|
expect(api_client.sanitize_filename('sun')).to eq('sun')
|
216
216
|
expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
|
217
217
|
expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
|