ElasticEmail 4.0.11 → 4.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a579af43327bba161d78355869f905865a8734be32fdeca142e918faf7fee346
-  data.tar.gz: c11d317b8d4cfff7253a28e8a77441766e323af98a78ab2744569a6f7682548a
+  metadata.gz: cdbda054427188f07760c2f3eb6e7e27892471e66338755b302ee8dbd2056e20
+  data.tar.gz: c21695fc7bf759627ba2b5e89145a1bebff7078f365f8b7dc2ab685a0b7c0c89
 SHA512:
-  metadata.gz: fa45cae0270fd62f943254ea6621d0cf3c9a8542ea232c1349b2d1a7fc41778ebae11ce5acef6d3810e716afda70f70a7ff4c8d0d6d9bcb7e6e141f98d1fae12
-  data.tar.gz: b05ac0e0f71d82a1191807819c06e0d8a8c648c97a7f95f5840377d0cd8c4e1a199b9286ede41234dc858d6b6cca1966126527a35746937a8002ed702458d437
+  metadata.gz: 2eb8cac315b968d1147e4defb925bd374ac893950b866cb2d054be050dd8ef9dd2512a71fc5ca5f7515b764bea9e8c61b0672df29061a6beaf1d174fd201bedc
+  data.tar.gz: 40389b8a3b8d520edd41686ad54cf9ec8279bbfffad13886162f0fc5a869461c3ddda6e18791ae532c95b1418b509293650716c71f78e28cfe7d77d238a8b3fd

data/README.md

@@ -15,7 +15,7 @@ Downloadable library clients can be found in our Github repository <a target=\"_
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 4.0.0
-- Package version: 4.0.11
+- Package version: 4.0.12
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -31,16 +31,16 @@ gem build ElasticEmail.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ElasticEmail-4.0.11.gem
+gem install ./ElasticEmail-4.0.12.gem
 ```
 
-(for development, run `gem install --dev ./ElasticEmail-4.0.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ElasticEmail-4.0.12.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.11'
+    gem 'ElasticEmail', '~> 4.0.12'
 
 ### Install from Git
 
