ElasticEmail 4.0.1 → 4.0.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +4 -4
  2. data/ElasticEmail.gemspec +3 -3
  3. data/README.md +14 -9
  4. data/VERSION +1 -1
  5. data/docs/ApiKeyPayload.md +2 -2
  6. data/docs/BodyPart.md +1 -1
  7. data/docs/Campaign.md +4 -4
  8. data/docs/CampaignOptions.md +2 -2
  9. data/docs/CampaignTemplate.md +2 -2
  10. data/docs/CampaignsApi.md +2 -2
  11. data/docs/ConsentData.md +1 -1
  12. data/docs/Contact.md +3 -3
  13. data/docs/ContactHistory.md +1 -1
  14. data/docs/ContactPayload.md +2 -2
  15. data/docs/ContactsApi.md +3 -3
  16. data/docs/EmailContent.md +4 -2
  17. data/docs/EmailData.md +2 -2
  18. data/docs/EmailMessageData.md +3 -3
  19. data/docs/EmailRecipient.md +1 -1
  20. data/docs/EmailStatus.md +1 -1
  21. data/docs/EmailTransactionalMessageData.md +3 -3
  22. data/docs/EmailsApi.md +3 -3
  23. data/docs/EmailsPayload.md +2 -2
  24. data/docs/EventsApi.md +7 -7
  25. data/docs/FilePayload.md +1 -1
  26. data/docs/FilesApi.md +1 -1
  27. data/docs/InboundPayload.md +4 -4
  28. data/docs/InboundRoute.md +2 -2
  29. data/docs/InboundRouteApi.md +3 -3
  30. data/docs/ListPayload.md +2 -2
  31. data/docs/ListsApi.md +1 -1
  32. data/docs/MergeEmailPayload.md +3 -3
  33. data/docs/MessageAttachment.md +4 -4
  34. data/docs/NewSmtpCredentials.md +1 -1
  35. data/docs/Options.md +1 -1
  36. data/docs/RecipientEvent.md +2 -2
  37. data/docs/SecurityApi.md +4 -4
  38. data/docs/SegmentPayload.md +2 -2
  39. data/docs/SegmentsApi.md +2 -2
  40. data/docs/SmtpCredentials.md +1 -1
  41. data/docs/SmtpCredentialsPayload.md +1 -1
  42. data/docs/SortOrderItem.md +2 -2
  43. data/docs/SplitOptions.md +1 -1
  44. data/docs/SubAccountInfo.md +2 -2
  45. data/docs/SubAccountsApi.md +2 -2
  46. data/docs/SubaccountEmailCreditsPayload.md +1 -1
  47. data/docs/SubaccountPayload.md +3 -3
  48. data/docs/SubaccountSettingsInfo.md +1 -1
  49. data/docs/SubaccountSettingsInfoPayload.md +1 -1
  50. data/docs/Template.md +2 -2
  51. data/docs/TemplatePayload.md +2 -2
  52. data/docs/TemplateScope.md +15 -0
  53. data/docs/TemplatesApi.md +4 -4
  54. data/docs/TransactionalRecipient.md +1 -1
  55. data/docs/VerificationFileResult.md +2 -2
  56. data/docs/VerificationFileResultDetails.md +2 -2
  57. data/docs/VerificationsApi.md +80 -9
  58. data/lib/ElasticEmail/api/campaigns_api.rb +10 -4
  59. data/lib/ElasticEmail/api/contacts_api.rb +20 -8
  60. data/lib/ElasticEmail/api/emails_api.rb +14 -5
  61. data/lib/ElasticEmail/api/events_api.rb +9 -9
  62. data/lib/ElasticEmail/api/files_api.rb +6 -3
  63. data/lib/ElasticEmail/api/inbound_route_api.rb +14 -5
  64. data/lib/ElasticEmail/api/lists_api.rb +18 -6
  65. data/lib/ElasticEmail/api/security_api.rb +18 -6
  66. data/lib/ElasticEmail/api/segments_api.rb +10 -4
  67. data/lib/ElasticEmail/api/statistics_api.rb +2 -2
  68. data/lib/ElasticEmail/api/sub_accounts_api.rb +14 -5
  69. data/lib/ElasticEmail/api/suppressions_api.rb +26 -8
  70. data/lib/ElasticEmail/api/templates_api.rb +12 -6
  71. data/lib/ElasticEmail/api/verifications_api.rb +73 -9
  72. data/lib/ElasticEmail/api_client.rb +5 -5
  73. data/lib/ElasticEmail/api_error.rb +2 -2
  74. data/lib/ElasticEmail/configuration.rb +4 -3
  75. data/lib/ElasticEmail/models/access_level.rb +5 -2
  76. data/lib/ElasticEmail/models/account_status_enum.rb +2 -2
  77. data/lib/ElasticEmail/models/api_key.rb +2 -2
  78. data/lib/ElasticEmail/models/api_key_payload.rb +12 -2
  79. data/lib/ElasticEmail/models/body_content_type.rb +2 -2
  80. data/lib/ElasticEmail/models/body_part.rb +9 -3
  81. data/lib/ElasticEmail/models/campaign.rb +14 -5
  82. data/lib/ElasticEmail/models/campaign_options.rb +4 -4
  83. data/lib/ElasticEmail/models/campaign_recipient.rb +2 -2
  84. data/lib/ElasticEmail/models/campaign_status.rb +2 -2
  85. data/lib/ElasticEmail/models/campaign_template.rb +2 -3
  86. data/lib/ElasticEmail/models/channel_log_status_summary.rb +2 -2
  87. data/lib/ElasticEmail/models/compression_format.rb +2 -2
  88. data/lib/ElasticEmail/models/consent_data.rb +4 -3
  89. data/lib/ElasticEmail/models/consent_tracking.rb +2 -2
  90. data/lib/ElasticEmail/models/contact.rb +6 -5
  91. data/lib/ElasticEmail/models/contact_activity.rb +2 -2
  92. data/lib/ElasticEmail/models/contact_hist_event_type.rb +2 -2
  93. data/lib/ElasticEmail/models/contact_history.rb +4 -3
  94. data/lib/ElasticEmail/models/contact_payload.rb +9 -3
  95. data/lib/ElasticEmail/models/contact_source.rb +2 -2
  96. data/lib/ElasticEmail/models/contact_status.rb +2 -2
  97. data/lib/ElasticEmail/models/contact_update_payload.rb +2 -2
  98. data/lib/ElasticEmail/models/contacts_list.rb +2 -2
  99. data/lib/ElasticEmail/models/delivery_optimization_type.rb +2 -2
  100. data/lib/ElasticEmail/models/email_content.rb +13 -4
  101. data/lib/ElasticEmail/models/email_data.rb +2 -4
  102. data/lib/ElasticEmail/models/email_message_data.rb +8 -5
  103. data/lib/ElasticEmail/models/email_recipient.rb +8 -3
  104. data/lib/ElasticEmail/models/email_send.rb +2 -2
  105. data/lib/ElasticEmail/models/email_status.rb +4 -3
  106. data/lib/ElasticEmail/models/email_transactional_message_data.rb +7 -5
  107. data/lib/ElasticEmail/models/email_validation_result.rb +2 -2
  108. data/lib/ElasticEmail/models/email_validation_status.rb +2 -2
  109. data/lib/ElasticEmail/models/email_view.rb +2 -2
  110. data/lib/ElasticEmail/models/emails_payload.rb +3 -3
  111. data/lib/ElasticEmail/models/encoding_type.rb +2 -2
  112. data/lib/ElasticEmail/models/event_type.rb +2 -2
  113. data/lib/ElasticEmail/models/events_order_by.rb +2 -2
  114. data/lib/ElasticEmail/models/export_file_formats.rb +2 -2
  115. data/lib/ElasticEmail/models/export_link.rb +2 -2
  116. data/lib/ElasticEmail/models/export_status.rb +2 -2
  117. data/lib/ElasticEmail/models/file_info.rb +2 -2
  118. data/lib/ElasticEmail/models/file_payload.rb +7 -2
  119. data/lib/ElasticEmail/models/file_upload_result.rb +2 -2
  120. data/lib/ElasticEmail/models/inbound_payload.rb +26 -4
  121. data/lib/ElasticEmail/models/inbound_route.rb +6 -4
  122. data/lib/ElasticEmail/models/inbound_route_action_type.rb +2 -2
  123. data/lib/ElasticEmail/models/inbound_route_filter_type.rb +2 -2
  124. data/lib/ElasticEmail/models/list_payload.rb +8 -3
  125. data/lib/ElasticEmail/models/list_update_payload.rb +2 -2
  126. data/lib/ElasticEmail/models/log_job_status.rb +2 -2
  127. data/lib/ElasticEmail/models/log_status_summary.rb +2 -2
  128. data/lib/ElasticEmail/models/merge_email_payload.rb +7 -5
  129. data/lib/ElasticEmail/models/message_attachment.rb +10 -3
  130. data/lib/ElasticEmail/models/message_category.rb +2 -2
  131. data/lib/ElasticEmail/models/new_api_key.rb +2 -2
  132. data/lib/ElasticEmail/models/new_smtp_credentials.rb +4 -3
  133. data/lib/ElasticEmail/models/options.rb +4 -3
  134. data/lib/ElasticEmail/models/recipient_event.rb +6 -4
  135. data/lib/ElasticEmail/models/segment.rb +2 -2
  136. data/lib/ElasticEmail/models/segment_payload.rb +12 -2
  137. data/lib/ElasticEmail/models/smtp_credentials.rb +4 -3
  138. data/lib/ElasticEmail/models/smtp_credentials_payload.rb +7 -2
  139. data/lib/ElasticEmail/models/sort_order_item.rb +13 -2
  140. data/lib/ElasticEmail/models/split_optimization_type.rb +2 -2
  141. data/lib/ElasticEmail/models/split_options.rb +4 -3
  142. data/lib/ElasticEmail/models/sub_account_info.rb +4 -4
  143. data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +7 -2
  144. data/lib/ElasticEmail/models/subaccount_email_settings.rb +2 -2
  145. data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +2 -2
  146. data/lib/ElasticEmail/models/subaccount_payload.rb +12 -3
  147. data/lib/ElasticEmail/models/subaccount_settings_info.rb +2 -3
  148. data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +2 -3
  149. data/lib/ElasticEmail/models/suppression.rb +2 -2
  150. data/lib/ElasticEmail/models/template.rb +7 -5
  151. data/lib/ElasticEmail/models/template_payload.rb +10 -4
  152. data/lib/ElasticEmail/models/template_scope.rb +37 -0
  153. data/lib/ElasticEmail/models/template_type.rb +2 -2
  154. data/lib/ElasticEmail/models/transactional_recipient.rb +7 -2
  155. data/lib/ElasticEmail/models/utm.rb +2 -2
  156. data/lib/ElasticEmail/models/verification_file_result.rb +4 -4
  157. data/lib/ElasticEmail/models/verification_file_result_details.rb +4 -4
  158. data/lib/ElasticEmail/models/verification_status.rb +2 -2
  159. data/lib/ElasticEmail/version.rb +3 -3
  160. data/lib/ElasticEmail.rb +3 -3
  161. data/spec/api_client_spec.rb +4 -4
  162. data/spec/configuration_spec.rb +2 -2
  163. data/spec/models/template_scope_spec.rb +28 -0
  164. data/spec/spec_helper.rb +2 -2
  165. metadata +92 -86
  166. data/DIFF +0 -0
