sib-api-v3-sdk 5.2.0 → 5.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/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/ListsApi.md
CHANGED
@@ -30,6 +30,11 @@ SibApiV3Sdk.configure do |config|
|
|
30
30
|
config.api_key['api-key'] = 'YOUR API KEY'
|
31
31
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
32
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
33
|
+
|
34
|
+
# Configure API key authorization: partner-key
|
35
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
33
38
|
end
|
34
39
|
|
35
40
|
api_instance = SibApiV3Sdk::ListsApi.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
|
|
@@ -85,6 +90,11 @@ SibApiV3Sdk.configure do |config|
|
|
85
90
|
config.api_key['api-key'] = 'YOUR API KEY'
|
86
91
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
92
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
93
|
+
|
94
|
+
# Configure API key authorization: partner-key
|
95
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
96
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
97
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
88
98
|
end
|
89
99
|
|
90
100
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -113,7 +123,7 @@ Name | Type | Description | Notes
|
|
113
123
|
|
114
124
|
### Authorization
|
115
125
|
|
116
|
-
[api-key](../README.md#api-key)
|
126
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
117
127
|
|
118
128
|
### HTTP request headers
|
119
129
|
|
@@ -137,6 +147,11 @@ SibApiV3Sdk.configure do |config|
|
|
137
147
|
config.api_key['api-key'] = 'YOUR API KEY'
|
138
148
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
149
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
150
|
+
|
151
|
+
# Configure API key authorization: partner-key
|
152
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
154
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
140
155
|
end
|
141
156
|
|
142
157
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -164,7 +179,7 @@ nil (empty response body)
|
|
164
179
|
|
165
180
|
### Authorization
|
166
181
|
|
167
|
-
[api-key](../README.md#api-key)
|
182
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
168
183
|
|
169
184
|
### HTTP request headers
|
170
185
|
|
@@ -188,6 +203,11 @@ SibApiV3Sdk.configure do |config|
|
|
188
203
|
config.api_key['api-key'] = 'YOUR API KEY'
|
189
204
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
190
205
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
206
|
+
|
207
|
+
# Configure API key authorization: partner-key
|
208
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
209
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
210
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
191
211
|
end
|
192
212
|
|
193
213
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -224,7 +244,7 @@ Name | Type | Description | Notes
|
|
224
244
|
|
225
245
|
### Authorization
|
226
246
|
|
227
|
-
[api-key](../README.md#api-key)
|
247
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
228
248
|
|
229
249
|
### HTTP request headers
|
230
250
|
|
@@ -248,6 +268,11 @@ SibApiV3Sdk.configure do |config|
|
|
248
268
|
config.api_key['api-key'] = 'YOUR API KEY'
|
249
269
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
250
270
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
271
|
+
|
272
|
+
# Configure API key authorization: partner-key
|
273
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
275
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
251
276
|
end
|
252
277
|
|
253
278
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -282,7 +307,7 @@ Name | Type | Description | Notes
|
|
282
307
|
|
283
308
|
### Authorization
|
284
309
|
|
285
|
-
[api-key](../README.md#api-key)
|
310
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
286
311
|
|
287
312
|
### HTTP request headers
|
288
313
|
|
@@ -306,6 +331,11 @@ SibApiV3Sdk.configure do |config|
|
|
306
331
|
config.api_key['api-key'] = 'YOUR API KEY'
|
307
332
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
308
333
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
334
|
+
|
335
|
+
# Configure API key authorization: partner-key
|
336
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
337
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
338
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
309
339
|
end
|
310
340
|
|
311
341
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -334,7 +364,7 @@ Name | Type | Description | Notes
|
|
334
364
|
|
335
365
|
### Authorization
|
336
366
|
|
337
|
-
[api-key](../README.md#api-key)
|
367
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
338
368
|
|
339
369
|
### HTTP request headers
|
340
370
|
|
@@ -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::ListsApi.new
|
@@ -389,7 +424,7 @@ Name | Type | Description | Notes
|
|
389
424
|
|
390
425
|
### Authorization
|
391
426
|
|
392
|
-
[api-key](../README.md#api-key)
|
427
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
393
428
|
|
394
429
|
### HTTP request headers
|
395
430
|
|
@@ -413,6 +448,11 @@ SibApiV3Sdk.configure do |config|
|
|
413
448
|
config.api_key['api-key'] = 'YOUR API KEY'
|
414
449
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
415
450
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
451
|
+
|
452
|
+
# Configure API key authorization: partner-key
|
453
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
454
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
455
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
416
456
|
end
|
417
457
|
|
418
458
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -444,7 +484,7 @@ Name | Type | Description | Notes
|
|
444
484
|
|
445
485
|
### Authorization
|
446
486
|
|
447
|
-
[api-key](../README.md#api-key)
|
487
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
448
488
|
|
449
489
|
### HTTP request headers
|
450
490
|
|
@@ -468,6 +508,11 @@ SibApiV3Sdk.configure do |config|
|
|
468
508
|
config.api_key['api-key'] = 'YOUR API KEY'
|
469
509
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
470
510
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
511
|
+
|
512
|
+
# Configure API key authorization: partner-key
|
513
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
514
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
515
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
471
516
|
end
|
472
517
|
|
473
518
|
api_instance = SibApiV3Sdk::ListsApi.new
|
@@ -498,7 +543,7 @@ nil (empty response body)
|
|
498
543
|
|
499
544
|
### Authorization
|
500
545
|
|
501
|
-
[api-key](../README.md#api-key)
|
546
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
502
547
|
|
503
548
|
### HTTP request headers
|
504
549
|
|
data/docs/ProcessApi.md
CHANGED
@@ -23,6 +23,11 @@ SibApiV3Sdk.configure do |config|
|
|
23
23
|
config.api_key['api-key'] = 'YOUR API KEY'
|
24
24
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
25
25
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
26
|
+
|
27
|
+
# Configure API key authorization: partner-key
|
28
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
26
31
|
end
|
27
32
|
|
28
33
|
api_instance = SibApiV3Sdk::ProcessApi.new
|
@@ -51,7 +56,7 @@ Name | Type | Description | Notes
|
|
51
56
|
|
52
57
|
### Authorization
|
53
58
|
|
54
|
-
[api-key](../README.md#api-key)
|
59
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
55
60
|
|
56
61
|
### HTTP request headers
|
57
62
|
|
@@ -75,6 +80,11 @@ SibApiV3Sdk.configure do |config|
|
|
75
80
|
config.api_key['api-key'] = 'YOUR API KEY'
|
76
81
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
77
82
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
83
|
+
|
84
|
+
# Configure API key authorization: partner-key
|
85
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
78
88
|
end
|
79
89
|
|
80
90
|
api_instance = SibApiV3Sdk::ProcessApi.new
|
@@ -106,7 +116,7 @@ Name | Type | Description | Notes
|
|
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
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional]
|
7
|
-
**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example,
|
7
|
+
**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts. |
|
8
8
|
**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
|
9
9
|
|
10
10
|
|
data/docs/ResellerApi.md
CHANGED
@@ -30,6 +30,11 @@ SibApiV3Sdk.configure do |config|
|
|
30
30
|
config.api_key['api-key'] = 'YOUR API KEY'
|
31
31
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
32
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
33
|
+
|
34
|
+
# Configure API key authorization: partner-key
|
35
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
33
38
|
end
|
34
39
|
|
35
40
|
api_instance = SibApiV3Sdk::ResellerApi.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
|
|
@@ -85,6 +90,11 @@ SibApiV3Sdk.configure do |config|
|
|
85
90
|
config.api_key['api-key'] = 'YOUR API KEY'
|
86
91
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
92
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
93
|
+
|
94
|
+
# Configure API key authorization: partner-key
|
95
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
96
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
97
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
88
98
|
end
|
89
99
|
|
90
100
|
api_instance = SibApiV3Sdk::ResellerApi.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::ResellerApi.new
|
@@ -168,7 +183,7 @@ Name | Type | Description | Notes
|
|
168
183
|
|
169
184
|
### Authorization
|
170
185
|
|
171
|
-
[api-key](../README.md#api-key)
|
186
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
172
187
|
|
173
188
|
### HTTP request headers
|
174
189
|
|
@@ -192,6 +207,11 @@ SibApiV3Sdk.configure do |config|
|
|
192
207
|
config.api_key['api-key'] = 'YOUR API KEY'
|
193
208
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
194
209
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
210
|
+
|
211
|
+
# Configure API key authorization: partner-key
|
212
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
214
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
195
215
|
end
|
196
216
|
|
197
217
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -219,7 +239,7 @@ nil (empty response body)
|
|
219
239
|
|
220
240
|
### Authorization
|
221
241
|
|
222
|
-
[api-key](../README.md#api-key)
|
242
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
223
243
|
|
224
244
|
### HTTP request headers
|
225
245
|
|
@@ -243,6 +263,11 @@ SibApiV3Sdk.configure do |config|
|
|
243
263
|
config.api_key['api-key'] = 'YOUR API KEY'
|
244
264
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
245
265
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
266
|
+
|
267
|
+
# Configure API key authorization: partner-key
|
268
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
270
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
246
271
|
end
|
247
272
|
|
248
273
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -273,7 +298,7 @@ nil (empty response body)
|
|
273
298
|
|
274
299
|
### Authorization
|
275
300
|
|
276
|
-
[api-key](../README.md#api-key)
|
301
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
277
302
|
|
278
303
|
### HTTP request headers
|
279
304
|
|
@@ -297,6 +322,11 @@ SibApiV3Sdk.configure do |config|
|
|
297
322
|
config.api_key['api-key'] = 'YOUR API KEY'
|
298
323
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
299
324
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
325
|
+
|
326
|
+
# Configure API key authorization: partner-key
|
327
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
328
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
329
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
300
330
|
end
|
301
331
|
|
302
332
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -325,7 +355,7 @@ Name | Type | Description | Notes
|
|
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
|
|
@@ -349,6 +379,11 @@ SibApiV3Sdk.configure do |config|
|
|
349
379
|
config.api_key['api-key'] = 'YOUR API KEY'
|
350
380
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
351
381
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
382
|
+
|
383
|
+
# Configure API key authorization: partner-key
|
384
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
385
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
386
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
352
387
|
end
|
353
388
|
|
354
389
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -371,7 +406,7 @@ This endpoint does not need any parameter.
|
|
371
406
|
|
372
407
|
### Authorization
|
373
408
|
|
374
|
-
[api-key](../README.md#api-key)
|
409
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
375
410
|
|
376
411
|
### HTTP request headers
|
377
412
|
|
@@ -395,6 +430,11 @@ SibApiV3Sdk.configure do |config|
|
|
395
430
|
config.api_key['api-key'] = 'YOUR API KEY'
|
396
431
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
397
432
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
433
|
+
|
434
|
+
# Configure API key authorization: partner-key
|
435
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
436
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
437
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
398
438
|
end
|
399
439
|
|
400
440
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -426,7 +466,7 @@ Name | Type | Description | Notes
|
|
426
466
|
|
427
467
|
### Authorization
|
428
468
|
|
429
|
-
[api-key](../README.md#api-key)
|
469
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
430
470
|
|
431
471
|
### HTTP request headers
|
432
472
|
|
@@ -450,6 +490,11 @@ SibApiV3Sdk.configure do |config|
|
|
450
490
|
config.api_key['api-key'] = 'YOUR API KEY'
|
451
491
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
452
492
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
493
|
+
|
494
|
+
# Configure API key authorization: partner-key
|
495
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
496
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
497
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
453
498
|
end
|
454
499
|
|
455
500
|
api_instance = SibApiV3Sdk::ResellerApi.new
|
@@ -480,7 +525,7 @@ nil (empty response body)
|
|
480
525
|
|
481
526
|
### Authorization
|
482
527
|
|
483
|
-
[api-key](../README.md#api-key)
|
528
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
484
529
|
|
485
530
|
### HTTP request headers
|
486
531
|
|
data/docs/SMSCampaignsApi.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::SMSCampaignsApi.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::SMSCampaignsApi.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::SMSCampaignsApi.new
|
@@ -165,7 +180,7 @@ Name | Type | Description | Notes
|
|
165
180
|
|
166
181
|
### Authorization
|
167
182
|
|
168
|
-
[api-key](../README.md#api-key)
|
183
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
169
184
|
|
170
185
|
### HTTP request headers
|
171
186
|
|
@@ -189,6 +204,11 @@ SibApiV3Sdk.configure do |config|
|
|
189
204
|
config.api_key['api-key'] = 'YOUR API KEY'
|
190
205
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
191
206
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
207
|
+
|
208
|
+
# Configure API key authorization: partner-key
|
209
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
211
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
192
212
|
end
|
193
213
|
|
194
214
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -226,7 +246,7 @@ Name | Type | Description | Notes
|
|
226
246
|
|
227
247
|
### Authorization
|
228
248
|
|
229
|
-
[api-key](../README.md#api-key)
|
249
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
230
250
|
|
231
251
|
### HTTP request headers
|
232
252
|
|
@@ -252,6 +272,11 @@ SibApiV3Sdk.configure do |config|
|
|
252
272
|
config.api_key['api-key'] = 'YOUR API KEY'
|
253
273
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
254
274
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
275
|
+
|
276
|
+
# Configure API key authorization: partner-key
|
277
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
278
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
279
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
255
280
|
end
|
256
281
|
|
257
282
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -284,7 +309,7 @@ Name | Type | Description | Notes
|
|
284
309
|
|
285
310
|
### Authorization
|
286
311
|
|
287
|
-
[api-key](../README.md#api-key)
|
312
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
288
313
|
|
289
314
|
### HTTP request headers
|
290
315
|
|
@@ -308,6 +333,11 @@ SibApiV3Sdk.configure do |config|
|
|
308
333
|
config.api_key['api-key'] = 'YOUR API KEY'
|
309
334
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
310
335
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
336
|
+
|
337
|
+
# Configure API key authorization: partner-key
|
338
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
340
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
311
341
|
end
|
312
342
|
|
313
343
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -335,7 +365,7 @@ nil (empty response body)
|
|
335
365
|
|
336
366
|
### Authorization
|
337
367
|
|
338
|
-
[api-key](../README.md#api-key)
|
368
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
339
369
|
|
340
370
|
### HTTP request headers
|
341
371
|
|
@@ -361,6 +391,11 @@ SibApiV3Sdk.configure do |config|
|
|
361
391
|
config.api_key['api-key'] = 'YOUR API KEY'
|
362
392
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
363
393
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
394
|
+
|
395
|
+
# Configure API key authorization: partner-key
|
396
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
397
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
398
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
364
399
|
end
|
365
400
|
|
366
401
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -391,7 +426,7 @@ nil (empty response body)
|
|
391
426
|
|
392
427
|
### Authorization
|
393
428
|
|
394
|
-
[api-key](../README.md#api-key)
|
429
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
395
430
|
|
396
431
|
### HTTP request headers
|
397
432
|
|
@@ -415,6 +450,11 @@ SibApiV3Sdk.configure do |config|
|
|
415
450
|
config.api_key['api-key'] = 'YOUR API KEY'
|
416
451
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
417
452
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
453
|
+
|
454
|
+
# Configure API key authorization: partner-key
|
455
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
456
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
457
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
418
458
|
end
|
419
459
|
|
420
460
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -445,7 +485,7 @@ nil (empty response body)
|
|
445
485
|
|
446
486
|
### Authorization
|
447
487
|
|
448
|
-
[api-key](../README.md#api-key)
|
488
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
449
489
|
|
450
490
|
### HTTP request headers
|
451
491
|
|
@@ -469,6 +509,11 @@ SibApiV3Sdk.configure do |config|
|
|
469
509
|
config.api_key['api-key'] = 'YOUR API KEY'
|
470
510
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
471
511
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
512
|
+
|
513
|
+
# Configure API key authorization: partner-key
|
514
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
516
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
472
517
|
end
|
473
518
|
|
474
519
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -499,7 +544,7 @@ nil (empty response body)
|
|
499
544
|
|
500
545
|
### Authorization
|
501
546
|
|
502
|
-
[api-key](../README.md#api-key)
|
547
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
503
548
|
|
504
549
|
### HTTP request headers
|
505
550
|
|
@@ -523,6 +568,11 @@ SibApiV3Sdk.configure do |config|
|
|
523
568
|
config.api_key['api-key'] = 'YOUR API KEY'
|
524
569
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
525
570
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
571
|
+
|
572
|
+
# Configure API key authorization: partner-key
|
573
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
574
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
575
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
526
576
|
end
|
527
577
|
|
528
578
|
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
@@ -553,7 +603,7 @@ nil (empty response body)
|
|
553
603
|
|
554
604
|
### Authorization
|
555
605
|
|
556
|
-
[api-key](../README.md#api-key)
|
606
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
557
607
|
|
558
608
|
### HTTP request headers
|
559
609
|
|