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.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AccountApi.md +6 -1
  3. data/docs/AttributesApi.md +24 -4
  4. data/docs/ContactsApi.md +156 -26
  5. data/docs/CreateAttribute.md +1 -1
  6. data/docs/CreateContact.md +1 -1
  7. data/docs/CreateEmailCampaign.md +9 -3
  8. data/docs/CreateSmtpTemplate.md +1 -1
  9. data/docs/EmailCampaignsApi.md +60 -10
  10. data/docs/FoldersApi.md +36 -6
  11. data/docs/GetCampaignOverview.md +8 -1
  12. data/docs/GetContactDetails.md +1 -0
  13. data/docs/GetEmailCampaign.md +8 -1
  14. data/docs/GetExtendedCampaignOverview.md +8 -1
  15. data/docs/GetExtendedContactDetails.md +1 -0
  16. data/docs/ListsApi.md +54 -9
  17. data/docs/ProcessApi.md +12 -2
  18. data/docs/RequestContactExport.md +1 -1
  19. data/docs/ResellerApi.md +54 -9
  20. data/docs/SMSCampaignsApi.md +60 -10
  21. data/docs/SMTPApi.md +72 -12
  22. data/docs/SendEmail.md +3 -3
  23. data/docs/SendSmtpEmail.md +4 -4
  24. data/docs/SendersApi.md +36 -6
  25. data/docs/TransactionalSMSApi.md +24 -4
  26. data/docs/UpdateAttribute.md +1 -1
  27. data/docs/UpdateContact.md +1 -1
  28. data/docs/UpdateEmailCampaign.md +8 -2
  29. data/docs/UpdateSmtpTemplate.md +1 -1
  30. data/docs/WebhooksApi.md +30 -5
  31. data/lib/sib-api-v3-sdk/api/account_api.rb +1 -1
  32. data/lib/sib-api-v3-sdk/api/attributes_api.rb +4 -4
  33. data/lib/sib-api-v3-sdk/api/contacts_api.rb +26 -26
  34. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +10 -10
  35. data/lib/sib-api-v3-sdk/api/folders_api.rb +6 -6
  36. data/lib/sib-api-v3-sdk/api/lists_api.rb +9 -9
  37. data/lib/sib-api-v3-sdk/api/process_api.rb +2 -2
  38. data/lib/sib-api-v3-sdk/api/reseller_api.rb +9 -9
  39. data/lib/sib-api-v3-sdk/api/senders_api.rb +6 -6
  40. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +10 -10
  41. data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
  42. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
  43. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +5 -5
  44. data/lib/sib-api-v3-sdk/configuration.rb +7 -0
  45. data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
  46. data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
  47. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +150 -10
  48. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +1 -1
  49. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +1 -1
  50. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +1 -1
  51. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +75 -10
  52. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +16 -1
  53. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +72 -7
  54. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +72 -7
  55. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -1
  56. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  57. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -3
  58. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +4 -4
  59. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
  60. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
  61. data/lib/sib-api-v3-sdk/models/update_attribute.rb +1 -1
  62. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  63. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +151 -6
  64. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +1 -1
  65. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
  66. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +1 -1
  67. data/lib/sib-api-v3-sdk/version.rb +1 -1
  68. data/spec/models/create_email_campaign_spec.rb +40 -0
  69. data/spec/models/get_campaign_overview_spec.rb +42 -0
  70. data/spec/models/get_contact_details_spec.rb +6 -0
  71. data/spec/models/get_email_campaign_spec.rb +42 -0
  72. data/spec/models/get_extended_campaign_overview_spec.rb +42 -0
  73. data/spec/models/get_extended_contact_details_spec.rb +6 -0
  74. data/spec/models/update_email_campaign_spec.rb +40 -0
  75. metadata +2 -2
data/docs/CreateAttribute.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7
- **enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
7
+ **enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` | [optional]
8
8
  **type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
9
9
 
10
10
 
data/docs/CreateContact.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
7
- **attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
7
+ **attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` | [optional]
8
8
  **email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
9
9
  **sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
10
10
  **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
data/docs/CreateEmailCampaign.md CHANGED
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
10
10
  **html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
11
11
  **template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
12
12
  **scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
13
- **subject** | **String** | Subject of the campaign |
13
+ **subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
14
14
  **reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
15
- **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
15
+ **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional]
16
16
  **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
17
17
  **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]
18
18
  **inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
@@ -20,7 +20,13 @@ Name | Type | Description | Notes
20
20
  **footer** | **String** | Footer of the email campaign | [optional]
21
21
  **header** | **String** | Header of the email campaign | [optional]
22
22
  **utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
23
- **params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
23
+ **params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
24
24
  **send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