data/docs/Options.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **time_offset** | **Integer** | By how long should an e-mail be delayed (in minutes). Maximum is 35 days. | [optional] |
8
8
  | **pool_name** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
9
9
  | **channel_name** | **String** | Name of selected channel. | [optional] |
10
- | **encoding** | [**EncodingType**](EncodingType.md) | 0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as \"Raw7Bit\" for value 1. NOTE: Base64 or QuotedPrintable is recommended if you are validating your domain(s) with DKIM. | [optional] |
10
+ | **encoding** | [**EncodingType**](EncodingType.md) | | [optional][default to 'UserProvided'] |
11
11
  | **track_opens** | **Boolean** | Should the opens be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
12
12
  | **track_clicks** | **Boolean** | Should the clicks be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
13
13
 
@@ -9,10 +9,10 @@
9
9
  | **from_email** | **String** | Default From: email address. | [optional] |
10
10
  | **to** | **String** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
11
11
  | **subject** | **String** | Default subject of email. | [optional] |
12
- | **event_type** | [**EventType**](EventType.md) | Type of an Event | [optional] |
12
+ | **event_type** | [**EventType**](EventType.md) | | [optional][default to 'Submission'] |
13
13
  | **event_date** | **Time** | Creation date | [optional] |
14
14
  | **channel_name** | **String** | Name of selected channel. | [optional] |
