sendpost_ruby_sdk 1.2.2 → 2.0.2

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 (293) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/README.md +583 -145
  4. data/docs/AccountStats.md +20 -0
  5. data/docs/AccountStatsStat.md +38 -0
  6. data/docs/AggregateStat.md +38 -0
  7. data/docs/AggregateStats.md +38 -0
  8. data/docs/AggregatedEmailStats.md +38 -0
  9. data/docs/Attachment.md +4 -4
  10. data/docs/AutoWarmupPlan.md +80 -0
  11. data/docs/CopyTo.md +5 -5
  12. data/docs/CreateDomainRequest.md +18 -0
  13. data/docs/CreateSubAccountRequest.md +18 -0
  14. data/docs/CreateSuppressionRequest.md +24 -0
  15. data/docs/CreateSuppressionRequestHardBounceInner.md +18 -0
  16. data/docs/{SuppressionEmail.md → CreateSuppressionRequestManualInner.md} +3 -3
  17. data/docs/CreateSuppressionRequestSpamComplaintInner.md +18 -0
  18. data/docs/CreateSuppressionRequestUnsubscribeInner.md +18 -0
  19. data/docs/CreateWebhookRequest.md +46 -0
  20. data/docs/DeleteResponse.md +2 -2
  21. data/docs/DeleteSubAccountResponse.md +20 -0
  22. data/docs/DeleteSuppression200ResponseInner.md +20 -0
  23. data/docs/DeleteSuppressionRequest.md +18 -0
  24. data/docs/DeleteWebhookResponse.md +20 -0
  25. data/docs/Device.md +1 -1
  26. data/docs/Domain.md +56 -0
  27. data/docs/DomainApi.md +301 -0
  28. data/docs/DomainDkim.md +22 -0
  29. data/docs/DomainDmarc.md +22 -0
  30. data/docs/DomainGpt.md +22 -0
  31. data/docs/DomainReturnPath.md +22 -0
  32. data/docs/DomainSpf.md +22 -0
  33. data/docs/DomainTrack.md +22 -0
  34. data/docs/EIP.md +18 -0
  35. data/docs/{From.md → EmailAddress.md} +4 -4
  36. data/docs/EmailApi.md +38 -32
  37. data/docs/EmailMessage.md +30 -24
  38. data/docs/EmailMessageFrom.md +20 -0
  39. data/docs/EmailMessageObject.md +46 -0
  40. data/docs/{ReplyTo.md → EmailMessageReplyTo.md} +5 -5
  41. data/docs/EmailMessageToInner.md +26 -0
  42. data/docs/EmailMessageToInnerBccInner.md +22 -0
  43. data/docs/EmailMessageToInnerCcInner.md +22 -0
  44. data/docs/EmailMessageWithTemplate.md +52 -0
  45. data/docs/EmailResponse.md +8 -8
  46. data/docs/EmailStats.md +20 -0
  47. data/docs/EmailStatsStats.md +38 -0
  48. data/docs/Event.md +56 -0
  49. data/docs/EventMetadata.md +13 -13
  50. data/docs/{City.md → GeoLocation.md} +8 -8
  51. data/docs/IP.md +62 -0
  52. data/docs/IPAllocationRequest.md +20 -0
  53. data/docs/IPApi.md +375 -0
  54. data/docs/IPDeletionResponse.md +20 -0
  55. data/docs/IPPool.md +42 -0
  56. data/docs/IPPoolCreateRequest.md +28 -0
  57. data/docs/IPPoolDeleteResponse.md +20 -0
  58. data/docs/IPPoolUpdateRequest.md +24 -0
  59. data/docs/IPPoolsApi.md +361 -0
  60. data/docs/IPUpdateRequest.md +18 -0
  61. data/docs/Label.md +22 -0
  62. data/docs/Member.md +40 -0
  63. data/docs/Message.md +76 -0
  64. data/docs/MessageApi.md +79 -0
  65. data/docs/MessageHeaderTo.md +26 -0
  66. data/docs/MessageTo.md +26 -0
  67. data/docs/{Os.md → OperatingSystem.md} +7 -7
  68. data/docs/Person.md +20 -0
  69. data/docs/{To.md → Recipient.md} +7 -7
  70. data/docs/SMTPAuth.md +26 -0
  71. data/docs/Stat.md +20 -0
  72. data/docs/StatStat.md +38 -0
  73. data/docs/StatStats.md +38 -0
  74. data/docs/StatsAApi.md +307 -0
  75. data/docs/StatsApi.md +237 -0
  76. data/docs/SubAccount.md +48 -0
  77. data/docs/SubAccountApi.md +375 -0
  78. data/docs/Suppression.md +8 -8
  79. data/docs/SuppressionApi.md +76 -134
  80. data/docs/ThirdPartySendingProvider.md +38 -0
  81. data/docs/UpdateSubAccount.md +18 -0
  82. data/docs/UpdateWebhook.md +46 -0
  83. data/docs/UserAgent.md +4 -4
  84. data/docs/Webhook.md +54 -0
  85. data/docs/WebhookApi.md +375 -0
  86. data/git_push.sh +1 -1
  87. data/lib/sendpost_ruby_sdk/api/domain_api.rb +290 -0
  88. data/lib/sendpost_ruby_sdk/api/email_api.rb +33 -35
  89. data/lib/sendpost_ruby_sdk/api/ip_api.rb +356 -0
  90. data/lib/sendpost_ruby_sdk/api/ip_pools_api.rb +356 -0
  91. data/lib/sendpost_ruby_sdk/api/message_api.rb +85 -0
  92. data/lib/sendpost_ruby_sdk/api/stats_a_api.rb +320 -0
  93. data/lib/sendpost_ruby_sdk/api/stats_api.rb +260 -0
  94. data/lib/sendpost_ruby_sdk/api/sub_account_api.rb +356 -0
  95. data/lib/sendpost_ruby_sdk/api/suppression_api.rb +81 -141
  96. data/lib/sendpost_ruby_sdk/api/webhook_api.rb +356 -0
  97. data/lib/sendpost_ruby_sdk/api_client.rb +26 -24
  98. data/lib/sendpost_ruby_sdk/api_error.rb +3 -3
  99. data/lib/sendpost_ruby_sdk/configuration.rb +28 -3
  100. data/lib/sendpost_ruby_sdk/models/account_stats.rb +229 -0
  101. data/lib/sendpost_ruby_sdk/models/account_stats_stat.rb +311 -0
  102. data/lib/sendpost_ruby_sdk/models/aggregate_stat.rb +321 -0
  103. data/lib/sendpost_ruby_sdk/models/aggregate_stats.rb +310 -0
  104. data/lib/sendpost_ruby_sdk/models/aggregated_email_stats.rb +321 -0
  105. data/lib/sendpost_ruby_sdk/models/attachment.rb +15 -7
  106. data/lib/sendpost_ruby_sdk/models/auto_warmup_plan.rb +531 -0
  107. data/lib/sendpost_ruby_sdk/models/copy_to.rb +28 -19
  108. data/lib/sendpost_ruby_sdk/models/create_domain_request.rb +221 -0
  109. data/lib/sendpost_ruby_sdk/models/create_sub_account_request.rb +221 -0
  110. data/lib/sendpost_ruby_sdk/models/create_suppression_request.rb +259 -0
  111. data/lib/sendpost_ruby_sdk/models/create_suppression_request_hard_bounce_inner.rb +220 -0
  112. data/lib/sendpost_ruby_sdk/models/create_suppression_request_manual_inner.rb +220 -0
  113. data/lib/sendpost_ruby_sdk/models/create_suppression_request_spam_complaint_inner.rb +220 -0
  114. data/lib/sendpost_ruby_sdk/models/create_suppression_request_unsubscribe_inner.rb +220 -0
  115. data/lib/sendpost_ruby_sdk/models/create_webhook_request.rb +361 -0
  116. data/lib/sendpost_ruby_sdk/models/delete_response.rb +15 -7
  117. data/lib/sendpost_ruby_sdk/models/delete_sub_account_response.rb +231 -0
  118. data/lib/sendpost_ruby_sdk/models/delete_suppression200_response_inner.rb +231 -0
  119. data/lib/sendpost_ruby_sdk/models/delete_suppression_request.rb +222 -0
  120. data/lib/sendpost_ruby_sdk/models/delete_webhook_response.rb +231 -0
  121. data/lib/sendpost_ruby_sdk/models/device.rb +13 -7
  122. data/lib/sendpost_ruby_sdk/models/domain.rb +435 -0
  123. data/lib/sendpost_ruby_sdk/models/domain_dkim.rb +239 -0
  124. data/lib/sendpost_ruby_sdk/models/domain_dmarc.rb +239 -0
  125. data/lib/sendpost_ruby_sdk/models/domain_gpt.rb +239 -0
  126. data/lib/sendpost_ruby_sdk/models/domain_return_path.rb +239 -0
  127. data/lib/sendpost_ruby_sdk/models/domain_spf.rb +239 -0
  128. data/lib/sendpost_ruby_sdk/models/domain_track.rb +239 -0
  129. data/lib/sendpost_ruby_sdk/models/eip.rb +238 -0
  130. data/lib/sendpost_ruby_sdk/models/email_address.rb +229 -0
  131. data/lib/sendpost_ruby_sdk/models/email_message.rb +121 -86
  132. data/lib/sendpost_ruby_sdk/models/email_message_from.rb +229 -0
  133. data/lib/sendpost_ruby_sdk/models/email_message_object.rb +354 -0
  134. data/lib/sendpost_ruby_sdk/models/email_message_reply_to.rb +229 -0
  135. data/lib/sendpost_ruby_sdk/models/email_message_to_inner.rb +262 -0
  136. data/lib/sendpost_ruby_sdk/models/email_message_to_inner_bcc_inner.rb +240 -0
  137. data/lib/sendpost_ruby_sdk/models/email_message_to_inner_cc_inner.rb +240 -0
  138. data/lib/sendpost_ruby_sdk/models/email_message_with_template.rb +392 -0
  139. data/lib/sendpost_ruby_sdk/models/email_response.rb +40 -32
  140. data/lib/sendpost_ruby_sdk/models/email_stats.rb +230 -0
  141. data/lib/sendpost_ruby_sdk/models/email_stats_stats.rb +321 -0
  142. data/lib/sendpost_ruby_sdk/models/event.rb +393 -0
  143. data/lib/sendpost_ruby_sdk/models/event_metadata.rb +59 -53
  144. data/lib/sendpost_ruby_sdk/models/geo_location.rb +256 -0
  145. data/lib/sendpost_ruby_sdk/models/ip.rb +643 -0
  146. data/lib/sendpost_ruby_sdk/models/ip_allocation_request.rb +266 -0
  147. data/lib/sendpost_ruby_sdk/models/ip_deletion_response.rb +265 -0
  148. data/lib/sendpost_ruby_sdk/models/ip_pool.rb +357 -0
  149. data/lib/sendpost_ruby_sdk/models/ip_pool_create_request.rb +299 -0
  150. data/lib/sendpost_ruby_sdk/models/ip_pool_delete_response.rb +229 -0
  151. data/lib/sendpost_ruby_sdk/models/ip_pool_update_request.rb +249 -0
  152. data/lib/sendpost_ruby_sdk/models/ip_update_request.rb +238 -0
  153. data/lib/sendpost_ruby_sdk/models/label.rb +241 -0
  154. data/lib/sendpost_ruby_sdk/models/member.rb +331 -0
  155. data/lib/sendpost_ruby_sdk/models/message.rb +523 -0
  156. data/lib/sendpost_ruby_sdk/models/message_header_to.rb +268 -0
  157. data/lib/sendpost_ruby_sdk/models/message_to.rb +268 -0
  158. data/lib/sendpost_ruby_sdk/models/operating_system.rb +256 -0
  159. data/lib/sendpost_ruby_sdk/models/person.rb +231 -0
  160. data/lib/sendpost_ruby_sdk/models/recipient.rb +263 -0
  161. data/lib/sendpost_ruby_sdk/models/smtp_auth.rb +261 -0
  162. data/lib/sendpost_ruby_sdk/models/stat.rb +230 -0
  163. data/lib/sendpost_ruby_sdk/models/stat_stat.rb +322 -0
  164. data/lib/sendpost_ruby_sdk/models/stat_stats.rb +321 -0
  165. data/lib/sendpost_ruby_sdk/models/sub_account.rb +415 -0
  166. data/lib/sendpost_ruby_sdk/models/suppression.rb +40 -29
  167. data/lib/sendpost_ruby_sdk/models/third_party_sending_provider.rb +310 -0
  168. data/lib/sendpost_ruby_sdk/models/update_sub_account.rb +221 -0
  169. data/lib/sendpost_ruby_sdk/models/update_webhook.rb +368 -0
  170. data/lib/sendpost_ruby_sdk/models/user_agent.rb +13 -7
  171. data/lib/sendpost_ruby_sdk/models/webhook.rb +405 -0
  172. data/lib/sendpost_ruby_sdk/version.rb +4 -4
  173. data/lib/sendpost_ruby_sdk.rb +73 -15
  174. data/spec/api/domain_api_spec.rb +85 -0
  175. data/spec/api/email_api_spec.rb +9 -9
  176. data/spec/api/ip_api_spec.rb +98 -0
  177. data/spec/api/ip_pools_api_spec.rb +98 -0
  178. data/spec/api/message_api_spec.rb +47 -0
  179. data/spec/api/stats_a_api_spec.rb +89 -0
  180. data/spec/api/stats_api_spec.rb +78 -0
  181. data/spec/api/sub_account_api_spec.rb +98 -0
  182. data/spec/api/suppression_api_spec.rb +22 -34
  183. data/spec/api/webhook_api_spec.rb +98 -0
  184. data/spec/models/account_stats_spec.rb +42 -0
  185. data/spec/models/account_stats_stat_spec.rb +96 -0
  186. data/spec/models/aggregate_stat_spec.rb +96 -0
  187. data/spec/models/aggregate_stats_spec.rb +96 -0
  188. data/spec/models/aggregated_email_stats_spec.rb +96 -0
  189. data/spec/models/attachment_spec.rb +6 -4
  190. data/spec/models/auto_warmup_plan_spec.rb +222 -0
  191. data/spec/models/copy_to_spec.rb +8 -6
  192. data/spec/models/create_domain_request_spec.rb +36 -0
  193. data/spec/models/create_sub_account_request_spec.rb +36 -0
  194. data/spec/models/create_suppression_request_hard_bounce_inner_spec.rb +36 -0
  195. data/spec/models/create_suppression_request_manual_inner_spec.rb +36 -0
  196. data/spec/models/create_suppression_request_spam_complaint_inner_spec.rb +36 -0
  197. data/spec/models/create_suppression_request_spec.rb +54 -0
  198. data/spec/models/create_suppression_request_unsubscribe_inner_spec.rb +36 -0
  199. data/spec/models/create_webhook_request_spec.rb +120 -0
  200. data/spec/models/delete_response_spec.rb +6 -4
  201. data/spec/models/delete_sub_account_response_spec.rb +42 -0
  202. data/spec/models/delete_suppression200_response_inner_spec.rb +42 -0
  203. data/spec/models/delete_suppression_request_spec.rb +36 -0
  204. data/spec/models/delete_webhook_response_spec.rb +42 -0
  205. data/spec/models/device_spec.rb +6 -4
  206. data/spec/models/domain_dkim_spec.rb +48 -0
  207. data/spec/models/domain_dmarc_spec.rb +48 -0
  208. data/spec/models/domain_gpt_spec.rb +48 -0
  209. data/spec/models/domain_return_path_spec.rb +48 -0
  210. data/spec/models/domain_spec.rb +150 -0
  211. data/spec/models/domain_spf_spec.rb +48 -0
  212. data/spec/models/domain_track_spec.rb +48 -0
  213. data/spec/models/eip_spec.rb +36 -0
  214. data/spec/models/email_address_spec.rb +42 -0
  215. data/spec/models/email_message_from_spec.rb +42 -0
  216. data/spec/models/email_message_object_spec.rb +120 -0
  217. data/spec/models/email_message_reply_to_spec.rb +42 -0
  218. data/spec/models/email_message_spec.rb +37 -17
  219. data/spec/models/email_message_to_inner_bcc_inner_spec.rb +48 -0
  220. data/spec/models/email_message_to_inner_cc_inner_spec.rb +48 -0
  221. data/spec/models/email_message_to_inner_spec.rb +60 -0
  222. data/spec/models/email_message_with_template_spec.rb +138 -0
  223. data/spec/models/email_response_spec.rb +10 -8
  224. data/spec/models/email_stats_spec.rb +42 -0
  225. data/spec/models/email_stats_stats_spec.rb +96 -0
  226. data/spec/models/event_metadata_spec.rb +24 -10
  227. data/spec/models/event_spec.rb +150 -0
  228. data/spec/models/geo_location_spec.rb +60 -0
  229. data/spec/models/ip_allocation_request_spec.rb +42 -0
  230. data/spec/models/ip_deletion_response_spec.rb +42 -0
  231. data/spec/models/ip_pool_create_request_spec.rb +66 -0
  232. data/spec/models/ip_pool_delete_response_spec.rb +42 -0
  233. data/spec/models/ip_pool_spec.rb +108 -0
  234. data/spec/models/ip_pool_update_request_spec.rb +54 -0
  235. data/spec/models/ip_spec.rb +168 -0
  236. data/spec/models/ip_update_request_spec.rb +36 -0
  237. data/spec/models/label_spec.rb +48 -0
  238. data/spec/models/member_spec.rb +102 -0
  239. data/spec/models/message_header_to_spec.rb +60 -0
  240. data/spec/models/message_spec.rb +210 -0
  241. data/spec/models/message_to_spec.rb +60 -0
  242. data/spec/models/operating_system_spec.rb +60 -0
  243. data/spec/models/person_spec.rb +42 -0
  244. data/spec/models/recipient_spec.rb +60 -0
  245. data/spec/models/smtp_auth_spec.rb +60 -0
  246. data/spec/models/stat_spec.rb +42 -0
  247. data/spec/models/stat_stat_spec.rb +96 -0
  248. data/spec/models/stat_stats_spec.rb +96 -0
  249. data/spec/models/sub_account_spec.rb +130 -0
  250. data/spec/models/suppression_spec.rb +11 -9
  251. data/spec/models/third_party_sending_provider_spec.rb +96 -0
  252. data/spec/models/update_sub_account_spec.rb +36 -0
  253. data/spec/models/update_webhook_spec.rb +120 -0
  254. data/spec/models/user_agent_spec.rb +6 -4
  255. data/spec/models/webhook_spec.rb +144 -0
  256. data/spec/spec_helper.rb +3 -3
  257. metadata +295 -66
  258. data/config-ruby.json +0 -11
  259. data/docs/CountStat.md +0 -18
  260. data/docs/QEmailMessage.md +0 -70
  261. data/docs/QEvent.md +0 -42
  262. data/docs/RDSuppression.md +0 -18
  263. data/docs/RSuppression.md +0 -24
  264. data/docs/WebhookEvent.md +0 -20
  265. data/generate-libs.bash +0 -1
  266. data/lib/sendpost_ruby_sdk/models/city.rb +0 -250
  267. data/lib/sendpost_ruby_sdk/models/count_stat.rb +0 -214
  268. data/lib/sendpost_ruby_sdk/models/from.rb +0 -223
  269. data/lib/sendpost_ruby_sdk/models/os.rb +0 -250
  270. data/lib/sendpost_ruby_sdk/models/q_email_message.rb +0 -456
  271. data/lib/sendpost_ruby_sdk/models/q_event.rb +0 -324
  272. data/lib/sendpost_ruby_sdk/models/r_suppression.rb +0 -249
  273. data/lib/sendpost_ruby_sdk/models/rd_suppression.rb +0 -216
  274. data/lib/sendpost_ruby_sdk/models/reply_to.rb +0 -223
  275. data/lib/sendpost_ruby_sdk/models/suppression_email.rb +0 -214
  276. data/lib/sendpost_ruby_sdk/models/to.rb +0 -254
  277. data/lib/sendpost_ruby_sdk/models/webhook_event.rb +0 -223
  278. data/sendpost.yaml +0 -666
  279. data/sendpost_ruby_sdk.gemspec +0 -38
  280. data/spec/api_client_spec.rb +0 -228
  281. data/spec/configuration_spec.rb +0 -42
  282. data/spec/models/city_spec.rb +0 -58
  283. data/spec/models/count_stat_spec.rb +0 -34
  284. data/spec/models/from_spec.rb +0 -40
  285. data/spec/models/os_spec.rb +0 -58
  286. data/spec/models/q_email_message_spec.rb +0 -190
  287. data/spec/models/q_event_spec.rb +0 -106
  288. data/spec/models/r_suppression_spec.rb +0 -52
  289. data/spec/models/rd_suppression_spec.rb +0 -34
  290. data/spec/models/reply_to_spec.rb +0 -40
  291. data/spec/models/suppression_email_spec.rb +0 -34
  292. data/spec/models/to_spec.rb +0 -58
  293. data/spec/models/webhook_event_spec.rb +0 -40
