sendpost_ruby_sdk 2.0.2 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (360) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +612 -531
  3. data/docs/AccountCycleUsage.md +18 -0
  4. data/docs/AccountStats.md +3 -3
  5. data/docs/AccountWebhookWithStats.md +58 -0
  6. data/docs/AggregateStat.md +14 -14
  7. data/docs/AggregateStats.md +22 -22
  8. data/docs/Attachment.md +4 -4
  9. data/docs/BlacklistLinks.md +20 -0
  10. data/docs/BlacklistResource.md +38 -0
  11. data/docs/BlacklistedOn.md +20 -0
  12. data/docs/CopyTo.md +6 -6
  13. data/docs/CreateDomainRequest.md +2 -2
  14. data/docs/CreateSuppressionRequest.md +4 -4
  15. data/docs/CreateSuppressionRequestHardBounceInner.md +1 -1
  16. data/docs/CreateSuppressionRequestManualInner.md +1 -1
  17. data/docs/CreateSuppressionRequestSpamComplaintInner.md +1 -1
  18. data/docs/CreateSuppressionRequestUnsubscribeInner.md +1 -1
  19. data/docs/DailyStatistics.md +38 -0
  20. data/docs/DateStat.md +40 -0
  21. data/docs/DeleteResponse.md +4 -4
  22. data/docs/DeleteSubAccountResponse.md +4 -4
  23. data/docs/{DeleteSuppression200ResponseInner.md → DeleteSuppression200Response.md} +2 -4
  24. data/docs/DeleteSuppressionRequest.md +1 -1
  25. data/docs/{EmailMessageReplyTo.md → DeleteSuppressionRequestSuppressionsInner.md} +3 -5
  26. data/docs/DeleteWebhookResponse.md +3 -3
  27. data/docs/Device.md +2 -2
  28. data/docs/DnsRecord.md +22 -0
  29. data/docs/Domain.md +24 -28
  30. data/docs/DomainApi.md +66 -66
  31. data/docs/DomainStat.md +46 -0
  32. data/docs/EIP.md +1 -1
  33. data/docs/EmailAddress.md +4 -4
  34. data/docs/EmailApi.md +4 -4
  35. data/docs/EmailMessage.md +30 -30
  36. data/docs/EmailMessageObject.md +33 -26
  37. data/docs/EmailMessageWithTemplate.md +32 -27
  38. data/docs/EmailResponse.md +10 -10
  39. data/docs/EmailTypeStat.md +40 -0
  40. data/docs/ErrorResponse.md +18 -0
  41. data/docs/ErrorResponseError.md +26 -0
  42. data/docs/ErrorResponseErrorDetailsInner.md +20 -0
  43. data/docs/Event.md +18 -36
  44. data/docs/EventMetadata.md +14 -14
  45. data/docs/GeoLocation.md +8 -8
  46. data/docs/GroupStat.md +40 -0
  47. data/docs/IP.md +13 -43
  48. data/docs/IPAllocationRequest.md +4 -4
  49. data/docs/IPApi.md +19 -19
  50. data/docs/IPDeletionResponse.md +2 -2
  51. data/docs/IPPool.md +13 -21
  52. data/docs/IPPoolCreateRequest.md +10 -8
  53. data/docs/IPPoolDeleteResponse.md +2 -2
  54. data/docs/IPPoolStat.md +44 -0
  55. data/docs/IPPoolUpdateRequest.md +13 -7
  56. data/docs/IPPoolsApi.md +26 -19
  57. data/docs/IPStat.md +46 -0
  58. data/docs/IPUpdateRequest.md +2 -2
  59. data/docs/Label.md +10 -6
  60. data/docs/Member.md +15 -21
  61. data/docs/Message.md +37 -53
  62. data/docs/MessageApi.md +83 -3
  63. data/docs/NewSubAccount.md +18 -0
  64. data/docs/NewWebhook.md +46 -0
  65. data/docs/Os.md +26 -0
  66. data/docs/PostmasterDomainStat.md +30 -0
  67. data/docs/ProviderStat.md +40 -0
  68. data/docs/RAIPPoolStat.md +20 -0
  69. data/docs/RDStat.md +20 -0
  70. data/docs/RIPStat.md +20 -0
  71. data/docs/RStat.md +20 -0
  72. data/docs/Recipient.md +8 -8
  73. data/docs/SDStat.md +42 -0
  74. data/docs/SMTPAuth.md +5 -9
  75. data/docs/SeedContactStats.md +28 -0
  76. data/docs/Stat.md +22 -4
  77. data/docs/StatsAApi.md +24 -24
  78. data/docs/StatsApi.md +19 -19
  79. data/docs/SubAccount.md +13 -27
  80. data/docs/SubAccountApi.md +23 -23
  81. data/docs/SubAccountStat.md +44 -0
  82. data/docs/SubAccountStatForPool.md +42 -0
  83. data/docs/Suppression.md +14 -10
  84. data/docs/SuppressionApi.md +19 -19
  85. data/docs/TPSPStat.md +42 -0
  86. data/docs/UpdateSubAccount.md +2 -2
  87. data/docs/UpdateWebhook.md +23 -23
  88. data/docs/UserAgent.md +7 -7
  89. data/docs/ValidationStat.md +32 -0
  90. data/docs/Webhook.md +31 -29
  91. data/docs/WebhookApi.md +28 -28
  92. data/docs/WebhookObject.md +20 -0
  93. data/docs/WebhookReferenceApi.md +71 -0
  94. data/lib/sendpost_ruby_sdk/api/domain_api.rb +84 -84
  95. data/lib/sendpost_ruby_sdk/api/email_api.rb +6 -6
  96. data/lib/sendpost_ruby_sdk/api/ip_api.rb +24 -24
  97. data/lib/sendpost_ruby_sdk/api/ip_pools_api.rb +25 -25
  98. data/lib/sendpost_ruby_sdk/api/message_api.rb +83 -6
  99. data/lib/sendpost_ruby_sdk/api/stats_a_api.rb +30 -30
  100. data/lib/sendpost_ruby_sdk/api/stats_api.rb +24 -24
  101. data/lib/sendpost_ruby_sdk/api/sub_account_api.rb +33 -33
  102. data/lib/sendpost_ruby_sdk/api/suppression_api.rb +23 -23
  103. data/lib/sendpost_ruby_sdk/api/webhook_api.rb +36 -36
  104. data/lib/sendpost_ruby_sdk/api/webhook_reference_api.rb +82 -0
  105. data/lib/sendpost_ruby_sdk/api_client.rb +2 -2
  106. data/lib/sendpost_ruby_sdk/api_error.rb +2 -2
  107. data/lib/sendpost_ruby_sdk/configuration.rb +2 -2
  108. data/lib/sendpost_ruby_sdk/models/account_cycle_usage.rb +222 -0
  109. data/lib/sendpost_ruby_sdk/models/account_stats.rb +5 -3
  110. data/lib/sendpost_ruby_sdk/models/account_webhook_with_stats.rb +463 -0
  111. data/lib/sendpost_ruby_sdk/models/aggregate_stat.rb +37 -29
  112. data/lib/sendpost_ruby_sdk/models/aggregate_stats.rb +43 -24
  113. data/lib/sendpost_ruby_sdk/models/attachment.rb +48 -4
  114. data/lib/sendpost_ruby_sdk/models/blacklist_links.rb +232 -0
  115. data/lib/sendpost_ruby_sdk/models/blacklist_resource.rb +323 -0
  116. data/lib/sendpost_ruby_sdk/models/blacklisted_on.rb +232 -0
  117. data/lib/sendpost_ruby_sdk/models/copy_to.rb +42 -3
  118. data/lib/sendpost_ruby_sdk/models/create_domain_request.rb +32 -3
  119. data/lib/sendpost_ruby_sdk/models/create_suppression_request.rb +6 -6
  120. data/lib/sendpost_ruby_sdk/models/create_suppression_request_hard_bounce_inner.rb +2 -2
  121. data/lib/sendpost_ruby_sdk/models/create_suppression_request_manual_inner.rb +2 -2
  122. data/lib/sendpost_ruby_sdk/models/create_suppression_request_spam_complaint_inner.rb +2 -2
  123. data/lib/sendpost_ruby_sdk/models/create_suppression_request_unsubscribe_inner.rb +2 -2
  124. data/lib/sendpost_ruby_sdk/models/daily_statistics.rb +322 -0
  125. data/lib/sendpost_ruby_sdk/models/date_stat.rb +339 -0
  126. data/lib/sendpost_ruby_sdk/models/delete_response.rb +5 -4
  127. data/lib/sendpost_ruby_sdk/models/delete_sub_account_response.rb +5 -4
  128. data/lib/sendpost_ruby_sdk/models/delete_suppression200_response.rb +221 -0
  129. data/lib/sendpost_ruby_sdk/models/delete_suppression_request.rb +4 -3
  130. data/lib/sendpost_ruby_sdk/models/delete_suppression_request_suppressions_inner.rb +220 -0
  131. data/lib/sendpost_ruby_sdk/models/delete_webhook_response.rb +5 -4
  132. data/lib/sendpost_ruby_sdk/models/device.rb +5 -3
  133. data/lib/sendpost_ruby_sdk/models/dns_record.rb +276 -0
  134. data/lib/sendpost_ruby_sdk/models/domain.rb +42 -85
  135. data/lib/sendpost_ruby_sdk/models/domain_stat.rb +369 -0
  136. data/lib/sendpost_ruby_sdk/models/eip.rb +4 -3
  137. data/lib/sendpost_ruby_sdk/models/email_address.rb +41 -2
  138. data/lib/sendpost_ruby_sdk/models/email_message.rb +26 -9
  139. data/lib/sendpost_ruby_sdk/models/email_message_object.rb +123 -3
  140. data/lib/sendpost_ruby_sdk/models/email_message_with_template.rb +121 -12
  141. data/lib/sendpost_ruby_sdk/models/email_response.rb +8 -4
  142. data/lib/sendpost_ruby_sdk/models/email_type_stat.rb +339 -0
  143. data/lib/sendpost_ruby_sdk/models/error_response.rb +221 -0
  144. data/lib/sendpost_ruby_sdk/models/error_response_error.rb +297 -0
  145. data/lib/sendpost_ruby_sdk/models/error_response_error_details_inner.rb +231 -0
  146. data/lib/sendpost_ruby_sdk/models/event.rb +94 -118
  147. data/lib/sendpost_ruby_sdk/models/event_metadata.rb +15 -5
  148. data/lib/sendpost_ruby_sdk/models/geo_location.rb +20 -14
  149. data/lib/sendpost_ruby_sdk/models/group_stat.rb +339 -0
  150. data/lib/sendpost_ruby_sdk/models/ip.rb +72 -375
  151. data/lib/sendpost_ruby_sdk/models/ip_allocation_request.rb +29 -33
  152. data/lib/sendpost_ruby_sdk/models/ip_deletion_response.rb +5 -4
  153. data/lib/sendpost_ruby_sdk/models/ip_pool.rb +94 -82
  154. data/lib/sendpost_ruby_sdk/models/ip_pool_create_request.rb +91 -29
  155. data/lib/sendpost_ruby_sdk/models/ip_pool_delete_response.rb +5 -2
  156. data/lib/sendpost_ruby_sdk/models/ip_pool_stat.rb +359 -0
  157. data/lib/sendpost_ruby_sdk/models/ip_pool_update_request.rb +97 -7
  158. data/lib/sendpost_ruby_sdk/models/ip_stat.rb +369 -0
  159. data/lib/sendpost_ruby_sdk/models/ip_update_request.rb +4 -20
  160. data/lib/sendpost_ruby_sdk/models/label.rb +101 -6
  161. data/lib/sendpost_ruby_sdk/models/member.rb +49 -57
  162. data/lib/sendpost_ruby_sdk/models/message.rb +39 -120
  163. data/lib/sendpost_ruby_sdk/models/new_sub_account.rb +257 -0
  164. data/lib/sendpost_ruby_sdk/models/new_webhook.rb +407 -0
  165. data/lib/sendpost_ruby_sdk/models/os.rb +262 -0
  166. data/lib/sendpost_ruby_sdk/models/postmaster_domain_stat.rb +282 -0
  167. data/lib/sendpost_ruby_sdk/models/provider_stat.rb +339 -0
  168. data/lib/sendpost_ruby_sdk/models/r_stat.rb +231 -0
  169. data/lib/sendpost_ruby_sdk/models/raip_pool_stat.rb +231 -0
  170. data/lib/sendpost_ruby_sdk/models/rd_stat.rb +231 -0
  171. data/lib/sendpost_ruby_sdk/models/recipient.rb +82 -3
  172. data/lib/sendpost_ruby_sdk/models/rip_stat.rb +231 -0
  173. data/lib/sendpost_ruby_sdk/models/sd_stat.rb +349 -0
  174. data/lib/sendpost_ruby_sdk/models/seed_contact_stats.rb +281 -0
  175. data/lib/sendpost_ruby_sdk/models/smtp_auth.rb +10 -29
  176. data/lib/sendpost_ruby_sdk/models/stat.rb +108 -16
  177. data/lib/sendpost_ruby_sdk/models/sub_account.rb +57 -115
  178. data/lib/sendpost_ruby_sdk/models/sub_account_stat.rb +359 -0
  179. data/lib/sendpost_ruby_sdk/models/sub_account_stat_for_pool.rb +349 -0
  180. data/lib/sendpost_ruby_sdk/models/suppression.rb +82 -15
  181. data/lib/sendpost_ruby_sdk/models/tpsp_stat.rb +349 -0
  182. data/lib/sendpost_ruby_sdk/models/update_sub_account.rb +32 -3
  183. data/lib/sendpost_ruby_sdk/models/update_webhook.rb +83 -37
  184. data/lib/sendpost_ruby_sdk/models/user_agent.rb +11 -6
  185. data/lib/sendpost_ruby_sdk/models/validation_stat.rb +292 -0
  186. data/lib/sendpost_ruby_sdk/models/webhook.rb +108 -67
  187. data/lib/sendpost_ruby_sdk/models/webhook_object.rb +232 -0
  188. data/lib/sendpost_ruby_sdk/version.rb +3 -3
  189. data/lib/sendpost_ruby_sdk.rb +36 -27
  190. data/sendpost_ruby_sdk.gemspec +39 -0
  191. data/spec/api/webhook_reference_api_spec.rb +46 -0
  192. data/spec/models/account_cycle_usage_spec.rb +36 -0
  193. data/spec/models/account_webhook_with_stats_spec.rb +160 -0
  194. data/spec/models/blacklist_links_spec.rb +42 -0
  195. data/spec/models/blacklist_resource_spec.rb +96 -0
  196. data/spec/models/blacklisted_on_spec.rb +42 -0
  197. data/spec/models/daily_statistics_spec.rb +96 -0
  198. data/spec/models/date_stat_spec.rb +102 -0
  199. data/spec/models/delete_suppression200_response_spec.rb +36 -0
  200. data/spec/models/delete_suppression_request_suppressions_inner_spec.rb +36 -0
  201. data/spec/models/dns_record_spec.rb +52 -0
  202. data/spec/models/domain_stat_spec.rb +120 -0
  203. data/spec/models/email_type_stat_spec.rb +102 -0
  204. data/spec/models/error_response_error_details_inner_spec.rb +42 -0
  205. data/spec/models/error_response_error_spec.rb +64 -0
  206. data/spec/models/error_response_spec.rb +36 -0
  207. data/spec/models/group_stat_spec.rb +102 -0
  208. data/spec/models/ip_pool_stat_spec.rb +114 -0
  209. data/spec/models/ip_stat_spec.rb +120 -0
  210. data/spec/models/new_sub_account_spec.rb +36 -0
  211. data/spec/models/new_webhook_spec.rb +120 -0
  212. data/spec/models/os_spec.rb +60 -0
  213. data/spec/models/postmaster_domain_stat_spec.rb +72 -0
  214. data/spec/models/provider_stat_spec.rb +102 -0
  215. data/spec/models/r_stat_spec.rb +42 -0
  216. data/spec/models/raip_pool_stat_spec.rb +42 -0
  217. data/spec/models/rd_stat_spec.rb +42 -0
  218. data/spec/models/rip_stat_spec.rb +42 -0
  219. data/spec/models/sd_stat_spec.rb +108 -0
  220. data/spec/models/seed_contact_stats_spec.rb +66 -0
  221. data/spec/models/sub_account_stat_for_pool_spec.rb +108 -0
  222. data/spec/models/sub_account_stat_spec.rb +114 -0
  223. data/spec/models/tpsp_stat_spec.rb +108 -0
  224. data/spec/models/validation_stat_spec.rb +78 -0
  225. data/spec/models/webhook_object_spec.rb +42 -0
  226. data/spec/spec_helper.rb +2 -2
  227. metadata +143 -219
  228. data/LICENSE +0 -21
  229. data/docs/AccountStatsStat.md +0 -38
  230. data/docs/AggregatedEmailStats.md +0 -38
  231. data/docs/AutoWarmupPlan.md +0 -80
  232. data/docs/CreateSubAccountRequest.md +0 -18
  233. data/docs/CreateWebhookRequest.md +0 -46
  234. data/docs/DomainDkim.md +0 -22
  235. data/docs/DomainDmarc.md +0 -22
  236. data/docs/DomainGpt.md +0 -22
  237. data/docs/DomainReturnPath.md +0 -22
  238. data/docs/DomainSpf.md +0 -22
  239. data/docs/DomainTrack.md +0 -22
  240. data/docs/EmailMessageFrom.md +0 -20
  241. data/docs/EmailMessageToInner.md +0 -26
  242. data/docs/EmailMessageToInnerBccInner.md +0 -22
  243. data/docs/EmailMessageToInnerCcInner.md +0 -22
  244. data/docs/EmailStats.md +0 -20
  245. data/docs/EmailStatsStats.md +0 -38
  246. data/docs/MessageHeaderTo.md +0 -26
  247. data/docs/MessageTo.md +0 -26
  248. data/docs/OperatingSystem.md +0 -26
  249. data/docs/Person.md +0 -20
  250. data/docs/StatStat.md +0 -38
  251. data/docs/StatStats.md +0 -38
  252. data/docs/ThirdPartySendingProvider.md +0 -38
  253. data/lib/sendpost_ruby_sdk/models/account_stats_stat.rb +0 -311
  254. data/lib/sendpost_ruby_sdk/models/aggregated_email_stats.rb +0 -321
  255. data/lib/sendpost_ruby_sdk/models/auto_warmup_plan.rb +0 -531
  256. data/lib/sendpost_ruby_sdk/models/create_sub_account_request.rb +0 -221
  257. data/lib/sendpost_ruby_sdk/models/create_webhook_request.rb +0 -361
  258. data/lib/sendpost_ruby_sdk/models/delete_suppression200_response_inner.rb +0 -231
  259. data/lib/sendpost_ruby_sdk/models/domain_dkim.rb +0 -239
  260. data/lib/sendpost_ruby_sdk/models/domain_dmarc.rb +0 -239
  261. data/lib/sendpost_ruby_sdk/models/domain_gpt.rb +0 -239
  262. data/lib/sendpost_ruby_sdk/models/domain_return_path.rb +0 -239
  263. data/lib/sendpost_ruby_sdk/models/domain_spf.rb +0 -239
  264. data/lib/sendpost_ruby_sdk/models/domain_track.rb +0 -239
  265. data/lib/sendpost_ruby_sdk/models/email_message_from.rb +0 -229
  266. data/lib/sendpost_ruby_sdk/models/email_message_reply_to.rb +0 -229
  267. data/lib/sendpost_ruby_sdk/models/email_message_to_inner.rb +0 -262
  268. data/lib/sendpost_ruby_sdk/models/email_message_to_inner_bcc_inner.rb +0 -240
  269. data/lib/sendpost_ruby_sdk/models/email_message_to_inner_cc_inner.rb +0 -240
  270. data/lib/sendpost_ruby_sdk/models/email_stats.rb +0 -230
  271. data/lib/sendpost_ruby_sdk/models/email_stats_stats.rb +0 -321
  272. data/lib/sendpost_ruby_sdk/models/message_header_to.rb +0 -268
  273. data/lib/sendpost_ruby_sdk/models/message_to.rb +0 -268
  274. data/lib/sendpost_ruby_sdk/models/operating_system.rb +0 -256
  275. data/lib/sendpost_ruby_sdk/models/person.rb +0 -231
  276. data/lib/sendpost_ruby_sdk/models/stat_stat.rb +0 -322
  277. data/lib/sendpost_ruby_sdk/models/stat_stats.rb +0 -321
  278. data/lib/sendpost_ruby_sdk/models/third_party_sending_provider.rb +0 -310
  279. data/spec/api/domain_api_spec.rb +0 -85
  280. data/spec/api/email_api_spec.rb +0 -59
  281. data/spec/api/ip_api_spec.rb +0 -98
  282. data/spec/api/ip_pools_api_spec.rb +0 -98
  283. data/spec/api/message_api_spec.rb +0 -47
  284. data/spec/api/stats_a_api_spec.rb +0 -89
  285. data/spec/api/stats_api_spec.rb +0 -78
  286. data/spec/api/sub_account_api_spec.rb +0 -98
  287. data/spec/api/suppression_api_spec.rb +0 -76
  288. data/spec/api/webhook_api_spec.rb +0 -98
  289. data/spec/models/account_stats_spec.rb +0 -42
  290. data/spec/models/account_stats_stat_spec.rb +0 -96
  291. data/spec/models/aggregate_stat_spec.rb +0 -96
  292. data/spec/models/aggregate_stats_spec.rb +0 -96
  293. data/spec/models/aggregated_email_stats_spec.rb +0 -96
  294. data/spec/models/attachment_spec.rb +0 -42
  295. data/spec/models/auto_warmup_plan_spec.rb +0 -222
  296. data/spec/models/copy_to_spec.rb +0 -48
  297. data/spec/models/create_domain_request_spec.rb +0 -36
  298. data/spec/models/create_sub_account_request_spec.rb +0 -36
  299. data/spec/models/create_suppression_request_hard_bounce_inner_spec.rb +0 -36
  300. data/spec/models/create_suppression_request_manual_inner_spec.rb +0 -36
  301. data/spec/models/create_suppression_request_spam_complaint_inner_spec.rb +0 -36
  302. data/spec/models/create_suppression_request_spec.rb +0 -54
  303. data/spec/models/create_suppression_request_unsubscribe_inner_spec.rb +0 -36
  304. data/spec/models/create_webhook_request_spec.rb +0 -120
  305. data/spec/models/delete_response_spec.rb +0 -42
  306. data/spec/models/delete_sub_account_response_spec.rb +0 -42
  307. data/spec/models/delete_suppression200_response_inner_spec.rb +0 -42
  308. data/spec/models/delete_suppression_request_spec.rb +0 -36
  309. data/spec/models/delete_webhook_response_spec.rb +0 -42
  310. data/spec/models/device_spec.rb +0 -36
  311. data/spec/models/domain_dkim_spec.rb +0 -48
  312. data/spec/models/domain_dmarc_spec.rb +0 -48
  313. data/spec/models/domain_gpt_spec.rb +0 -48
  314. data/spec/models/domain_return_path_spec.rb +0 -48
  315. data/spec/models/domain_spec.rb +0 -150
  316. data/spec/models/domain_spf_spec.rb +0 -48
  317. data/spec/models/domain_track_spec.rb +0 -48
  318. data/spec/models/eip_spec.rb +0 -36
  319. data/spec/models/email_address_spec.rb +0 -42
  320. data/spec/models/email_message_from_spec.rb +0 -42
  321. data/spec/models/email_message_object_spec.rb +0 -120
  322. data/spec/models/email_message_reply_to_spec.rb +0 -42
  323. data/spec/models/email_message_spec.rb +0 -138
  324. data/spec/models/email_message_to_inner_bcc_inner_spec.rb +0 -48
  325. data/spec/models/email_message_to_inner_cc_inner_spec.rb +0 -48
  326. data/spec/models/email_message_to_inner_spec.rb +0 -60
  327. data/spec/models/email_message_with_template_spec.rb +0 -138
  328. data/spec/models/email_response_spec.rb +0 -60
  329. data/spec/models/email_stats_spec.rb +0 -42
  330. data/spec/models/email_stats_stats_spec.rb +0 -96
  331. data/spec/models/event_metadata_spec.rb +0 -84
  332. data/spec/models/event_spec.rb +0 -150
  333. data/spec/models/geo_location_spec.rb +0 -60
  334. data/spec/models/ip_allocation_request_spec.rb +0 -42
  335. data/spec/models/ip_deletion_response_spec.rb +0 -42
  336. data/spec/models/ip_pool_create_request_spec.rb +0 -66
  337. data/spec/models/ip_pool_delete_response_spec.rb +0 -42
  338. data/spec/models/ip_pool_spec.rb +0 -108
  339. data/spec/models/ip_pool_update_request_spec.rb +0 -54
  340. data/spec/models/ip_spec.rb +0 -168
  341. data/spec/models/ip_update_request_spec.rb +0 -36
  342. data/spec/models/label_spec.rb +0 -48
  343. data/spec/models/member_spec.rb +0 -102
  344. data/spec/models/message_header_to_spec.rb +0 -60
  345. data/spec/models/message_spec.rb +0 -210
  346. data/spec/models/message_to_spec.rb +0 -60
  347. data/spec/models/operating_system_spec.rb +0 -60
  348. data/spec/models/person_spec.rb +0 -42
  349. data/spec/models/recipient_spec.rb +0 -60
  350. data/spec/models/smtp_auth_spec.rb +0 -60
  351. data/spec/models/stat_spec.rb +0 -42
  352. data/spec/models/stat_stat_spec.rb +0 -96
  353. data/spec/models/stat_stats_spec.rb +0 -96
  354. data/spec/models/sub_account_spec.rb +0 -130
  355. data/spec/models/suppression_spec.rb +0 -60
  356. data/spec/models/third_party_sending_provider_spec.rb +0 -96
  357. data/spec/models/update_sub_account_spec.rb +0 -36
  358. data/spec/models/update_webhook_spec.rb +0 -120
  359. data/spec/models/user_agent_spec.rb +0 -54
  360. data/spec/models/webhook_spec.rb +0 -144
