ElasticEmail 4.0.28 → 4.2.0
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/README.md +12 -8
- data/VERSION +1 -1
- data/docs/CampaignsApi.md +73 -0
- data/docs/DKIMRecord.md +26 -0
- data/docs/DomainData.md +7 -1
- data/docs/DomainDetail.md +7 -1
- data/docs/SecurityApi.md +4 -4
- data/docs/SubAccountsApi.md +73 -1
- data/lib/ElasticEmail/api/campaigns_api.rb +68 -0
- data/lib/ElasticEmail/api/security_api.rb +4 -4
- data/lib/ElasticEmail/api/sub_accounts_api.rb +65 -2
- data/lib/ElasticEmail/models/certificate_validation_status.rb +2 -1
- data/lib/ElasticEmail/models/dkim_record.rb +252 -0
- data/lib/ElasticEmail/models/domain_data.rb +32 -4
- data/lib/ElasticEmail/models/domain_detail.rb +32 -4
- data/lib/ElasticEmail/models/event_type.rb +5 -2
- data/lib/ElasticEmail/version.rb +1 -1
- data/lib/ElasticEmail.rb +1 -0
- data/spec/api/campaigns_api_spec.rb +13 -0
- data/spec/api/security_api_spec.rb +2 -2
- data/spec/api/sub_accounts_api_spec.rb +13 -1
- data/spec/models/dkim_record_spec.rb +60 -0
- data/spec/models/domain_data_spec.rb +18 -0
- data/spec/models/domain_detail_spec.rb +18 -0
- metadata +95 -91
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '06992cb5829185504ab14ef86658dbcec7017bc89ab3be8d7488ee92d989acce'
|
|
4
|
+
data.tar.gz: b2b1d3bfb7e5ec9feeea50d7190b717139a1548ab0efcaac36f210107e558e2e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4398e5c24377380692390953090991d298d502cb0f6b207e2df933580808a61dd2e60f90309b8dc852e44d83043ca092e15aed9a15329000baed6f58b94e90d7
|
|
7
|
+
data.tar.gz: 2048a4b9c2fbd556eaa4eb91ca0416de6517313cab1edd57d5fc5b82297f333a50c67e762b08fbaa4b3483677e1fe30593fac6acd433210b1826c056b54e0f0f
|
data/README.md
CHANGED
|
@@ -15,7 +15,7 @@ Downloadable library clients can be found in our Github repository <a target='_b
|
|
|
15
15
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
16
16
|
|
|
17
17
|
- API version: 4.0.0
|
|
18
|
-
- Package version: 4.0
|
|
18
|
+
- Package version: 4.2.0
|
|
19
19
|
- Generator version: 7.11.0
|
|
20
20
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
21
21
|
|
|
@@ -32,16 +32,16 @@ gem build ElasticEmail.gemspec
|
|
|
32
32
|
Then either install the gem locally:
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
gem install ./ElasticEmail-4.0.
|
|
35
|
+
gem install ./ElasticEmail-4.2.0.gem
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
(for development, run `gem install --dev ./ElasticEmail-4.0.
|
|
38
|
+
(for development, run `gem install --dev ./ElasticEmail-4.2.0.gem` to install the development dependencies)
|
|
39
39
|
|
|
40
40
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
41
41
|
|
|
42
42
|
Finally add this to the Gemfile:
|
|
43
43
|
|
|
44
|
-
gem 'ElasticEmail', '~> 4.0
|
|
44
|
+
gem 'ElasticEmail', '~> 4.2.0'
|
|
45
45
|
|
|
46
46
|
### Install from Git
|
|
47
47
|
|
|
@@ -74,13 +74,14 @@ ElasticEmail.configure do |config|
|
|
|
74
74
|
end
|
|
75
75
|
|
|
76
76
|
api_instance = ElasticEmail::CampaignsApi.new
|
|
77
|
-
name = 'name_example' # String |
|
|
77
|
+
name = 'name_example' # String |
|
|
78
|
+
contact_email = 'contact_email_example' # String |
|
|
78
79
|
|
|
79
80
|
begin
|
|
80
|
-
#
|
|
81
|
-
api_instance.
|
|
81
|
+
#Trigger Automation for Contact
|
|
82
|
+
api_instance.campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
82
83
|
rescue ElasticEmail::ApiError => e
|
|
83
|
-
puts "Exception when calling CampaignsApi->
|
|
84
|
+
puts "Exception when calling CampaignsApi->campaigns_automation_by_name_trigger_post: #{e}"
|
|
84
85
|
end
|
|
85
86
|
|
|
86
87
|
```
|
|
@@ -91,6 +92,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
91
92
|
|
|
92
93
|
Class | Method | HTTP request | Description
|
|
93
94
|
------------ | ------------- | ------------- | -------------
|
|
95
|
+
*ElasticEmail::CampaignsApi* | [**campaigns_automation_by_name_trigger_post**](docs/CampaignsApi.md#campaigns_automation_by_name_trigger_post) | **POST** /campaigns/automation/{name}/trigger | Trigger Automation for Contact
|
|
94
96
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign
|
|
95
97
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign
|
|
96
98
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign
|
|
@@ -165,6 +167,7 @@ Class | Method | HTTP request | Description
|
|
|
165
167
|
*ElasticEmail::StatisticsApi* | [**statistics_channels_by_name_get**](docs/StatisticsApi.md#statistics_channels_by_name_get) | **GET** /statistics/channels/{name} | Load Channel Stats
|
|
166
168
|
*ElasticEmail::StatisticsApi* | [**statistics_channels_get**](docs/StatisticsApi.md#statistics_channels_get) | **GET** /statistics/channels | Load Channels Stats
|
|
167
169
|
*ElasticEmail::StatisticsApi* | [**statistics_get**](docs/StatisticsApi.md#statistics_get) | **GET** /statistics | Load Statistics
|
|
170
|
+
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_apikey_get**](docs/SubAccountsApi.md#subaccounts_by_email_apikey_get) | **GET** /subaccounts/{email}/apikey | Get SubAccount ApiKey
|
|
168
171
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_credits_patch**](docs/SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits
|
|
169
172
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_delete**](docs/SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount
|
|
170
173
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_get**](docs/SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount
|
|
@@ -230,6 +233,7 @@ Class | Method | HTTP request | Description
|
|
|
230
233
|
- [ElasticEmail::ContactStatus](docs/ContactStatus.md)
|
|
231
234
|
- [ElasticEmail::ContactUpdatePayload](docs/ContactUpdatePayload.md)
|
|
232
235
|
- [ElasticEmail::ContactsList](docs/ContactsList.md)
|
|
236
|
+
- [ElasticEmail::DKIMRecord](docs/DKIMRecord.md)
|
|
233
237
|
- [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)
|
|
234
238
|
- [ElasticEmail::DomainData](docs/DomainData.md)
|
|
235
239
|
- [ElasticEmail::DomainDetail](docs/DomainDetail.md)
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
4.0
|
|
1
|
+
4.2.0
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**campaigns_automation_by_name_trigger_post**](CampaignsApi.md#campaigns_automation_by_name_trigger_post) | **POST** /campaigns/automation/{name}/trigger | Trigger Automation for Contact |
|
|
7
8
|
| [**campaigns_by_name_delete**](CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign |
|
|
8
9
|
| [**campaigns_by_name_get**](CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign |
|
|
9
10
|
| [**campaigns_by_name_pause_put**](CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign |
|
|
@@ -12,6 +13,78 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
12
13
|
| [**campaigns_post**](CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign |
|
|
13
14
|
|
|
14
15
|
|
|
16
|
+
## campaigns_automation_by_name_trigger_post
|
|
17
|
+
|
|
18
|
+
> campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
19
|
+
|
|
20
|
+
Trigger Automation for Contact
|
|
21
|
+
|
|
22
|
+
Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'ElasticEmail'
|
|
29
|
+
# setup authorization
|
|
30
|
+
ElasticEmail.configure do |config|
|
|
31
|
+
# Configure API key authorization: apikey
|
|
32
|
+
config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = ElasticEmail::CampaignsApi.new
|
|
38
|
+
name = 'name_example' # String |
|
|
39
|
+
contact_email = 'contact_email_example' # String |
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Trigger Automation for Contact
|
|
43
|
+
api_instance.campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
44
|
+
rescue ElasticEmail::ApiError => e
|
|
45
|
+
puts "Error when calling CampaignsApi->campaigns_automation_by_name_trigger_post: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the campaigns_automation_by_name_trigger_post_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(nil, Integer, Hash)> campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Trigger Automation for Contact
|
|
58
|
+
data, status_code, headers = api_instance.campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => nil
|
|
62
|
+
rescue ElasticEmail::ApiError => e
|
|
63
|
+
puts "Error when calling CampaignsApi->campaigns_automation_by_name_trigger_post_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **name** | **String** | | |
|
|
72
|
+
| **contact_email** | **String** | | |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
nil (empty response body)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[apikey](../README.md#apikey)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: Not defined
|
|
85
|
+
- **Accept**: Not defined
|
|
86
|
+
|
|
87
|
+
|
|
15
88
|
## campaigns_by_name_delete
|
|
16
89
|
|
|
17
90
|
> campaigns_by_name_delete(name)
|
data/docs/DKIMRecord.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ElasticEmail::DKIMRecord
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **selector** | **String** | | [optional] |
|
|
8
|
+
| **public_key** | **String** | | [optional] |
|
|
9
|
+
| **host_name** | **String** | | [optional] |
|
|
10
|
+
| **record_value** | **String** | | [optional] |
|
|
11
|
+
| **domain** | **String** | Name of selected domain. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ElasticEmail'
|
|
17
|
+
|
|
18
|
+
instance = ElasticEmail::DKIMRecord.new(
|
|
19
|
+
selector: null,
|
|
20
|
+
public_key: null,
|
|
21
|
+
host_name: null,
|
|
22
|
+
record_value: null,
|
|
23
|
+
domain: example.com
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/DomainData.md
CHANGED
|
@@ -16,13 +16,16 @@
|
|
|
16
16
|
| **type** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
17
17
|
| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to 'Validated'] |
|
|
18
18
|
| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to 'ErrorOccured'] |
|
|
19
|
+
| **certificate_expiry_date** | **Time** | | [optional] |
|
|
19
20
|
| **certificate_validation_error** | **String** | | [optional] |
|
|
20
21
|
| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
21
22
|
| **verp** | **Boolean** | | [optional] |
|
|
22
23
|
| **custom_bounces_domain** | **String** | | [optional] |
|
|
23
24
|
| **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
|
|
25
|
+
| **was_ever_verified** | **Boolean** | | [optional] |
|
|
24
26
|
| **is_marked_for_deletion** | **Boolean** | | [optional] |
|
|
25
27
|
| **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to 'Current'] |
|
|
28
|
+
| **dkim_record** | [**DKIMRecord**](DKIMRecord.md) | | [optional] |
|
|
26
29
|
|
|
27
30
|
## Example
|
|
28
31
|
|
|
@@ -42,13 +45,16 @@ instance = ElasticEmail::DomainData.new(
|
|
|
42
45
|
type: null,
|
|
43
46
|
tracking_status: null,
|
|
44
47
|
certificate_status: null,
|
|
48
|
+
certificate_expiry_date: null,
|
|
45
49
|
certificate_validation_error: null,
|
|
46
50
|
tracking_type_user_request: null,
|
|
47
51
|
verp: null,
|
|
48
52
|
custom_bounces_domain: null,
|
|
49
53
|
is_custom_bounces_domain_default: null,
|
|
54
|
+
was_ever_verified: null,
|
|
50
55
|
is_marked_for_deletion: null,
|
|
51
|
-
ownership: null
|
|
56
|
+
ownership: null,
|
|
57
|
+
dkim_record: null
|
|
52
58
|
)
|
|
53
59
|
```
|
|
54
60
|
|
data/docs/DomainDetail.md
CHANGED
|
@@ -15,13 +15,16 @@
|
|
|
15
15
|
| **type** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
16
16
|
| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to 'Validated'] |
|
|
17
17
|
| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to 'ErrorOccured'] |
|
|
18
|
+
| **certificate_expiry_date** | **Time** | | [optional] |
|
|
18
19
|
| **certificate_validation_error** | **String** | | [optional] |
|
|
19
20
|
| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
20
21
|
| **verp** | **Boolean** | | [optional] |
|
|
21
22
|
| **custom_bounces_domain** | **String** | | [optional] |
|
|
22
23
|
| **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
|
|
24
|
+
| **was_ever_verified** | **Boolean** | | [optional] |
|
|
23
25
|
| **is_marked_for_deletion** | **Boolean** | | [optional] |
|
|
24
26
|
| **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to 'Current'] |
|
|
27
|
+
| **dkim_record** | [**DKIMRecord**](DKIMRecord.md) | | [optional] |
|
|
25
28
|
|
|
26
29
|
## Example
|
|
27
30
|
|
|
@@ -40,13 +43,16 @@ instance = ElasticEmail::DomainDetail.new(
|
|
|
40
43
|
type: null,
|
|
41
44
|
tracking_status: null,
|
|
42
45
|
certificate_status: null,
|
|
46
|
+
certificate_expiry_date: null,
|
|
43
47
|
certificate_validation_error: null,
|
|
44
48
|
tracking_type_user_request: null,
|
|
45
49
|
verp: null,
|
|
46
50
|
custom_bounces_domain: null,
|
|
47
51
|
is_custom_bounces_domain_default: null,
|
|
52
|
+
was_ever_verified: null,
|
|
48
53
|
is_marked_for_deletion: null,
|
|
49
|
-
ownership: null
|
|
54
|
+
ownership: null,
|
|
55
|
+
dkim_record: null
|
|
50
56
|
)
|
|
51
57
|
```
|
|
52
58
|
|
data/docs/SecurityApi.md
CHANGED
|
@@ -114,7 +114,7 @@ end
|
|
|
114
114
|
api_instance = ElasticEmail::SecurityApi.new
|
|
115
115
|
name = 'name_example' # String | Name of the ApiKey
|
|
116
116
|
opts = {
|
|
117
|
-
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKey should be loaded
|
|
117
|
+
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
|
|
118
118
|
}
|
|
119
119
|
|
|
120
120
|
begin
|
|
@@ -149,7 +149,7 @@ end
|
|
|
149
149
|
| Name | Type | Description | Notes |
|
|
150
150
|
| ---- | ---- | ----------- | ----- |
|
|
151
151
|
| **name** | **String** | Name of the ApiKey | |
|
|
152
|
-
| **subaccount** | **String** | Email of the subaccount of which ApiKey should be loaded | [optional] |
|
|
152
|
+
| **subaccount** | **String** | Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. | [optional] |
|
|
153
153
|
|
|
154
154
|
### Return type
|
|
155
155
|
|
|
@@ -261,7 +261,7 @@ end
|
|
|
261
261
|
|
|
262
262
|
api_instance = ElasticEmail::SecurityApi.new
|
|
263
263
|
opts = {
|
|
264
|
-
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKeys should be loaded
|
|
264
|
+
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
|
|
265
265
|
}
|
|
266
266
|
|
|
267
267
|
begin
|
|
@@ -295,7 +295,7 @@ end
|
|
|
295
295
|
|
|
296
296
|
| Name | Type | Description | Notes |
|
|
297
297
|
| ---- | ---- | ----------- | ----- |
|
|
298
|
-
| **subaccount** | **String** | Email of the subaccount of which ApiKeys should be loaded | [optional] |
|
|
298
|
+
| **subaccount** | **String** | Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. | [optional] |
|
|
299
299
|
|
|
300
300
|
### Return type
|
|
301
301
|
|
data/docs/SubAccountsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**subaccounts_by_email_apikey_get**](SubAccountsApi.md#subaccounts_by_email_apikey_get) | **GET** /subaccounts/{email}/apikey | Get SubAccount ApiKey |
|
|
7
8
|
| [**subaccounts_by_email_credits_patch**](SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits |
|
|
8
9
|
| [**subaccounts_by_email_delete**](SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount |
|
|
9
10
|
| [**subaccounts_by_email_get**](SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount |
|
|
@@ -12,6 +13,77 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
12
13
|
| [**subaccounts_post**](SubAccountsApi.md#subaccounts_post) | **POST** /subaccounts | Add SubAccount |
|
|
13
14
|
|
|
14
15
|
|
|
16
|
+
## subaccounts_by_email_apikey_get
|
|
17
|
+
|
|
18
|
+
> String subaccounts_by_email_apikey_get(email)
|
|
19
|
+
|
|
20
|
+
Get SubAccount ApiKey
|
|
21
|
+
|
|
22
|
+
Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'ElasticEmail'
|
|
29
|
+
# setup authorization
|
|
30
|
+
ElasticEmail.configure do |config|
|
|
31
|
+
# Configure API key authorization: apikey
|
|
32
|
+
config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = ElasticEmail::SubAccountsApi.new
|
|
38
|
+
email = 'mail@example.com' # String | Email address of Sub-Account
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Get SubAccount ApiKey
|
|
42
|
+
result = api_instance.subaccounts_by_email_apikey_get(email)
|
|
43
|
+
p result
|
|
44
|
+
rescue ElasticEmail::ApiError => e
|
|
45
|
+
puts "Error when calling SubAccountsApi->subaccounts_by_email_apikey_get: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the subaccounts_by_email_apikey_get_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(String, Integer, Hash)> subaccounts_by_email_apikey_get_with_http_info(email)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Get SubAccount ApiKey
|
|
58
|
+
data, status_code, headers = api_instance.subaccounts_by_email_apikey_get_with_http_info(email)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => String
|
|
62
|
+
rescue ElasticEmail::ApiError => e
|
|
63
|
+
puts "Error when calling SubAccountsApi->subaccounts_by_email_apikey_get_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **email** | **String** | Email address of Sub-Account | |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
**String**
|
|
76
|
+
|
|
77
|
+
### Authorization
|
|
78
|
+
|
|
79
|
+
[apikey](../README.md#apikey)
|
|
80
|
+
|
|
81
|
+
### HTTP request headers
|
|
82
|
+
|
|
83
|
+
- **Content-Type**: Not defined
|
|
84
|
+
- **Accept**: application/json
|
|
85
|
+
|
|
86
|
+
|
|
15
87
|
## subaccounts_by_email_credits_patch
|
|
16
88
|
|
|
17
89
|
> subaccounts_by_email_credits_patch(email, subaccount_email_credits_payload)
|
|
@@ -379,7 +451,7 @@ end
|
|
|
379
451
|
|
|
380
452
|
Add SubAccount
|
|
381
453
|
|
|
382
|
-
Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts
|
|
454
|
+
Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
383
455
|
|
|
384
456
|
### Examples
|
|
385
457
|
|
|
@@ -19,6 +19,74 @@ module ElasticEmail
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
# Trigger Automation for Contact
|
|
23
|
+
# Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
|
|
24
|
+
# @param name [String]
|
|
25
|
+
# @param contact_email [String]
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @return [nil]
|
|
28
|
+
def campaigns_automation_by_name_trigger_post(name, contact_email, opts = {})
|
|
29
|
+
campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email, opts)
|
|
30
|
+
nil
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Trigger Automation for Contact
|
|
34
|
+
# Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
|
|
35
|
+
# @param name [String]
|
|
36
|
+
# @param contact_email [String]
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
39
|
+
def campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_automation_by_name_trigger_post ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'name' is set
|
|
44
|
+
if @api_client.config.client_side_validation && name.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling CampaignsApi.campaigns_automation_by_name_trigger_post"
|
|
46
|
+
end
|
|
47
|
+
# verify the required parameter 'contact_email' is set
|
|
48
|
+
if @api_client.config.client_side_validation && contact_email.nil?
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'contact_email' when calling CampaignsApi.campaigns_automation_by_name_trigger_post"
|
|
50
|
+
end
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/campaigns/automation/{name}/trigger'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = opts[:query_params] || {}
|
|
56
|
+
query_params[:'contactEmail'] = contact_email
|
|
57
|
+
|
|
58
|
+
# header parameters
|
|
59
|
+
header_params = opts[:header_params] || {}
|
|
60
|
+
|
|
61
|
+
# form parameters
|
|
62
|
+
form_params = opts[:form_params] || {}
|
|
63
|
+
|
|
64
|
+
# http body (model)
|
|
65
|
+
post_body = opts[:debug_body]
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type]
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"CampaignsApi.campaigns_automation_by_name_trigger_post",
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => return_type
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: CampaignsApi#campaigns_automation_by_name_trigger_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
|
|
22
90
|
# Delete Campaign
|
|
23
91
|
# Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
|
|
24
92
|
# @param name [String] Name of Campaign to delete
|
|
@@ -87,7 +87,7 @@ module ElasticEmail
|
|
|
87
87
|
# Load your existing ApiKey info. Required Access Level: ViewAccessTokens
|
|
88
88
|
# @param name [String] Name of the ApiKey
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
|
-
# @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded
|
|
90
|
+
# @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.
|
|
91
91
|
# @return [ApiKey]
|
|
92
92
|
def security_apikeys_by_name_get(name, opts = {})
|
|
93
93
|
data, _status_code, _headers = security_apikeys_by_name_get_with_http_info(name, opts)
|
|
@@ -98,7 +98,7 @@ module ElasticEmail
|
|
|
98
98
|
# Load your existing ApiKey info. Required Access Level: ViewAccessTokens
|
|
99
99
|
# @param name [String] Name of the ApiKey
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
101
|
-
# @option opts [String] :subaccount Email of the subaccount of which ApiKey should be loaded
|
|
101
|
+
# @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.
|
|
102
102
|
# @return [Array<(ApiKey, Integer, Hash)>] ApiKey data, response status code and response headers
|
|
103
103
|
def security_apikeys_by_name_get_with_http_info(name, opts = {})
|
|
104
104
|
if @api_client.config.debugging
|
|
@@ -226,7 +226,7 @@ module ElasticEmail
|
|
|
226
226
|
# List ApiKeys
|
|
227
227
|
# List all your existing ApiKeys. Required Access Level: ViewAccessTokens
|
|
228
228
|
# @param [Hash] opts the optional parameters
|
|
229
|
-
# @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded
|
|
229
|
+
# @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.
|
|
230
230
|
# @return [Array<ApiKey>]
|
|
231
231
|
def security_apikeys_get(opts = {})
|
|
232
232
|
data, _status_code, _headers = security_apikeys_get_with_http_info(opts)
|
|
@@ -236,7 +236,7 @@ module ElasticEmail
|
|
|
236
236
|
# List ApiKeys
|
|
237
237
|
# List all your existing ApiKeys. Required Access Level: ViewAccessTokens
|
|
238
238
|
# @param [Hash] opts the optional parameters
|
|
239
|
-
# @option opts [String] :subaccount Email of the subaccount of which ApiKeys should be loaded
|
|
239
|
+
# @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.
|
|
240
240
|
# @return [Array<(Array<ApiKey>, Integer, Hash)>] Array<ApiKey> data, response status code and response headers
|
|
241
241
|
def security_apikeys_get_with_http_info(opts = {})
|
|
242
242
|
if @api_client.config.debugging
|
|
@@ -19,6 +19,69 @@ module ElasticEmail
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
# Get SubAccount ApiKey
|
|
23
|
+
# Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
24
|
+
# @param email [String] Email address of Sub-Account
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [String]
|
|
27
|
+
def subaccounts_by_email_apikey_get(email, opts = {})
|
|
28
|
+
data, _status_code, _headers = subaccounts_by_email_apikey_get_with_http_info(email, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get SubAccount ApiKey
|
|
33
|
+
# Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
34
|
+
# @param email [String] Email address of Sub-Account
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
37
|
+
def subaccounts_by_email_apikey_get_with_http_info(email, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: SubAccountsApi.subaccounts_by_email_apikey_get ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'email' is set
|
|
42
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling SubAccountsApi.subaccounts_by_email_apikey_get"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/subaccounts/{email}/apikey'.sub('{' + 'email' + '}', CGI.escape(email.to_s))
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = opts[:form_params] || {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = opts[:debug_body]
|
|
61
|
+
|
|
62
|
+
# return_type
|
|
63
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
64
|
+
|
|
65
|
+
# auth_names
|
|
66
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
|
67
|
+
|
|
68
|
+
new_options = opts.merge(
|
|
69
|
+
:operation => :"SubAccountsApi.subaccounts_by_email_apikey_get",
|
|
70
|
+
:header_params => header_params,
|
|
71
|
+
:query_params => query_params,
|
|
72
|
+
:form_params => form_params,
|
|
73
|
+
:body => post_body,
|
|
74
|
+
:auth_names => auth_names,
|
|
75
|
+
:return_type => return_type
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: SubAccountsApi#subaccounts_by_email_apikey_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
22
85
|
# Add, Subtract Email Credits
|
|
23
86
|
# Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
|
|
24
87
|
# @param email [String] Email address of Sub-Account
|
|
@@ -353,7 +416,7 @@ module ElasticEmail
|
|
|
353
416
|
end
|
|
354
417
|
|
|
355
418
|
# Add SubAccount
|
|
356
|
-
# Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts
|
|
419
|
+
# Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
357
420
|
# @param subaccount_payload [SubaccountPayload]
|
|
358
421
|
# @param [Hash] opts the optional parameters
|
|
359
422
|
# @return [SubAccountInfo]
|
|
@@ -363,7 +426,7 @@ module ElasticEmail
|
|
|
363
426
|
end
|
|
364
427
|
|
|
365
428
|
# Add SubAccount
|
|
366
|
-
# Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts
|
|
429
|
+
# Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
367
430
|
# @param subaccount_payload [SubaccountPayload]
|
|
368
431
|
# @param [Hash] opts the optional parameters
|
|
369
432
|
# @return [Array<(SubAccountInfo, Integer, Hash)>] SubAccountInfo data, response status code and response headers
|
|
@@ -19,9 +19,10 @@ module ElasticEmail
|
|
|
19
19
|
CERT_NOT_SET = "CertNotSet".freeze
|
|
20
20
|
VALID = "Valid".freeze
|
|
21
21
|
NOT_VALID = "NotValid".freeze
|
|
22
|
+
IN_PROGRESS = "InProgress".freeze
|
|
22
23
|
|
|
23
24
|
def self.all_vars
|
|
24
|
-
@all_vars ||= [ERROR_OCCURED, CERT_NOT_SET, VALID, NOT_VALID].freeze
|
|
25
|
+
@all_vars ||= [ERROR_OCCURED, CERT_NOT_SET, VALID, NOT_VALID, IN_PROGRESS].freeze
|
|
25
26
|
end
|
|
26
27
|
|
|
27
28
|
# Builds the enum from string
|