data/docs/EmailMessage.md CHANGED
@@ -4,21 +4,24 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **attachments** | [**Array<Attachment>**](Attachment.md) | | [optional] |
8
- | **from** | [**From**](From.md) | | [optional] |
7
+ | **message_id** | **String** | | [optional] |
8
+ | **account_id** | **Integer** | | [optional] |
9
+ | **sub_account_id** | **Integer** | | [optional] |
10
+ | **ip_id** | **Integer** | | [optional] |
11
+ | **public_ip** | **String** | | [optional] |
12
+ | **local_ip** | **String** | | [optional] |
13
+ | **email_type** | **String** | | [optional] |
14
+ | **submitted_at** | **Integer** | | [optional] |
15
+ | **from** | [**EmailMessageFrom**](EmailMessageFrom.md) | | [optional] |
16
+ | **reply_to** | [**EmailMessageReplyTo**](EmailMessageReplyTo.md) | | [optional] |
17
+ | **to** | [**Array<EmailMessageToInner>**](EmailMessageToInner.md) | | [optional] |
9
18
  | **groups** | **Array<String>** | | [optional] |
10
- | **html_body** | **String** | | [optional] |
11
- | **ippool** | **String** | | [optional] |
12
- | **pre_text** | **String** | | [optional] |
13
- | **reply_to** | [**ReplyTo**](ReplyTo.md) | | [optional] |
14
- | **subject** | **String** | | [optional] |
15
- | **template** | **String** | | [optional] |
16
- | **text_body** | **String** | | [optional] |
17
- | **to** | [**Array<To>**](To.md) | | [optional] |
18
- | **track_clicks** | **Boolean** | | [optional] |
19
+ | **ip_pool** | **String** | | [optional] |
20
+ | **headers** | **Hash<String, String>** | | [optional] |
21
+ | **custom_fields** | **Hash<String, String>** | | [optional] |
19
22
  | **track_opens** | **Boolean** | | [optional] |
