sib-api-v3-sdk 5.2.5 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (470) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +100 -75
  5. data/docs/AbTestCampaignResult.md +15 -0
  6. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  7. data/docs/AbTestCampaignResultStatistics.md +13 -0
  8. data/docs/AbTestVersionClicks.md +7 -0
  9. data/docs/AbTestVersionClicksInner.md +10 -0
  10. data/docs/AbTestVersionStats.md +9 -0
  11. data/docs/AccountApi.md +3 -3
  12. data/docs/AddContactToList.md +2 -1
  13. data/docs/AttributesApi.md +18 -18
  14. data/docs/ContactsApi.md +136 -73
  15. data/docs/CreateAttribute.md +1 -1
  16. data/docs/CreateChild.md +1 -0
  17. data/docs/CreateContact.md +2 -2
  18. data/docs/CreateDoiContact.md +13 -0
  19. data/docs/CreateEmailCampaign.md +4 -1
  20. data/docs/CreateEmailCampaignSender.md +1 -0
  21. data/docs/CreateReseller.md +1 -0
  22. data/docs/CreateSender.md +1 -1
  23. data/docs/CreateSmsCampaign.md +1 -1
  24. data/docs/CreateSmtpTemplateSender.md +1 -0
  25. data/docs/CreateWebhook.md +2 -2
  26. data/docs/EmailCampaignsApi.md +202 -25
  27. data/docs/EmailExportRecipients.md +1 -1
  28. data/docs/FoldersApi.md +12 -12
  29. data/docs/GetAggregatedReport.md +13 -13
  30. data/docs/GetCampaignStats.md +1 -0
  31. data/docs/GetChildAccountCreationStatus.md +8 -0
  32. data/docs/GetChildrenList.md +1 -0
  33. data/docs/GetDeviceBrowserStats.md +11 -0
  34. data/docs/GetEmailCampaign.md +1 -0
  35. data/docs/GetExtendedCampaignOverview.md +1 -0
  36. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  37. data/docs/GetExtendedCampaignStats.md +2 -0
  38. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  39. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  40. data/docs/GetSharedTemplateUrl.md +8 -0
  41. data/docs/GetSmtpTemplateOverview.md +1 -0
  42. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  43. data/docs/GetStatsByBrowser.md +7 -0
  44. data/docs/GetStatsByDevice.md +11 -0
  45. data/docs/GetTransacBlockedContacts.md +9 -0
  46. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  47. data/docs/GetTransacBlockedContactsReason.md +9 -0
  48. data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
  49. data/docs/ListsApi.md +17 -17
  50. data/docs/PostContactInfoContacts.md +1 -0
  51. data/docs/RemainingCreditModelChild.md +2 -2
  52. data/docs/RemainingCreditModelReseller.md +2 -2
  53. data/docs/RemoveContactFromList.md +3 -2
  54. data/docs/RequestContactExport.md +3 -2
  55. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  56. data/docs/RequestContactImport.md +2 -2
  57. data/docs/RequestSMSRecipientExport.md +1 -1
  58. data/docs/ResellerApi.md +158 -91
  59. data/docs/SMSCampaignsApi.md +24 -24
  60. data/docs/SendEmail.md +3 -3
  61. data/docs/SendReport.md +1 -1
  62. data/docs/SendReportEmail.md +1 -5
  63. data/docs/SendSmtpEmail.md +4 -4
  64. data/docs/SendSmtpEmailBcc.md +1 -1
  65. data/docs/SendSmtpEmailCc.md +1 -1
  66. data/docs/SendSmtpEmailReplyTo.md +1 -1
  67. data/docs/SendSmtpEmailSender.md +2 -1
  68. data/docs/SendSmtpEmailTo.md +1 -1
  69. data/docs/SendTransacSms.md +2 -2
  70. data/docs/SendersApi.md +8 -8
  71. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
  72. data/docs/TransactionalSMSApi.md +17 -17
  73. data/docs/UpdateAttribute.md +1 -1
  74. data/docs/UpdateChildAccountStatus.md +1 -0
  75. data/docs/UpdateContact.md +1 -1
  76. data/docs/UpdateEmailCampaign.md +4 -1
  77. data/docs/UpdateEmailCampaignSender.md +1 -0
  78. data/docs/UpdateSmsCampaign.md +1 -1
  79. data/docs/UpdateSmtpTemplateSender.md +1 -0
  80. data/docs/UpdateWebhook.md +1 -1
  81. data/docs/UploadImageToGallery.md +9 -0
  82. data/docs/WebhooksApi.md +1 -1
  83. data/lib/sib-api-v3-sdk.rb +20 -3
  84. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  85. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  86. data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
  87. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  88. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  89. data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
  90. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  91. data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
  92. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  93. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  94. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
  95. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  96. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  97. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  98. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  99. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  100. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
  101. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  102. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  103. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  104. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  105. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  106. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  107. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
  108. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  109. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  110. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  111. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  112. data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
  113. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
  114. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
  115. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  116. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  117. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  119. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  120. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  121. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  122. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  123. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
  124. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  125. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
  126. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
  127. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  128. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  129. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  130. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  131. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  132. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  133. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  134. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  135. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  136. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  137. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  138. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
  139. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
  140. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
  141. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  142. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  143. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  144. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  145. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
  147. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  148. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  149. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  150. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  151. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  152. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  153. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  154. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  155. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  156. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  157. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  158. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  159. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  160. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  161. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  162. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  163. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  164. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  165. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  166. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  167. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  168. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  169. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  170. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  171. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  173. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  174. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  176. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  177. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  179. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  181. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  182. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
  183. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
  184. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  185. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  186. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  187. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  188. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  189. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  190. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  191. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  192. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  193. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  195. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  196. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  197. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  198. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  199. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  201. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  202. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  203. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  204. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  205. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  206. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  207. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  209. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  210. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  211. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
  212. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  213. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  214. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  215. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  216. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  217. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  218. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  219. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  220. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
  221. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
  222. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
  223. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
  224. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  225. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  226. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  227. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  228. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  229. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  230. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  231. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  232. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  234. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  235. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  236. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
  237. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  238. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  239. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  240. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  241. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  242. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  243. data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
  244. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  245. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  246. data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
  247. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  248. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  249. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  250. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  251. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  252. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  253. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
  254. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  255. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  256. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  258. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
  259. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  260. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  261. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  262. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
  264. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  265. data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
  266. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
  267. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  268. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  269. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  270. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  271. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
  272. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
  273. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  274. data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
  275. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  276. data/lib/sib-api-v3-sdk/version.rb +3 -3
  277. data/sib-api-v3-sdk.gemspec +5 -5
  278. data/spec/api/account_api_spec.rb +4 -5
  279. data/spec/api/attributes_api_spec.rb +10 -14
  280. data/spec/api/contacts_api_spec.rb +62 -73
  281. data/spec/api/email_campaigns_api_spec.rb +54 -28
  282. data/spec/api/folders_api_spec.rb +12 -18
  283. data/spec/api/lists_api_spec.rb +17 -26
  284. data/spec/api/process_api_spec.rb +4 -6
  285. data/spec/api/reseller_api_spec.rb +53 -54
  286. data/spec/api/senders_api_spec.rb +10 -16
  287. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  288. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
  289. data/spec/api/transactional_sms_api_spec.rb +8 -12
  290. data/spec/api/webhooks_api_spec.rb +7 -12
  291. data/spec/api_client_spec.rb +36 -36
  292. data/spec/configuration_spec.rb +10 -10
  293. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  294. data/spec/models/ab_test_campaign_result_spec.rb +91 -0
  295. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  296. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  297. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  298. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  299. data/spec/models/add_child_domain_spec.rb +3 -4
  300. data/spec/models/add_contact_to_list_spec.rb +9 -4
  301. data/spec/models/add_credits_spec.rb +4 -5
  302. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  303. data/spec/models/create_attribute_spec.rb +9 -10
  304. data/spec/models/create_child_spec.rb +17 -8
  305. data/spec/models/create_contact_spec.rb +9 -10
  306. data/spec/models/create_doi_contact_spec.rb +71 -0
  307. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  308. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  309. data/spec/models/create_email_campaign_spec.rb +49 -32
  310. data/spec/models/create_list_spec.rb +4 -5
  311. data/spec/models/create_model_spec.rb +3 -4
  312. data/spec/models/create_reseller_spec.rb +9 -4
  313. data/spec/models/create_sender_ips_spec.rb +5 -6
  314. data/spec/models/create_sender_model_spec.rb +5 -6
  315. data/spec/models/create_sender_spec.rb +5 -6
  316. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  317. data/spec/models/create_sms_campaign_spec.rb +7 -8
  318. data/spec/models/create_smtp_email_spec.rb +3 -4
  319. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  320. data/spec/models/create_smtp_template_spec.rb +12 -13
  321. data/spec/models/create_update_contact_model_spec.rb +3 -4
  322. data/spec/models/create_update_folder_spec.rb +3 -4
  323. data/spec/models/create_webhook_spec.rb +14 -15
  324. data/spec/models/created_process_id_spec.rb +3 -4
  325. data/spec/models/delete_hardbounces_spec.rb +5 -6
  326. data/spec/models/email_export_recipients_spec.rb +8 -9
  327. data/spec/models/error_model_spec.rb +8 -9
  328. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  329. data/spec/models/get_account_plan_spec.rb +16 -17
  330. data/spec/models/get_account_relay_data_spec.rb +5 -6
  331. data/spec/models/get_account_relay_spec.rb +4 -5
  332. data/spec/models/get_account_spec.rb +10 -11
  333. data/spec/models/get_aggregated_report_spec.rb +15 -16
  334. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  335. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  336. data/spec/models/get_attributes_spec.rb +3 -4
  337. data/spec/models/get_campaign_overview_spec.rb +23 -24
  338. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  339. data/spec/models/get_campaign_stats_spec.rb +20 -15
  340. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  341. data/spec/models/get_child_domain_spec.rb +4 -5
  342. data/spec/models/get_child_domains_spec.rb +2 -3
  343. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  344. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  345. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  346. data/spec/models/get_child_info_credits_spec.rb +4 -5
  347. data/spec/models/get_child_info_spec.rb +11 -12
  348. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  349. data/spec/models/get_children_list_spec.rb +9 -4
  350. data/spec/models/get_client_spec.rb +6 -7
  351. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  352. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  353. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  354. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  355. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  356. data/spec/models/get_contact_details_spec.rb +11 -12
  357. data/spec/models/get_contacts_spec.rb +4 -5
  358. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  359. data/spec/models/get_email_campaign_spec.rb +46 -41
  360. data/spec/models/get_email_campaigns_spec.rb +4 -5
  361. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  362. data/spec/models/get_email_event_report_spec.rb +3 -4
  363. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  364. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  365. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  366. data/spec/models/get_extended_client_address_spec.rb +6 -7
  367. data/spec/models/get_extended_client_spec.rb +7 -8
  368. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  369. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  370. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  371. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  372. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  373. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  374. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  375. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  376. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  377. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  378. data/spec/models/get_extended_list_spec.rb +10 -11
  379. data/spec/models/get_folder_lists_spec.rb +4 -5
  380. data/spec/models/get_folder_spec.rb +7 -8
  381. data/spec/models/get_folders_spec.rb +4 -5
  382. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  383. data/spec/models/get_ip_spec.rb +6 -7
  384. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  385. data/spec/models/get_ips_spec.rb +3 -4
  386. data/spec/models/get_list_spec.rb +6 -7
  387. data/spec/models/get_lists_spec.rb +4 -5
  388. data/spec/models/get_process_spec.rb +10 -11
  389. data/spec/models/get_processes_spec.rb +4 -5
  390. data/spec/models/get_reports_reports_spec.rb +15 -16
  391. data/spec/models/get_reports_spec.rb +3 -4
  392. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  393. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  394. data/spec/models/get_senders_list_spec.rb +3 -4
  395. data/spec/models/get_shared_template_url_spec.rb +41 -0
  396. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  397. data/spec/models/get_sms_campaign_spec.rb +16 -17
  398. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  399. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  400. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  401. data/spec/models/get_sms_event_report_spec.rb +3 -4
  402. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  403. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  404. data/spec/models/get_smtp_templates_spec.rb +4 -5
  405. data/spec/models/get_sso_token_spec.rb +3 -4
  406. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  407. data/spec/models/get_stats_by_device_spec.rb +59 -0
  408. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  409. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  410. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  411. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  412. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  413. data/spec/models/get_transac_email_content_events_spec.rb +4 -5
  414. data/spec/models/get_transac_email_content_spec.rb +9 -10
  415. data/spec/models/get_transac_emails_list_spec.rb +3 -4
  416. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
  417. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  418. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  419. data/spec/models/get_webhook_spec.rb +13 -14
  420. data/spec/models/get_webhooks_spec.rb +3 -4
  421. data/spec/models/manage_ip_spec.rb +3 -4
  422. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  423. data/spec/models/post_contact_info_spec.rb +3 -4
  424. data/spec/models/post_send_failed_spec.rb +7 -8
  425. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  426. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  427. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  428. data/spec/models/remaining_credit_model_spec.rb +4 -5
  429. data/spec/models/remove_contact_from_list_spec.rb +10 -5
  430. data/spec/models/remove_credits_spec.rb +4 -5
  431. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  432. data/spec/models/request_contact_export_spec.rb +11 -6
  433. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  434. data/spec/models/request_contact_import_spec.rb +11 -12
  435. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  436. data/spec/models/send_email_attachment_spec.rb +4 -5
  437. data/spec/models/send_email_spec.rb +11 -12
  438. data/spec/models/send_report_email_spec.rb +4 -33
  439. data/spec/models/send_report_spec.rb +8 -9
  440. data/spec/models/send_sms_spec.rb +7 -8
  441. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  442. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  443. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  444. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  445. data/spec/models/send_smtp_email_sender_spec.rb +10 -5
  446. data/spec/models/send_smtp_email_spec.rb +15 -16
  447. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  448. data/spec/models/send_template_email_spec.rb +3 -4
  449. data/spec/models/send_test_email_spec.rb +3 -4
  450. data/spec/models/send_test_sms_spec.rb +3 -4
  451. data/spec/models/send_transac_sms_spec.rb +12 -13
  452. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  453. data/spec/models/update_attribute_spec.rb +4 -5
  454. data/spec/models/update_campaign_status_spec.rb +7 -8
  455. data/spec/models/update_child_account_status_spec.rb +11 -6
  456. data/spec/models/update_child_domain_spec.rb +3 -4
  457. data/spec/models/update_child_spec.rb +7 -8
  458. data/spec/models/update_contact_spec.rb +8 -9
  459. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  460. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  461. data/spec/models/update_email_campaign_spec.rb +49 -32
  462. data/spec/models/update_list_spec.rb +4 -5
  463. data/spec/models/update_sender_spec.rb +5 -6
  464. data/spec/models/update_sms_campaign_spec.rb +7 -8
  465. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  466. data/spec/models/update_smtp_template_spec.rb +12 -13
  467. data/spec/models/update_webhook_spec.rb +9 -10
  468. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  469. data/spec/spec_helper.rb +2 -2
  470. metadata +78 -10
