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.
- checksums.yaml +4 -4
- data/LICENSE +21 -0
- data/README.md +583 -145
- data/docs/AccountStats.md +20 -0
- data/docs/AccountStatsStat.md +38 -0
- data/docs/AggregateStat.md +38 -0
- data/docs/AggregateStats.md +38 -0
- data/docs/AggregatedEmailStats.md +38 -0
- data/docs/Attachment.md +4 -4
- data/docs/AutoWarmupPlan.md +80 -0
- data/docs/CopyTo.md +5 -5
- data/docs/CreateDomainRequest.md +18 -0
- data/docs/CreateSubAccountRequest.md +18 -0
- data/docs/CreateSuppressionRequest.md +24 -0
- data/docs/CreateSuppressionRequestHardBounceInner.md +18 -0
- data/docs/{SuppressionEmail.md → CreateSuppressionRequestManualInner.md} +3 -3
- data/docs/CreateSuppressionRequestSpamComplaintInner.md +18 -0
- data/docs/CreateSuppressionRequestUnsubscribeInner.md +18 -0
- data/docs/CreateWebhookRequest.md +46 -0
- data/docs/DeleteResponse.md +2 -2
- data/docs/DeleteSubAccountResponse.md +20 -0
- data/docs/DeleteSuppression200ResponseInner.md +20 -0
- data/docs/DeleteSuppressionRequest.md +18 -0
- data/docs/DeleteWebhookResponse.md +20 -0
- data/docs/Device.md +1 -1
- data/docs/Domain.md +56 -0
- data/docs/DomainApi.md +301 -0
- data/docs/DomainDkim.md +22 -0
- data/docs/DomainDmarc.md +22 -0
- data/docs/DomainGpt.md +22 -0
- data/docs/DomainReturnPath.md +22 -0
- data/docs/DomainSpf.md +22 -0
- data/docs/DomainTrack.md +22 -0
- data/docs/EIP.md +18 -0
- data/docs/{From.md → EmailAddress.md} +4 -4
- data/docs/EmailApi.md +38 -32
- data/docs/EmailMessage.md +30 -24
- data/docs/EmailMessageFrom.md +20 -0
- data/docs/EmailMessageObject.md +46 -0
- data/docs/{ReplyTo.md → EmailMessageReplyTo.md} +5 -5
- data/docs/EmailMessageToInner.md +26 -0
- data/docs/EmailMessageToInnerBccInner.md +22 -0
- data/docs/EmailMessageToInnerCcInner.md +22 -0
- data/docs/EmailMessageWithTemplate.md +52 -0
- data/docs/EmailResponse.md +8 -8
- data/docs/EmailStats.md +20 -0
- data/docs/EmailStatsStats.md +38 -0
- data/docs/Event.md +56 -0
- data/docs/EventMetadata.md +13 -13
- data/docs/{City.md → GeoLocation.md} +8 -8
- data/docs/IP.md +62 -0
- data/docs/IPAllocationRequest.md +20 -0
- data/docs/IPApi.md +375 -0
- data/docs/IPDeletionResponse.md +20 -0
- data/docs/IPPool.md +42 -0
- data/docs/IPPoolCreateRequest.md +28 -0
- data/docs/IPPoolDeleteResponse.md +20 -0
- data/docs/IPPoolUpdateRequest.md +24 -0
- data/docs/IPPoolsApi.md +361 -0
- data/docs/IPUpdateRequest.md +18 -0
- data/docs/Label.md +22 -0
- data/docs/Member.md +40 -0
- data/docs/Message.md +76 -0
- data/docs/MessageApi.md +79 -0
- data/docs/MessageHeaderTo.md +26 -0
- data/docs/MessageTo.md +26 -0
- data/docs/{Os.md → OperatingSystem.md} +7 -7
- data/docs/Person.md +20 -0
- data/docs/{To.md → Recipient.md} +7 -7
- data/docs/SMTPAuth.md +26 -0
- data/docs/Stat.md +20 -0
- data/docs/StatStat.md +38 -0
- data/docs/StatStats.md +38 -0
- data/docs/StatsAApi.md +307 -0
- data/docs/StatsApi.md +237 -0
- data/docs/SubAccount.md +48 -0
- data/docs/SubAccountApi.md +375 -0
- data/docs/Suppression.md +8 -8
- data/docs/SuppressionApi.md +76 -134
- data/docs/ThirdPartySendingProvider.md +38 -0
- data/docs/UpdateSubAccount.md +18 -0
- data/docs/UpdateWebhook.md +46 -0
- data/docs/UserAgent.md +4 -4
- data/docs/Webhook.md +54 -0
- data/docs/WebhookApi.md +375 -0
- data/git_push.sh +1 -1
- data/lib/sendpost_ruby_sdk/api/domain_api.rb +290 -0
- data/lib/sendpost_ruby_sdk/api/email_api.rb +33 -35
- data/lib/sendpost_ruby_sdk/api/ip_api.rb +356 -0
- data/lib/sendpost_ruby_sdk/api/ip_pools_api.rb +356 -0
- data/lib/sendpost_ruby_sdk/api/message_api.rb +85 -0
- data/lib/sendpost_ruby_sdk/api/stats_a_api.rb +320 -0
- data/lib/sendpost_ruby_sdk/api/stats_api.rb +260 -0
- data/lib/sendpost_ruby_sdk/api/sub_account_api.rb +356 -0
- data/lib/sendpost_ruby_sdk/api/suppression_api.rb +81 -141
- data/lib/sendpost_ruby_sdk/api/webhook_api.rb +356 -0
- data/lib/sendpost_ruby_sdk/api_client.rb +26 -24
- data/lib/sendpost_ruby_sdk/api_error.rb +3 -3
- data/lib/sendpost_ruby_sdk/configuration.rb +28 -3
- data/lib/sendpost_ruby_sdk/models/account_stats.rb +229 -0
- data/lib/sendpost_ruby_sdk/models/account_stats_stat.rb +311 -0
- data/lib/sendpost_ruby_sdk/models/aggregate_stat.rb +321 -0
- data/lib/sendpost_ruby_sdk/models/aggregate_stats.rb +310 -0
- data/lib/sendpost_ruby_sdk/models/aggregated_email_stats.rb +321 -0
- data/lib/sendpost_ruby_sdk/models/attachment.rb +15 -7
- data/lib/sendpost_ruby_sdk/models/auto_warmup_plan.rb +531 -0
- data/lib/sendpost_ruby_sdk/models/copy_to.rb +28 -19
- data/lib/sendpost_ruby_sdk/models/create_domain_request.rb +221 -0
- data/lib/sendpost_ruby_sdk/models/create_sub_account_request.rb +221 -0
- data/lib/sendpost_ruby_sdk/models/create_suppression_request.rb +259 -0
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_hard_bounce_inner.rb +220 -0
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_manual_inner.rb +220 -0
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_spam_complaint_inner.rb +220 -0
- data/lib/sendpost_ruby_sdk/models/create_suppression_request_unsubscribe_inner.rb +220 -0
- data/lib/sendpost_ruby_sdk/models/create_webhook_request.rb +361 -0
- data/lib/sendpost_ruby_sdk/models/delete_response.rb +15 -7
- data/lib/sendpost_ruby_sdk/models/delete_sub_account_response.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/delete_suppression200_response_inner.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/delete_suppression_request.rb +222 -0
- data/lib/sendpost_ruby_sdk/models/delete_webhook_response.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/device.rb +13 -7
- data/lib/sendpost_ruby_sdk/models/domain.rb +435 -0
- data/lib/sendpost_ruby_sdk/models/domain_dkim.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/domain_dmarc.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/domain_gpt.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/domain_return_path.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/domain_spf.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/domain_track.rb +239 -0
- data/lib/sendpost_ruby_sdk/models/eip.rb +238 -0
- data/lib/sendpost_ruby_sdk/models/email_address.rb +229 -0
- data/lib/sendpost_ruby_sdk/models/email_message.rb +121 -86
- data/lib/sendpost_ruby_sdk/models/email_message_from.rb +229 -0
- data/lib/sendpost_ruby_sdk/models/email_message_object.rb +354 -0
- data/lib/sendpost_ruby_sdk/models/email_message_reply_to.rb +229 -0
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner.rb +262 -0
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner_bcc_inner.rb +240 -0
- data/lib/sendpost_ruby_sdk/models/email_message_to_inner_cc_inner.rb +240 -0
- data/lib/sendpost_ruby_sdk/models/email_message_with_template.rb +392 -0
- data/lib/sendpost_ruby_sdk/models/email_response.rb +40 -32
- data/lib/sendpost_ruby_sdk/models/email_stats.rb +230 -0
- data/lib/sendpost_ruby_sdk/models/email_stats_stats.rb +321 -0
- data/lib/sendpost_ruby_sdk/models/event.rb +393 -0
- data/lib/sendpost_ruby_sdk/models/event_metadata.rb +59 -53
- data/lib/sendpost_ruby_sdk/models/geo_location.rb +256 -0
- data/lib/sendpost_ruby_sdk/models/ip.rb +643 -0
- data/lib/sendpost_ruby_sdk/models/ip_allocation_request.rb +266 -0
- data/lib/sendpost_ruby_sdk/models/ip_deletion_response.rb +265 -0
- data/lib/sendpost_ruby_sdk/models/ip_pool.rb +357 -0
- data/lib/sendpost_ruby_sdk/models/ip_pool_create_request.rb +299 -0
- data/lib/sendpost_ruby_sdk/models/ip_pool_delete_response.rb +229 -0
- data/lib/sendpost_ruby_sdk/models/ip_pool_update_request.rb +249 -0
- data/lib/sendpost_ruby_sdk/models/ip_update_request.rb +238 -0
- data/lib/sendpost_ruby_sdk/models/label.rb +241 -0
- data/lib/sendpost_ruby_sdk/models/member.rb +331 -0
- data/lib/sendpost_ruby_sdk/models/message.rb +523 -0
- data/lib/sendpost_ruby_sdk/models/message_header_to.rb +268 -0
- data/lib/sendpost_ruby_sdk/models/message_to.rb +268 -0
- data/lib/sendpost_ruby_sdk/models/operating_system.rb +256 -0
- data/lib/sendpost_ruby_sdk/models/person.rb +231 -0
- data/lib/sendpost_ruby_sdk/models/recipient.rb +263 -0
- data/lib/sendpost_ruby_sdk/models/smtp_auth.rb +261 -0
- data/lib/sendpost_ruby_sdk/models/stat.rb +230 -0
- data/lib/sendpost_ruby_sdk/models/stat_stat.rb +322 -0
- data/lib/sendpost_ruby_sdk/models/stat_stats.rb +321 -0
- data/lib/sendpost_ruby_sdk/models/sub_account.rb +415 -0
- data/lib/sendpost_ruby_sdk/models/suppression.rb +40 -29
- data/lib/sendpost_ruby_sdk/models/third_party_sending_provider.rb +310 -0
- data/lib/sendpost_ruby_sdk/models/update_sub_account.rb +221 -0
- data/lib/sendpost_ruby_sdk/models/update_webhook.rb +368 -0
- data/lib/sendpost_ruby_sdk/models/user_agent.rb +13 -7
- data/lib/sendpost_ruby_sdk/models/webhook.rb +405 -0
- data/lib/sendpost_ruby_sdk/version.rb +4 -4
- data/lib/sendpost_ruby_sdk.rb +73 -15
- data/spec/api/domain_api_spec.rb +85 -0
- data/spec/api/email_api_spec.rb +9 -9
- data/spec/api/ip_api_spec.rb +98 -0
- data/spec/api/ip_pools_api_spec.rb +98 -0
- data/spec/api/message_api_spec.rb +47 -0
- data/spec/api/stats_a_api_spec.rb +89 -0
- data/spec/api/stats_api_spec.rb +78 -0
- data/spec/api/sub_account_api_spec.rb +98 -0
- data/spec/api/suppression_api_spec.rb +22 -34
- data/spec/api/webhook_api_spec.rb +98 -0
- data/spec/models/account_stats_spec.rb +42 -0
- data/spec/models/account_stats_stat_spec.rb +96 -0
- data/spec/models/aggregate_stat_spec.rb +96 -0
- data/spec/models/aggregate_stats_spec.rb +96 -0
- data/spec/models/aggregated_email_stats_spec.rb +96 -0
- data/spec/models/attachment_spec.rb +6 -4
- data/spec/models/auto_warmup_plan_spec.rb +222 -0
- data/spec/models/copy_to_spec.rb +8 -6
- data/spec/models/create_domain_request_spec.rb +36 -0
- data/spec/models/create_sub_account_request_spec.rb +36 -0
- data/spec/models/create_suppression_request_hard_bounce_inner_spec.rb +36 -0
- data/spec/models/create_suppression_request_manual_inner_spec.rb +36 -0
- data/spec/models/create_suppression_request_spam_complaint_inner_spec.rb +36 -0
- data/spec/models/create_suppression_request_spec.rb +54 -0
- data/spec/models/create_suppression_request_unsubscribe_inner_spec.rb +36 -0
- data/spec/models/create_webhook_request_spec.rb +120 -0
- data/spec/models/delete_response_spec.rb +6 -4
- data/spec/models/delete_sub_account_response_spec.rb +42 -0
- data/spec/models/delete_suppression200_response_inner_spec.rb +42 -0
- data/spec/models/delete_suppression_request_spec.rb +36 -0
- data/spec/models/delete_webhook_response_spec.rb +42 -0
- data/spec/models/device_spec.rb +6 -4
- data/spec/models/domain_dkim_spec.rb +48 -0
- data/spec/models/domain_dmarc_spec.rb +48 -0
- data/spec/models/domain_gpt_spec.rb +48 -0
- data/spec/models/domain_return_path_spec.rb +48 -0
- data/spec/models/domain_spec.rb +150 -0
- data/spec/models/domain_spf_spec.rb +48 -0
- data/spec/models/domain_track_spec.rb +48 -0
- data/spec/models/eip_spec.rb +36 -0
- data/spec/models/email_address_spec.rb +42 -0
- data/spec/models/email_message_from_spec.rb +42 -0
- data/spec/models/email_message_object_spec.rb +120 -0
- data/spec/models/email_message_reply_to_spec.rb +42 -0
- data/spec/models/email_message_spec.rb +37 -17
- data/spec/models/email_message_to_inner_bcc_inner_spec.rb +48 -0
- data/spec/models/email_message_to_inner_cc_inner_spec.rb +48 -0
- data/spec/models/email_message_to_inner_spec.rb +60 -0
- data/spec/models/email_message_with_template_spec.rb +138 -0
- data/spec/models/email_response_spec.rb +10 -8
- data/spec/models/email_stats_spec.rb +42 -0
- data/spec/models/email_stats_stats_spec.rb +96 -0
- data/spec/models/event_metadata_spec.rb +24 -10
- data/spec/models/event_spec.rb +150 -0
- data/spec/models/geo_location_spec.rb +60 -0
- data/spec/models/ip_allocation_request_spec.rb +42 -0
- data/spec/models/ip_deletion_response_spec.rb +42 -0
- data/spec/models/ip_pool_create_request_spec.rb +66 -0
- data/spec/models/ip_pool_delete_response_spec.rb +42 -0
- data/spec/models/ip_pool_spec.rb +108 -0
- data/spec/models/ip_pool_update_request_spec.rb +54 -0
- data/spec/models/ip_spec.rb +168 -0
- data/spec/models/ip_update_request_spec.rb +36 -0
- data/spec/models/label_spec.rb +48 -0
- data/spec/models/member_spec.rb +102 -0
- data/spec/models/message_header_to_spec.rb +60 -0
- data/spec/models/message_spec.rb +210 -0
- data/spec/models/message_to_spec.rb +60 -0
- data/spec/models/operating_system_spec.rb +60 -0
- data/spec/models/person_spec.rb +42 -0
- data/spec/models/recipient_spec.rb +60 -0
- data/spec/models/smtp_auth_spec.rb +60 -0
- data/spec/models/stat_spec.rb +42 -0
- data/spec/models/stat_stat_spec.rb +96 -0
- data/spec/models/stat_stats_spec.rb +96 -0
- data/spec/models/sub_account_spec.rb +130 -0
- data/spec/models/suppression_spec.rb +11 -9
- data/spec/models/third_party_sending_provider_spec.rb +96 -0
- data/spec/models/update_sub_account_spec.rb +36 -0
- data/spec/models/update_webhook_spec.rb +120 -0
- data/spec/models/user_agent_spec.rb +6 -4
- data/spec/models/webhook_spec.rb +144 -0
- data/spec/spec_helper.rb +3 -3
- metadata +295 -66
- data/config-ruby.json +0 -11
- data/docs/CountStat.md +0 -18
- data/docs/QEmailMessage.md +0 -70
- data/docs/QEvent.md +0 -42
- data/docs/RDSuppression.md +0 -18
- data/docs/RSuppression.md +0 -24
- data/docs/WebhookEvent.md +0 -20
- data/generate-libs.bash +0 -1
- data/lib/sendpost_ruby_sdk/models/city.rb +0 -250
- data/lib/sendpost_ruby_sdk/models/count_stat.rb +0 -214
- data/lib/sendpost_ruby_sdk/models/from.rb +0 -223
- data/lib/sendpost_ruby_sdk/models/os.rb +0 -250
- data/lib/sendpost_ruby_sdk/models/q_email_message.rb +0 -456
- data/lib/sendpost_ruby_sdk/models/q_event.rb +0 -324
- data/lib/sendpost_ruby_sdk/models/r_suppression.rb +0 -249
- data/lib/sendpost_ruby_sdk/models/rd_suppression.rb +0 -216
- data/lib/sendpost_ruby_sdk/models/reply_to.rb +0 -223
- data/lib/sendpost_ruby_sdk/models/suppression_email.rb +0 -214
- data/lib/sendpost_ruby_sdk/models/to.rb +0 -254
- data/lib/sendpost_ruby_sdk/models/webhook_event.rb +0 -223
- data/sendpost.yaml +0 -666
- data/sendpost_ruby_sdk.gemspec +0 -38
- data/spec/api_client_spec.rb +0 -228
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/city_spec.rb +0 -58
- data/spec/models/count_stat_spec.rb +0 -34
- data/spec/models/from_spec.rb +0 -40
- data/spec/models/os_spec.rb +0 -58
- data/spec/models/q_email_message_spec.rb +0 -190
- data/spec/models/q_event_spec.rb +0 -106
- data/spec/models/r_suppression_spec.rb +0 -52
- data/spec/models/rd_suppression_spec.rb +0 -34
- data/spec/models/reply_to_spec.rb +0 -40
- data/spec/models/suppression_email_spec.rb +0 -34
- data/spec/models/to_spec.rb +0 -58
- data/spec/models/webhook_event_spec.rb +0 -40
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::AccountStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | | [optional] |
|
|
8
|
+
| **stat** | [**AccountStatsStat**](AccountStatsStat.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::AccountStats.new(
|
|
16
|
+
date: 2020-03-12,
|
|
17
|
+
stat: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Sendpost::AccountStatsStat
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **processed** | **Integer** | | [optional] |
|
|
8
|
+
| **sent** | **Integer** | | [optional] |
|
|
9
|
+
| **delivered** | **Integer** | | [optional] |
|
|
10
|
+
| **dropped** | **Integer** | | [optional] |
|
|
11
|
+
| **smtp_dropped** | **Integer** | | [optional] |
|
|
12
|
+
| **hard_bounced** | **Integer** | | [optional] |
|
|
13
|
+
| **soft_bounced** | **Integer** | | [optional] |
|
|
14
|
+
| **opened** | **Integer** | | [optional] |
|
|
15
|
+
| **clicked** | **Integer** | | [optional] |
|
|
16
|
+
| **unsubscribed** | **Integer** | | [optional] |
|
|
17
|
+
| **spams** | **Integer** | | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'sendpost_ruby_sdk'
|
|
23
|
+
|
|
24
|
+
instance = Sendpost::AccountStatsStat.new(
|
|
25
|
+
processed: 1225,
|
|
26
|
+
sent: 1220,
|
|
27
|
+
delivered: 1200,
|
|
28
|
+
dropped: 10,
|
|
29
|
+
smtp_dropped: 5,
|
|
30
|
+
hard_bounced: 10,
|
|
31
|
+
soft_bounced: 5,
|
|
32
|
+
opened: 150,
|
|
33
|
+
clicked: 130,
|
|
34
|
+
unsubscribed: 15,
|
|
35
|
+
spams: 12
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Sendpost::AggregateStat
|
|
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::AggregateStat.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
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Sendpost::AggregateStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **processed** | **Integer** | | [optional] |
|
|
8
|
+
| **sent** | **Integer** | | [optional] |
|
|
9
|
+
| **delivered** | **Integer** | | [optional] |
|
|
10
|
+
| **dropped** | **Integer** | | [optional] |
|
|
11
|
+
| **smtp_dropped** | **Integer** | | [optional] |
|
|
12
|
+
| **hard_bounced** | **Integer** | | [optional] |
|
|
13
|
+
| **soft_bounced** | **Integer** | | [optional] |
|
|
14
|
+
| **opened** | **Integer** | | [optional] |
|
|
15
|
+
| **clicked** | **Integer** | | [optional] |
|
|
16
|
+
| **unsubscribed** | **Integer** | | [optional] |
|
|
17
|
+
| **spams** | **Integer** | | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'sendpost_ruby_sdk'
|
|
23
|
+
|
|
24
|
+
instance = Sendpost::AggregateStats.new(
|
|
25
|
+
processed: 22500,
|
|
26
|
+
sent: 22400,
|
|
27
|
+
delivered: 20000,
|
|
28
|
+
dropped: 1000,
|
|
29
|
+
smtp_dropped: 400,
|
|
30
|
+
hard_bounced: 1000,
|
|
31
|
+
soft_bounced: 500,
|
|
32
|
+
opened: 5000,
|
|
33
|
+
clicked: 3000,
|
|
34
|
+
unsubscribed: 500,
|
|
35
|
+
spams: 200
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Sendpost::AggregatedEmailStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **processed** | **Integer** | Total number of emails accepted by SendPost API | [optional] |
|
|
8
|
+
| **sent** | **Integer** | Total number of emails sent | [optional] |
|
|
9
|
+
| **delivered** | **Integer** | Total number of emails successfully delivered to SMTP | [optional] |
|
|
10
|
+
| **dropped** | **Integer** | Total number of emails dropped without delivery | [optional] |
|
|
11
|
+
| **smtp_dropped** | **Integer** | Total number of emails dropped by SMTP | [optional] |
|
|
12
|
+
| **hard_bounced** | **Integer** | Total number of hard bounce errors | [optional] |
|
|
13
|
+
| **soft_bounced** | **Integer** | Total number of soft bounce errors | [optional] |
|
|
14
|
+
| **opened** | **Integer** | Total number of emails opened by recipients | [optional] |
|
|
15
|
+
| **clicked** | **Integer** | Total number of links clicked by recipients | [optional] |
|
|
16
|
+
| **unsubscribed** | **Integer** | Total number of unsubscribed recipients | [optional] |
|
|
17
|
+
| **spam** | **Integer** | Total number of spams reported by recipients | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'sendpost_ruby_sdk'
|
|
23
|
+
|
|
24
|
+
instance = Sendpost::AggregatedEmailStats.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/Attachment.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **content** | **String** |
|
|
8
|
-
| **filename** | **String** |
|
|
7
|
+
| **content** | **String** | Base64 encoded attachment content | [optional] |
|
|
8
|
+
| **filename** | **String** | Name of the attachment file | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
require 'sendpost_ruby_sdk'
|
|
14
14
|
|
|
15
15
|
instance = Sendpost::Attachment.new(
|
|
16
|
-
content:
|
|
17
|
-
filename:
|
|
16
|
+
content: null,
|
|
17
|
+
filename: null
|
|
18
18
|
)
|
|
19
19
|
```
|
|
20
20
|
|
|
@@ -0,0 +1,80 @@
|
|
|
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
|
+
|
data/docs/CopyTo.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **name** | **String** | | [optional] |
|
|
8
7
|
| **email** | **String** | | [optional] |
|
|
9
|
-
| **
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **custom_fields** | **Hash<String, Object>** | Custom fields for personalization | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
require 'sendpost_ruby_sdk'
|
|
15
15
|
|
|
16
16
|
instance = Sendpost::CopyTo.new(
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
custom_fields:
|
|
17
|
+
email: null,
|
|
18
|
+
name: null,
|
|
19
|
+
custom_fields: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::CreateDomainRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Name of the domain (e.g., hooli.com). | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::CreateDomainRequest.new(
|
|
15
|
+
name: hooli.com
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
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
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Sendpost::CreateSuppressionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hard_bounce** | [**Array<CreateSuppressionRequestHardBounceInner>**](CreateSuppressionRequestHardBounceInner.md) | list of email addresses which you want to mark in hardBounce suppression list | [optional] |
|
|
8
|
+
| **manual** | [**Array<CreateSuppressionRequestManualInner>**](CreateSuppressionRequestManualInner.md) | list of email addresses which you want to mark in manual suppression list | [optional] |
|
|
9
|
+
| **unsubscribe** | [**Array<CreateSuppressionRequestUnsubscribeInner>**](CreateSuppressionRequestUnsubscribeInner.md) | list of email addresses which you want to mark in unsubscribe suppression list | [optional] |
|
|
10
|
+
| **spam_complaint** | [**Array<CreateSuppressionRequestSpamComplaintInner>**](CreateSuppressionRequestSpamComplaintInner.md) | list of email addresses which you want to mark in spamComplaint suppression list | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'sendpost_ruby_sdk'
|
|
16
|
+
|
|
17
|
+
instance = Sendpost::CreateSuppressionRequest.new(
|
|
18
|
+
hard_bounce: null,
|
|
19
|
+
manual: null,
|
|
20
|
+
unsubscribe: null,
|
|
21
|
+
spam_complaint: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::CreateSuppressionRequestHardBounceInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::CreateSuppressionRequestHardBounceInner.new(
|
|
15
|
+
email: jackbarker@hooli.com
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Sendpost::
|
|
1
|
+
# Sendpost::CreateSuppressionRequestManualInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'sendpost_ruby_sdk'
|
|
13
13
|
|
|
14
|
-
instance = Sendpost::
|
|
15
|
-
email:
|
|
14
|
+
instance = Sendpost::CreateSuppressionRequestManualInner.new(
|
|
15
|
+
email: russhannelman@gmail.com
|
|
16
16
|
)
|
|
17
17
|
```
|
|
18
18
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::CreateSuppressionRequestSpamComplaintInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::CreateSuppressionRequestSpamComplaintInner.new(
|
|
15
|
+
email: gilfoyle@piedpiper.com
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::CreateSuppressionRequestUnsubscribeInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::CreateSuppressionRequestUnsubscribeInner.new(
|
|
15
|
+
email: jared@piedpiper.com
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
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/DeleteResponse.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** |
|
|
8
|
-
| **message** | **String** |
|
|
7
|
+
| **id** | **Integer** | ID of the deleted domain. | [optional] |
|
|
8
|
+
| **message** | **String** | Success message. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::DeleteSubAccountResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | Unique ID for the deleted sub-account. | [optional] |
|
|
8
|
+
| **message** | **String** | Message confirming the deletion. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::DeleteSubAccountResponse.new(
|
|
16
|
+
id: 12,
|
|
17
|
+
message: Sub-Account (FoxHole V1) has been deleted successfully.
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::DeleteSuppression200ResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | The ID of the deleted suppression | [optional] |
|
|
8
|
+
| **message** | **String** | A success message after the suppression(s) are deleted | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::DeleteSuppression200ResponseInner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
message: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Sendpost::DeleteSuppressionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **suppressions** | [**Array<CreateSuppressionRequestSpamComplaintInner>**](CreateSuppressionRequestSpamComplaintInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'sendpost_ruby_sdk'
|
|
13
|
+
|
|
14
|
+
instance = Sendpost::DeleteSuppressionRequest.new(
|
|
15
|
+
suppressions: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Sendpost::DeleteWebhookResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | Unique ID of the deleted webhook. | [optional] |
|
|
8
|
+
| **message** | **String** | Success message. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'sendpost_ruby_sdk'
|
|
14
|
+
|
|
15
|
+
instance = Sendpost::DeleteWebhookResponse.new(
|
|
16
|
+
id: 117,
|
|
17
|
+
message: Webhook (https://app.hooli.com/email/webhook) has been deleted successfully.
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Device.md
CHANGED
data/docs/Domain.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Sendpost::Domain
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | Unique ID for the domain. | [optional] |
|
|
8
|
+
| **name** | **String** | Name of the domain. | [optional] |
|
|
9
|
+
| **dkim** | [**DomainDkim**](DomainDkim.md) | | [optional] |
|
|
10
|
+
| **return_path** | [**DomainReturnPath**](DomainReturnPath.md) | | [optional] |
|
|
11
|
+
| **track** | [**DomainTrack**](DomainTrack.md) | | [optional] |
|
|
12
|
+
| **dmarc** | [**DomainDmarc**](DomainDmarc.md) | | [optional] |
|
|
13
|
+
| **dkim_config** | **String** | DKIM configuration | [optional] |
|
|
14
|
+
| **dkim_verified** | **Boolean** | Status of DKIM verification ( true or false ) | [optional] |
|
|
15
|
+
| **dmarc_verified** | **Boolean** | Status of DMARC verification ( true or false) | [optional] |
|
|
16
|
+
| **return_path_verified** | **Boolean** | Status of ReturnPath verification ( true or false ) | [optional] |
|
|
17
|
+
| **track_verified** | **Boolean** | Status of Track verification ( true or false ) | [optional] |
|
|
18
|
+
| **verified** | **Boolean** | Overall verification status of the domain | [optional] |
|
|
19
|
+
| **domain_registered_date** | **String** | Date when the domain was registered | [optional] |
|
|
20
|
+
| **created** | **Integer** | UNIX epoch timestamp in nanoseconds. | [optional] |
|
|
21
|
+
| **gpt_verified** | **Boolean** | Status of GPT verification ( true or false ) | [optional] |
|
|
22
|
+
| **gpt** | [**DomainGpt**](DomainGpt.md) | | [optional] |
|
|
23
|
+
| **dmarc_failure_reason** | **String** | Reason for DMARC verification failure | [optional] |
|
|
24
|
+
| **dkim_failure_reason** | **String** | Reason for DKIM verification failure | [optional] |
|
|
25
|
+
| **track_failure_reason** | **String** | Reason for Track verification failure | [optional] |
|
|
26
|
+
| **return_path_failure_reason** | **String** | Reason for ReturnPath verification failure | [optional] |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'sendpost_ruby_sdk'
|
|
32
|
+
|
|
33
|
+
instance = Sendpost::Domain.new(
|
|
34
|
+
id: 117,
|
|
35
|
+
name: piedpiper.com,
|
|
36
|
+
dkim: null,
|
|
37
|
+
return_path: null,
|
|
38
|
+
track: null,
|
|
39
|
+
dmarc: null,
|
|
40
|
+
dkim_config: null,
|
|
41
|
+
dkim_verified: false,
|
|
42
|
+
dmarc_verified: false,
|
|
43
|
+
return_path_verified: false,
|
|
44
|
+
track_verified: true,
|
|
45
|
+
verified: false,
|
|
46
|
+
domain_registered_date: 1995-08-14,
|
|
47
|
+
created: 1766394250613907000,
|
|
48
|
+
gpt_verified: false,
|
|
49
|
+
gpt: null,
|
|
50
|
+
dmarc_failure_reason: ,
|
|
51
|
+
dkim_failure_reason: ,
|
|
52
|
+
track_failure_reason: ,
|
|
53
|
+
return_path_failure_reason:
|
|
54
|
+
)
|
|
55
|
+
```
|
|
56
|
+
|