ElasticEmail 4.0.24 → 4.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf1c9217625cef16555bee235d90e20d39ba360d535db2e13f2367eda9ddca0
-  data.tar.gz: f821031e0e7a06077f858706c3ee3fbe3baa5087ca4c20f761bbdb902f8b7185
+  metadata.gz: 2970493e028687e825b1d8cea502663debe9d3e019a8f44b6ca46ff6ee37588d
+  data.tar.gz: 6e5b85138658749b1da90b93852c1368701d3af71a66a290f8c1c14af735921a
 SHA512:
-  metadata.gz: 5118ea476a962dd3e8515c753b76878a116994fabd7ee1b982e4be11701701829cbcb2d30c22efaaa0458f94a0a0ee56ba6b4519e9e8e2dbeb1de82ec19d649d
-  data.tar.gz: 677db984d6484d85595666ddcb720f1d317ace9410bf121346fc135de7bb0af153f62ae1718a3783b21e0b635a2fca76ac4dbcdcbd999b9a9b0a9d596f18eefc
+  metadata.gz: 58959be65abc1fc66c366e8412f8a60f4318f9e1a9455fb4c372b66d84e65c5a7cb8cb2028b39745c6c243242d64ac6bcb991283b923aa5d4d35f2fc5d0e9557
+  data.tar.gz: 6bd1de9c575690ff4e531854e31c5e8c2f8160a4e6321a3cdfb0905d37ca21875b97ffec060b05987734c890bdf9705820c4bcd52ccc36e5faa240d9ac17a92d

data/ElasticEmail.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 4.0.0
 Contact: support@elasticemail.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.5.0
 
 =end
 

data/README.md