@@ -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.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
- require "uri"
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
- return data
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 "Calling API: ProcessApi.get_process ..."
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 = "/processes/{processId}".sub('{' + 'processId' + '}', process_id.to_s)
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
- return data
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 "Calling API: ProcessApi.get_processes ..."
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 = "/processes"
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.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
- require "uri"
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&#39;s child
23
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, add_credits, opts = {})
30
- data, _status_code, _headers = add_credits_with_http_info(child_auth_key, add_credits, opts)
31
- return data
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&#39;s child
33
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, add_credits, opts = {})
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 "Calling API: ResellerApi.add_credits ..."
39
+ @api_client.config.logger.debug 'Calling API: ResellerApi.add_credits ...'
43
40
  end
44
- # verify the required parameter 'child_auth_key' is set
45
- if @api_client.config.client_side_validation && child_auth_key.nil?
46
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.add_credits"
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 = "/reseller/children/{childAuthKey}/credits/add".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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&#39;s child
81
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, ip, opts = {})
91
- associate_ip_to_child_with_http_info(child_auth_key, ip, opts)
92
- return nil
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&#39;s child
91
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, ip, opts = {})
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 "Calling API: ResellerApi.associate_ip_to_child ..."
97
+ @api_client.config.logger.debug 'Calling API: ResellerApi.associate_ip_to_child ...'
104
98
  end
