sendpost_ruby_sdk 2.0.0 → 3.0.0

data/docs/AutoWarmupPlan.md

@@ -1,80 +0,0 @@
-# Sendpost::AutoWarmupPlan
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the auto-warmup plan | [optional] |
-| **name** | **String** | Name of the auto-warmup plan | [optional] |
-| **gmail_warmup_plan** | **String** | Gmail warmup plan configuration in JSON format | [optional] |
-| **yahoo_warmup_plan** | **String** | Yahoo warmup plan configuration in JSON format | [optional] |
-| **aol_warmup_plan** | **String** | AOL warmup plan configuration in JSON format | [optional] |
-| **microsoft_warmup_plan** | **String** | Microsoft warmup plan configuration in JSON format | [optional] |
-| **comcast_warmup_plan** | **String** | Comcast warmup plan configuration in JSON format | [optional] |
-| **yandex_warmup_plan** | **String** | Yandex warmup plan configuration in JSON format | [optional] |
-| **gmx_warmup_plan** | **String** | GMX warmup plan configuration in JSON format | [optional] |
-| **mailru_warmup_plan** | **String** | Mail.ru warmup plan configuration in JSON format | [optional] |
-| **icloud_warmup_plan** | **String** | iCloud warmup plan configuration in JSON format | [optional] |
-| **zoho_warmup_plan** | **String** | Zoho warmup plan configuration in JSON format | [optional] |
-| **qq_warmup_plan** | **String** | QQ warmup plan configuration in JSON format | [optional] |
-| **default_warmup_plan** | **String** | Default warmup plan configuration in JSON format | [optional] |
-| **att_warmup_plan** | **String** | AT&T warmup plan configuration in JSON format | [optional] |
-| **office365_warmup_plan** | **String** | Office365 warmup plan configuration in JSON format | [optional] |
-| **googleworkspace_warmup_plan** | **String** | Google Workspace warmup plan configuration in JSON format | [optional] |
-| **proofpoint_warmup_plan** | **String** | Proofpoint warmup plan configuration in JSON format | [optional] |
-| **mimecast_warmup_plan** | **String** | Mimecast warmup plan configuration in JSON format | [optional] |
-| **barracuda_warmup_plan** | **String** | Barracuda warmup plan configuration in JSON format | [optional] |
-| **ciscoironport_warmup_plan** | **String** | Cisco IronPort warmup plan configuration in JSON format | [optional] |
-| **rackspace_warmup_plan** | **String** | Rackspace warmup plan configuration in JSON format | [optional] |
-| **zohobusiness_warmup_plan** | **String** | Zoho Business warmup plan configuration in JSON format | [optional] |
-| **amazonworkmail_warmup_plan** | **String** | Amazon WorkMail warmup plan configuration in JSON format | [optional] |
-| **symantec_warmup_plan** | **String** | Symantec warmup plan configuration in JSON format | [optional] |
-| **fortinet_warmup_plan** | **String** | Fortinet warmup plan configuration in JSON format | [optional] |
-| **sophos_warmup_plan** | **String** | Sophos warmup plan configuration in JSON format | [optional] |
-| **trendmicro_warmup_plan** | **String** | Trend Micro warmup plan configuration in JSON format | [optional] |
-| **checkpoint_warmup_plan** | **String** | Checkpoint warmup plan configuration in JSON format | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the warmup plan was created | [optional] |
-| **updated** | **Integer** | UNIX epoch nano timestamp when the warmup plan was last updated | [optional] |
-| **warmup_interval** | **Integer** | Warmup interval in hours | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::AutoWarmupPlan.new(
-  id: 742,
-  name: Default Auto Warmup Plan,
-  gmail_warmup_plan: null,
-  yahoo_warmup_plan: null,
-  aol_warmup_plan: null,
-  microsoft_warmup_plan: null,
-  comcast_warmup_plan: null,
-  yandex_warmup_plan: null,
-  gmx_warmup_plan: null,
-  mailru_warmup_plan: null,
-  icloud_warmup_plan: null,
-  zoho_warmup_plan: null,
-  qq_warmup_plan: null,
-  default_warmup_plan: null,
-  att_warmup_plan: null,
-  office365_warmup_plan: null,
-  googleworkspace_warmup_plan: null,
-  proofpoint_warmup_plan: null,
-  mimecast_warmup_plan: null,
-  barracuda_warmup_plan: null,
-  ciscoironport_warmup_plan: null,
-  rackspace_warmup_plan: null,
-  zohobusiness_warmup_plan: null,
-  amazonworkmail_warmup_plan: null,
-  symantec_warmup_plan: null,
-  fortinet_warmup_plan: null,
-  sophos_warmup_plan: null,
-  trendmicro_warmup_plan: null,
-  checkpoint_warmup_plan: null,
-  created: 1761234191727534000,
-  updated: 1766535064510659800,
-  warmup_interval: 24
-)
-```
-

data/docs/CreateSubAccountRequest.md

@@ -1,18 +0,0 @@
-# Sendpost::CreateSubAccountRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name for the new sub-account. | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::CreateSubAccountRequest.new(
-  name: FoxHole
-)
-```
-

