sib-api-v3-sdk 5.2.0 → 5.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/AccountApi.md +6 -1
- data/docs/AttributesApi.md +24 -4
- data/docs/ContactsApi.md +156 -26
- data/docs/CreateAttribute.md +1 -1
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +9 -3
- data/docs/CreateSmtpTemplate.md +1 -1
- data/docs/EmailCampaignsApi.md +60 -10
- data/docs/FoldersApi.md +36 -6
- data/docs/GetCampaignOverview.md +8 -1
- data/docs/GetContactDetails.md +1 -0
- data/docs/GetEmailCampaign.md +8 -1
- data/docs/GetExtendedCampaignOverview.md +8 -1
- data/docs/GetExtendedContactDetails.md +1 -0
- data/docs/ListsApi.md +54 -9
- data/docs/ProcessApi.md +12 -2
- data/docs/RequestContactExport.md +1 -1
- data/docs/ResellerApi.md +54 -9
- data/docs/SMSCampaignsApi.md +60 -10
- data/docs/SMTPApi.md +72 -12
- data/docs/SendEmail.md +3 -3
- data/docs/SendSmtpEmail.md +4 -4
- data/docs/SendersApi.md +36 -6
- data/docs/TransactionalSMSApi.md +24 -4
- data/docs/UpdateAttribute.md +1 -1
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +8 -2
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/WebhooksApi.md +30 -5
- data/lib/sib-api-v3-sdk/api/account_api.rb +1 -1
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +4 -4
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +26 -26
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +10 -10
- data/lib/sib-api-v3-sdk/api/folders_api.rb +6 -6
- data/lib/sib-api-v3-sdk/api/lists_api.rb +9 -9
- data/lib/sib-api-v3-sdk/api/process_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +9 -9
- data/lib/sib-api-v3-sdk/api/senders_api.rb +6 -6
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +10 -10
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +5 -5
- data/lib/sib-api-v3-sdk/configuration.rb +7 -0
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +150 -10
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +75 -10
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +16 -1
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +72 -7
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +72 -7
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -1
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_email.rb +3 -3
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +4 -4
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +151 -6
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +40 -0
- data/spec/models/get_campaign_overview_spec.rb +42 -0
- data/spec/models/get_contact_details_spec.rb +6 -0
- data/spec/models/get_email_campaign_spec.rb +42 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +42 -0
- data/spec/models/get_extended_contact_details_spec.rb +6 -0
- data/spec/models/update_email_campaign_spec.rb +40 -0
- metadata +2 -2
data/docs/SMTPApi.md
CHANGED
@@ -33,6 +33,11 @@ SibApiV3Sdk.configure do |config|
|
|
33
33
|
config.api_key['api-key'] = 'YOUR API KEY'
|
34
34
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
35
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
36
|
+
|
37
|
+
# Configure API key authorization: partner-key
|
38
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
39
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
40
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
36
41
|
end
|
37
42
|
|
38
43
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -61,7 +66,7 @@ Name | Type | Description | Notes
|
|
61
66
|
|
62
67
|
### Authorization
|
63
68
|
|
64
|
-
[api-key](../README.md#api-key)
|
69
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
65
70
|
|
66
71
|
### HTTP request headers
|
67
72
|
|
@@ -87,6 +92,11 @@ SibApiV3Sdk.configure do |config|
|
|
87
92
|
config.api_key['api-key'] = 'YOUR API KEY'
|
88
93
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
89
94
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
95
|
+
|
96
|
+
# Configure API key authorization: partner-key
|
97
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
98
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
99
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
90
100
|
end
|
91
101
|
|
92
102
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -115,7 +125,7 @@ nil (empty response body)
|
|
115
125
|
|
116
126
|
### Authorization
|
117
127
|
|
118
|
-
[api-key](../README.md#api-key)
|
128
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
119
129
|
|
120
130
|
### HTTP request headers
|
121
131
|
|
@@ -139,6 +149,11 @@ SibApiV3Sdk.configure do |config|
|
|
139
149
|
config.api_key['api-key'] = 'YOUR API KEY'
|
140
150
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
141
151
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
152
|
+
|
153
|
+
# Configure API key authorization: partner-key
|
154
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
155
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
156
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
142
157
|
end
|
143
158
|
|
144
159
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -166,7 +181,7 @@ nil (empty response body)
|
|
166
181
|
|
167
182
|
### Authorization
|
168
183
|
|
169
|
-
[api-key](../README.md#api-key)
|
184
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
170
185
|
|
171
186
|
### HTTP request headers
|
172
187
|
|
@@ -190,6 +205,11 @@ SibApiV3Sdk.configure do |config|
|
|
190
205
|
config.api_key['api-key'] = 'YOUR API KEY'
|
191
206
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
192
207
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
208
|
+
|
209
|
+
# Configure API key authorization: partner-key
|
210
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
211
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
212
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
193
213
|
end
|
194
214
|
|
195
215
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -225,7 +245,7 @@ Name | Type | Description | Notes
|
|
225
245
|
|
226
246
|
### Authorization
|
227
247
|
|
228
|
-
[api-key](../README.md#api-key)
|
248
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
229
249
|
|
230
250
|
### HTTP request headers
|
231
251
|
|
@@ -249,6 +269,11 @@ SibApiV3Sdk.configure do |config|
|
|
249
269
|
config.api_key['api-key'] = 'YOUR API KEY'
|
250
270
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
251
271
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
272
|
+
|
273
|
+
# Configure API key authorization: partner-key
|
274
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
275
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
276
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
252
277
|
end
|
253
278
|
|
254
279
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -296,7 +321,7 @@ Name | Type | Description | Notes
|
|
296
321
|
|
297
322
|
### Authorization
|
298
323
|
|
299
|
-
[api-key](../README.md#api-key)
|
324
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
300
325
|
|
301
326
|
### HTTP request headers
|
302
327
|
|
@@ -320,6 +345,11 @@ SibApiV3Sdk.configure do |config|
|
|
320
345
|
config.api_key['api-key'] = 'YOUR API KEY'
|
321
346
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
322
347
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
348
|
+
|
349
|
+
# Configure API key authorization: partner-key
|
350
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
352
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
323
353
|
end
|
324
354
|
|
325
355
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -359,7 +389,7 @@ Name | Type | Description | Notes
|
|
359
389
|
|
360
390
|
### Authorization
|
361
391
|
|
362
|
-
[api-key](../README.md#api-key)
|
392
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
363
393
|
|
364
394
|
### HTTP request headers
|
365
395
|
|
@@ -383,6 +413,11 @@ SibApiV3Sdk.configure do |config|
|
|
383
413
|
config.api_key['api-key'] = 'YOUR API KEY'
|
384
414
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
385
415
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
416
|
+
|
417
|
+
# Configure API key authorization: partner-key
|
418
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
420
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
386
421
|
end
|
387
422
|
|
388
423
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -411,7 +446,7 @@ Name | Type | Description | Notes
|
|
411
446
|
|
412
447
|
### Authorization
|
413
448
|
|
414
|
-
[api-key](../README.md#api-key)
|
449
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
415
450
|
|
416
451
|
### HTTP request headers
|
417
452
|
|
@@ -435,6 +470,11 @@ SibApiV3Sdk.configure do |config|
|
|
435
470
|
config.api_key['api-key'] = 'YOUR API KEY'
|
436
471
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
437
472
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
473
|
+
|
474
|
+
# Configure API key authorization: partner-key
|
475
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
476
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
477
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
438
478
|
end
|
439
479
|
|
440
480
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -468,7 +508,7 @@ Name | Type | Description | Notes
|
|
468
508
|
|
469
509
|
### Authorization
|
470
510
|
|
471
|
-
[api-key](../README.md#api-key)
|
511
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
472
512
|
|
473
513
|
### HTTP request headers
|
474
514
|
|
@@ -494,6 +534,11 @@ SibApiV3Sdk.configure do |config|
|
|
494
534
|
config.api_key['api-key'] = 'YOUR API KEY'
|
495
535
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
496
536
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
537
|
+
|
538
|
+
# Configure API key authorization: partner-key
|
539
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
541
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
497
542
|
end
|
498
543
|
|
499
544
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -525,7 +570,7 @@ Name | Type | Description | Notes
|
|
525
570
|
|
526
571
|
### Authorization
|
527
572
|
|
528
|
-
[api-key](../README.md#api-key)
|
573
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
529
574
|
|
530
575
|
### HTTP request headers
|
531
576
|
|
@@ -549,6 +594,11 @@ SibApiV3Sdk.configure do |config|
|
|
549
594
|
config.api_key['api-key'] = 'YOUR API KEY'
|
550
595
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
551
596
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
597
|
+
|
598
|
+
# Configure API key authorization: partner-key
|
599
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
600
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
601
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
552
602
|
end
|
553
603
|
|
554
604
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -579,7 +629,7 @@ nil (empty response body)
|
|
579
629
|
|
580
630
|
### Authorization
|
581
631
|
|
582
|
-
[api-key](../README.md#api-key)
|
632
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
583
633
|
|
584
634
|
### HTTP request headers
|
585
635
|
|
@@ -603,6 +653,11 @@ SibApiV3Sdk.configure do |config|
|
|
603
653
|
config.api_key['api-key'] = 'YOUR API KEY'
|
604
654
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
605
655
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
656
|
+
|
657
|
+
# Configure API key authorization: partner-key
|
658
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
659
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
660
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
606
661
|
end
|
607
662
|
|
608
663
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -631,7 +686,7 @@ Name | Type | Description | Notes
|
|
631
686
|
|
632
687
|
### Authorization
|
633
688
|
|
634
|
-
[api-key](../README.md#api-key)
|
689
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
635
690
|
|
636
691
|
### HTTP request headers
|
637
692
|
|
@@ -655,6 +710,11 @@ SibApiV3Sdk.configure do |config|
|
|
655
710
|
config.api_key['api-key'] = 'YOUR API KEY'
|
656
711
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
657
712
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
713
|
+
|
714
|
+
# Configure API key authorization: partner-key
|
715
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
716
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
717
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
658
718
|
end
|
659
719
|
|
660
720
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
@@ -685,7 +745,7 @@ nil (empty response body)
|
|
685
745
|
|
686
746
|
### Authorization
|
687
747
|
|
688
|
-
[api-key](../README.md#api-key)
|
748
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
689
749
|
|
690
750
|
### HTTP request headers
|
691
751
|
|
data/docs/SendEmail.md
CHANGED
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
|
|
8
8
|
**email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional]
|
9
9
|
**reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
|
10
10
|
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
11
|
-
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{
|
12
|
-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example,
|
13
|
-
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {
|
11
|
+
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, `[{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]` | [optional]
|
12
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` | [optional]
|
13
|
+
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} | [optional]
|
14
14
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
15
15
|
|
16
16
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -4,17 +4,17 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
|
7
|
-
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{
|
7
|
+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]` |
|
8
8
|
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9
9
|
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10
10
|
**html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
|
11
11
|
**text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
|
12
12
|
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
|
-
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{
|
15
|
-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example,
|
14
|
+
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` | [optional]
|
16
16
|
**template_id** | **Integer** | Id of the template | [optional]
|
17
|
-
**params** | **Object** | Pass the set of attributes to customize the template. For example,
|
17
|
+
**params** | **Object** | Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format. | [optional]
|
18
18
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
19
19
|
|
20
20
|
|
data/docs/SendersApi.md
CHANGED
@@ -27,6 +27,11 @@ SibApiV3Sdk.configure do |config|
|
|
27
27
|
config.api_key['api-key'] = 'YOUR API KEY'
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
29
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
30
|
+
|
31
|
+
# Configure API key authorization: partner-key
|
32
|
+
config.api_key['partner-key'] = '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['partner-key'] = 'Bearer'
|
30
35
|
end
|
31
36
|
|
32
37
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -56,7 +61,7 @@ Name | Type | Description | Notes
|
|
56
61
|
|
57
62
|
### Authorization
|
58
63
|
|
59
|
-
[api-key](../README.md#api-key)
|
64
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
60
65
|
|
61
66
|
### HTTP request headers
|
62
67
|
|
@@ -80,6 +85,11 @@ SibApiV3Sdk.configure do |config|
|
|
80
85
|
config.api_key['api-key'] = 'YOUR API KEY'
|
81
86
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
87
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
88
|
+
|
89
|
+
# Configure API key authorization: partner-key
|
90
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
91
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
92
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
83
93
|
end
|
84
94
|
|
85
95
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -107,7 +117,7 @@ nil (empty response body)
|
|
107
117
|
|
108
118
|
### Authorization
|
109
119
|
|
110
|
-
[api-key](../README.md#api-key)
|
120
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
111
121
|
|
112
122
|
### HTTP request headers
|
113
123
|
|
@@ -131,6 +141,11 @@ SibApiV3Sdk.configure do |config|
|
|
131
141
|
config.api_key['api-key'] = 'YOUR API KEY'
|
132
142
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
133
143
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
144
|
+
|
145
|
+
# Configure API key authorization: partner-key
|
146
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
147
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
148
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
134
149
|
end
|
135
150
|
|
136
151
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -153,7 +168,7 @@ This endpoint does not need any parameter.
|
|
153
168
|
|
154
169
|
### Authorization
|
155
170
|
|
156
|
-
[api-key](../README.md#api-key)
|
171
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
157
172
|
|
158
173
|
### HTTP request headers
|
159
174
|
|
@@ -177,6 +192,11 @@ SibApiV3Sdk.configure do |config|
|
|
177
192
|
config.api_key['api-key'] = 'YOUR API KEY'
|
178
193
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
179
194
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
195
|
+
|
196
|
+
# Configure API key authorization: partner-key
|
197
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
180
200
|
end
|
181
201
|
|
182
202
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -205,7 +225,7 @@ Name | Type | Description | Notes
|
|
205
225
|
|
206
226
|
### Authorization
|
207
227
|
|
208
|
-
[api-key](../README.md#api-key)
|
228
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
209
229
|
|
210
230
|
### HTTP request headers
|
211
231
|
|
@@ -229,6 +249,11 @@ SibApiV3Sdk.configure do |config|
|
|
229
249
|
config.api_key['api-key'] = 'YOUR API KEY'
|
230
250
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
231
251
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
252
|
+
|
253
|
+
# Configure API key authorization: partner-key
|
254
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
255
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
256
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
232
257
|
end
|
233
258
|
|
234
259
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -260,7 +285,7 @@ Name | Type | Description | Notes
|
|
260
285
|
|
261
286
|
### Authorization
|
262
287
|
|
263
|
-
[api-key](../README.md#api-key)
|
288
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
264
289
|
|
265
290
|
### HTTP request headers
|
266
291
|
|
@@ -284,6 +309,11 @@ SibApiV3Sdk.configure do |config|
|
|
284
309
|
config.api_key['api-key'] = 'YOUR API KEY'
|
285
310
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
286
311
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
312
|
+
|
313
|
+
# Configure API key authorization: partner-key
|
314
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
315
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
316
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
287
317
|
end
|
288
318
|
|
289
319
|
api_instance = SibApiV3Sdk::SendersApi.new
|
@@ -315,7 +345,7 @@ nil (empty response body)
|
|
315
345
|
|
316
346
|
### Authorization
|
317
347
|
|
318
|
-
[api-key](../README.md#api-key)
|
348
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
319
349
|
|
320
350
|
### HTTP request headers
|
321
351
|
|
data/docs/TransactionalSMSApi.md
CHANGED
@@ -25,6 +25,11 @@ SibApiV3Sdk.configure do |config|
|
|
25
25
|
config.api_key['api-key'] = 'YOUR API KEY'
|
26
26
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
27
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
28
|
+
|
29
|
+
# Configure API key authorization: partner-key
|
30
|
+
config.api_key['partner-key'] = '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['partner-key'] = 'Bearer'
|
28
33
|
end
|
29
34
|
|
30
35
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
@@ -68,7 +73,7 @@ Name | Type | Description | Notes
|
|
68
73
|
|
69
74
|
### Authorization
|
70
75
|
|
71
|
-
[api-key](../README.md#api-key)
|
76
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
72
77
|
|
73
78
|
### HTTP request headers
|
74
79
|
|
@@ -92,6 +97,11 @@ SibApiV3Sdk.configure do |config|
|
|
92
97
|
config.api_key['api-key'] = 'YOUR API KEY'
|
93
98
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
94
99
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
100
|
+
|
101
|
+
# Configure API key authorization: partner-key
|
102
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
104
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
95
105
|
end
|
96
106
|
|
97
107
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
@@ -127,7 +137,7 @@ Name | Type | Description | Notes
|
|
127
137
|
|
128
138
|
### Authorization
|
129
139
|
|
130
|
-
[api-key](../README.md#api-key)
|
140
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
131
141
|
|
132
142
|
### HTTP request headers
|
133
143
|
|
@@ -151,6 +161,11 @@ SibApiV3Sdk.configure do |config|
|
|
151
161
|
config.api_key['api-key'] = 'YOUR API KEY'
|
152
162
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
153
163
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
164
|
+
|
165
|
+
# Configure API key authorization: partner-key
|
166
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
167
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
168
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
154
169
|
end
|
155
170
|
|
156
171
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
@@ -186,7 +201,7 @@ Name | Type | Description | Notes
|
|
186
201
|
|
187
202
|
### Authorization
|
188
203
|
|
189
|
-
[api-key](../README.md#api-key)
|
204
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
190
205
|
|
191
206
|
### HTTP request headers
|
192
207
|
|
@@ -210,6 +225,11 @@ SibApiV3Sdk.configure do |config|
|
|
210
225
|
config.api_key['api-key'] = 'YOUR API KEY'
|
211
226
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
212
227
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
228
|
+
|
229
|
+
# Configure API key authorization: partner-key
|
230
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
231
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
232
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
213
233
|
end
|
214
234
|
|
215
235
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
@@ -238,7 +258,7 @@ Name | Type | Description | Notes
|
|
238
258
|
|
239
259
|
### Authorization
|
240
260
|
|
241
|
-
[api-key](../README.md#api-key)
|
261
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
242
262
|
|
243
263
|
### HTTP request headers
|
244
264
|
|