105
- # verify the required parameter 'child_auth_key' is set
106
- if @api_client.config.client_side_validation && child_auth_key.nil?
107
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.associate_ip_to_child"
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 = "/reseller/children/{childAuthKey}/ips/associate".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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
- # Creates a domain for a child account
145
- #
146
- # @param child_auth_key auth key of reseller&#39;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&#39;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(child_auth_key, add_child_domain, opts = {})
151
- create_child_domain_with_http_info(child_auth_key, add_child_domain, opts)
152
- return nil
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
- # Creates a domain for a child account
156
- #
157
- # @param child_auth_key auth key of reseller&#39;s child
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&#39;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(child_auth_key, add_child_domain, opts = {})
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 "Calling API: ResellerApi.create_child_domain ..."
154
+ @api_client.config.logger.debug 'Calling API: ResellerApi.create_child_domain ...'
164
155
  end
165
- # verify the required parameter 'child_auth_key' is set
166
- if @api_client.config.client_side_validation && child_auth_key.nil?
167
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.create_child_domain"
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 = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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
- return data
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 "Calling API: ResellerApi.create_reseller_child ..."
209
+ @api_client.config.logger.debug 'Calling API: ResellerApi.create_reseller_child ...'
222
210
  end
223
211
  # resource path
224
- local_var_path = "/reseller/children"
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
- # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
256
- #
257
- # @param child_auth_key auth key of reseller&#39;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&#39;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(child_auth_key, domain_name, opts = {})
262
- delete_child_domain_with_http_info(child_auth_key, domain_name, opts)
263
- return nil
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
- # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
267
- #
268
- # @param child_auth_key auth key of reseller&#39;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&#39;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(child_auth_key, domain_name, opts = {})
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 "Calling API: ResellerApi.delete_child_domain ..."
259
+ @api_client.config.logger.debug 'Calling API: ResellerApi.delete_child_domain ...'
275
260
  end
