sendpost_ruby_sdk 1.2.2 → 2.0.0

data/docs/EmailMessageFrom.md

@@ -0,0 +1,20 @@
+# 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/EmailMessageObject.md

@@ -0,0 +1,46 @@
+# Sendpost::EmailMessageObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **to** | [**Array<Recipient>**](Recipient.md) |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **pre_text** | **String** |  | [optional] |
+| **html_body** | **String** |  | [optional] |
+| **text_body** | **String** |  | [optional] |
+| **amp_body** | **String** |  | [optional] |
+| **ippool** | **String** |  | [optional] |
+| **headers** | **Hash<String, String>** |  | [optional] |
+| **track_opens** | **Boolean** |  | [optional] |
+| **track_clicks** | **Boolean** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **webhook_endpoint** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::EmailMessageObject.new(
+  from: null,
+  reply_to: null,
+  to: null,
+  subject: null,
+  pre_text: null,
+  html_body: null,
+  text_body: null,
+  amp_body: null,
+  ippool: null,
+  headers: null,
+  track_opens: null,
+  track_clicks: null,
+  groups: null,
+  attachments: null,
+  webhook_endpoint: null
+)
+```
+

data/docs/{ReplyTo.md → EmailMessageReplyTo.md}

@@ -1,20 +1,20 @@
-# Sendpost::ReplyTo
+# Sendpost::EmailMessageReplyTo
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'sendpost_ruby_sdk'
 
-instance = Sendpost::ReplyTo.new(
-  email: welcome@hooli.vom,
-  name: Team @ Hooli
+instance = Sendpost::EmailMessageReplyTo.new(
+  name: Gavin,
+  email: gavin@hooli.com
 )
 ```
 

data/docs/EmailMessageToInner.md

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,22 @@
+# 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/EmailMessageWithTemplate.md

@@ -0,0 +1,52 @@
+# Sendpost::EmailMessageWithTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **to** | [**Array<Recipient>**](Recipient.md) |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **pre_text** | **String** |  | [optional] |
+| **html_body** | **String** |  | [optional] |
+| **text_body** | **String** |  | [optional] |
+| **amp_body** | **String** |  | [optional] |
+| **ippool** | **String** |  | [optional] |
+| **headers** | **Hash<String, String>** |  | [optional] |
+| **track_opens** | **Boolean** |  | [optional] |
+| **track_clicks** | **Boolean** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **webhook_endpoint** | **String** |  | [optional] |
+| **template** | **String** |  | [optional] |
+| **template_id** | **String** | Template ID for the email template | [optional] |
+| **template_variables** | **Hash<String, String>** | Key-Value pair of template variables | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::EmailMessageWithTemplate.new(
+  from: null,
+  reply_to: null,
+  to: null,
+  subject: null,
+  pre_text: null,
+  html_body: null,
+  text_body: null,
+  amp_body: null,
+  ippool: null,
+  headers: null,
+  track_opens: null,
+  track_clicks: null,
+  groups: null,
+  attachments: null,
+  webhook_endpoint: null,
+  template: null,
+  template_id: null,
+  template_variables: null
+)
+```
+

data/docs/EmailResponse.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **to** | **String** |  | [optional] |
+| **submitted_at** | **Integer** | UNIX epoch nano timestamp | [optional] |
+| **message_id** | **String** | Message UUID | [optional] |
 | **error_code** | **Integer** |  | [optional] |
 | **message** | **String** |  | [optional] |
-| **message_id** | **String** |  | [optional] |
-| **submitted_at** | **Integer** |  | [optional] |
-| **to** | **String** |  | [optional] |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EmailResponse.new(
-  error_code: 500,
-  message: ok,
-  message_id: 0e139af1-f1xe-480d-b08d-eg28m48kf48d,
-  submitted_at: 1567512491587205124,
-  to: bighead@bachmanity.com
+  to: null,
+  submitted_at: null,
+  message_id: null,
+  error_code: null,
+  message: null
 )
 ```
 

data/docs/EmailStats.md

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,38 @@
+# 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/Event.md