25
+ **ab_testing** | **BOOLEAN** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
26
+ **subject_a** | **String** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
27
+ **subject_b** | **String** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
28
+ **split_rule** | **Integer** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
29
+ **winner_criteria** | **String** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
30
+ **winner_delay** | **Integer** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
25
31
 
26
32
 
data/docs/CreateSmtpTemplate.md CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
11
11
  **subject** | **String** | Subject of the template |
12
12
  **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
13
- **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
13
+ **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional]
14
14
  **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]
15
15
  **is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
16
16
 
data/docs/EmailCampaignsApi.md CHANGED
@@ -31,6 +31,11 @@ SibApiV3Sdk.configure do |config|
31
31
  config.api_key['api-key'] = 'YOUR API KEY'
32
32
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
33
  #config.api_key_prefix['api-key'] = 'Bearer'
34
+
35
+ # Configure API key authorization: partner-key
36
+ config.api_key['partner-key'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ #config.api_key_prefix['partner-key'] = 'Bearer'
34
39
  end
35
40
 
36
41
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -59,7 +64,7 @@ Name | Type | Description | Notes
59
64
 
60
65
  ### Authorization
61
66
 
62
- [api-key](../README.md#api-key)
67
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
63
68
 
64
69
  ### HTTP request headers
65
70
 
@@ -83,6 +88,11 @@ SibApiV3Sdk.configure do |config|
83
88
  config.api_key['api-key'] = 'YOUR API KEY'
84
89
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
90
  #config.api_key_prefix['api-key'] = 'Bearer'
91
+
92
+ # Configure API key authorization: partner-key
93
+ config.api_key['partner-key'] = 'YOUR API KEY'
94
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
95
+ #config.api_key_prefix['partner-key'] = 'Bearer'
86
96
  end
87
97
 
88
98
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -110,7 +120,7 @@ nil (empty response body)
110
120
 
111
121
  ### Authorization
112
122
 
113
- [api-key](../README.md#api-key)
123
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
114
124
 
115
125
  ### HTTP request headers
116
126
 
@@ -134,6 +144,11 @@ SibApiV3Sdk.configure do |config|
134
144
  config.api_key['api-key'] = 'YOUR API KEY'
135
145
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
136
146
  #config.api_key_prefix['api-key'] = 'Bearer'
147
+
148
+ # Configure API key authorization: partner-key
149
+ config.api_key['partner-key'] = 'YOUR API KEY'
150
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
151
+ #config.api_key_prefix['partner-key'] = 'Bearer'
137
152
  end
138
153
 
139
154
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -166,7 +181,7 @@ Name | Type | Description | Notes
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::EmailCampaignsApi.new
@@ -218,7 +238,7 @@ Name | Type | Description | Notes
218
238
 
219
239
  ### Authorization
220
240
 
221
- [api-key](../README.md#api-key)
241
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
222
242
 
223
243
  ### HTTP request headers
224
244
 
@@ -242,6 +262,11 @@ SibApiV3Sdk.configure do |config|
242
262
  config.api_key['api-key'] = 'YOUR API KEY'
243
263
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
244
264
  #config.api_key_prefix['api-key'] = 'Bearer'
265
+
266
+ # Configure API key authorization: partner-key
267
+ config.api_key['partner-key'] = 'YOUR API KEY'
268
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
269
+ #config.api_key_prefix['partner-key'] = 'Bearer'
245
270
  end
246
271
 
247
272
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -281,7 +306,7 @@ Name | Type | Description | Notes
281
306
 
282
307
  ### Authorization
283
308
 
284
- [api-key](../README.md#api-key)
309
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
285
310
 
286
311
  ### HTTP request headers
287
312
 
@@ -305,6 +330,11 @@ SibApiV3Sdk.configure do |config|
305
330
  config.api_key['api-key'] = 'YOUR API KEY'
306
331
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
307
332
  #config.api_key_prefix['api-key'] = 'Bearer'
333
+
334
+ # Configure API key authorization: partner-key
335
+ config.api_key['partner-key'] = 'YOUR API KEY'
336
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
337
+ #config.api_key_prefix['partner-key'] = 'Bearer'
308
338
  end
309
339
 
310
340
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -332,7 +362,7 @@ nil (empty response body)
332
362
 
333
363
  ### Authorization
334
364
 
335
- [api-key](../README.md#api-key)
365
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
336
366
 
337
367
  ### HTTP request headers
338
368
 
@@ -358,6 +388,11 @@ SibApiV3Sdk.configure do |config|
358
388
  config.api_key['api-key'] = 'YOUR API KEY'
359
389
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
360
390
  #config.api_key_prefix['api-key'] = 'Bearer'
391
+
392
+ # Configure API key authorization: partner-key
393
+ config.api_key['partner-key'] = 'YOUR API KEY'
394
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
395
+ #config.api_key_prefix['partner-key'] = 'Bearer'
361
396
  end
362
397
 
363
398
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -388,7 +423,7 @@ nil (empty response body)
388
423
 
389
424
  ### Authorization
390
425
 
391
- [api-key](../README.md#api-key)
426
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
392
427
 
393
428
  ### HTTP request headers
394
429
 
@@ -412,6 +447,11 @@ SibApiV3Sdk.configure do |config|
412
447
  config.api_key['api-key'] = 'YOUR API KEY'
413
448
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
414
449
  #config.api_key_prefix['api-key'] = 'Bearer'
450
+
451
+ # Configure API key authorization: partner-key
452
+ config.api_key['partner-key'] = 'YOUR API KEY'
453
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
454
+ #config.api_key_prefix['partner-key'] = 'Bearer'
415
455
  end
416
456
 
417
457
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -442,7 +482,7 @@ nil (empty response body)
442
482
 
443
483
  ### Authorization
444
484
 
445
- [api-key](../README.md#api-key)
485
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
446
486
 
447
487
  ### HTTP request headers
448
488
 
@@ -466,6 +506,11 @@ SibApiV3Sdk.configure do |config|
466
506
  config.api_key['api-key'] = 'YOUR API KEY'
467
507
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
468
508
  #config.api_key_prefix['api-key'] = 'Bearer'
509
+
510
+ # Configure API key authorization: partner-key
511
+ config.api_key['partner-key'] = 'YOUR API KEY'
512
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
513
+ #config.api_key_prefix['partner-key'] = 'Bearer'
469
514
  end
470
515
 
471
516
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -496,7 +541,7 @@ nil (empty response body)
496
541
 
497
542
  ### Authorization
498
543
 
499
- [api-key](../README.md#api-key)
544
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
500
545
 
501
546
  ### HTTP request headers
502
547
 
@@ -520,6 +565,11 @@ SibApiV3Sdk.configure do |config|
520
565
  config.api_key['api-key'] = 'YOUR API KEY'
521
566
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
522
567
  #config.api_key_prefix['api-key'] = 'Bearer'
568
+
569
+ # Configure API key authorization: partner-key
570
+ config.api_key['partner-key'] = 'YOUR API KEY'
571
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
572
+ #config.api_key_prefix['partner-key'] = 'Bearer'
523
573
  end
524
574
 
525
575
  api_instance = SibApiV3Sdk::EmailCampaignsApi.new
@@ -550,7 +600,7 @@ nil (empty response body)
550
600
 
551
601
  ### Authorization
552
602
 
553
- [api-key](../README.md#api-key)
603
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
554
604
 
555
605
  ### HTTP request headers
556
606
 
data/docs/FoldersApi.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::FoldersApi.new
@@ -55,7 +60,7 @@ Name | Type | Description | Notes
55
60
 
56
61
  ### Authorization
57
62
 
58
- [api-key](../README.md#api-key)
63
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
59
64
 
60
65
  ### HTTP request headers
61
66
 
@@ -79,6 +84,11 @@ SibApiV3Sdk.configure do |config|
79
84
  config.api_key['api-key'] = 'YOUR API KEY'
80
85
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
86
  #config.api_key_prefix['api-key'] = 'Bearer'
87
+
88
+ # Configure API key authorization: partner-key
89
+ config.api_key['partner-key'] = 'YOUR API KEY'
90
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
91
+ #config.api_key_prefix['partner-key'] = 'Bearer'
82
92
  end
83
93
 
84
94
  api_instance = SibApiV3Sdk::FoldersApi.new
@@ -106,7 +116,7 @@ nil (empty response body)
106
116
 
107
117
  ### Authorization
108
118
 
109
- [api-key](../README.md#api-key)
119
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
110
120
 
111
121
  ### HTTP request headers
112
122
 
@@ -130,6 +140,11 @@ SibApiV3Sdk.configure do |config|
130
140
  config.api_key['api-key'] = 'YOUR API KEY'
131
141
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
132
142
  #config.api_key_prefix['api-key'] = 'Bearer'
143
+
144
+ # Configure API key authorization: partner-key
145
+ config.api_key['partner-key'] = 'YOUR API KEY'
146
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
+ #config.api_key_prefix['partner-key'] = 'Bearer'
133
148
  end
134
149
 
135
150
  api_instance = SibApiV3Sdk::FoldersApi.new
@@ -158,7 +173,7 @@ Name | Type | Description | Notes
158
173
 
159
174
  ### Authorization
160
175
 
161
- [api-key](../README.md#api-key)
176
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
162
177
 
163
178
  ### HTTP request headers
164
179
 
@@ -182,6 +197,11 @@ SibApiV3Sdk.configure do |config|
182
197
  config.api_key['api-key'] = 'YOUR API KEY'
183
198
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
184
199
  #config.api_key_prefix['api-key'] = 'Bearer'
200
+
201
+ # Configure API key authorization: partner-key
202
+ config.api_key['partner-key'] = 'YOUR API KEY'
203
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
204
+ #config.api_key_prefix['partner-key'] = 'Bearer'
185
205
  end
186
206
 
187
207
  api_instance = SibApiV3Sdk::FoldersApi.new
@@ -216,7 +236,7 @@ Name | Type | Description | Notes
216
236
 
217
237
  ### Authorization
218
238
 
219
- [api-key](../README.md#api-key)
239
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
220
240
 
221
241
  ### HTTP request headers
222
242
 
@@ -240,6 +260,11 @@ SibApiV3Sdk.configure do |config|
240
260
  config.api_key['api-key'] = 'YOUR API KEY'
241
261
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
242
262
  #config.api_key_prefix['api-key'] = 'Bearer'
263
+
264
+ # Configure API key authorization: partner-key
265
+ config.api_key['partner-key'] = 'YOUR API KEY'
266
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
267
+ #config.api_key_prefix['partner-key'] = 'Bearer'
243
268
  end
244
269
 
245
270
  api_instance = SibApiV3Sdk::FoldersApi.new
@@ -271,7 +296,7 @@ Name | Type | Description | Notes
271
296
 
272
297
  ### Authorization
273
298
 
274
- [api-key](../README.md#api-key)
299
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
275
300
 
276
301
  ### HTTP request headers
277
302
 
@@ -295,6 +320,11 @@ SibApiV3Sdk.configure do |config|
295
320
  config.api_key['api-key'] = 'YOUR API KEY'
296
321
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
297
322
  #config.api_key_prefix['api-key'] = 'Bearer'
323
+
324
+ # Configure API key authorization: partner-key
325
+ config.api_key['partner-key'] = 'YOUR API KEY'
326
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
327
+ #config.api_key_prefix['partner-key'] = 'Bearer'
298
328
  end
299
329
 
300
330
  api_instance = SibApiV3Sdk::FoldersApi.new
@@ -325,7 +355,7 @@ nil (empty response body)
325
355
 
326
356
  ### Authorization
327
357
 
328
- [api-key](../README.md#api-key)
358
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
329
359
 
330
360
  ### HTTP request headers
331
361
 
data/docs/GetCampaignOverview.md CHANGED
@@ -5,9 +5,16 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **Integer** | ID of the campaign |
7
7
  **name** | **String** | Name of the campaign |
8
- **subject** | **String** | Subject of the campaign |
8
+ **subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
11
  **scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
+ **ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
13
+ **subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
14
+ **subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15
+ **split_rule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
16
+ **winner_criteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
17
+ **winner_delay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
18
+ **send_at_best_time** | **BOOLEAN** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
12
19
 
13
20
 
data/docs/GetContactDetails.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **id** | **Integer** | ID of the contact for which you requested the details |
8
8
  **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
9
9
  **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10
+ **created_at** | **DateTime** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
10
11
  **modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
11
12
  **list_ids** | **Array<Integer>** | |
12
13
  **list_unsubscribed** | **Array<Integer>** | | [optional]
data/docs/GetEmailCampaign.md CHANGED
@@ -5,10 +5,17 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **Integer** | ID of the campaign |
7
7
  **name** | **String** | Name of the campaign |
8
- **subject** | **String** | Subject of the campaign |
8
+ **subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
11
  **scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
+ **ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
13
+ **subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
14
+ **subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15
+ **split_rule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
16
+ **winner_criteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
17
+ **winner_delay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
18
+ **send_at_best_time** | **BOOLEAN** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
12
19
  **test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
13
20
  **header** | **String** | Header of the campaign |
14
21
  **footer** | **String** | Footer of the campaign |
data/docs/GetExtendedCampaignOverview.md CHANGED
@@ -5,10 +5,17 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **Integer** | ID of the campaign |
7
7
  **name** | **String** | Name of the campaign |
8
- **subject** | **String** | Subject of the campaign |
8
+ **subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
11
  **scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
+ **ab_testing** | **BOOLEAN** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
13
+ **subject_a** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
14
+ **subject_b** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15
+ **split_rule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
16
+ **winner_criteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
17
+ **winner_delay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
18
+ **send_at_best_time** | **BOOLEAN** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
12
19
  **test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
13
20
  **header** | **String** | Header of the campaign |
14
21
  **footer** | **String** | Footer of the campaign |
data/docs/GetExtendedContactDetails.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **id** | **Integer** | ID of the contact for which you requested the details |
8
8
  **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
9
9
  **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10
+ **created_at** | **DateTime** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
10
11
  **modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
11
12
  **list_ids** | **Array<Integer>** | |
12
13
  **list_unsubscribed** | **Array<Integer>** | | [optional]