20
- | **headers** | **Object** | | [optional] |
21
- | **amp_body** | **String** | | [optional] |
23
+ | **track_clicks** | **Boolean** | | [optional] |
24
+ | **webhook_endpoint** | **String** | | [optional] |
22
25
 
23
26
  ## Example
24
27
 
@@ -26,21 +29,24 @@
26
29
  require 'sendpost_ruby_sdk'
27
30
 
28
31
  instance = Sendpost::EmailMessage.new(
29
- attachments: null,
32
+ message_id: mjhl-1401-sasdf-129324,
33
+ account_id: 117,
34
+ sub_account_id: 117,
35
+ ip_id: 123,
36
+ public_ip: 52.34.11.12,
37
+ local_ip: 127.0.0.1,
38
+ email_type: default,
39
+ submitted_at: 1567512491587205024,
30
40
  from: null,
31
- groups: ["promotion","techcrunch-launch"],
32
- html_body: <html><body>Thanks for your trust in Hooli {{.Name}}. We are trying launching Nucleus at TechCrunch Disrupt - our cloud based compression platform. That you could easily integrate it into {{.Company}}.</html></body>,
33
- ippool: promotional-hooli,
34
- pre_text: Follow the steps to integrate our video compression API,
35
41
  reply_to: null,
36
- subject: Welcome to Nucles {{.Name}}:) Let's get started,
37
- template: welcome-onboarding,
38
- text_body: Thanks for your trust in Hooli {{.Name}}. We are trying launching Nucleus at TechCrunch Disrupt - our cloud based compression platform. That you could easily integrate it into {{.Company}},
39
42
  to: null,
