ElasticEmail 4.0.27 → 4.0.29

data/docs/WebhookApi.md

@@ -0,0 +1,372 @@
+# ElasticEmail::WebhookApi
+
+All URIs are relative to *https://api.elasticemail.com/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**webhook_by_publicid_delete**](WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook |
+| [**webhook_by_publicid_get**](WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook |
+| [**webhook_by_publicid_put**](WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook |
+| [**webhook_get**](WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks |
+| [**webhook_post**](WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook |
+
+
+## webhook_by_publicid_delete
+
+> webhook_by_publicid_delete(publicid)
+
+Delete Webhook
+
+Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-ElasticEmail-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-ElasticEmail-ApiKey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+publicid = 'publicid_example' # String | 
+
+begin
+  # Delete Webhook
+  api_instance.webhook_by_publicid_delete(publicid)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_delete: #{e}"
+end
+```
+
+#### Using the webhook_by_publicid_delete_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)> webhook_by_publicid_delete_with_http_info(publicid)
+
+```ruby
+begin
+  # Delete Webhook
+  data, status_code, headers = api_instance.webhook_by_publicid_delete_with_http_info(publicid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **publicid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## webhook_by_publicid_get
+
+> <Webhook> webhook_by_publicid_get(publicid)
+
+Load Webhook
+
+Load notifications webhook details. Required Access Level: ViewWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-ElasticEmail-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-ElasticEmail-ApiKey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+publicid = 'publicid_example' # String | 
+
+begin
+  # Load Webhook
+  result = api_instance.webhook_by_publicid_get(publicid)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_get: #{e}"
+end
+```
+
+#### Using the webhook_by_publicid_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> webhook_by_publicid_get_with_http_info(publicid)
+
+```ruby
+begin
+  # Load Webhook
+  data, status_code, headers = api_instance.webhook_by_publicid_get_with_http_info(publicid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **publicid** | **String** |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhook_by_publicid_put
+
+> <Webhook> webhook_by_publicid_put(publicid, webhook_update_payload)
+
+Update Webhook
+
+Update notification webhook. Required Access Level: ModifyWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-ElasticEmail-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-ElasticEmail-ApiKey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+publicid = 'publicid_example' # String | 
+webhook_update_payload = ElasticEmail::WebhookUpdatePayload.new # WebhookUpdatePayload | 
+
+begin
+  # Update Webhook
+  result = api_instance.webhook_by_publicid_put(publicid, webhook_update_payload)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_put: #{e}"
+end
+```
+
+#### Using the webhook_by_publicid_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> webhook_by_publicid_put_with_http_info(publicid, webhook_update_payload)
+
+```ruby
+begin
+  # Update Webhook
+  data, status_code, headers = api_instance.webhook_by_publicid_put_with_http_info(publicid, webhook_update_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **publicid** | **String** |  |  |
+| **webhook_update_payload** | [**WebhookUpdatePayload**](WebhookUpdatePayload.md) |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## webhook_get
+
+> <Array<Webhook>> webhook_get(opts)
+
+Load Webhooks
+
+Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-ElasticEmail-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-ElasticEmail-ApiKey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+opts = {
+  limit: 100, # Integer | Maximum number of returned items.
+  offset: 20 # Integer | How many items should be returned ahead.
+}
+
+begin
+  # Load Webhooks
+  result = api_instance.webhook_get(opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_get: #{e}"
+end
+```
+
+#### Using the webhook_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Webhook>>, Integer, Hash)> webhook_get_with_http_info(opts)
+
+```ruby
+begin
+  # Load Webhooks
+  data, status_code, headers = api_instance.webhook_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Webhook>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of returned items. | [optional] |
+| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
+
+### Return type
+
+[**Array&lt;Webhook&gt;**](Webhook.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhook_post
+
+> <Webhook> webhook_post(webhook_create_payload)
+
+Add Webhook
+
+Add a notification webhook. Required Access Level: ModifyWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-ElasticEmail-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-ElasticEmail-ApiKey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+webhook_create_payload = ElasticEmail::WebhookCreatePayload.new({name: 'attachment.txt', url: 'http://address.for.notification.com'}) # WebhookCreatePayload | 
+
+begin
+  # Add Webhook
+  result = api_instance.webhook_post(webhook_create_payload)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_post: #{e}"
+end
+```
+
+#### Using the webhook_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> webhook_post_with_http_info(webhook_create_payload)
+
+```ruby
+begin
+  # Add Webhook
+  data, status_code, headers = api_instance.webhook_post_with_http_info(webhook_create_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_create_payload** | [**WebhookCreatePayload**](WebhookCreatePayload.md) |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WebhookCreatePayload.md

@@ -0,0 +1,34 @@
+# ElasticEmail::WebhookCreatePayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Filename |  |
+| **url** | **String** | URL of notification. |  |
+| **notify_once_per_email** | **Boolean** |  | [optional] |
+| **notification_for_sent** | **Boolean** |  | [optional] |
+| **notification_for_opened** | **Boolean** |  | [optional] |
+| **notification_for_clicked** | **Boolean** |  | [optional] |
+| **notification_for_unsubscribed** | **Boolean** |  | [optional] |
+| **notification_for_abuse_report** | **Boolean** |  | [optional] |
+| **notification_for_error** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::WebhookCreatePayload.new(
+  name: attachment.txt,
+  url: http://address.for.notification.com,
+  notify_once_per_email: null,
+  notification_for_sent: null,
+  notification_for_opened: null,
+  notification_for_clicked: null,
+  notification_for_unsubscribed: null,
+  notification_for_abuse_report: null,
+  notification_for_error: null
+)
+```
+

data/docs/WebhookUpdatePayload.md

@@ -0,0 +1,36 @@
+# ElasticEmail::WebhookUpdatePayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Filename | [optional] |
+| **url** | **String** | URL of notification. | [optional] |
+| **notify_once_per_email** | **Boolean** |  | [optional] |
+| **notification_for_sent** | **Boolean** |  | [optional] |
+| **notification_for_opened** | **Boolean** |  | [optional] |
+| **notification_for_clicked** | **Boolean** |  | [optional] |
+| **notification_for_unsubscribed** | **Boolean** |  | [optional] |
+| **notification_for_abuse_report** | **Boolean** |  | [optional] |
+| **notification_for_error** | **Boolean** |  | [optional] |
+| **is_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::WebhookUpdatePayload.new(
+  name: attachment.txt,
+  url: http://address.for.notification.com,
+  notify_once_per_email: null,
+  notification_for_sent: null,
+  notification_for_opened: null,
+  notification_for_clicked: null,
+  notification_for_unsubscribed: null,
+  notification_for_abuse_report: null,
+  notification_for_error: null,
+  is_enabled: null
+)
+```
+

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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 
@@ -19,6 +19,74 @@ module ElasticEmail
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Trigger Automation for Contact
+    # Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
+    # @param name [String] 
+    # @param contact_email [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def campaigns_automation_by_name_trigger_post(name, contact_email, opts = {})
+      campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email, opts)
+      nil
+    end
+
+    # Trigger Automation for Contact
+    # Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
+    # @param name [String] 
+    # @param contact_email [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_automation_by_name_trigger_post ...'
+      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_automation_by_name_trigger_post"
+      end
+      # verify the required parameter 'contact_email' is set
+      if @api_client.config.client_side_validation && contact_email.nil?
+        fail ArgumentError, "Missing the required parameter 'contact_email' when calling CampaignsApi.campaigns_automation_by_name_trigger_post"
+      end
+      # resource path
+      local_var_path = '/campaigns/automation/{name}/trigger'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'contactEmail'] = contact_email
+
+      # 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_automation_by_name_trigger_post",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_automation_by_name_trigger_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete Campaign
     # Delete the specific campaign.  This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
     # @param name [String] Name of Campaign to delete

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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/domains_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/emails_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/events_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/files_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/inbound_route_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/lists_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/security_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 
@@ -87,7 +87,7 @@ module ElasticEmail
     # Load your existing ApiKey info. Required Access Level: ViewAccessTokens
     # @param name [String] Name of the ApiKey
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded
+    # @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
     # @return [ApiKey]
     def security_apikeys_by_name_get(name, opts = {})
       data, _status_code, _headers = security_apikeys_by_name_get_with_http_info(name, opts)
@@ -98,7 +98,7 @@ module ElasticEmail
     # Load your existing ApiKey info. Required Access Level: ViewAccessTokens
     # @param name [String] Name of the ApiKey
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded
+    # @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
     # @return [Array<(ApiKey, Integer, Hash)>] ApiKey data, response status code and response headers
     def security_apikeys_by_name_get_with_http_info(name, opts = {})
       if @api_client.config.debugging
@@ -226,7 +226,7 @@ module ElasticEmail
     # List ApiKeys
     # List all your existing ApiKeys. Required Access Level: ViewAccessTokens
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded
+    # @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
     # @return [Array<ApiKey>]
     def security_apikeys_get(opts = {})
       data, _status_code, _headers = security_apikeys_get_with_http_info(opts)
@@ -236,7 +236,7 @@ module ElasticEmail
     # List ApiKeys
     # List all your existing ApiKeys. Required Access Level: ViewAccessTokens
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded
+    # @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
     # @return [Array<(Array<ApiKey>, Integer, Hash)>] Array<ApiKey> data, response status code and response headers
     def security_apikeys_get_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/ElasticEmail/api/segments_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end
 

data/lib/ElasticEmail/api/statistics_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
-Generator version: 7.11.0
+Generator version: 7.14.0
 
 =end