data/docs/CreateWebhookRequest.md

@@ -1,46 +0,0 @@
-# Sendpost::CreateWebhookRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Is the webhook active or in a paused state? | [optional] |
-| **url** | **String** | URL endpoint to which webhook calls are sent. | [optional] |
-| **processed** | **Boolean** | Trigger webhook on email message being processed. | [optional] |
-| **delivered** | **Boolean** | Trigger webhook on email message being delivered. | [optional] |
-| **dropped** | **Boolean** | Trigger webhook on email message being dropped. | [optional] |
-| **soft_bounced** | **Boolean** | Trigger webhook on email message being soft bounced. | [optional] |
-| **hard_bounced** | **Boolean** | Trigger webhook on email message being hard bounced. | [optional] |
-| **opened** | **Boolean** | Trigger webhook on email message being opened. | [optional] |
-| **clicked** | **Boolean** | Trigger webhook on email message link being clicked. | [optional] |
-| **unsubscribed** | **Boolean** | Trigger webhook on email message being unsubscribed. | [optional] |
-| **spam** | **Boolean** | Trigger webhook on email message being marked as spam. | [optional] |
-| **sent** | **Boolean** | Trigger webhook on email message being sent. | [optional] |
-| **smtp_dropped** | **Boolean** | Trigger webhook on email message being dropped by SMTP. | [optional] |
-| **unique_open** | **Boolean** | Trigger webhook on unique email opens. | [optional] |
-| **unique_click** | **Boolean** | Trigger webhook on unique email clicks. | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::CreateWebhookRequest.new(
-  enabled: true,
-  url: https://app.hooli.com/email/webhook,
-  processed: true,
-  delivered: true,
-  dropped: false,
-  soft_bounced: false,
-  hard_bounced: true,
-  opened: true,
-  clicked: true,
-  unsubscribed: true,
-  spam: true,
-  sent: true,
-  smtp_dropped: false,
-  unique_open: true,
-  unique_click: true
-)
-```
-

data/docs/DomainDkim.md

@@ -1,22 +0,0 @@
-# Sendpost::DomainDkim
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **host** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **text_value** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::DomainDkim.new(
-  host: sp-dkim._domainkey.example.com,
-  type: TXT,
-  text_value: v=DKIM1;k=rsa;s=email;h=sha256;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDU9T3mqruDth2rHXCqNiPzr4oRbHqcUMkqCA4sTZgK7WrhjzerHVyqNAfq4Tyx9s4Tqj0CVfAuENp9mHFKt9Kow5csxqTeVkBoi5UaonafsDstm39ggxFQhKTlRpRoV+VNE5jU9WYlv3wywv28DY2woKYG6QBM6JPSKN1dYQpR4QIDAQAB
-)
-```
-

data/docs/DomainDmarc.md

@@ -1,22 +0,0 @@
-# Sendpost::DomainDmarc
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **host** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **text_value** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::DomainDmarc.new(
-  host: _dmarc.hooli.com,
-  type: TXT,
-  text_value: v=DMARC1; p=none;
-)
-```
-

data/docs/DomainGpt.md

@@ -1,22 +0,0 @@
-# Sendpost::DomainGpt
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **host** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **text_value** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::DomainGpt.new(
-  host: example.com,
-  type: TXT,
-  text_value: 
-)
-```
-

