sib-api-v3-sdk 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (487) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +349 -0
  5. data/Rakefile +8 -0
  6. data/docs/AccountApi.md +55 -0
  7. data/docs/AddCredits.md +9 -0
  8. data/docs/AddRemoveContactToList.md +8 -0
  9. data/docs/AttributesApi.md +160 -0
  10. data/docs/ContactsApi.md +1310 -0
  11. data/docs/CreaUpdateFolder.md +8 -0
  12. data/docs/CreateAttribute.md +12 -0
  13. data/docs/CreateAttributeEnumemaration.md +9 -0
  14. data/docs/CreateChild.md +12 -0
  15. data/docs/CreateContact.md +12 -0
  16. data/docs/CreateEmailCampaign.md +25 -0
  17. data/docs/CreateEmailCampaignRecipients.md +9 -0
  18. data/docs/CreateEmailCampaignSender.md +9 -0
  19. data/docs/CreateList.md +9 -0
  20. data/docs/CreateModel.md +8 -0
  21. data/docs/CreateSender.md +10 -0
  22. data/docs/CreateSenderIps.md +10 -0
  23. data/docs/CreateSenderModel.md +10 -0
  24. data/docs/CreateSmsCampaign.md +12 -0
  25. data/docs/CreateSmsCampaignRecipients.md +9 -0
  26. data/docs/CreateSmtpEmail.md +8 -0
  27. data/docs/CreateSmtpTemplate.md +17 -0
  28. data/docs/CreateSmtpTemplateSender.md +9 -0
  29. data/docs/CreateWebhook.md +11 -0
  30. data/docs/CreatedProcessId.md +8 -0
  31. data/docs/DeleteHardbounces.md +10 -0
  32. data/docs/EmailCampaignsApi.md +557 -0
  33. data/docs/EmailExportRecipients.md +9 -0
  34. data/docs/ErrorModel.md +9 -0
  35. data/docs/FoldersApi.md +336 -0
  36. data/docs/GetAccount.md +15 -0
  37. data/docs/GetAccountMarketingAutomation.md +9 -0
  38. data/docs/GetAccountPlan.md +10 -0
  39. data/docs/GetAccountRelay.md +9 -0
  40. data/docs/GetAccountRelayData.md +10 -0
  41. data/docs/GetAggregatedReport.md +19 -0
  42. data/docs/GetAttributes.md +8 -0
  43. data/docs/GetAttributesAttributes.md +13 -0
  44. data/docs/GetAttributesEnumeration.md +9 -0
  45. data/docs/GetCampaignOverview.md +13 -0
  46. data/docs/GetCampaignRecipients.md +9 -0
  47. data/docs/GetCampaignRecipientsExclusionLists.md +9 -0
  48. data/docs/GetCampaignRecipientsLists.md +9 -0
  49. data/docs/GetCampaignStats.md +19 -0
  50. data/docs/GetChildInfo.md +16 -0
  51. data/docs/GetChildInfoApiKeys.md +10 -0
  52. data/docs/GetChildInfoCredits.md +9 -0
  53. data/docs/GetChildInfoIps.md +9 -0
  54. data/docs/GetChildInfoStatistics.md +10 -0
  55. data/docs/GetChildrenList.md +8 -0
  56. data/docs/GetClient.md +11 -0
  57. data/docs/GetContactCampaignStats.md +15 -0
  58. data/docs/GetContactCampaignStatsClicked.md +9 -0
  59. data/docs/GetContactCampaignStatsLinks.md +11 -0
  60. data/docs/GetContactCampaignStatsMessagesSent.md +9 -0
  61. data/docs/GetContactCampaignStatsOpened.md +11 -0
  62. data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
  63. data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
  64. data/docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md +9 -0
  65. data/docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md +10 -0
  66. data/docs/GetContactDetails.md +15 -0
  67. data/docs/GetContacts.md +9 -0
  68. data/docs/GetEmailCampaign.md +27 -0
  69. data/docs/GetEmailCampaigns.md +9 -0
  70. data/docs/GetEmailEventReport.md +8 -0
  71. data/docs/GetEmailEventReportEvents.md +14 -0
  72. data/docs/GetExtendedCampaignOverview.md +27 -0
  73. data/docs/GetExtendedCampaignOverviewSender.md +9 -0
  74. data/docs/GetExtendedCampaignStats.md +12 -0
  75. data/docs/GetExtendedCampaignStatsLinksStats.md +8 -0
  76. data/docs/GetExtendedClient.md +12 -0
  77. data/docs/GetExtendedClientAddress.md +11 -0
  78. data/docs/GetExtendedContactDetails.md +15 -0
  79. data/docs/GetExtendedList.md +15 -0
  80. data/docs/GetExtendedListCampaignStats.md +9 -0
  81. data/docs/GetFolder.md +12 -0
  82. data/docs/GetFolderLists.md +9 -0
  83. data/docs/GetFolders.md +9 -0
  84. data/docs/GetIp.md +11 -0
  85. data/docs/GetIpFromSender.md +11 -0
  86. data/docs/GetIps.md +8 -0
  87. data/docs/GetIpsFromSender.md +8 -0
  88. data/docs/GetList.md +11 -0
  89. data/docs/GetLists.md +9 -0
  90. data/docs/GetListsFolder.md +9 -0
  91. data/docs/GetListsLists.md +8 -0
  92. data/docs/GetProcess.md +11 -0
  93. data/docs/GetProcesses.md +9 -0
  94. data/docs/GetReports.md +8 -0
  95. data/docs/GetReportsReports.md +20 -0
  96. data/docs/GetSendersList.md +8 -0
  97. data/docs/GetSendersListIps.md +10 -0
  98. data/docs/GetSendersListSenders.md +12 -0
  99. data/docs/GetSmsCampaign.md +16 -0
  100. data/docs/GetSmsCampaignOverview.md +16 -0
  101. data/docs/GetSmsCampaignStats.md +14 -0
  102. data/docs/GetSmsCampaigns.md +9 -0
  103. data/docs/GetSmsEventReport.md +8 -0
  104. data/docs/GetSmsEventReportEvents.md +14 -0
  105. data/docs/GetSmtpTemplateOverview.md +19 -0
  106. data/docs/GetSmtpTemplateOverviewSender.md +9 -0
  107. data/docs/GetSmtpTemplates.md +9 -0
  108. data/docs/GetStatsByDomain.md +7 -0
  109. data/docs/GetTransacAggregatedSmsReport.md +17 -0
  110. data/docs/GetTransacSmsReport.md +8 -0
  111. data/docs/GetTransacSmsReportReports.md +18 -0
  112. data/docs/GetWebhook.md +14 -0
  113. data/docs/GetWebhooks.md +8 -0
  114. data/docs/ListsApi.md +509 -0
  115. data/docs/ManageIp.md +8 -0
  116. data/docs/PostContactInfo.md +8 -0
  117. data/docs/PostContactInfoContacts.md +9 -0
  118. data/docs/PostSendFailed.md +12 -0
  119. data/docs/PostSendSmsTestFailed.md +11 -0
  120. data/docs/ProcessApi.md +117 -0
  121. data/docs/RemainingCreditModel.md +9 -0
  122. data/docs/RemainingCreditModelChild.md +9 -0
  123. data/docs/RemainingCreditModelReseller.md +9 -0
  124. data/docs/RemoveCredits.md +9 -0
  125. data/docs/RequestContactExport.md +10 -0
  126. data/docs/RequestContactImport.md +12 -0
  127. data/docs/RequestContactImportNewList.md +9 -0
  128. data/docs/RequestSMSRecipientExport.md +9 -0
  129. data/docs/ResellerApi.md +491 -0
  130. data/docs/SMSCampaignsApi.md +560 -0
  131. data/docs/SMTPApi.md +642 -0
  132. data/docs/SendEmail.md +15 -0
  133. data/docs/SendEmailAttachment.md +9 -0
  134. data/docs/SendReport.md +9 -0
  135. data/docs/SendReportEmail.md +13 -0
  136. data/docs/SendSms.md +8 -0
  137. data/docs/SendSmtpEmail.md +17 -0
  138. data/docs/SendSmtpEmailAttachment.md +10 -0
  139. data/docs/SendSmtpEmailBcc.md +9 -0
  140. data/docs/SendSmtpEmailCc.md +9 -0
  141. data/docs/SendSmtpEmailReplyTo.md +9 -0
  142. data/docs/SendSmtpEmailSender.md +9 -0
  143. data/docs/SendSmtpEmailTo.md +9 -0
  144. data/docs/SendTemplateEmail.md +8 -0
  145. data/docs/SendTestEmail.md +8 -0
  146. data/docs/SendTestSms.md +8 -0
  147. data/docs/SendTransacSms.md +12 -0
  148. data/docs/SendersApi.md +326 -0
  149. data/docs/TransactionalSMSApi.md +249 -0
  150. data/docs/UpdateCampaignStatus.md +8 -0
  151. data/docs/UpdateChild.md +13 -0
  152. data/docs/UpdateContact.md +12 -0
  153. data/docs/UpdateEmailCampaign.md +24 -0
  154. data/docs/UpdateEmailCampaignRecipients.md +9 -0
  155. data/docs/UpdateEmailCampaignSender.md +9 -0
  156. data/docs/UpdateList.md +9 -0
  157. data/docs/UpdateSender.md +10 -0
  158. data/docs/UpdateSmsCampaign.md +12 -0
  159. data/docs/UpdateSmtpTemplate.md +17 -0
  160. data/docs/UpdateSmtpTemplateSender.md +9 -0
  161. data/docs/UpdateWebhook.md +10 -0
  162. data/docs/WebhooksApi.md +275 -0
  163. data/git_push.sh +55 -0
  164. data/lib/sib-api-v3-sdk.rb +196 -0
  165. data/lib/sib-api-v3-sdk/api/account_api.rb +72 -0
  166. data/lib/sib-api-v3-sdk/api/attributes_api.rb +181 -0
  167. data/lib/sib-api-v3-sdk/api/contacts_api.rb +1408 -0
  168. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +609 -0
  169. data/lib/sib-api-v3-sdk/api/folders_api.rb +379 -0
  170. data/lib/sib-api-v3-sdk/api/lists_api.rb +565 -0
  171. data/lib/sib-api-v3-sdk/api/process_api.rb +137 -0
  172. data/lib/sib-api-v3-sdk/api/reseller_api.rb +534 -0
  173. data/lib/sib-api-v3-sdk/api/senders_api.rb +343 -0
  174. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +609 -0
  175. data/lib/sib-api-v3-sdk/api/smtp_api.rb +699 -0
  176. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +280 -0
  177. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +302 -0
  178. data/lib/sib-api-v3-sdk/api_client.rb +389 -0
  179. data/lib/sib-api-v3-sdk/api_error.rb +38 -0
  180. data/lib/sib-api-v3-sdk/configuration.rb +209 -0
  181. data/lib/sib-api-v3-sdk/models/add_credits.rb +199 -0
  182. data/lib/sib-api-v3-sdk/models/add_remove_contact_to_list.rb +191 -0
  183. data/lib/sib-api-v3-sdk/models/crea_update_folder.rb +189 -0
  184. data/lib/sib-api-v3-sdk/models/create_attribute.rb +291 -0
  185. data/lib/sib-api-v3-sdk/models/create_attribute_enumemaration.rb +199 -0
  186. data/lib/sib-api-v3-sdk/models/create_child.rb +254 -0
  187. data/lib/sib-api-v3-sdk/models/create_contact.rb +231 -0
  188. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +425 -0
  189. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +203 -0
  190. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +204 -0
  191. data/lib/sib-api-v3-sdk/models/create_list.rb +209 -0
  192. data/lib/sib-api-v3-sdk/models/create_model.rb +194 -0
  193. data/lib/sib-api-v3-sdk/models/create_sender.rb +221 -0
  194. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +244 -0
  195. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +214 -0
  196. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +273 -0
  197. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +213 -0
  198. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +194 -0
  199. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +288 -0
  200. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +204 -0
  201. data/lib/sib-api-v3-sdk/models/create_webhook.rb +261 -0
  202. data/lib/sib-api-v3-sdk/models/created_process_id.rb +194 -0
  203. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +209 -0
  204. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +237 -0
  205. data/lib/sib-api-v3-sdk/models/error_model.rb +242 -0
  206. data/lib/sib-api-v3-sdk/models/get_account.rb +283 -0
  207. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +204 -0
  208. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +269 -0
  209. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +203 -0
  210. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +224 -0
  211. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +359 -0
  212. data/lib/sib-api-v3-sdk/models/get_attributes.rb +196 -0
  213. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +301 -0
  214. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +209 -0
  215. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +325 -0
  216. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +213 -0
  217. data/lib/sib-api-v3-sdk/models/get_campaign_recipients_exclusion_lists.rb +209 -0
  218. data/lib/sib-api-v3-sdk/models/get_campaign_recipients_lists.rb +209 -0
  219. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +359 -0
  220. data/lib/sib-api-v3-sdk/models/get_child_info.rb +296 -0
  221. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +219 -0
  222. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +199 -0
  223. data/lib/sib-api-v3-sdk/models/get_child_info_ips.rb +209 -0
  224. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +209 -0
  225. data/lib/sib-api-v3-sdk/models/get_children_list.rb +191 -0
  226. data/lib/sib-api-v3-sdk/models/get_client.rb +239 -0
  227. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +265 -0
  228. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +210 -0
  229. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_links.rb +239 -0
  230. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_messages_sent.rb +209 -0
  231. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +239 -0
  232. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +224 -0
  233. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +213 -0
  234. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription.rb +209 -0
  235. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription.rb +224 -0
  236. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +316 -0
  237. data/lib/sib-api-v3-sdk/models/get_contacts.rb +210 -0
  238. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +552 -0
  239. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +205 -0
  240. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +190 -0
  241. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +312 -0
  242. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +552 -0
  243. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +199 -0
  244. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +255 -0
  245. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb +194 -0
  246. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +248 -0
  247. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +239 -0
  248. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +316 -0
  249. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +309 -0
  250. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +208 -0
  251. data/lib/sib-api-v3-sdk/models/get_folder.rb +254 -0
  252. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +210 -0
  253. data/lib/sib-api-v3-sdk/models/get_folders.rb +200 -0
  254. data/lib/sib-api-v3-sdk/models/get_ip.rb +239 -0
  255. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +239 -0
  256. data/lib/sib-api-v3-sdk/models/get_ips.rb +196 -0
  257. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +196 -0
  258. data/lib/sib-api-v3-sdk/models/get_list.rb +239 -0
  259. data/lib/sib-api-v3-sdk/models/get_lists.rb +211 -0
  260. data/lib/sib-api-v3-sdk/models/get_lists_folder.rb +209 -0
  261. data/lib/sib-api-v3-sdk/models/get_lists_lists.rb +188 -0
  262. data/lib/sib-api-v3-sdk/models/get_process.rb +267 -0
  263. data/lib/sib-api-v3-sdk/models/get_processes.rb +206 -0
  264. data/lib/sib-api-v3-sdk/models/get_reports.rb +190 -0
  265. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +374 -0
  266. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +191 -0
  267. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +224 -0
  268. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +251 -0
  269. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +404 -0
  270. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +404 -0
  271. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +284 -0
  272. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +205 -0
  273. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +190 -0
  274. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +311 -0
  275. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +391 -0
  276. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +199 -0
  277. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +200 -0
  278. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +179 -0
  279. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +329 -0
  280. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +190 -0
  281. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +344 -0
  282. data/lib/sib-api-v3-sdk/models/get_webhook.rb +356 -0
  283. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +195 -0
  284. data/lib/sib-api-v3-sdk/models/manage_ip.rb +189 -0
  285. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +188 -0
  286. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +206 -0
  287. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +242 -0
  288. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +231 -0
  289. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +197 -0
  290. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +209 -0
  291. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +209 -0
  292. data/lib/sib-api-v3-sdk/models/remove_credits.rb +199 -0
  293. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +216 -0
  294. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +230 -0
  295. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +199 -0
  296. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +239 -0
  297. data/lib/sib-api-v3-sdk/models/send_email.rb +274 -0
  298. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +215 -0
  299. data/lib/sib-api-v3-sdk/models/send_report.rb +233 -0
  300. data/lib/sib-api-v3-sdk/models/send_report_email.rb +278 -0
  301. data/lib/sib-api-v3-sdk/models/send_sms.rb +193 -0
  302. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +301 -0
  303. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +225 -0
  304. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +204 -0
  305. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +204 -0
  306. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +204 -0
  307. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +204 -0
  308. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +204 -0
  309. data/lib/sib-api-v3-sdk/models/send_template_email.rb +194 -0
  310. data/lib/sib-api-v3-sdk/models/send_test_email.rb +191 -0
  311. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +191 -0
  312. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +282 -0
  313. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +221 -0
  314. data/lib/sib-api-v3-sdk/models/update_child.rb +240 -0
  315. data/lib/sib-api-v3-sdk/models/update_contact.rb +234 -0
  316. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +367 -0
  317. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +203 -0
  318. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +199 -0
  319. data/lib/sib-api-v3-sdk/models/update_list.rb +199 -0
  320. data/lib/sib-api-v3-sdk/models/update_sender.rb +211 -0
  321. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +260 -0
  322. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +278 -0
  323. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +199 -0
  324. data/lib/sib-api-v3-sdk/models/update_webhook.rb +211 -0
  325. data/lib/sib-api-v3-sdk/version.rb +15 -0
  326. data/sib-api-v3-sdk.gemspec +45 -0
  327. data/spec/api/account_api_spec.rb +46 -0
  328. data/spec/api/attributes_api_spec.rb +70 -0
  329. data/spec/api/contacts_api_spec.rb +335 -0
  330. data/spec/api/email_campaigns_api_spec.rb +163 -0
  331. data/spec/api/folders_api_spec.rb +111 -0
  332. data/spec/api/lists_api_spec.rb +152 -0
  333. data/spec/api/process_api_spec.rb +60 -0
  334. data/spec/api/reseller_api_spec.rb +147 -0
  335. data/spec/api/senders_api_spec.rb +108 -0
  336. data/spec/api/sms_campaigns_api_spec.rb +163 -0
  337. data/spec/api/smtp_api_spec.rb +189 -0
  338. data/spec/api/transactional_sms_api_spec.rb +96 -0
  339. data/spec/api/webhooks_api_spec.rb +96 -0
  340. data/spec/api_client_spec.rb +226 -0
  341. data/spec/configuration_spec.rb +42 -0
  342. data/spec/models/add_credits_spec.rb +48 -0
  343. data/spec/models/add_remove_contact_to_list_spec.rb +42 -0
  344. data/spec/models/crea_update_folder_spec.rb +42 -0
  345. data/spec/models/create_attribute_enumemaration_spec.rb +48 -0
  346. data/spec/models/create_attribute_spec.rb +74 -0
  347. data/spec/models/create_child_spec.rb +66 -0
  348. data/spec/models/create_contact_spec.rb +66 -0
  349. data/spec/models/create_email_campaign_recipients_spec.rb +48 -0
  350. data/spec/models/create_email_campaign_sender_spec.rb +48 -0
  351. data/spec/models/create_email_campaign_spec.rb +148 -0
  352. data/spec/models/create_list_spec.rb +48 -0
  353. data/spec/models/create_model_spec.rb +42 -0
  354. data/spec/models/create_sender_ips_spec.rb +54 -0
  355. data/spec/models/create_sender_model_spec.rb +54 -0
  356. data/spec/models/create_sender_spec.rb +54 -0
  357. data/spec/models/create_sms_campaign_recipients_spec.rb +48 -0
  358. data/spec/models/create_sms_campaign_spec.rb +66 -0
  359. data/spec/models/create_smtp_email_spec.rb +42 -0
  360. data/spec/models/create_smtp_template_sender_spec.rb +48 -0
  361. data/spec/models/create_smtp_template_spec.rb +96 -0
  362. data/spec/models/create_webhook_spec.rb +64 -0
  363. data/spec/models/created_process_id_spec.rb +42 -0
  364. data/spec/models/delete_hardbounces_spec.rb +54 -0
  365. data/spec/models/email_export_recipients_spec.rb +52 -0
  366. data/spec/models/error_model_spec.rb +52 -0
  367. data/spec/models/get_account_marketing_automation_spec.rb +48 -0
  368. data/spec/models/get_account_plan_spec.rb +62 -0
  369. data/spec/models/get_account_relay_data_spec.rb +54 -0
  370. data/spec/models/get_account_relay_spec.rb +48 -0
  371. data/spec/models/get_account_spec.rb +84 -0
  372. data/spec/models/get_aggregated_report_spec.rb +108 -0
  373. data/spec/models/get_attributes_attributes_spec.rb +80 -0
  374. data/spec/models/get_attributes_enumeration_spec.rb +48 -0
  375. data/spec/models/get_attributes_spec.rb +42 -0
  376. data/spec/models/get_campaign_overview_spec.rb +80 -0
  377. data/spec/models/get_campaign_recipients_exclusion_lists_spec.rb +48 -0
  378. data/spec/models/get_campaign_recipients_lists_spec.rb +48 -0
  379. data/spec/models/get_campaign_recipients_spec.rb +48 -0
  380. data/spec/models/get_campaign_stats_spec.rb +108 -0
  381. data/spec/models/get_child_info_api_keys_spec.rb +54 -0
  382. data/spec/models/get_child_info_credits_spec.rb +48 -0
  383. data/spec/models/get_child_info_ips_spec.rb +48 -0
  384. data/spec/models/get_child_info_spec.rb +90 -0
  385. data/spec/models/get_child_info_statistics_spec.rb +54 -0
  386. data/spec/models/get_children_list_spec.rb +42 -0
  387. data/spec/models/get_client_spec.rb +60 -0
  388. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +48 -0
  389. data/spec/models/get_contact_campaign_stats_links_spec.rb +60 -0
  390. data/spec/models/get_contact_campaign_stats_messages_sent_spec.rb +48 -0
  391. data/spec/models/get_contact_campaign_stats_opened_spec.rb +60 -0
  392. data/spec/models/get_contact_campaign_stats_spec.rb +84 -0
  393. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +54 -0
  394. data/spec/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription_spec.rb +48 -0
  395. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +48 -0
  396. data/spec/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription_spec.rb +54 -0
  397. data/spec/models/get_contact_details_spec.rb +84 -0
  398. data/spec/models/get_contacts_spec.rb +48 -0
  399. data/spec/models/get_email_campaign_spec.rb +164 -0
  400. data/spec/models/get_email_campaigns_spec.rb +48 -0
  401. data/spec/models/get_email_event_report_events_spec.rb +82 -0
  402. data/spec/models/get_email_event_report_spec.rb +42 -0
  403. data/spec/models/get_extended_campaign_overview_sender_spec.rb +48 -0
  404. data/spec/models/get_extended_campaign_overview_spec.rb +164 -0
  405. data/spec/models/get_extended_campaign_stats_links_stats_spec.rb +42 -0
  406. data/spec/models/get_extended_campaign_stats_spec.rb +66 -0
  407. data/spec/models/get_extended_client_address_spec.rb +60 -0
  408. data/spec/models/get_extended_client_spec.rb +66 -0
  409. data/spec/models/get_extended_contact_details_spec.rb +84 -0
  410. data/spec/models/get_extended_list_campaign_stats_spec.rb +48 -0
  411. data/spec/models/get_extended_list_spec.rb +84 -0
  412. data/spec/models/get_folder_lists_spec.rb +48 -0
  413. data/spec/models/get_folder_spec.rb +66 -0
  414. data/spec/models/get_folders_spec.rb +48 -0
  415. data/spec/models/get_ip_from_sender_spec.rb +60 -0
  416. data/spec/models/get_ip_spec.rb +60 -0
  417. data/spec/models/get_ips_from_sender_spec.rb +42 -0
  418. data/spec/models/get_ips_spec.rb +42 -0
  419. data/spec/models/get_list_spec.rb +60 -0
  420. data/spec/models/get_lists_folder_spec.rb +48 -0
  421. data/spec/models/get_lists_lists_spec.rb +42 -0
  422. data/spec/models/get_lists_spec.rb +48 -0
  423. data/spec/models/get_process_spec.rb +64 -0
  424. data/spec/models/get_processes_spec.rb +48 -0
  425. data/spec/models/get_reports_reports_spec.rb +114 -0
  426. data/spec/models/get_reports_spec.rb +42 -0
  427. data/spec/models/get_senders_list_ips_spec.rb +54 -0
  428. data/spec/models/get_senders_list_senders_spec.rb +66 -0
  429. data/spec/models/get_senders_list_spec.rb +42 -0
  430. data/spec/models/get_sms_campaign_overview_spec.rb +94 -0
  431. data/spec/models/get_sms_campaign_spec.rb +94 -0
  432. data/spec/models/get_sms_campaign_stats_spec.rb +78 -0
  433. data/spec/models/get_sms_campaigns_spec.rb +48 -0
  434. data/spec/models/get_sms_event_report_events_spec.rb +82 -0
  435. data/spec/models/get_sms_event_report_spec.rb +42 -0
  436. data/spec/models/get_smtp_template_overview_sender_spec.rb +48 -0
  437. data/spec/models/get_smtp_template_overview_spec.rb +108 -0
  438. data/spec/models/get_smtp_templates_spec.rb +48 -0
  439. data/spec/models/get_stats_by_domain_spec.rb +36 -0
  440. data/spec/models/get_transac_aggregated_sms_report_spec.rb +96 -0
  441. data/spec/models/get_transac_sms_report_reports_spec.rb +102 -0
  442. data/spec/models/get_transac_sms_report_spec.rb +42 -0
  443. data/spec/models/get_webhook_spec.rb +82 -0
  444. data/spec/models/get_webhooks_spec.rb +42 -0
  445. data/spec/models/manage_ip_spec.rb +42 -0
  446. data/spec/models/post_contact_info_contacts_spec.rb +48 -0
  447. data/spec/models/post_contact_info_spec.rb +42 -0
  448. data/spec/models/post_send_failed_spec.rb +66 -0
  449. data/spec/models/post_send_sms_test_failed_spec.rb +60 -0
  450. data/spec/models/remaining_credit_model_child_spec.rb +48 -0
  451. data/spec/models/remaining_credit_model_reseller_spec.rb +48 -0
  452. data/spec/models/remaining_credit_model_spec.rb +48 -0
  453. data/spec/models/remove_credits_spec.rb +48 -0
  454. data/spec/models/request_contact_export_spec.rb +54 -0
  455. data/spec/models/request_contact_import_new_list_spec.rb +48 -0
  456. data/spec/models/request_contact_import_spec.rb +66 -0
  457. data/spec/models/request_sms_recipient_export_spec.rb +52 -0
  458. data/spec/models/send_email_attachment_spec.rb +48 -0
  459. data/spec/models/send_email_spec.rb +84 -0
  460. data/spec/models/send_report_email_spec.rb +76 -0
  461. data/spec/models/send_report_spec.rb +52 -0
  462. data/spec/models/send_sms_spec.rb +42 -0
  463. data/spec/models/send_smtp_email_attachment_spec.rb +54 -0
  464. data/spec/models/send_smtp_email_bcc_spec.rb +48 -0
  465. data/spec/models/send_smtp_email_cc_spec.rb +48 -0
  466. data/spec/models/send_smtp_email_reply_to_spec.rb +48 -0
  467. data/spec/models/send_smtp_email_sender_spec.rb +48 -0
  468. data/spec/models/send_smtp_email_spec.rb +96 -0
  469. data/spec/models/send_smtp_email_to_spec.rb +48 -0
  470. data/spec/models/send_template_email_spec.rb +42 -0
  471. data/spec/models/send_test_email_spec.rb +42 -0
  472. data/spec/models/send_test_sms_spec.rb +42 -0
  473. data/spec/models/send_transac_sms_spec.rb +66 -0
  474. data/spec/models/update_campaign_status_spec.rb +46 -0
  475. data/spec/models/update_child_spec.rb +72 -0
  476. data/spec/models/update_contact_spec.rb +66 -0
  477. data/spec/models/update_email_campaign_recipients_spec.rb +48 -0
  478. data/spec/models/update_email_campaign_sender_spec.rb +48 -0
  479. data/spec/models/update_email_campaign_spec.rb +138 -0
  480. data/spec/models/update_list_spec.rb +48 -0
  481. data/spec/models/update_sender_spec.rb +54 -0
  482. data/spec/models/update_sms_campaign_spec.rb +66 -0
  483. data/spec/models/update_smtp_template_sender_spec.rb +48 -0
  484. data/spec/models/update_smtp_template_spec.rb +96 -0
  485. data/spec/models/update_webhook_spec.rb +54 -0
  486. data/spec/spec_helper.rb +111 -0
  487. metadata +869 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0dceed50c061a3cac4e852e95abd9b396a92021c
