ElasticEmail 4.0.23 → 4.0.25

data/docs/EmailTransactionalMessageData.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) |  |  |
-| **content** | [**EmailContent**](EmailContent.md) |  | [optional] |
+| **content** | [**EmailContent**](EmailContent.md) |  |  |
 | **options** | [**Options**](Options.md) |  | [optional] |
 
 ## Example

data/docs/EmailValidationResult.md

@@ -11,9 +11,9 @@
 | **disposable** | **Boolean** | Does the email have a temporary domain | [optional] |
 | **role** | **Boolean** | Is an email a role email (e.g. info@, noreply@ etc.) | [optional] |
 | **reason** | **String** | All detected issues | [optional] |
-| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
+| **date_added** | **Time** | Added date | [optional] |
 | **result** | [**EmailValidationStatus**](EmailValidationStatus.md) |  | [optional][default to 'None'] |
-| **predicted_score** | **Float** |  | [optional] |
+| **predicted_score** | **Float** | Predicted score | [optional] |
 | **predicted_status** | [**EmailPredictedValidationStatus**](EmailPredictedValidationStatus.md) |  | [optional][default to 'None'] |
 
 ## Example

data/docs/EmailsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**emails_by_msgid_view_get**](EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email |
+| [**emails_by_transactionid_status_get**](EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status |
 | [**emails_mergefile_post**](EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV |
 | [**emails_post**](EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails |
 | [**emails_transactional_post**](EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email |
@@ -81,13 +82,106 @@ end
 - **Accept**: application/json
 
 
+## emails_by_transactionid_status_get
+
+> <EmailJobStatus> emails_by_transactionid_status_get(transactionid, opts)
+
+Get Status
+
+Get status details of an email transaction. Required Access Level: ViewReports
+
+### 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::EmailsApi.new
+transactionid = 'transactionid_example' # String | Transaction identifier
+opts = {
+  show_failed: true, # Boolean | Include Bounced email addresses.
+  show_sent: true, # Boolean | Include Sent email addresses.
+  show_delivered: true, # Boolean | Include all delivered email addresses.
+  show_pending: true, # Boolean | Include Ready to send email addresses.
+  show_opened: true, # Boolean | Include Opened email addresses.
+  show_clicked: true, # Boolean | Include Clicked email addresses.
+  show_abuse: true, # Boolean | Include Reported as abuse email addresses.
+  show_unsubscribed: true, # Boolean | Include Unsubscribed email addresses.
+  show_errors: true, # Boolean | Include error messages for bounced emails.
+  show_message_ids: true # Boolean | Include all MessageIDs for this transaction
+}
+
+begin
+  # Get Status
+  result = api_instance.emails_by_transactionid_status_get(transactionid, opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_by_transactionid_status_get: #{e}"
+end
+```
+
+#### Using the emails_by_transactionid_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailJobStatus>, Integer, Hash)> emails_by_transactionid_status_get_with_http_info(transactionid, opts)
+
+```ruby
+begin
+  # Get Status
+  data, status_code, headers = api_instance.emails_by_transactionid_status_get_with_http_info(transactionid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailJobStatus>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_by_transactionid_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactionid** | **String** | Transaction identifier |  |
+| **show_failed** | **Boolean** | Include Bounced email addresses. | [optional][default to false] |
+| **show_sent** | **Boolean** | Include Sent email addresses. | [optional][default to false] |
+| **show_delivered** | **Boolean** | Include all delivered email addresses. | [optional][default to false] |
+| **show_pending** | **Boolean** | Include Ready to send email addresses. | [optional][default to false] |
+| **show_opened** | **Boolean** | Include Opened email addresses. | [optional][default to false] |
+| **show_clicked** | **Boolean** | Include Clicked email addresses. | [optional][default to false] |
+| **show_abuse** | **Boolean** | Include Reported as abuse email addresses. | [optional][default to false] |
+| **show_unsubscribed** | **Boolean** | Include Unsubscribed email addresses. | [optional][default to false] |
+| **show_errors** | **Boolean** | Include error messages for bounced emails. | [optional][default to false] |
+| **show_message_ids** | **Boolean** | Include all MessageIDs for this transaction | [optional][default to false] |
+
+### Return type
+
+[**EmailJobStatus**](EmailJobStatus.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## emails_mergefile_post
 
 > <EmailSend> emails_mergefile_post(merge_email_payload)
 
 Send Bulk Emails CSV
 
-Send bulk merge email. Required Access Level: SendHttp
+Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.                           Example CSV:                           email, firstname, lastname              test1@gmail.com, michael, smith              test2@gmail.com, janet, smith                           Merge file must not be empty. Required Access Level: SendHttp
 
 ### Examples
 
@@ -103,7 +197,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'})}) # MergeEmailPayload | Email data
+merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # MergeEmailPayload | Email data
 
 begin
   # Send Bulk Emails CSV
@@ -174,7 +268,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})]}) # EmailMessageData | Email data
+email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})], content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailMessageData | Email data
 
 begin
   # Send Bulk Emails
