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.
- checksums.yaml +4 -4
- data/README.md +612 -531
- data/docs/AccountCycleUsage.md +18 -0
- data/docs/AccountStats.md +3 -3
- data/docs/AccountWebhookWithStats.md +58 -0
- data/docs/AggregateStat.md +14 -14
- data/docs/AggregateStats.md +22 -22
- data/docs/Attachment.md +4 -4
- data/docs/BlacklistLinks.md +20 -0
- data/docs/BlacklistResource.md +38 -0
- data/docs/BlacklistedOn.md +20 -0
- data/docs/CopyTo.md +6 -6
- data/docs/CreateDomainRequest.md +2 -2
- data/docs/CreateSuppressionRequest.md +4 -4
- data/docs/CreateSuppressionRequestHardBounceInner.md +1 -1
- data/docs/CreateSuppressionRequestManualInner.md +1 -1
- data/docs/CreateSuppressionRequestSpamComplaintInner.md +1 -1
- data/docs/CreateSuppressionRequestUnsubscribeInner.md +1 -1
- data/docs/DailyStatistics.md +38 -0
- data/docs/DateStat.md +40 -0
- data/docs/DeleteResponse.md +4 -4
- data/docs/DeleteSubAccountResponse.md +4 -4
- data/docs/{DeleteSuppression200ResponseInner.md → DeleteSuppression200Response.md} +2 -4
- data/docs/DeleteSuppressionRequest.md +1 -1
- data/docs/{EmailMessageReplyTo.md → DeleteSuppressionRequestSuppressionsInner.md} +3 -5
- data/docs/DeleteWebhookResponse.md +3 -3
- data/docs/Device.md +2 -2
- data/docs/DnsRecord.md +22 -0
- data/docs/Domain.md +24 -28
- data/docs/DomainApi.md +66 -66
- data/docs/DomainStat.md +46 -0
- data/docs/EIP.md +1 -1
- data/docs/EmailAddress.md +4 -4
- data/docs/EmailApi.md +4 -4
- data/docs/EmailMessage.md +30 -30
- data/docs/EmailMessageObject.md +33 -26
- data/docs/EmailMessageWithTemplate.md +32 -27
- data/docs/EmailResponse.md +10 -10
- data/docs/EmailTypeStat.md +40 -0
- data/docs/ErrorResponse.md +18 -0
- data/docs/ErrorResponseError.md +26 -0
- data/docs/ErrorResponseErrorDetailsInner.md +20 -0
- data/docs/Event.md +18 -36
- data/docs/EventMetadata.md +14 -14
- data/docs/GeoLocation.md +8 -8
- data/docs/GroupStat.md +40 -0
- data/docs/IP.md +13 -43
- data/docs/IPAllocationRequest.md +4 -4
- data/docs/IPApi.md +19 -19
- data/docs/IPDeletionResponse.md +2 -2
- data/docs/IPPool.md +13 -21
- data/docs/IPPoolCreateRequest.md +10 -8
- data/docs/IPPoolDeleteResponse.md +2 -2
- data/docs/IPPoolStat.md +44 -0
- data/docs/IPPoolUpdateRequest.md +13 -7
- data/docs/IPPoolsApi.md +26 -19
- data/docs/IPStat.md +46 -0
- data/docs/IPUpdateRequest.md +2 -2
- data/docs/Label.md +10 -6
- data/docs/Member.md +15 -21
- data/docs/Message.md +37 -53
- data/docs/MessageApi.md +83 -3
- data/docs/NewSubAccount.md +18 -0
- data/docs/NewWebhook.md +46 -0
- data/docs/Os.md +26 -0
- data/docs/PostmasterDomainStat.md +30 -0
- data/docs/ProviderStat.md +40 -0
- data/docs/RAIPPoolStat.md +20 -0
- data/docs/RDStat.md +20 -0
- data/docs/RIPStat.md +20 -0
- data/docs/RStat.md +20 -0
- data/docs/Recipient.md +8 -8
- data/docs/SDStat.md +42 -0
- data/docs/SMTPAuth.md +5 -9
- data/docs/SeedContactStats.md +28 -0
- data/docs/Stat.md +22 -4
- data/docs/StatsAApi.md +24 -24
- data/docs/StatsApi.md +19 -19
- data/docs/SubAccount.md +13 -27
- data/docs/SubAccountApi.md +23 -23
- data/docs/SubAccountStat.md +44 -0
- data/docs/SubAccountStatForPool.md +42 -0
- data/docs/Suppression.md +14 -10
- data/docs/SuppressionApi.md +19 -19
- data/docs/TPSPStat.md +42 -0
- data/docs/UpdateSubAccount.md +2 -2
- data/docs/UpdateWebhook.md +23 -23
- data/docs/UserAgent.md +7 -7
- data/docs/ValidationStat.md +32 -0
- data/docs/Webhook.md +31 -29
- data/docs/WebhookApi.md +28 -28
- data/docs/WebhookObject.md +20 -0
- data/docs/WebhookReferenceApi.md +71 -0
- data/lib/sendpost_ruby_sdk/api/domain_api.rb +84 -84
- data/lib/sendpost_ruby_sdk/api/email_api.rb +6 -6
- data/lib/sendpost_ruby_sdk/api/ip_api.rb +24 -24
- data/lib/sendpost_ruby_sdk/api/ip_pools_api.rb +25 -25
- data/lib/sendpost_ruby_sdk/api/message_api.rb +83 -6
- data/lib/sendpost_ruby_sdk/api/stats_a_api.rb +30 -30
- data/lib/sendpost_ruby_sdk/api/stats_api.rb +24 -24
- data/lib/sendpost_ruby_sdk/api/sub_account_api.rb +33 -33
- data/lib/sendpost_ruby_sdk/api/suppression_api.rb +23 -23
- data/lib/sendpost_ruby_sdk/api/webhook_api.rb +36 -36
- data/lib/sendpost_ruby_sdk/api/webhook_reference_api.rb +82 -0
- data/lib/sendpost_ruby_sdk/api_client.rb +2 -2
- data/lib/sendpost_ruby_sdk/api_error.rb +2 -2
- data/lib/sendpost_ruby_sdk/configuration.rb +2 -2
- data/lib/sendpost_ruby_sdk/models/account_cycle_usage.rb +222 -0
- data/lib/sendpost_ruby_sdk/models/account_stats.rb +5 -3
- data/lib/sendpost_ruby_sdk/models/account_webhook_with_stats.rb +463 -0
- data/lib/sendpost_ruby_sdk/models/aggregate_stat.rb +37 -29
- data/lib/sendpost_ruby_sdk/models/aggregate_stats.rb +43 -24
- data/lib/sendpost_ruby_sdk/models/attachment.rb +48 -4
- data/lib/sendpost_ruby_sdk/models/blacklist_links.rb +232 -0
- data/lib/sendpost_ruby_sdk/models/blacklist_resource.rb +323 -0
- data/lib/sendpost_ruby_sdk/models/blacklisted_on.rb +232 -0
- data/lib/sendpost_ruby_sdk/models/copy_to.rb +42 -3
- data/lib/sendpost_ruby_sdk/models/create_domain_request.rb +32 -3
- data/lib/sendpost_ruby_sdk/models/create_suppression_request.rb +6 -6
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_hard_bounce_inner.rb +2 -2
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_manual_inner.rb +2 -2
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_spam_complaint_inner.rb +2 -2
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_unsubscribe_inner.rb +2 -2
- data/lib/sendpost_ruby_sdk/models/daily_statistics.rb +322 -0
- data/lib/sendpost_ruby_sdk/models/date_stat.rb +339 -0
- data/lib/sendpost_ruby_sdk/models/delete_response.rb +5 -4
- data/lib/sendpost_ruby_sdk/models/delete_sub_account_response.rb +5 -4
- data/lib/sendpost_ruby_sdk/models/delete_suppression200_response.rb +221 -0
- data/lib/sendpost_ruby_sdk/models/delete_suppression_request.rb +4 -3
- data/lib/sendpost_ruby_sdk/models/delete_suppression_request_suppressions_inner.rb +220 -0
- data/lib/sendpost_ruby_sdk/models/delete_webhook_response.rb +5 -4
- data/lib/sendpost_ruby_sdk/models/device.rb +5 -3
- data/lib/sendpost_ruby_sdk/models/dns_record.rb +276 -0
- data/lib/sendpost_ruby_sdk/models/domain.rb +42 -85
- data/lib/sendpost_ruby_sdk/models/domain_stat.rb +369 -0
- data/lib/sendpost_ruby_sdk/models/eip.rb +4 -3
- data/lib/sendpost_ruby_sdk/models/email_address.rb +41 -2
- data/lib/sendpost_ruby_sdk/models/email_message.rb +26 -9
- data/lib/sendpost_ruby_sdk/models/email_message_object.rb +123 -3
- data/lib/sendpost_ruby_sdk/models/email_message_with_template.rb +121 -12
- data/lib/sendpost_ruby_sdk/models/email_response.rb +8 -4
- data/lib/sendpost_ruby_sdk/models/email_type_stat.rb +339 -0
- data/lib/sendpost_ruby_sdk/models/error_response.rb +221 -0
- data/lib/sendpost_ruby_sdk/models/error_response_error.rb +297 -0
- data/lib/sendpost_ruby_sdk/models/error_response_error_details_inner.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/event.rb +94 -118
- data/lib/sendpost_ruby_sdk/models/event_metadata.rb +15 -5
- data/lib/sendpost_ruby_sdk/models/geo_location.rb +20 -14
- data/lib/sendpost_ruby_sdk/models/group_stat.rb +339 -0
- data/lib/sendpost_ruby_sdk/models/ip.rb +72 -375
- data/lib/sendpost_ruby_sdk/models/ip_allocation_request.rb +29 -33
- data/lib/sendpost_ruby_sdk/models/ip_deletion_response.rb +5 -4
- data/lib/sendpost_ruby_sdk/models/ip_pool.rb +94 -82
- data/lib/sendpost_ruby_sdk/models/ip_pool_create_request.rb +91 -29
- data/lib/sendpost_ruby_sdk/models/ip_pool_delete_response.rb +5 -2
- data/lib/sendpost_ruby_sdk/models/ip_pool_stat.rb +359 -0
- data/lib/sendpost_ruby_sdk/models/ip_pool_update_request.rb +97 -7
- data/lib/sendpost_ruby_sdk/models/ip_stat.rb +369 -0
- data/lib/sendpost_ruby_sdk/models/ip_update_request.rb +4 -20
- data/lib/sendpost_ruby_sdk/models/label.rb +101 -6
- data/lib/sendpost_ruby_sdk/models/member.rb +49 -57
- data/lib/sendpost_ruby_sdk/models/message.rb +39 -120
- data/lib/sendpost_ruby_sdk/models/new_sub_account.rb +257 -0
- data/lib/sendpost_ruby_sdk/models/new_webhook.rb +407 -0
- data/lib/sendpost_ruby_sdk/models/os.rb +262 -0
- data/lib/sendpost_ruby_sdk/models/postmaster_domain_stat.rb +282 -0
- data/lib/sendpost_ruby_sdk/models/provider_stat.rb +339 -0
- data/lib/sendpost_ruby_sdk/models/r_stat.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/raip_pool_stat.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/rd_stat.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/recipient.rb +82 -3
- data/lib/sendpost_ruby_sdk/models/rip_stat.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/sd_stat.rb +349 -0
- data/lib/sendpost_ruby_sdk/models/seed_contact_stats.rb +281 -0
- data/lib/sendpost_ruby_sdk/models/smtp_auth.rb +10 -29
- data/lib/sendpost_ruby_sdk/models/stat.rb +108 -16
- data/lib/sendpost_ruby_sdk/models/sub_account.rb +57 -115
- data/lib/sendpost_ruby_sdk/models/sub_account_stat.rb +359 -0
- data/lib/sendpost_ruby_sdk/models/sub_account_stat_for_pool.rb +349 -0
- data/lib/sendpost_ruby_sdk/models/suppression.rb +82 -15
- data/lib/sendpost_ruby_sdk/models/tpsp_stat.rb +349 -0
- data/lib/sendpost_ruby_sdk/models/update_sub_account.rb +32 -3
- data/lib/sendpost_ruby_sdk/models/update_webhook.rb +83 -37
- data/lib/sendpost_ruby_sdk/models/user_agent.rb +11 -6
- data/lib/sendpost_ruby_sdk/models/validation_stat.rb +292 -0
- data/lib/sendpost_ruby_sdk/models/webhook.rb +108 -67
- data/lib/sendpost_ruby_sdk/models/webhook_object.rb +232 -0
- data/lib/sendpost_ruby_sdk/version.rb +3 -3
- data/lib/sendpost_ruby_sdk.rb +36 -27
- data/sendpost_ruby_sdk.gemspec +39 -0
- data/spec/api/webhook_reference_api_spec.rb +46 -0
- data/spec/models/account_cycle_usage_spec.rb +36 -0
- data/spec/models/account_webhook_with_stats_spec.rb +160 -0
- data/spec/models/blacklist_links_spec.rb +42 -0
- data/spec/models/blacklist_resource_spec.rb +96 -0
- data/spec/models/blacklisted_on_spec.rb +42 -0
- data/spec/models/daily_statistics_spec.rb +96 -0
- data/spec/models/date_stat_spec.rb +102 -0
- data/spec/models/delete_suppression200_response_spec.rb +36 -0
- data/spec/models/delete_suppression_request_suppressions_inner_spec.rb +36 -0
- data/spec/models/dns_record_spec.rb +52 -0
- data/spec/models/domain_stat_spec.rb +120 -0
- data/spec/models/email_type_stat_spec.rb +102 -0
- data/spec/models/error_response_error_details_inner_spec.rb +42 -0
- data/spec/models/error_response_error_spec.rb +64 -0
- data/spec/models/error_response_spec.rb +36 -0
- data/spec/models/group_stat_spec.rb +102 -0
- data/spec/models/ip_pool_stat_spec.rb +114 -0
- data/spec/models/ip_stat_spec.rb +120 -0
- data/spec/models/new_sub_account_spec.rb +36 -0
- data/spec/models/new_webhook_spec.rb +120 -0
- data/spec/models/os_spec.rb +60 -0
- data/spec/models/postmaster_domain_stat_spec.rb +72 -0
- data/spec/models/provider_stat_spec.rb +102 -0
- data/spec/models/r_stat_spec.rb +42 -0
- data/spec/models/raip_pool_stat_spec.rb +42 -0
- data/spec/models/rd_stat_spec.rb +42 -0
- data/spec/models/rip_stat_spec.rb +42 -0
- data/spec/models/sd_stat_spec.rb +108 -0
- data/spec/models/seed_contact_stats_spec.rb +66 -0
- data/spec/models/sub_account_stat_for_pool_spec.rb +108 -0
- data/spec/models/sub_account_stat_spec.rb +114 -0
- data/spec/models/tpsp_stat_spec.rb +108 -0
- data/spec/models/validation_stat_spec.rb +78 -0
- data/spec/models/webhook_object_spec.rb +42 -0
- data/spec/spec_helper.rb +2 -2
- metadata +143 -219
- data/LICENSE +0 -21
- data/docs/AccountStatsStat.md +0 -38
- data/docs/AggregatedEmailStats.md +0 -38
- data/docs/AutoWarmupPlan.md +0 -80
- data/docs/CreateSubAccountRequest.md +0 -18
- data/docs/CreateWebhookRequest.md +0 -46
- data/docs/DomainDkim.md +0 -22
- data/docs/DomainDmarc.md +0 -22
- data/docs/DomainGpt.md +0 -22
- data/docs/DomainReturnPath.md +0 -22
- data/docs/DomainSpf.md +0 -22
- data/docs/DomainTrack.md +0 -22
- data/docs/EmailMessageFrom.md +0 -20
- data/docs/EmailMessageToInner.md +0 -26
- data/docs/EmailMessageToInnerBccInner.md +0 -22
- data/docs/EmailMessageToInnerCcInner.md +0 -22
- data/docs/EmailStats.md +0 -20
- data/docs/EmailStatsStats.md +0 -38
- data/docs/MessageHeaderTo.md +0 -26
- data/docs/MessageTo.md +0 -26
- data/docs/OperatingSystem.md +0 -26
- data/docs/Person.md +0 -20
- data/docs/StatStat.md +0 -38
- data/docs/StatStats.md +0 -38
- data/docs/ThirdPartySendingProvider.md +0 -38
- data/lib/sendpost_ruby_sdk/models/account_stats_stat.rb +0 -311
- data/lib/sendpost_ruby_sdk/models/aggregated_email_stats.rb +0 -321
- data/lib/sendpost_ruby_sdk/models/auto_warmup_plan.rb +0 -531
- data/lib/sendpost_ruby_sdk/models/create_sub_account_request.rb +0 -221
- data/lib/sendpost_ruby_sdk/models/create_webhook_request.rb +0 -361
- data/lib/sendpost_ruby_sdk/models/delete_suppression200_response_inner.rb +0 -231
- data/lib/sendpost_ruby_sdk/models/domain_dkim.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/domain_dmarc.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/domain_gpt.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/domain_return_path.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/domain_spf.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/domain_track.rb +0 -239
- data/lib/sendpost_ruby_sdk/models/email_message_from.rb +0 -229
- data/lib/sendpost_ruby_sdk/models/email_message_reply_to.rb +0 -229
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner.rb +0 -262
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner_bcc_inner.rb +0 -240
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner_cc_inner.rb +0 -240
- data/lib/sendpost_ruby_sdk/models/email_stats.rb +0 -230
- data/lib/sendpost_ruby_sdk/models/email_stats_stats.rb +0 -321
- data/lib/sendpost_ruby_sdk/models/message_header_to.rb +0 -268
- data/lib/sendpost_ruby_sdk/models/message_to.rb +0 -268
- data/lib/sendpost_ruby_sdk/models/operating_system.rb +0 -256
- data/lib/sendpost_ruby_sdk/models/person.rb +0 -231
- data/lib/sendpost_ruby_sdk/models/stat_stat.rb +0 -322
- data/lib/sendpost_ruby_sdk/models/stat_stats.rb +0 -321
- data/lib/sendpost_ruby_sdk/models/third_party_sending_provider.rb +0 -310
- data/spec/api/domain_api_spec.rb +0 -85
- data/spec/api/email_api_spec.rb +0 -59
- data/spec/api/ip_api_spec.rb +0 -98
- data/spec/api/ip_pools_api_spec.rb +0 -98
- data/spec/api/message_api_spec.rb +0 -47
- data/spec/api/stats_a_api_spec.rb +0 -89
- data/spec/api/stats_api_spec.rb +0 -78
- data/spec/api/sub_account_api_spec.rb +0 -98
- data/spec/api/suppression_api_spec.rb +0 -76
- data/spec/api/webhook_api_spec.rb +0 -98
- data/spec/models/account_stats_spec.rb +0 -42
- data/spec/models/account_stats_stat_spec.rb +0 -96
- data/spec/models/aggregate_stat_spec.rb +0 -96
- data/spec/models/aggregate_stats_spec.rb +0 -96
- data/spec/models/aggregated_email_stats_spec.rb +0 -96
- data/spec/models/attachment_spec.rb +0 -42
- data/spec/models/auto_warmup_plan_spec.rb +0 -222
- data/spec/models/copy_to_spec.rb +0 -48
- data/spec/models/create_domain_request_spec.rb +0 -36
- data/spec/models/create_sub_account_request_spec.rb +0 -36
- data/spec/models/create_suppression_request_hard_bounce_inner_spec.rb +0 -36
- data/spec/models/create_suppression_request_manual_inner_spec.rb +0 -36
- data/spec/models/create_suppression_request_spam_complaint_inner_spec.rb +0 -36
- data/spec/models/create_suppression_request_spec.rb +0 -54
- data/spec/models/create_suppression_request_unsubscribe_inner_spec.rb +0 -36
- data/spec/models/create_webhook_request_spec.rb +0 -120
- data/spec/models/delete_response_spec.rb +0 -42
- data/spec/models/delete_sub_account_response_spec.rb +0 -42
- data/spec/models/delete_suppression200_response_inner_spec.rb +0 -42
- data/spec/models/delete_suppression_request_spec.rb +0 -36
- data/spec/models/delete_webhook_response_spec.rb +0 -42
- data/spec/models/device_spec.rb +0 -36
- data/spec/models/domain_dkim_spec.rb +0 -48
- data/spec/models/domain_dmarc_spec.rb +0 -48
- data/spec/models/domain_gpt_spec.rb +0 -48
- data/spec/models/domain_return_path_spec.rb +0 -48
- data/spec/models/domain_spec.rb +0 -150
- data/spec/models/domain_spf_spec.rb +0 -48
- data/spec/models/domain_track_spec.rb +0 -48
- data/spec/models/eip_spec.rb +0 -36
- data/spec/models/email_address_spec.rb +0 -42
- data/spec/models/email_message_from_spec.rb +0 -42
- data/spec/models/email_message_object_spec.rb +0 -120
- data/spec/models/email_message_reply_to_spec.rb +0 -42
- data/spec/models/email_message_spec.rb +0 -138
- data/spec/models/email_message_to_inner_bcc_inner_spec.rb +0 -48
- data/spec/models/email_message_to_inner_cc_inner_spec.rb +0 -48
- data/spec/models/email_message_to_inner_spec.rb +0 -60
- data/spec/models/email_message_with_template_spec.rb +0 -138
- data/spec/models/email_response_spec.rb +0 -60
- data/spec/models/email_stats_spec.rb +0 -42
- data/spec/models/email_stats_stats_spec.rb +0 -96
- data/spec/models/event_metadata_spec.rb +0 -84
- data/spec/models/event_spec.rb +0 -150
- data/spec/models/geo_location_spec.rb +0 -60
- data/spec/models/ip_allocation_request_spec.rb +0 -42
- data/spec/models/ip_deletion_response_spec.rb +0 -42
- data/spec/models/ip_pool_create_request_spec.rb +0 -66
- data/spec/models/ip_pool_delete_response_spec.rb +0 -42
- data/spec/models/ip_pool_spec.rb +0 -108
- data/spec/models/ip_pool_update_request_spec.rb +0 -54
- data/spec/models/ip_spec.rb +0 -168
- data/spec/models/ip_update_request_spec.rb +0 -36
- data/spec/models/label_spec.rb +0 -48
- data/spec/models/member_spec.rb +0 -102
- data/spec/models/message_header_to_spec.rb +0 -60
- data/spec/models/message_spec.rb +0 -210
- data/spec/models/message_to_spec.rb +0 -60
- data/spec/models/operating_system_spec.rb +0 -60
- data/spec/models/person_spec.rb +0 -42
- data/spec/models/recipient_spec.rb +0 -60
- data/spec/models/smtp_auth_spec.rb +0 -60
- data/spec/models/stat_spec.rb +0 -42
- data/spec/models/stat_stat_spec.rb +0 -96
- data/spec/models/stat_stats_spec.rb +0 -96
- data/spec/models/sub_account_spec.rb +0 -130
- data/spec/models/suppression_spec.rb +0 -60
- data/spec/models/third_party_sending_provider_spec.rb +0 -96
- data/spec/models/update_sub_account_spec.rb +0 -36
- data/spec/models/update_webhook_spec.rb +0 -120
- data/spec/models/user_agent_spec.rb +0 -54
- data/spec/models/webhook_spec.rb +0 -144
data/docs/Message.md
CHANGED
|
@@ -4,36 +4,28 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_id** | **String** | Unique
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **
|
|
25
|
-
| **
|
|
26
|
-
| **
|
|
27
|
-
| **
|
|
28
|
-
| **
|
|
29
|
-
| **html_body** | **String** | HTML email content. | [optional] |
|
|
30
|
-
| **text_body** | **String** | Text email content. | [optional] |
|
|
31
|
-
| **amp_body** | **String** | AMP email content. | [optional] |
|
|
32
|
-
| **track_opens** | **Boolean** | Indicates if email opens need to be tracked. | [optional] |
|
|
33
|
-
| **track_clicks** | **Boolean** | Indicates if email clicks need to be tracked. | [optional] |
|
|
34
|
-
| **attempt** | **Integer** | Number of delivery attempts made for the message. | [optional] |
|
|
35
|
-
| **webhook_endpoint** | **String** | Webhook endpoint URL for the message. | [optional] |
|
|
36
|
-
| **mx_records** | **Array<String>** | List of MX records for the recipient domain | [optional] |
|
|
7
|
+
| **message_id** | **String** | Unique identifier (UUID) for this email message | [optional] |
|
|
8
|
+
| **sub_account_id** | **Integer** | ID of the sub-account that sent this email | [optional] |
|
|
9
|
+
| **public_ip** | **String** | The public IP address used to send this email | [optional] |
|
|
10
|
+
| **email_type** | **String** | Classification of the email, e.g. \"transactional\" or \"marketing\". | [optional] |
|
|
11
|
+
| **submitted_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the email was submitted | [optional] |
|
|
12
|
+
| **from** | [**EmailAddress**](EmailAddress.md) | The sender's email address and display name | [optional] |
|
|
13
|
+
| **reply_to** | [**EmailAddress**](EmailAddress.md) | The Reply-To email address and display name | [optional] |
|
|
14
|
+
| **to** | [**Recipient**](Recipient.md) | The primary recipient, including any per-recipient CC/BCC and custom fields | [optional] |
|
|
15
|
+
| **header_to** | [**Recipient**](Recipient.md) | The address rendered in the visible To header (may differ from the envelope recipient) | [optional] |
|
|
16
|
+
| **header_cc** | [**Array<CopyTo>**](CopyTo.md) | Addresses rendered in the visible Cc header | [optional] |
|
|
17
|
+
| **header_bcc** | [**Array<CopyTo>**](CopyTo.md) | Addresses rendered in the visible Bcc header | [optional] |
|
|
18
|
+
| **attachments** | [**Array<Attachment>**](Attachment.md) | File attachments included with the email | [optional] |
|
|
19
|
+
| **groups** | **Array<String>** | Tags/groups associated with this email | [optional] |
|
|
20
|
+
| **ip_pool** | **String** | Name of the IP pool used for sending | [optional] |
|
|
21
|
+
| **headers** | **Hash<String, String>** | Custom SMTP headers set on the message | [optional] |
|
|
22
|
+
| **subject** | **String** | The email subject line | [optional] |
|
|
23
|
+
| **pre_text** | **String** | Preheader/preview text shown by many email clients after the subject | [optional] |
|
|
24
|
+
| **html_body** | **String** | The HTML body of the email | [optional] |
|
|
25
|
+
| **text_body** | **String** | The plain-text body of the email | [optional] |
|
|
26
|
+
| **amp_body** | **String** | The AMP for Email body, if provided | [optional] |
|
|
27
|
+
| **track_opens** | **Boolean** | Whether open tracking was enabled for this email | [optional] |
|
|
28
|
+
| **track_clicks** | **Boolean** | Whether click tracking was enabled for this email | [optional] |
|
|
37
29
|
|
|
38
30
|
## Example
|
|
39
31
|
|
|
@@ -41,36 +33,28 @@
|
|
|
41
33
|
require 'sendpost_ruby_sdk'
|
|
42
34
|
|
|
43
35
|
instance = Sendpost::Message.new(
|
|
44
|
-
message_id:
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
public_ip: 34.196.37.102,
|
|
50
|
-
local_ip: 10.1.0.195,
|
|
51
|
-
email_type: googleworkspace,
|
|
52
|
-
submitted_at: 1766396394503841392,
|
|
36
|
+
message_id: 550e8400-e29b-41d4-a716-446655440000,
|
|
37
|
+
sub_account_id: 117,
|
|
38
|
+
public_ip: 52.34.11.12,
|
|
39
|
+
email_type: transactional,
|
|
40
|
+
submitted_at: 1704067200000000000,
|
|
53
41
|
from: null,
|
|
54
42
|
reply_to: null,
|
|
55
43
|
to: null,
|
|
56
44
|
header_to: null,
|
|
57
|
-
header_cc:
|
|
45
|
+
header_cc: null,
|
|
58
46
|
header_bcc: null,
|
|
59
|
-
attachments:
|
|
60
|
-
groups: [],
|
|
61
|
-
ip_pool: ,
|
|
62
|
-
headers: {X-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
text_body: Hello from SendPost! This is a test email sent using the SendPost Java SDK from Maven Central.,
|
|
47
|
+
attachments: null,
|
|
48
|
+
groups: [order-confirmation, transactional],
|
|
49
|
+
ip_pool: transactional,
|
|
50
|
+
headers: {X-Campaign-Id=12345},
|
|
51
|
+
subject: Your order has been shipped!,
|
|
52
|
+
pre_text: Your order is on its way,
|
|
53
|
+
html_body: <h1>Your order has shipped!</h1>,
|
|
54
|
+
text_body: Your order has shipped!,
|
|
68
55
|
amp_body: ,
|
|
69
56
|
track_opens: true,
|
|
70
|
-
track_clicks: true
|
|
71
|
-
attempt: 0,
|
|
72
|
-
webhook_endpoint: ,
|
|
73
|
-
mx_records: [alt3.aspmx.l.google.com, alt4.aspmx.l.google.com, alt1.aspmx.l.google.com, alt2.aspmx.l.google.com, aspmx.l.google.com]
|
|
57
|
+
track_clicks: true
|
|
74
58
|
)
|
|
75
59
|
```
|
|
76
60
|
|
data/docs/MessageApi.md
CHANGED
|
@@ -4,16 +4,96 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_all_messages**](MessageApi.md#get_all_messages) | **GET** /account/message | List Messages |
|
|
7
8
|
| [**get_message_by_id**](MessageApi.md#get_message_by_id) | **GET** /account/message/{message_id} | Get Message |
|
|
8
9
|
|
|
9
10
|
|
|
11
|
+
## get_all_messages
|
|
12
|
+
|
|
13
|
+
> <Array<Message>> get_all_messages(from, to, opts)
|
|
14
|
+
|
|
15
|
+
List Messages
|
|
16
|
+
|
|
17
|
+
Retrieve a paginated list of all email messages sent through your account. Each message includes delivery status, timestamps, and metadata. **Message Information Includes:** - Sender and recipient details - Subject line and message ID - Delivery status (delivered, bounced, opened, etc.) - Timestamps for each event - IP address and pool used for sending **Use Cases:** - Search for specific emails sent to customers - Debug delivery issues for specific recipients - Audit email delivery for compliance - Export message logs for analysis - Customer support - lookup specific email by recipient **Example:** Find all emails to a specific domain in the last week: ``` GET /account/message?from=2024-01-01T00:00:00Z&to=2024-01-07T23:59:59Z ``` **Note:** Maximum date range is 60 days.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'sendpost_ruby_sdk'
|
|
24
|
+
# setup authorization
|
|
25
|
+
Sendpost.configure do |config|
|
|
26
|
+
# Configure API key authorization: accountAuth
|
|
27
|
+
config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = Sendpost::MessageApi.new
|
|
33
|
+
from = Time.parse('2024-01-01T00:00:00Z') # Time | Start timestamp for message retrieval. ISO 8601 format.
|
|
34
|
+
to = Time.parse('2024-01-31T23:59:59Z') # Time | End timestamp for message retrieval. Max 60 days from `from`.
|
|
35
|
+
opts = {
|
|
36
|
+
limit: 50, # Integer | Number of records to return per request. Default 50, max 100.
|
|
37
|
+
offset: 0 # Integer | Number of initial records to skip for pagination.
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# List Messages
|
|
42
|
+
result = api_instance.get_all_messages(from, to, opts)
|
|
43
|
+
p result
|
|
44
|
+
rescue Sendpost::ApiError => e
|
|
45
|
+
puts "Error when calling MessageApi->get_all_messages: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the get_all_messages_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(<Array<Message>>, Integer, Hash)> get_all_messages_with_http_info(from, to, opts)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# List Messages
|
|
58
|
+
data, status_code, headers = api_instance.get_all_messages_with_http_info(from, to, opts)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => <Array<Message>>
|
|
62
|
+
rescue Sendpost::ApiError => e
|
|
63
|
+
puts "Error when calling MessageApi->get_all_messages_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **from** | **Time** | Start timestamp for message retrieval. ISO 8601 format. | |
|
|
72
|
+
| **to** | **Time** | End timestamp for message retrieval. Max 60 days from `from`. | |
|
|
73
|
+
| **limit** | **Integer** | Number of records to return per request. Default 50, max 100. | [optional][default to 50] |
|
|
74
|
+
| **offset** | **Integer** | Number of initial records to skip for pagination. | [optional][default to 0] |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**Array<Message>**](Message.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[accountAuth](../README.md#accountAuth)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: Not defined
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
89
|
+
|
|
10
90
|
## get_message_by_id
|
|
11
91
|
|
|
12
92
|
> <Message> get_message_by_id(message_id)
|
|
13
93
|
|
|
14
94
|
Get Message
|
|
15
95
|
|
|
16
|
-
Retrieve
|
|
96
|
+
Retrieve complete details about a specific email message, including full event timeline and metadata. **Response Includes:** - Full message details (sender, recipients, subject) - Complete event timeline (submitted, sent, delivered, opened, clicked) - Bounce/drop information with reasons - IP and pool used for sending - Click and open tracking data **Use Cases:** - Debug why a specific email wasn't delivered - Customer support - provide delivery proof - Audit trail for compliance requirements - Analyze engagement for specific messages
|
|
17
97
|
|
|
18
98
|
### Examples
|
|
19
99
|
|
|
@@ -29,7 +109,7 @@ Sendpost.configure do |config|
|
|
|
29
109
|
end
|
|
30
110
|
|
|
31
111
|
api_instance = Sendpost::MessageApi.new
|
|
32
|
-
message_id = '
|
|
112
|
+
message_id = 'msg_01H2X3Y4Z5A6B7C8D9E0F1G2H3' # String | The unique message ID returned when the email was sent.
|
|
33
113
|
|
|
34
114
|
begin
|
|
35
115
|
# Get Message
|
|
@@ -62,7 +142,7 @@ end
|
|
|
62
142
|
|
|
63
143
|
| Name | Type | Description | Notes |
|
|
64
144
|
| ---- | ---- | ----------- | ----- |
|
|
65
|
-
| **message_id** | **String** | The ID
|
|
145
|
+
| **message_id** | **String** | The unique message ID returned when the email was sent. | |
|
|
66
146
|
|
|
67
147
|
### Return type
|
|
68
148
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::NewSubAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display name for the new sub-account. Must be unique within your account. Use descriptive names like \"Marketing - Production\" or \"Customer: Acme Corp\" | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::NewSubAccount.new(
|
|
15
|
+
name: Marketing - Production
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/NewWebhook.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Sendpost::NewWebhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | Whether the webhook is active immediately after creation. Set to false to configure and test before activating. | [optional][default to true] |
|
|
8
|
+
| **url** | **String** | HTTPS URL endpoint to receive webhook POST requests. Must: - Use HTTPS (HTTP not allowed for security) - Be publicly accessible - Return 2xx status within 10 seconds - Handle duplicate deliveries (use eventId for idempotency) | |
|
|
9
|
+
| **processed** | **Boolean** | Fire when email is accepted by SendPost API | [optional][default to false] |
|
|
10
|
+
| **sent** | **Boolean** | Fire when email is sent to recipient's mail server | [optional][default to false] |
|
|
11
|
+
| **delivered** | **Boolean** | Fire when email is accepted by recipient's mail server | [optional][default to true] |
|
|
12
|
+
| **dropped** | **Boolean** | Fire when email is not sent (suppression, invalid, etc.) | [optional][default to true] |
|
|
13
|
+
| **smtp_dropped** | **Boolean** | Fire when email is rejected at SMTP level | [optional][default to false] |
|
|
14
|
+
| **soft_bounced** | **Boolean** | Fire on temporary delivery failure (will retry) | [optional][default to true] |
|
|
15
|
+
| **hard_bounced** | **Boolean** | Fire on permanent delivery failure | [optional][default to true] |
|
|
16
|
+
| **opened** | **Boolean** | Fire when email is opened. Fires on EVERY open. Consider using `uniqueOpen` instead to reduce volume. | [optional][default to true] |
|
|
17
|
+
| **clicked** | **Boolean** | Fire when a link is clicked. Fires on EVERY click. Consider using `uniqueClick` instead to reduce volume. | [optional][default to true] |
|
|
18
|
+
| **unsubscribed** | **Boolean** | Fire when recipient clicks unsubscribe link | [optional][default to true] |
|
|
19
|
+
| **spam** | **Boolean** | Fire when recipient marks email as spam | [optional][default to true] |
|
|
20
|
+
| **unique_open** | **Boolean** | Fire only on FIRST open of each email (unique opens). More efficient than `opened` if you only need engagement metrics. | [optional][default to false] |
|
|
21
|
+
| **unique_click** | **Boolean** | Fire only on FIRST click of each email (unique clicks). More efficient than `clicked` if you only need engagement metrics. | [optional][default to false] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'sendpost_ruby_sdk'
|
|
27
|
+
|
|
28
|
+
instance = Sendpost::NewWebhook.new(
|
|
29
|
+
enabled: true,
|
|
30
|
+
url: https://app.hooli.com/api/webhooks/sendpost,
|
|
31
|
+
processed: false,
|
|
32
|
+
sent: false,
|
|
33
|
+
delivered: true,
|
|
34
|
+
dropped: true,
|
|
35
|
+
smtp_dropped: false,
|
|
36
|
+
soft_bounced: true,
|
|
37
|
+
hard_bounced: true,
|
|
38
|
+
opened: true,
|
|
39
|
+
clicked: true,
|
|
40
|
+
unsubscribed: true,
|
|
41
|
+
spam: true,
|
|
42
|
+
unique_open: false,
|
|
43
|
+
unique_click: false
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
data/docs/Os.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Sendpost::Os
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **family** | **String** | Operating system family name. Common values: Windows, macOS, iOS, Android, Linux | [optional] |
|
|
8
|
+
| **major** | **String** | Major version number | [optional] |
|
|
9
|
+
| **minor** | **String** | Minor version number | [optional] |
|
|
10
|
+
| **patch** | **String** | Patch version number | [optional] |
|
|
11
|
+
| **patch_minor** | **String** | Additional patch version component | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'sendpost_ruby_sdk'
|
|
17
|
+
|
|
18
|
+
instance = Sendpost::Os.new(
|
|
19
|
+
family: macOS,
|
|
20
|
+
major: 14,
|
|
21
|
+
minor: 2,
|
|
22
|
+
patch: 1,
|
|
23
|
+
patch_minor: 0
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Sendpost::PostmasterDomainStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The domain these Postmaster statistics belong to. | [optional] |
|
|
8
|
+
| **date** | **String** | The date these statistics apply to (YYYY-MM-DD, UTC). | [optional] |
|
|
9
|
+
| **domain_reputation** | **String** | Google's reputation rating for the domain (e.g. `HIGH`, `MEDIUM`, `LOW`, `BAD`). | [optional] |
|
|
10
|
+
| **spam** | **String** | User-reported spam rate for the domain (fraction, string-encoded). | [optional] |
|
|
11
|
+
| **dkim_success** | **String** | Fraction of mail that passed DKIM authentication (string-encoded). | [optional] |
|
|
12
|
+
| **spf_success** | **String** | Fraction of mail that passed SPF authentication (string-encoded). | [optional] |
|
|
13
|
+
| **dmarc_success** | **String** | Fraction of mail that passed DMARC authentication (string-encoded). | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'sendpost_ruby_sdk'
|
|
19
|
+
|
|
20
|
+
instance = Sendpost::PostmasterDomainStat.new(
|
|
21
|
+
name: mail.hooli.com,
|
|
22
|
+
date: 2024-01-15,
|
|
23
|
+
domain_reputation: HIGH,
|
|
24
|
+
spam: 0.01,
|
|
25
|
+
dkim_success: 0.99,
|
|
26
|
+
spf_success: 0.98,
|
|
27
|
+
dmarc_success: 0.97
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Sendpost::ProviderStat
|
|
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
|
+
| **provider** | **String** | The email provider these statistics are aggregated for. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'sendpost_ruby_sdk'
|
|
24
|
+
|
|
25
|
+
instance = Sendpost::ProviderStat.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
|
+
provider: google
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::RAIPPoolStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | The date these IP-pool statistics apply to (YYYY-MM-DD, UTC). | [optional] |
|
|
8
|
+
| **stat** | [**Stat**](Stat.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::RAIPPoolStat.new(
|
|
16
|
+
date: 2024-01-15,
|
|
17
|
+
stat: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/RDStat.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::RDStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | The date these domain statistics apply to (YYYY-MM-DD, UTC). | [optional] |
|
|
8
|
+
| **stat** | [**Stat**](Stat.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::RDStat.new(
|
|
16
|
+
date: 2024-01-15,
|
|
17
|
+
stat: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/RIPStat.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::RIPStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | The date these IP statistics apply to (YYYY-MM-DD, UTC). | [optional] |
|
|
8
|
+
| **stat** | [**IPStat**](IPStat.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::RIPStat.new(
|
|
16
|
+
date: 2024-01-15,
|
|
17
|
+
stat: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/RStat.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::RStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | The date these statistics apply to (YYYY-MM-DD, UTC). | [optional] |
|
|
8
|
+
| **stat** | [**Stat**](Stat.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::RStat.new(
|
|
16
|
+
date: 2024-01-15,
|
|
17
|
+
stat: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Recipient.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **email** | **String** |
|
|
8
|
-
| **name** | **String** |
|
|
9
|
-
| **cc** | [**Array<CopyTo>**](CopyTo.md) | | [optional] |
|
|
10
|
-
| **bcc** | [**Array<CopyTo>**](CopyTo.md) | | [optional] |
|
|
11
|
-
| **custom_fields** | **Hash<String, Object>** | Custom fields for
|
|
7
|
+
| **email** | **String** | The recipient's email address | |
|
|
8
|
+
| **name** | **String** | The recipient's display name | [optional] |
|
|
9
|
+
| **cc** | [**Array<CopyTo>**](CopyTo.md) | Carbon copy recipients for this specific recipient's email. CC addresses will be visible to all recipients of this email copy. | [optional] |
|
|
10
|
+
| **bcc** | [**Array<CopyTo>**](CopyTo.md) | Blind carbon copy recipients for this specific recipient's email. BCC addresses are hidden from all other recipients. | [optional] |
|
|
11
|
+
| **custom_fields** | **Hash<String, Object>** | Custom fields for personalizing the email content for this recipient. Use Handlebars syntax ({{fieldName}}) in subject, htmlBody, or textBody to insert values. Reserved field names: `unsubscribe` (auto-generated unsubscribe link). | [optional] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'sendpost_ruby_sdk'
|
|
17
17
|
|
|
18
18
|
instance = Sendpost::Recipient.new(
|
|
19
|
-
email:
|
|
20
|
-
name:
|
|
19
|
+
email: recipient@example.com,
|
|
20
|
+
name: Jane Smith,
|
|
21
21
|
cc: null,
|
|
22
22
|
bcc: null,
|
|
23
|
-
custom_fields:
|
|
23
|
+
custom_fields: {firstName=Jane, lastName=Smith, accountId=ACC-12345, planName=Premium}
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
data/docs/SDStat.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Sendpost::SDStat
|
|
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
|
+
| **sub_account_id** | **Integer** | Unique identifier of the sub-account. | [optional] |
|
|
19
|
+
| **sub_account_name** | **String** | Human-readable name of the sub-account. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'sendpost_ruby_sdk'
|
|
25
|
+
|
|
26
|
+
instance = Sendpost::SDStat.new(
|
|
27
|
+
processed: 225,
|
|
28
|
+
sent: 220,
|
|
29
|
+
dropped: 10,
|
|
30
|
+
smtp_dropped: 5,
|
|
31
|
+
delivered: 200,
|
|
32
|
+
soft_bounced: 5,
|
|
33
|
+
hard_bounced: 10,
|
|
34
|
+
opened: 150,
|
|
35
|
+
clicked: 50,
|
|
36
|
+
unsubscribed: 6,
|
|
37
|
+
spam: 2,
|
|
38
|
+
sub_account_id: 42,
|
|
39
|
+
sub_account_name: Marketing
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
data/docs/SMTPAuth.md
CHANGED
|
@@ -4,11 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | Unique
|
|
8
|
-
| **username** | **String** |
|
|
9
|
-
| **
|
|
10
|
-
| **created** | **Integer** | UNIX epoch nano timestamp when the SMTP Auth was created | [optional] |
|
|
11
|
-
| **updated** | **Integer** | UNIX epoch nano timestamp when the SMTP Auth was updated | [optional] |
|
|
7
|
+
| **id** | **Integer** | Unique identifier for the SMTP credentials | [optional] |
|
|
8
|
+
| **username** | **String** | SMTP username for authentication. Format: {identifier}@{subaccount_id}.sendpost.io | [optional] |
|
|
9
|
+
| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when credentials were created | [optional] |
|
|
12
10
|
|
|
13
11
|
## Example
|
|
14
12
|
|
|
@@ -17,10 +15,8 @@ require 'sendpost_ruby_sdk'
|
|
|
17
15
|
|
|
18
16
|
instance = Sendpost::SMTPAuth.new(
|
|
19
17
|
id: 117,
|
|
20
|
-
username: default@
|
|
21
|
-
|
|
22
|
-
created: 1567512491588004044,
|
|
23
|
-
updated: 1567512491588004044
|
|
18
|
+
username: default@50441.sendpost.io,
|
|
19
|
+
created: 1704067200000000000
|
|
24
20
|
)
|
|
25
21
|
```
|
|
26
22
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Sendpost::SeedContactStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **stat** | [**Stat**](Stat.md) | | [optional] |
|
|
8
|
+
| **r_stats** | [**Array<RStat>**](RStat.md) | Per-day statistics for the seed-contact run. | [optional] |
|
|
9
|
+
| **group_stats** | [**Array<GroupStat>**](GroupStat.md) | Statistics broken down by group/tag. | [optional] |
|
|
10
|
+
| **domain_stats** | [**Array<DomainStat>**](DomainStat.md) | Statistics broken down by sending domain. | [optional] |
|
|
11
|
+
| **ip_stats** | [**Array<IPStat>**](IPStat.md) | Statistics broken down by sending IP address. | [optional] |
|
|
12
|
+
| **provider_stats** | [**Array<ProviderStat>**](ProviderStat.md) | Statistics broken down by email provider. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'sendpost_ruby_sdk'
|
|
18
|
+
|
|
19
|
+
instance = Sendpost::SeedContactStats.new(
|
|
20
|
+
stat: null,
|
|
21
|
+
r_stats: null,
|
|
22
|
+
group_stats: null,
|
|
23
|
+
domain_stats: null,
|
|
24
|
+
ip_stats: null,
|
|
25
|
+
provider_stats: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|