15
- | **message_category** | [**MessageCategory**](MessageCategory.md) | Message category | [optional] |
15
+ | **message_category** | [**MessageCategory**](MessageCategory.md) | | [optional][default to 'Unknown'] |
16
16
  | **next_try_on** | **Time** | Date of next try | [optional] |
17
17
  | **message** | **String** | Content of message, HTML encoded | [optional] |
18
18
  | **ip_address** | **String** | IP which this email was sent through | [optional] |
data/docs/SecurityApi.md CHANGED
@@ -188,7 +188,7 @@ end
188
188
 
189
189
  api_instance = ElasticEmail::SecurityApi.new
190
190
  name = 'name_example' # String | Name of the ApiKey
191
- api_key_payload = ElasticEmail::ApiKeyPayload.new # ApiKeyPayload |
191
+ api_key_payload = ElasticEmail::ApiKeyPayload.new({name: 'name_example', access_level: [ElasticEmail::AccessLevel::NONE]}) # ApiKeyPayload |
192
192
 
193
193
  begin
194
194
  # Update ApiKey
@@ -333,7 +333,7 @@ ElasticEmail.configure do |config|
333
333
  end
334
334
 
335
335
  api_instance = ElasticEmail::SecurityApi.new
336
- api_key_payload = ElasticEmail::ApiKeyPayload.new # ApiKeyPayload |
336
+ api_key_payload = ElasticEmail::ApiKeyPayload.new({name: 'name_example', access_level: [ElasticEmail::AccessLevel::NONE]}) # ApiKeyPayload |
337
337
 