@@ -245,7 +339,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']})}) # EmailTransactionalMessageData | Email data
+email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailTransactionalMessageData | Email data
 
 begin
   # Send Transactional Email

data/docs/EmailsPayload.md

@@ -14,7 +14,7 @@ require 'ElasticEmail'
 
 instance = ElasticEmail::EmailsPayload.new(
   rule: null,
-  emails: [ "john.doe@sample.com" ]
+  emails: ["john.doe@sample.com"]
 )
 ```
 

data/docs/ListPayload.md

@@ -16,7 +16,7 @@ require 'ElasticEmail'
 instance = ElasticEmail::ListPayload.new(
   list_name: My List 1,
   allow_unsubscribe: false,
-  emails: null
+  emails: ["john.doe@sample.com"]
 )
 ```
 

data/docs/ListsApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**lists_by_listname_contacts_get**](ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List |
 | [**lists_by_name_contacts_post**](ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List |
 | [**lists_by_name_contacts_remove_post**](ListsApi.md#lists_by_name_contacts_remove_post) | **POST** /lists/{name}/contacts/remove | Remove Contacts from List |
 | [**lists_by_name_delete**](ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List |
@@ -13,6 +14,83 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 | [**lists_post**](ListsApi.md#lists_post) | **POST** /lists | Add List |
 
 
+## lists_by_listname_contacts_get
+
+> <Array<Contact>> lists_by_listname_contacts_get(listname, opts)
+
+Load Contacts in List
+
+Returns a list of contacts. Required Access Level: ViewContacts
+
+### 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::ListsApi.new
+listname = 'My List 1' # String | Name of your list.
+opts = {
+  limit: 100, # Integer | Maximum number of returned items.
+  offset: 20 # Integer | How many items should be returned ahead.
+}
+
+begin
+  # Load Contacts in List
+  result = api_instance.lists_by_listname_contacts_get(listname, opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ListsApi->lists_by_listname_contacts_get: #{e}"
+end
+```
+
+#### Using the lists_by_listname_contacts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Contact>>, Integer, Hash)> lists_by_listname_contacts_get_with_http_info(listname, opts)
+
+```ruby
+begin
+  # Load Contacts in List
+  data, status_code, headers = api_instance.lists_by_listname_contacts_get_with_http_info(listname, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Contact>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ListsApi->lists_by_listname_contacts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **listname** | **String** | Name of your list. |  |
+| **limit** | **Integer** | Maximum number of returned items. | [optional] |
+| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
+
+### Return type
+
+[**Array&lt;Contact&gt;**](Contact.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## lists_by_name_contacts_post
 
 > <ContactsList> lists_by_name_contacts_post(name, emails_payload)

data/docs/MergeEmailPayload.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **merge_file** | [**MessageAttachment**](MessageAttachment.md) |  |  |
-| **content** | [**EmailContent**](EmailContent.md) |  | [optional] |
+| **content** | [**EmailContent**](EmailContent.md) |  |  |
 | **options** | [**Options**](Options.md) |  | [optional] |
 
 ## Example

data/docs/{ContactHistEventType.md → MessageCategoryEnum.md}

@@ -1,4 +1,4 @@
-# ElasticEmail::ContactHistEventType
+# ElasticEmail::MessageCategoryEnum
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'ElasticEmail'
 
-instance = ElasticEmail::ContactHistEventType.new()
+instance = ElasticEmail::MessageCategoryEnum.new()
 ```
 

data/docs/TrackingType.md

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

data/docs/TrackingValidationStatus.md

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

data/lib/ElasticEmail/api/campaigns_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 4.0.0
 Contact: support@elasticemail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.3.0
+Generator version: 7.5.0
 
 =end
 
@@ -143,6 +143,67 @@ module ElasticEmail
       return data, status_code, headers
     end
 
+    # Pause Campaign
+    # Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
+    # @param name [String] Name of Campaign to pause
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def campaigns_by_name_pause_put(name, opts = {})
+      campaigns_by_name_pause_put_with_http_info(name, opts)
+      nil
+    end
+
+    # Pause Campaign
+    # Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
+    # @param name [String] Name of Campaign to pause
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def campaigns_by_name_pause_put_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_by_name_pause_put ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling CampaignsApi.campaigns_by_name_pause_put"
+      end
+      # resource path
+      local_var_path = '/campaigns/{name}/pause'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_by_name_pause_put",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_by_name_pause_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update Campaign
     # Updates a previously added campaign.  Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
     # @param name [String] Name of Campaign to update

data/lib/ElasticEmail/api/contacts_api.rb

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