ElasticEmail 4.0.27 → 4.0.28

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d7e71de54d22cf1753a4cac85b7bbb4d83f8b4c740e69269ed81795a4531d9e9
4
- data.tar.gz: 614657b0af2ae8dae76193fbd7f104304a5c3f71332a65cce0cabfbd27eefbaa
3
+ metadata.gz: e62f0b1b13023e18752bd255549a6ed57a6696c867cadacce6b6934e36782251
4
+ data.tar.gz: 6e98527a3efca72133724469ac03147c015275d792ce4d64e8d66bfe54c44d96
5
5
  SHA512:
6
- metadata.gz: 52bad164c737bf16c465a465f62127c6241cd97ae447c93cd51a38f1953f42fdd31018522a1bfedad7dee1d56bfb6c24d416fc69de4c2e538a5031c9399704fa
7
- data.tar.gz: 37b6a9297145a369cfa3c7f7ea1185929972d31d06716b74d5d24adff6dccb928756cff8343894bae0fbeb449b5ac57adea884bc483865dab274d088cacb92ed
6
+ metadata.gz: 8637f66b8c672b0c261a9be380208e7387959cb1ee47180b1c8dfebf339d14e20bde42206bb64582c9742c9060e6425e6bb7d3455ae0246adda5923a6e4c362d
7
+ data.tar.gz: 390be93f769ca81486e1280dd58163e24e9ae2e62b63426a8b143d969d90989219a9814d0d749b23da87f66497243b935b75dc587f603fb945a211cd0242bf1f
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.27
18
+ - Package version: 4.0.28
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.27.gem
35
+ gem install ./ElasticEmail-4.0.28.gem
36
36
  ```
37
37
 
38
- (for development, run `gem install --dev ./ElasticEmail-4.0.27.gem` to install the development dependencies)
38
+ (for development, run `gem install --dev ./ElasticEmail-4.0.28.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.27'
44
+ gem 'ElasticEmail', '~> 4.0.28'
45
45
 
46
46
  ### Install from Git
47
47
 
@@ -198,6 +198,11 @@ Class | Method | HTTP request | Description
198
198
  *ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails
199
199
  *ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results
200
200
  *ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results
