sendpost_ruby_sdk 1.2.2 → 2.0.2

data/docs/DomainApi.md

@@ -0,0 +1,301 @@
+# Sendpost::DomainApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_all_domains**](DomainApi.md#get_all_domains) | **GET** /subaccount/domain | List Domains |
+| [**subaccount_domain_domain_id_delete**](DomainApi.md#subaccount_domain_domain_id_delete) | **DELETE** /subaccount/domain/{domain_id} | Delete Domain |
+| [**subaccount_domain_domain_id_get**](DomainApi.md#subaccount_domain_domain_id_get) | **GET** /subaccount/domain/{domain_id} | Get Domain |
+| [**subaccount_domain_post**](DomainApi.md#subaccount_domain_post) | **POST** /subaccount/domain | Create Domain |
+
+
+## get_all_domains
+
+> <Array<Domain>> get_all_domains(opts)
+
+List Domains
+
+Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status. 
+
+### 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::DomainApi.new
+opts = {
+  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 domain names
+}
+
+begin
+  # List Domains
+  result = api_instance.get_all_domains(opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->get_all_domains: #{e}"
+end
+```
+
+#### Using the get_all_domains_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Domain>>, Integer, Hash)> get_all_domains_with_http_info(opts)
+
+```ruby
+begin
+  # List Domains
+  data, status_code, headers = api_instance.get_all_domains_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Domain>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->get_all_domains_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of records to return per request | [optional] |
+| **offset** | **Integer** | Number of initial records to skip | [optional] |
+| **search** | **String** | Case insensitive search against domain names | [optional] |
+
+### Return type
+
+[**Array&lt;Domain&gt;**](Domain.md)
+
+### Authorization
+
+[subAccountAuth](../README.md#subAccountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subaccount_domain_domain_id_delete
+
+> <DeleteResponse> subaccount_domain_domain_id_delete(domain_id)
+
+Delete Domain
+
+Delete a specific domain using its `id`.
+
+### 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::DomainApi.new
+domain_id = 'domain_id_example' # String | The unique ID of the domain to delete.
+
+begin
+  # Delete Domain
+  result = api_instance.subaccount_domain_domain_id_delete(domain_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_domain_id_delete: #{e}"
+end
+```
+
+#### Using the subaccount_domain_domain_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteResponse>, Integer, Hash)> subaccount_domain_domain_id_delete_with_http_info(domain_id)
+
+```ruby
+begin
+  # Delete Domain
+  data, status_code, headers = api_instance.subaccount_domain_domain_id_delete_with_http_info(domain_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteResponse>
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_domain_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** | The unique ID of the domain to delete. |  |
+
+### Return type
+
+[**DeleteResponse**](DeleteResponse.md)
+
+### Authorization
+
+[subAccountAuth](../README.md#subAccountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subaccount_domain_domain_id_get
+
+> <Domain> subaccount_domain_domain_id_get(domain_id)
+
+Get Domain
+
+Retrieve details of a specific domain using its `id`.
+
+### 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::DomainApi.new
+domain_id = 'domain_id_example' # String | The unique ID of the domain to retrieve.
+
+begin
+  # Get Domain
+  result = api_instance.subaccount_domain_domain_id_get(domain_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_domain_id_get: #{e}"
+end
+```
+
+#### Using the subaccount_domain_domain_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> subaccount_domain_domain_id_get_with_http_info(domain_id)
+
+```ruby
+begin
+  # Get Domain
+  data, status_code, headers = api_instance.subaccount_domain_domain_id_get_with_http_info(domain_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_domain_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** | The unique ID of the domain to retrieve. |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[subAccountAuth](../README.md#subAccountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subaccount_domain_post
+
+> <Domain> subaccount_domain_post(create_domain_request)
+
+Create Domain
+
+Add a new domain using its `name`.
+
+### 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::DomainApi.new
+create_domain_request = Sendpost::CreateDomainRequest.new # CreateDomainRequest | 
+
+begin
+  # Create Domain
+  result = api_instance.subaccount_domain_post(create_domain_request)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_post: #{e}"
+end
+```
+
+#### Using the subaccount_domain_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> subaccount_domain_post_with_http_info(create_domain_request)
+
+```ruby
+begin
+  # Create Domain
+  data, status_code, headers = api_instance.subaccount_domain_post_with_http_info(create_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Sendpost::ApiError => e
+  puts "Error when calling DomainApi->subaccount_domain_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md) |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[subAccountAuth](../README.md#subAccountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DomainDkim.md

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

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

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

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

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

data/docs/DomainTrack.md

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

@@ -0,0 +1,18 @@
+# Sendpost::EIP
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_ip** | **String** | list of IP resources which are a part of the IP Pool containing public IP information. Note that the IPs specified in the IPPool should have been allocated in advance for your account |  |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::EIP.new(
+  public_ip: 52.13.11.14
+)
+```
+

data/docs/{From.md → EmailAddress.md}

@@ -1,4 +1,4 @@
-# Sendpost::From
+# Sendpost::EmailAddress
 
 ## Properties
 
@@ -12,9 +12,9 @@
 ```ruby
 require 'sendpost_ruby_sdk'
 
-instance = Sendpost::From.new(
-  email: gavin@hooli.com,
-  name: Gavin Belson
+instance = Sendpost::EmailAddress.new(
+  email: null,
+  name: null
 )
 ```
 

data/docs/EmailApi.md

@@ -4,33 +4,37 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**send_email**](EmailApi.md#send_email) | **POST** /subaccount/email/ |  |
-| [**send_email_with_template**](EmailApi.md#send_email_with_template) | **POST** /subaccount/email/template |  |
+| [**send_email**](EmailApi.md#send_email) | **POST** /subaccount/email/ | Send Email |
+| [**send_email_with_template**](EmailApi.md#send_email_with_template) | **POST** /subaccount/email/template | Send Email With Template |
 
 
 ## send_email
 
-> <Array<EmailResponse>> send_email(x_sub_account_api_key, opts)
+> <Array<EmailResponse>> send_email(email_message_object)
 
+Send Email
 
-
-Send Email To Contacts
+Use this API to send either a single or batch email.
 
 ### 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::EmailApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
-opts = {
-  email_message: Sendpost::EmailMessage.new # EmailMessage | Email message
-}
+email_message_object = Sendpost::EmailMessageObject.new # EmailMessageObject | Email message details
 
 begin
-  
-  result = api_instance.send_email(x_sub_account_api_key, opts)
+  # Send Email
+  result = api_instance.send_email(email_message_object)
   p result
 rescue Sendpost::ApiError => e
   puts "Error when calling EmailApi->send_email: #{e}"
@@ -41,12 +45,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_http_info(x_sub_account_api_key, opts)
+> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_http_info(email_message_object)
 
 ```ruby
 begin
-  
-  data, status_code, headers = api_instance.send_email_with_http_info(x_sub_account_api_key, opts)
+  # Send Email
+  data, status_code, headers = api_instance.send_email_with_http_info(email_message_object)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<EmailResponse>>
@@ -59,8 +63,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **email_message** | [**EmailMessage**](EmailMessage.md) | Email message | [optional] |
+| **email_message_object** | [**EmailMessageObject**](EmailMessageObject.md) | Email message details |  |
 
 ### Return type
 
@@ -68,7 +71,7 @@ end
 
 ### Authorization
 
-No authorization required
+[subAccountAuth](../README.md#subAccountAuth)
 
 ### HTTP request headers
 
@@ -78,27 +81,31 @@ No authorization required
 
 ## send_email_with_template
 
-> <Array<EmailResponse>> send_email_with_template(x_sub_account_api_key, opts)
+> <Array<EmailResponse>> send_email_with_template(email_message_with_template)
 
+Send Email With Template
 
-
-Send Email To Contacts With Template
+Use this API to send an email with a predefined template. This makes it easy to integrate transactional emails with minimal code. 
 
 ### 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::EmailApi.new
-x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
-opts = {
-  email_message: Sendpost::EmailMessage.new # EmailMessage | Email message
-}
+email_message_with_template = Sendpost::EmailMessageWithTemplate.new # EmailMessageWithTemplate | Email message details with template information
 
 begin
-  
-  result = api_instance.send_email_with_template(x_sub_account_api_key, opts)
+  # Send Email With Template
+  result = api_instance.send_email_with_template(email_message_with_template)
   p result
 rescue Sendpost::ApiError => e
   puts "Error when calling EmailApi->send_email_with_template: #{e}"
@@ -109,12 +116,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_template_with_http_info(x_sub_account_api_key, opts)
+> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_template_with_http_info(email_message_with_template)
 
 ```ruby
 begin
-  
-  data, status_code, headers = api_instance.send_email_with_template_with_http_info(x_sub_account_api_key, opts)
+  # Send Email With Template
+  data, status_code, headers = api_instance.send_email_with_template_with_http_info(email_message_with_template)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<EmailResponse>>
@@ -127,8 +134,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
-| **email_message** | [**EmailMessage**](EmailMessage.md) | Email message | [optional] |
+| **email_message_with_template** | [**EmailMessageWithTemplate**](EmailMessageWithTemplate.md) | Email message details with template information |  |
 
 ### Return type
 
@@ -136,7 +142,7 @@ end
 
 ### Authorization
 
-No authorization required
+[subAccountAuth](../README.md#subAccountAuth)
 
 ### HTTP request headers