338
338
  begin
339
339
  # Add ApiKey
@@ -554,7 +554,7 @@ end
554
554
 
555
555
  api_instance = ElasticEmail::SecurityApi.new
556
556
  name = 'name_example' # String | Name of the SMTP Credential
557
- smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new # SmtpCredentialsPayload |
557
+ smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new({name: 'name_example'}) # SmtpCredentialsPayload |
558
558
 
559
559
  begin
560
560
  # Update SMTP Credential
@@ -699,7 +699,7 @@ ElasticEmail.configure do |config|
699
699
  end
700
700
 
701
701
  api_instance = ElasticEmail::SecurityApi.new
702
- smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new # SmtpCredentialsPayload |
702
+ smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new({name: 'name_example'}) # SmtpCredentialsPayload |
703
703
 
704
704
  begin
705
705
  # Add SMTP Credential
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Segment name | [optional] |
8
- | **rule** | **String** | SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules | [optional] |
7
+ | **name** | **String** | Segment name | |
8
+ | **rule** | **String** | SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules | |
9
9
 
10
10
  ## Example
11
11
 
data/docs/SegmentsApi.md CHANGED
@@ -175,7 +175,7 @@ end
175
175
 
176
176
  api_instance = ElasticEmail::SegmentsApi.new
177
177
  name = 'My Segment 1' # String | Name of your segment.
178
- segment_payload = ElasticEmail::SegmentPayload.new # SegmentPayload |
178
+ segment_payload = ElasticEmail::SegmentPayload.new({name: 'name_example', rule: 'rule_example'}) # SegmentPayload |
179
179
 
180
180
  begin
181
181
  # Update Segment
@@ -322,7 +322,7 @@ ElasticEmail.configure do |config|
322
322
  end
323
323
 
324
324
  api_instance = ElasticEmail::SegmentsApi.new
325
- segment_payload = ElasticEmail::SegmentPayload.new # SegmentPayload |
325
+ segment_payload = ElasticEmail::SegmentPayload.new({name: 'name_example', rule: 'rule_example'}) # SegmentPayload |
326
326
 
327
327
  begin
328
328
  # Add Segment
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **access_level** | [**AccessLevel**](AccessLevel.md) | Access level of this Smtp Credential. | [optional] |
7
+ | **access_level** | [**AccessLevel**](AccessLevel.md) | | [optional][default to 'None'] |
8
8
  | **name** | **String** | Name of the key. | [optional] |
9
9
  | **date_created** | **Time** | Date this SmtpCredential was created. | [optional] |
10
10
  | **last_use** | **Time** | Date this SmtpCredential was last used. | [optional] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Name of the Credential for ease of reference. It must be a valid email address. | [optional] |
7
+ | **name** | **String** | Name of the Credential for ease of reference. It must be a valid email address. | |
8
8
  | **expires** | **Time** | Date this SmtpCredential expires. | [optional] |
9
9
  | **restrict_access_to_ip_range** | **Array<String>** | Which IPs can use this SmtpCredential | [optional] |
10
10
  | **subaccount** | **String** | Email of the subaccount for which this SmtpCredential should be created | [optional] |
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **public_inbound_id** | **String** | | [optional] |
8
- | **sort_order** | **Integer** | 1 - route will be used first | [optional] |
7
+ | **public_inbound_id** | **String** | ID of the route to change the order of | |
8
+ | **sort_order** | **Integer** | 1 - route will be used first | |
9
9
 
10
10
  ## Example
11
11
 
data/docs/SplitOptions.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **optimize_for** | [**SplitOptimizationType**](SplitOptimizationType.md) | Type of results by which to determine the winner template (content) | [optional] |
7
+ | **optimize_for** | [**SplitOptimizationType**](SplitOptimizationType.md) | | [optional][default to 'Opens'] |
8
8
  | **optimize_period_minutes** | **Integer** | For how long should the results be measured until determining the winner template (content) | [optional] |