@@ -0,0 +1,18 @@
1
+ # Sendpost::AccountCycleUsage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **processed** | **Integer** | Total emails processed by the account since the last billing cycle reset. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'sendpost_ruby_sdk'
13
+
14
+ instance = Sendpost::AccountCycleUsage.new(
15
+ processed: 15230
16
+ )
17
+ ```
18
+
data/docs/AccountStats.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **date** | **Date** | | [optional] |
8
- | **stat** | [**AccountStatsStat**](AccountStatsStat.md) | | [optional] |
7
+ | **date** | **Date** | The date for these statistics (UTC) | [optional] |
8
+ | **stat** | [**DailyStatistics**](DailyStatistics.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,7 +13,7 @@
13
13
  require 'sendpost_ruby_sdk'
14
14
 
15
15
  instance = Sendpost::AccountStats.new(
16
- date: 2020-03-12,
16
+ date: 2024-01-15,
17
17
  stat: null
18
18
  )
19
19
  ```
@@ -0,0 +1,58 @@
1
+ # Sendpost::AccountWebhookWithStats
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | Unique identifier for the webhook configuration | [optional] |
8
+ | **enabled** | **Boolean** | Whether the webhook is active. When false, no events will be sent to this webhook. Useful for temporarily pausing notifications during maintenance. | [optional] |
9
+ | **url** | **String** | HTTPS endpoint URL to receive webhook POST requests. Must be publicly accessible and return 2xx status code. | [optional] |
10
+ | **processed** | **Boolean** | Trigger webhook when an email is accepted for processing. Fires immediately when API call is successful. | [optional] |
11
+ | **sent** | **Boolean** | Trigger webhook when an email is sent to the recipient's mail server. Indicates the email left SendPost's infrastructure. | [optional] |
12
+ | **dropped** | **Boolean** | Trigger webhook when an email is dropped before sending. Common reasons: suppressed address, invalid email, unverified domain. | [optional] |
13
+ | **smtp_dropped** | **Boolean** | Trigger webhook when an email is dropped at SMTP level. Usually due to policy rejection by receiving server. | [optional] |
14
+ | **delivered** | **Boolean** | Trigger webhook when an email is successfully delivered. Note: \"Delivered\" means accepted by mail server, not inbox placement. | [optional] |
15
+ | **soft_bounced** | **Boolean** | Trigger webhook on temporary delivery failure (soft bounce). SendPost will retry delivery automatically. | [optional] |
16
+ | **hard_bounced** | **Boolean** | Trigger webhook on permanent delivery failure (hard bounce). The recipient is automatically added to suppression list. | [optional] |
17
+ | **opened** | **Boolean** | Trigger webhook when recipient opens the email. Fires on every open (can fire multiple times per email). | [optional] |
18
+ | **clicked** | **Boolean** | Trigger webhook when recipient clicks a link. Fires on every click (can fire multiple times per email). | [optional] |
19
+ | **unsubscribed** | **Boolean** | Trigger webhook when recipient clicks the unsubscribe link. The recipient is automatically added to suppression list. | [optional] |
20
+ | **spam** | **Boolean** | Trigger webhook when recipient marks email as spam. The recipient is automatically added to suppression list. Monitor this closely - high spam rates damage sender reputation. | [optional] |
21
+ | **unique_open** | **Boolean** | Trigger webhook only on the first open of an email (unique opens). Use this instead of 'opened' if you only care about unique engagement. | [optional] |
22
+ | **unique_click** | **Boolean** | Trigger webhook only on the first click of an email (unique clicks). Use this instead of 'clicked' if you only care about unique engagement. | [optional] |
23
+ | **status** | **String** | Health status of the webhook (read-only): - `active` - delivering normally - `degraded` - recent delivery failures - `disabled` - auto-disabled after repeated consecutive failures | [optional] |
24
+ | **disabled_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the webhook was auto-disabled (0 if never). Read-only. | [optional] |
25
+ | **disabled_reason** | **String** | Human-readable reason the webhook was auto-disabled (empty if active). Read-only. | [optional] |
26
+ | **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the webhook was created | [optional] |
27
+ | **success_rate** | **Float** | Percentage of webhook deliveries that succeeded (2xx responses) over the recent measurement window. Ranges from 0 to 100. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'sendpost_ruby_sdk'
33
+
34
+ instance = Sendpost::AccountWebhookWithStats.new(
35
+ id: 117,
36
+ enabled: true,
37
+ url: https://app.hooli.com/api/webhooks/sendpost,
38
+ processed: true,
39
+ sent: true,
40
+ dropped: true,
41
+ smtp_dropped: false,
42
+ delivered: true,
43
+ soft_bounced: true,
44
+ hard_bounced: true,
45
+ opened: true,
46
+ clicked: true,
47
+ unsubscribed: true,
48
+ spam: true,
49
+ unique_open: false,
50
+ unique_click: false,
51
+ status: active,
52
+ disabled_at: 0,
53
+ disabled_reason: ,
54
+ created: 1704067200000000000,
55
+ success_rate: 99.5
56
+ )
57
+ ```
58
+
@@ -4,17 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **processed** | **Integer** | Number of emails accepted by SendPost API. | [optional] |
8
- | **sent** | **Integer** | Number of emails sent. | [optional] |
9
- | **delivered** | **Integer** | Number of emails we were able to successfully deliver at SMTP without encountering any error | [optional] |
10
- | **dropped** | **Integer** | Number of emails drop without attempting to deliver either because the email is invalid or email in in existing suppression list | [optional] |
11
- | **smtp_dropped** | **Integer** | Number of emails dropped by SMTP. | [optional] |
12
- | **hard_bounced** | **Integer** | Number of emails where we got SMTP hard bounce error code by the recipient mail provider | [optional] |
13
- | **soft_bounced** | **Integer** | Number of emails where we got temporary soft bounce error by the recipent mail provider. Soft bounced emails are retried upto 5 times over 24 hour period before marking them as hardBounced. | [optional] |
14
- | **opened** | **Integer** | Number of emails opened by recipients | [optional] |
15
- | **clicked** | **Integer** | Number of email links clicked by recipients | [optional] |
16
- | **unsubscribed** | **Integer** | Number of email recipients who unsubscribed from receiving further emails | [optional] |
17
- | **spam** | **Integer** | Number of email recipients who marked emails as spam | [optional] |
7
+ | **processed** | **Integer** | Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API. | [optional] |
8
+ | **sent** | **Integer** | Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped | [optional] |
9
+ | **dropped** | **Integer** | Number of emails dropped before sending. Common reasons: - Recipient email in suppression list (hard bounce, spam complaint, unsubscribe) - Invalid recipient email format - Sender domain not verified | [optional] |
10
+ | **smtp_dropped** | **Integer** | Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed. | [optional] |
11
+ | **delivered** | **Integer** | Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox. | [optional] |
12
+ | **soft_bounced** | **Integer** | Number of temporary delivery failures (soft bounces). Common causes: - Recipient mailbox full - Server temporarily unavailable - Message too large SendPost automatically retries soft bounces. | [optional] |
13
+ | **hard_bounced** | **Integer** | Number of permanent delivery failures (hard bounces). Common causes: - Recipient email doesn't exist - Domain doesn't exist - Recipient has blocked sender Hard bounced addresses are automatically added to suppression list. | [optional] |
14
+ | **opened** | **Integer** | Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels. | [optional] |
15
+ | **clicked** | **Integer** | Number of emails with at least one link clicked. Requires trackClicks=true. | [optional] |
16
+ | **unsubscribed** | **Integer** | Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list. | [optional] |
17
+ | **spam** | **Integer** | Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%. | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -24,13 +24,13 @@ require 'sendpost_ruby_sdk'
24
24
  instance = Sendpost::AggregateStat.new(
25
25
  processed: 225,
26
26
  sent: 220,
27
- delivered: 200,
28
27
  dropped: 10,
29
28
  smtp_dropped: 5,
30
- hard_bounced: 10,
29
+ delivered: 200,
31
30
  soft_bounced: 5,
31
+ hard_bounced: 10,
32
32
  opened: 150,
33
- clicked: 130,
33
+ clicked: 50,
34
34
  unsubscribed: 6,
35
35
  spam: 2
36
36
  )
@@ -4,17 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **processed** | **Integer** | | [optional] |
8
- | **sent** | **Integer** | | [optional] |
9
- | **delivered** | **Integer** | | [optional] |
10
- | **dropped** | **Integer** | | [optional] |
11
- | **smtp_dropped** | **Integer** | | [optional] |
12
- | **hard_bounced** | **Integer** | | [optional] |
13
- | **soft_bounced** | **Integer** | | [optional] |
14
- | **opened** | **Integer** | | [optional] |
15
- | **clicked** | **Integer** | | [optional] |
16
- | **unsubscribed** | **Integer** | | [optional] |
17
- | **spams** | **Integer** | | [optional] |
7
+ | **processed** | **Integer** | Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API. | [optional] |
8
+ | **sent** | **Integer** | Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped | [optional] |
9
+ | **dropped** | **Integer** | Number of emails dropped before sending. Common reasons: - Recipient email in suppression list (hard bounce, spam complaint, unsubscribe) - Invalid recipient email format - Sender domain not verified | [optional] |
10
+ | **smtp_dropped** | **Integer** | Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed. | [optional] |
11
+ | **delivered** | **Integer** | Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox. | [optional] |
12
+ | **soft_bounced** | **Integer** | Number of temporary delivery failures (soft bounces). Common causes: - Recipient mailbox full - Server temporarily unavailable - Message too large SendPost automatically retries soft bounces. | [optional] |
13
+ | **hard_bounced** | **Integer** | Number of permanent delivery failures (hard bounces). Common causes: - Recipient email doesn't exist - Domain doesn't exist - Recipient has blocked sender Hard bounced addresses are automatically added to suppression list. | [optional] |
14
+ | **opened** | **Integer** | Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels. | [optional] |
15
+ | **clicked** | **Integer** | Number of emails with at least one link clicked. Requires trackClicks=true. | [optional] |
16
+ | **unsubscribed** | **Integer** | Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list. | [optional] |
17
+ | **spam** | **Integer** | Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%. | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -22,17 +22,17 @@
22
22
  require 'sendpost_ruby_sdk'
23
23
 
24
24
  instance = Sendpost::AggregateStats.new(
25
- processed: 22500,
26
- sent: 22400,
27
- delivered: 20000,
28
- dropped: 1000,
29
- smtp_dropped: 400,
30
- hard_bounced: 1000,
31
- soft_bounced: 500,
32
- opened: 5000,
33
- clicked: 3000,
34
- unsubscribed: 500,
35
- spams: 200
25
+ processed: 225,
26
+ sent: 220,
27
+ dropped: 10,
28
+ smtp_dropped: 5,
29
+ delivered: 200,
30
+ soft_bounced: 5,
31
+ hard_bounced: 10,
32
+ opened: 150,
33
+ clicked: 50,
34
+ unsubscribed: 6,
35
+ spam: 2
36
36
  )
37
37
  ```
38
38
 
data/docs/Attachment.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **content** | **String** | Base64 encoded attachment content | [optional] |
8
- | **filename** | **String** | Name of the attachment file | [optional] |
7
+ | **content** | **String** | Base64 encoded content of the attachment file. Ensure proper encoding to avoid corruption. | |
8
+ | **filename** | **String** | Name of the attachment file as it will appear to recipients. Include the file extension (e.g., \"report.pdf\", \"image.png\"). | |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'sendpost_ruby_sdk'
14
14
 
15
15
  instance = Sendpost::Attachment.new(
16
- content: null,
17
- filename: null
16
+ content: SGVsbG8gV29ybGQh,
17
+ filename: invoice-12345.pdf
18
18
  )
19
19
  ```
20
20
 
@@ -0,0 +1,20 @@
1
+ # Sendpost::BlacklistLinks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **report_link** | **String** | Link to the full blacklist report for this resource. | [optional] |
8
+ | **whitelabel_report_link** | **String** | White-labelled variant of the blacklist report link. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'sendpost_ruby_sdk'
14
+
15
+ instance = Sendpost::BlacklistLinks.new(
16
+ report_link: https://app.sendpost.io/reports/blacklist/abc123,
17
+ whitelabel_report_link: https://reports.hooli.com/blacklist/abc123
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # Sendpost::BlacklistResource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the blacklist resource entry. | [optional] |
8
+ | **type** | **String** | The kind of target being monitored (e.g. `domain` or `ip`). | [optional] |
9
+ | **target** | **String** | The domain or IP address being monitored for blacklisting. | [optional] |
10
+ | **add_date** | **Integer** | UNIX epoch timestamp when the resource was added to monitoring. | [optional] |
11
+ | **last_check** | **Integer** | UNIX epoch timestamp of the most recent blacklist check. | [optional] |
12
+ | **status** | **String** | Current blacklist status of the target (e.g. `clean`, `listed`). | [optional] |
13
+ | **label** | **String** | User-assigned label for the monitored resource. | [optional] |
14
+ | **contact_list_id** | **String** | Identifier of the contact list associated with this resource, if any. | [optional] |
15
+ | **blacklisted_count** | **String** | Number of RBLs the target is currently listed on (string-encoded). | [optional] |
16
+ | **blacklisted_on** | [**Array<BlacklistedOn>**](BlacklistedOn.md) | The specific RBLs this target is currently listed on. | [optional] |
17
+ | **links** | [**BlacklistLinks**](BlacklistLinks.md) | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'sendpost_ruby_sdk'
23
+
24
+ instance = Sendpost::BlacklistResource.new(
25
+ id: abc123,
26
+ type: ip,
27
+ target: 192.0.2.10,
28
+ add_date: 1704067200,
29
+ last_check: 1704153600,
30
+ status: listed,
31
+ label: Primary sending IP,
32
+ contact_list_id: ,
33
+ blacklisted_count: 2,
34
+ blacklisted_on: null,
35
+ links: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # Sendpost::BlacklistedOn
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rbl** | **String** | Name/host of the real-time blacklist (RBL) the target is listed on. | [optional] |
8
+ | **delist** | **String** | URL or instructions for requesting delisting from this RBL. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'sendpost_ruby_sdk'
14
+
15
+ instance = Sendpost::BlacklistedOn.new(
16
+ rbl: b.barracudacentral.org,
17
+ delist: https://www.barracudacentral.org/rbl/removal-request
18
+ )
19
+ ```
20
+
data/docs/CopyTo.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **custom_fields** | **Hash<String, Object>** | Custom fields for personalization | [optional] |
7
+ | **email** | **String** | The CC/BCC recipient's email address | |
8
+ | **name** | **String** | The CC/BCC recipient's display name | [optional] |
9
+ | **custom_fields** | **Hash<String, Object>** | Custom fields specific to this CC/BCC recipient. Allows personalization in CC/BCC copies of the email. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -14,9 +14,9 @@
14
14
  require 'sendpost_ruby_sdk'
15
15
 
16
16
  instance = Sendpost::CopyTo.new(
17
- email: null,
18
- name: null,
19
- custom_fields: null
17
+ email: cc@example.com,
18
+ name: Copy Recipient,
19
+ custom_fields: {role=Manager}
20
20
  )
21
21
  ```
22
22
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name of the domain (e.g., hooli.com). | [optional] |
7
+ | **name** | **String** | The domain name to add for sending emails. Must be a valid domain you own and can configure DNS records for. Example: piedpiper.com (not subdomain like mail.piedpiper.com) | |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::CreateDomainRequest.new(
15
- name: hooli.com
15
+ name: piedpiper.com
16
16
  )
17
17
  ```
18
18
 
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **hard_bounce** | [**Array<CreateSuppressionRequestHardBounceInner>**](CreateSuppressionRequestHardBounceInner.md) | list of email addresses which you want to mark in hardBounce suppression list | [optional] |
8
- | **manual** | [**Array<CreateSuppressionRequestManualInner>**](CreateSuppressionRequestManualInner.md) | list of email addresses which you want to mark in manual suppression list | [optional] |
9
- | **unsubscribe** | [**Array<CreateSuppressionRequestUnsubscribeInner>**](CreateSuppressionRequestUnsubscribeInner.md) | list of email addresses which you want to mark in unsubscribe suppression list | [optional] |
10
- | **spam_complaint** | [**Array<CreateSuppressionRequestSpamComplaintInner>**](CreateSuppressionRequestSpamComplaintInner.md) | list of email addresses which you want to mark in spamComplaint suppression list | [optional] |
7
+ | **hard_bounce** | [**Array<CreateSuppressionRequestHardBounceInner>**](CreateSuppressionRequestHardBounceInner.md) | Email addresses with known permanent delivery issues (invalid, non-existent domains). | [optional] |
8
+ | **manual** | [**Array<CreateSuppressionRequestManualInner>**](CreateSuppressionRequestManualInner.md) | Email addresses to suppress without specific categorization (do-not-contact requests, etc.). | [optional] |
9
+ | **unsubscribe** | [**Array<CreateSuppressionRequestUnsubscribeInner>**](CreateSuppressionRequestUnsubscribeInner.md) | Email addresses of users who opted out via external unsubscribe mechanisms. | [optional] |
10
+ | **spam_complaint** | [**Array<CreateSuppressionRequestSpamComplaintInner>**](CreateSuppressionRequestSpamComplaintInner.md) | Email addresses that reported spam via external feedback loops. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::CreateSuppressionRequestHardBounceInner.new(
15
- email: jackbarker@hooli.com
15
+ email: invalid-user@deleted-domain.com
16
16
  )
17
17
  ```
18
18
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::CreateSuppressionRequestManualInner.new(
15
- email: russhannelman@gmail.com
15
+ email: contact-support@company.com
16
16
  )
17
17
  ```
18
18
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::CreateSuppressionRequestSpamComplaintInner.new(
15
- email: gilfoyle@piedpiper.com
15
+ email: complained-user@example.com
16
16
  )
17
17
  ```
18
18
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::CreateSuppressionRequestUnsubscribeInner.new(
15
- email: jared@piedpiper.com
15
+ email: opted-out-user@example.com
16
16
  )
17
17
  ```
18
18
 
@@ -0,0 +1,38 @@
1
+ # Sendpost::DailyStatistics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **processed** | **Integer** | Total emails accepted by the API | [optional] |
8
+ | **sent** | **Integer** | Total emails sent to recipient mail servers | [optional] |
9
+ | **dropped** | **Integer** | Total emails dropped before sending | [optional] |
10
+ | **smtp_dropped** | **Integer** | Total emails dropped at the SMTP level before delivery | [optional] |
11
+ | **delivered** | **Integer** | Total emails delivered successfully | [optional] |
12
+ | **soft_bounced** | **Integer** | Total temporary delivery failures | [optional] |
13
+ | **hard_bounced** | **Integer** | Total permanent delivery failures | [optional] |
14
+ | **opened** | **Integer** | Total email opens | [optional] |
15
+ | **clicked** | **Integer** | Total link clicks | [optional] |
16
+ | **unsubscribed** | **Integer** | Total unsubscribes | [optional] |
17
+ | **spam** | **Integer** | Total spam complaints | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'sendpost_ruby_sdk'
23
+
24
+ instance = Sendpost::DailyStatistics.new(
25
+ processed: 1225,
26
+ sent: 1210,
27
+ dropped: 10,
28
+ smtp_dropped: 5,
29
+ delivered: 1200,
30
+ soft_bounced: 5,
31
+ hard_bounced: 10,
32
+ opened: 150,
33
+ clicked: 130,
34
+ unsubscribed: 15,
35
+ spam: 12
36
+ )
37
+ ```
38
+
data/docs/DateStat.md ADDED
@@ -0,0 +1,40 @@
1
+ # Sendpost::DateStat
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **processed** | **Integer** | Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API. | [optional] |
8
+ | **sent** | **Integer** | Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped | [optional] |
9
+ | **dropped** | **Integer** | Number of emails dropped before sending. Common reasons: - Recipient email in suppression list (hard bounce, spam complaint, unsubscribe) - Invalid recipient email format - Sender domain not verified | [optional] |
10
+ | **smtp_dropped** | **Integer** | Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed. | [optional] |
11
+ | **delivered** | **Integer** | Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox. | [optional] |
12
+ | **soft_bounced** | **Integer** | Number of temporary delivery failures (soft bounces). Common causes: - Recipient mailbox full - Server temporarily unavailable - Message too large SendPost automatically retries soft bounces. | [optional] |
13
+ | **hard_bounced** | **Integer** | Number of permanent delivery failures (hard bounces). Common causes: - Recipient email doesn't exist - Domain doesn't exist - Recipient has blocked sender Hard bounced addresses are automatically added to suppression list. | [optional] |
14
+ | **opened** | **Integer** | Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels. | [optional] |
15
+ | **clicked** | **Integer** | Number of emails with at least one link clicked. Requires trackClicks=true. | [optional] |
16
+ | **unsubscribed** | **Integer** | Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list. | [optional] |
17
+ | **spam** | **Integer** | Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%. | [optional] |
18
+ | **date** | **Date** | The date these statistics apply to (YYYY-MM-DD, UTC). | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'sendpost_ruby_sdk'
24
+
25
+ instance = Sendpost::DateStat.new(
26
+ processed: 225,
27
+ sent: 220,
28
+ dropped: 10,
29
+ smtp_dropped: 5,
30
+ delivered: 200,
31
+ soft_bounced: 5,
32
+ hard_bounced: 10,
33
+ opened: 150,
34
+ clicked: 50,
35
+ unsubscribed: 6,
36
+ spam: 2,
37
+ date: 2024-01-15
38
+ )
39
+ ```
40
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | ID of the deleted domain. | [optional] |
8
- | **message** | **String** | Success message. | [optional] |
7
+ | **id** | **Integer** | ID of the deleted resource | [optional] |
8
+ | **message** | **String** | Human-readable confirmation message | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'sendpost_ruby_sdk'
14
14
 
15
15
  instance = Sendpost::DeleteResponse.new(
16
- id: null,
17
- message: null
16
+ id: 117,
17
+ message: Resource has been deleted successfully
18
18
  )
19
19
  ```
20
20
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | Unique ID for the deleted sub-account. | [optional] |
8
- | **message** | **String** | Message confirming the deletion. | [optional] |
7
+ | **id** | **Integer** | ID of the deleted sub-account | [optional] |
8
+ | **message** | **String** | Confirmation message | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'sendpost_ruby_sdk'
14
14
 
15
15
  instance = Sendpost::DeleteSubAccountResponse.new(
16
- id: 12,
17
- message: Sub-Account (FoxHole V1) has been deleted successfully.
16
+ id: 50442,
17
+ message: Sub-Account (Marketing - Production) has been deleted successfully
18
18
  )
19
19
  ```
20
20
 
@@ -1,10 +1,9 @@
1
- # Sendpost::DeleteSuppression200ResponseInner
1
+ # Sendpost::DeleteSuppression200Response
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | The ID of the deleted suppression | [optional] |
8
7
  | **message** | **String** | A success message after the suppression(s) are deleted | [optional] |
9
8
 
10
9
  ## Example
@@ -12,8 +11,7 @@
12
11
  ```ruby
13
12
  require 'sendpost_ruby_sdk'
14
13
 
15
- instance = Sendpost::DeleteSuppression200ResponseInner.new(
16
- id: null,
14
+ instance = Sendpost::DeleteSuppression200Response.new(
17
15
  message: null
18
16
  )
19
17
  ```
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **suppressions** | [**Array<CreateSuppressionRequestSpamComplaintInner>**](CreateSuppressionRequestSpamComplaintInner.md) | | [optional] |
7
+ | **suppressions** | [**Array<DeleteSuppressionRequestSuppressionsInner>**](DeleteSuppressionRequestSuppressionsInner.md) | List of email addresses to remove from suppression. Each email will be removed regardless of suppression type. | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -1,10 +1,9 @@
1
- # Sendpost::EmailMessageReplyTo
1
+ # Sendpost::DeleteSuppressionRequestSuppressionsInner
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
7
  | **email** | **String** | | [optional] |
9
8
 
10
9
  ## Example
@@ -12,9 +11,8 @@
12
11
  ```ruby
13
12
  require 'sendpost_ruby_sdk'
14
13
 
15
- instance = Sendpost::EmailMessageReplyTo.new(
16
- name: Gavin,
17
- email: gavin@hooli.com
14
+ instance = Sendpost::DeleteSuppressionRequestSuppressionsInner.new(
15
+ email: verified-user@example.com
18
16
  )
19
17
  ```
20
18
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | Unique ID of the deleted webhook. | [optional] |
8
- | **message** | **String** | Success message. | [optional] |
7
+ | **id** | **Integer** | ID of the deleted webhook | [optional] |
8
+ | **message** | **String** | Confirmation message | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -14,7 +14,7 @@ require 'sendpost_ruby_sdk'
14
14
 
15
15
  instance = Sendpost::DeleteWebhookResponse.new(
16
16
  id: 117,
17
- message: Webhook (https://app.hooli.com/email/webhook) has been deleted successfully.
17
+ message: Webhook (https://app.hooli.com/api/webhooks/sendpost) has been deleted successfully
18
18
  )
19
19
  ```
20
20
 
data/docs/Device.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **family** | **String** | | [optional] |
7
+ | **family** | **String** | Device type or model family. Common values: Mac, iPhone, iPad, Windows Desktop, Android, Other | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'sendpost_ruby_sdk'
13
13
 
14
14
  instance = Sendpost::Device.new(
15
- family:
15
+ family: Mac
16
16
  )
17
17
  ```
18
18