276
- # verify the required parameter 'child_auth_key' is set
277
- if @api_client.config.client_side_validation && child_auth_key.nil?
278
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_child_domain"
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 = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
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
- # Deletes a single reseller child based on the childAuthKey supplied
316
- #
317
- # @param child_auth_key auth key of reseller&#39;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&#39;s child
318
301
  # @param [Hash] opts the optional parameters
319
302
  # @return [nil]
320
- def delete_reseller_child(child_auth_key, opts = {})
321
- delete_reseller_child_with_http_info(child_auth_key, opts)
322
- return nil
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
- # Deletes a single reseller child based on the childAuthKey supplied
326
- #
327
- # @param child_auth_key auth key of reseller&#39;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&#39;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(child_auth_key, opts = {})
312
+ def delete_reseller_child_with_http_info(child_identifier, opts = {})
331
313
  if @api_client.config.debugging
332
- @api_client.config.logger.debug "Calling API: ResellerApi.delete_reseller_child ..."
314
+ @api_client.config.logger.debug 'Calling API: ResellerApi.delete_reseller_child ...'
333
315
  end
334
- # verify the required parameter 'child_auth_key' is set
335
- if @api_client.config.client_side_validation && child_auth_key.nil?
336
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_reseller_child"
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 = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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&#39;s child
351
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, ip, opts = {})
376
- dissociate_ip_from_child_with_http_info(child_auth_key, ip, opts)
377
- return nil
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&#39;s child
361
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, ip, opts = {})
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 "Calling API: ResellerApi.dissociate_ip_from_child ..."
367
+ @api_client.config.logger.debug 'Calling API: ResellerApi.dissociate_ip_from_child ...'
389
368
  end
