sib-api-v3-sdk 7.2.0 → 7.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -0
- data/docs/ContactsApi.md +10 -10
- data/docs/CreateSmtpEmail.md +2 -1
- data/docs/EmailCampaignsApi.md +2 -2
- data/docs/FoldersApi.md +4 -4
- data/docs/ListsApi.md +6 -6
- data/docs/ProcessApi.md +2 -2
- data/docs/SMSCampaignsApi.md +2 -2
- data/docs/SendSmtpEmail.md +3 -2
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/TransactionalEmailsApi.md +10 -10
- data/docs/TransactionalSMSApi.md +4 -4
- data/lib/sib-api-v3-sdk.rb +3 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +10 -10
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/folders_api.rb +4 -4
- data/lib/sib-api-v3-sdk/api/lists_api.rb +6 -6
- data/lib/sib-api-v3-sdk/api/process_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +2 -2
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +10 -10
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +15 -9
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +15 -8
- data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +246 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +200 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +199 -0
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/contacts_api_spec.rb +5 -5
- data/spec/api/email_campaigns_api_spec.rb +1 -1
- data/spec/api/folders_api_spec.rb +2 -2
- data/spec/api/lists_api_spec.rb +3 -3
- data/spec/api/process_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +1 -1
- data/spec/api/transactional_emails_api_spec.rb +5 -5
- data/spec/api/transactional_sms_api_spec.rb +2 -2
- data/spec/models/create_smtp_email_spec.rb +6 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_spec.rb +6 -0
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- metadata +14 -3
- data/testfile.rb +0 -26
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b8fdf83b8326a5b49b72bd3ed41bc50d0140926b962167a8484ebe8d9ec6c673
|
4
|
+
data.tar.gz: 739d85c46094e2d0128a6066c9309fe09d470a52ecd5969f9cadca4090bc5817
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4fb34e9ff66c8c05c13f1b842a49115934639944150326984564e8d9c4f80b951b0ac40d81a96fc70567e8debacb806f465ea1ff75140fd73330df3e936a2d71
|
7
|
+
data.tar.gz: 1dba0523105025ccb9c15a1bf87b47b63b95f4c69ed9dea13efe178855e3f8edd6820a7ecc0768e0fc19090f3f5e6169952232e95272ba375d6719823b9dfe19
|
data/README.md
CHANGED
@@ -357,9 +357,12 @@ Class | Method | HTTP request | Description
|
|
357
357
|
- [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
|
358
358
|
- [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
|
359
359
|
- [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
|
360
|
+
- [SibApiV3Sdk::SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
|
360
361
|
- [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
|
362
|
+
- [SibApiV3Sdk::SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
|
361
363
|
- [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
|
362
364
|
- [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
|
365
|
+
- [SibApiV3Sdk::SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
|
363
366
|
- [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
|
364
367
|
- [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
|
365
368
|
- [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
|
data/docs/ContactsApi.md
CHANGED
@@ -808,7 +808,7 @@ opts = {
|
|
808
808
|
limit: 50, # Integer | Number of documents per page
|
809
809
|
offset: 0, # Integer | Index of the first document of the page
|
810
810
|
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
811
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
811
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
812
812
|
}
|
813
813
|
|
814
814
|
begin
|
@@ -827,7 +827,7 @@ Name | Type | Description | Notes
|
|
827
827
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
828
828
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
829
829
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
830
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
830
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
831
831
|
|
832
832
|
### Return type
|
833
833
|
|
@@ -874,7 +874,7 @@ opts = {
|
|
874
874
|
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
875
875
|
limit: 50, # Integer | Number of documents per page
|
876
876
|
offset: 0, # Integer | Index of the first document of the page
|
877
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
877
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
878
878
|
}
|
879
879
|
|
880
880
|
begin
|
@@ -894,7 +894,7 @@ Name | Type | Description | Notes
|
|
894
894
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
895
895
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
896
896
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
897
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
897
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
898
898
|
|
899
899
|
### Return type
|
900
900
|
|
@@ -997,7 +997,7 @@ folder_id = 789 # Integer | Id of the folder
|
|
997
997
|
opts = {
|
998
998
|
limit: 10, # Integer | Number of documents per page
|
999
999
|
offset: 0, # Integer | Index of the first document of the page
|
1000
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1000
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1001
1001
|
}
|
1002
1002
|
|
1003
1003
|
begin
|
@@ -1016,7 +1016,7 @@ Name | Type | Description | Notes
|
|
1016
1016
|
**folder_id** | **Integer**| Id of the folder |
|
1017
1017
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1018
1018
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1019
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1019
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1020
1020
|
|
1021
1021
|
### Return type
|
1022
1022
|
|
@@ -1062,7 +1062,7 @@ limit = 10 # Integer | Number of documents per page
|
|
1062
1062
|
offset = 0 # Integer | Index of the first document of the page
|
1063
1063
|
|
1064
1064
|
opts = {
|
1065
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1065
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1066
1066
|
}
|
1067
1067
|
|
1068
1068
|
begin
|
@@ -1080,7 +1080,7 @@ Name | Type | Description | Notes
|
|
1080
1080
|
------------- | ------------- | ------------- | -------------
|
1081
1081
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
1082
1082
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
1083
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1083
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1084
1084
|
|
1085
1085
|
### Return type
|
1086
1086
|
|
@@ -1181,7 +1181,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1181
1181
|
opts = {
|
1182
1182
|
limit: 10, # Integer | Number of documents per page
|
1183
1183
|
offset: 0, # Integer | Index of the first document of the page
|
1184
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1184
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
1185
1185
|
}
|
1186
1186
|
|
1187
1187
|
begin
|
@@ -1199,7 +1199,7 @@ Name | Type | Description | Notes
|
|
1199
1199
|
------------- | ------------- | ------------- | -------------
|
1200
1200
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1201
1201
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1202
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1202
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
1203
1203
|
|
1204
1204
|
### Return type
|
1205
1205
|
|
data/docs/CreateSmtpEmail.md
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**message_id** | **String** | Message ID of the transactional email sent |
|
6
|
+
**message_id** | **String** | Message ID of the transactional email sent | [optional]
|
7
|
+
**message_ids** | **Array<String>** | | [optional]
|
7
8
|
|
8
9
|
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -340,7 +340,7 @@ opts = {
|
|
340
340
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
341
341
|
limit: 500, # Integer | Number of documents per page
|
342
342
|
offset: 0, # Integer | Index of the first document in the page
|
343
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
343
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
344
344
|
}
|
345
345
|
|
346
346
|
begin
|
@@ -362,7 +362,7 @@ Name | Type | Description | Notes
|
|
362
362
|
**end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
363
363
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
|
364
364
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
365
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
365
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
366
366
|
|
367
367
|
### Return type
|
368
368
|
|
data/docs/FoldersApi.md
CHANGED
@@ -211,7 +211,7 @@ folder_id = 789 # Integer | Id of the folder
|
|
211
211
|
opts = {
|
212
212
|
limit: 10, # Integer | Number of documents per page
|
213
213
|
offset: 0, # Integer | Index of the first document of the page
|
214
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
214
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
215
215
|
}
|
216
216
|
|
217
217
|
begin
|
@@ -230,7 +230,7 @@ Name | Type | Description | Notes
|
|
230
230
|
**folder_id** | **Integer**| Id of the folder |
|
231
231
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
232
232
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
233
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
233
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
234
234
|
|
235
235
|
### Return type
|
236
236
|
|
@@ -276,7 +276,7 @@ limit = 10 # Integer | Number of documents per page
|
|
276
276
|
offset = 0 # Integer | Index of the first document of the page
|
277
277
|
|
278
278
|
opts = {
|
279
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
279
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
280
280
|
}
|
281
281
|
|
282
282
|
begin
|
@@ -294,7 +294,7 @@ Name | Type | Description | Notes
|
|
294
294
|
------------- | ------------- | ------------- | -------------
|
295
295
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
296
296
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
297
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
297
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
298
298
|
|
299
299
|
### Return type
|
300
300
|
|
data/docs/ListsApi.md
CHANGED
@@ -218,7 +218,7 @@ opts = {
|
|
218
218
|
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
219
219
|
limit: 50, # Integer | Number of documents per page
|
220
220
|
offset: 0, # Integer | Index of the first document of the page
|
221
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
221
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
222
222
|
}
|
223
223
|
|
224
224
|
begin
|
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
|
|
238
238
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
239
239
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
240
240
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
241
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
241
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
242
242
|
|
243
243
|
### Return type
|
244
244
|
|
@@ -284,7 +284,7 @@ folder_id = 789 # Integer | Id of the folder
|
|
284
284
|
opts = {
|
285
285
|
limit: 10, # Integer | Number of documents per page
|
286
286
|
offset: 0, # Integer | Index of the first document of the page
|
287
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
287
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
288
288
|
}
|
289
289
|
|
290
290
|
begin
|
@@ -303,7 +303,7 @@ Name | Type | Description | Notes
|
|
303
303
|
**folder_id** | **Integer**| Id of the folder |
|
304
304
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
305
305
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
306
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
306
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
307
307
|
|
308
308
|
### Return type
|
309
309
|
|
@@ -404,7 +404,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
404
404
|
opts = {
|
405
405
|
limit: 10, # Integer | Number of documents per page
|
406
406
|
offset: 0, # Integer | Index of the first document of the page
|
407
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
407
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
408
408
|
}
|
409
409
|
|
410
410
|
begin
|
@@ -422,7 +422,7 @@ Name | Type | Description | Notes
|
|
422
422
|
------------- | ------------- | ------------- | -------------
|
423
423
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
424
424
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
425
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
425
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
426
426
|
|
427
427
|
### Return type
|
428
428
|
|
data/docs/ProcessApi.md
CHANGED
@@ -92,7 +92,7 @@ api_instance = SibApiV3Sdk::ProcessApi.new
|
|
92
92
|
opts = {
|
93
93
|
limit: 10, # Integer | Number limitation for the result returned
|
94
94
|
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
95
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
95
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
96
96
|
}
|
97
97
|
|
98
98
|
begin
|
@@ -110,7 +110,7 @@ Name | Type | Description | Notes
|
|
110
110
|
------------- | ------------- | ------------- | -------------
|
111
111
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
|
112
112
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
113
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
113
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
114
114
|
|
115
115
|
### Return type
|
116
116
|
|
data/docs/SMSCampaignsApi.md
CHANGED
@@ -216,7 +216,7 @@ opts = {
|
|
216
216
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
217
217
|
limit: 500, # Integer | Number limitation for the result returned
|
218
218
|
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
219
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
219
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
220
220
|
}
|
221
221
|
|
222
222
|
begin
|
@@ -237,7 +237,7 @@ Name | Type | Description | Notes
|
|
237
237
|
**end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
238
238
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
|
239
239
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
240
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
240
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
241
241
|
|
242
242
|
### Return type
|
243
243
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -4,7 +4,7 @@
|
|
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, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] |
|
7
|
+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
|
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]
|
@@ -13,8 +13,9 @@ Name | Type | Description | Notes
|
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15
15
|
**headers** | **Object** | Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
|
16
|
-
**template_id** | **Integer** | Id of the template | [optional]
|
16
|
+
**template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional]
|
17
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
|
+
**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
|
18
19
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
19
20
|
|
20
21
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailMessageVersions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**to** | [**Array<SendSmtpEmailTo1>**](SendSmtpEmailTo1.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\"}] |
|
7
|
+
**params** | **Hash<String, 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]
|
8
|
+
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9
|
+
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10
|
+
**reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional]
|
11
|
+
**subject** | **String** | Custom subject specific to message version | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailReplyTo1
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address in reply to |
|
7
|
+
**name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::SendSmtpEmailTo1
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address of the recipient |
|
7
|
+
**name** | **String** | Name of the recipient. **Maximum allowed characters are 70**. | [optional]
|
8
|
+
|
9
|
+
|
@@ -466,7 +466,7 @@ opts = {
|
|
466
466
|
tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
|
467
467
|
message_id: 'message_id_example', # String | Filter on a specific message id
|
468
468
|
template_id: 789, # Integer | Filter on a specific template id
|
469
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
469
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
470
470
|
}
|
471
471
|
|
472
472
|
begin
|
@@ -492,7 +492,7 @@ Name | Type | Description | Notes
|
|
492
492
|
**tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
|
493
493
|
**message_id** | **String**| Filter on a specific message id | [optional]
|
494
494
|
**template_id** | **Integer**| Filter on a specific template id | [optional]
|
495
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
495
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
496
496
|
|
497
497
|
### Return type
|
498
498
|
|
@@ -540,7 +540,7 @@ opts = {
|
|
540
540
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
541
541
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
542
542
|
tag: 'tag_example', # String | Tag of the emails
|
543
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
543
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
544
544
|
}
|
545
545
|
|
546
546
|
begin
|
@@ -562,7 +562,7 @@ Name | Type | Description | Notes
|
|
562
562
|
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
|
563
563
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
564
564
|
**tag** | **String**| Tag of the emails | [optional]
|
565
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
565
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
566
566
|
|
567
567
|
### Return type
|
568
568
|
|
@@ -664,7 +664,7 @@ opts = {
|
|
664
664
|
template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
|
665
665
|
limit: 50, # Integer | Number of documents returned per page
|
666
666
|
offset: 0, # Integer | Index of the first document in the page
|
667
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
667
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
668
668
|
}
|
669
669
|
|
670
670
|
begin
|
@@ -683,7 +683,7 @@ Name | Type | Description | Notes
|
|
683
683
|
**template_status** | **BOOLEAN**| Filter on the status of the template. Active = true, inactive = false | [optional]
|
684
684
|
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
685
685
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
686
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
686
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
687
687
|
|
688
688
|
### Return type
|
689
689
|
|
@@ -730,7 +730,7 @@ opts = {
|
|
730
730
|
limit: 50, # Integer | Number of documents returned per page
|
731
731
|
offset: 0, # Integer | Index of the first document on the page
|
732
732
|
senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
733
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
733
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
734
734
|
}
|
735
735
|
|
736
736
|
begin
|
@@ -751,7 +751,7 @@ Name | Type | Description | Notes
|
|
751
751
|
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
752
752
|
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
753
753
|
**senders** | [**Array<String>**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
|
754
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
754
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
755
755
|
|
756
756
|
### Return type
|
757
757
|
|
@@ -857,7 +857,7 @@ opts = {
|
|
857
857
|
message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
858
858
|
start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
859
859
|
end_date: Date.parse('2013-10-20'), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
860
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
860
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
861
861
|
}
|
862
862
|
|
863
863
|
begin
|
@@ -878,7 +878,7 @@ Name | Type | Description | Notes
|
|
878
878
|
**message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
|
879
879
|
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
880
880
|
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
881
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
881
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
882
882
|
|
883
883
|
### Return type
|
884
884
|
|
data/docs/TransactionalSMSApi.md
CHANGED
@@ -43,7 +43,7 @@ opts = {
|
|
43
43
|
phone_number: 'phone_number_example', # String | Filter the report for a specific phone number
|
44
44
|
event: 'event_example', # String | Filter the report for specific events
|
45
45
|
tags: 'tags_example', # String | Filter the report for specific tags passed as a serialized urlencoded array
|
46
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
46
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
|
|
67
67
|
**phone_number** | **String**| Filter the report for a specific phone number | [optional]
|
68
68
|
**event** | **String**| Filter the report for specific events | [optional]
|
69
69
|
**tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
|
70
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
70
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
71
71
|
|
72
72
|
### Return type
|
73
73
|
|
@@ -177,7 +177,7 @@ opts = {
|
|
177
177
|
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
178
178
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
179
179
|
tag: 'tag_example', # String | Filter on a tag
|
180
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
180
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
181
181
|
}
|
182
182
|
|
183
183
|
begin
|
@@ -197,7 +197,7 @@ Name | Type | Description | Notes
|
|
197
197
|
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
198
198
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
199
199
|
**tag** | **String**| Filter on a tag | [optional]
|
200
|
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
200
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
201
201
|
|
202
202
|
### Return type
|
203
203
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -163,9 +163,12 @@ require 'sib-api-v3-sdk/models/send_smtp_email'
|
|
163
163
|
require 'sib-api-v3-sdk/models/send_smtp_email_attachment'
|
164
164
|
require 'sib-api-v3-sdk/models/send_smtp_email_bcc'
|
165
165
|
require 'sib-api-v3-sdk/models/send_smtp_email_cc'
|
166
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_message_versions'
|
166
167
|
require 'sib-api-v3-sdk/models/send_smtp_email_reply_to'
|
168
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_reply_to_1'
|
167
169
|
require 'sib-api-v3-sdk/models/send_smtp_email_sender'
|
168
170
|
require 'sib-api-v3-sdk/models/send_smtp_email_to'
|
171
|
+
require 'sib-api-v3-sdk/models/send_smtp_email_to_1'
|
169
172
|
require 'sib-api-v3-sdk/models/send_template_email'
|
170
173
|
require 'sib-api-v3-sdk/models/send_test_email'
|
171
174
|
require 'sib-api-v3-sdk/models/send_test_sms'
|