40
- track_clicks: true,
43
+ groups: ["welcome","user-onboarding"],
44
+ ip_pool: transactional-piedpiper,
45
+ headers: {"X-Campaign-Id":"12345"},
46
+ custom_fields: {"Company":"Company Name","Email":"user@example.com"},
41
47
  track_opens: true,
42
- headers: {"X-Campaign-Id":"techcrunch-launch"},
43
- amp_body: null
48
+ track_clicks: true,
49
+ webhook_endpoint: https://webhook.example.com/webhook
44
50
  )
45
51
  ```
46
52
 
data/docs/EmailMessageFrom.md ADDED
@@ -0,0 +1,20 @@
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
+
data/docs/EmailMessageObject.md ADDED
@@ -0,0 +1,46 @@
1
+ # Sendpost::EmailMessageObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | [**EmailAddress**](EmailAddress.md) | | [optional] |
8
+ | **reply_to** | [**EmailAddress**](EmailAddress.md) | | [optional] |
9
+ | **to** | [**Array<Recipient>**](Recipient.md) | | [optional] |
10
+ | **subject** | **String** | | [optional] |
11
+ | **pre_text** | **String** | | [optional] |
12
+ | **html_body** | **String** | | [optional] |
13
+ | **text_body** | **String** | | [optional] |
14
+ | **amp_body** | **String** | | [optional] |
15
+ | **ippool** | **String** | | [optional] |
16
+ | **headers** | **Hash<String, String>** | | [optional] |
17
+ | **track_opens** | **Boolean** | | [optional] |
18
+ | **track_clicks** | **Boolean** | | [optional] |
19
+ | **groups** | **Array<String>** | | [optional] |
20
+ | **attachments** | [**Array<Attachment>**](Attachment.md) | | [optional] |
21
+ | **webhook_endpoint** | **String** | | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'sendpost_ruby_sdk'
27
+
28
+ instance = Sendpost::EmailMessageObject.new(
29
+ from: null,
30
+ reply_to: null,
31
+ to: null,
32
+ subject: null,
33
+ pre_text: null,
34
+ html_body: null,
35
+ text_body: null,
36
+ amp_body: null,
37
+ ippool: null,
38
+ headers: null,
39
+ track_opens: null,
40
+ track_clicks: null,
41
+ groups: null,
42
+ attachments: null,
43
+ webhook_endpoint: null
44
+ )
45
+ ```
46
+
data/docs/{ReplyTo.md → EmailMessageReplyTo.md} RENAMED
@@ -1,20 +1,20 @@
1
- # Sendpost::ReplyTo
1
+ # Sendpost::EmailMessageReplyTo
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
7
  | **name** | **String** | | [optional] |