4
+ data.tar.gz: 2a0b606befde61f1a6875d4fa7fa77c2c7695e8a
5
+ SHA512:
6
+ metadata.gz: 95f6925cc3274327cd0c3e94ef1a127234c9bce12dc814e9cdc514adab57f9c790f27443ef7dcf32cbf36aa98222f12453e67ef8196c5815e359f1c07f1716de
7
+ data.tar.gz: 518264d9114e0804cc3c42d5a834cccc64c759b7f033b8dfcd2af9df4eb48832b32ce514f1a642398d9e3777970d2991db1cbce0528b36b9c239829ee6ff88c1
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 SendinBlue
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,349 @@
1
+ # SendinBlue's API v3 Ruby Library
2
+
3
+ SendinBlue's API exposes the entire SendinBlue features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.sendinblue.com) to learn more.
4
+
5
+ This is the wrapper for the API. It implements all the features of the API v3.
6
+
7
+ SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.sendinblue.com/v3/swagger_definition.yml).
8
+
9
+ This RUBY package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:
10
+
11
+ - API version: 3.0.0
12
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
13
+
14
+ For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support)
15
+
16
+ ## Installation
17
+
18
+ ### Build a gem
19
+
20
+ Add this line to your application's Gemfile:
21
+ ```shell
22
+ gem 'sib-api-v3-sdk'
23
+ ```
24
+
25
+ And then execute:
26
+ ```shell
27
+ $ bundle
28
+ ```
29
+
30
+ Or install it yourself as:
31
+ ```shell
32
+ $ ( sudo ) gem install sib-api-v3-sdk
33
+ ```
34
+
35
+ ### Install from Git
36
+
37
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
38
+
39
+ gem 'sib-api-v3-sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
40
+
41
+ ### Include the Ruby code directly
42
+
43
+ Include the Ruby code directly using `-I` as follows:
44
+
45
+ ```shell
46
+ ruby -Ilib script.rb
47
+ ```
48
+
49
+ ## Getting Started
50
+
51
+ Please follow the [installation](#installation) procedure and then run the following code:
52
+ ```ruby
53
+ # Load the gem
54
+ require 'sib-api-v3-sdk'
55
+
56
+ # Setup authorization
57
+ SendinblueApiv3.configure do |config|
58
+ # Configure API key authorization: api-key
59
+ config.api_key['api-key'] = 'YOUR API KEY'
60
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
61
+ #config.api_key_prefix['api-key'] = 'Bearer'
62
+ end
63
+
64
+ api_instance = SendinblueApiv3::AccountApi.new
65
+
66
+ begin
67
+ #Get your account informations, plans and credits details
68
+ result = api_instance.get_account
69
+ p result
70
+ rescue SendinblueApiv3::ApiError => e
71
+ puts "Exception when calling AccountApi->get_account: #{e}"
72
+ end
73
+
74
+ ```
75
+
76
+ ## Documentation for API Endpoints
77
+
78
+ All URIs are relative to *https://api.sendinblue.com/v3*
79
+
80
+ Class | Method | HTTP request | Description
81
+ ------------ | ------------- | ------------- | -------------
82
+ *SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details
83
+ *SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
84
+ *SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
85
+ *SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
86
+ *SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
87
+ *SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
88
+ *SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
89
+ *SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
90
+ *SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
91
+ *SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
92
+ *SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
93
+ *SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
94
+ *SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
95
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Retrieves contact informations
96
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact
97
+ *SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
98
+ *SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list
99
+ *SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
100
+ *SibApiV3Sdk::ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
101
+ *SibApiV3Sdk::ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all the folders
102
+ *SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
103
+ *SibApiV3Sdk::ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
104
+ *SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
105
+ *SibApiV3Sdk::ContactsApi* | [**remove_contact_to_list**](docs/ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
106
+ *SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
107
+ *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
108
+ *SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
109
+ *SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
110
+ *SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
111
+ *SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaigns**](docs/EmailCampaignsApi.md#delete_email_campaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
112
+ *SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
113
+ *SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
114
+ *SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
115
+ *SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
116
+ *SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
117
+ *SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
118
+ *SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
119
+ *SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaigns**](docs/EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
120
+ *SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
121
+ *SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
122
+ *SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
123
+ *SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
124
+ *SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all the folders
125
+ *SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
126
+ *SibApiV3Sdk::ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
127
+ *SibApiV3Sdk::ListsApi* | [**create_list**](docs/ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
128
+ *SibApiV3Sdk::ListsApi* | [**delete_list**](docs/ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
129
+ *SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list
130
+ *SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
131
+ *SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
132
+ *SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
133
+ *SibApiV3Sdk::ListsApi* | [**remove_contact_to_list**](docs/ListsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
134
+ *SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
135
+ *SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
136
+ *SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
137
+ *SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childId}/credits/add | Add Email and/or SMS credits to a specific child account
138
+ *SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childId}/ips/associate | Associate a dedicated IP to the child
139
+ *SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
140
+ *SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
141
+ *SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child
142
+ *SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
143
+ *SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
144
+ *SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
145
+ *SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
146
+ *SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates a SMS campaign
147
+ *SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaigns**](docs/SMSCampaignsApi.md#delete_sms_campaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
148
+ *SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get a SMS campaign
149
+ *SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
150
+ *SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
151
+ *SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_campaign_now**](docs/SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
152
+ *SibApiV3Sdk::SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
153
+ *SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
154
+ *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates a SMS campaign
155
+ *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
156
+ *SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an smtp template
157
+ *SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
158
+ *SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
159
+ *SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
160
+ *SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
161
+ *SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
162
+ *SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of SMTP templates
163
+ *SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
164
+ *SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
165
+ *SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
166
+ *SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates an smtp templates
167
+ *SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
168
+ *SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
169
+ *SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
170
+ *SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender
171
+ *SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
172
+ *SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
173
+ *SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events)
174
+ *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
175
+ *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
176
+ *SibApiV3Sdk::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number
177
+ *SibApiV3Sdk::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
178
+ *SibApiV3Sdk::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
179
+ *SibApiV3Sdk::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
180
+ *SibApiV3Sdk::WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get all webhooks
181
+ *SibApiV3Sdk::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks/{webhookId} | Update a webhook
182
+
183
+
184
+ ## Documentation for Models
185
+
186
+ - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
187
+ - [SibApiV3Sdk::AddRemoveContactToList](docs/AddRemoveContactToList.md)
188
+ - [SibApiV3Sdk::CreaUpdateFolder](docs/CreaUpdateFolder.md)
189
+ - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
190
+ - [SibApiV3Sdk::CreateAttributeEnumemaration](docs/CreateAttributeEnumemaration.md)
191
+ - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
192
+ - [SibApiV3Sdk::CreateContact](docs/CreateContact.md)
193
+ - [SibApiV3Sdk::CreateEmailCampaign](docs/CreateEmailCampaign.md)
194
+ - [SibApiV3Sdk::CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md)
195
+ - [SibApiV3Sdk::CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
196
+ - [SibApiV3Sdk::CreateList](docs/CreateList.md)
197
+ - [SibApiV3Sdk::CreateModel](docs/CreateModel.md)
198
+ - [SibApiV3Sdk::CreateSender](docs/CreateSender.md)
199
+ - [SibApiV3Sdk::CreateSenderIps](docs/CreateSenderIps.md)
200
+ - [SibApiV3Sdk::CreateSenderModel](docs/CreateSenderModel.md)
201
+ - [SibApiV3Sdk::CreateSmsCampaign](docs/CreateSmsCampaign.md)
202
+ - [SibApiV3Sdk::CreateSmsCampaignRecipients](docs/CreateSmsCampaignRecipients.md)
203
+ - [SibApiV3Sdk::CreateSmtpEmail](docs/CreateSmtpEmail.md)
204
+ - [SibApiV3Sdk::CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
205
+ - [SibApiV3Sdk::CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
206
+ - [SibApiV3Sdk::CreateWebhook](docs/CreateWebhook.md)
207
+ - [SibApiV3Sdk::CreatedProcessId](docs/CreatedProcessId.md)
208
+ - [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)
209
+ - [SibApiV3Sdk::EmailExportRecipients](docs/EmailExportRecipients.md)
210
+ - [SibApiV3Sdk::ErrorModel](docs/ErrorModel.md)
211
+ - [SibApiV3Sdk::GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
212
+ - [SibApiV3Sdk::GetAccountPlan](docs/GetAccountPlan.md)
213
+ - [SibApiV3Sdk::GetAccountRelay](docs/GetAccountRelay.md)
214
+ - [SibApiV3Sdk::GetAccountRelayData](docs/GetAccountRelayData.md)
215
+ - [SibApiV3Sdk::GetAggregatedReport](docs/GetAggregatedReport.md)
216
+ - [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
217
+ - [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
218
+ - [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
219
+ - [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
220
+ - [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
221
+ - [SibApiV3Sdk::GetCampaignRecipientsExclusionLists](docs/GetCampaignRecipientsExclusionLists.md)
222
+ - [SibApiV3Sdk::GetCampaignRecipientsLists](docs/GetCampaignRecipientsLists.md)
223
+ - [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
224
+ - [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
225
+ - [SibApiV3Sdk::GetChildInfoCredits](docs/GetChildInfoCredits.md)
226
+ - [SibApiV3Sdk::GetChildInfoIps](docs/GetChildInfoIps.md)
227
+ - [SibApiV3Sdk::GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
228
+ - [SibApiV3Sdk::GetChildrenList](docs/GetChildrenList.md)
229
+ - [SibApiV3Sdk::GetClient](docs/GetClient.md)
230
+ - [SibApiV3Sdk::GetContactCampaignStats](docs/GetContactCampaignStats.md)
231
+ - [SibApiV3Sdk::GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
232
+ - [SibApiV3Sdk::GetContactCampaignStatsLinks](docs/GetContactCampaignStatsLinks.md)
233
+ - [SibApiV3Sdk::GetContactCampaignStatsMessagesSent](docs/GetContactCampaignStatsMessagesSent.md)
234
+ - [SibApiV3Sdk::GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
235
+ - [SibApiV3Sdk::GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
236
+ - [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
237
+ - [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsAdminUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md)
238
+ - [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsUserUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md)
239
+ - [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
240
+ - [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
241
+ - [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
242
+ - [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
243
+ - [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
244
+ - [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
245
+ - [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
246
+ - [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
247
+ - [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
248
+ - [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
249
+ - [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
250
+ - [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
251
+ - [SibApiV3Sdk::GetFolders](docs/GetFolders.md)
252
+ - [SibApiV3Sdk::GetIp](docs/GetIp.md)
253
+ - [SibApiV3Sdk::GetIpFromSender](docs/GetIpFromSender.md)
254
+ - [SibApiV3Sdk::GetIps](docs/GetIps.md)
255
+ - [SibApiV3Sdk::GetIpsFromSender](docs/GetIpsFromSender.md)
256
+ - [SibApiV3Sdk::GetList](docs/GetList.md)
257
+ - [SibApiV3Sdk::GetLists](docs/GetLists.md)
258
+ - [SibApiV3Sdk::GetListsFolder](docs/GetListsFolder.md)
259
+ - [SibApiV3Sdk::GetListsLists](docs/GetListsLists.md)
260
+ - [SibApiV3Sdk::GetProcess](docs/GetProcess.md)
261
+ - [SibApiV3Sdk::GetProcesses](docs/GetProcesses.md)
262
+ - [SibApiV3Sdk::GetReports](docs/GetReports.md)
263
+ - [SibApiV3Sdk::GetReportsReports](docs/GetReportsReports.md)
264
+ - [SibApiV3Sdk::GetSendersList](docs/GetSendersList.md)
265
+ - [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
266
+ - [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
267
+ - [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
268
+ - [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
269
+ - [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
270
+ - [SibApiV3Sdk::GetSmsEventReport](docs/GetSmsEventReport.md)
271
+ - [SibApiV3Sdk::GetSmsEventReportEvents](docs/GetSmsEventReportEvents.md)
272
+ - [SibApiV3Sdk::GetSmtpTemplateOverview](docs/GetSmtpTemplateOverview.md)
273
+ - [SibApiV3Sdk::GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
274
+ - [SibApiV3Sdk::GetSmtpTemplates](docs/GetSmtpTemplates.md)
275
+ - [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
276
+ - [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
277
+ - [SibApiV3Sdk::GetTransacSmsReport](docs/GetTransacSmsReport.md)
278
+ - [SibApiV3Sdk::GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
279
+ - [SibApiV3Sdk::GetWebhook](docs/GetWebhook.md)
280
+ - [SibApiV3Sdk::GetWebhooks](docs/GetWebhooks.md)
281
+ - [SibApiV3Sdk::ManageIp](docs/ManageIp.md)
282
+ - [SibApiV3Sdk::PostContactInfo](docs/PostContactInfo.md)
283
+ - [SibApiV3Sdk::PostContactInfoContacts](docs/PostContactInfoContacts.md)
284
+ - [SibApiV3Sdk::PostSendFailed](docs/PostSendFailed.md)
285
+ - [SibApiV3Sdk::PostSendSmsTestFailed](docs/PostSendSmsTestFailed.md)
286
+ - [SibApiV3Sdk::RemainingCreditModel](docs/RemainingCreditModel.md)
287
+ - [SibApiV3Sdk::RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
288
+ - [SibApiV3Sdk::RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
289
+ - [SibApiV3Sdk::RemoveCredits](docs/RemoveCredits.md)
290
+ - [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
291
+ - [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
292
+ - [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
293
+ - [SibApiV3Sdk::RequestSMSRecipientExport](docs/RequestSMSRecipientExport.md)
294
+ - [SibApiV3Sdk::SendEmail](docs/SendEmail.md)
295
+ - [SibApiV3Sdk::SendEmailAttachment](docs/SendEmailAttachment.md)
296
+ - [SibApiV3Sdk::SendReport](docs/SendReport.md)
297
+ - [SibApiV3Sdk::SendReportEmail](docs/SendReportEmail.md)
298
+ - [SibApiV3Sdk::SendSms](docs/SendSms.md)
299
+ - [SibApiV3Sdk::SendSmtpEmail](docs/SendSmtpEmail.md)
300
+ - [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
301
+ - [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
302
+ - [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
303
+ - [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
304
+ - [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
305
+ - [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
306
+ - [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
307
+ - [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
308
+ - [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
309
+ - [SibApiV3Sdk::SendTransacSms](docs/SendTransacSms.md)
310
+ - [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
311
+ - [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
312
+ - [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)
313
+ - [SibApiV3Sdk::UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
314
+ - [SibApiV3Sdk::UpdateEmailCampaignRecipients](docs/UpdateEmailCampaignRecipients.md)
315
+ - [SibApiV3Sdk::UpdateEmailCampaignSender](docs/UpdateEmailCampaignSender.md)
316
+ - [SibApiV3Sdk::UpdateList](docs/UpdateList.md)
317
+ - [SibApiV3Sdk::UpdateSender](docs/UpdateSender.md)
318
+ - [SibApiV3Sdk::UpdateSmsCampaign](docs/UpdateSmsCampaign.md)
319
+ - [SibApiV3Sdk::UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
320
+ - [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
321
+ - [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
322
+ - [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
323
+ - [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
324
+ - [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
325
+ - [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
326
+ - [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
327
+ - [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
328
+ - [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
329
+ - [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
330
+
331
+
332
+ ## Documentation for Authorization
333
+
334
+
335
+ ### api-key
336
+
337
+ - **Type**: API key
338
+ - **API key parameter name**: api-key
339
+ - **Location**: HTTP header
340
+
341
+
342
+ ## Support and Feedback
343
+
344
+ Be sure to visit the SendinBlue official [documentation website](https://sendinblue.readme.io/docs ) for additional information about our API.
345
+
346
+ If you find a bug, please post the issue on [Github](https://github.com/sendinblue/APIv3-ruby-library/issues).
347
+
348
+ As always, if you need additional assistance, drop us a note [here](https://account.sendinblue.com/support).
349
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,55 @@
1
+ # SibApiV3Sdk::AccountApi
2
+
3
+ All URIs are relative to *https://api.sendinblue.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details
8
+
9
+
10
+ # **get_account**
11
+ > GetAccount get_account
12
+
13
+ Get your account informations, plans and credits details
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'sib-api-v3-sdk'
19
+ # setup authorization
20
+ SibApiV3Sdk.configure do |config|
21
+ # Configure API key authorization: api-key
22
+ config.api_key['api-key'] = 'YOUR API KEY'
23
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24
+ #config.api_key_prefix['api-key'] = 'Bearer'
25
+ end
26
+
27
+ api_instance = SibApiV3Sdk::AccountApi.new
28
+
29
+ begin
30
+ #Get your account informations, plans and credits details
31
+ result = api_instance.get_account
32
+ p result
33
+ rescue SibApiV3Sdk::ApiError => e
34
+ puts "Exception when calling AccountApi->get_account: #{e}"
35
+ end
36
+ ```
37
+
38
+ ### Parameters
39
+ This endpoint does not need any parameter.
40
+
41
+ ### Return type
42
+
43
+ [**GetAccount**](GetAccount.md)
44
+
45
+ ### Authorization
46
+
47
+ [api-key](../README.md#api-key)
48
+
49
+ ### HTTP request headers
50
+
51
+ - **Content-Type**: application/json
52
+ - **Accept**: application/json
53
+
54
+
55
+