Skip to content

Commit a14292e

Browse files
Merge pull request #96 from sendinblue/feature_update_nodejs_wrapper_batch_params_AP-1232
batch params feature & default sort order documentation
2 parents 511848d + cfc1915 commit a14292e

File tree

214 files changed

+926
-287
lines changed

Some content is hidden

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

214 files changed

+926
-287
lines changed

Diff for: README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/).
99
This library is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:
1010

1111
- API version: 3.0.0
12-
- Package version: 8.1.1
12+
- Package version: 8.2.0
1313
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
1414

1515
## Installation
@@ -388,9 +388,12 @@ Class | Method | HTTP request | Description
388388
- [SibApiV3Sdk.SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
389389
- [SibApiV3Sdk.SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
390390
- [SibApiV3Sdk.SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
391+
- [SibApiV3Sdk.SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
391392
- [SibApiV3Sdk.SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
393+
- [SibApiV3Sdk.SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
392394
- [SibApiV3Sdk.SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
393395
- [SibApiV3Sdk.SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
396+
- [SibApiV3Sdk.SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
394397
- [SibApiV3Sdk.SendTemplateEmail](docs/SendTemplateEmail.md)
395398
- [SibApiV3Sdk.SendTestEmail](docs/SendTestEmail.md)
396399
- [SibApiV3Sdk.SendTestSms](docs/SendTestSms.md)

Diff for: docs/ContactsApi.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -956,7 +956,7 @@ var folderId = 789; // Number | Id of the folder
956956
var opts = {
957957
'limit': 10, // Number | Number of documents per page
958958
'offset': 0, // Number | Index of the first document of the page
959-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
959+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
960960
};
961961
apiInstance.getFolderLists(folderId, opts).then(function(data) {
962962
console.log('API called successfully. Returned data: ' + data);
@@ -973,7 +973,7 @@ Name | Type | Description | Notes
973973
**folderId** | **Number**| Id of the folder |
974974
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
975975
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
976-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
976+
**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]
977977

978978
### Return type
979979

@@ -1018,7 +1018,7 @@ var limit = 10; // Number | Number of documents per page
10181018
var offset = 0; // Number | Index of the first document of the page
10191019

10201020
var opts = {
1021-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
1021+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
10221022
};
10231023
apiInstance.getFolders(limit, offset, opts).then(function(data) {
10241024
console.log('API called successfully. Returned data: ' + data);
@@ -1034,7 +1034,7 @@ Name | Type | Description | Notes
10341034
------------- | ------------- | ------------- | -------------
10351035
**limit** | **Number**| Number of documents per page | [default to 10]
10361036
**offset** | **Number**| Index of the first document of the page | [default to 0]
1037-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
1037+
**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]
10381038

10391039
### Return type
10401040

@@ -1131,7 +1131,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
11311131
var opts = {
11321132
'limit': 10, // Number | Number of documents per page
11331133
'offset': 0, // Number | Index of the first document of the page
1134-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
1134+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
11351135
};
11361136
apiInstance.getLists(opts).then(function(data) {
11371137
console.log('API called successfully. Returned data: ' + data);
@@ -1147,7 +1147,7 @@ Name | Type | Description | Notes
11471147
------------- | ------------- | ------------- | -------------
11481148
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
11491149
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
1150-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
1150+
**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]
11511151

11521152
### Return type
11531153

Diff for: docs/CreateSmtpEmail.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**messageId** | **String** | Message ID of the transactional email sent |
6+
**messageId** | **String** | Message ID of the transactional email sent | [optional]
7+
**messageIds** | **[String]** | | [optional]
78

89

Diff for: docs/EmailCampaignsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ var opts = {
327327
'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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' )
328328
'limit': 500, // Number | Number of documents per page
329329
'offset': 0, // Number | Index of the first document in the page
330-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
330+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
331331
};
332332
apiInstance.getEmailCampaigns(opts).then(function(data) {
333333
console.log('API called successfully. Returned data: ' + data);
@@ -347,7 +347,7 @@ Name | Type | Description | Notes
347347
**endDate** | **Date**| 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]
348348
**limit** | **Number**| Number of documents per page | [optional] [default to 500]
349349
**offset** | **Number**| Index of the first document in the page | [optional] [default to 0]
350-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
350+
**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]
351351

352352
### Return type
353353

Diff for: docs/FoldersApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ var folderId = 789; // Number | Id of the folder
204204
var opts = {
205205
'limit': 10, // Number | Number of documents per page
206206
'offset': 0, // Number | Index of the first document of the page
207-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
207+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
208208
};
209209
apiInstance.getFolderLists(folderId, opts).then(function(data) {
210210
console.log('API called successfully. Returned data: ' + data);
@@ -221,7 +221,7 @@ Name | Type | Description | Notes
221221
**folderId** | **Number**| Id of the folder |
222222
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
223223
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
224-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
224+
**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]
225225

226226
### Return type
227227

@@ -266,7 +266,7 @@ var limit = 10; // Number | Number of documents per page
266266
var offset = 0; // Number | Index of the first document of the page
267267

268268
var opts = {
269-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
269+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
270270
};
271271
apiInstance.getFolders(limit, offset, opts).then(function(data) {
272272
console.log('API called successfully. Returned data: ' + data);
@@ -282,7 +282,7 @@ Name | Type | Description | Notes
282282
------------- | ------------- | ------------- | -------------
283283
**limit** | **Number**| Number of documents per page | [default to 10]
284284
**offset** | **Number**| Index of the first document of the page | [default to 0]
285-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
285+
**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]
286286

287287
### Return type
288288

Diff for: docs/ListsApi.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ var opts = {
211211
'modifiedSince': new Date("2013-10-20T19:20:30+01:00"), // Date | 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.
212212
'limit': 50, // Number | Number of documents per page
213213
'offset': 0, // Number | 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
apiInstance.getContactsFromList(listId, opts).then(function(data) {
217217
console.log('API called successfully. Returned data: ' + data);
@@ -229,7 +229,7 @@ Name | Type | Description | Notes
229229
**modifiedSince** | **Date**| 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]
230230
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
231231
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
232-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
232+
**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]
233233

234234
### Return type
235235

@@ -274,7 +274,7 @@ var folderId = 789; // Number | Id of the folder
274274
var opts = {
275275
'limit': 10, // Number | Number of documents per page
276276
'offset': 0, // Number | Index of the first document of the page
277-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
277+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
278278
};
279279
apiInstance.getFolderLists(folderId, opts).then(function(data) {
280280
console.log('API called successfully. Returned data: ' + data);
@@ -291,7 +291,7 @@ Name | Type | Description | Notes
291291
**folderId** | **Number**| Id of the folder |
292292
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
293293
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
294-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
294+
**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]
295295

296296
### Return type
297297

@@ -388,7 +388,7 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
388388
var opts = {
389389
'limit': 10, // Number | Number of documents per page
390390
'offset': 0, // Number | Index of the first document of the page
391-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
391+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
392392
};
393393
apiInstance.getLists(opts).then(function(data) {
394394
console.log('API called successfully. Returned data: ' + data);
@@ -404,7 +404,7 @@ Name | Type | Description | Notes
404404
------------- | ------------- | ------------- | -------------
405405
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
406406
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
407-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
407+
**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]
408408

409409
### Return type
410410

Diff for: docs/ProcessApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ var apiInstance = new SibApiV3Sdk.ProcessApi();
9090
var opts = {
9191
'limit': 10, // Number | Number limitation for the result returned
9292
'offset': 0, // Number | Beginning point in the list to retrieve from.
93-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
93+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
9494
};
9595
apiInstance.getProcesses(opts).then(function(data) {
9696
console.log('API called successfully. Returned data: ' + data);
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106
------------- | ------------- | ------------- | -------------
107107
**limit** | **Number**| Number limitation for the result returned | [optional] [default to 10]
108108
**offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
109-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
109+
**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]
110110

111111
### Return type
112112

Diff for: docs/SMSCampaignsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ var opts = {
209209
'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 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' )
210210
'limit': 500, // Number | Number limitation for the result returned
211211
'offset': 0, // Number | Beginning point in the list to retrieve from.
212-
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
212+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
213213
};
214214
apiInstance.getSmsCampaigns(opts).then(function(data) {
215215
console.log('API called successfully. Returned data: ' + data);
@@ -228,7 +228,7 @@ Name | Type | Description | Notes
228228
**endDate** | **Date**| 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]
229229
**limit** | **Number**| Number limitation for the result returned | [optional] [default to 500]
230230
**offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
231-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
231+
**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]
232232

233233
### Return type
234234

0 commit comments

Comments
 (0)