@@ -183,8 +183,9 @@ Class | Method | HTTP request | Description
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_delete**](docs/VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_download_get**](docs/VerificationsApi.md#verifications_files_by_id_result_download_get) | **GET** /verifications/files/{id}/result/download | Download File Verification Result
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_get**](docs/VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result
-*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Verify From File
-*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Simple Files Verification Results
+*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_verification_post**](docs/VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification
+*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails
+*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results
 *ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results
 
 

data/VERSION

@@ -1 +1 @@
-4.0.11
+4.0.12

data/docs/MessageAttachment.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **binary_content** | **String** |  | [optional] |
-| **name** | **String** | Filename | [optional] |
-| **content_type** | **String** |  | [optional] |
+| **binary_content** | **String** | File's content as byte array (or a Base64 string) | [optional] |
+| **name** | **String** | Display name of the file | [optional] |
+| **content_type** | **String** | MIME content type | [optional] |
 
 ## Example
 
@@ -15,7 +15,7 @@ require 'ElasticEmail'
 
 instance = ElasticEmail::MessageAttachment.new(
   binary_content: null,
-  name: attachment.txt,
+  name: null,
   content_type: null
 )
 ```

data/docs/VerificationsApi.md

@@ -10,8 +10,9 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 | [**verifications_files_by_id_delete**](VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result |
 | [**verifications_files_by_id_result_download_get**](VerificationsApi.md#verifications_files_by_id_result_download_get) | **GET** /verifications/files/{id}/result/download | Download File Verification Result |
 | [**verifications_files_by_id_result_get**](VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result |
-| [**verifications_files_post**](VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Verify From File |
-| [**verifications_files_result_get**](VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Simple Files Verification Results |
+| [**verifications_files_by_id_verification_post**](VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification |
+| [**verifications_files_post**](VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails |
+| [**verifications_files_result_get**](VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results |
 | [**verifications_get**](VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results |
 
 
@@ -445,13 +446,83 @@ end
 - **Accept**: application/json
 
 
+## verifications_files_by_id_verification_post
+
+> verifications_files_by_id_verification_post(id)
+
+Start verification
+
+Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails
+
+### 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::VerificationsApi.new
+id = 'id_example' # String | File ID to start verification
+
+begin
+  # Start verification
+  api_instance.verifications_files_by_id_verification_post(id)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling VerificationsApi->verifications_files_by_id_verification_post: #{e}"
+end
+```
+
+#### Using the verifications_files_by_id_verification_post_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)> verifications_files_by_id_verification_post_with_http_info(id)
+
+```ruby
+begin
+  # Start verification
+  data, status_code, headers = api_instance.verifications_files_by_id_verification_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling VerificationsApi->verifications_files_by_id_verification_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | File ID to start verification |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## verifications_files_post
 
 > <VerificationFileResult> verifications_files_post(opts)
 
-Verify From File
+Upload File with Emails
 
-Uploads a CSV file with list of emails to verify. An 'email' column is required. Required Access Level: VerifyEmails
+Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails
 
 ### Examples
 
@@ -472,7 +543,7 @@ opts = {
 }
 
 begin
-  # Verify From File
+  # Upload File with Emails
   result = api_instance.verifications_files_post(opts)
   p result
 rescue ElasticEmail::ApiError => e
@@ -488,7 +559,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Verify From File
+  # Upload File with Emails
   data, status_code, headers = api_instance.verifications_files_post_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -522,7 +593,7 @@ end
 
 > <Array<VerificationFileResult>> verifications_files_result_get
 
-Get Simple Files Verification Results
+Get Files Verification Results
 
 Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
 
@@ -542,7 +613,7 @@ end
 api_instance = ElasticEmail::VerificationsApi.new
 
 begin
-  # Get Simple Files Verification Results
+  # Get Files Verification Results
   result = api_instance.verifications_files_result_get
   p result
 rescue ElasticEmail::ApiError => e
@@ -558,7 +629,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get Simple Files Verification Results
+  # Get Files Verification Results
   data, status_code, headers = api_instance.verifications_files_result_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }

data/lib/ElasticEmail/api/verifications_api.rb

@@ -399,8 +399,69 @@ module ElasticEmail
       return data, status_code, headers
     end
 
-    # Verify From File
-    # Uploads a CSV file with list of emails to verify. An 'email' column is required. Required Access Level: VerifyEmails
+    # Start verification
+    # Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails
+    # @param id [String] File ID to start verification
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def verifications_files_by_id_verification_post(id, opts = {})
+      verifications_files_by_id_verification_post_with_http_info(id, opts)
+      nil
+    end
+
+    # Start verification
+    # Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails
+    # @param id [String] File ID to start verification
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def verifications_files_by_id_verification_post_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VerificationsApi.verifications_files_by_id_verification_post ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VerificationsApi.verifications_files_by_id_verification_post"
+      end
+      # resource path
+      local_var_path = '/verifications/files/{id}/verification'.sub('{' + 'id' + '}', CGI.escape(id.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 => :"VerificationsApi.verifications_files_by_id_verification_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: VerificationsApi#verifications_files_by_id_verification_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload File with Emails
+    # Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails
     # @param [Hash] opts the optional parameters
     # @option opts [File] :file 
     # @return [VerificationFileResult]
@@ -409,8 +470,8 @@ module ElasticEmail
       data
     end
 
-    # Verify From File
-    # Uploads a CSV file with list of emails to verify. An &#39;email&#39; column is required. Required Access Level: VerifyEmails
+    # Upload File with Emails
+    # Uploads a CSV file with list of emails that can then be triggered for verification. An &#39;email&#39; column is required. Required Access Level: VerifyEmails
     # @param [Hash] opts the optional parameters
     # @option opts [File] :file 
     # @return [Array<(VerificationFileResult, Integer, Hash)>] VerificationFileResult data, response status code and response headers
@@ -461,7 +522,7 @@ module ElasticEmail
       return data, status_code, headers
     end
 
-    # Get Simple Files Verification Results
+    # Get Files Verification Results
     # Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
     # @param [Hash] opts the optional parameters
     # @return [Array<VerificationFileResult>]
@@ -470,7 +531,7 @@ module ElasticEmail
       data
     end
 
-    # Get Simple Files Verification Results
+    # Get Files Verification Results
     # Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<VerificationFileResult>, Integer, Hash)>] Array<VerificationFileResult> data, response status code and response headers

data/lib/ElasticEmail/models/message_attachment.rb

@@ -15,11 +15,13 @@ require 'time'
 
 module ElasticEmail
   class MessageAttachment
+    # File's content as byte array (or a Base64 string)
     attr_accessor :binary_content
 
-    # Filename
+    # Display name of the file
     attr_accessor :name
 
+    # MIME content type
     attr_accessor :content_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ElasticEmail/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.1
 =end
 
 module ElasticEmail
-  VERSION = '4.0.11'
+  VERSION = '4.0.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ElasticEmail
 version: !ruby/object:Gem::Version
-  version: 4.0.11
+  version: 4.0.12
 platform: ruby
 authors:
 - ElasticEmail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus