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
@@ -1,80 +0,0 @@
1
- # Sendpost::AutoWarmupPlan
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | Unique ID for the auto-warmup plan | [optional] |
8
- | **name** | **String** | Name of the auto-warmup plan | [optional] |
9
- | **gmail_warmup_plan** | **String** | Gmail warmup plan configuration in JSON format | [optional] |
10
- | **yahoo_warmup_plan** | **String** | Yahoo warmup plan configuration in JSON format | [optional] |
11
- | **aol_warmup_plan** | **String** | AOL warmup plan configuration in JSON format | [optional] |
12
- | **microsoft_warmup_plan** | **String** | Microsoft warmup plan configuration in JSON format | [optional] |
13
- | **comcast_warmup_plan** | **String** | Comcast warmup plan configuration in JSON format | [optional] |
14
- | **yandex_warmup_plan** | **String** | Yandex warmup plan configuration in JSON format | [optional] |
15
- | **gmx_warmup_plan** | **String** | GMX warmup plan configuration in JSON format | [optional] |
16
- | **mailru_warmup_plan** | **String** | Mail.ru warmup plan configuration in JSON format | [optional] |
17
- | **icloud_warmup_plan** | **String** | iCloud warmup plan configuration in JSON format | [optional] |
18
- | **zoho_warmup_plan** | **String** | Zoho warmup plan configuration in JSON format | [optional] |
19
- | **qq_warmup_plan** | **String** | QQ warmup plan configuration in JSON format | [optional] |
20
- | **default_warmup_plan** | **String** | Default warmup plan configuration in JSON format | [optional] |
21
- | **att_warmup_plan** | **String** | AT&T warmup plan configuration in JSON format | [optional] |
22
- | **office365_warmup_plan** | **String** | Office365 warmup plan configuration in JSON format | [optional] |
23
- | **googleworkspace_warmup_plan** | **String** | Google Workspace warmup plan configuration in JSON format | [optional] |
24
- | **proofpoint_warmup_plan** | **String** | Proofpoint warmup plan configuration in JSON format | [optional] |
25
- | **mimecast_warmup_plan** | **String** | Mimecast warmup plan configuration in JSON format | [optional] |
26
- | **barracuda_warmup_plan** | **String** | Barracuda warmup plan configuration in JSON format | [optional] |
27
- | **ciscoironport_warmup_plan** | **String** | Cisco IronPort warmup plan configuration in JSON format | [optional] |
28
- | **rackspace_warmup_plan** | **String** | Rackspace warmup plan configuration in JSON format | [optional] |
29
- | **zohobusiness_warmup_plan** | **String** | Zoho Business warmup plan configuration in JSON format | [optional] |
30
- | **amazonworkmail_warmup_plan** | **String** | Amazon WorkMail warmup plan configuration in JSON format | [optional] |
31
- | **symantec_warmup_plan** | **String** | Symantec warmup plan configuration in JSON format | [optional] |
32
- | **fortinet_warmup_plan** | **String** | Fortinet warmup plan configuration in JSON format | [optional] |
33
- | **sophos_warmup_plan** | **String** | Sophos warmup plan configuration in JSON format | [optional] |
34
- | **trendmicro_warmup_plan** | **String** | Trend Micro warmup plan configuration in JSON format | [optional] |
35
- | **checkpoint_warmup_plan** | **String** | Checkpoint warmup plan configuration in JSON format | [optional] |
36
- | **created** | **Integer** | UNIX epoch nano timestamp when the warmup plan was created | [optional] |
37
- | **updated** | **Integer** | UNIX epoch nano timestamp when the warmup plan was last updated | [optional] |
38
- | **warmup_interval** | **Integer** | Warmup interval in hours | [optional] |
39
-
40
- ## Example
41
-
42
- ```ruby
43
- require 'sendpost_ruby_sdk'
44
-
45
- instance = Sendpost::AutoWarmupPlan.new(
46
- id: 742,
47
- name: Default Auto Warmup Plan,
48
- gmail_warmup_plan: null,
49
- yahoo_warmup_plan: null,
50
- aol_warmup_plan: null,
51
- microsoft_warmup_plan: null,
52
- comcast_warmup_plan: null,
53
- yandex_warmup_plan: null,
54
- gmx_warmup_plan: null,
55
- mailru_warmup_plan: null,
56
- icloud_warmup_plan: null,
57
- zoho_warmup_plan: null,
58
- qq_warmup_plan: null,
59
- default_warmup_plan: null,
60
- att_warmup_plan: null,
61
- office365_warmup_plan: null,
62
- googleworkspace_warmup_plan: null,
63
- proofpoint_warmup_plan: null,
64
- mimecast_warmup_plan: null,
65
- barracuda_warmup_plan: null,
66
- ciscoironport_warmup_plan: null,
67
- rackspace_warmup_plan: null,
68
- zohobusiness_warmup_plan: null,
69
- amazonworkmail_warmup_plan: null,
70
- symantec_warmup_plan: null,
71
- fortinet_warmup_plan: null,
72
- sophos_warmup_plan: null,
73
- trendmicro_warmup_plan: null,
74
- checkpoint_warmup_plan: null,
75
- created: 1761234191727534000,
76
- updated: 1766535064510659800,
77
- warmup_interval: 24
78
- )
79
- ```
80
-
@@ -1,18 +0,0 @@
1
- # Sendpost::CreateSubAccountRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name for the new sub-account. | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'sendpost_ruby_sdk'
13
-
14
- instance = Sendpost::CreateSubAccountRequest.new(
15
- name: FoxHole
16
- )
17
- ```
18
-
@@ -1,46 +0,0 @@
1
- # Sendpost::CreateWebhookRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **enabled** | **Boolean** | Is the webhook active or in a paused state? | [optional] |
8
- | **url** | **String** | URL endpoint to which webhook calls are sent. | [optional] |
9
- | **processed** | **Boolean** | Trigger webhook on email message being processed. | [optional] |
10
- | **delivered** | **Boolean** | Trigger webhook on email message being delivered. | [optional] |
11
- | **dropped** | **Boolean** | Trigger webhook on email message being dropped. | [optional] |
12
- | **soft_bounced** | **Boolean** | Trigger webhook on email message being soft bounced. | [optional] |
13
- | **hard_bounced** | **Boolean** | Trigger webhook on email message being hard bounced. | [optional] |
14
- | **opened** | **Boolean** | Trigger webhook on email message being opened. | [optional] |
15
- | **clicked** | **Boolean** | Trigger webhook on email message link being clicked. | [optional] |
16
- | **unsubscribed** | **Boolean** | Trigger webhook on email message being unsubscribed. | [optional] |
17
- | **spam** | **Boolean** | Trigger webhook on email message being marked as spam. | [optional] |
18
- | **sent** | **Boolean** | Trigger webhook on email message being sent. | [optional] |
19
- | **smtp_dropped** | **Boolean** | Trigger webhook on email message being dropped by SMTP. | [optional] |
20
- | **unique_open** | **Boolean** | Trigger webhook on unique email opens. | [optional] |
21
- | **unique_click** | **Boolean** | Trigger webhook on unique email clicks. | [optional] |
22
-
23
- ## Example
24
-
25
- ```ruby
26
- require 'sendpost_ruby_sdk'
27
-
28
- instance = Sendpost::CreateWebhookRequest.new(
29
- enabled: true,
30
- url: https://app.hooli.com/email/webhook,
31
- processed: true,
32
- delivered: true,
33
- dropped: false,
34
- soft_bounced: false,
35
- hard_bounced: true,
36
- opened: true,
37
- clicked: true,
38
- unsubscribed: true,
39
- spam: true,
40
- sent: true,
41
- smtp_dropped: false,
42
- unique_open: true,
43
- unique_click: true
44
- )
45
- ```
46
-
data/docs/DomainDkim.md DELETED
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainDkim
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainDkim.new(
17
- host: sp-dkim._domainkey.example.com,
18
- type: TXT,
19
- text_value: v=DKIM1;k=rsa;s=email;h=sha256;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDU9T3mqruDth2rHXCqNiPzr4oRbHqcUMkqCA4sTZgK7WrhjzerHVyqNAfq4Tyx9s4Tqj0CVfAuENp9mHFKt9Kow5csxqTeVkBoi5UaonafsDstm39ggxFQhKTlRpRoV+VNE5jU9WYlv3wywv28DY2woKYG6QBM6JPSKN1dYQpR4QIDAQAB
20
- )
21
- ```
22
-
data/docs/DomainDmarc.md DELETED
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainDmarc
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainDmarc.new(
17
- host: _dmarc.hooli.com,
18
- type: TXT,
19
- text_value: v=DMARC1; p=none;
20
- )
21
- ```
22
-
data/docs/DomainGpt.md DELETED
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainGpt
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainGpt.new(
17
- host: example.com,
18
- type: TXT,
19
- text_value:
20
- )
21
- ```
22
-
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainReturnPath
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainReturnPath.new(
17
- host: sp-bounces.hooli.com,
18
- type: CNAME,
19
- text_value: sp.sendpost.email
20
- )
21
- ```
22
-
data/docs/DomainSpf.md DELETED
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainSpf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainSpf.new(
17
- host: sp-bounce.example.com,
18
- type: CNAME,
19
- text_value: sp.sendpost.info
20
- )
21
- ```
22
-
data/docs/DomainTrack.md DELETED
@@ -1,22 +0,0 @@
1
- # Sendpost::DomainTrack
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **host** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **text_value** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::DomainTrack.new(
17
- host: track.hooli.com,
18
- type: CNAME,
19
- text_value: api.sendpost.io
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Sendpost::EmailMessageFrom
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **email** | **String** | | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'sendpost_ruby_sdk'
14
-
15
- instance = Sendpost::EmailMessageFrom.new(
16
- name: Richard,
17
- email: richard@piedpiper.com
18
- )
19
- ```
20
-
@@ -1,26 +0,0 @@
1
- # Sendpost::EmailMessageToInner
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **email** | **String** | | [optional] |
9
- | **custom_fields** | **Hash<String, String>** | | [optional] |
10
- | **cc** | [**Array<EmailMessageToInnerCcInner>**](EmailMessageToInnerCcInner.md) | | [optional] |
11
- | **bcc** | [**Array<EmailMessageToInnerBccInner>**](EmailMessageToInnerBccInner.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'sendpost_ruby_sdk'
17
-
18
- instance = Sendpost::EmailMessageToInner.new(
19
- name: Gavin,
20
- email: gavin@hooli.com,
21
- custom_fields: {"Company":"Hooli"},
22
- cc: null,
23
- bcc: null
24
- )
25
- ```
26
-
@@ -1,22 +0,0 @@
1
- # Sendpost::EmailMessageToInnerBccInner
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **email** | **String** | | [optional] |
9
- | **custom_fields** | **Hash<String, String>** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::EmailMessageToInnerBccInner.new(
17
- name: Jian,
18
- email: jian@bachmanity.com,
19
- custom_fields: {Company=Hooli}
20
- )
21
- ```
22
-
@@ -1,22 +0,0 @@
1
- # Sendpost::EmailMessageToInnerCcInner
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **email** | **String** | | [optional] |
9
- | **custom_fields** | **Hash<String, String>** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'sendpost_ruby_sdk'
15
-
16
- instance = Sendpost::EmailMessageToInnerCcInner.new(
17
- name: Dinesh,
18
- email: dinesh@bachmanity.com,
19
- custom_fields: {Company=Hooli}
20
- )
21
- ```
22
-
data/docs/EmailStats.md DELETED
@@ -1,20 +0,0 @@
1
- # Sendpost::EmailStats
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **date** | **Date** | The UTC date for which stats are retrieved | [optional] |
8
- | **stats** | [**EmailStatsStats**](EmailStatsStats.md) | | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'sendpost_ruby_sdk'
14
-
15
- instance = Sendpost::EmailStats.new(
16
- date: null,
17
- stats: null
18
- )
19
- ```
20
-
@@ -1,38 +0,0 @@
1
- # Sendpost::EmailStatsStats
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
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 successfully delivered to SMTP without errors | [optional] |
10
- | **dropped** | **Integer** | Number of emails dropped without attempting to deliver due to invalid email or suppression list | [optional] |
11
- | **smtp_dropped** | **Integer** | Number of emails dropped by SMTP | [optional] |
12
- | **hard_bounced** | **Integer** | Number of emails that resulted in a hard bounce error | [optional] |
13
- | **soft_bounced** | **Integer** | Number of emails that resulted in a temporary soft bounce error | [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 | [optional] |
17
- | **spam** | **Integer** | Number of emails marked as spam by recipients | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'sendpost_ruby_sdk'
23
-
24
- instance = Sendpost::EmailStatsStats.new(
25
- processed: null,
26
- sent: null,
27
- delivered: null,
28
- dropped: null,
29
- smtp_dropped: null,
30
- hard_bounced: null,
31
- soft_bounced: null,
32
- opened: null,
33
- clicked: null,
34
- unsubscribed: null,
35
- spam: null
36
- )
37
- ```
38
-
@@ -1,26 +0,0 @@
1
- # Sendpost::MessageHeaderTo
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name of the recipient. | [optional] |
8
- | **email** | **String** | Email address of the recipient. | [optional] |
9
- | **cc** | **Array<String>** | List of CC recipients | [optional] |
10
- | **bcc** | **Array<String>** | List of BCC recipients | [optional] |
11
- | **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'sendpost_ruby_sdk'
17
-
18
- instance = Sendpost::MessageHeaderTo.new(
19
- name: Test Recipient,
20
- email: aditya@sendx.io,
21
- cc: [],
22
- bcc: [],
23
- custom_fields: {}
24
- )
25
- ```
26
-
data/docs/MessageTo.md DELETED
@@ -1,26 +0,0 @@
1
- # Sendpost::MessageTo
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name of the recipient. | [optional] |
8
- | **email** | **String** | Email address of the recipient. | [optional] |
9
- | **cc** | **Array<String>** | List of CC recipients | [optional] |
10
- | **bcc** | **Array<String>** | List of BCC recipients | [optional] |
11
- | **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'sendpost_ruby_sdk'
17
-
18
- instance = Sendpost::MessageTo.new(
19
- name: Test Recipient,
20
- email: aditya@sendx.io,
21
- cc: [],
22
- bcc: [],
23
- custom_fields: {}
24
- )
25
- ```
26
-
@@ -1,26 +0,0 @@
1
- # Sendpost::OperatingSystem
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **family** | **String** | | [optional] |
8
- | **major** | **String** | | [optional] |
9
- | **minor** | **String** | | [optional] |
10
- | **patch** | **String** | | [optional] |
11
- | **patch_minor** | **String** | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'sendpost_ruby_sdk'
17
-
18
- instance = Sendpost::OperatingSystem.new(
19
- family: Windows,
20
- major: 10,
21
- minor: 0,
22
- patch: 0,
23
- patch_minor: 0
24
- )
25
- ```
26
-
data/docs/Person.md DELETED
@@ -1,20 +0,0 @@
1
- # Sendpost::Person
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name of the person. | [optional] |
8
- | **email** | **String** | Email address of the person. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'sendpost_ruby_sdk'
14
-
15
- instance = Sendpost::Person.new(
16
- name: PiedPipers,
17
- email: team@piedpiper.com
18
- )
19
- ```
20
-
data/docs/StatStat.md DELETED
@@ -1,38 +0,0 @@
1
- # Sendpost::StatStat
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
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] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'sendpost_ruby_sdk'
23
-
24
- instance = Sendpost::StatStat.new(
25
- processed: 225,
26
- sent: 220,
27
- delivered: 200,
28
- dropped: 10,
29
- smtp_dropped: 5,
30
- hard_bounced: 10,
31
- soft_bounced: 5,
32
- opened: 150,
33
- clicked: 130,
34
- unsubscribed: 6,
35
- spam: 2
36
- )
37
- ```
38
-
data/docs/StatStats.md DELETED
@@ -1,38 +0,0 @@
1
- # Sendpost::StatStats
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
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] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'sendpost_ruby_sdk'
23
-
24
- instance = Sendpost::StatStats.new(
25
- processed: 225,
26
- sent: 220,
27
- delivered: 200,
28
- dropped: 10,
29
- smtp_dropped: 5,
30
- hard_bounced: 10,
31
- soft_bounced: 5,
32
- opened: 150,
33
- clicked: 130,
34
- unsubscribed: 6,
35
- spam: 2
36
- )
37
- ```
38
-
@@ -1,38 +0,0 @@
1
- # Sendpost::ThirdPartySendingProvider
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **type** | **Integer** | | [optional] |
10
- | **domain** | **String** | | [optional] |
11
- | **endpoint** | **String** | | [optional] |
12
- | **key** | **String** | | [optional] |
13
- | **secret** | **String** | | [optional] |
14
- | **port** | **Integer** | | [optional] |
15
- | **oauth_token** | **String** | | [optional] |
16
- | **retry_time** | **Integer** | | [optional] |
17
- | **created** | **Integer** | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'sendpost_ruby_sdk'
23
-
24
- instance = Sendpost::ThirdPartySendingProvider.new(
25
- id: 1,
26
- name: sendgrid,
27
- type: 1,
28
- domain: ,
29
- endpoint: ,
30
- key: ,
31
- secret: your_api_key,
32
- port: 0,
33
- oauth_token: ,
34
- retry_time: 0,
35
- created: 1597511124701000
36
- )
37
- ```
38
-