sendpost_ruby_sdk 1.2.2 → 2.0.2

data/docs/{To.md → Recipient.md}

@@ -1,26 +1,26 @@
-# Sendpost::To
+# Sendpost::Recipient
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
 | **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
 | **cc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
 | **bcc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
-| **custom_fields** | **Object** |  | [optional] |
+| **custom_fields** | **Hash<String, Object>** | Custom fields for personalization | [optional] |
 
 ## Example
 
 ```ruby
 require 'sendpost_ruby_sdk'
 
-instance = Sendpost::To.new(
-  name: Elrich Bachman,
-  email: elrich@bachmanity.com,
+instance = Sendpost::Recipient.new(
+  email: null,
+  name: null,
   cc: null,
   bcc: null,
-  custom_fields: {"Company":"Bachmanity"}
+  custom_fields: null
 )
 ```
 

data/docs/SMTPAuth.md

@@ -0,0 +1,26 @@
+# Sendpost::SMTPAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique ID for the SMTP Auth | [optional] |
+| **username** | **String** | Username for the SMTP Auth | [optional] |
+| **password** | **String** | Password for the SMTP Auth | [optional] |
+| **created** | **Integer** | UNIX epoch nano timestamp when the SMTP Auth was created | [optional] |
+| **updated** | **Integer** | UNIX epoch nano timestamp when the SMTP Auth was updated | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::SMTPAuth.new(
+  id: 117,
+  username: default@117.sendpost.io,
+  password: default@117.sendpost.io,
+  created: 1567512491588004044,
+  updated: 1567512491588004044
+)
+```
+

data/docs/Stat.md

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

data/docs/StatStat.md

@@ -0,0 +1,38 @@
+# Sendpost::StatStat
+
+## 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::StatStat.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/StatStats.md

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

@@ -0,0 +1,307 @@
+# Sendpost::StatsAApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_account_aggregate_stats**](StatsAApi.md#get_account_aggregate_stats) | **GET** /account/stat/aggregate | Get Account Aggregate Stats |
+| [**get_account_aggregate_stats_by_group**](StatsAApi.md#get_account_aggregate_stats_by_group) | **GET** /account/stat/aggregate/group | Get Account Group Aggregate Stats |
+| [**get_account_stats_by_group**](StatsAApi.md#get_account_stats_by_group) | **GET** /account/stat/group | List Account Group Stats |
+| [**get_all_account_stats**](StatsAApi.md#get_all_account_stats) | **GET** /account/stat | List Account Stats |
+
+
+## get_account_aggregate_stats
+
+> <AggregateStats> get_account_aggregate_stats(from, to)
+
+Get Account Aggregate Stats
+
+Retrieve aggregated email statistics for all sub-accounts of a specific account for a given date range.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::StatsAApi.new
+from = Date.parse('2019-01-01') # Date | The start date for retrieving aggregated stats (inclusive)
+to = Date.parse('2019-12-31') # Date | The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days.
+
+begin
+  # Get Account Aggregate Stats
+  result = api_instance.get_account_aggregate_stats(from, to)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_aggregate_stats: #{e}"
+end
+```
+
+#### Using the get_account_aggregate_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AggregateStats>, Integer, Hash)> get_account_aggregate_stats_with_http_info(from, to)
+
+```ruby
+begin
+  # Get Account Aggregate Stats
+  data, status_code, headers = api_instance.get_account_aggregate_stats_with_http_info(from, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AggregateStats>
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_aggregate_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **Date** | The start date for retrieving aggregated stats (inclusive) |  |
+| **to** | **Date** | The end date for retrieving aggregated stats (inclusive). The difference between &#x60;from&#x60; and &#x60;to&#x60; should not exceed 366 days. |  |
+
+### Return type
+
+[**AggregateStats**](AggregateStats.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_account_aggregate_stats_by_group
+
+> <AggregateStat> get_account_aggregate_stats_by_group(group, from, to)
+
+Get Account Group Aggregate Stats
+
+Gets aggregated email stats for a specific group in all sub-accounts of a specific account for the given daterange. The maximum daterange for which these stats can be retrieved is 366 days.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::StatsAApi.new
+group = 'shopify' # String | Group whose aggregate stats need to be retrieved.
+from = Date.parse('2019-01-01') # Date | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`).
+to = Date.parse('2019-12-31') # Date | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days.
+
+begin
+  # Get Account Group Aggregate Stats
+  result = api_instance.get_account_aggregate_stats_by_group(group, from, to)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_aggregate_stats_by_group: #{e}"
+end
+```
+
+#### Using the get_account_aggregate_stats_by_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AggregateStat>, Integer, Hash)> get_account_aggregate_stats_by_group_with_http_info(group, from, to)
+
+```ruby
+begin
+  # Get Account Group Aggregate Stats
+  data, status_code, headers = api_instance.get_account_aggregate_stats_by_group_with_http_info(group, from, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AggregateStat>
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_aggregate_stats_by_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | **String** | Group whose aggregate stats need to be retrieved. |  |
+| **from** | **Date** | Date from which stats should be retrieved (should be in the format &#x60;YYYY-MM-DD&#x60;). |  |
+| **to** | **Date** | Date to which stats should be retrieved (should be in the format &#x60;YYYY-MM-DD&#x60;). Note that the difference between &#x60;from&#x60; and &#x60;to&#x60; should not be more than 366 days. |  |
+
+### Return type
+
+[**AggregateStat**](AggregateStat.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_account_stats_by_group
+
+> <Array<Stat>> get_account_stats_by_group(group, from, to)
+
+List Account Group Stats
+
+Gets a list of all email stats for all sub-accounts of a specific account by group for a given daterange. The maximum daterange for which these stats can be retrieved is 31 days.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::StatsAApi.new
+group = 'shopify' # String | Group whose stats need to be retrieved
+from = Date.parse('2020-03-12') # Date | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`)
+to = Date.parse('2020-04-14') # Date | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days.
+
+begin
+  # List Account Group Stats
+  result = api_instance.get_account_stats_by_group(group, from, to)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_stats_by_group: #{e}"
+end
+```
+
+#### Using the get_account_stats_by_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Stat>>, Integer, Hash)> get_account_stats_by_group_with_http_info(group, from, to)
+
+```ruby
+begin
+  # List Account Group Stats
+  data, status_code, headers = api_instance.get_account_stats_by_group_with_http_info(group, from, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Stat>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_account_stats_by_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | **String** | Group whose stats need to be retrieved |  |
+| **from** | **Date** | Date from which stats should be retrieved (should be in the format &#x60;YYYY-MM-DD&#x60;) |  |
+| **to** | **Date** | Date to which stats should be retrieved (should be in the format &#x60;YYYY-MM-DD&#x60;). Note that the difference between &#x60;from&#x60; and &#x60;to&#x60; should not be more than 31 days. |  |
+
+### Return type
+
+[**Array&lt;Stat&gt;**](Stat.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_account_stats
+
+> <Array<AccountStats>> get_all_account_stats(from, to)
+
+List Account Stats
+
+Retrieve email statistics for all sub-accounts of a specific account for a given date range.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::StatsAApi.new
+from = Date.parse('2020-03-12') # Date | The start date for retrieving stats (inclusive)
+to = Date.parse('2020-04-14') # Date | The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days.
+
+begin
+  # List Account Stats
+  result = api_instance.get_all_account_stats(from, to)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_all_account_stats: #{e}"
+end
+```
+
+#### Using the get_all_account_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AccountStats>>, Integer, Hash)> get_all_account_stats_with_http_info(from, to)
+
+```ruby
+begin
+  # List Account Stats
+  data, status_code, headers = api_instance.get_all_account_stats_with_http_info(from, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AccountStats>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling StatsAApi->get_all_account_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **Date** | The start date for retrieving stats (inclusive) |  |
+| **to** | **Date** | The end date for retrieving stats (inclusive). The difference between &#x60;from&#x60; and &#x60;to&#x60; should not exceed 31 days. |  |
+
+### Return type
+
+[**Array&lt;AccountStats&gt;**](AccountStats.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+