ElasticEmail 4.0.16 → 4.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/ElasticEmail.gemspec +3 -3
- data/README.md +7 -12
- data/VERSION +1 -1
- data/docs/ContactsApi.md +2 -78
- data/docs/EmailsApi.md +1 -1
- data/docs/MessageAttachment.md +1 -1
- data/docs/SuppressionsApi.md +12 -12
- data/docs/VerificationsApi.md +4 -4
- data/lib/ElasticEmail/api/campaigns_api.rb +2 -2
- data/lib/ElasticEmail/api/contacts_api.rb +7 -73
- data/lib/ElasticEmail/api/emails_api.rb +2 -2
- data/lib/ElasticEmail/api/events_api.rb +9 -9
- data/lib/ElasticEmail/api/files_api.rb +2 -2
- data/lib/ElasticEmail/api/inbound_route_api.rb +2 -2
- data/lib/ElasticEmail/api/lists_api.rb +2 -2
- data/lib/ElasticEmail/api/security_api.rb +2 -2
- data/lib/ElasticEmail/api/segments_api.rb +2 -2
- data/lib/ElasticEmail/api/statistics_api.rb +2 -2
- data/lib/ElasticEmail/api/sub_accounts_api.rb +2 -2
- data/lib/ElasticEmail/api/suppressions_api.rb +26 -26
- data/lib/ElasticEmail/api/templates_api.rb +2 -2
- data/lib/ElasticEmail/api/verifications_api.rb +10 -10
- data/lib/ElasticEmail/api_client.rb +5 -3
- data/lib/ElasticEmail/api_error.rb +2 -2
- data/lib/ElasticEmail/configuration.rb +4 -3
- data/lib/ElasticEmail/models/access_level.rb +13 -8
- data/lib/ElasticEmail/models/account_status_enum.rb +8 -6
- data/lib/ElasticEmail/models/api_key.rb +3 -2
- data/lib/ElasticEmail/models/api_key_payload.rb +3 -2
- data/lib/ElasticEmail/models/body_content_type.rb +8 -5
- data/lib/ElasticEmail/models/body_part.rb +3 -2
- data/lib/ElasticEmail/models/campaign.rb +3 -2
- data/lib/ElasticEmail/models/campaign_options.rb +3 -2
- data/lib/ElasticEmail/models/campaign_recipient.rb +3 -2
- data/lib/ElasticEmail/models/campaign_status.rb +8 -5
- data/lib/ElasticEmail/models/campaign_template.rb +3 -2
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +3 -2
- data/lib/ElasticEmail/models/compression_format.rb +8 -5
- data/lib/ElasticEmail/models/consent_data.rb +3 -2
- data/lib/ElasticEmail/models/consent_tracking.rb +8 -5
- data/lib/ElasticEmail/models/contact.rb +3 -2
- data/lib/ElasticEmail/models/contact_activity.rb +3 -2
- data/lib/ElasticEmail/models/contact_hist_event_type.rb +2 -2
- data/lib/ElasticEmail/models/contact_history.rb +3 -2
- data/lib/ElasticEmail/models/contact_payload.rb +3 -2
- data/lib/ElasticEmail/models/contact_source.rb +8 -5
- data/lib/ElasticEmail/models/contact_status.rb +8 -5
- data/lib/ElasticEmail/models/contact_update_payload.rb +3 -2
- data/lib/ElasticEmail/models/contacts_list.rb +3 -2
- data/lib/ElasticEmail/models/delivery_optimization_type.rb +8 -5
- data/lib/ElasticEmail/models/email_content.rb +3 -2
- data/lib/ElasticEmail/models/email_data.rb +3 -2
- data/lib/ElasticEmail/models/email_message_data.rb +3 -2
- data/lib/ElasticEmail/models/email_recipient.rb +3 -2
- data/lib/ElasticEmail/models/email_send.rb +3 -2
- data/lib/ElasticEmail/models/email_status.rb +3 -2
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +3 -2
- data/lib/ElasticEmail/models/email_validation_result.rb +3 -2
- data/lib/ElasticEmail/models/email_validation_status.rb +8 -5
- data/lib/ElasticEmail/models/email_view.rb +3 -2
- data/lib/ElasticEmail/models/emails_payload.rb +3 -2
- data/lib/ElasticEmail/models/encoding_type.rb +8 -5
- data/lib/ElasticEmail/models/event_type.rb +8 -5
- data/lib/ElasticEmail/models/events_order_by.rb +8 -5
- data/lib/ElasticEmail/models/export_file_formats.rb +8 -5
- data/lib/ElasticEmail/models/export_link.rb +3 -2
- data/lib/ElasticEmail/models/export_status.rb +8 -5
- data/lib/ElasticEmail/models/file_info.rb +3 -2
- data/lib/ElasticEmail/models/file_payload.rb +3 -2
- data/lib/ElasticEmail/models/file_upload_result.rb +3 -2
- data/lib/ElasticEmail/models/inbound_payload.rb +3 -2
- data/lib/ElasticEmail/models/inbound_route.rb +3 -2
- data/lib/ElasticEmail/models/inbound_route_action_type.rb +8 -5
- data/lib/ElasticEmail/models/inbound_route_filter_type.rb +8 -5
- data/lib/ElasticEmail/models/list_payload.rb +3 -2
- data/lib/ElasticEmail/models/list_update_payload.rb +3 -2
- data/lib/ElasticEmail/models/log_job_status.rb +8 -5
- data/lib/ElasticEmail/models/log_status_summary.rb +3 -2
- data/lib/ElasticEmail/models/merge_email_payload.rb +3 -2
- data/lib/ElasticEmail/models/message_attachment.rb +8 -2
- data/lib/ElasticEmail/models/message_category.rb +8 -5
- data/lib/ElasticEmail/models/new_api_key.rb +3 -2
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +3 -2
- data/lib/ElasticEmail/models/options.rb +3 -2
- data/lib/ElasticEmail/models/recipient_event.rb +3 -2
- data/lib/ElasticEmail/models/segment.rb +3 -2
- data/lib/ElasticEmail/models/segment_payload.rb +3 -2
- data/lib/ElasticEmail/models/smtp_credentials.rb +3 -2
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +3 -2
- data/lib/ElasticEmail/models/sort_order_item.rb +3 -2
- data/lib/ElasticEmail/models/split_optimization_type.rb +8 -5
- data/lib/ElasticEmail/models/split_options.rb +3 -2
- data/lib/ElasticEmail/models/sub_account_info.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_payload.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +3 -2
- data/lib/ElasticEmail/models/suppression.rb +3 -2
- data/lib/ElasticEmail/models/template.rb +3 -2
- data/lib/ElasticEmail/models/template_payload.rb +3 -2
- data/lib/ElasticEmail/models/template_scope.rb +8 -5
- data/lib/ElasticEmail/models/template_type.rb +8 -5
- data/lib/ElasticEmail/models/transactional_recipient.rb +3 -2
- data/lib/ElasticEmail/models/utm.rb +3 -2
- data/lib/ElasticEmail/models/verification_file_result.rb +3 -2
- data/lib/ElasticEmail/models/verification_file_result_details.rb +3 -2
- data/lib/ElasticEmail/models/verification_status.rb +8 -5
- data/lib/ElasticEmail/version.rb +3 -3
- data/lib/ElasticEmail.rb +2 -4
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +7 -13
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f3dbb5439e933d6d4f712e4d9d3dd58d78337d5726e8cb4c4987cf3f96d05525
|
|
4
|
+
data.tar.gz: 0472be067ee8428d882b477d6947e7e108026354b2df5cdb35a8b95ea8bce95b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 56c5ce32bd50a1a8ea3b362ae1ee2f878ecd708e100fd4153d558f5710ee8e94faeeda04bd0c1f3a1a582e8272fd141c7961ed30f134e1898426b2ebc90c2286
|
|
7
|
+
data.tar.gz: bb6f889d3642a1e46deccbd0249dde0932ef134d8e5cce364325363fe1f60051d04db35ac2f83bc116ebfda04a6af3f3ce62a8a04c83c6b86c83f32086de419d
|
data/ElasticEmail.gemspec
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#Elastic Email REST API
|
|
5
5
|
|
|
6
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
6
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
7
7
|
|
|
8
8
|
The version of the OpenAPI document: 4.0.0
|
|
9
9
|
Contact: support@elasticemail.com
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
|
-
OpenAPI Generator version:
|
|
11
|
+
OpenAPI Generator version: 6.2.1
|
|
12
12
|
|
|
13
13
|
=end
|
|
14
14
|
|
|
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
|
|
|
23
23
|
s.email = ["contact@elasticemail.com"]
|
|
24
24
|
s.homepage = "https://elasticemail.com"
|
|
25
25
|
s.summary = "Elastic Email REST API Ruby Gem"
|
|
26
|
-
s.description = "This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.
|
|
26
|
+
s.description = "The C# library for the Elastic Email REST API. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. To start using this API, you will need your Access Token. Remember to keep it safe."
|
|
27
27
|
s.license = "Unlicense"
|
|
28
28
|
s.required_ruby_version = ">= 2.4"
|
|
29
29
|
|
data/README.md
CHANGED
|
@@ -8,16 +8,14 @@ Every API call is established on which specific request type (GET, POST, PUT, DE
|
|
|
8
8
|
|
|
9
9
|
The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
|
|
10
10
|
|
|
11
|
-
To start using this API, you will need your Access Token (available [here](https://elasticemail.com/
|
|
11
|
+
To start using this API, you will need your Access Token (available [here](https://app.elasticemail.com/marketing/settings/new/manage-api)). Remember to keep it safe. Required access levels are listed in the given request’s description.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme)
|
|
13
|
+
Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail/elasticemail-ruby)
|
|
16
14
|
|
|
17
15
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
18
16
|
|
|
19
17
|
- API version: 4.0.0
|
|
20
|
-
- Package version: 4.0.
|
|
18
|
+
- Package version: 4.0.21
|
|
21
19
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
22
20
|
|
|
23
21
|
## Installation
|
|
@@ -33,16 +31,16 @@ gem build ElasticEmail.gemspec
|
|
|
33
31
|
Then either install the gem locally:
|
|
34
32
|
|
|
35
33
|
```shell
|
|
36
|
-
gem install ./ElasticEmail-4.0.
|
|
34
|
+
gem install ./ElasticEmail-4.0.21.gem
|
|
37
35
|
```
|
|
38
36
|
|
|
39
|
-
(for development, run `gem install --dev ./ElasticEmail-4.0.
|
|
37
|
+
(for development, run `gem install --dev ./ElasticEmail-4.0.21.gem` to install the development dependencies)
|
|
40
38
|
|
|
41
39
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
42
40
|
|
|
43
41
|
Finally add this to the Gemfile:
|
|
44
42
|
|
|
45
|
-
gem 'ElasticEmail', '~> 4.0.
|
|
43
|
+
gem 'ElasticEmail', '~> 4.0.21'
|
|
46
44
|
|
|
47
45
|
### Install from Git
|
|
48
46
|
|
|
@@ -86,7 +84,7 @@ end
|
|
|
86
84
|
|
|
87
85
|
```
|
|
88
86
|
|
|
89
|
-
|
|
87
|
+
|
|
90
88
|
|
|
91
89
|
All URIs are relative to *https://api.elasticemail.com/v4*
|
|
92
90
|
|
|
@@ -99,7 +97,6 @@ Class | Method | HTTP request | Description
|
|
|
99
97
|
*ElasticEmail::CampaignsApi* | [**campaigns_post**](docs/CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign
|
|
100
98
|
*ElasticEmail::ContactsApi* | [**contacts_by_email_delete**](docs/ContactsApi.md#contacts_by_email_delete) | **DELETE** /contacts/{email} | Delete Contact
|
|
101
99
|
*ElasticEmail::ContactsApi* | [**contacts_by_email_get**](docs/ContactsApi.md#contacts_by_email_get) | **GET** /contacts/{email} | Load Contact
|
|
102
|
-
*ElasticEmail::ContactsApi* | [**contacts_by_email_history_get**](docs/ContactsApi.md#contacts_by_email_history_get) | **GET** /contacts/{email}/history | Load History
|
|
103
100
|
*ElasticEmail::ContactsApi* | [**contacts_by_email_put**](docs/ContactsApi.md#contacts_by_email_put) | **PUT** /contacts/{email} | Update Contact
|
|
104
101
|
*ElasticEmail::ContactsApi* | [**contacts_delete_post**](docs/ContactsApi.md#contacts_delete_post) | **POST** /contacts/delete | Delete Contacts Bulk
|
|
105
102
|
*ElasticEmail::ContactsApi* | [**contacts_export_by_id_status_get**](docs/ContactsApi.md#contacts_export_by_id_status_get) | **GET** /contacts/export/{id}/status | Check Export Status
|
|
@@ -210,8 +207,6 @@ Class | Method | HTTP request | Description
|
|
|
210
207
|
- [ElasticEmail::ConsentTracking](docs/ConsentTracking.md)
|
|
211
208
|
- [ElasticEmail::Contact](docs/Contact.md)
|
|
212
209
|
- [ElasticEmail::ContactActivity](docs/ContactActivity.md)
|
|
213
|
-
- [ElasticEmail::ContactHistEventType](docs/ContactHistEventType.md)
|
|
214
|
-
- [ElasticEmail::ContactHistory](docs/ContactHistory.md)
|
|
215
210
|
- [ElasticEmail::ContactPayload](docs/ContactPayload.md)
|
|
216
211
|
- [ElasticEmail::ContactSource](docs/ContactSource.md)
|
|
217
212
|
- [ElasticEmail::ContactStatus](docs/ContactStatus.md)
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
4.0.
|
|
1
|
+
4.0.21
|
data/docs/ContactsApi.md
CHANGED
|
@@ -6,7 +6,6 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**contacts_by_email_delete**](ContactsApi.md#contacts_by_email_delete) | **DELETE** /contacts/{email} | Delete Contact |
|
|
8
8
|
| [**contacts_by_email_get**](ContactsApi.md#contacts_by_email_get) | **GET** /contacts/{email} | Load Contact |
|
|
9
|
-
| [**contacts_by_email_history_get**](ContactsApi.md#contacts_by_email_history_get) | **GET** /contacts/{email}/history | Load History |
|
|
10
9
|
| [**contacts_by_email_put**](ContactsApi.md#contacts_by_email_put) | **PUT** /contacts/{email} | Update Contact |
|
|
11
10
|
| [**contacts_delete_post**](ContactsApi.md#contacts_delete_post) | **POST** /contacts/delete | Delete Contacts Bulk |
|
|
12
11
|
| [**contacts_export_by_id_status_get**](ContactsApi.md#contacts_export_by_id_status_get) | **GET** /contacts/export/{id}/status | Check Export Status |
|
|
@@ -157,83 +156,6 @@ end
|
|
|
157
156
|
- **Accept**: application/json
|
|
158
157
|
|
|
159
158
|
|
|
160
|
-
## contacts_by_email_history_get
|
|
161
|
-
|
|
162
|
-
> <Array<ContactHistory>> contacts_by_email_history_get(email, opts)
|
|
163
|
-
|
|
164
|
-
Load History
|
|
165
|
-
|
|
166
|
-
Returns detailed history of specified Contact. Required Access Level: ViewContacts
|
|
167
|
-
|
|
168
|
-
### Examples
|
|
169
|
-
|
|
170
|
-
```ruby
|
|
171
|
-
require 'time'
|
|
172
|
-
require 'ElasticEmail'
|
|
173
|
-
# setup authorization
|
|
174
|
-
ElasticEmail.configure do |config|
|
|
175
|
-
# Configure API key authorization: apikey
|
|
176
|
-
config.api_key['apikey'] = 'YOUR API KEY'
|
|
177
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
178
|
-
# config.api_key_prefix['apikey'] = 'Bearer'
|
|
179
|
-
end
|
|
180
|
-
|
|
181
|
-
api_instance = ElasticEmail::ContactsApi.new
|
|
182
|
-
email = 'mail@example.com' # String | Proper email address.
|
|
183
|
-
opts = {
|
|
184
|
-
limit: 100, # Integer | Maximum number of returned items.
|
|
185
|
-
offset: 20 # Integer | How many items should be returned ahead.
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
begin
|
|
189
|
-
# Load History
|
|
190
|
-
result = api_instance.contacts_by_email_history_get(email, opts)
|
|
191
|
-
p result
|
|
192
|
-
rescue ElasticEmail::ApiError => e
|
|
193
|
-
puts "Error when calling ContactsApi->contacts_by_email_history_get: #{e}"
|
|
194
|
-
end
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
#### Using the contacts_by_email_history_get_with_http_info variant
|
|
198
|
-
|
|
199
|
-
This returns an Array which contains the response data, status code and headers.
|
|
200
|
-
|
|
201
|
-
> <Array(<Array<ContactHistory>>, Integer, Hash)> contacts_by_email_history_get_with_http_info(email, opts)
|
|
202
|
-
|
|
203
|
-
```ruby
|
|
204
|
-
begin
|
|
205
|
-
# Load History
|
|
206
|
-
data, status_code, headers = api_instance.contacts_by_email_history_get_with_http_info(email, opts)
|
|
207
|
-
p status_code # => 2xx
|
|
208
|
-
p headers # => { ... }
|
|
209
|
-
p data # => <Array<ContactHistory>>
|
|
210
|
-
rescue ElasticEmail::ApiError => e
|
|
211
|
-
puts "Error when calling ContactsApi->contacts_by_email_history_get_with_http_info: #{e}"
|
|
212
|
-
end
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### Parameters
|
|
216
|
-
|
|
217
|
-
| Name | Type | Description | Notes |
|
|
218
|
-
| ---- | ---- | ----------- | ----- |
|
|
219
|
-
| **email** | **String** | Proper email address. | |
|
|
220
|
-
| **limit** | **Integer** | Maximum number of returned items. | [optional] |
|
|
221
|
-
| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
|
|
222
|
-
|
|
223
|
-
### Return type
|
|
224
|
-
|
|
225
|
-
[**Array<ContactHistory>**](ContactHistory.md)
|
|
226
|
-
|
|
227
|
-
### Authorization
|
|
228
|
-
|
|
229
|
-
[apikey](../README.md#apikey)
|
|
230
|
-
|
|
231
|
-
### HTTP request headers
|
|
232
|
-
|
|
233
|
-
- **Content-Type**: Not defined
|
|
234
|
-
- **Accept**: application/json
|
|
235
|
-
|
|
236
|
-
|
|
237
159
|
## contacts_by_email_put
|
|
238
160
|
|
|
239
161
|
> <Contact> contacts_by_email_put(email, contact_update_payload)
|
|
@@ -629,6 +551,7 @@ api_instance = ElasticEmail::ContactsApi.new
|
|
|
629
551
|
opts = {
|
|
630
552
|
list_name: 'list_name_example', # String | Name of an existing list to add these contacts to
|
|
631
553
|
encoding_name: 'encoding_name_example', # String | In what encoding the file is uploaded
|
|
554
|
+
file_url: 'file_url_example', # String | Optional url of csv to import
|
|
632
555
|
file: File.new('/path/to/some/file') # File |
|
|
633
556
|
}
|
|
634
557
|
|
|
@@ -664,6 +587,7 @@ end
|
|
|
664
587
|
| ---- | ---- | ----------- | ----- |
|
|
665
588
|
| **list_name** | **String** | Name of an existing list to add these contacts to | [optional] |
|
|
666
589
|
| **encoding_name** | **String** | In what encoding the file is uploaded | [optional] |
|
|
590
|
+
| **file_url** | **String** | Optional url of csv to import | [optional] |
|
|
667
591
|
| **file** | **File** | | [optional] |
|
|
668
592
|
|
|
669
593
|
### Return type
|
data/docs/EmailsApi.md
CHANGED
|
@@ -103,7 +103,7 @@ ElasticEmail.configure do |config|
|
|
|
103
103
|
end
|
|
104
104
|
|
|
105
105
|
api_instance = ElasticEmail::EmailsApi.new
|
|
106
|
-
merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example'})}) # MergeEmailPayload | Email data
|
|
106
|
+
merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'})}) # MergeEmailPayload | Email data
|
|
107
107
|
|
|
108
108
|
begin
|
|
109
109
|
# Send Bulk Emails CSV
|
data/docs/MessageAttachment.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **binary_content** | **String** | File's content as byte array (or a Base64 string) | |
|
|
8
|
-
| **name** | **String** | Display name of the file |
|
|
8
|
+
| **name** | **String** | Display name of the file | |
|
|
9
9
|
| **content_type** | **String** | MIME content type | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
data/docs/SuppressionsApi.md
CHANGED
|
@@ -24,7 +24,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
24
24
|
|
|
25
25
|
Get Bounce List
|
|
26
26
|
|
|
27
|
-
Retrieve your list of bounced emails. Required Access Level: ViewContacts
|
|
27
|
+
Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions
|
|
28
28
|
|
|
29
29
|
### Examples
|
|
30
30
|
|
|
@@ -101,7 +101,7 @@ end
|
|
|
101
101
|
|
|
102
102
|
Add Bounces Async
|
|
103
103
|
|
|
104
|
-
Add Bounced. Required Access Level: ModifyContacts
|
|
104
|
+
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
|
|
105
105
|
|
|
106
106
|
### Examples
|
|
107
107
|
|
|
@@ -173,7 +173,7 @@ nil (empty response body)
|
|
|
173
173
|
|
|
174
174
|
Add Bounces
|
|
175
175
|
|
|
176
|
-
Add Bounced. Required Access Level: ModifyContacts
|
|
176
|
+
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
|
|
177
177
|
|
|
178
178
|
### Examples
|
|
179
179
|
|
|
@@ -244,7 +244,7 @@ end
|
|
|
244
244
|
|
|
245
245
|
Delete Suppression
|
|
246
246
|
|
|
247
|
-
Delete Suppression. Required Access Level: ViewContacts
|
|
247
|
+
Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions
|
|
248
248
|
|
|
249
249
|
### Examples
|
|
250
250
|
|
|
@@ -314,7 +314,7 @@ nil (empty response body)
|
|
|
314
314
|
|
|
315
315
|
Get Suppression
|
|
316
316
|
|
|
317
|
-
Retrieve your suppression. Required Access Level: ViewContacts
|
|
317
|
+
Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions
|
|
318
318
|
|
|
319
319
|
### Examples
|
|
320
320
|
|
|
@@ -385,7 +385,7 @@ end
|
|
|
385
385
|
|
|
386
386
|
Get Complaints List
|
|
387
387
|
|
|
388
|
-
Retrieve your list of complaints. Required Access Level: ViewContacts
|
|
388
|
+
Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions
|
|
389
389
|
|
|
390
390
|
### Examples
|
|
391
391
|
|
|
@@ -462,7 +462,7 @@ end
|
|
|
462
462
|
|
|
463
463
|
Add Complaints Async
|
|
464
464
|
|
|
465
|
-
Add Complaints. Required Access Level: ModifyContacts
|
|
465
|
+
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
|
|
466
466
|
|
|
467
467
|
### Examples
|
|
468
468
|
|
|
@@ -534,7 +534,7 @@ nil (empty response body)
|
|
|
534
534
|
|
|
535
535
|
Add Complaints
|
|
536
536
|
|
|
537
|
-
Add Complaints. Required Access Level: ModifyContacts
|
|
537
|
+
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
|
|
538
538
|
|
|
539
539
|
### Examples
|
|
540
540
|
|
|
@@ -605,7 +605,7 @@ end
|
|
|
605
605
|
|
|
606
606
|
Get Suppressions
|
|
607
607
|
|
|
608
|
-
Retrieve your suppressions. Required Access Level: ViewContacts
|
|
608
|
+
Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions
|
|
609
609
|
|
|
610
610
|
### Examples
|
|
611
611
|
|
|
@@ -680,7 +680,7 @@ end
|
|
|
680
680
|
|
|
681
681
|
Get Unsubscribes List
|
|
682
682
|
|
|
683
|
-
Retrieve your list of unsubscribes. Required Access Level: ViewContacts
|
|
683
|
+
Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions
|
|
684
684
|
|
|
685
685
|
### Examples
|
|
686
686
|
|
|
@@ -757,7 +757,7 @@ end
|
|
|
757
757
|
|
|
758
758
|
Add Unsubscribes Async
|
|
759
759
|
|
|
760
|
-
Add Unsubscribes. Required Access Level: ModifyContacts
|
|
760
|
+
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
|
|
761
761
|
|
|
762
762
|
### Examples
|
|
763
763
|
|
|
@@ -829,7 +829,7 @@ nil (empty response body)
|
|
|
829
829
|
|
|
830
830
|
Add Unsubscribes
|
|
831
831
|
|
|
832
|
-
Add Unsubscribes. Required Access Level: ModifyContacts
|
|
832
|
+
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
|
|
833
833
|
|
|
834
834
|
### Examples
|
|
835
835
|
|
data/docs/VerificationsApi.md
CHANGED
|
@@ -92,7 +92,7 @@ nil (empty response body)
|
|
|
92
92
|
|
|
93
93
|
Get Email Verification Result
|
|
94
94
|
|
|
95
|
-
Returns a result of verified email. Required Access Level: ViewEmailVerifications
|
|
95
|
+
Returns a result of verified email. Required Access Level: VerifyEmails, ViewEmailVerifications
|
|
96
96
|
|
|
97
97
|
### Examples
|
|
98
98
|
|
|
@@ -375,7 +375,7 @@ end
|
|
|
375
375
|
|
|
376
376
|
Get Detailed File Verification Result
|
|
377
377
|
|
|
378
|
-
Returns status and results (if verified) of file with given ID. Required Access Level: ViewEmailVerifications
|
|
378
|
+
Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails, ViewEmailVerifications
|
|
379
379
|
|
|
380
380
|
### Examples
|
|
381
381
|
|
|
@@ -595,7 +595,7 @@ end
|
|
|
595
595
|
|
|
596
596
|
Get Files Verification Results
|
|
597
597
|
|
|
598
|
-
Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
|
|
598
|
+
Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails, ViewEmailVerifications
|
|
599
599
|
|
|
600
600
|
### Examples
|
|
601
601
|
|
|
@@ -663,7 +663,7 @@ This endpoint does not need any parameter.
|
|
|
663
663
|
|
|
664
664
|
Get Emails Verification Results
|
|
665
665
|
|
|
666
|
-
Returns a results of all verified single emails. Required Access Level: ViewEmailVerifications
|
|
666
|
+
Returns a results of all verified single emails. Required Access Level: VerifyEmails, ViewEmailVerifications
|
|
667
667
|
|
|
668
668
|
### Examples
|
|
669
669
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -143,75 +143,6 @@ module ElasticEmail
|
|
|
143
143
|
return data, status_code, headers
|
|
144
144
|
end
|
|
145
145
|
|
|
146
|
-
# Load History
|
|
147
|
-
# Returns detailed history of specified Contact. Required Access Level: ViewContacts
|
|
148
|
-
# @param email [String] Proper email address.
|
|
149
|
-
# @param [Hash] opts the optional parameters
|
|
150
|
-
# @option opts [Integer] :limit Maximum number of returned items.
|
|
151
|
-
# @option opts [Integer] :offset How many items should be returned ahead.
|
|
152
|
-
# @return [Array<ContactHistory>]
|
|
153
|
-
def contacts_by_email_history_get(email, opts = {})
|
|
154
|
-
data, _status_code, _headers = contacts_by_email_history_get_with_http_info(email, opts)
|
|
155
|
-
data
|
|
156
|
-
end
|
|
157
|
-
|
|
158
|
-
# Load History
|
|
159
|
-
# Returns detailed history of specified Contact. Required Access Level: ViewContacts
|
|
160
|
-
# @param email [String] Proper email address.
|
|
161
|
-
# @param [Hash] opts the optional parameters
|
|
162
|
-
# @option opts [Integer] :limit Maximum number of returned items.
|
|
163
|
-
# @option opts [Integer] :offset How many items should be returned ahead.
|
|
164
|
-
# @return [Array<(Array<ContactHistory>, Integer, Hash)>] Array<ContactHistory> data, response status code and response headers
|
|
165
|
-
def contacts_by_email_history_get_with_http_info(email, opts = {})
|
|
166
|
-
if @api_client.config.debugging
|
|
167
|
-
@api_client.config.logger.debug 'Calling API: ContactsApi.contacts_by_email_history_get ...'
|
|
168
|
-
end
|
|
169
|
-
# verify the required parameter 'email' is set
|
|
170
|
-
if @api_client.config.client_side_validation && email.nil?
|
|
171
|
-
fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.contacts_by_email_history_get"
|
|
172
|
-
end
|
|
173
|
-
# resource path
|
|
174
|
-
local_var_path = '/contacts/{email}/history'.sub('{' + 'email' + '}', CGI.escape(email.to_s))
|
|
175
|
-
|
|
176
|
-
# query parameters
|
|
177
|
-
query_params = opts[:query_params] || {}
|
|
178
|
-
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
179
|
-
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
180
|
-
|
|
181
|
-
# header parameters
|
|
182
|
-
header_params = opts[:header_params] || {}
|
|
183
|
-
# HTTP header 'Accept' (if needed)
|
|
184
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
185
|
-
|
|
186
|
-
# form parameters
|
|
187
|
-
form_params = opts[:form_params] || {}
|
|
188
|
-
|
|
189
|
-
# http body (model)
|
|
190
|
-
post_body = opts[:debug_body]
|
|
191
|
-
|
|
192
|
-
# return_type
|
|
193
|
-
return_type = opts[:debug_return_type] || 'Array<ContactHistory>'
|
|
194
|
-
|
|
195
|
-
# auth_names
|
|
196
|
-
auth_names = opts[:debug_auth_names] || ['apikey']
|
|
197
|
-
|
|
198
|
-
new_options = opts.merge(
|
|
199
|
-
:operation => :"ContactsApi.contacts_by_email_history_get",
|
|
200
|
-
:header_params => header_params,
|
|
201
|
-
:query_params => query_params,
|
|
202
|
-
:form_params => form_params,
|
|
203
|
-
:body => post_body,
|
|
204
|
-
:auth_names => auth_names,
|
|
205
|
-
:return_type => return_type
|
|
206
|
-
)
|
|
207
|
-
|
|
208
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
209
|
-
if @api_client.config.debugging
|
|
210
|
-
@api_client.config.logger.debug "API called: ContactsApi#contacts_by_email_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
211
|
-
end
|
|
212
|
-
return data, status_code, headers
|
|
213
|
-
end
|
|
214
|
-
|
|
215
146
|
# Update Contact
|
|
216
147
|
# Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts
|
|
217
148
|
# @param email [String] Proper email address.
|
|
@@ -432,10 +363,10 @@ module ElasticEmail
|
|
|
432
363
|
# Export Contacts
|
|
433
364
|
# Request an Export of specified Contacts. Required Access Level: Export
|
|
434
365
|
# @param [Hash] opts the optional parameters
|
|
435
|
-
# @option opts [ExportFileFormats] :file_format Format of the exported file
|
|
366
|
+
# @option opts [ExportFileFormats] :file_format Format of the exported file (default to 'Csv')
|
|
436
367
|
# @option opts [String] :rule Query used for filtering.
|
|
437
368
|
# @option opts [Array<String>] :emails Comma delimited list of contact emails
|
|
438
|
-
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
|
|
369
|
+
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip. (default to 'None')
|
|
439
370
|
# @option opts [String] :file_name Name of your file including extension.
|
|
440
371
|
# @return [Array<(ExportLink, Integer, Hash)>] ExportLink data, response status code and response headers
|
|
441
372
|
def contacts_export_post_with_http_info(opts = {})
|
|
@@ -555,6 +486,7 @@ module ElasticEmail
|
|
|
555
486
|
# @param [Hash] opts the optional parameters
|
|
556
487
|
# @option opts [String] :list_name Name of an existing list to add these contacts to
|
|
557
488
|
# @option opts [String] :encoding_name In what encoding the file is uploaded
|
|
489
|
+
# @option opts [String] :file_url Optional url of csv to import
|
|
558
490
|
# @option opts [File] :file
|
|
559
491
|
# @return [nil]
|
|
560
492
|
def contacts_import_post(opts = {})
|
|
@@ -567,6 +499,7 @@ module ElasticEmail
|
|
|
567
499
|
# @param [Hash] opts the optional parameters
|
|
568
500
|
# @option opts [String] :list_name Name of an existing list to add these contacts to
|
|
569
501
|
# @option opts [String] :encoding_name In what encoding the file is uploaded
|
|
502
|
+
# @option opts [String] :file_url Optional url of csv to import
|
|
570
503
|
# @option opts [File] :file
|
|
571
504
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
572
505
|
def contacts_import_post_with_http_info(opts = {})
|
|
@@ -580,6 +513,7 @@ module ElasticEmail
|
|
|
580
513
|
query_params = opts[:query_params] || {}
|
|
581
514
|
query_params[:'listName'] = opts[:'list_name'] if !opts[:'list_name'].nil?
|
|
582
515
|
query_params[:'encodingName'] = opts[:'encoding_name'] if !opts[:'encoding_name'].nil?
|
|
516
|
+
query_params[:'fileUrl'] = opts[:'file_url'] if !opts[:'file_url'].nil?
|
|
583
517
|
|
|
584
518
|
# header parameters
|
|
585
519
|
header_params = opts[:header_params] || {}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -40,7 +40,7 @@ module ElasticEmail
|
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
|
|
42
42
|
# @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
|
|
43
|
-
# @option opts [EventsOrderBy] :order_by
|
|
43
|
+
# @option opts [EventsOrderBy] :order_by (default to 'DateDescending')
|
|
44
44
|
# @option opts [Integer] :limit Maximum number of returned items.
|
|
45
45
|
# @option opts [Integer] :offset How many items should be returned ahead.
|
|
46
46
|
# @return [Array<(Array<RecipientEvent>, Integer, Hash)>] Array<RecipientEvent> data, response status code and response headers
|
|
@@ -120,8 +120,8 @@ module ElasticEmail
|
|
|
120
120
|
# @option opts [Array<EventType>] :event_types Types of Events to return
|
|
121
121
|
# @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
|
|
122
122
|
# @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
|
|
123
|
-
# @option opts [ExportFileFormats] :file_format Format of the exported file
|
|
124
|
-
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
|
|
123
|
+
# @option opts [ExportFileFormats] :file_format Format of the exported file (default to 'Csv')
|
|
124
|
+
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip. (default to 'None')
|
|
125
125
|
# @option opts [String] :file_name Name of your file including extension.
|
|
126
126
|
# @return [Array<(ExportLink, Integer, Hash)>] ExportLink data, response status code and response headers
|
|
127
127
|
def events_channels_by_name_export_post_with_http_info(name, opts = {})
|
|
@@ -201,7 +201,7 @@ module ElasticEmail
|
|
|
201
201
|
# @option opts [Array<EventType>] :event_types Types of Events to return
|
|
202
202
|
# @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
|
|
203
203
|
# @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
|
|
204
|
-
# @option opts [EventsOrderBy] :order_by
|
|
204
|
+
# @option opts [EventsOrderBy] :order_by (default to 'DateDescending')
|
|
205
205
|
# @option opts [Integer] :limit How many items to load. Maximum for this request is 1000 items
|
|
206
206
|
# @option opts [Integer] :offset How many items should be returned ahead.
|
|
207
207
|
# @return [Array<(Array<RecipientEvent>, Integer, Hash)>] Array<RecipientEvent> data, response status code and response headers
|
|
@@ -406,8 +406,8 @@ module ElasticEmail
|
|
|
406
406
|
# @option opts [Array<EventType>] :event_types Types of Events to return
|
|
407
407
|
# @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
|
|
408
408
|
# @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
|
|
409
|
-
# @option opts [ExportFileFormats] :file_format Format of the exported file
|
|
410
|
-
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
|
|
409
|
+
# @option opts [ExportFileFormats] :file_format Format of the exported file (default to 'Csv')
|
|
410
|
+
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip. (default to 'None')
|
|
411
411
|
# @option opts [String] :file_name Name of your file including extension.
|
|
412
412
|
# @return [Array<(ExportLink, Integer, Hash)>] ExportLink data, response status code and response headers
|
|
413
413
|
def events_export_post_with_http_info(opts = {})
|
|
@@ -481,7 +481,7 @@ module ElasticEmail
|
|
|
481
481
|
# @option opts [Array<EventType>] :event_types Types of Events to return
|
|
482
482
|
# @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
|
|
483
483
|
# @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
|
|
484
|
-
# @option opts [EventsOrderBy] :order_by
|
|
484
|
+
# @option opts [EventsOrderBy] :order_by (default to 'DateDescending')
|
|
485
485
|
# @option opts [Integer] :limit How many items to load. Maximum for this request is 1000 items
|
|
486
486
|
# @option opts [Integer] :offset How many items should be returned ahead.
|
|
487
487
|
# @return [Array<(Array<RecipientEvent>, Integer, Hash)>] Array<RecipientEvent> data, response status code and response headers
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Elastic Email REST API
|
|
3
3
|
|
|
4
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/
|
|
4
|
+
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
|
7
7
|
Contact: support@elasticemail.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|