sib-api-v3-sdk 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE.md +21 -0
- data/README.md +349 -0
- data/Rakefile +8 -0
- data/docs/AccountApi.md +55 -0
- data/docs/AddCredits.md +9 -0
- data/docs/AddRemoveContactToList.md +8 -0
- data/docs/AttributesApi.md +160 -0
- data/docs/ContactsApi.md +1310 -0
- data/docs/CreaUpdateFolder.md +8 -0
- data/docs/CreateAttribute.md +12 -0
- data/docs/CreateAttributeEnumemaration.md +9 -0
- data/docs/CreateChild.md +12 -0
- data/docs/CreateContact.md +12 -0
- data/docs/CreateEmailCampaign.md +25 -0
- data/docs/CreateEmailCampaignRecipients.md +9 -0
- data/docs/CreateEmailCampaignSender.md +9 -0
- data/docs/CreateList.md +9 -0
- data/docs/CreateModel.md +8 -0
- data/docs/CreateSender.md +10 -0
- data/docs/CreateSenderIps.md +10 -0
- data/docs/CreateSenderModel.md +10 -0
- data/docs/CreateSmsCampaign.md +12 -0
- data/docs/CreateSmsCampaignRecipients.md +9 -0
- data/docs/CreateSmtpEmail.md +8 -0
- data/docs/CreateSmtpTemplate.md +17 -0
- data/docs/CreateSmtpTemplateSender.md +9 -0
- data/docs/CreateWebhook.md +11 -0
- data/docs/CreatedProcessId.md +8 -0
- data/docs/DeleteHardbounces.md +10 -0
- data/docs/EmailCampaignsApi.md +557 -0
- data/docs/EmailExportRecipients.md +9 -0
- data/docs/ErrorModel.md +9 -0
- data/docs/FoldersApi.md +336 -0
- data/docs/GetAccount.md +15 -0
- data/docs/GetAccountMarketingAutomation.md +9 -0
- data/docs/GetAccountPlan.md +10 -0
- data/docs/GetAccountRelay.md +9 -0
- data/docs/GetAccountRelayData.md +10 -0
- data/docs/GetAggregatedReport.md +19 -0
- data/docs/GetAttributes.md +8 -0
- data/docs/GetAttributesAttributes.md +13 -0
- data/docs/GetAttributesEnumeration.md +9 -0
- data/docs/GetCampaignOverview.md +13 -0
- data/docs/GetCampaignRecipients.md +9 -0
- data/docs/GetCampaignRecipientsExclusionLists.md +9 -0
- data/docs/GetCampaignRecipientsLists.md +9 -0
- data/docs/GetCampaignStats.md +19 -0
- data/docs/GetChildInfo.md +16 -0
- data/docs/GetChildInfoApiKeys.md +10 -0
- data/docs/GetChildInfoCredits.md +9 -0
- data/docs/GetChildInfoIps.md +9 -0
- data/docs/GetChildInfoStatistics.md +10 -0
- data/docs/GetChildrenList.md +8 -0
- data/docs/GetClient.md +11 -0
- data/docs/GetContactCampaignStats.md +15 -0
- data/docs/GetContactCampaignStatsClicked.md +9 -0
- data/docs/GetContactCampaignStatsLinks.md +11 -0
- data/docs/GetContactCampaignStatsMessagesSent.md +9 -0
- data/docs/GetContactCampaignStatsOpened.md +11 -0
- data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- data/docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md +9 -0
- data/docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md +10 -0
- data/docs/GetContactDetails.md +15 -0
- data/docs/GetContacts.md +9 -0
- data/docs/GetEmailCampaign.md +27 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +14 -0
- data/docs/GetExtendedCampaignOverview.md +27 -0
- data/docs/GetExtendedCampaignOverviewSender.md +9 -0
- data/docs/GetExtendedCampaignStats.md +12 -0
- data/docs/GetExtendedCampaignStatsLinksStats.md +8 -0
- data/docs/GetExtendedClient.md +12 -0
- data/docs/GetExtendedClientAddress.md +11 -0
- data/docs/GetExtendedContactDetails.md +15 -0
- data/docs/GetExtendedList.md +15 -0
- data/docs/GetExtendedListCampaignStats.md +9 -0
- data/docs/GetFolder.md +12 -0
- data/docs/GetFolderLists.md +9 -0
- data/docs/GetFolders.md +9 -0
- data/docs/GetIp.md +11 -0
- data/docs/GetIpFromSender.md +11 -0
- data/docs/GetIps.md +8 -0
- data/docs/GetIpsFromSender.md +8 -0
- data/docs/GetList.md +11 -0
- data/docs/GetLists.md +9 -0
- data/docs/GetListsFolder.md +9 -0
- data/docs/GetListsLists.md +8 -0
- data/docs/GetProcess.md +11 -0
- data/docs/GetProcesses.md +9 -0
- data/docs/GetReports.md +8 -0
- data/docs/GetReportsReports.md +20 -0
- data/docs/GetSendersList.md +8 -0
- data/docs/GetSendersListIps.md +10 -0
- data/docs/GetSendersListSenders.md +12 -0
- data/docs/GetSmsCampaign.md +16 -0
- data/docs/GetSmsCampaignOverview.md +16 -0
- data/docs/GetSmsCampaignStats.md +14 -0
- data/docs/GetSmsCampaigns.md +9 -0
- data/docs/GetSmsEventReport.md +8 -0
- data/docs/GetSmsEventReportEvents.md +14 -0
- data/docs/GetSmtpTemplateOverview.md +19 -0
- data/docs/GetSmtpTemplateOverviewSender.md +9 -0
- data/docs/GetSmtpTemplates.md +9 -0
- data/docs/GetStatsByDomain.md +7 -0
- data/docs/GetTransacAggregatedSmsReport.md +17 -0
- data/docs/GetTransacSmsReport.md +8 -0
- data/docs/GetTransacSmsReportReports.md +18 -0
- data/docs/GetWebhook.md +14 -0
- data/docs/GetWebhooks.md +8 -0
- data/docs/ListsApi.md +509 -0
- data/docs/ManageIp.md +8 -0
- data/docs/PostContactInfo.md +8 -0
- data/docs/PostContactInfoContacts.md +9 -0
- data/docs/PostSendFailed.md +12 -0
- data/docs/PostSendSmsTestFailed.md +11 -0
- data/docs/ProcessApi.md +117 -0
- data/docs/RemainingCreditModel.md +9 -0
- data/docs/RemainingCreditModelChild.md +9 -0
- data/docs/RemainingCreditModelReseller.md +9 -0
- data/docs/RemoveCredits.md +9 -0
- data/docs/RequestContactExport.md +10 -0
- data/docs/RequestContactImport.md +12 -0
- data/docs/RequestContactImportNewList.md +9 -0
- data/docs/RequestSMSRecipientExport.md +9 -0
- data/docs/ResellerApi.md +491 -0
- data/docs/SMSCampaignsApi.md +560 -0
- data/docs/SMTPApi.md +642 -0
- data/docs/SendEmail.md +15 -0
- data/docs/SendEmailAttachment.md +9 -0
- data/docs/SendReport.md +9 -0
- data/docs/SendReportEmail.md +13 -0
- data/docs/SendSms.md +8 -0
- data/docs/SendSmtpEmail.md +17 -0
- data/docs/SendSmtpEmailAttachment.md +10 -0
- data/docs/SendSmtpEmailBcc.md +9 -0
- data/docs/SendSmtpEmailCc.md +9 -0
- data/docs/SendSmtpEmailReplyTo.md +9 -0
- data/docs/SendSmtpEmailSender.md +9 -0
- data/docs/SendSmtpEmailTo.md +9 -0
- data/docs/SendTemplateEmail.md +8 -0
- data/docs/SendTestEmail.md +8 -0
- data/docs/SendTestSms.md +8 -0
- data/docs/SendTransacSms.md +12 -0
- data/docs/SendersApi.md +326 -0
- data/docs/TransactionalSMSApi.md +249 -0
- data/docs/UpdateCampaignStatus.md +8 -0
- data/docs/UpdateChild.md +13 -0
- data/docs/UpdateContact.md +12 -0
- data/docs/UpdateEmailCampaign.md +24 -0
- data/docs/UpdateEmailCampaignRecipients.md +9 -0
- data/docs/UpdateEmailCampaignSender.md +9 -0
- data/docs/UpdateList.md +9 -0
- data/docs/UpdateSender.md +10 -0
- data/docs/UpdateSmsCampaign.md +12 -0
- data/docs/UpdateSmtpTemplate.md +17 -0
- data/docs/UpdateSmtpTemplateSender.md +9 -0
- data/docs/UpdateWebhook.md +10 -0
- data/docs/WebhooksApi.md +275 -0
- data/git_push.sh +55 -0
- data/lib/sib-api-v3-sdk.rb +196 -0
- data/lib/sib-api-v3-sdk/api/account_api.rb +72 -0
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +181 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +1408 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +609 -0
- data/lib/sib-api-v3-sdk/api/folders_api.rb +379 -0
- data/lib/sib-api-v3-sdk/api/lists_api.rb +565 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +137 -0
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +534 -0
- data/lib/sib-api-v3-sdk/api/senders_api.rb +343 -0
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +609 -0
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +699 -0
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +280 -0
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +302 -0
- data/lib/sib-api-v3-sdk/api_client.rb +389 -0
- data/lib/sib-api-v3-sdk/api_error.rb +38 -0
- data/lib/sib-api-v3-sdk/configuration.rb +209 -0
- data/lib/sib-api-v3-sdk/models/add_credits.rb +199 -0
- data/lib/sib-api-v3-sdk/models/add_remove_contact_to_list.rb +191 -0
- data/lib/sib-api-v3-sdk/models/crea_update_folder.rb +189 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +291 -0
- data/lib/sib-api-v3-sdk/models/create_attribute_enumemaration.rb +199 -0
- data/lib/sib-api-v3-sdk/models/create_child.rb +254 -0
- data/lib/sib-api-v3-sdk/models/create_contact.rb +231 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +425 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +203 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +204 -0
- data/lib/sib-api-v3-sdk/models/create_list.rb +209 -0
- data/lib/sib-api-v3-sdk/models/create_model.rb +194 -0
- data/lib/sib-api-v3-sdk/models/create_sender.rb +221 -0
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +244 -0
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +214 -0
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +273 -0
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +213 -0
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +194 -0
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +288 -0
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +204 -0
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +261 -0
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +194 -0
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +209 -0
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +237 -0
- data/lib/sib-api-v3-sdk/models/error_model.rb +242 -0
- data/lib/sib-api-v3-sdk/models/get_account.rb +283 -0
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +204 -0
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +269 -0
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +203 -0
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +224 -0
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +359 -0
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +196 -0
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +301 -0
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +325 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +213 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients_exclusion_lists.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients_lists.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +359 -0
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +296 -0
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +219 -0
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +199 -0
- data/lib/sib-api-v3-sdk/models/get_child_info_ips.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +191 -0
- data/lib/sib-api-v3-sdk/models/get_client.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +265 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +210 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_links.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_messages_sent.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +224 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +213 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription.rb +224 -0
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +316 -0
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +210 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +552 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +205 -0
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +190 -0
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +312 -0
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +552 -0
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +199 -0
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +255 -0
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb +194 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +248 -0
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +316 -0
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +309 -0
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +208 -0
- data/lib/sib-api-v3-sdk/models/get_folder.rb +254 -0
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +210 -0
- data/lib/sib-api-v3-sdk/models/get_folders.rb +200 -0
- data/lib/sib-api-v3-sdk/models/get_ip.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_ips.rb +196 -0
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +196 -0
- data/lib/sib-api-v3-sdk/models/get_list.rb +239 -0
- data/lib/sib-api-v3-sdk/models/get_lists.rb +211 -0
- data/lib/sib-api-v3-sdk/models/get_lists_folder.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_lists_lists.rb +188 -0
- data/lib/sib-api-v3-sdk/models/get_process.rb +267 -0
- data/lib/sib-api-v3-sdk/models/get_processes.rb +206 -0
- data/lib/sib-api-v3-sdk/models/get_reports.rb +190 -0
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +374 -0
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +191 -0
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +224 -0
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +251 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +404 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +404 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +284 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +205 -0
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +190 -0
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +311 -0
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +391 -0
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +199 -0
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +200 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +179 -0
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +329 -0
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +190 -0
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +344 -0
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +356 -0
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +195 -0
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +189 -0
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +188 -0
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +206 -0
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +242 -0
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +231 -0
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +197 -0
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +209 -0
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +209 -0
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +199 -0
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +216 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +230 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +199 -0
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +239 -0
- data/lib/sib-api-v3-sdk/models/send_email.rb +274 -0
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +215 -0
- data/lib/sib-api-v3-sdk/models/send_report.rb +233 -0
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +278 -0
- data/lib/sib-api-v3-sdk/models/send_sms.rb +193 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +301 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +225 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +204 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +204 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +204 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +204 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +204 -0
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +194 -0
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +191 -0
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +191 -0
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +282 -0
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +221 -0
- data/lib/sib-api-v3-sdk/models/update_child.rb +240 -0
- data/lib/sib-api-v3-sdk/models/update_contact.rb +234 -0
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +367 -0
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +203 -0
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +199 -0
- data/lib/sib-api-v3-sdk/models/update_list.rb +199 -0
- data/lib/sib-api-v3-sdk/models/update_sender.rb +211 -0
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +260 -0
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +278 -0
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +199 -0
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +211 -0
- data/lib/sib-api-v3-sdk/version.rb +15 -0
- data/sib-api-v3-sdk.gemspec +45 -0
- data/spec/api/account_api_spec.rb +46 -0
- data/spec/api/attributes_api_spec.rb +70 -0
- data/spec/api/contacts_api_spec.rb +335 -0
- data/spec/api/email_campaigns_api_spec.rb +163 -0
- data/spec/api/folders_api_spec.rb +111 -0
- data/spec/api/lists_api_spec.rb +152 -0
- data/spec/api/process_api_spec.rb +60 -0
- data/spec/api/reseller_api_spec.rb +147 -0
- data/spec/api/senders_api_spec.rb +108 -0
- data/spec/api/sms_campaigns_api_spec.rb +163 -0
- data/spec/api/smtp_api_spec.rb +189 -0
- data/spec/api/transactional_sms_api_spec.rb +96 -0
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_credits_spec.rb +48 -0
- data/spec/models/add_remove_contact_to_list_spec.rb +42 -0
- data/spec/models/crea_update_folder_spec.rb +42 -0
- data/spec/models/create_attribute_enumemaration_spec.rb +48 -0
- data/spec/models/create_attribute_spec.rb +74 -0
- data/spec/models/create_child_spec.rb +66 -0
- data/spec/models/create_contact_spec.rb +66 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +48 -0
- data/spec/models/create_email_campaign_sender_spec.rb +48 -0
- data/spec/models/create_email_campaign_spec.rb +148 -0
- data/spec/models/create_list_spec.rb +48 -0
- data/spec/models/create_model_spec.rb +42 -0
- data/spec/models/create_sender_ips_spec.rb +54 -0
- data/spec/models/create_sender_model_spec.rb +54 -0
- data/spec/models/create_sender_spec.rb +54 -0
- data/spec/models/create_sms_campaign_recipients_spec.rb +48 -0
- data/spec/models/create_sms_campaign_spec.rb +66 -0
- data/spec/models/create_smtp_email_spec.rb +42 -0
- data/spec/models/create_smtp_template_sender_spec.rb +48 -0
- data/spec/models/create_smtp_template_spec.rb +96 -0
- data/spec/models/create_webhook_spec.rb +64 -0
- data/spec/models/created_process_id_spec.rb +42 -0
- data/spec/models/delete_hardbounces_spec.rb +54 -0
- data/spec/models/email_export_recipients_spec.rb +52 -0
- data/spec/models/error_model_spec.rb +52 -0
- data/spec/models/get_account_marketing_automation_spec.rb +48 -0
- data/spec/models/get_account_plan_spec.rb +62 -0
- data/spec/models/get_account_relay_data_spec.rb +54 -0
- data/spec/models/get_account_relay_spec.rb +48 -0
- data/spec/models/get_account_spec.rb +84 -0
- data/spec/models/get_aggregated_report_spec.rb +108 -0
- data/spec/models/get_attributes_attributes_spec.rb +80 -0
- data/spec/models/get_attributes_enumeration_spec.rb +48 -0
- data/spec/models/get_attributes_spec.rb +42 -0
- data/spec/models/get_campaign_overview_spec.rb +80 -0
- data/spec/models/get_campaign_recipients_exclusion_lists_spec.rb +48 -0
- data/spec/models/get_campaign_recipients_lists_spec.rb +48 -0
- data/spec/models/get_campaign_recipients_spec.rb +48 -0
- data/spec/models/get_campaign_stats_spec.rb +108 -0
- data/spec/models/get_child_info_api_keys_spec.rb +54 -0
- data/spec/models/get_child_info_credits_spec.rb +48 -0
- data/spec/models/get_child_info_ips_spec.rb +48 -0
- data/spec/models/get_child_info_spec.rb +90 -0
- data/spec/models/get_child_info_statistics_spec.rb +54 -0
- data/spec/models/get_children_list_spec.rb +42 -0
- data/spec/models/get_client_spec.rb +60 -0
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +48 -0
- data/spec/models/get_contact_campaign_stats_links_spec.rb +60 -0
- data/spec/models/get_contact_campaign_stats_messages_sent_spec.rb +48 -0
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +60 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +84 -0
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +54 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription_spec.rb +48 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +48 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription_spec.rb +54 -0
- data/spec/models/get_contact_details_spec.rb +84 -0
- data/spec/models/get_contacts_spec.rb +48 -0
- data/spec/models/get_email_campaign_spec.rb +164 -0
- data/spec/models/get_email_campaigns_spec.rb +48 -0
- data/spec/models/get_email_event_report_events_spec.rb +82 -0
- data/spec/models/get_email_event_report_spec.rb +42 -0
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +48 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +164 -0
- data/spec/models/get_extended_campaign_stats_links_stats_spec.rb +42 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +66 -0
- data/spec/models/get_extended_client_address_spec.rb +60 -0
- data/spec/models/get_extended_client_spec.rb +66 -0
- data/spec/models/get_extended_contact_details_spec.rb +84 -0
- data/spec/models/get_extended_list_campaign_stats_spec.rb +48 -0
- data/spec/models/get_extended_list_spec.rb +84 -0
- data/spec/models/get_folder_lists_spec.rb +48 -0
- data/spec/models/get_folder_spec.rb +66 -0
- data/spec/models/get_folders_spec.rb +48 -0
- data/spec/models/get_ip_from_sender_spec.rb +60 -0
- data/spec/models/get_ip_spec.rb +60 -0
- data/spec/models/get_ips_from_sender_spec.rb +42 -0
- data/spec/models/get_ips_spec.rb +42 -0
- data/spec/models/get_list_spec.rb +60 -0
- data/spec/models/get_lists_folder_spec.rb +48 -0
- data/spec/models/get_lists_lists_spec.rb +42 -0
- data/spec/models/get_lists_spec.rb +48 -0
- data/spec/models/get_process_spec.rb +64 -0
- data/spec/models/get_processes_spec.rb +48 -0
- data/spec/models/get_reports_reports_spec.rb +114 -0
- data/spec/models/get_reports_spec.rb +42 -0
- data/spec/models/get_senders_list_ips_spec.rb +54 -0
- data/spec/models/get_senders_list_senders_spec.rb +66 -0
- data/spec/models/get_senders_list_spec.rb +42 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +94 -0
- data/spec/models/get_sms_campaign_spec.rb +94 -0
- data/spec/models/get_sms_campaign_stats_spec.rb +78 -0
- data/spec/models/get_sms_campaigns_spec.rb +48 -0
- data/spec/models/get_sms_event_report_events_spec.rb +82 -0
- data/spec/models/get_sms_event_report_spec.rb +42 -0
- data/spec/models/get_smtp_template_overview_sender_spec.rb +48 -0
- data/spec/models/get_smtp_template_overview_spec.rb +108 -0
- data/spec/models/get_smtp_templates_spec.rb +48 -0
- data/spec/models/get_stats_by_domain_spec.rb +36 -0
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +96 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +102 -0
- data/spec/models/get_transac_sms_report_spec.rb +42 -0
- data/spec/models/get_webhook_spec.rb +82 -0
- data/spec/models/get_webhooks_spec.rb +42 -0
- data/spec/models/manage_ip_spec.rb +42 -0
- data/spec/models/post_contact_info_contacts_spec.rb +48 -0
- data/spec/models/post_contact_info_spec.rb +42 -0
- data/spec/models/post_send_failed_spec.rb +66 -0
- data/spec/models/post_send_sms_test_failed_spec.rb +60 -0
- data/spec/models/remaining_credit_model_child_spec.rb +48 -0
- data/spec/models/remaining_credit_model_reseller_spec.rb +48 -0
- data/spec/models/remaining_credit_model_spec.rb +48 -0
- data/spec/models/remove_credits_spec.rb +48 -0
- data/spec/models/request_contact_export_spec.rb +54 -0
- data/spec/models/request_contact_import_new_list_spec.rb +48 -0
- data/spec/models/request_contact_import_spec.rb +66 -0
- data/spec/models/request_sms_recipient_export_spec.rb +52 -0
- data/spec/models/send_email_attachment_spec.rb +48 -0
- data/spec/models/send_email_spec.rb +84 -0
- data/spec/models/send_report_email_spec.rb +76 -0
- data/spec/models/send_report_spec.rb +52 -0
- data/spec/models/send_sms_spec.rb +42 -0
- data/spec/models/send_smtp_email_attachment_spec.rb +54 -0
- data/spec/models/send_smtp_email_bcc_spec.rb +48 -0
- data/spec/models/send_smtp_email_cc_spec.rb +48 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +48 -0
- data/spec/models/send_smtp_email_sender_spec.rb +48 -0
- data/spec/models/send_smtp_email_spec.rb +96 -0
- data/spec/models/send_smtp_email_to_spec.rb +48 -0
- data/spec/models/send_template_email_spec.rb +42 -0
- data/spec/models/send_test_email_spec.rb +42 -0
- data/spec/models/send_test_sms_spec.rb +42 -0
- data/spec/models/send_transac_sms_spec.rb +66 -0
- data/spec/models/update_campaign_status_spec.rb +46 -0
- data/spec/models/update_child_spec.rb +72 -0
- data/spec/models/update_contact_spec.rb +66 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +48 -0
- data/spec/models/update_email_campaign_sender_spec.rb +48 -0
- data/spec/models/update_email_campaign_spec.rb +138 -0
- data/spec/models/update_list_spec.rb +48 -0
- data/spec/models/update_sender_spec.rb +54 -0
- data/spec/models/update_sms_campaign_spec.rb +66 -0
- data/spec/models/update_smtp_template_sender_spec.rb +48 -0
- data/spec/models/update_smtp_template_spec.rb +96 -0
- data/spec/models/update_webhook_spec.rb +54 -0
- data/spec/spec_helper.rb +111 -0
- metadata +869 -0
@@ -0,0 +1,210 @@
|
|
1
|
+
=begin
|
2
|
+
#SendinBlue API
|
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 |
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.0
|
7
|
+
Contact: contact@sendinblue.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.2.3
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
|
17
|
+
class GetContacts
|
18
|
+
attr_accessor :contacts
|
19
|
+
|
20
|
+
# Number of contacts
|
21
|
+
attr_accessor :count
|
22
|
+
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'contacts' => :'contacts',
|
28
|
+
:'count' => :'count'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Attribute type mapping.
|
33
|
+
def self.swagger_types
|
34
|
+
{
|
35
|
+
:'contacts' => :'Array<Object>',
|
36
|
+
:'count' => :'Integer'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Initializes the object
|
41
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
42
|
+
def initialize(attributes = {})
|
43
|
+
return unless attributes.is_a?(Hash)
|
44
|
+
|
45
|
+
# convert string to symbol for hash key
|
46
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
47
|
+
|
48
|
+
if attributes.has_key?(:'contacts')
|
49
|
+
if (value = attributes[:'contacts']).is_a?(Array)
|
50
|
+
self.contacts = value
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
if attributes.has_key?(:'count')
|
55
|
+
self.count = attributes[:'count']
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
59
|
+
|
60
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
61
|
+
# @return Array for valid properies with the reasons
|
62
|
+
def list_invalid_properties
|
63
|
+
invalid_properties = Array.new
|
64
|
+
if @contacts.nil?
|
65
|
+
invalid_properties.push("invalid value for 'contacts', contacts cannot be nil.")
|
66
|
+
end
|
67
|
+
|
68
|
+
if @count.nil?
|
69
|
+
invalid_properties.push("invalid value for 'count', count cannot be nil.")
|
70
|
+
end
|
71
|
+
|
72
|
+
return invalid_properties
|
73
|
+
end
|
74
|
+
|
75
|
+
# Check to see if the all the properties in the model are valid
|
76
|
+
# @return true if the model is valid
|
77
|
+
def valid?
|
78
|
+
return false if @contacts.nil?
|
79
|
+
return false if @count.nil?
|
80
|
+
return true
|
81
|
+
end
|
82
|
+
|
83
|
+
# Checks equality by comparing each attribute.
|
84
|
+
# @param [Object] Object to be compared
|
85
|
+
def ==(o)
|
86
|
+
return true if self.equal?(o)
|
87
|
+
self.class == o.class &&
|
88
|
+
contacts == o.contacts &&
|
89
|
+
count == o.count
|
90
|
+
end
|
91
|
+
|
92
|
+
# @see the `==` method
|
93
|
+
# @param [Object] Object to be compared
|
94
|
+
def eql?(o)
|
95
|
+
self == o
|
96
|
+
end
|
97
|
+
|
98
|
+
# Calculates hash code according to all attributes.
|
99
|
+
# @return [Fixnum] Hash code
|
100
|
+
def hash
|
101
|
+
[contacts, count].hash
|
102
|
+
end
|
103
|
+
|
104
|
+
# Builds the object from hash
|
105
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
106
|
+
# @return [Object] Returns the model itself
|
107
|
+
def build_from_hash(attributes)
|
108
|
+
return nil unless attributes.is_a?(Hash)
|
109
|
+
self.class.swagger_types.each_pair do |key, type|
|
110
|
+
if type =~ /\AArray<(.*)>/i
|
111
|
+
# check to ensure the input is an array given that the the attribute
|
112
|
+
# is documented as an array but the input is not
|
113
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
114
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
115
|
+
end
|
116
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
117
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
118
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
119
|
+
end
|
120
|
+
|
121
|
+
self
|
122
|
+
end
|
123
|
+
|
124
|
+
# Deserializes the data based on type
|
125
|
+
# @param string type Data type
|
126
|
+
# @param string value Value to be deserialized
|
127
|
+
# @return [Object] Deserialized data
|
128
|
+
def _deserialize(type, value)
|
129
|
+
case type.to_sym
|
130
|
+
when :DateTime
|
131
|
+
DateTime.parse(value)
|
132
|
+
when :Date
|
133
|
+
Date.parse(value)
|
134
|
+
when :String
|
135
|
+
value.to_s
|
136
|
+
when :Integer
|
137
|
+
value.to_i
|
138
|
+
when :Float
|
139
|
+
value.to_f
|
140
|
+
when :BOOLEAN
|
141
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
142
|
+
true
|
143
|
+
else
|
144
|
+
false
|
145
|
+
end
|
146
|
+
when :Object
|
147
|
+
# generic object (usually a Hash), return directly
|
148
|
+
value
|
149
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
150
|
+
inner_type = Regexp.last_match[:inner_type]
|
151
|
+
value.map { |v| _deserialize(inner_type, v) }
|
152
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
153
|
+
k_type = Regexp.last_match[:k_type]
|
154
|
+
v_type = Regexp.last_match[:v_type]
|
155
|
+
{}.tap do |hash|
|
156
|
+
value.each do |k, v|
|
157
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
158
|
+
end
|
159
|
+
end
|
160
|
+
else # model
|
161
|
+
temp_model = SibApiV3Sdk.const_get(type).new
|
162
|
+
temp_model.build_from_hash(value)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Returns the string representation of the object
|
167
|
+
# @return [String] String presentation of the object
|
168
|
+
def to_s
|
169
|
+
to_hash.to_s
|
170
|
+
end
|
171
|
+
|
172
|
+
# to_body is an alias to to_hash (backward compatibility)
|
173
|
+
# @return [Hash] Returns the object in the form of hash
|
174
|
+
def to_body
|
175
|
+
to_hash
|
176
|
+
end
|
177
|
+
|
178
|
+
# Returns the object in the form of hash
|
179
|
+
# @return [Hash] Returns the object in the form of hash
|
180
|
+
def to_hash
|
181
|
+
hash = {}
|
182
|
+
self.class.attribute_map.each_pair do |attr, param|
|
183
|
+
value = self.send(attr)
|
184
|
+
next if value.nil?
|
185
|
+
hash[param] = _to_hash(value)
|
186
|
+
end
|
187
|
+
hash
|
188
|
+
end
|
189
|
+
|
190
|
+
# Outputs non-array value in the form of hash
|
191
|
+
# For object, use to_hash. Otherwise, just return the value
|
192
|
+
# @param [Object] value Any valid value
|
193
|
+
# @return [Hash] Returns the value in the form of hash
|
194
|
+
def _to_hash(value)
|
195
|
+
if value.is_a?(Array)
|
196
|
+
value.compact.map{ |v| _to_hash(v) }
|
197
|
+
elsif value.is_a?(Hash)
|
198
|
+
{}.tap do |hash|
|
199
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
200
|
+
end
|
201
|
+
elsif value.respond_to? :to_hash
|
202
|
+
value.to_hash
|
203
|
+
else
|
204
|
+
value
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
208
|
+
end
|
209
|
+
|
210
|
+
end
|
@@ -0,0 +1,552 @@
|
|
1
|
+
=begin
|
2
|
+
#SendinBlue API
|
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 |
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.0
|
7
|
+
Contact: contact@sendinblue.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.2.3
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
|
17
|
+
class GetEmailCampaign
|
18
|
+
# ID of the campaign
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
# Name of the campaign
|
22
|
+
attr_accessor :name
|
23
|
+
|
24
|
+
# Subject of the campaign
|
25
|
+
attr_accessor :subject
|
26
|
+
|
27
|
+
# Type of campaign
|
28
|
+
attr_accessor :type
|
29
|
+
|
30
|
+
# Status of the campaign
|
31
|
+
attr_accessor :status
|
32
|
+
|
33
|
+
# Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss)
|
34
|
+
attr_accessor :scheduled_at
|
35
|
+
|
36
|
+
# Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
|
37
|
+
attr_accessor :test_sent
|
38
|
+
|
39
|
+
# Header of the campaign
|
40
|
+
attr_accessor :header
|
41
|
+
|
42
|
+
# Footer of the campaign
|
43
|
+
attr_accessor :footer
|
44
|
+
|
45
|
+
attr_accessor :sender
|
46
|
+
|
47
|
+
# Email defined as the \"Reply to\" of the campaign
|
48
|
+
attr_accessor :reply_to
|
49
|
+
|
50
|
+
# Customisation of the \"to\" field of the campaign
|
51
|
+
attr_accessor :to_field
|
52
|
+
|
53
|
+
# HTML content of the campaign
|
54
|
+
attr_accessor :html_content
|
55
|
+
|
56
|
+
# Link to share the campaign on social medias
|
57
|
+
attr_accessor :share_link
|
58
|
+
|
59
|
+
# Tag of the campaign
|
60
|
+
attr_accessor :tag
|
61
|
+
|
62
|
+
# Creation date of the campaign (YYYY-MM-DD HH:mm:ss)
|
63
|
+
attr_accessor :created_at
|
64
|
+
|
65
|
+
# Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss)
|
66
|
+
attr_accessor :modified_at
|
67
|
+
|
68
|
+
# Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
|
69
|
+
attr_accessor :inline_image_activation
|
70
|
+
|
71
|
+
# Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
|
72
|
+
attr_accessor :mirror_active
|
73
|
+
|
74
|
+
# FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
|
75
|
+
attr_accessor :recurring
|
76
|
+
|
77
|
+
class EnumAttributeValidator
|
78
|
+
attr_reader :datatype
|
79
|
+
attr_reader :allowable_values
|
80
|
+
|
81
|
+
def initialize(datatype, allowable_values)
|
82
|
+
@allowable_values = allowable_values.map do |value|
|
83
|
+
case datatype.to_s
|
84
|
+
when /Integer/i
|
85
|
+
value.to_i
|
86
|
+
when /Float/i
|
87
|
+
value.to_f
|
88
|
+
else
|
89
|
+
value
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
def valid?(value)
|
95
|
+
!value || allowable_values.include?(value)
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
100
|
+
def self.attribute_map
|
101
|
+
{
|
102
|
+
:'id' => :'id',
|
103
|
+
:'name' => :'name',
|
104
|
+
:'subject' => :'subject',
|
105
|
+
:'type' => :'type',
|
106
|
+
:'status' => :'status',
|
107
|
+
:'scheduled_at' => :'scheduledAt',
|
108
|
+
:'test_sent' => :'testSent',
|
109
|
+
:'header' => :'header',
|
110
|
+
:'footer' => :'footer',
|
111
|
+
:'sender' => :'sender',
|
112
|
+
:'reply_to' => :'replyTo',
|
113
|
+
:'to_field' => :'toField',
|
114
|
+
:'html_content' => :'htmlContent',
|
115
|
+
:'share_link' => :'shareLink',
|
116
|
+
:'tag' => :'tag',
|
117
|
+
:'created_at' => :'createdAt',
|
118
|
+
:'modified_at' => :'modifiedAt',
|
119
|
+
:'inline_image_activation' => :'inlineImageActivation',
|
120
|
+
:'mirror_active' => :'mirrorActive',
|
121
|
+
:'recurring' => :'recurring'
|
122
|
+
}
|
123
|
+
end
|
124
|
+
|
125
|
+
# Attribute type mapping.
|
126
|
+
def self.swagger_types
|
127
|
+
{
|
128
|
+
:'id' => :'Integer',
|
129
|
+
:'name' => :'String',
|
130
|
+
:'subject' => :'String',
|
131
|
+
:'type' => :'String',
|
132
|
+
:'status' => :'String',
|
133
|
+
:'scheduled_at' => :'String',
|
134
|
+
:'test_sent' => :'BOOLEAN',
|
135
|
+
:'header' => :'String',
|
136
|
+
:'footer' => :'String',
|
137
|
+
:'sender' => :'GetExtendedCampaignOverviewSender',
|
138
|
+
:'reply_to' => :'String',
|
139
|
+
:'to_field' => :'String',
|
140
|
+
:'html_content' => :'String',
|
141
|
+
:'share_link' => :'String',
|
142
|
+
:'tag' => :'String',
|
143
|
+
:'created_at' => :'String',
|
144
|
+
:'modified_at' => :'String',
|
145
|
+
:'inline_image_activation' => :'BOOLEAN',
|
146
|
+
:'mirror_active' => :'BOOLEAN',
|
147
|
+
:'recurring' => :'BOOLEAN'
|
148
|
+
}
|
149
|
+
end
|
150
|
+
|
151
|
+
# Initializes the object
|
152
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
153
|
+
def initialize(attributes = {})
|
154
|
+
return unless attributes.is_a?(Hash)
|
155
|
+
|
156
|
+
# convert string to symbol for hash key
|
157
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
158
|
+
|
159
|
+
if attributes.has_key?(:'id')
|
160
|
+
self.id = attributes[:'id']
|
161
|
+
end
|
162
|
+
|
163
|
+
if attributes.has_key?(:'name')
|
164
|
+
self.name = attributes[:'name']
|
165
|
+
end
|
166
|
+
|
167
|
+
if attributes.has_key?(:'subject')
|
168
|
+
self.subject = attributes[:'subject']
|
169
|
+
end
|
170
|
+
|
171
|
+
if attributes.has_key?(:'type')
|
172
|
+
self.type = attributes[:'type']
|
173
|
+
end
|
174
|
+
|
175
|
+
if attributes.has_key?(:'status')
|
176
|
+
self.status = attributes[:'status']
|
177
|
+
end
|
178
|
+
|
179
|
+
if attributes.has_key?(:'scheduledAt')
|
180
|
+
self.scheduled_at = attributes[:'scheduledAt']
|
181
|
+
end
|
182
|
+
|
183
|
+
if attributes.has_key?(:'testSent')
|
184
|
+
self.test_sent = attributes[:'testSent']
|
185
|
+
end
|
186
|
+
|
187
|
+
if attributes.has_key?(:'header')
|
188
|
+
self.header = attributes[:'header']
|
189
|
+
end
|
190
|
+
|
191
|
+
if attributes.has_key?(:'footer')
|
192
|
+
self.footer = attributes[:'footer']
|
193
|
+
end
|
194
|
+
|
195
|
+
if attributes.has_key?(:'sender')
|
196
|
+
self.sender = attributes[:'sender']
|
197
|
+
end
|
198
|
+
|
199
|
+
if attributes.has_key?(:'replyTo')
|
200
|
+
self.reply_to = attributes[:'replyTo']
|
201
|
+
end
|
202
|
+
|
203
|
+
if attributes.has_key?(:'toField')
|
204
|
+
self.to_field = attributes[:'toField']
|
205
|
+
end
|
206
|
+
|
207
|
+
if attributes.has_key?(:'htmlContent')
|
208
|
+
self.html_content = attributes[:'htmlContent']
|
209
|
+
end
|
210
|
+
|
211
|
+
if attributes.has_key?(:'shareLink')
|
212
|
+
self.share_link = attributes[:'shareLink']
|
213
|
+
end
|
214
|
+
|
215
|
+
if attributes.has_key?(:'tag')
|
216
|
+
self.tag = attributes[:'tag']
|
217
|
+
end
|
218
|
+
|
219
|
+
if attributes.has_key?(:'createdAt')
|
220
|
+
self.created_at = attributes[:'createdAt']
|
221
|
+
end
|
222
|
+
|
223
|
+
if attributes.has_key?(:'modifiedAt')
|
224
|
+
self.modified_at = attributes[:'modifiedAt']
|
225
|
+
end
|
226
|
+
|
227
|
+
if attributes.has_key?(:'inlineImageActivation')
|
228
|
+
self.inline_image_activation = attributes[:'inlineImageActivation']
|
229
|
+
end
|
230
|
+
|
231
|
+
if attributes.has_key?(:'mirrorActive')
|
232
|
+
self.mirror_active = attributes[:'mirrorActive']
|
233
|
+
end
|
234
|
+
|
235
|
+
if attributes.has_key?(:'recurring')
|
236
|
+
self.recurring = attributes[:'recurring']
|
237
|
+
end
|
238
|
+
|
239
|
+
end
|
240
|
+
|
241
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
242
|
+
# @return Array for valid properies with the reasons
|
243
|
+
def list_invalid_properties
|
244
|
+
invalid_properties = Array.new
|
245
|
+
if @id.nil?
|
246
|
+
invalid_properties.push("invalid value for 'id', id cannot be nil.")
|
247
|
+
end
|
248
|
+
|
249
|
+
if @name.nil?
|
250
|
+
invalid_properties.push("invalid value for 'name', name cannot be nil.")
|
251
|
+
end
|
252
|
+
|
253
|
+
if @subject.nil?
|
254
|
+
invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
|
255
|
+
end
|
256
|
+
|
257
|
+
if @type.nil?
|
258
|
+
invalid_properties.push("invalid value for 'type', type cannot be nil.")
|
259
|
+
end
|
260
|
+
|
261
|
+
if @status.nil?
|
262
|
+
invalid_properties.push("invalid value for 'status', status cannot be nil.")
|
263
|
+
end
|
264
|
+
|
265
|
+
if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
266
|
+
invalid_properties.push("invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
|
267
|
+
end
|
268
|
+
|
269
|
+
if @test_sent.nil?
|
270
|
+
invalid_properties.push("invalid value for 'test_sent', test_sent cannot be nil.")
|
271
|
+
end
|
272
|
+
|
273
|
+
if @header.nil?
|
274
|
+
invalid_properties.push("invalid value for 'header', header cannot be nil.")
|
275
|
+
end
|
276
|
+
|
277
|
+
if @footer.nil?
|
278
|
+
invalid_properties.push("invalid value for 'footer', footer cannot be nil.")
|
279
|
+
end
|
280
|
+
|
281
|
+
if @reply_to.nil?
|
282
|
+
invalid_properties.push("invalid value for 'reply_to', reply_to cannot be nil.")
|
283
|
+
end
|
284
|
+
|
285
|
+
if @to_field.nil?
|
286
|
+
invalid_properties.push("invalid value for 'to_field', to_field cannot be nil.")
|
287
|
+
end
|
288
|
+
|
289
|
+
if @html_content.nil?
|
290
|
+
invalid_properties.push("invalid value for 'html_content', html_content cannot be nil.")
|
291
|
+
end
|
292
|
+
|
293
|
+
if @share_link.nil?
|
294
|
+
invalid_properties.push("invalid value for 'share_link', share_link cannot be nil.")
|
295
|
+
end
|
296
|
+
|
297
|
+
if @tag.nil?
|
298
|
+
invalid_properties.push("invalid value for 'tag', tag cannot be nil.")
|
299
|
+
end
|
300
|
+
|
301
|
+
if @created_at.nil?
|
302
|
+
invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
|
303
|
+
end
|
304
|
+
|
305
|
+
if @created_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
306
|
+
invalid_properties.push("invalid value for 'created_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
|
307
|
+
end
|
308
|
+
|
309
|
+
if @modified_at.nil?
|
310
|
+
invalid_properties.push("invalid value for 'modified_at', modified_at cannot be nil.")
|
311
|
+
end
|
312
|
+
|
313
|
+
if @modified_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
314
|
+
invalid_properties.push("invalid value for 'modified_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
|
315
|
+
end
|
316
|
+
|
317
|
+
return invalid_properties
|
318
|
+
end
|
319
|
+
|
320
|
+
# Check to see if the all the properties in the model are valid
|
321
|
+
# @return true if the model is valid
|
322
|
+
def valid?
|
323
|
+
return false if @id.nil?
|
324
|
+
return false if @name.nil?
|
325
|
+
return false if @subject.nil?
|
326
|
+
return false if @type.nil?
|
327
|
+
type_validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
|
328
|
+
return false unless type_validator.valid?(@type)
|
329
|
+
return false if @status.nil?
|
330
|
+
status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "in_process"])
|
331
|
+
return false unless status_validator.valid?(@status)
|
332
|
+
return false if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
333
|
+
return false if @test_sent.nil?
|
334
|
+
return false if @header.nil?
|
335
|
+
return false if @footer.nil?
|
336
|
+
return false if @reply_to.nil?
|
337
|
+
return false if @to_field.nil?
|
338
|
+
return false if @html_content.nil?
|
339
|
+
return false if @share_link.nil?
|
340
|
+
return false if @tag.nil?
|
341
|
+
return false if @created_at.nil?
|
342
|
+
return false if @created_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
343
|
+
return false if @modified_at.nil?
|
344
|
+
return false if @modified_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
345
|
+
return true
|
346
|
+
end
|
347
|
+
|
348
|
+
# Custom attribute writer method checking allowed values (enum).
|
349
|
+
# @param [Object] type Object to be assigned
|
350
|
+
def type=(type)
|
351
|
+
validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
|
352
|
+
unless validator.valid?(type)
|
353
|
+
fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
|
354
|
+
end
|
355
|
+
@type = type
|
356
|
+
end
|
357
|
+
|
358
|
+
# Custom attribute writer method checking allowed values (enum).
|
359
|
+
# @param [Object] status Object to be assigned
|
360
|
+
def status=(status)
|
361
|
+
validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "in_process"])
|
362
|
+
unless validator.valid?(status)
|
363
|
+
fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
|
364
|
+
end
|
365
|
+
@status = status
|
366
|
+
end
|
367
|
+
|
368
|
+
# Custom attribute writer method with validation
|
369
|
+
# @param [Object] scheduled_at Value to be assigned
|
370
|
+
def scheduled_at=(scheduled_at)
|
371
|
+
|
372
|
+
if !scheduled_at.nil? && scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
373
|
+
fail ArgumentError, "invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
|
374
|
+
end
|
375
|
+
|
376
|
+
@scheduled_at = scheduled_at
|
377
|
+
end
|
378
|
+
|
379
|
+
# Custom attribute writer method with validation
|
380
|
+
# @param [Object] created_at Value to be assigned
|
381
|
+
def created_at=(created_at)
|
382
|
+
if created_at.nil?
|
383
|
+
fail ArgumentError, "created_at cannot be nil"
|
384
|
+
end
|
385
|
+
|
386
|
+
if created_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
387
|
+
fail ArgumentError, "invalid value for 'created_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
|
388
|
+
end
|
389
|
+
|
390
|
+
@created_at = created_at
|
391
|
+
end
|
392
|
+
|
393
|
+
# Custom attribute writer method with validation
|
394
|
+
# @param [Object] modified_at Value to be assigned
|
395
|
+
def modified_at=(modified_at)
|
396
|
+
if modified_at.nil?
|
397
|
+
fail ArgumentError, "modified_at cannot be nil"
|
398
|
+
end
|
399
|
+
|
400
|
+
if modified_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
401
|
+
fail ArgumentError, "invalid value for 'modified_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
|
402
|
+
end
|
403
|
+
|
404
|
+
@modified_at = modified_at
|
405
|
+
end
|
406
|
+
|
407
|
+
# Checks equality by comparing each attribute.
|
408
|
+
# @param [Object] Object to be compared
|
409
|
+
def ==(o)
|
410
|
+
return true if self.equal?(o)
|
411
|
+
self.class == o.class &&
|
412
|
+
id == o.id &&
|
413
|
+
name == o.name &&
|
414
|
+
subject == o.subject &&
|
415
|
+
type == o.type &&
|
416
|
+
status == o.status &&
|
417
|
+
scheduled_at == o.scheduled_at &&
|
418
|
+
test_sent == o.test_sent &&
|
419
|
+
header == o.header &&
|
420
|
+
footer == o.footer &&
|
421
|
+
sender == o.sender &&
|
422
|
+
reply_to == o.reply_to &&
|
423
|
+
to_field == o.to_field &&
|
424
|
+
html_content == o.html_content &&
|
425
|
+
share_link == o.share_link &&
|
426
|
+
tag == o.tag &&
|
427
|
+
created_at == o.created_at &&
|
428
|
+
modified_at == o.modified_at &&
|
429
|
+
inline_image_activation == o.inline_image_activation &&
|
430
|
+
mirror_active == o.mirror_active &&
|
431
|
+
recurring == o.recurring
|
432
|
+
end
|
433
|
+
|
434
|
+
# @see the `==` method
|
435
|
+
# @param [Object] Object to be compared
|
436
|
+
def eql?(o)
|
437
|
+
self == o
|
438
|
+
end
|
439
|
+
|
440
|
+
# Calculates hash code according to all attributes.
|
441
|
+
# @return [Fixnum] Hash code
|
442
|
+
def hash
|
443
|
+
[id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring].hash
|
444
|
+
end
|
445
|
+
|
446
|
+
# Builds the object from hash
|
447
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
448
|
+
# @return [Object] Returns the model itself
|
449
|
+
def build_from_hash(attributes)
|
450
|
+
return nil unless attributes.is_a?(Hash)
|
451
|
+
self.class.swagger_types.each_pair do |key, type|
|
452
|
+
if type =~ /\AArray<(.*)>/i
|
453
|
+
# check to ensure the input is an array given that the the attribute
|
454
|
+
# is documented as an array but the input is not
|
455
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
456
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
457
|
+
end
|
458
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
459
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
460
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
461
|
+
end
|
462
|
+
|
463
|
+
self
|
464
|
+
end
|
465
|
+
|
466
|
+
# Deserializes the data based on type
|
467
|
+
# @param string type Data type
|
468
|
+
# @param string value Value to be deserialized
|
469
|
+
# @return [Object] Deserialized data
|
470
|
+
def _deserialize(type, value)
|
471
|
+
case type.to_sym
|
472
|
+
when :DateTime
|
473
|
+
DateTime.parse(value)
|
474
|
+
when :Date
|
475
|
+
Date.parse(value)
|
476
|
+
when :String
|
477
|
+
value.to_s
|
478
|
+
when :Integer
|
479
|
+
value.to_i
|
480
|
+
when :Float
|
481
|
+
value.to_f
|
482
|
+
when :BOOLEAN
|
483
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
484
|
+
true
|
485
|
+
else
|
486
|
+
false
|
487
|
+
end
|
488
|
+
when :Object
|
489
|
+
# generic object (usually a Hash), return directly
|
490
|
+
value
|
491
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
492
|
+
inner_type = Regexp.last_match[:inner_type]
|
493
|
+
value.map { |v| _deserialize(inner_type, v) }
|
494
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
495
|
+
k_type = Regexp.last_match[:k_type]
|
496
|
+
v_type = Regexp.last_match[:v_type]
|
497
|
+
{}.tap do |hash|
|
498
|
+
value.each do |k, v|
|
499
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
500
|
+
end
|
501
|
+
end
|
502
|
+
else # model
|
503
|
+
temp_model = SibApiV3Sdk.const_get(type).new
|
504
|
+
temp_model.build_from_hash(value)
|
505
|
+
end
|
506
|
+
end
|
507
|
+
|
508
|
+
# Returns the string representation of the object
|
509
|
+
# @return [String] String presentation of the object
|
510
|
+
def to_s
|
511
|
+
to_hash.to_s
|
512
|
+
end
|
513
|
+
|
514
|
+
# to_body is an alias to to_hash (backward compatibility)
|
515
|
+
# @return [Hash] Returns the object in the form of hash
|
516
|
+
def to_body
|
517
|
+
to_hash
|
518
|
+
end
|
519
|
+
|
520
|
+
# Returns the object in the form of hash
|
521
|
+
# @return [Hash] Returns the object in the form of hash
|
522
|
+
def to_hash
|
523
|
+
hash = {}
|
524
|
+
self.class.attribute_map.each_pair do |attr, param|
|
525
|
+
value = self.send(attr)
|
526
|
+
next if value.nil?
|
527
|
+
hash[param] = _to_hash(value)
|
528
|
+
end
|
529
|
+
hash
|
530
|
+
end
|
531
|
+
|
532
|
+
# Outputs non-array value in the form of hash
|
533
|
+
# For object, use to_hash. Otherwise, just return the value
|
534
|
+
# @param [Object] value Any valid value
|
535
|
+
# @return [Hash] Returns the value in the form of hash
|
536
|
+
def _to_hash(value)
|
537
|
+
if value.is_a?(Array)
|
538
|
+
value.compact.map{ |v| _to_hash(v) }
|
539
|
+
elsif value.is_a?(Hash)
|
540
|
+
{}.tap do |hash|
|
541
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
542
|
+
end
|
543
|
+
elsif value.respond_to? :to_hash
|
544
|
+
value.to_hash
|
545
|
+
else
|
546
|
+
value
|
547
|
+
end
|
548
|
+
end
|
549
|
+
|
550
|
+
end
|
551
|
+
|
552
|
+
end
|