390
- # verify the required parameter 'child_auth_key' is set
391
- if @api_client.config.client_side_validation && child_auth_key.nil?
392
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.dissociate_ip_from_child"
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 = "/reseller/children/{childAuthKey}/ips/dissociate".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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&#39;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&#39;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&#39;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
- # Gets all the sender domains of a specific child account
430
- #
431
- # @param child_auth_key auth key of reseller&#39;s child
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&#39;s child
432
461
  # @param [Hash] opts the optional parameters
433
462
  # @return [GetChildDomains]
434
- def get_child_domains(child_auth_key, opts = {})
435
- data, _status_code, _headers = get_child_domains_with_http_info(child_auth_key, opts)
436
- return data
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
- # Gets all the sender domains of a specific child account
440
- #
441
- # @param child_auth_key auth key of reseller&#39;s child
468
+ # Get all sender domains for a specific child account
469
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, opts = {})
472
+ def get_child_domains_with_http_info(child_identifier, opts = {})
445
473
  if @api_client.config.debugging
446
- @api_client.config.logger.debug "Calling API: ResellerApi.get_child_domains ..."
474
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_domains ...'
447
475
  end
448
- # verify the required parameter 'child_auth_key' is set
449
- if @api_client.config.client_side_validation && child_auth_key.nil?
450
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_domains"
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 = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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
- # Gets the info about a specific child account
485
- #
486
- # @param child_auth_key auth key of reseller&#39;s child
511
+ # Get a child account's details
512
+ # @param child_identifier Either auth key or id of reseller&#39;s child
487
513
  # @param [Hash] opts the optional parameters