9
9
 
10
10
  ## Example
@@ -6,12 +6,12 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **public_account_id** | **String** | Public key for limited access to your Account such as contact/add so you can use it safely on public websites. | [optional] |
8
8
  | **email** | **String** | Proper email address. | [optional] |
9
- | **settings** | [**SubaccountSettingsInfo**](SubaccountSettingsInfo.md) | SubAccount settings | [optional] |
9
+ | **settings** | [**SubaccountSettingsInfo**](SubaccountSettingsInfo.md) | | [optional] |
10
10
  | **last_activity** | **Time** | Date of last activity on Account | [optional] |
11
11
  | **email_credits** | **Integer** | Amount of email credits | [optional] |
12
12
  | **total_emails_sent** | **Integer** | Amount of emails sent from this Account | [optional] |
13
13
  | **reputation** | **Float** | Numeric reputation | [optional] |
14
- | **status** | [**AccountStatusEnum**](AccountStatusEnum.md) | Account's current status. | [optional] |
14
+ | **status** | [**AccountStatusEnum**](AccountStatusEnum.md) | | [optional][default to 'Disabled'] |
15
15
  | **contacts_count** | **Integer** | How many contacts this SubAccount has stored | [optional] |
16
16
 
17
17
  ## Example
@@ -35,7 +35,7 @@ end
35
35
 
36
36
  api_instance = ElasticEmail::SubAccountsApi.new
37
37
  email = 'mail@example.com' # String | Email address of Sub-Account
38
- subaccount_email_credits_payload = ElasticEmail::SubaccountEmailCreditsPayload.new # SubaccountEmailCreditsPayload | Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
38
+ subaccount_email_credits_payload = ElasticEmail::SubaccountEmailCreditsPayload.new({credits: 37}) # SubaccountEmailCreditsPayload | Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
39
39
 
40
40
  begin
41
41
  # Add, Subtract Email Credits
@@ -395,7 +395,7 @@ ElasticEmail.configure do |config|
395
395
  end
396
396
 
397
397
  api_instance = ElasticEmail::SubAccountsApi.new
398
- subaccount_payload = ElasticEmail::SubaccountPayload.new # SubaccountPayload |
398
+ subaccount_payload = ElasticEmail::SubaccountPayload.new({email: 'mail@example.com', password: '********'}) # SubaccountPayload |
399
399
 
400
400
  begin
401
401
  # Add SubAccount
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **credits** | **Integer** | Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool. | [optional] |
7
+ | **credits** | **Integer** | Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool. | |
8
8
  | **notes** | **String** | Note to append to this credits change, for history. | [optional] |
9
9
 
10
10
  ## Example
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | Proper email address. | [optional] |
8
- | **password** | **String** | Current password. | [optional] |
7
+ | **email** | **String** | Proper email address. | |
8
+ | **password** | **String** | Current password. | |
9
9
  | **send_activation** | **Boolean** | True, if you want to send activation email to this Account to confirm the creation of a new SubAccount. Otherwise, false (SubAccount will immediately be Active). | [optional] |