8
+ | **email** | **String** | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```ruby
13
13
  require 'sendpost_ruby_sdk'
14
14
 
15
- instance = Sendpost::ReplyTo.new(
16
- email: welcome@hooli.vom,
17
- name: Team @ Hooli
15
+ instance = Sendpost::EmailMessageReplyTo.new(
16
+ name: Gavin,
17
+ email: gavin@hooli.com
18
18
  )
19
19
  ```
20
20
 
data/docs/EmailMessageToInner.md ADDED
@@ -0,0 +1,26 @@
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
+
data/docs/EmailMessageToInnerBccInner.md ADDED
@@ -0,0 +1,22 @@
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
+
data/docs/EmailMessageToInnerCcInner.md ADDED
@@ -0,0 +1,22 @@
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/EmailMessageWithTemplate.md ADDED
@@ -0,0 +1,52 @@
1
+ # Sendpost::EmailMessageWithTemplate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | [**EmailAddress**](EmailAddress.md) | | [optional] |
8
+ | **reply_to** | [**EmailAddress**](EmailAddress.md) | | [optional] |
9
+ | **to** | [**Array<Recipient>**](Recipient.md) | | [optional] |
10
+ | **subject** | **String** | | [optional] |
11
+ | **pre_text** | **String** | | [optional] |
12
+ | **html_body** | **String** | | [optional] |
13
+ | **text_body** | **String** | | [optional] |
14
+ | **amp_body** | **String** | | [optional] |
15
+ | **ippool** | **String** | | [optional] |
16
+ | **headers** | **Hash<String, String>** | | [optional] |
17
+ | **track_opens** | **Boolean** | | [optional] |
18
+ | **track_clicks** | **Boolean** | | [optional] |
19
+ | **groups** | **Array<String>** | | [optional] |
20
+ | **attachments** | [**Array<Attachment>**](Attachment.md) | | [optional] |
21
+ | **webhook_endpoint** | **String** | | [optional] |
22
+ | **template** | **String** | | [optional] |
23
+ | **template_id** | **String** | Template ID for the email template | [optional] |
24
+ | **template_variables** | **Hash<String, String>** | Key-Value pair of template variables | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'sendpost_ruby_sdk'
30
+
31
+ instance = Sendpost::EmailMessageWithTemplate.new(
32
+ from: null,
33
+ reply_to: null,
34
+ to: null,
35
+ subject: null,
36
+ pre_text: null,
37
+ html_body: null,
38
+ text_body: null,
39
+ amp_body: null,
40
+ ippool: null,
41
+ headers: null,
42
+ track_opens: null,
43
+ track_clicks: null,
44
+ groups: null,
45
+ attachments: null,
46
+ webhook_endpoint: null,
47
+ template: null,
48
+ template_id: null,
49
+ template_variables: null
50
+ )
51
+ ```
52
+
data/docs/EmailResponse.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **to** | **String** | | [optional] |
8
+ | **submitted_at** | **Integer** | UNIX epoch nano timestamp | [optional] |
9
+ | **message_id** | **String** | Message UUID | [optional] |
7
10
  | **error_code** | **Integer** | | [optional] |
8
11
  | **message** | **String** | | [optional] |
9
- | **message_id** | **String** | | [optional] |
10
- | **submitted_at** | **Integer** | | [optional] |
11
- | **to** | **String** | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -16,11 +16,11 @@
16
16
  require 'sendpost_ruby_sdk'
17
17
 
18
18
  instance = Sendpost::EmailResponse.new(
19
- error_code: 500,
20
- message: ok,
21
- message_id: 0e139af1-f1xe-480d-b08d-eg28m48kf48d,
22
- submitted_at: 1567512491587205124,
23
- to: bighead@bachmanity.com
19
+ to: null,
20
+ submitted_at: null,
21
+ message_id: null,
22
+ error_code: null,
23
+ message: null
24
24
  )
25
25
  ```