488
514
  # @return [GetChildInfo]
489
- def get_child_info(child_auth_key, opts = {})
490
- data, _status_code, _headers = get_child_info_with_http_info(child_auth_key, opts)
491
- return data
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
- # Gets the info about a specific child account
495
- #
496
- # @param child_auth_key auth key of reseller&#39;s child
520
+ # Get a child account&#39;s details
521
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, opts = {})
524
+ def get_child_info_with_http_info(child_identifier, opts = {})
500
525
  if @api_client.config.debugging
501
- @api_client.config.logger.debug "Calling API: ResellerApi.get_child_info ..."
526
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_info ...'
502
527
  end
503
- # verify the required parameter 'child_auth_key' is set
504
- if @api_client.config.client_side_validation && child_auth_key.nil?
505
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_info"
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 = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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
- return data
570
+ data
546
571
  end
547
572
 
548
- # Gets the list of all reseller&#39;s children accounts
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 "Calling API: ResellerApi.get_reseller_childs ..."
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 = "/reseller/children"
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
619
  # Get session token to access Sendinblue (SSO)
589
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]
590
- # @param child_auth_key auth key of reseller&#39;s child
621
+ # @param child_identifier Either auth key or id of reseller&#39;s child
591
622
  # @param [Hash] opts the optional parameters
592
623
  # @return [GetSsoToken]