data/docs/DomainReturnPath.md

@@ -1,22 +0,0 @@
-# Sendpost::DomainReturnPath
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **host** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **text_value** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::DomainReturnPath.new(
-  host: sp-bounces.hooli.com,
-  type: CNAME,
-  text_value: sp.sendpost.email
-)
-```
-

data/docs/DomainTrack.md

@@ -1,22 +0,0 @@
-# Sendpost::DomainTrack
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **host** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **text_value** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::DomainTrack.new(
-  host: track.hooli.com,
-  type: CNAME,
-  text_value: api.sendpost.io
-)
-```
-

data/docs/EmailMessageFrom.md

@@ -1,20 +0,0 @@
-# Sendpost::EmailMessageFrom
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailMessageFrom.new(
-  name: Richard,
-  email: richard@piedpiper.com
-)
-```
-

data/docs/EmailMessageToInner.md

@@ -1,26 +0,0 @@
-# Sendpost::EmailMessageToInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **custom_fields** | **Hash<String, String>** |  | [optional] |
-| **cc** | [**Array<EmailMessageToInnerCcInner>**](EmailMessageToInnerCcInner.md) |  | [optional] |
-| **bcc** | [**Array<EmailMessageToInnerBccInner>**](EmailMessageToInnerBccInner.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailMessageToInner.new(
-  name: Gavin,
-  email: gavin@hooli.com,
-  custom_fields: {"Company":"Hooli"},
-  cc: null,
-  bcc: null
-)
-```
-

data/docs/EmailMessageToInnerBccInner.md

@@ -1,22 +0,0 @@
-# Sendpost::EmailMessageToInnerBccInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **custom_fields** | **Hash<String, String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailMessageToInnerBccInner.new(
-  name: Jian,
-  email: jian@bachmanity.com,
-  custom_fields: {Company=Hooli}
-)
-```
-

data/docs/EmailMessageToInnerCcInner.md

@@ -1,22 +0,0 @@
-# Sendpost::EmailMessageToInnerCcInner
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **custom_fields** | **Hash<String, String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailMessageToInnerCcInner.new(
-  name: Dinesh,
-  email: dinesh@bachmanity.com,
-  custom_fields: {Company=Hooli}
-)
-```
-

data/docs/EmailStats.md

