sendpost_ruby_sdk 1.2.2 → 2.0.2

data/docs/SuppressionApi.md

@@ -4,126 +4,59 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**count**](SuppressionApi.md#count) | **GET** /subaccount/suppression/count |  |
-| [**create_suppressions**](SuppressionApi.md#create_suppressions) | **POST** /subaccount/suppression/ |  |
-| [**delete_suppression**](SuppressionApi.md#delete_suppression) | **DELETE** /subaccount/suppression/ |  |
-| [**get_suppressions**](SuppressionApi.md#get_suppressions) | **GET** /subaccount/suppression/ |  |
+| [**create_suppression**](SuppressionApi.md#create_suppression) | **POST** /subaccount/suppression | Create Suppressions |
+| [**delete_suppression**](SuppressionApi.md#delete_suppression) | **DELETE** /subaccount/suppression | Delete Suppressions |
+| [**get_suppression_list**](SuppressionApi.md#get_suppression_list) | **GET** /subaccount/suppression | List Suppressions |
 
 
-## count
+## create_suppression
 
-> <CountStat> count(x_sub_account_api_key, opts)
+> <Array<Suppression>> create_suppression(create_suppression_request)
 
+Create Suppressions
 
-
-Count Total Suppressions
+Creates new suppressions by posting to the suppression resource. You can specify different types of suppressions including `hardBounce`, `manual`, `unsubscribe`, and `spamComplaint`. 
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'sendpost_ruby_sdk'
-
-api_instance = Sendpost::SuppressionApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
-opts = {
-  from: 'from_example', # String | from date
-  to: 'to_example' # String | to date
-}
-
-begin
-  
-  result = api_instance.count(x_sub_account_api_key, opts)
-  p result
-rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->count: #{e}"
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: subAccountAuth
+  config.api_key['X-SubAccount-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-SubAccount-ApiKey'] = 'Bearer'
 end
-```
-
-#### Using the count_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<CountStat>, Integer, Hash)> count_with_http_info(x_sub_account_api_key, opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.count_with_http_info(x_sub_account_api_key, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <CountStat>
-rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->count_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **from** | **String** | from date | [optional] |
-| **to** | **String** | to date | [optional] |
-
-### Return type
-
-[**CountStat**](CountStat.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## create_suppressions
-
-> <Array<Suppression>> create_suppressions(x_sub_account_api_key, opts)
-
-
-
-Add Email Addresses To Suppression List
-
-### Examples
-
-```ruby
-require 'time'
-require 'sendpost_ruby_sdk'
 
 api_instance = Sendpost::SuppressionApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
-opts = {
-  r_suppression: Sendpost::RSuppression.new # RSuppression | Suppression content
-}
+create_suppression_request = Sendpost::CreateSuppressionRequest.new # CreateSuppressionRequest | 
 
 begin
-  
-  result = api_instance.create_suppressions(x_sub_account_api_key, opts)
+  # Create Suppressions
+  result = api_instance.create_suppression(create_suppression_request)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->create_suppressions: #{e}"
+  puts "Error when calling SuppressionApi->create_suppression: #{e}"
 end
 ```
 
-#### Using the create_suppressions_with_http_info variant
+#### Using the create_suppression_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<Suppression>>, Integer, Hash)> create_suppressions_with_http_info(x_sub_account_api_key, opts)
+> <Array(<Array<Suppression>>, Integer, Hash)> create_suppression_with_http_info(create_suppression_request)
 
 ```ruby
 begin
-  
-  data, status_code, headers = api_instance.create_suppressions_with_http_info(x_sub_account_api_key, opts)
+  # Create Suppressions
+  data, status_code, headers = api_instance.create_suppression_with_http_info(create_suppression_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<Suppression>>
 rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->create_suppressions_with_http_info: #{e}"
+  puts "Error when calling SuppressionApi->create_suppression_with_http_info: #{e}"
 end
 ```
 
@@ -131,8 +64,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **r_suppression** | [**RSuppression**](RSuppression.md) | Suppression content | [optional] |
+| **create_suppression_request** | [**CreateSuppressionRequest**](CreateSuppressionRequest.md) |  |  |
 
 ### Return type
 
@@ -140,7 +72,7 @@ end
 
 ### Authorization
 
-No authorization required
+[subAccountAuth](../README.md#subAccountAuth)
 
 ### HTTP request headers
 
@@ -150,27 +82,31 @@ No authorization required
 
 ## delete_suppression
 
-> <Array<DeleteResponse>> delete_suppression(x_sub_account_api_key, opts)
-
+> <Array<DeleteSuppression200ResponseInner>> delete_suppression(delete_suppression_request)
 
+Delete Suppressions
 
-Delete specific emails which are in suppression list
+Deletes one or more suppressions for a given sub-account. The request can contain a list of emails to delete specific suppressions or delete a single suppression. 
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: subAccountAuth
+  config.api_key['X-SubAccount-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-SubAccount-ApiKey'] = 'Bearer'
+end
 
 api_instance = Sendpost::SuppressionApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
-opts = {
-  rd_suppression: Sendpost::RDSuppression.new # RDSuppression | Suppression content
-}
+delete_suppression_request = Sendpost::DeleteSuppressionRequest.new # DeleteSuppressionRequest | 
 
 begin
-  
-  result = api_instance.delete_suppression(x_sub_account_api_key, opts)
+  # Delete Suppressions
+  result = api_instance.delete_suppression(delete_suppression_request)
   p result
 rescue Sendpost::ApiError => e
   puts "Error when calling SuppressionApi->delete_suppression: #{e}"
@@ -181,15 +117,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<DeleteResponse>>, Integer, Hash)> delete_suppression_with_http_info(x_sub_account_api_key, opts)
+> <Array(<Array<DeleteSuppression200ResponseInner>>, Integer, Hash)> delete_suppression_with_http_info(delete_suppression_request)
 
 ```ruby
 begin
-  
-  data, status_code, headers = api_instance.delete_suppression_with_http_info(x_sub_account_api_key, opts)
+  # Delete Suppressions
+  data, status_code, headers = api_instance.delete_suppression_with_http_info(delete_suppression_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<DeleteResponse>>
+  p data # => <Array<DeleteSuppression200ResponseInner>>
 rescue Sendpost::ApiError => e
   puts "Error when calling SuppressionApi->delete_suppression_with_http_info: #{e}"
 end
@@ -199,16 +135,15 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **rd_suppression** | [**RDSuppression**](RDSuppression.md) | Suppression content | [optional] |
+| **delete_suppression_request** | [**DeleteSuppressionRequest**](DeleteSuppressionRequest.md) |  |  |
 
 ### Return type
 
-[**Array&lt;DeleteResponse&gt;**](DeleteResponse.md)
+[**Array&lt;DeleteSuppression200ResponseInner&gt;**](DeleteSuppression200ResponseInner.md)
 
 ### Authorization
 
-No authorization required
+[subAccountAuth](../README.md#subAccountAuth)
 
 ### HTTP request headers
 
@@ -216,54 +151,61 @@ No authorization required
 - **Accept**: application/json
 
 
-## get_suppressions
-
-> <Array<Suppression>> get_suppressions(x_sub_account_api_key, opts)
+## get_suppression_list
 
+> <Array<Suppression>> get_suppression_list(from, to, opts)
 
+List Suppressions
 
-Get all suppressions
+Retrieves a list of suppressions associated with a specific sub-account within a given date range. The maximum difference between `from` and `to` dates should not exceed 60 days. 
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: subAccountAuth
+  config.api_key['X-SubAccount-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-SubAccount-ApiKey'] = 'Bearer'
+end
 
 api_instance = Sendpost::SuppressionApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+from = Date.parse('2013-10-20') # Date | Start date for the suppression records
+to = Date.parse('2013-10-20') # Date | End date for the suppression records (Note: `from` should be earlier than `to` and the date range should not exceed 60 days) 
 opts = {
-  offset: 789, # Integer | offset
-  limit: 789, # Integer | limit
-  search: 'search_example', # String | search
-  from: 'from_example', # String | from date
-  to: 'to_example' # String | to date
+  limit: 56, # Integer | Number of records to return per request
+  offset: 56, # Integer | Number of initial records to skip
+  search: 'search_example', # String | Case-insensitive search against suppression email
+  type: 'hardBounce' # String | Type of suppression. Valid values: `hardBounce`, `manual`, `spamComplaint`, `unsubscribe` 
 }
 
 begin
-  
-  result = api_instance.get_suppressions(x_sub_account_api_key, opts)
+  # List Suppressions
+  result = api_instance.get_suppression_list(from, to, opts)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->get_suppressions: #{e}"
+  puts "Error when calling SuppressionApi->get_suppression_list: #{e}"
 end
 ```
 
-#### Using the get_suppressions_with_http_info variant
+#### Using the get_suppression_list_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<Suppression>>, Integer, Hash)> get_suppressions_with_http_info(x_sub_account_api_key, opts)
+> <Array(<Array<Suppression>>, Integer, Hash)> get_suppression_list_with_http_info(from, to, opts)
 
 ```ruby
 begin
-  
-  data, status_code, headers = api_instance.get_suppressions_with_http_info(x_sub_account_api_key, opts)
+  # List Suppressions
+  data, status_code, headers = api_instance.get_suppression_list_with_http_info(from, to, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<Suppression>>
 rescue Sendpost::ApiError => e
-  puts "Error when calling SuppressionApi->get_suppressions_with_http_info: #{e}"
+  puts "Error when calling SuppressionApi->get_suppression_list_with_http_info: #{e}"
 end
 ```
 
@@ -271,12 +213,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **offset** | **Integer** | offset | [optional] |
-| **limit** | **Integer** | limit | [optional] |
-| **search** | **String** | search | [optional] |
-| **from** | **String** | from date | [optional] |
-| **to** | **String** | to date | [optional] |
+| **from** | **Date** | Start date for the suppression records |  |
+| **to** | **Date** | End date for the suppression records (Note: &#x60;from&#x60; should be earlier than &#x60;to&#x60; and the date range should not exceed 60 days)  |  |
+| **limit** | **Integer** | Number of records to return per request | [optional][default to 20] |
+| **offset** | **Integer** | Number of initial records to skip | [optional][default to 0] |
+| **search** | **String** | Case-insensitive search against suppression email | [optional] |
+| **type** | **String** | Type of suppression. Valid values: &#x60;hardBounce&#x60;, &#x60;manual&#x60;, &#x60;spamComplaint&#x60;, &#x60;unsubscribe&#x60;  | [optional] |
 
 ### Return type
 
@@ -284,7 +226,7 @@ end
 
 ### Authorization
 
-No authorization required
+[subAccountAuth](../README.md#subAccountAuth)
 
 ### HTTP request headers
 

data/docs/ThirdPartySendingProvider.md

@@ -0,0 +1,38 @@
+# 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
+)
+```
+

data/docs/UpdateSubAccount.md

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

data/docs/UpdateWebhook.md

@@ -0,0 +1,46 @@
+# Sendpost::UpdateWebhook
+
+## 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::UpdateWebhook.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/UserAgent.md

@@ -15,10 +15,10 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::UserAgent.new(
-  family: null,
-  major: null,
-  minor: null,
-  patch: null
+  family: Mozilla,
+  major: 5.0,
+  minor: 0,
+  patch: 0
 )
 ```
 

data/docs/Webhook.md

@@ -0,0 +1,54 @@
+# Sendpost::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique ID for the webhook. | [optional] |
+| **enabled** | **Boolean** | Indicates if the webhook is active or paused. | [optional] |
+| **url** | **String** | URL endpoint to which webhook calls need to be made. | [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] |
+| **created** | **Integer** | UNIX epoch nano timestamp when the webhook was created. | [optional] |
+| **created_by** | **Hash<String, Object>** | Member who created the webhook | [optional] |
+| **updated_by** | **Hash<String, Object>** | Member who updated the webhook | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Webhook.new(
+  id: 117,
+  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,
+  created: 1567512491588004044,
+  created_by: null,
+  updated_by: null
+)
+```
+