593
- def get_sso_token(child_auth_key, opts = {})
594
- data, _status_code, _headers = get_sso_token_with_http_info(child_auth_key, opts)
595
- return data
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
629
  # Get session token to access Sendinblue (SSO)
599
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 &#x3D;&gt; https:/email.mydomain.com/login/sso?token&#x3D;[token]
600
- # @param child_auth_key auth key of reseller&#39;s child
631
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, opts = {})
634
+ def get_sso_token_with_http_info(child_identifier, opts = {})
604
635
  if @api_client.config.debugging
605
- @api_client.config.logger.debug "Calling API: ResellerApi.get_sso_token ..."
636
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_sso_token ...'
606
637
  end
607
- # verify the required parameter 'child_auth_key' is set
608
- if @api_client.config.client_side_validation && child_auth_key.nil?
609
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_sso_token"
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 = "/reseller/children/{childAuthKey}/auth".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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&#39;s child
674
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, remove_credits, opts = {})
650
- data, _status_code, _headers = remove_credits_with_http_info(child_auth_key, remove_credits, opts)
651
- return data
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&#39;s child
684
+ # @param child_identifier Either auth key or id of reseller&#39;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(child_auth_key, remove_credits, opts = {})
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 "Calling API: ResellerApi.remove_credits ..."
690
+ @api_client.config.logger.debug 'Calling API: ResellerApi.remove_credits ...'
663
691
  end
664
- # verify the required parameter 'child_auth_key' is set
665
- if @api_client.config.client_side_validation && child_auth_key.nil?
666
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.remove_credits"
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 = "/reseller/children/{childAuthKey}/credits/remove".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
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,38 +728,35 @@ module SibApiV3Sdk
700
728
  end
701
729
  return data, status_code, headers
702
730
  end
703
-
704
- # Updates infos of reseller's child account status based on the childAuthKey supplied
705
- #
706
- # @param child_auth_key auth key of reseller&#39;s child
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&#39;s child
707
733
  # @param update_child_account_status values to update in child account status
708
734
  # @param [Hash] opts the optional parameters
709
735
  # @return [nil]
710
- def update_child_account_status(child_auth_key, update_child_account_status, opts = {})
711
- update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts)
712
- 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
713
739
  end
714
740
 
715
- # Updates infos of reseller&#39;s child account status based on the childAuthKey supplied
716
- #
717
- # @param child_auth_key auth key of reseller&#39;s child
741
+ # Update info of reseller&#39;s child account status based on the childIdentifier supplied
742
+ # @param child_identifier Either auth key or id of reseller&#39;s child
718
743
  # @param update_child_account_status values to update in child account status
719
744
  # @param [Hash] opts the optional parameters
720
745
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
721
- def update_child_account_status_with_http_info(child_auth_key, update_child_account_status, opts = {})
746
+ def update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts = {})
722
747
  if @api_client.config.debugging
723
- @api_client.config.logger.debug "Calling API: ResellerApi.update_child_account_status ..."
748
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_account_status ...'
724
749
  end
725
- # verify the required parameter 'child_auth_key' is set
726
- if @api_client.config.client_side_validation && child_auth_key.nil?
727
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_account_status"
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"
728
753
  end
729
754
  # verify the required parameter 'update_child_account_status' is set
730
755
  if @api_client.config.client_side_validation && update_child_account_status.nil?
731
756
  fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
732
757
  end
733
758
  # resource path
734
- local_var_path = "/reseller/children/{childAuthKey}/accountStatus".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
759
+ local_var_path = '/reseller/children/{childIdentifier}/accountStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
735
760
 
736
761
  # query parameters
737
762
  query_params = {}
@@ -760,33 +785,30 @@ module SibApiV3Sdk
760
785
  end
761
786
  return data, status_code, headers
762
787
  end
763
-
764
- # Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
765
- #
766
- # @param child_auth_key auth key of reseller&#39;s child
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&#39;s child
767
790
  # @param domain_name Pass the existing domain that needs to be updated
