Skip to content

Commit 5df08c1

Browse files
Merge pull request #51 from sendinblue/feature_batch_sending
Added batch sending functionality for transactional email api
2 parents a6624a7 + e4f4962 commit 5df08c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+995
-121
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,9 +357,12 @@ Class | Method | HTTP request | Description
357357
- [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
358358
- [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
359359
- [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
360+
- [SibApiV3Sdk::SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
360361
- [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
362+
- [SibApiV3Sdk::SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
361363
- [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
362364
- [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
365+
- [SibApiV3Sdk::SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
363366
- [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
364367
- [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
365368
- [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)

docs/ContactsApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,7 @@ opts = {
808808
limit: 50, # Integer | Number of documents per page
809809
offset: 0, # Integer | Index of the first document of the page
810810
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
812812
}
813813

814814
begin
@@ -827,7 +827,7 @@ Name | Type | Description | Notes
827827
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
828828
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
829829
**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]
831831

832832
### Return type
833833

@@ -874,7 +874,7 @@ opts = {
874874
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.
875875
limit: 50, # Integer | Number of documents per page
876876
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
878878
}
879879

880880
begin
@@ -894,7 +894,7 @@ Name | Type | Description | Notes
894894
**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]
895895
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
896896
**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]
898898

899899
### Return type
900900

@@ -997,7 +997,7 @@ folder_id = 789 # Integer | Id of the folder
997997
opts = {
998998
limit: 10, # Integer | Number of documents per page
999999
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
10011001
}
10021002

10031003
begin
@@ -1016,7 +1016,7 @@ Name | Type | Description | Notes
10161016
**folder_id** | **Integer**| Id of the folder |
10171017
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
10181018
**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]
10201020

10211021
### Return type
10221022

@@ -1062,7 +1062,7 @@ limit = 10 # Integer | Number of documents per page
10621062
offset = 0 # Integer | Index of the first document of the page
10631063

10641064
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
10661066
}
10671067

10681068
begin
@@ -1080,7 +1080,7 @@ Name | Type | Description | Notes
10801080
------------- | ------------- | ------------- | -------------
10811081
**limit** | **Integer**| Number of documents per page | [default to 10]
10821082
**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]
10841084

10851085
### Return type
10861086

@@ -1181,7 +1181,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
11811181
opts = {
11821182
limit: 10, # Integer | Number of documents per page
11831183
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
11851185
}
11861186

11871187
begin
@@ -1199,7 +1199,7 @@ Name | Type | Description | Notes
11991199
------------- | ------------- | ------------- | -------------
12001200
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
12011201
**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]
12031203

12041204
### Return type
12051205

docs/CreateSmtpEmail.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
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]
78

89

docs/EmailCampaignsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ opts = {
340340
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' )
341341
limit: 500, # Integer | Number of documents per page
342342
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
344344
}
345345

346346
begin
@@ -362,7 +362,7 @@ Name | Type | Description | Notes
362362
**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]
363363
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
364364
**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]
366366

367367
### Return type
368368

docs/FoldersApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ folder_id = 789 # Integer | Id of the folder
211211
opts = {
212212
limit: 10, # Integer | Number of documents per page
213213
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
215215
}
216216

217217
begin
@@ -230,7 +230,7 @@ Name | Type | Description | Notes
230230
**folder_id** | **Integer**| Id of the folder |
231231
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
232232
**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]
234234

235235
### Return type
236236

@@ -276,7 +276,7 @@ limit = 10 # Integer | Number of documents per page
276276
offset = 0 # Integer | Index of the first document of the page
277277

278278
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
280280
}
281281

282282
begin
@@ -294,7 +294,7 @@ Name | Type | Description | Notes
294294
------------- | ------------- | ------------- | -------------
295295
**limit** | **Integer**| Number of documents per page | [default to 10]
296296
**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]
298298

299299
### Return type
300300

docs/ListsApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ opts = {
218218
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.
219219
limit: 50, # Integer | Number of documents per page
220220
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
222222
}
223223

224224
begin
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
238238
**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]
239239
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
240240
**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]
242242

243243
### Return type
244244

@@ -284,7 +284,7 @@ folder_id = 789 # Integer | Id of the folder
284284
opts = {
285285
limit: 10, # Integer | Number of documents per page
286286
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
288288
}
289289

290290
begin
@@ -303,7 +303,7 @@ Name | Type | Description | Notes
303303
**folder_id** | **Integer**| Id of the folder |
304304
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
305305
**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]
307307

308308
### Return type
309309

@@ -404,7 +404,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
404404
opts = {
405405
limit: 10, # Integer | Number of documents per page
406406
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
408408
}
409409

410410
begin
@@ -422,7 +422,7 @@ Name | Type | Description | Notes
422422
------------- | ------------- | ------------- | -------------
423423
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
424424
**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]
426426

427427
### Return type
428428

docs/ProcessApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ api_instance = SibApiV3Sdk::ProcessApi.new
9292
opts = {
9393
limit: 10, # Integer | Number limitation for the result returned
9494
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
9696
}
9797

9898
begin
@@ -110,7 +110,7 @@ Name | Type | Description | Notes
110110
------------- | ------------- | ------------- | -------------
111111
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
112112
**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]
114114

115115
### Return type
116116

docs/SMSCampaignsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ opts = {
216216
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' )
217217
limit: 500, # Integer | Number limitation for the result returned
218218
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
220220
}
221221

222222
begin
@@ -237,7 +237,7 @@ Name | Type | Description | Notes
237237
**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]
238238
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
239239
**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]
241241

242242
### Return type
243243

0 commit comments

Comments
 (0)