10
- | **settings** | [**SubaccountSettingsInfoPayload**](SubaccountSettingsInfoPayload.md) | SubAccount settings | [optional] |
10
+ | **settings** | [**SubaccountSettingsInfoPayload**](SubaccountSettingsInfoPayload.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | [**SubaccountEmailSettings**](SubaccountEmailSettings.md) | Settings related to sending emails | [optional] |
7
+ | **email** | [**SubaccountEmailSettings**](SubaccountEmailSettings.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | [**SubaccountEmailSettingsPayload**](SubaccountEmailSettingsPayload.md) | Settings related to sending emails | [optional] |
7
+ | **email** | [**SubaccountEmailSettingsPayload**](SubaccountEmailSettingsPayload.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
data/docs/Template.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **template_type** | [**TemplateType**](TemplateType.md) | How the template should be edited | [optional] |
7
+ | **template_type** | [**TemplateType**](TemplateType.md) | | [optional][default to 'RawHTML'] |
8
8
  | **name** | **String** | Template name | [optional] |
9
9
  | **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
10
10
  | **subject** | **String** | Default subject of email. | [optional] |
11
11
  | **body** | [**Array<BodyPart>**](BodyPart.md) | Email content of this template | [optional] |
12
- | **template_scope** | [**TemplateScopeType**](TemplateScopeType.md) | Visibility of a template | [optional] |
12
+ | **template_scope** | [**TemplateScope**](TemplateScope.md) | | [optional][default to 'Personal'] |
13
13
 
14
14
  ## Example
15
15
 
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Template name | [optional] |
7
+ | **name** | **String** | Template name | |
8
8
  | **subject** | **String** | Default subject of email. | [optional] |
9
9
  | **body** | [**Array<BodyPart>**](BodyPart.md) | Email content of this template | [optional] |
10
- | **template_scope** | [**TemplateScopeType**](TemplateScopeType.md) | Visibility of a template | [optional] |
10
+ | **template_scope** | [**TemplateScope**](TemplateScope.md) | | [optional][default to 'Personal'] |
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,15 @@
1
+ # ElasticEmail::TemplateScope
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'ElasticEmail'
12
+
13
+ instance = ElasticEmail::TemplateScope.new()
14
+ ```
15
+
data/docs/TemplatesApi.md CHANGED
@@ -175,7 +175,7 @@ end
175
175
 
176
176
  api_instance = ElasticEmail::TemplatesApi.new
177
177
  name = 'Template01' # String | Name of template.
178
- template_payload = ElasticEmail::TemplatePayload.new # TemplatePayload |
178
+ template_payload = ElasticEmail::TemplatePayload.new({name: 'name_example'}) # TemplatePayload |
179
179
 
180
180
  begin
181
181
  # Update Template
@@ -247,7 +247,7 @@ ElasticEmail.configure do |config|
247
247
  end
248
248
 
249
249
  api_instance = ElasticEmail::TemplatesApi.new
250
- scope_type = [ElasticEmail::TemplateScopeType::PERSONAL] # Array<TemplateScopeType> | Return templates with specified scope only
250
+ scope_type = [ElasticEmail::TemplateScope::PERSONAL] # Array<TemplateScope> | Return templates with specified scope only
251
251
  opts = {
252
252
  template_types: [ElasticEmail::TemplateType::RAW_HTML], # Array<TemplateType> | Return templates with specified type only
253
253
  limit: 100, # Integer | Maximum number of returned items.
@@ -285,7 +285,7 @@ end
285
285
 
286
286
  | Name | Type | Description | Notes |
287
287
  | ---- | ---- | ----------- | ----- |
288
- | **scope_type** | [**Array&lt;TemplateScopeType&gt;**](TemplateScopeType.md) | Return templates with specified scope only | |
288
+ | **scope_type** | [**Array&lt;TemplateScope&gt;**](TemplateScope.md) | Return templates with specified scope only | |
289
289
  | **template_types** | [**Array&lt;TemplateType&gt;**](TemplateType.md) | Return templates with specified type only | [optional] |
290
290
  | **limit** | **Integer** | Maximum number of returned items. | [optional] |
291
291
  | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
@@ -326,7 +326,7 @@ ElasticEmail.configure do |config|
326
326
  end
327
327
 
328
328
  api_instance = ElasticEmail::TemplatesApi.new
329
- template_payload = ElasticEmail::TemplatePayload.new # TemplatePayload |
329
+ template_payload = ElasticEmail::TemplatePayload.new({name: 'name_example'}) # TemplatePayload |
330
330
 
331
331
  begin
332
332
  # Add Template
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **to** | **Array&lt;String&gt;** | List of recipients (visible to others) | [optional] |
7
+ | **to** | **Array&lt;String&gt;** | List of recipients (visible to others) | |
8
8
  | **cc** | **Array&lt;String&gt;** | List of Carbon Copy recipients (visible to others) | [optional] |
9
9
  | **bcc** | **Array&lt;String&gt;** | List of Blind Carbon Copy recipients (hidden from other recipients) | [optional] |
10
10
 
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **verification_id** | **String** | Identifier of this verification result | [optional] |
8
8
  | **filename** | **String** | Origin file name | [optional] |
9
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | In what state does this verification result currently is | [optional] |
10
- | **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | How many emails were detected in the file for verification | [optional] |
9
+ | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | [optional][default to &#39;Processing&#39;] |
10
+ | **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | | [optional] |
11
11
  | **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
12
12
  | **source** | **String** | Origin file extension | [optional] |
13
13
 
@@ -7,8 +7,8 @@
7
7
  | **verification_result** | [**Array&lt;EmailValidationResult&gt;**](EmailValidationResult.md) | Verification result&#39;s details | [optional] |
8
8
  | **verification_id** | **String** | Identifier of this verification result | [optional] |
9
9
  | **filename** | **String** | Origin file name | [optional] |
10
- | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | In what state does this verification result currently is | [optional] |
11
- | **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | How many emails were detected in the file for verification | [optional] |
10
+ | **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | [optional][default to &#39;Processing&#39;] |
11
+ | **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | | [optional] |
12
12
  | **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
13
13
  | **source** | **String** | Origin file extension | [optional] |
14
14
 
@@ -10,8 +10,9 @@ All URIs are relative to *https://api.elasticemail.com/v4*
10
10
  | [**verifications_files_by_id_delete**](VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result |
11
11
  | [**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 |
12
12
  | [**verifications_files_by_id_result_get**](VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result |
13
- | [**verifications_files_post**](VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Verify From File |
14
- | [**verifications_files_result_get**](VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Simple Files Verification Results |
13
+ | [**verifications_files_by_id_verification_post**](VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification |
14
+ | [**verifications_files_post**](VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails |
15
+ | [**verifications_files_result_get**](VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results |
15
16
  | [**verifications_get**](VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results |
16
17
 
17
18
 
@@ -445,13 +446,83 @@ end
445
446
  - **Accept**: application/json
446
447
 
447
448
 
449
+ ## verifications_files_by_id_verification_post
450
+
451
+ > verifications_files_by_id_verification_post(id)
452
+
453
+ Start verification
454
+
455
+ Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails
456
+
457
+ ### Examples
458
+
459
+ ```ruby
460
+ require 'time'
461
+ require 'ElasticEmail'
462
+ # setup authorization
463
+ ElasticEmail.configure do |config|
464
+ # Configure API key authorization: apikey
465
+ config.api_key['apikey'] = 'YOUR API KEY'
466
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
467
+ # config.api_key_prefix['apikey'] = 'Bearer'
468
+ end
469
+
470
+ api_instance = ElasticEmail::VerificationsApi.new
471
+ id = 'id_example' # String | File ID to start verification
472
+
473
+ begin
474
+ # Start verification
475
+ api_instance.verifications_files_by_id_verification_post(id)
476
+ rescue ElasticEmail::ApiError => e
477
+ puts "Error when calling VerificationsApi->verifications_files_by_id_verification_post: #{e}"
478
+ end
479
+ ```
480
+
481
+ #### Using the verifications_files_by_id_verification_post_with_http_info variant
482
+
483
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
484
+
485
+ > <Array(nil, Integer, Hash)> verifications_files_by_id_verification_post_with_http_info(id)
486
+
487
+ ```ruby
488
+ begin
489
+ # Start verification
490
+ data, status_code, headers = api_instance.verifications_files_by_id_verification_post_with_http_info(id)
491
+ p status_code # => 2xx
492
+ p headers # => { ... }
493
+ p data # => nil
494
+ rescue ElasticEmail::ApiError => e
495
+ puts "Error when calling VerificationsApi->verifications_files_by_id_verification_post_with_http_info: #{e}"
496
+ end
497
+ ```
498
+
499
+ ### Parameters
500
+
501
+ | Name | Type | Description | Notes |
502
+ | ---- | ---- | ----------- | ----- |
503
+ | **id** | **String** | File ID to start verification | |
504
+
505
+ ### Return type
506
+
507
+ nil (empty response body)
508
+
509
+ ### Authorization
510
+
511
+ [apikey](../README.md#apikey)
512
+
513
+ ### HTTP request headers
514
+
515
+ - **Content-Type**: Not defined
516
+ - **Accept**: Not defined
517
+
518
+
448
519
  ## verifications_files_post
449
520
 
450
521
  > <VerificationFileResult> verifications_files_post(opts)
451
522
 
452
- Verify From File
523
+ Upload File with Emails
453
524
 
454
- Uploads a CSV file with list of emails to verify. An 'email' column is required. Required Access Level: VerifyEmails
525
+ Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails
455
526
 
456
527
  ### Examples
457
528
 
@@ -472,7 +543,7 @@ opts = {
472
543
  }
473
544
 
474
545
  begin
475
- # Verify From File
546
+ # Upload File with Emails
476
547
  result = api_instance.verifications_files_post(opts)
477
548
  p result
478
549
  rescue ElasticEmail::ApiError => e
@@ -488,7 +559,7 @@ This returns an Array which contains the response data, status code and headers.
488
559
 
489
560
  ```ruby
490
561
  begin
491
- # Verify From File
562
+ # Upload File with Emails
492
563
  data, status_code, headers = api_instance.verifications_files_post_with_http_info(opts)
493
564
  p status_code # => 2xx
494
565
  p headers # => { ... }
@@ -522,7 +593,7 @@ end
522
593
 
523
594
  > <Array<VerificationFileResult>> verifications_files_result_get
524
595
 
525
- Get Simple Files Verification Results
596
+ Get Files Verification Results
526
597
 
527
598
  Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
528
599
 
@@ -542,7 +613,7 @@ end
542
613
  api_instance = ElasticEmail::VerificationsApi.new
543
614
 
544
615
  begin
545
- # Get Simple Files Verification Results
616
+ # Get Files Verification Results
546
617
  result = api_instance.verifications_files_result_get
547
618
  p result
548
619
  rescue ElasticEmail::ApiError => e
@@ -558,7 +629,7 @@ This returns an Array which contains the response data, status code and headers.
558
629
 
559
630
  ```ruby
560
631
  begin
561
- # Get Simple Files Verification Results
632
+ # Get Files Verification Results
562
633
  data, status_code, headers = api_instance.verifications_files_result_get_with_http_info
563
634
  p status_code # => 2xx
564
635
  p 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. To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
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/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>. 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: 5.0.1
9
+ OpenAPI Generator version: 5.3.0
10
10
 
11
11
  =end
12
12
 
@@ -183,7 +183,10 @@ module ElasticEmail
183
183
  # HTTP header 'Accept' (if needed)
184
184
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
185
185
  # HTTP header 'Content-Type'
186
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
186
+ content_type = @api_client.select_header_content_type(['application/json'])
187
+ if !content_type.nil?
188
+ header_params['Content-Type'] = content_type
189
+ end
187
190
 
188
191
  # form parameters
189
192
  form_params = opts[:form_params] || {}
@@ -314,7 +317,10 @@ module ElasticEmail
314
317
  # HTTP header 'Accept' (if needed)
315
318
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
316
319
  # HTTP header 'Content-Type'
317
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
320
+ content_type = @api_client.select_header_content_type(['application/json'])
321
+ if !content_type.nil?
322
+ header_params['Content-Type'] = content_type
323
+ end
318
324
 
319
325
  # form parameters
320
326
  form_params = opts[:form_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. To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
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/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>. 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: 5.0.1
9
+ OpenAPI Generator version: 5.3.0
10
10
 
11
11
  =end
12
12
 
@@ -252,7 +252,10 @@ module ElasticEmail
252
252
  # HTTP header 'Accept' (if needed)
253
253
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
254
254
  # HTTP header 'Content-Type'
255
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
255
+ content_type = @api_client.select_header_content_type(['application/json'])
256
+ if !content_type.nil?
257
+ header_params['Content-Type'] = content_type
258
+ end
256
259
 
257
260
  # form parameters
258
261
  form_params = opts[:form_params] || {}
@@ -315,7 +318,10 @@ module ElasticEmail
315
318
  # header parameters
316
319
  header_params = opts[:header_params] || {}
317
320
  # HTTP header 'Content-Type'
318
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
321
+ content_type = @api_client.select_header_content_type(['application/json'])
322
+ if !content_type.nil?
323
+ header_params['Content-Type'] = content_type
324
+ end
319
325
 
320
326
  # form parameters
321
327
  form_params = opts[:form_params] || {}
@@ -412,10 +418,10 @@ module ElasticEmail
412
418
  # Export Contacts
413
419
  # Request an Export of specified Contacts. Required Access Level: Export
414
420
  # @param [Hash] opts the optional parameters
415
- # @option opts [ExportFileFormats] :file_format Format of the exported file
421
+ # @option opts [ExportFileFormats] :file_format Format of the exported file (default to 'Csv')
416
422
  # @option opts [String] :rule Query used for filtering.
417
423
  # @option opts [Array<String>] :emails Comma delimited list of contact emails
418
- # @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
424
+ # @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip. (default to 'None')
419
425
  # @option opts [String] :file_name Name of your file including extension.
420
426
  # @return [ExportLink]
421
427
  def contacts_export_post(opts = {})
@@ -578,7 +584,10 @@ module ElasticEmail
578
584
  # header parameters
579
585
  header_params = opts[:header_params] || {}
580
586
  # HTTP header 'Content-Type'
581
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
587
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
588
+ if !content_type.nil?
589
+ header_params['Content-Type'] = content_type
590
+ end
582
591
 
583
592
  # form parameters
584
593
  form_params = opts[:form_params] || {}
@@ -647,7 +656,10 @@ module ElasticEmail
647
656
  # HTTP header 'Accept' (if needed)
648
657
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
649
658
  # HTTP header 'Content-Type'
650
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
659
+ content_type = @api_client.select_header_content_type(['application/json'])
660
+ if !content_type.nil?
661
+ header_params['Content-Type'] = content_type
662
+ end
651
663
 
652
664
  # form parameters
653
665
  form_params = opts[:form_params] || {}