26
26
 
data/docs/EmailStats.md ADDED
@@ -0,0 +1,20 @@
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
+
data/docs/EmailStatsStats.md ADDED
@@ -0,0 +1,38 @@
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
+
data/docs/Event.md ADDED
@@ -0,0 +1,56 @@
1
+ # Sendpost::Event
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **event_id** | **String** | | [optional] |
8
+ | **groups** | **Array<String>** | | [optional] |
9
+ | **ip_id** | **Integer** | | [optional] |
10
+ | **ip_pool_id** | **Integer** | | [optional] |
11
+ | **domain_id** | **Integer** | | [optional] |
12
+ | **tpsp_id** | **Integer** | | [optional] |
13
+ | **message_type** | **String** | | [optional] |
14
+ | **message_subject** | **String** | | [optional] |
15
+ | **account_id** | **Integer** | | [optional] |
16
+ | **sub_account_id** | **Integer** | | [optional] |
17
+ | **message_id** | **String** | | [optional] |
18
+ | **type** | **Integer** | | [optional] |
19
+ | **from** | **String** | | [optional] |
20
+ | **from_name** | **String** | | [optional] |
21
+ | **to** | **String** | | [optional] |
22
+ | **to_name** | **String** | | [optional] |
23
+ | **submitted_at** | **Integer** | | [optional] |
24
+ | **smtp_code** | **Integer** | | [optional] |
25
+ | **smtp_description** | **String** | | [optional] |
26
+ | **event_metadata** | [**EventMetadata**](EventMetadata.md) | | [optional] |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'sendpost_ruby_sdk'
32
+
33
+ instance = Sendpost::Event.new(
34
+ event_id: edhg-123gh-afasdf-124egh,
35
+ groups: ["transactional","user-onboarding"],
36
+ ip_id: 123,
37
+ ip_pool_id: 123,
38
+ domain_id: 123,
39
+ tpsp_id: 1,
40
+ message_type: default,
41
+ message_subject: Welcome to Pied Piper :) + 1 quick question,
42
+ account_id: 117,
43
+ sub_account_id: 117,
44
+ message_id: mjhl-1401-sasdf-129324,
45
+ type: 2,
46
+ from: richard@piedpiper.com,
47
+ from_name: Richard,
48
+ to: gavin@hooli.com,
49
+ to_name: Gavin,
50
+ submitted_at: 1567512491587205024,
51
+ smtp_code: 200,
52
+ smtp_description: email delivered successfully,
53
+ event_metadata: null
54
+ )
55
+ ```
56
+
data/docs/EventMetadata.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **clicked_url** | **String** | | [optional] |
8
- | **tracked_ip** | **String** | | [optional] |
9
- | **raw_user_agent** | **String** | | [optional] |
10
- | **device** | [**Device**](Device.md) | | [optional] |
11
- | **geo** | [**City**](City.md) | | [optional] |
12
- | **os** | [**Os**](Os.md) | | [optional] |
13
7
  | **smtp_code** | **Integer** | | [optional] |
14
8
  | **smtp_description** | **String** | | [optional] |
15
9
  | **user_agent** | [**UserAgent**](UserAgent.md) | | [optional] |
10
+ | **os** | [**OperatingSystem**](OperatingSystem.md) | | [optional] |
11
+ | **device** | [**Device**](Device.md) | | [optional] |
12
+ | **geo** | [**GeoLocation**](GeoLocation.md) | | [optional] |
13
+ | **clicked_url** | **String** | | [optional] |
14
+ | **tracked_ip** | **String** | | [optional] |
15
+ | **raw_user_agent** | **String** | | [optional] |
16
16
 
17
17
  ## Example
18
18
 
@@ -20,15 +20,15 @@
20
20
  require 'sendpost_ruby_sdk'
21
21
 
22
22
  instance = Sendpost::EventMetadata.new(
23
- clicked_url: null,
24
- tracked_ip: null,
25
- raw_user_agent: null,
26
- device: null,
27
- geo: null,
28
- os: null,
29
23
  smtp_code: 200,
30
24
  smtp_description: email delivered successfully,
31
- user_agent: null
25
+ user_agent: null,
26
+ os: null,
27
+ device: null,
28
+ geo: null,
29
+ clicked_url: https://hooli.com,
30
+ tracked_ip: 52.34.11.12,
31
+ raw_user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
32
32
  )
33
33
  ```