@@ -15,8 +15,8 @@ Downloadable library clients can be found in our Github repository [here](https:
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 4.0.0
-- Package version: 4.0.24
-- Generator version: 7.7.0
+- Package version: 4.0.26
+- Generator version: 7.5.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -32,16 +32,16 @@ gem build ElasticEmail.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ElasticEmail-4.0.24.gem
+gem install ./ElasticEmail-4.0.26.gem
 ```
 
-(for development, run `gem install --dev ./ElasticEmail-4.0.24.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ElasticEmail-4.0.26.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ElasticEmail', '~> 4.0.24'
+    gem 'ElasticEmail', '~> 4.0.26'
 
 ### Install from Git
 
@@ -93,6 +93,7 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *ElasticEmail::CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign
 *ElasticEmail::CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign
+*ElasticEmail::CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign
 *ElasticEmail::CampaignsApi* | [**campaigns_by_name_put**](docs/CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign
 *ElasticEmail::CampaignsApi* | [**campaigns_get**](docs/CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns
 *ElasticEmail::CampaignsApi* | [**campaigns_post**](docs/CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign
@@ -105,6 +106,14 @@ Class | Method | HTTP request | Description
 *ElasticEmail::ContactsApi* | [**contacts_get**](docs/ContactsApi.md#contacts_get) | **GET** /contacts | Load Contacts
 *ElasticEmail::ContactsApi* | [**contacts_import_post**](docs/ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts
 *ElasticEmail::ContactsApi* | [**contacts_post**](docs/ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact
+*ElasticEmail::DomainsApi* | [**domains_by_domain_delete**](docs/DomainsApi.md#domains_by_domain_delete) | **DELETE** /domains/{domain} | Delete Domain
+*ElasticEmail::DomainsApi* | [**domains_by_domain_get**](docs/DomainsApi.md#domains_by_domain_get) | **GET** /domains/{domain} | Load Domain
+*ElasticEmail::DomainsApi* | [**domains_by_domain_put**](docs/DomainsApi.md#domains_by_domain_put) | **PUT** /domains/{domain} | Update Domain
+*ElasticEmail::DomainsApi* | [**domains_by_domain_restricted_get**](docs/DomainsApi.md#domains_by_domain_restricted_get) | **GET** /domains/{domain}/restricted | Check for domain restriction
+*ElasticEmail::DomainsApi* | [**domains_by_domain_verification_put**](docs/DomainsApi.md#domains_by_domain_verification_put) | **PUT** /domains/{domain}/verification | Verify Domain
+*ElasticEmail::DomainsApi* | [**domains_by_email_default_patch**](docs/DomainsApi.md#domains_by_email_default_patch) | **PATCH** /domains/{email}/default | Set Default
+*ElasticEmail::DomainsApi* | [**domains_get**](docs/DomainsApi.md#domains_get) | **GET** /domains | Load Domains
+*ElasticEmail::DomainsApi* | [**domains_post**](docs/DomainsApi.md#domains_post) | **POST** /domains | Add Domain
 *ElasticEmail::EmailsApi* | [**emails_by_msgid_view_get**](docs/EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email
 *ElasticEmail::EmailsApi* | [**emails_by_transactionid_status_get**](docs/EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status
 *ElasticEmail::EmailsApi* | [**emails_mergefile_post**](docs/EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV
@@ -204,6 +213,7 @@ Class | Method | HTTP request | Description
  - [ElasticEmail::CampaignRecipient](docs/CampaignRecipient.md)
  - [ElasticEmail::CampaignStatus](docs/CampaignStatus.md)
  - [ElasticEmail::CampaignTemplate](docs/CampaignTemplate.md)
+ - [ElasticEmail::CertificateValidationStatus](docs/CertificateValidationStatus.md)
  - [ElasticEmail::ChannelLogStatusSummary](docs/ChannelLogStatusSummary.md)
  - [ElasticEmail::CompressionFormat](docs/CompressionFormat.md)
  - [ElasticEmail::ConsentData](docs/ConsentData.md)
@@ -216,6 +226,11 @@ Class | Method | HTTP request | Description
  - [ElasticEmail::ContactUpdatePayload](docs/ContactUpdatePayload.md)
  - [ElasticEmail::ContactsList](docs/ContactsList.md)
  - [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)
+ - [ElasticEmail::DomainData](docs/DomainData.md)
+ - [ElasticEmail::DomainDetail](docs/DomainDetail.md)
+ - [ElasticEmail::DomainOwner](docs/DomainOwner.md)
+ - [ElasticEmail::DomainPayload](docs/DomainPayload.md)
+ - [ElasticEmail::DomainUpdatePayload](docs/DomainUpdatePayload.md)
  - [ElasticEmail::EmailContent](docs/EmailContent.md)
  - [ElasticEmail::EmailData](docs/EmailData.md)
  - [ElasticEmail::EmailJobFailedStatus](docs/EmailJobFailedStatus.md)
@@ -250,6 +265,7 @@ Class | Method | HTTP request | Description
  - [ElasticEmail::MergeEmailPayload](docs/MergeEmailPayload.md)
  - [ElasticEmail::MessageAttachment](docs/MessageAttachment.md)
  - [ElasticEmail::MessageCategory](docs/MessageCategory.md)
+ - [ElasticEmail::MessageCategoryEnum](docs/MessageCategoryEnum.md)
  - [ElasticEmail::NewApiKey](docs/NewApiKey.md)
  - [ElasticEmail::NewSmtpCredentials](docs/NewSmtpCredentials.md)
  - [ElasticEmail::Options](docs/Options.md)
@@ -273,6 +289,8 @@ Class | Method | HTTP request | Description
  - [ElasticEmail::TemplatePayload](docs/TemplatePayload.md)
  - [ElasticEmail::TemplateScope](docs/TemplateScope.md)
  - [ElasticEmail::TemplateType](docs/TemplateType.md)
+ - [ElasticEmail::TrackingType](docs/TrackingType.md)
+ - [ElasticEmail::TrackingValidationStatus](docs/TrackingValidationStatus.md)
  - [ElasticEmail::TransactionalRecipient](docs/TransactionalRecipient.md)
  - [ElasticEmail::Utm](docs/Utm.md)
  - [ElasticEmail::VerificationFileResult](docs/VerificationFileResult.md)

data/VERSION

@@ -1 +1 @@
-4.0.24
+4.0.26

data/docs/CampaignsApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 | ------ | ------------ | ----------- |
 | [**campaigns_by_name_delete**](CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign |
 | [**campaigns_by_name_get**](CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign |
+| [**campaigns_by_name_pause_put**](CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign |
 | [**campaigns_by_name_put**](CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign |
 | [**campaigns_get**](CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns |
 | [**campaigns_post**](CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign |
@@ -152,6 +153,76 @@ end
 - **Accept**: application/json
 
 
+## campaigns_by_name_pause_put
+
+> campaigns_by_name_pause_put(name)
+
+Pause Campaign
+
+Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['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['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::CampaignsApi.new
+name = 'name_example' # String | Name of Campaign to pause
+
+begin
+  # Pause Campaign
+  api_instance.campaigns_by_name_pause_put(name)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_pause_put: #{e}"
+end
+```
+
+#### Using the campaigns_by_name_pause_put_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> campaigns_by_name_pause_put_with_http_info(name)
+
+```ruby
+begin
+  # Pause Campaign
+  data, status_code, headers = api_instance.campaigns_by_name_pause_put_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_pause_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Campaign to pause |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## campaigns_by_name_put
 
 > <Campaign> campaigns_by_name_put(name, campaign)

data/docs/CertificateValidationStatus.md

@@ -0,0 +1,15 @@
+# ElasticEmail::CertificateValidationStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::CertificateValidationStatus.new()
+```
+

data/docs/DomainData.md

@@ -0,0 +1,54 @@
+# ElasticEmail::DomainData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **validation_log** | **String** | Domain validation results - when domain has been running through validation process | [optional] |
+| **domain** | **String** | Name of selected domain. | [optional] |
+| **default_domain** | **Boolean** | True, if domain is used as default. Otherwise, false, | [optional] |
+| **spf** | **Boolean** | True, if SPF record is verified | [optional] |
+| **dkim** | **Boolean** | True, if DKIM record is verified | [optional] |
+| **mx** | **Boolean** | True, if MX record is verified | [optional] |
+| **dmarc** | **Boolean** |  | [optional] |
+| **is_rewrite_domain_valid** | **Boolean** | True, if tracking CNAME record is verified | [optional] |
+| **verify** | **Boolean** | True, if DKIM, SPF, or tracking are still to be verified | [optional] |
+| **type** | [**TrackingType**](TrackingType.md) |  | [optional][default to 'None'] |
+| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) |  | [optional][default to 'Validated'] |
+| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) |  | [optional][default to 'ErrorOccured'] |
+| **certificate_validation_error** | **String** |  | [optional] |
+| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) |  | [optional][default to 'None'] |
+| **verp** | **Boolean** |  | [optional] |
+| **custom_bounces_domain** | **String** |  | [optional] |
+| **is_custom_bounces_domain_default** | **Boolean** |  | [optional] |
+| **is_marked_for_deletion** | **Boolean** |  | [optional] |
+| **ownership** | [**DomainOwner**](DomainOwner.md) |  | [optional][default to 'Current'] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::DomainData.new(
+  validation_log: null,
+  domain: example.com,
+  default_domain: null,
+  spf: true,
+  dkim: true,
+  mx: true,
+  dmarc: null,
+  is_rewrite_domain_valid: true,
+  verify: true,
+  type: null,
+  tracking_status: null,
+  certificate_status: null,
+  certificate_validation_error: null,
+  tracking_type_user_request: null,
+  verp: null,
+  custom_bounces_domain: null,
+  is_custom_bounces_domain_default: null,
+  is_marked_for_deletion: null,
+  ownership: null
+)
+```
+

data/docs/DomainDetail.md

@@ -0,0 +1,52 @@
+# ElasticEmail::DomainDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | Name of selected domain. | [optional] |
+| **default_domain** | **Boolean** | True, if domain is used as default. Otherwise, false, | [optional] |
+| **spf** | **Boolean** | True, if SPF record is verified | [optional] |
+| **dkim** | **Boolean** | True, if DKIM record is verified | [optional] |
+| **mx** | **Boolean** | True, if MX record is verified | [optional] |
+| **dmarc** | **Boolean** |  | [optional] |
+| **is_rewrite_domain_valid** | **Boolean** | True, if tracking CNAME record is verified | [optional] |
+| **verify** | **Boolean** | True, if DKIM, SPF, or tracking are still to be verified | [optional] |
+| **type** | [**TrackingType**](TrackingType.md) |  | [optional][default to 'None'] |
+| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) |  | [optional][default to 'Validated'] |
+| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) |  | [optional][default to 'ErrorOccured'] |
+| **certificate_validation_error** | **String** |  | [optional] |
+| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) |  | [optional][default to 'None'] |
+| **verp** | **Boolean** |  | [optional] |
+| **custom_bounces_domain** | **String** |  | [optional] |
+| **is_custom_bounces_domain_default** | **Boolean** |  | [optional] |
+| **is_marked_for_deletion** | **Boolean** |  | [optional] |
+| **ownership** | [**DomainOwner**](DomainOwner.md) |  | [optional][default to 'Current'] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::DomainDetail.new(
+  domain: example.com,
+  default_domain: null,
+  spf: true,
+  dkim: true,
+  mx: true,
+  dmarc: null,
+  is_rewrite_domain_valid: true,
+  verify: true,
+  type: null,
+  tracking_status: null,
+  certificate_status: null,
+  certificate_validation_error: null,
+  tracking_type_user_request: null,
+  verp: null,
+  custom_bounces_domain: null,
+  is_custom_bounces_domain_default: null,
+  is_marked_for_deletion: null,
+  ownership: null
+)
+```
+

data/docs/DomainOwner.md

@@ -0,0 +1,15 @@
+# ElasticEmail::DomainOwner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::DomainOwner.new()
+```
+

data/docs/DomainPayload.md

@@ -0,0 +1,20 @@
+# ElasticEmail::DomainPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | Name of selected domain. | [optional] |
+| **set_as_default** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::DomainPayload.new(
+  domain: example.com,
+  set_as_default: null
+)
+```
+

data/docs/DomainUpdatePayload.md

@@ -0,0 +1,24 @@
+# ElasticEmail::DomainUpdatePayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) |  | [optional][default to 'ErrorOccured'] |
+| **verp** | **Boolean** |  | [optional] |
+| **custom_bounces_domain** | **String** |  | [optional] |
+| **is_custom_bounces_domain_default** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::DomainUpdatePayload.new(
+  certificate_status: null,
+  verp: null,
+  custom_bounces_domain: null,
+  is_custom_bounces_domain_default: null
+)
+```
+