@@ -1,20 +0,0 @@
-# Sendpost::EmailStats
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | The UTC date for which stats are retrieved | [optional] |
-| **stats** | [**EmailStatsStats**](EmailStatsStats.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailStats.new(
-  date: null,
-  stats: null
-)
-```
-

data/docs/EmailStatsStats.md

@@ -1,38 +0,0 @@
-# Sendpost::EmailStatsStats
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **processed** | **Integer** | Number of emails accepted by SendPost API | [optional] |
-| **sent** | **Integer** | Number of emails sent | [optional] |
-| **delivered** | **Integer** | Number of emails successfully delivered to SMTP without errors | [optional] |
-| **dropped** | **Integer** | Number of emails dropped without attempting to deliver due to invalid email or suppression list | [optional] |
-| **smtp_dropped** | **Integer** | Number of emails dropped by SMTP | [optional] |
-| **hard_bounced** | **Integer** | Number of emails that resulted in a hard bounce error | [optional] |
-| **soft_bounced** | **Integer** | Number of emails that resulted in a temporary soft bounce error | [optional] |
-| **opened** | **Integer** | Number of emails opened by recipients | [optional] |
-| **clicked** | **Integer** | Number of email links clicked by recipients | [optional] |
-| **unsubscribed** | **Integer** | Number of email recipients who unsubscribed | [optional] |
-| **spam** | **Integer** | Number of emails marked as spam by recipients | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::EmailStatsStats.new(
-  processed: null,
-  sent: null,
-  delivered: null,
-  dropped: null,
-  smtp_dropped: null,
-  hard_bounced: null,
-  soft_bounced: null,
-  opened: null,
-  clicked: null,
-  unsubscribed: null,
-  spam: null
-)
-```
-

data/docs/MessageHeaderTo.md

@@ -1,26 +0,0 @@
-# Sendpost::MessageHeaderTo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the recipient. | [optional] |
-| **email** | **String** | Email address of the recipient. | [optional] |
-| **cc** | **Array<String>** | List of CC recipients | [optional] |
-| **bcc** | **Array<String>** | List of BCC recipients | [optional] |
-| **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::MessageHeaderTo.new(
-  name: Test Recipient,
-  email: aditya@sendx.io,
-  cc: [],
-  bcc: [],
-  custom_fields: {}
-)
-```
-

data/docs/MessageTo.md

@@ -1,26 +0,0 @@
-# Sendpost::MessageTo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the recipient. | [optional] |
-| **email** | **String** | Email address of the recipient. | [optional] |
-| **cc** | **Array<String>** | List of CC recipients | [optional] |
-| **bcc** | **Array<String>** | List of BCC recipients | [optional] |
-| **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::MessageTo.new(
-  name: Test Recipient,
-  email: aditya@sendx.io,
-  cc: [],
-  bcc: [],
-  custom_fields: {}
-)
-```
-

data/docs/OperatingSystem.md

@@ -1,26 +0,0 @@
-# Sendpost::OperatingSystem
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **family** | **String** |  | [optional] |
-| **major** | **String** |  | [optional] |
-| **minor** | **String** |  | [optional] |
-| **patch** | **String** |  | [optional] |
-| **patch_minor** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::OperatingSystem.new(
-  family: Windows,
-  major: 10,
-  minor: 0,
-  patch: 0,
-  patch_minor: 0
-)
-```
-

data/docs/Person.md

@@ -1,20 +0,0 @@
-# Sendpost::Person
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the person. | [optional] |
-| **email** | **String** | Email address of the person. | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::Person.new(
-  name: PiedPipers,
-  email: team@piedpiper.com
-)
-```
-

data/docs/StatStats.md

@@ -1,38 +0,0 @@
-# Sendpost::StatStats
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **processed** | **Integer** | Number of emails accepted by SendPost API. | [optional] |
-| **sent** | **Integer** | Number of emails sent. | [optional] |
-| **delivered** | **Integer** | Number of emails we were able to successfully deliver at SMTP without encountering any error | [optional] |
-| **dropped** | **Integer** | Number of emails drop without attempting to deliver either because the email is invalid or email in in existing suppression list | [optional] |
-| **smtp_dropped** | **Integer** | Number of emails dropped by SMTP. | [optional] |
-| **hard_bounced** | **Integer** | Number of emails where we got SMTP hard bounce error code by the recipient mail provider | [optional] |
-| **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] |
-| **opened** | **Integer** | Number of emails opened by recipients | [optional] |
-| **clicked** | **Integer** | Number of email links clicked by recipients | [optional] |
-| **unsubscribed** | **Integer** | Number of email recipients who unsubscribed from receiving further emails | [optional] |
-| **spam** | **Integer** | Number of email recipients who marked emails as spam | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::StatStats.new(
-  processed: 225,
-  sent: 220,
-  delivered: 200,
-  dropped: 10,
-  smtp_dropped: 5,
-  hard_bounced: 10,
-  soft_bounced: 5,
-  opened: 150,
-  clicked: 130,
-  unsubscribed: 6,
-  spam: 2
-)
-```
-

data/docs/ThirdPartySendingProvider.md

@@ -1,38 +0,0 @@
-# Sendpost::ThirdPartySendingProvider
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **type** | **Integer** |  | [optional] |
-| **domain** | **String** |  | [optional] |
-| **endpoint** | **String** |  | [optional] |
-| **key** | **String** |  | [optional] |
-| **secret** | **String** |  | [optional] |
-| **port** | **Integer** |  | [optional] |
-| **oauth_token** | **String** |  | [optional] |
-| **retry_time** | **Integer** |  | [optional] |
-| **created** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'sendpost_ruby_sdk'
-
-instance = Sendpost::ThirdPartySendingProvider.new(
-  id: 1,
-  name: sendgrid,
-  type: 1,
-  domain: ,
-  endpoint: ,
-  key: ,
-  secret: your_api_key,
-  port: 0,
-  oauth_token: ,
-  retry_time: 0,
-  created: 1597511124701000
-)
-```
-