201
+ *ElasticEmail::WebhookApi* | [**webhook_by_publicid_delete**](docs/WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook
202
+ *ElasticEmail::WebhookApi* | [**webhook_by_publicid_get**](docs/WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook
203
+ *ElasticEmail::WebhookApi* | [**webhook_by_publicid_put**](docs/WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook
204
+ *ElasticEmail::WebhookApi* | [**webhook_get**](docs/WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks
205
+ *ElasticEmail::WebhookApi* | [**webhook_post**](docs/WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook
201
206
 
202
207
 
203
208
  ## Documentation for Models
@@ -296,6 +301,9 @@ Class | Method | HTTP request | Description
296
301
  - [ElasticEmail::VerificationFileResult](docs/VerificationFileResult.md)
297
302
  - [ElasticEmail::VerificationFileResultDetails](docs/VerificationFileResultDetails.md)
298
303
  - [ElasticEmail::VerificationStatus](docs/VerificationStatus.md)
304
+ - [ElasticEmail::Webhook](docs/Webhook.md)
305
+ - [ElasticEmail::WebhookCreatePayload](docs/WebhookCreatePayload.md)
306
+ - [ElasticEmail::WebhookUpdatePayload](docs/WebhookUpdatePayload.md)
299
307
 
300
308
 
301
309
  ## Documentation for Authorization
data/VERSION CHANGED
@@ -1 +1 @@
1
- 4.0.27
1
+ 4.0.28
@@ -11,6 +11,7 @@
11
11
  | **trigger_frequency** | **Float** | How often (in minutes) to send the campaign | [optional] |
12
12
  | **trigger_count** | **Integer** | How many times send the campaign | [optional] |
13
13
  | **split_options** | [**SplitOptions**](SplitOptions.md) | | [optional] |
14
+ | **send_at_local_time** | **Boolean** | Send email at local time of contact. | [optional] |
14
15
 
15
16
  ## Example
16
17
 
@@ -24,7 +25,8 @@ instance = ElasticEmail::CampaignOptions.new(
24
25
  schedule_for: null,
25
26
  trigger_frequency: null,
26
27
  trigger_count: null,
27
- split_options: null
28
+ split_options: null,
29
+ send_at_local_time: null
28
30
  )
29
31
  ```
30
32
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **poolname** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
8
8
  | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe &lt;email@domain.com&gt;) | |
9
- | **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe &lt;email@domain.com&gt;) | [optional] |
9
+ | **reply_to** | **String** | To what addresses should the recipients reply to (e.g. John Doe &lt;email@domain.com&gt;) | [optional] |
10
10
  | **subject** | **String** | Default subject of email. | [optional] |
11
11
  | **template_name** | **String** | Name of template. | [optional] |
12
12
  | **attach_files** | **Array&lt;String&gt;** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
@@ -20,7 +20,7 @@ require 'ElasticEmail'
20
20
  instance = ElasticEmail::CampaignTemplate.new(
21
21
  poolname: My Custom Pool,
22
22
  from: John Doe &lt;email@domain.com&gt;,
23
- reply_to: John Doe &lt;email@domain.com&gt;,
23
+ reply_to: John Doe &lt;email@domain.com&gt;,John Doe2 &lt;email2@domain.com&gt;,
24
24
  subject: Hello!,
25
25
  template_name: Template01,
26
26
  attach_files: [&quot;preuploaded.jpg&quot;],
data/docs/EmailContent.md CHANGED
@@ -11,7 +11,7 @@
11
11
  | **postback** | **String** | Postback header. | [optional] |
12
12
  | **envelope_from** | **String** | E-mail with an optional name to be used as the envelope from address (e.g.: John Doe &lt;email@domain.com&gt;) | [optional] |
13
13
  | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe &lt;email@domain.com&gt;) | |
14
- | **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe &lt;email@domain.com&gt;) | [optional] |
14
+ | **reply_to** | **String** | To what addresses should the recipients reply to (e.g. John Doe &lt;email@domain.com&gt;) | [optional] |
15
15
  | **subject** | **String** | Default subject of email. | [optional] |
16
16
  | **template_name** | **String** | Name of template. | [optional] |
17
17
  | **attach_files** | **Array&lt;String&gt;** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
@@ -30,7 +30,7 @@ instance = ElasticEmail::EmailContent.new(
30
30
  postback: null,
31
31
  envelope_from: John Doe &lt;email@domain.com&gt;,
32
32
  from: John Doe &lt;email@domain.com&gt;,
33
- reply_to: John Doe &lt;email@domain.com&gt;,
33
+ reply_to: John Doe &lt;email@domain.com&gt;,John Doe2 &lt;email2@domain.com&gt;,
34
34
  subject: Hello!,
35
35
  template_name: Template01,
36
36
  attach_files: [&quot;preuploaded.jpg&quot;],
@@ -7,7 +7,7 @@
7
7
  | **binary_content** | **String** | File&#39;s content as byte array (or a Base64 string) | |
8
8
  | **name** | **String** | Display name of the file | |
9
9
  | **content_type** | **String** | MIME content type | [optional] |
10
- | **size** | **Integer** | Size of your attachment (in bytes). | [optional] |
10
+ | **size** | **Integer** | Size of the attachement in B | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -18,7 +18,7 @@ instance = ElasticEmail::MessageAttachment.new(
18
18
  binary_content: null,
19
19
  name: null,
20
20
  content_type: null,
21
- size: 100
21
+ size: null
22
22
  )
23
23
  ```
24
24
 
data/docs/Webhook.md ADDED
@@ -0,0 +1,42 @@
1
+ # ElasticEmail::Webhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **webhook_id** | **String** | Public webhook ID | [optional] |
8
+ | **name** | **String** | Filename | [optional] |
9
+ | **date_created** | **Time** | Creation date. | [optional] |
10
+ | **date_updated** | **Time** | Last change date | [optional] |
11
+ | **url** | **String** | URL of notification. | [optional] |
12
+ | **notify_once_per_email** | **Boolean** | | [optional] |
13
+ | **notification_for_sent** | **Boolean** | | [optional] |
14
+ | **notification_for_opened** | **Boolean** | | [optional] |
15
+ | **notification_for_clicked** | **Boolean** | | [optional] |
16
+ | **notification_for_unsubscribed** | **Boolean** | | [optional] |
17
+ | **notification_for_abuse_report** | **Boolean** | | [optional] |
18
+ | **notification_for_error** | **Boolean** | | [optional] |
19
+ | **is_enabled** | **Boolean** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ElasticEmail'
25
+
26
+ instance = ElasticEmail::Webhook.new(
27
+ webhook_id: null,
28
+ name: attachment.txt,
29
+ date_created: null,
30
+ date_updated: null,
31
+ url: http://address.for.notification.com,
32
+ notify_once_per_email: null,
33
+ notification_for_sent: null,
34
+ notification_for_opened: null,
35
+ notification_for_clicked: null,
36
+ notification_for_unsubscribed: null,
37
+ notification_for_abuse_report: null,
38
+ notification_for_error: null,
39
+ is_enabled: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,372 @@
1
+ # ElasticEmail::WebhookApi
2
+
3
+ All URIs are relative to *https://api.elasticemail.com/v4*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**webhook_by_publicid_delete**](WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook |
8
+ | [**webhook_by_publicid_get**](WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook |
9
+ | [**webhook_by_publicid_put**](WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook |
10
+ | [**webhook_get**](WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks |
11
+ | [**webhook_post**](WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook |
12
+
13
+
14
+ ## webhook_by_publicid_delete
15
+
16
+ > webhook_by_publicid_delete(publicid)
17
+
18
+ Delete Webhook
19
+
20
+ Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'ElasticEmail'
27
+ # setup authorization
28
+ ElasticEmail.configure do |config|
29
+ # Configure API key authorization: apikey
30
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = ElasticEmail::WebhookApi.new
36
+ publicid = 'publicid_example' # String |
37
+
38
+ begin
39
+ # Delete Webhook
40
+ api_instance.webhook_by_publicid_delete(publicid)
41
+ rescue ElasticEmail::ApiError => e
42
+ puts "Error when calling WebhookApi->webhook_by_publicid_delete: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the webhook_by_publicid_delete_with_http_info variant
47
+
48
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
49
+
50
+ > <Array(nil, Integer, Hash)> webhook_by_publicid_delete_with_http_info(publicid)
51
+
52
+ ```ruby
53
+ begin
54
+ # Delete Webhook
55
+ data, status_code, headers = api_instance.webhook_by_publicid_delete_with_http_info(publicid)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => nil
59
+ rescue ElasticEmail::ApiError => e
60
+ puts "Error when calling WebhookApi->webhook_by_publicid_delete_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **publicid** | **String** | | |
69
+
70
+ ### Return type
71
+
72
+ nil (empty response body)
73
+
74
+ ### Authorization
75
+
76
+ [apikey](../README.md#apikey)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: Not defined
82
+
83
+
84
+ ## webhook_by_publicid_get
85
+
86
+ > <Webhook> webhook_by_publicid_get(publicid)
87
+
88
+ Load Webhook
89
+
90
+ Load notifications webhook details. Required Access Level: ViewWebNotifications
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'ElasticEmail'
97
+ # setup authorization
98
+ ElasticEmail.configure do |config|
99
+ # Configure API key authorization: apikey
100
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
101
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
102
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
103
+ end
104
+
105
+ api_instance = ElasticEmail::WebhookApi.new
106
+ publicid = 'publicid_example' # String |
107
+
108
+ begin
109
+ # Load Webhook
110
+ result = api_instance.webhook_by_publicid_get(publicid)
111
+ p result
112
+ rescue ElasticEmail::ApiError => e
113
+ puts "Error when calling WebhookApi->webhook_by_publicid_get: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the webhook_by_publicid_get_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<Webhook>, Integer, Hash)> webhook_by_publicid_get_with_http_info(publicid)
122
+
123
+ ```ruby
124
+ begin
125
+ # Load Webhook
126
+ data, status_code, headers = api_instance.webhook_by_publicid_get_with_http_info(publicid)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <Webhook>
130
+ rescue ElasticEmail::ApiError => e
131
+ puts "Error when calling WebhookApi->webhook_by_publicid_get_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **publicid** | **String** | | |
140
+
141
+ ### Return type
142
+
143
+ [**Webhook**](Webhook.md)
144
+
145
+ ### Authorization
146
+
147
+ [apikey](../README.md#apikey)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
154
+
155
+ ## webhook_by_publicid_put
156
+
157
+ > <Webhook> webhook_by_publicid_put(publicid, webhook_update_payload)
158
+
159
+ Update Webhook
160
+
161
+ Update notification webhook. Required Access Level: ModifyWebNotifications
162
+
163
+ ### Examples
164
+
165
+ ```ruby
166
+ require 'time'
167
+ require 'ElasticEmail'
168
+ # setup authorization
169
+ ElasticEmail.configure do |config|
170
+ # Configure API key authorization: apikey
171
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
172
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
173
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
174
+ end
175
+
176
+ api_instance = ElasticEmail::WebhookApi.new
177
+ publicid = 'publicid_example' # String |
178
+ webhook_update_payload = ElasticEmail::WebhookUpdatePayload.new # WebhookUpdatePayload |
179
+
180
+ begin
181
+ # Update Webhook
182
+ result = api_instance.webhook_by_publicid_put(publicid, webhook_update_payload)
183
+ p result
184
+ rescue ElasticEmail::ApiError => e
185
+ puts "Error when calling WebhookApi->webhook_by_publicid_put: #{e}"
186
+ end
187
+ ```
188
+
189
+ #### Using the webhook_by_publicid_put_with_http_info variant
190
+
191
+ This returns an Array which contains the response data, status code and headers.
192
+
193
+ > <Array(<Webhook>, Integer, Hash)> webhook_by_publicid_put_with_http_info(publicid, webhook_update_payload)
194
+
195
+ ```ruby
196
+ begin
197
+ # Update Webhook
198
+ data, status_code, headers = api_instance.webhook_by_publicid_put_with_http_info(publicid, webhook_update_payload)
199
+ p status_code # => 2xx
200
+ p headers # => { ... }
201
+ p data # => <Webhook>
202
+ rescue ElasticEmail::ApiError => e
203
+ puts "Error when calling WebhookApi->webhook_by_publicid_put_with_http_info: #{e}"
204
+ end
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ | Name | Type | Description | Notes |
210
+ | ---- | ---- | ----------- | ----- |
211
+ | **publicid** | **String** | | |
212
+ | **webhook_update_payload** | [**WebhookUpdatePayload**](WebhookUpdatePayload.md) | | |
213
+
214
+ ### Return type
215
+
216
+ [**Webhook**](Webhook.md)
217
+
218
+ ### Authorization
219
+
220
+ [apikey](../README.md#apikey)
221
+
222
+ ### HTTP request headers
223
+
224
+ - **Content-Type**: application/json
225
+ - **Accept**: application/json
226
+
227
+
228
+ ## webhook_get
229
+
230
+ > <Array<Webhook>> webhook_get(opts)
231
+
232
+ Load Webhooks
233
+
234
+ Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
235
+
236
+ ### Examples
237
+
238
+ ```ruby
239
+ require 'time'
240
+ require 'ElasticEmail'
241
+ # setup authorization
242
+ ElasticEmail.configure do |config|
243
+ # Configure API key authorization: apikey
244
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
245
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
247
+ end
248
+
249
+ api_instance = ElasticEmail::WebhookApi.new
250
+ opts = {
251
+ limit: 100, # Integer | Maximum number of returned items.
252
+ offset: 20 # Integer | How many items should be returned ahead.
253
+ }
254
+
255
+ begin
256
+ # Load Webhooks
257
+ result = api_instance.webhook_get(opts)
258
+ p result
259
+ rescue ElasticEmail::ApiError => e
260
+ puts "Error when calling WebhookApi->webhook_get: #{e}"
261
+ end
262
+ ```
263
+
264
+ #### Using the webhook_get_with_http_info variant
265
+
266
+ This returns an Array which contains the response data, status code and headers.
267
+
268
+ > <Array(<Array<Webhook>>, Integer, Hash)> webhook_get_with_http_info(opts)
269
+
270
+ ```ruby
271
+ begin
272
+ # Load Webhooks
273
+ data, status_code, headers = api_instance.webhook_get_with_http_info(opts)
274
+ p status_code # => 2xx
275
+ p headers # => { ... }
276
+ p data # => <Array<Webhook>>
277
+ rescue ElasticEmail::ApiError => e
278
+ puts "Error when calling WebhookApi->webhook_get_with_http_info: #{e}"
279
+ end
280
+ ```
281
+
282
+ ### Parameters
283
+
284
+ | Name | Type | Description | Notes |
285
+ | ---- | ---- | ----------- | ----- |
286
+ | **limit** | **Integer** | Maximum number of returned items. | [optional] |
287
+ | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
288
+
289
+ ### Return type
290
+
291
+ [**Array&lt;Webhook&gt;**](Webhook.md)
292
+
293
+ ### Authorization
294
+
295
+ [apikey](../README.md#apikey)
296
+
297
+ ### HTTP request headers
298
+
299
+ - **Content-Type**: Not defined
300
+ - **Accept**: application/json
301
+
302
+
303
+ ## webhook_post
304
+
305
+ > <Webhook> webhook_post(webhook_create_payload)
306
+
307
+ Add Webhook
308
+
309
+ Add a notification webhook. Required Access Level: ModifyWebNotifications
310
+
311
+ ### Examples
312
+
313
+ ```ruby
314
+ require 'time'
315
+ require 'ElasticEmail'
316
+ # setup authorization
317
+ ElasticEmail.configure do |config|
318
+ # Configure API key authorization: apikey
319
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
320
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
321
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
322
+ end
323
+
324
+ api_instance = ElasticEmail::WebhookApi.new
325
+ webhook_create_payload = ElasticEmail::WebhookCreatePayload.new({name: 'attachment.txt', url: 'http://address.for.notification.com'}) # WebhookCreatePayload |
326
+
327
+ begin
328
+ # Add Webhook
329
+ result = api_instance.webhook_post(webhook_create_payload)
330
+ p result
331
+ rescue ElasticEmail::ApiError => e
332
+ puts "Error when calling WebhookApi->webhook_post: #{e}"
333
+ end
334
+ ```
335
+
336
+ #### Using the webhook_post_with_http_info variant
337
+
338
+ This returns an Array which contains the response data, status code and headers.
339
+
340
+ > <Array(<Webhook>, Integer, Hash)> webhook_post_with_http_info(webhook_create_payload)
341
+
342
+ ```ruby
343
+ begin
344
+ # Add Webhook
345
+ data, status_code, headers = api_instance.webhook_post_with_http_info(webhook_create_payload)
346
+ p status_code # => 2xx
347
+ p headers # => { ... }
348
+ p data # => <Webhook>
349
+ rescue ElasticEmail::ApiError => e
350
+ puts "Error when calling WebhookApi->webhook_post_with_http_info: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Name | Type | Description | Notes |
357
+ | ---- | ---- | ----------- | ----- |
358
+ | **webhook_create_payload** | [**WebhookCreatePayload**](WebhookCreatePayload.md) | | |
359
+
360
+ ### Return type
361
+
362
+ [**Webhook**](Webhook.md)
363
+
364
+ ### Authorization
365
+
366
+ [apikey](../README.md#apikey)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: application/json
371
+ - **Accept**: application/json
372
+
@@ -0,0 +1,34 @@
1
+ # ElasticEmail::WebhookCreatePayload
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Filename | |
8
+ | **url** | **String** | URL of notification. | |
9
+ | **notify_once_per_email** | **Boolean** | | [optional] |
10
+ | **notification_for_sent** | **Boolean** | | [optional] |
11
+ | **notification_for_opened** | **Boolean** | | [optional] |
12
+ | **notification_for_clicked** | **Boolean** | | [optional] |
13
+ | **notification_for_unsubscribed** | **Boolean** | | [optional] |
14
+ | **notification_for_abuse_report** | **Boolean** | | [optional] |
15
+ | **notification_for_error** | **Boolean** | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ElasticEmail'
21
+
22
+ instance = ElasticEmail::WebhookCreatePayload.new(
23
+ name: attachment.txt,
24
+ url: http://address.for.notification.com,
25
+ notify_once_per_email: null,
26
+ notification_for_sent: null,
27
+ notification_for_opened: null,
28
+ notification_for_clicked: null,
29
+ notification_for_unsubscribed: null,
30
+ notification_for_abuse_report: null,
31
+ notification_for_error: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,36 @@
1
+ # ElasticEmail::WebhookUpdatePayload
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Filename | [optional] |
8
+ | **url** | **String** | URL of notification. | [optional] |
9
+ | **notify_once_per_email** | **Boolean** | | [optional] |
10
+ | **notification_for_sent** | **Boolean** | | [optional] |
11
+ | **notification_for_opened** | **Boolean** | | [optional] |
12
+ | **notification_for_clicked** | **Boolean** | | [optional] |
13
+ | **notification_for_unsubscribed** | **Boolean** | | [optional] |
14
+ | **notification_for_abuse_report** | **Boolean** | | [optional] |
15
+ | **notification_for_error** | **Boolean** | | [optional] |
16
+ | **is_enabled** | **Boolean** | | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ElasticEmail'
22
+
23
+ instance = ElasticEmail::WebhookUpdatePayload.new(
24
+ name: attachment.txt,
25
+ url: http://address.for.notification.com,
26
+ notify_once_per_email: null,
27
+ notification_for_sent: null,
28
+ notification_for_opened: null,
29
+ notification_for_clicked: null,
30
+ notification_for_unsubscribed: null,
31
+ notification_for_abuse_report: null,
32
+ notification_for_error: null,
33
+ is_enabled: null
34
+ )
35
+ ```
36
+