@@ -0,0 +1,56 @@
+# Sendpost::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **ip_id** | **Integer** |  | [optional] |
+| **ip_pool_id** | **Integer** |  | [optional] |
+| **domain_id** | **Integer** |  | [optional] |
+| **tpsp_id** | **Integer** |  | [optional] |
+| **message_type** | **String** |  | [optional] |
+| **message_subject** | **String** |  | [optional] |
+| **account_id** | **Integer** |  | [optional] |
+| **sub_account_id** | **Integer** |  | [optional] |
+| **message_id** | **String** |  | [optional] |
+| **type** | **Integer** |  | [optional] |
+| **from** | **String** |  | [optional] |
+| **from_name** | **String** |  | [optional] |
+| **to** | **String** |  | [optional] |
+| **to_name** | **String** |  | [optional] |
+| **submitted_at** | **Integer** |  | [optional] |
+| **smtp_code** | **Integer** |  | [optional] |
+| **smtp_description** | **String** |  | [optional] |
+| **event_metadata** | [**EventMetadata**](EventMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Event.new(
+  event_id: edhg-123gh-afasdf-124egh,
+  groups: ["transactional","user-onboarding"],
+  ip_id: 123,
+  ip_pool_id: 123,
+  domain_id: 123,
+  tpsp_id: 1,
+  message_type: default,
+  message_subject: Welcome to Pied Piper :) + 1 quick question,
+  account_id: 117,
+  sub_account_id: 117,
+  message_id: mjhl-1401-sasdf-129324,
+  type: 2,
+  from: richard@piedpiper.com,
+  from_name: Richard,
+  to: gavin@hooli.com,
+  to_name: Gavin,
+  submitted_at: 1567512491587205024,
+  smtp_code: 200,
+  smtp_description: email delivered successfully,
+  event_metadata: null
+)
+```
+

data/docs/EventMetadata.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **clicked_url** | **String** |  | [optional] |
-| **tracked_ip** | **String** |  | [optional] |
-| **raw_user_agent** | **String** |  | [optional] |
-| **device** | [**Device**](Device.md) |  | [optional] |
-| **geo** | [**City**](City.md) |  | [optional] |
-| **os** | [**Os**](Os.md) |  | [optional] |
 | **smtp_code** | **Integer** |  | [optional] |
 | **smtp_description** | **String** |  | [optional] |
 | **user_agent** | [**UserAgent**](UserAgent.md) |  | [optional] |
+| **os** | [**OperatingSystem**](OperatingSystem.md) |  | [optional] |
+| **device** | [**Device**](Device.md) |  | [optional] |
+| **geo** | [**GeoLocation**](GeoLocation.md) |  | [optional] |
+| **clicked_url** | **String** |  | [optional] |
+| **tracked_ip** | **String** |  | [optional] |
+| **raw_user_agent** | **String** |  | [optional] |
 
 ## Example
 
@@ -20,15 +20,15 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EventMetadata.new(
-  clicked_url: null,
-  tracked_ip: null,
-  raw_user_agent: null,
-  device: null,
-  geo: null,
-  os: null,
   smtp_code: 200,
   smtp_description: email delivered successfully,
-  user_agent: null
+  user_agent: null,
+  os: null,
+  device: null,
+  geo: null,
+  clicked_url: https://hooli.com,
+  tracked_ip: 52.34.11.12,
+  raw_user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
 )
 ```
 

data/docs/{City.md → GeoLocation.md}

@@ -1,10 +1,10 @@
-# Sendpost::City
+# Sendpost::GeoLocation
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **city_id** | **Integer** |  | [optional] |
+| **city_id** | **String** |  | [optional] |
 | **continent_code** | **String** |  | [optional] |
 | **country_code** | **String** |  | [optional] |
 | **postal_code** | **String** |  | [optional] |
@@ -15,12 +15,12 @@
 ```ruby
 require 'sendpost_ruby_sdk'
 
-instance = Sendpost::City.new(
-  city_id: null,
-  continent_code: null,
-  country_code: null,
-  postal_code: null,
-  time_zone: null
+instance = Sendpost::GeoLocation.new(
+  city_id: 123,
+  continent_code: EU,
+  country_code: US,
+  postal_code: 12345,
+  time_zone: America/Los_Angeles
 )
 ```
 