34
34
 
data/docs/{City.md → GeoLocation.md} RENAMED
@@ -1,10 +1,10 @@
1
- # Sendpost::City
1
+ # Sendpost::GeoLocation
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **city_id** | **Integer** | | [optional] |
7
+ | **city_id** | **String** | | [optional] |
8
8
  | **continent_code** | **String** | | [optional] |
9
9
  | **country_code** | **String** | | [optional] |
10
10
  | **postal_code** | **String** | | [optional] |
@@ -15,12 +15,12 @@
15
15
  ```ruby
16
16
  require 'sendpost_ruby_sdk'
17
17
 
18
- instance = Sendpost::City.new(
19
- city_id: null,
20
- continent_code: null,
21
- country_code: null,
22
- postal_code: null,
23
- time_zone: null
18
+ instance = Sendpost::GeoLocation.new(
19
+ city_id: 123,
20
+ continent_code: EU,
21
+ country_code: US,
22
+ postal_code: 12345,
23
+ time_zone: America/Los_Angeles
24
24
  )
25
25
  ```
26
26
 
data/docs/IP.md ADDED
@@ -0,0 +1,62 @@
1
+ # Sendpost::IP
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | Unique ID for the IP | |
8
+ | **public_ip** | **String** | The public IP address associated with the resource | |
9
+ | **system_domain** | [**Domain**](Domain.md) | | [optional] |
10
+ | **reverse_dns_hostname** | **String** | The reverse DNS hostname for the IP | [optional] |
11
+ | **type** | **Integer** | Type of the IP | [optional] |
12
+ | **gmail_settings** | **String** | Configuration for Gmail delivery settings in JSON format | [optional] |
13
+ | **yahoo_settings** | **String** | Configuration for Yahoo delivery settings in JSON format | [optional] |
14
+ | **aol_settings** | **String** | Configuration for AOL delivery settings in JSON format | [optional] |
15
+ | **microsoft_settings** | **String** | Configuration for Microsoft delivery settings in JSON format | [optional] |
16
+ | **comcast_settings** | **String** | Configuration for Comcast delivery settings in JSON format | [optional] |
17
+ | **yandex_settings** | **String** | Configuration for Yandex delivery settings in JSON format | [optional] |
18
+ | **gmx_settings** | **String** | Configuration for GMX delivery settings in JSON format | [optional] |
19
+ | **mailru_settings** | **String** | Configuration for Mail.ru delivery settings in JSON format | [optional] |
20
+ | **icloud_settings** | **String** | Configuration for iCloud delivery settings in JSON format | [optional] |
21
+ | **zoho_settings** | **String** | Configuration for Zoho delivery settings in JSON format | [optional] |
22
+ | **qq_settings** | **String** | Configuration for QQ delivery settings in JSON format | [optional] |
23
+ | **default_settings** | **String** | Default delivery settings in JSON format | [optional] |
24
+ | **att_settings** | **String** | Configuration for AT&T delivery settings in JSON format | [optional] |
25
+ | **created** | **Integer** | The timestamp (UNIX epoch) when the IP was created | |
26
+ | **infra_classification** | **String** | Classification of the infrastructure | [optional] |
27
+ | **infra_monitor** | **Boolean** | Indicates whether infrastructure monitoring is enabled | [optional] |
28
+ | **state** | **Integer** | The state of the IP | [optional] |
29
+ | **auto_warmup_plan** | [**AutoWarmupPlan**](AutoWarmupPlan.md) | The auto-warmup plan associated with the IP. Can be null if no warmup plan is assigned. | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'sendpost_ruby_sdk'
35
+
36
+ instance = Sendpost::IP.new(
37
+ id: 11321,
38
+ public_ip: 52.34.11.12,
39
+ system_domain: null,
40
+ reverse_dns_hostname: example.mtaspg.email,
41
+ type: 0,
42
+ gmail_settings: {"name":"gmail","maxConcurrentConnections":100,...},
43
+ yahoo_settings: {"name":"yahoo","maxConcurrentConnections":16,...},
44
+ aol_settings: {"name":"aol","maxConcurrentConnections":20,...},
45
+ microsoft_settings: {"name":"microsoft","maxConcurrentConnections":16,...},
46
+ comcast_settings: {"name":"comcast","maxConcurrentConnections":20,...},
47
+ yandex_settings: {"name":"yandex","maxConcurrentConnections":2,...},
48
+ gmx_settings: {"name":"gmx","maxConcurrentConnections":2,...},
49
+ mailru_settings: {"name":"mailru","maxConcurrentConnections":1,...},
50
+ icloud_settings: {"name":"icloud","maxConcurrentConnections":20,...},
51
+ zoho_settings: {"name":"zoho","maxConcurrentConnections":1,...},
52
+ qq_settings: {"name":"qq","maxConcurrentConnections":1,...},
53
+ default_settings: {"name":"default","maxConcurrentConnections":14,...},
54
+ att_settings: {"name":"att","maxConcurrentConnections":1,...},
55
+ created: 1703224038766344700,
56
+ infra_classification: ,
57
+ infra_monitor: true,
58
+ state: 1,
59
+ auto_warmup_plan: null
60
+ )
61
+ ```
62
+
data/docs/IPAllocationRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # Sendpost::IPAllocationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **overflow_pool** | **Boolean** | Determines whether emails should be sent over shared IP when the IP pool is full | |
8
+ | **ips** | **Array<String>** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'sendpost_ruby_sdk'
14
+
15
+ instance = Sendpost::IPAllocationRequest.new(
16
+ overflow_pool: true,
17
+ ips: null
18
+ )
19
+ ```
20
+