sib-api-v3-sdk 5.2.3 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/LICENSE.md +1 -1
- data/README.md +96 -68
- data/docs/AbTestCampaignResult.md +13 -0
- data/docs/AccountApi.md +3 -3
- data/docs/AddContactToList.md +1 -1
- data/docs/AttributesApi.md +18 -18
- data/docs/ContactsApi.md +123 -60
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateChild.md +1 -0
- data/docs/CreateContact.md +3 -3
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateEmailCampaign.md +6 -3
- data/docs/CreateEmailCampaignSender.md +1 -0
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmtpEmail.md +1 -1
- data/docs/CreateSmtpTemplate.md +1 -1
- data/docs/CreateSmtpTemplateSender.md +1 -0
- data/docs/CreateWebhook.md +2 -2
- data/docs/EmailCampaignsApi.md +202 -25
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/FoldersApi.md +12 -12
- data/docs/GetAccountRelay.md +1 -1
- data/docs/GetAccountRelayData.md +1 -1
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildrenList.md +1 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetEmailCampaign.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +1 -0
- data/docs/GetExtendedCampaignOverviewSender.md +1 -0
- data/docs/GetExtendedCampaignStats.md +2 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/GetSmtpTemplateOverviewSender.md +1 -0
- data/docs/GetSmtpTemplates.md +1 -1
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +8 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/ListsApi.md +13 -13
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemainingCreditModelChild.md +2 -2
- data/docs/RemainingCreditModelReseller.md +2 -2
- data/docs/RemoveContactFromList.md +2 -2
- data/docs/RequestContactExport.md +3 -2
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +2 -2
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +215 -86
- data/docs/SMSCampaignsApi.md +24 -24
- data/docs/SMTPApi.md +350 -42
- data/docs/SendEmail.md +2 -2
- data/docs/SendReport.md +1 -1
- data/docs/SendReportEmail.md +1 -1
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendSmtpEmailBcc.md +1 -1
- data/docs/SendSmtpEmailCc.md +1 -1
- data/docs/SendSmtpEmailReplyTo.md +1 -1
- data/docs/SendSmtpEmailSender.md +1 -1
- data/docs/SendSmtpEmailTo.md +1 -1
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendersApi.md +8 -8
- data/docs/TransactionalSMSApi.md +17 -17
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateContact.md +2 -2
- data/docs/UpdateEmailCampaign.md +5 -2
- data/docs/UpdateEmailCampaignSender.md +1 -0
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/UpdateSmtpTemplateSender.md +1 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/WebhooksApi.md +1 -1
- data/lib/sib-api-v3-sdk.rb +19 -2
- data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +169 -186
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
- data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
- data/lib/sib-api-v3-sdk/api/lists_api.rb +38 -65
- data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
- data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +342 -92
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
- data/lib/sib-api-v3-sdk/api_client.rb +10 -10
- data/lib/sib-api-v3-sdk/api_error.rb +2 -2
- data/lib/sib-api-v3-sdk/configuration.rb +3 -3
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
- data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
- data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
- data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
- data/lib/sib-api-v3-sdk/models/create_contact.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
- data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
- data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
- data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
- data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
- data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
- data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
- data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
- data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
- data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
- data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
- data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
- data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
- data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
- data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
- data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
- data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
- data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
- data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
- data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +276 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
- data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
- data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
- data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
- data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
- data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +9 -14
- data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_email.rb +10 -15
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
- data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
- data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +10 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
- data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
- data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +214 -0
- data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
- data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +3 -3
- data/sib-api-v3-sdk.gemspec +5 -5
- data/spec/api/account_api_spec.rb +4 -5
- data/spec/api/attributes_api_spec.rb +10 -14
- data/spec/api/contacts_api_spec.rb +57 -68
- data/spec/api/email_campaigns_api_spec.rb +54 -28
- data/spec/api/folders_api_spec.rb +12 -18
- data/spec/api/lists_api_spec.rb +15 -24
- data/spec/api/process_api_spec.rb +4 -6
- data/spec/api/reseller_api_spec.rb +64 -52
- data/spec/api/senders_api_spec.rb +10 -16
- data/spec/api/sms_campaigns_api_spec.rb +19 -27
- data/spec/api/smtp_api_spec.rb +88 -34
- data/spec/api/transactional_sms_api_spec.rb +8 -12
- data/spec/api/webhooks_api_spec.rb +7 -12
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/ab_test_campaign_result_spec.rb +79 -0
- data/spec/models/add_child_domain_spec.rb +3 -4
- data/spec/models/add_contact_to_list_spec.rb +3 -4
- data/spec/models/add_credits_spec.rb +4 -5
- data/spec/models/create_attribute_enumeration_spec.rb +4 -5
- data/spec/models/create_attribute_spec.rb +9 -10
- data/spec/models/create_child_spec.rb +17 -8
- data/spec/models/create_contact_spec.rb +9 -10
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_email_campaign_sender_spec.rb +10 -5
- data/spec/models/create_email_campaign_spec.rb +49 -32
- data/spec/models/create_list_spec.rb +4 -5
- data/spec/models/create_model_spec.rb +3 -4
- data/spec/models/create_reseller_spec.rb +9 -4
- data/spec/models/create_sender_ips_spec.rb +5 -6
- data/spec/models/create_sender_model_spec.rb +5 -6
- data/spec/models/create_sender_spec.rb +5 -6
- data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
- data/spec/models/create_sms_campaign_spec.rb +7 -8
- data/spec/models/create_smtp_email_spec.rb +3 -4
- data/spec/models/create_smtp_template_sender_spec.rb +10 -5
- data/spec/models/create_smtp_template_spec.rb +12 -13
- data/spec/models/create_update_contact_model_spec.rb +3 -4
- data/spec/models/create_update_folder_spec.rb +3 -4
- data/spec/models/create_webhook_spec.rb +14 -15
- data/spec/models/created_process_id_spec.rb +3 -4
- data/spec/models/delete_hardbounces_spec.rb +5 -6
- data/spec/models/email_export_recipients_spec.rb +8 -9
- data/spec/models/error_model_spec.rb +8 -9
- data/spec/models/get_account_marketing_automation_spec.rb +4 -5
- data/spec/models/get_account_plan_spec.rb +16 -17
- data/spec/models/get_account_relay_data_spec.rb +5 -6
- data/spec/models/get_account_relay_spec.rb +4 -5
- data/spec/models/get_account_spec.rb +10 -11
- data/spec/models/get_aggregated_report_spec.rb +15 -16
- data/spec/models/get_attributes_attributes_spec.rb +15 -16
- data/spec/models/get_attributes_enumeration_spec.rb +4 -5
- data/spec/models/get_attributes_spec.rb +3 -4
- data/spec/models/get_campaign_overview_spec.rb +23 -24
- data/spec/models/get_campaign_recipients_spec.rb +4 -5
- data/spec/models/get_campaign_stats_spec.rb +14 -15
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +4 -5
- data/spec/models/get_child_domains_spec.rb +2 -3
- data/spec/models/get_child_info_api_keys_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
- data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
- data/spec/models/get_child_info_credits_spec.rb +4 -5
- data/spec/models/get_child_info_spec.rb +11 -12
- data/spec/models/get_child_info_statistics_spec.rb +5 -6
- data/spec/models/get_children_list_spec.rb +9 -4
- data/spec/models/get_client_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
- data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_contact_details_spec.rb +11 -12
- data/spec/models/get_contacts_spec.rb +4 -5
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_email_campaign_spec.rb +46 -41
- data/spec/models/get_email_campaigns_spec.rb +4 -5
- data/spec/models/get_email_event_report_events_spec.rb +16 -17
- data/spec/models/get_email_event_report_spec.rb +3 -4
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
- data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
- data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
- data/spec/models/get_extended_client_address_spec.rb +6 -7
- data/spec/models/get_extended_client_spec.rb +7 -8
- data/spec/models/get_extended_contact_details_spec.rb +12 -13
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
- data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
- data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
- data/spec/models/get_extended_list_spec.rb +10 -11
- data/spec/models/get_folder_lists_spec.rb +4 -5
- data/spec/models/get_folder_spec.rb +7 -8
- data/spec/models/get_folders_spec.rb +4 -5
- data/spec/models/get_ip_from_sender_spec.rb +6 -7
- data/spec/models/get_ip_spec.rb +6 -7
- data/spec/models/get_ips_from_sender_spec.rb +3 -4
- data/spec/models/get_ips_spec.rb +3 -4
- data/spec/models/get_list_spec.rb +6 -7
- data/spec/models/get_lists_spec.rb +4 -5
- data/spec/models/get_process_spec.rb +10 -11
- data/spec/models/get_processes_spec.rb +4 -5
- data/spec/models/get_reports_reports_spec.rb +15 -16
- data/spec/models/get_reports_spec.rb +3 -4
- data/spec/models/get_senders_list_ips_spec.rb +5 -6
- data/spec/models/get_senders_list_senders_spec.rb +7 -8
- data/spec/models/get_senders_list_spec.rb +3 -4
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
- data/spec/models/get_sms_campaign_spec.rb +16 -17
- data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
- data/spec/models/get_sms_campaigns_spec.rb +4 -5
- data/spec/models/get_sms_event_report_events_spec.rb +13 -14
- data/spec/models/get_sms_event_report_spec.rb +3 -4
- data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
- data/spec/models/get_smtp_template_overview_spec.rb +20 -15
- data/spec/models/get_smtp_templates_spec.rb +4 -5
- data/spec/models/get_sso_token_spec.rb +3 -4
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +2 -3
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +41 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
- data/spec/models/get_transac_sms_report_spec.rb +3 -4
- data/spec/models/get_webhook_spec.rb +13 -14
- data/spec/models/get_webhooks_spec.rb +3 -4
- data/spec/models/manage_ip_spec.rb +3 -4
- data/spec/models/post_contact_info_contacts_spec.rb +11 -6
- data/spec/models/post_contact_info_spec.rb +3 -4
- data/spec/models/post_send_failed_spec.rb +7 -8
- data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
- data/spec/models/remaining_credit_model_child_spec.rb +4 -5
- data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
- data/spec/models/remaining_credit_model_spec.rb +4 -5
- data/spec/models/remove_contact_from_list_spec.rb +4 -5
- data/spec/models/remove_credits_spec.rb +4 -5
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +11 -6
- data/spec/models/request_contact_import_new_list_spec.rb +4 -5
- data/spec/models/request_contact_import_spec.rb +11 -12
- data/spec/models/request_sms_recipient_export_spec.rb +8 -9
- data/spec/models/send_email_attachment_spec.rb +4 -5
- data/spec/models/send_email_spec.rb +11 -12
- data/spec/models/send_report_email_spec.rb +12 -13
- data/spec/models/send_report_spec.rb +8 -9
- data/spec/models/send_sms_spec.rb +7 -8
- data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
- data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
- data/spec/models/send_smtp_email_cc_spec.rb +4 -5
- data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
- data/spec/models/send_smtp_email_sender_spec.rb +4 -5
- data/spec/models/send_smtp_email_spec.rb +15 -16
- data/spec/models/send_smtp_email_to_spec.rb +4 -5
- data/spec/models/send_template_email_spec.rb +3 -4
- data/spec/models/send_test_email_spec.rb +3 -4
- data/spec/models/send_test_sms_spec.rb +3 -4
- data/spec/models/send_transac_sms_spec.rb +12 -13
- data/spec/models/update_attribute_enumeration_spec.rb +4 -5
- data/spec/models/update_attribute_spec.rb +4 -5
- data/spec/models/update_campaign_status_spec.rb +7 -8
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +3 -4
- data/spec/models/update_child_spec.rb +7 -8
- data/spec/models/update_contact_spec.rb +8 -9
- data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
- data/spec/models/update_email_campaign_sender_spec.rb +10 -5
- data/spec/models/update_email_campaign_spec.rb +49 -32
- data/spec/models/update_list_spec.rb +4 -5
- data/spec/models/update_sender_spec.rb +5 -6
- data/spec/models/update_sms_campaign_spec.rb +7 -8
- data/spec/models/update_smtp_template_sender_spec.rb +10 -5
- data/spec/models/update_smtp_template_spec.rb +12 -13
- data/spec/models/update_webhook_spec.rb +9 -10
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/spec_helper.rb +2 -2
- metadata +70 -2
@@ -1,16 +1,16 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require
|
13
|
+
require 'uri'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
class ProcessApi
|
@@ -19,32 +19,29 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
|
23
22
|
# Return the informations for a process
|
24
|
-
#
|
25
23
|
# @param process_id Id of the process
|
26
24
|
# @param [Hash] opts the optional parameters
|
27
25
|
# @return [GetProcess]
|
28
26
|
def get_process(process_id, opts = {})
|
29
27
|
data, _status_code, _headers = get_process_with_http_info(process_id, opts)
|
30
|
-
|
28
|
+
data
|
31
29
|
end
|
32
30
|
|
33
31
|
# Return the informations for a process
|
34
|
-
#
|
35
32
|
# @param process_id Id of the process
|
36
33
|
# @param [Hash] opts the optional parameters
|
37
34
|
# @return [Array<(GetProcess, Fixnum, Hash)>] GetProcess data, response status code and response headers
|
38
35
|
def get_process_with_http_info(process_id, opts = {})
|
39
36
|
if @api_client.config.debugging
|
40
|
-
@api_client.config.logger.debug
|
37
|
+
@api_client.config.logger.debug 'Calling API: ProcessApi.get_process ...'
|
41
38
|
end
|
42
39
|
# verify the required parameter 'process_id' is set
|
43
40
|
if @api_client.config.client_side_validation && process_id.nil?
|
44
41
|
fail ArgumentError, "Missing the required parameter 'process_id' when calling ProcessApi.get_process"
|
45
42
|
end
|
46
43
|
# resource path
|
47
|
-
local_var_path =
|
44
|
+
local_var_path = '/processes/{processId}'.sub('{' + 'processId' + '}', process_id.to_s)
|
48
45
|
|
49
46
|
# query parameters
|
50
47
|
query_params = {}
|
@@ -74,34 +71,31 @@ module SibApiV3Sdk
|
|
74
71
|
end
|
75
72
|
return data, status_code, headers
|
76
73
|
end
|
77
|
-
|
78
74
|
# Return all the processes for your account
|
79
|
-
#
|
80
75
|
# @param [Hash] opts the optional parameters
|
81
76
|
# @option opts [Integer] :limit Number limitation for the result returned (default to 10)
|
82
77
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
|
83
78
|
# @return [GetProcesses]
|
84
79
|
def get_processes(opts = {})
|
85
80
|
data, _status_code, _headers = get_processes_with_http_info(opts)
|
86
|
-
|
81
|
+
data
|
87
82
|
end
|
88
83
|
|
89
84
|
# Return all the processes for your account
|
90
|
-
#
|
91
85
|
# @param [Hash] opts the optional parameters
|
92
86
|
# @option opts [Integer] :limit Number limitation for the result returned
|
93
87
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
94
88
|
# @return [Array<(GetProcesses, Fixnum, Hash)>] GetProcesses data, response status code and response headers
|
95
89
|
def get_processes_with_http_info(opts = {})
|
96
90
|
if @api_client.config.debugging
|
97
|
-
@api_client.config.logger.debug
|
91
|
+
@api_client.config.logger.debug 'Calling API: ProcessApi.get_processes ...'
|
98
92
|
end
|
99
93
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
|
100
94
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, must be smaller than or equal to 50.'
|
101
95
|
end
|
102
96
|
|
103
97
|
# resource path
|
104
|
-
local_var_path =
|
98
|
+
local_var_path = '/processes'
|
105
99
|
|
106
100
|
# query parameters
|
107
101
|
query_params = {}
|
@@ -1,16 +1,16 @@
|
|
1
1
|
=begin
|
2
2
|
#SendinBlue API
|
3
3
|
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
5
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
7
7
|
Contact: contact@sendinblue.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require
|
13
|
+
require 'uri'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
class ResellerApi
|
@@ -19,38 +19,35 @@ module SibApiV3Sdk
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
|
23
22
|
# Add Email and/or SMS credits to a specific child account
|
24
|
-
#
|
25
|
-
# @param child_auth_key auth key of reseller's child
|
23
|
+
# @param child_identifier Either auth key or id of reseller's child
|
26
24
|
# @param add_credits Values to post to add credit to a specific child account
|
27
25
|
# @param [Hash] opts the optional parameters
|
28
26
|
# @return [RemainingCreditModel]
|
29
|
-
def add_credits(
|
30
|
-
data, _status_code, _headers = add_credits_with_http_info(
|
31
|
-
|
27
|
+
def add_credits(child_identifier, add_credits, opts = {})
|
28
|
+
data, _status_code, _headers = add_credits_with_http_info(child_identifier, add_credits, opts)
|
29
|
+
data
|
32
30
|
end
|
33
31
|
|
34
32
|
# Add Email and/or SMS credits to a specific child account
|
35
|
-
#
|
36
|
-
# @param child_auth_key auth key of reseller's child
|
33
|
+
# @param child_identifier Either auth key or id of reseller's child
|
37
34
|
# @param add_credits Values to post to add credit to a specific child account
|
38
35
|
# @param [Hash] opts the optional parameters
|
39
36
|
# @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
|
40
|
-
def add_credits_with_http_info(
|
37
|
+
def add_credits_with_http_info(child_identifier, add_credits, opts = {})
|
41
38
|
if @api_client.config.debugging
|
42
|
-
@api_client.config.logger.debug
|
39
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.add_credits ...'
|
43
40
|
end
|
44
|
-
# verify the required parameter '
|
45
|
-
if @api_client.config.client_side_validation &&
|
46
|
-
fail ArgumentError, "Missing the required parameter '
|
41
|
+
# verify the required parameter 'child_identifier' is set
|
42
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.add_credits"
|
47
44
|
end
|
48
45
|
# verify the required parameter 'add_credits' is set
|
49
46
|
if @api_client.config.client_side_validation && add_credits.nil?
|
50
47
|
fail ArgumentError, "Missing the required parameter 'add_credits' when calling ResellerApi.add_credits"
|
51
48
|
end
|
52
49
|
# resource path
|
53
|
-
local_var_path =
|
50
|
+
local_var_path = '/reseller/children/{childIdentifier}/credits/add'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
54
51
|
|
55
52
|
# query parameters
|
56
53
|
query_params = {}
|
@@ -80,38 +77,35 @@ module SibApiV3Sdk
|
|
80
77
|
end
|
81
78
|
return data, status_code, headers
|
82
79
|
end
|
83
|
-
|
84
80
|
# Associate a dedicated IP to the child
|
85
|
-
#
|
86
|
-
# @param child_auth_key auth key of reseller's child
|
81
|
+
# @param child_identifier Either auth key or id of reseller's child
|
87
82
|
# @param ip IP to associate
|
88
83
|
# @param [Hash] opts the optional parameters
|
89
84
|
# @return [nil]
|
90
|
-
def associate_ip_to_child(
|
91
|
-
associate_ip_to_child_with_http_info(
|
92
|
-
|
85
|
+
def associate_ip_to_child(child_identifier, ip, opts = {})
|
86
|
+
associate_ip_to_child_with_http_info(child_identifier, ip, opts)
|
87
|
+
nil
|
93
88
|
end
|
94
89
|
|
95
90
|
# Associate a dedicated IP to the child
|
96
|
-
#
|
97
|
-
# @param child_auth_key auth key of reseller's child
|
91
|
+
# @param child_identifier Either auth key or id of reseller's child
|
98
92
|
# @param ip IP to associate
|
99
93
|
# @param [Hash] opts the optional parameters
|
100
94
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
101
|
-
def associate_ip_to_child_with_http_info(
|
95
|
+
def associate_ip_to_child_with_http_info(child_identifier, ip, opts = {})
|
102
96
|
if @api_client.config.debugging
|
103
|
-
@api_client.config.logger.debug
|
97
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.associate_ip_to_child ...'
|
104
98
|
end
|
105
|
-
# verify the required parameter '
|
106
|
-
if @api_client.config.client_side_validation &&
|
107
|
-
fail ArgumentError, "Missing the required parameter '
|
99
|
+
# verify the required parameter 'child_identifier' is set
|
100
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
101
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.associate_ip_to_child"
|
108
102
|
end
|
109
103
|
# verify the required parameter 'ip' is set
|
110
104
|
if @api_client.config.client_side_validation && ip.nil?
|
111
105
|
fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.associate_ip_to_child"
|
112
106
|
end
|
113
107
|
# resource path
|
114
|
-
local_var_path =
|
108
|
+
local_var_path = '/reseller/children/{childIdentifier}/ips/associate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
115
109
|
|
116
110
|
# query parameters
|
117
111
|
query_params = {}
|
@@ -140,38 +134,35 @@ module SibApiV3Sdk
|
|
140
134
|
end
|
141
135
|
return data, status_code, headers
|
142
136
|
end
|
143
|
-
|
144
|
-
#
|
145
|
-
#
|
146
|
-
# @param child_auth_key auth key of reseller's child
|
147
|
-
# @param add_child_domain Sender domain to add for a specific child account
|
137
|
+
# Create a domain for a child account
|
138
|
+
# @param child_identifier Either auth key or id of reseller's child
|
139
|
+
# @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
148
140
|
# @param [Hash] opts the optional parameters
|
149
141
|
# @return [nil]
|
150
|
-
def create_child_domain(
|
151
|
-
create_child_domain_with_http_info(
|
152
|
-
|
142
|
+
def create_child_domain(child_identifier, add_child_domain, opts = {})
|
143
|
+
create_child_domain_with_http_info(child_identifier, add_child_domain, opts)
|
144
|
+
nil
|
153
145
|
end
|
154
146
|
|
155
|
-
#
|
156
|
-
#
|
157
|
-
# @param
|
158
|
-
# @param add_child_domain Sender domain to add for a specific child account
|
147
|
+
# Create a domain for a child account
|
148
|
+
# @param child_identifier Either auth key or id of reseller's child
|
149
|
+
# @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
159
150
|
# @param [Hash] opts the optional parameters
|
160
151
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
161
|
-
def create_child_domain_with_http_info(
|
152
|
+
def create_child_domain_with_http_info(child_identifier, add_child_domain, opts = {})
|
162
153
|
if @api_client.config.debugging
|
163
|
-
@api_client.config.logger.debug
|
154
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.create_child_domain ...'
|
164
155
|
end
|
165
|
-
# verify the required parameter '
|
166
|
-
if @api_client.config.client_side_validation &&
|
167
|
-
fail ArgumentError, "Missing the required parameter '
|
156
|
+
# verify the required parameter 'child_identifier' is set
|
157
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
158
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.create_child_domain"
|
168
159
|
end
|
169
160
|
# verify the required parameter 'add_child_domain' is set
|
170
161
|
if @api_client.config.client_side_validation && add_child_domain.nil?
|
171
162
|
fail ArgumentError, "Missing the required parameter 'add_child_domain' when calling ResellerApi.create_child_domain"
|
172
163
|
end
|
173
164
|
# resource path
|
174
|
-
local_var_path =
|
165
|
+
local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
175
166
|
|
176
167
|
# query parameters
|
177
168
|
query_params = {}
|
@@ -200,28 +191,25 @@ module SibApiV3Sdk
|
|
200
191
|
end
|
201
192
|
return data, status_code, headers
|
202
193
|
end
|
203
|
-
|
204
194
|
# Creates a reseller child
|
205
|
-
#
|
206
195
|
# @param [Hash] opts the optional parameters
|
207
196
|
# @option opts [CreateChild] :reseller_child reseller child to add
|
208
197
|
# @return [CreateReseller]
|
209
198
|
def create_reseller_child(opts = {})
|
210
199
|
data, _status_code, _headers = create_reseller_child_with_http_info(opts)
|
211
|
-
|
200
|
+
data
|
212
201
|
end
|
213
202
|
|
214
203
|
# Creates a reseller child
|
215
|
-
#
|
216
204
|
# @param [Hash] opts the optional parameters
|
217
205
|
# @option opts [CreateChild] :reseller_child reseller child to add
|
218
206
|
# @return [Array<(CreateReseller, Fixnum, Hash)>] CreateReseller data, response status code and response headers
|
219
207
|
def create_reseller_child_with_http_info(opts = {})
|
220
208
|
if @api_client.config.debugging
|
221
|
-
@api_client.config.logger.debug
|
209
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.create_reseller_child ...'
|
222
210
|
end
|
223
211
|
# resource path
|
224
|
-
local_var_path =
|
212
|
+
local_var_path = '/reseller/children'
|
225
213
|
|
226
214
|
# query parameters
|
227
215
|
query_params = {}
|
@@ -251,38 +239,35 @@ module SibApiV3Sdk
|
|
251
239
|
end
|
252
240
|
return data, status_code, headers
|
253
241
|
end
|
254
|
-
|
255
|
-
#
|
256
|
-
#
|
257
|
-
# @param child_auth_key auth key of reseller's child
|
242
|
+
# Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
243
|
+
# @param child_identifier Either auth key or id of reseller's child
|
258
244
|
# @param domain_name Pass the existing domain that needs to be deleted
|
259
245
|
# @param [Hash] opts the optional parameters
|
260
246
|
# @return [nil]
|
261
|
-
def delete_child_domain(
|
262
|
-
delete_child_domain_with_http_info(
|
263
|
-
|
247
|
+
def delete_child_domain(child_identifier, domain_name, opts = {})
|
248
|
+
delete_child_domain_with_http_info(child_identifier, domain_name, opts)
|
249
|
+
nil
|
264
250
|
end
|
265
251
|
|
266
|
-
#
|
267
|
-
#
|
268
|
-
# @param child_auth_key auth key of reseller's child
|
252
|
+
# Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
253
|
+
# @param child_identifier Either auth key or id of reseller's child
|
269
254
|
# @param domain_name Pass the existing domain that needs to be deleted
|
270
255
|
# @param [Hash] opts the optional parameters
|
271
256
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
272
|
-
def delete_child_domain_with_http_info(
|
257
|
+
def delete_child_domain_with_http_info(child_identifier, domain_name, opts = {})
|
273
258
|
if @api_client.config.debugging
|
274
|
-
@api_client.config.logger.debug
|
259
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.delete_child_domain ...'
|
275
260
|
end
|
276
|
-
# verify the required parameter '
|
277
|
-
if @api_client.config.client_side_validation &&
|
278
|
-
fail ArgumentError, "Missing the required parameter '
|
261
|
+
# verify the required parameter 'child_identifier' is set
|
262
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
263
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_child_domain"
|
279
264
|
end
|
280
265
|
# verify the required parameter 'domain_name' is set
|
281
266
|
if @api_client.config.client_side_validation && domain_name.nil?
|
282
267
|
fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.delete_child_domain"
|
283
268
|
end
|
284
269
|
# resource path
|
285
|
-
local_var_path =
|
270
|
+
local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
|
286
271
|
|
287
272
|
# query parameters
|
288
273
|
query_params = {}
|
@@ -311,32 +296,29 @@ module SibApiV3Sdk
|
|
311
296
|
end
|
312
297
|
return data, status_code, headers
|
313
298
|
end
|
314
|
-
|
315
|
-
#
|
316
|
-
#
|
317
|
-
# @param child_auth_key auth key of reseller's child
|
299
|
+
# Delete a single reseller child based on the child identifier supplied
|
300
|
+
# @param child_identifier Either auth key or child id of reseller's child
|
318
301
|
# @param [Hash] opts the optional parameters
|
319
302
|
# @return [nil]
|
320
|
-
def delete_reseller_child(
|
321
|
-
delete_reseller_child_with_http_info(
|
322
|
-
|
303
|
+
def delete_reseller_child(child_identifier, opts = {})
|
304
|
+
delete_reseller_child_with_http_info(child_identifier, opts)
|
305
|
+
nil
|
323
306
|
end
|
324
307
|
|
325
|
-
#
|
326
|
-
#
|
327
|
-
# @param child_auth_key auth key of reseller's child
|
308
|
+
# Delete a single reseller child based on the child identifier supplied
|
309
|
+
# @param child_identifier Either auth key or child id of reseller's child
|
328
310
|
# @param [Hash] opts the optional parameters
|
329
311
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
330
|
-
def delete_reseller_child_with_http_info(
|
312
|
+
def delete_reseller_child_with_http_info(child_identifier, opts = {})
|
331
313
|
if @api_client.config.debugging
|
332
|
-
@api_client.config.logger.debug
|
314
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.delete_reseller_child ...'
|
333
315
|
end
|
334
|
-
# verify the required parameter '
|
335
|
-
if @api_client.config.client_side_validation &&
|
336
|
-
fail ArgumentError, "Missing the required parameter '
|
316
|
+
# verify the required parameter 'child_identifier' is set
|
317
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
318
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_reseller_child"
|
337
319
|
end
|
338
320
|
# resource path
|
339
|
-
local_var_path =
|
321
|
+
local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
340
322
|
|
341
323
|
# query parameters
|
342
324
|
query_params = {}
|
@@ -365,38 +347,35 @@ module SibApiV3Sdk
|
|
365
347
|
end
|
366
348
|
return data, status_code, headers
|
367
349
|
end
|
368
|
-
|
369
350
|
# Dissociate a dedicated IP to the child
|
370
|
-
#
|
371
|
-
# @param child_auth_key auth key of reseller's child
|
351
|
+
# @param child_identifier Either auth key or id of reseller's child
|
372
352
|
# @param ip IP to dissociate
|
373
353
|
# @param [Hash] opts the optional parameters
|
374
354
|
# @return [nil]
|
375
|
-
def dissociate_ip_from_child(
|
376
|
-
dissociate_ip_from_child_with_http_info(
|
377
|
-
|
355
|
+
def dissociate_ip_from_child(child_identifier, ip, opts = {})
|
356
|
+
dissociate_ip_from_child_with_http_info(child_identifier, ip, opts)
|
357
|
+
nil
|
378
358
|
end
|
379
359
|
|
380
360
|
# Dissociate a dedicated IP to the child
|
381
|
-
#
|
382
|
-
# @param child_auth_key auth key of reseller's child
|
361
|
+
# @param child_identifier Either auth key or id of reseller's child
|
383
362
|
# @param ip IP to dissociate
|
384
363
|
# @param [Hash] opts the optional parameters
|
385
364
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
386
|
-
def dissociate_ip_from_child_with_http_info(
|
365
|
+
def dissociate_ip_from_child_with_http_info(child_identifier, ip, opts = {})
|
387
366
|
if @api_client.config.debugging
|
388
|
-
@api_client.config.logger.debug
|
367
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.dissociate_ip_from_child ...'
|
389
368
|
end
|
390
|
-
# verify the required parameter '
|
391
|
-
if @api_client.config.client_side_validation &&
|
392
|
-
fail ArgumentError, "Missing the required parameter '
|
369
|
+
# verify the required parameter 'child_identifier' is set
|
370
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
371
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.dissociate_ip_from_child"
|
393
372
|
end
|
394
373
|
# verify the required parameter 'ip' is set
|
395
374
|
if @api_client.config.client_side_validation && ip.nil?
|
396
375
|
fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.dissociate_ip_from_child"
|
397
376
|
end
|
398
377
|
# resource path
|
399
|
-
local_var_path =
|
378
|
+
local_var_path = '/reseller/children/{childIdentifier}/ips/dissociate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
400
379
|
|
401
380
|
# query parameters
|
402
381
|
query_params = {}
|
@@ -425,32 +404,81 @@ module SibApiV3Sdk
|
|
425
404
|
end
|
426
405
|
return data, status_code, headers
|
427
406
|
end
|
407
|
+
# Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
408
|
+
# @param child_identifier Either auth key or id of reseller's child
|
409
|
+
# @param [Hash] opts the optional parameters
|
410
|
+
# @return [GetChildAccountCreationStatus]
|
411
|
+
def get_child_account_creation_status(child_identifier, opts = {})
|
412
|
+
data, _status_code, _headers = get_child_account_creation_status_with_http_info(child_identifier, opts)
|
413
|
+
data
|
414
|
+
end
|
415
|
+
|
416
|
+
# Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
417
|
+
# @param child_identifier Either auth key or id of reseller's child
|
418
|
+
# @param [Hash] opts the optional parameters
|
419
|
+
# @return [Array<(GetChildAccountCreationStatus, Fixnum, Hash)>] GetChildAccountCreationStatus data, response status code and response headers
|
420
|
+
def get_child_account_creation_status_with_http_info(child_identifier, opts = {})
|
421
|
+
if @api_client.config.debugging
|
422
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.get_child_account_creation_status ...'
|
423
|
+
end
|
424
|
+
# verify the required parameter 'child_identifier' is set
|
425
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
426
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_account_creation_status"
|
427
|
+
end
|
428
|
+
# resource path
|
429
|
+
local_var_path = '/reseller/children/{childIdentifier}/accountCreationStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
430
|
+
|
431
|
+
# query parameters
|
432
|
+
query_params = {}
|
433
|
+
|
434
|
+
# header parameters
|
435
|
+
header_params = {}
|
436
|
+
# HTTP header 'Accept' (if needed)
|
437
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
438
|
+
# HTTP header 'Content-Type'
|
439
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
428
440
|
|
429
|
-
|
430
|
-
|
431
|
-
|
441
|
+
# form parameters
|
442
|
+
form_params = {}
|
443
|
+
|
444
|
+
# http body (model)
|
445
|
+
post_body = nil
|
446
|
+
auth_names = ['api-key', 'partner-key']
|
447
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
448
|
+
:header_params => header_params,
|
449
|
+
:query_params => query_params,
|
450
|
+
:form_params => form_params,
|
451
|
+
:body => post_body,
|
452
|
+
:auth_names => auth_names,
|
453
|
+
:return_type => 'GetChildAccountCreationStatus')
|
454
|
+
if @api_client.config.debugging
|
455
|
+
@api_client.config.logger.debug "API called: ResellerApi#get_child_account_creation_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
456
|
+
end
|
457
|
+
return data, status_code, headers
|
458
|
+
end
|
459
|
+
# Get all sender domains for a specific child account
|
460
|
+
# @param child_identifier Either auth key or id of reseller's child
|
432
461
|
# @param [Hash] opts the optional parameters
|
433
462
|
# @return [GetChildDomains]
|
434
|
-
def get_child_domains(
|
435
|
-
data, _status_code, _headers = get_child_domains_with_http_info(
|
436
|
-
|
463
|
+
def get_child_domains(child_identifier, opts = {})
|
464
|
+
data, _status_code, _headers = get_child_domains_with_http_info(child_identifier, opts)
|
465
|
+
data
|
437
466
|
end
|
438
467
|
|
439
|
-
#
|
440
|
-
#
|
441
|
-
# @param child_auth_key auth key of reseller's child
|
468
|
+
# Get all sender domains for a specific child account
|
469
|
+
# @param child_identifier Either auth key or id of reseller's child
|
442
470
|
# @param [Hash] opts the optional parameters
|
443
471
|
# @return [Array<(GetChildDomains, Fixnum, Hash)>] GetChildDomains data, response status code and response headers
|
444
|
-
def get_child_domains_with_http_info(
|
472
|
+
def get_child_domains_with_http_info(child_identifier, opts = {})
|
445
473
|
if @api_client.config.debugging
|
446
|
-
@api_client.config.logger.debug
|
474
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.get_child_domains ...'
|
447
475
|
end
|
448
|
-
# verify the required parameter '
|
449
|
-
if @api_client.config.client_side_validation &&
|
450
|
-
fail ArgumentError, "Missing the required parameter '
|
476
|
+
# verify the required parameter 'child_identifier' is set
|
477
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
478
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_domains"
|
451
479
|
end
|
452
480
|
# resource path
|
453
|
-
local_var_path =
|
481
|
+
local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
454
482
|
|
455
483
|
# query parameters
|
456
484
|
query_params = {}
|
@@ -480,32 +508,29 @@ module SibApiV3Sdk
|
|
480
508
|
end
|
481
509
|
return data, status_code, headers
|
482
510
|
end
|
483
|
-
|
484
|
-
#
|
485
|
-
#
|
486
|
-
# @param child_auth_key auth key of reseller's child
|
511
|
+
# Get a child account's details
|
512
|
+
# @param child_identifier Either auth key or id of reseller's child
|
487
513
|
# @param [Hash] opts the optional parameters
|
488
514
|
# @return [GetChildInfo]
|
489
|
-
def get_child_info(
|
490
|
-
data, _status_code, _headers = get_child_info_with_http_info(
|
491
|
-
|
515
|
+
def get_child_info(child_identifier, opts = {})
|
516
|
+
data, _status_code, _headers = get_child_info_with_http_info(child_identifier, opts)
|
517
|
+
data
|
492
518
|
end
|
493
519
|
|
494
|
-
#
|
495
|
-
#
|
496
|
-
# @param child_auth_key auth key of reseller's child
|
520
|
+
# Get a child account's details
|
521
|
+
# @param child_identifier Either auth key or id of reseller's child
|
497
522
|
# @param [Hash] opts the optional parameters
|
498
523
|
# @return [Array<(GetChildInfo, Fixnum, Hash)>] GetChildInfo data, response status code and response headers
|
499
|
-
def get_child_info_with_http_info(
|
524
|
+
def get_child_info_with_http_info(child_identifier, opts = {})
|
500
525
|
if @api_client.config.debugging
|
501
|
-
@api_client.config.logger.debug
|
526
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.get_child_info ...'
|
502
527
|
end
|
503
|
-
# verify the required parameter '
|
504
|
-
if @api_client.config.client_side_validation &&
|
505
|
-
fail ArgumentError, "Missing the required parameter '
|
528
|
+
# verify the required parameter 'child_identifier' is set
|
529
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
530
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_info"
|
506
531
|
end
|
507
532
|
# resource path
|
508
|
-
local_var_path =
|
533
|
+
local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
509
534
|
|
510
535
|
# query parameters
|
511
536
|
query_params = {}
|
@@ -535,29 +560,36 @@ module SibApiV3Sdk
|
|
535
560
|
end
|
536
561
|
return data, status_code, headers
|
537
562
|
end
|
538
|
-
|
539
|
-
# Gets the list of all reseller's children accounts
|
540
|
-
#
|
563
|
+
# Get the list of all children accounts
|
541
564
|
# @param [Hash] opts the optional parameters
|
565
|
+
# @option opts [Integer] :limit Number of documents for child accounts information per page (default to 10)
|
566
|
+
# @option opts [Integer] :offset Index of the first document in the page (default to 0)
|
542
567
|
# @return [GetChildrenList]
|
543
568
|
def get_reseller_childs(opts = {})
|
544
569
|
data, _status_code, _headers = get_reseller_childs_with_http_info(opts)
|
545
|
-
|
570
|
+
data
|
546
571
|
end
|
547
572
|
|
548
|
-
#
|
549
|
-
#
|
573
|
+
# Get the list of all children accounts
|
550
574
|
# @param [Hash] opts the optional parameters
|
575
|
+
# @option opts [Integer] :limit Number of documents for child accounts information per page
|
576
|
+
# @option opts [Integer] :offset Index of the first document in the page
|
551
577
|
# @return [Array<(GetChildrenList, Fixnum, Hash)>] GetChildrenList data, response status code and response headers
|
552
578
|
def get_reseller_childs_with_http_info(opts = {})
|
553
579
|
if @api_client.config.debugging
|
554
|
-
@api_client.config.logger.debug
|
580
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.get_reseller_childs ...'
|
581
|
+
end
|
582
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 20
|
583
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ResellerApi.get_reseller_childs, must be smaller than or equal to 20.'
|
555
584
|
end
|
585
|
+
|
556
586
|
# resource path
|
557
|
-
local_var_path =
|
587
|
+
local_var_path = '/reseller/children'
|
558
588
|
|
559
589
|
# query parameters
|
560
590
|
query_params = {}
|
591
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
592
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
561
593
|
|
562
594
|
# header parameters
|
563
595
|
header_params = {}
|
@@ -584,32 +616,31 @@ module SibApiV3Sdk
|
|
584
616
|
end
|
585
617
|
return data, status_code, headers
|
586
618
|
end
|
587
|
-
|
588
|
-
#
|
589
|
-
#
|
590
|
-
# @param child_auth_key auth key of reseller's child
|
619
|
+
# Get session token to access Sendinblue (SSO)
|
620
|
+
# It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
621
|
+
# @param child_identifier Either auth key or id of reseller's child
|
591
622
|
# @param [Hash] opts the optional parameters
|
592
623
|
# @return [GetSsoToken]
|
593
|
-
def get_sso_token(
|
594
|
-
data, _status_code, _headers = get_sso_token_with_http_info(
|
595
|
-
|
624
|
+
def get_sso_token(child_identifier, opts = {})
|
625
|
+
data, _status_code, _headers = get_sso_token_with_http_info(child_identifier, opts)
|
626
|
+
data
|
596
627
|
end
|
597
628
|
|
598
|
-
#
|
599
|
-
#
|
600
|
-
# @param
|
629
|
+
# Get session token to access Sendinblue (SSO)
|
630
|
+
# It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
631
|
+
# @param child_identifier Either auth key or id of reseller's child
|
601
632
|
# @param [Hash] opts the optional parameters
|
602
633
|
# @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
|
603
|
-
def get_sso_token_with_http_info(
|
634
|
+
def get_sso_token_with_http_info(child_identifier, opts = {})
|
604
635
|
if @api_client.config.debugging
|
605
|
-
@api_client.config.logger.debug
|
636
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.get_sso_token ...'
|
606
637
|
end
|
607
|
-
# verify the required parameter '
|
608
|
-
if @api_client.config.client_side_validation &&
|
609
|
-
fail ArgumentError, "Missing the required parameter '
|
638
|
+
# verify the required parameter 'child_identifier' is set
|
639
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
640
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_sso_token"
|
610
641
|
end
|
611
642
|
# resource path
|
612
|
-
local_var_path =
|
643
|
+
local_var_path = '/reseller/children/{childIdentifier}/auth'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
613
644
|
|
614
645
|
# query parameters
|
615
646
|
query_params = {}
|
@@ -639,38 +670,35 @@ module SibApiV3Sdk
|
|
639
670
|
end
|
640
671
|
return data, status_code, headers
|
641
672
|
end
|
642
|
-
|
643
673
|
# Remove Email and/or SMS credits from a specific child account
|
644
|
-
#
|
645
|
-
# @param child_auth_key auth key of reseller's child
|
674
|
+
# @param child_identifier Either auth key or id of reseller's child
|
646
675
|
# @param remove_credits Values to post to remove email or SMS credits from a specific child account
|
647
676
|
# @param [Hash] opts the optional parameters
|
648
677
|
# @return [RemainingCreditModel]
|
649
|
-
def remove_credits(
|
650
|
-
data, _status_code, _headers = remove_credits_with_http_info(
|
651
|
-
|
678
|
+
def remove_credits(child_identifier, remove_credits, opts = {})
|
679
|
+
data, _status_code, _headers = remove_credits_with_http_info(child_identifier, remove_credits, opts)
|
680
|
+
data
|
652
681
|
end
|
653
682
|
|
654
683
|
# Remove Email and/or SMS credits from a specific child account
|
655
|
-
#
|
656
|
-
# @param child_auth_key auth key of reseller's child
|
684
|
+
# @param child_identifier Either auth key or id of reseller's child
|
657
685
|
# @param remove_credits Values to post to remove email or SMS credits from a specific child account
|
658
686
|
# @param [Hash] opts the optional parameters
|
659
687
|
# @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
|
660
|
-
def remove_credits_with_http_info(
|
688
|
+
def remove_credits_with_http_info(child_identifier, remove_credits, opts = {})
|
661
689
|
if @api_client.config.debugging
|
662
|
-
@api_client.config.logger.debug
|
690
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.remove_credits ...'
|
663
691
|
end
|
664
|
-
# verify the required parameter '
|
665
|
-
if @api_client.config.client_side_validation &&
|
666
|
-
fail ArgumentError, "Missing the required parameter '
|
692
|
+
# verify the required parameter 'child_identifier' is set
|
693
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
694
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.remove_credits"
|
667
695
|
end
|
668
696
|
# verify the required parameter 'remove_credits' is set
|
669
697
|
if @api_client.config.client_side_validation && remove_credits.nil?
|
670
698
|
fail ArgumentError, "Missing the required parameter 'remove_credits' when calling ResellerApi.remove_credits"
|
671
699
|
end
|
672
700
|
# resource path
|
673
|
-
local_var_path =
|
701
|
+
local_var_path = '/reseller/children/{childIdentifier}/credits/remove'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
674
702
|
|
675
703
|
# query parameters
|
676
704
|
query_params = {}
|
@@ -700,33 +728,87 @@ module SibApiV3Sdk
|
|
700
728
|
end
|
701
729
|
return data, status_code, headers
|
702
730
|
end
|
731
|
+
# Update info of reseller's child account status based on the childIdentifier supplied
|
732
|
+
# @param child_identifier Either auth key or id of reseller's child
|
733
|
+
# @param update_child_account_status values to update in child account status
|
734
|
+
# @param [Hash] opts the optional parameters
|
735
|
+
# @return [nil]
|
736
|
+
def update_child_account_status(child_identifier, update_child_account_status, opts = {})
|
737
|
+
update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts)
|
738
|
+
nil
|
739
|
+
end
|
740
|
+
|
741
|
+
# Update info of reseller's child account status based on the childIdentifier supplied
|
742
|
+
# @param child_identifier Either auth key or id of reseller's child
|
743
|
+
# @param update_child_account_status values to update in child account status
|
744
|
+
# @param [Hash] opts the optional parameters
|
745
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
746
|
+
def update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts = {})
|
747
|
+
if @api_client.config.debugging
|
748
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.update_child_account_status ...'
|
749
|
+
end
|
750
|
+
# verify the required parameter 'child_identifier' is set
|
751
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
752
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_account_status"
|
753
|
+
end
|
754
|
+
# verify the required parameter 'update_child_account_status' is set
|
755
|
+
if @api_client.config.client_side_validation && update_child_account_status.nil?
|
756
|
+
fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
|
757
|
+
end
|
758
|
+
# resource path
|
759
|
+
local_var_path = '/reseller/children/{childIdentifier}/accountStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
760
|
+
|
761
|
+
# query parameters
|
762
|
+
query_params = {}
|
763
|
+
|
764
|
+
# header parameters
|
765
|
+
header_params = {}
|
766
|
+
# HTTP header 'Accept' (if needed)
|
767
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
768
|
+
# HTTP header 'Content-Type'
|
769
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
703
770
|
|
704
|
-
|
705
|
-
|
706
|
-
|
771
|
+
# form parameters
|
772
|
+
form_params = {}
|
773
|
+
|
774
|
+
# http body (model)
|
775
|
+
post_body = @api_client.object_to_http_body(update_child_account_status)
|
776
|
+
auth_names = ['api-key', 'partner-key']
|
777
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
778
|
+
:header_params => header_params,
|
779
|
+
:query_params => query_params,
|
780
|
+
:form_params => form_params,
|
781
|
+
:body => post_body,
|
782
|
+
:auth_names => auth_names)
|
783
|
+
if @api_client.config.debugging
|
784
|
+
@api_client.config.logger.debug "API called: ResellerApi#update_child_account_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
785
|
+
end
|
786
|
+
return data, status_code, headers
|
787
|
+
end
|
788
|
+
# Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
789
|
+
# @param child_identifier Either auth key or id of reseller's child
|
707
790
|
# @param domain_name Pass the existing domain that needs to be updated
|
708
791
|
# @param update_child_domain value to update for sender domain
|
709
792
|
# @param [Hash] opts the optional parameters
|
710
793
|
# @return [nil]
|
711
|
-
def update_child_domain(
|
712
|
-
update_child_domain_with_http_info(
|
713
|
-
|
794
|
+
def update_child_domain(child_identifier, domain_name, update_child_domain, opts = {})
|
795
|
+
update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts)
|
796
|
+
nil
|
714
797
|
end
|
715
798
|
|
716
|
-
#
|
717
|
-
#
|
718
|
-
# @param child_auth_key auth key of reseller's child
|
799
|
+
# Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
800
|
+
# @param child_identifier Either auth key or id of reseller's child
|
719
801
|
# @param domain_name Pass the existing domain that needs to be updated
|
720
802
|
# @param update_child_domain value to update for sender domain
|
721
803
|
# @param [Hash] opts the optional parameters
|
722
804
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
723
|
-
def update_child_domain_with_http_info(
|
805
|
+
def update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts = {})
|
724
806
|
if @api_client.config.debugging
|
725
|
-
@api_client.config.logger.debug
|
807
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.update_child_domain ...'
|
726
808
|
end
|
727
|
-
# verify the required parameter '
|
728
|
-
if @api_client.config.client_side_validation &&
|
729
|
-
fail ArgumentError, "Missing the required parameter '
|
809
|
+
# verify the required parameter 'child_identifier' is set
|
810
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
811
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_domain"
|
730
812
|
end
|
731
813
|
# verify the required parameter 'domain_name' is set
|
732
814
|
if @api_client.config.client_side_validation && domain_name.nil?
|
@@ -737,7 +819,7 @@ module SibApiV3Sdk
|
|
737
819
|
fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
|
738
820
|
end
|
739
821
|
# resource path
|
740
|
-
local_var_path =
|
822
|
+
local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
|
741
823
|
|
742
824
|
# query parameters
|
743
825
|
query_params = {}
|
@@ -766,38 +848,35 @@ module SibApiV3Sdk
|
|
766
848
|
end
|
767
849
|
return data, status_code, headers
|
768
850
|
end
|
769
|
-
|
770
|
-
#
|
771
|
-
#
|
772
|
-
# @param child_auth_key auth key of reseller's child
|
851
|
+
# Update info of reseller's child based on the child identifier supplied
|
852
|
+
# @param child_identifier Either auth key or id of reseller's child
|
773
853
|
# @param reseller_child values to update in child profile
|
774
854
|
# @param [Hash] opts the optional parameters
|
775
855
|
# @return [nil]
|
776
|
-
def update_reseller_child(
|
777
|
-
update_reseller_child_with_http_info(
|
778
|
-
|
856
|
+
def update_reseller_child(child_identifier, reseller_child, opts = {})
|
857
|
+
update_reseller_child_with_http_info(child_identifier, reseller_child, opts)
|
858
|
+
nil
|
779
859
|
end
|
780
860
|
|
781
|
-
#
|
782
|
-
#
|
783
|
-
# @param child_auth_key auth key of reseller's child
|
861
|
+
# Update info of reseller's child based on the child identifier supplied
|
862
|
+
# @param child_identifier Either auth key or id of reseller's child
|
784
863
|
# @param reseller_child values to update in child profile
|
785
864
|
# @param [Hash] opts the optional parameters
|
786
865
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
787
|
-
def update_reseller_child_with_http_info(
|
866
|
+
def update_reseller_child_with_http_info(child_identifier, reseller_child, opts = {})
|
788
867
|
if @api_client.config.debugging
|
789
|
-
@api_client.config.logger.debug
|
868
|
+
@api_client.config.logger.debug 'Calling API: ResellerApi.update_reseller_child ...'
|
790
869
|
end
|
791
|
-
# verify the required parameter '
|
792
|
-
if @api_client.config.client_side_validation &&
|
793
|
-
fail ArgumentError, "Missing the required parameter '
|
870
|
+
# verify the required parameter 'child_identifier' is set
|
871
|
+
if @api_client.config.client_side_validation && child_identifier.nil?
|
872
|
+
fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_reseller_child"
|
794
873
|
end
|
795
874
|
# verify the required parameter 'reseller_child' is set
|
796
875
|
if @api_client.config.client_side_validation && reseller_child.nil?
|
797
876
|
fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
|
798
877
|
end
|
799
878
|
# resource path
|
800
|
-
local_var_path =
|
879
|
+
local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
|
801
880
|
|
802
881
|
# query parameters
|
803
882
|
query_params = {}
|