data/docs/IP.md

@@ -0,0 +1,62 @@
+# Sendpost::IP
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique ID for the IP |  |
+| **public_ip** | **String** | The public IP address associated with the resource |  |
+| **system_domain** | [**Domain**](Domain.md) |  | [optional] |
+| **reverse_dns_hostname** | **String** | The reverse DNS hostname for the IP | [optional] |
+| **type** | **Integer** | Type of the IP | [optional] |
+| **gmail_settings** | **String** | Configuration for Gmail delivery settings in JSON format | [optional] |
+| **yahoo_settings** | **String** | Configuration for Yahoo delivery settings in JSON format | [optional] |
+| **aol_settings** | **String** | Configuration for AOL delivery settings in JSON format | [optional] |
+| **microsoft_settings** | **String** | Configuration for Microsoft delivery settings in JSON format | [optional] |
+| **comcast_settings** | **String** | Configuration for Comcast delivery settings in JSON format | [optional] |
+| **yandex_settings** | **String** | Configuration for Yandex delivery settings in JSON format | [optional] |
+| **gmx_settings** | **String** | Configuration for GMX delivery settings in JSON format | [optional] |
+| **mailru_settings** | **String** | Configuration for Mail.ru delivery settings in JSON format | [optional] |
+| **icloud_settings** | **String** | Configuration for iCloud delivery settings in JSON format | [optional] |
+| **zoho_settings** | **String** | Configuration for Zoho delivery settings in JSON format | [optional] |
+| **qq_settings** | **String** | Configuration for QQ delivery settings in JSON format | [optional] |
+| **default_settings** | **String** | Default delivery settings in JSON format | [optional] |
+| **att_settings** | **String** | Configuration for AT&T delivery settings in JSON format | [optional] |
+| **created** | **Integer** | The timestamp (UNIX epoch) when the IP was created |  |
+| **infra_classification** | **String** | Classification of the infrastructure | [optional] |
+| **infra_monitor** | **Boolean** | Indicates whether infrastructure monitoring is enabled | [optional] |
+| **state** | **Integer** | The state of the IP | [optional] |
+| **auto_warmup_plan** | [**AutoWarmupPlan**](AutoWarmupPlan.md) | The auto-warmup plan associated with the IP. Can be null if no warmup plan is assigned. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::IP.new(
+  id: 11321,
+  public_ip: 52.34.11.12,
+  system_domain: null,
+  reverse_dns_hostname: example.mtaspg.email,
+  type: 0,
+  gmail_settings: {"name":"gmail","maxConcurrentConnections":100,...},
+  yahoo_settings: {"name":"yahoo","maxConcurrentConnections":16,...},
+  aol_settings: {"name":"aol","maxConcurrentConnections":20,...},
+  microsoft_settings: {"name":"microsoft","maxConcurrentConnections":16,...},
+  comcast_settings: {"name":"comcast","maxConcurrentConnections":20,...},
+  yandex_settings: {"name":"yandex","maxConcurrentConnections":2,...},
+  gmx_settings: {"name":"gmx","maxConcurrentConnections":2,...},
+  mailru_settings: {"name":"mailru","maxConcurrentConnections":1,...},
+  icloud_settings: {"name":"icloud","maxConcurrentConnections":20,...},
+  zoho_settings: {"name":"zoho","maxConcurrentConnections":1,...},
+  qq_settings: {"name":"qq","maxConcurrentConnections":1,...},
+  default_settings: {"name":"default","maxConcurrentConnections":14,...},
+  att_settings: {"name":"att","maxConcurrentConnections":1,...},
+  created: 1703224038766344700,
+  infra_classification: ,
+  infra_monitor: true,
+  state: 1,
+  auto_warmup_plan: null
+)
+```
+

data/docs/IPAllocationRequest.md

@@ -0,0 +1,20 @@
+# Sendpost::IPAllocationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **overflow_pool** | **Boolean** | Determines whether emails should be sent over shared IP when the IP pool is full |  |
+| **ips** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::IPAllocationRequest.new(
+  overflow_pool: true,
+  ips: null
+)
+```
+