768
791
  # @param update_child_domain value to update for sender domain
769
792
  # @param [Hash] opts the optional parameters
770
793
  # @return [nil]
771
- def update_child_domain(child_auth_key, domain_name, update_child_domain, opts = {})
772
- update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts)
773
- return nil
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
774
797
  end
775
798
 
776
- # Updates the sender domain of reseller&#39;s child based on the childAuthKey and domainName passed
777
- #
778
- # @param child_auth_key auth key of reseller&#39;s child
799
+ # Update the sender domain of reseller&#39;s child based on the childIdentifier and domainName passed
800
+ # @param child_identifier Either auth key or id of reseller&#39;s child
779
801
  # @param domain_name Pass the existing domain that needs to be updated
780
802
  # @param update_child_domain value to update for sender domain
781
803
  # @param [Hash] opts the optional parameters
782
804
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
783
- def update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts = {})
805
+ def update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts = {})
784
806
  if @api_client.config.debugging
785
- @api_client.config.logger.debug "Calling API: ResellerApi.update_child_domain ..."
807
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_domain ...'
786
808
  end
787
- # verify the required parameter 'child_auth_key' is set
788
- if @api_client.config.client_side_validation && child_auth_key.nil?
789
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_domain"
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"
790
812
  end
791
813
  # verify the required parameter 'domain_name' is set
792
814
  if @api_client.config.client_side_validation && domain_name.nil?
@@ -797,7 +819,7 @@ module SibApiV3Sdk
797
819
  fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
798
820
  end
799
821
  # resource path
800
- local_var_path = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
822
+ local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
801
823
 
802
824
  # query parameters
803
825
  query_params = {}
@@ -826,38 +848,35 @@ module SibApiV3Sdk
826
848
  end
827
849
  return data, status_code, headers
828
850
  end
829
-
830
- # Updates infos of reseller's child based on the childAuthKey supplied
831
- #
832
- # @param child_auth_key auth key of reseller&#39;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&#39;s child
833
853
  # @param reseller_child values to update in child profile
834
854
  # @param [Hash] opts the optional parameters
835
855
  # @return [nil]
836
- def update_reseller_child(child_auth_key, reseller_child, opts = {})
837
- update_reseller_child_with_http_info(child_auth_key, reseller_child, opts)
838
- return nil
856
+ def update_reseller_child(child_identifier, reseller_child, opts = {})
857
+ update_reseller_child_with_http_info(child_identifier, reseller_child, opts)
858
+ nil
839
859
  end
840
860
 
841
- # Updates infos of reseller&#39;s child based on the childAuthKey supplied
842
- #
843
- # @param child_auth_key auth key of reseller&#39;s child
861
+ # Update info of reseller&#39;s child based on the child identifier supplied
862
+ # @param child_identifier Either auth key or id of reseller&#39;s child
844
863
  # @param reseller_child values to update in child profile
845
864
  # @param [Hash] opts the optional parameters
846
865
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
847
- def update_reseller_child_with_http_info(child_auth_key, reseller_child, opts = {})
866
+ def update_reseller_child_with_http_info(child_identifier, reseller_child, opts = {})
848
867
  if @api_client.config.debugging
849
- @api_client.config.logger.debug "Calling API: ResellerApi.update_reseller_child ..."
868
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_reseller_child ...'
850
869
  end
851
- # verify the required parameter 'child_auth_key' is set
852
- if @api_client.config.client_side_validation && child_auth_key.nil?
853
- fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_reseller_child"
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"
854
873
  end
855
874
  # verify the required parameter 'reseller_child' is set
856
875
  if @api_client.config.client_side_validation && reseller_child.nil?
857
876
  fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
858
877
  end
859
878
  # resource path
860
- local_var_path = "/reseller/children/{childAuthKey}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s)
879
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
861
880
 
862
881
  # query parameters
863
882
  query_params = {}