Skip to content

Commit 72a7252

Browse files
ekta-slitekta-slit
authored
Merge pull request #12 from sendinblue/feature_valid-swagger-spec-2-modifications
Valid swagger specification 2.0 implementation
2 parents 64cb32b + 0452f57 commit 72a7252

File tree

75 files changed

+528
-451
lines changed

Some content is hidden

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

75 files changed

+528
-451
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,6 @@ Class | Method | HTTP request | Description
215215

216216
- [SibApiV3Sdk.AddCredits](docs/AddCredits.md)
217217
- [SibApiV3Sdk.AddRemoveContactToList](docs/AddRemoveContactToList.md)
218-
- [SibApiV3Sdk.CreaUpdateFolder](docs/CreaUpdateFolder.md)
219218
- [SibApiV3Sdk.CreateAttribute](docs/CreateAttribute.md)
220219
- [SibApiV3Sdk.CreateAttributeEnumemaration](docs/CreateAttributeEnumemaration.md)
221220
- [SibApiV3Sdk.CreateChild](docs/CreateChild.md)
@@ -233,6 +232,7 @@ Class | Method | HTTP request | Description
233232
- [SibApiV3Sdk.CreateSmtpEmail](docs/CreateSmtpEmail.md)
234233
- [SibApiV3Sdk.CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
235234
- [SibApiV3Sdk.CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
235+
- [SibApiV3Sdk.CreateUpdateFolder](docs/CreateUpdateFolder.md)
236236
- [SibApiV3Sdk.CreateWebhook](docs/CreateWebhook.md)
237237
- [SibApiV3Sdk.CreatedProcessId](docs/CreatedProcessId.md)
238238
- [SibApiV3Sdk.DeleteHardbounces](docs/DeleteHardbounces.md)

‎docs/AttributesApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ apiKey.apiKey = 'YOUR API KEY';
7676

7777
var apiInstance = new SibApiV3Sdk.AttributesApi();
7878

79-
var attributeId = "attributeId_example"; // String | id of the attribute
79+
var attributeId = 789; // Number | id of the attribute
8080

8181
apiInstance.deleteAttribute(attributeId).then(function() {
8282
console.log('API called successfully.');
@@ -90,7 +90,7 @@ apiInstance.deleteAttribute(attributeId).then(function() {
9090

9191
Name | Type | Description | Notes
9292
------------- | ------------- | ------------- | -------------
93-
**attributeId** | **String**| id of the attribute |
93+
**attributeId** | **Number**| id of the attribute |
9494

9595
### Return type
9696

‎docs/ContactsApi.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ apiKey.apiKey = 'YOUR API KEY';
4949

5050
var apiInstance = new SibApiV3Sdk.ContactsApi();
5151

52-
var listId = "listId_example"; // String | Id of the list
52+
var listId = 789; // Number | Id of the list
5353

5454
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails addresses of the contacts
5555

@@ -65,7 +65,7 @@ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
6565

6666
Name | Type | Description | Notes
6767
------------- | ------------- | ------------- | -------------
68-
**listId** | **String**| Id of the list |
68+
**listId** | **Number**| Id of the list |
6969
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
7070

7171
### Return type
@@ -179,7 +179,7 @@ Name | Type | Description | Notes
179179

180180
<a name="createFolder"></a>
181181
# **createFolder**
182-
> CreateModel createFolder(name)
182+
> CreateModel createFolder(createFolder)
183183
184184
Create a folder
185185

@@ -196,9 +196,9 @@ apiKey.apiKey = 'YOUR API KEY';
196196

197197
var apiInstance = new SibApiV3Sdk.ContactsApi();
198198

199-
var name = new SibApiV3Sdk.CreaUpdateFolder(); // CreaUpdateFolder | Name of the folder
199+
var createFolder = new SibApiV3Sdk.CreateUpdateFolder(); // CreateUpdateFolder | Name of the folder
200200

201-
apiInstance.createFolder(name).then(function(data) {
201+
apiInstance.createFolder(createFolder).then(function(data) {
202202
console.log('API called successfully. Returned data: ' + data);
203203
}, function(error) {
204204
console.error(error);
@@ -210,7 +210,7 @@ apiInstance.createFolder(name).then(function(data) {
210210

211211
Name | Type | Description | Notes
212212
------------- | ------------- | ------------- | -------------
213-
**name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
213+
**createFolder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
214214

215215
### Return type
216216

@@ -292,7 +292,7 @@ apiKey.apiKey = 'YOUR API KEY';
292292

293293
var apiInstance = new SibApiV3Sdk.ContactsApi();
294294

295-
var attributeId = "attributeId_example"; // String | id of the attribute
295+
var attributeId = 789; // Number | id of the attribute
296296

297297
apiInstance.deleteAttribute(attributeId).then(function() {
298298
console.log('API called successfully.');
@@ -306,7 +306,7 @@ apiInstance.deleteAttribute(attributeId).then(function() {
306306

307307
Name | Type | Description | Notes
308308
------------- | ------------- | ------------- | -------------
309-
**attributeId** | **String**| id of the attribute |
309+
**attributeId** | **Number**| id of the attribute |
310310

311311
### Return type
312312

@@ -340,7 +340,7 @@ apiKey.apiKey = 'YOUR API KEY';
340340

341341
var apiInstance = new SibApiV3Sdk.ContactsApi();
342342

343-
var folderId = "folderId_example"; // String | Id of the folder
343+
var folderId = 789; // Number | Id of the folder
344344

345345
apiInstance.deleteFolder(folderId).then(function() {
346346
console.log('API called successfully.');
@@ -354,7 +354,7 @@ apiInstance.deleteFolder(folderId).then(function() {
354354

355355
Name | Type | Description | Notes
356356
------------- | ------------- | ------------- | -------------
357-
**folderId** | **String**| Id of the folder |
357+
**folderId** | **Number**| Id of the folder |
358358

359359
### Return type
360360

@@ -388,7 +388,7 @@ apiKey.apiKey = 'YOUR API KEY';
388388

389389
var apiInstance = new SibApiV3Sdk.ContactsApi();
390390

391-
var listId = "listId_example"; // String | Id of the list
391+
var listId = 789; // Number | Id of the list
392392

393393
apiInstance.deleteList(listId).then(function() {
394394
console.log('API called successfully.');
@@ -402,7 +402,7 @@ apiInstance.deleteList(listId).then(function() {
402402

403403
Name | Type | Description | Notes
404404
------------- | ------------- | ------------- | -------------
405-
**listId** | **String**| Id of the list |
405+
**listId** | **Number**| Id of the list |
406406

407407
### Return type
408408

@@ -625,10 +625,10 @@ apiKey.apiKey = 'YOUR API KEY';
625625

626626
var apiInstance = new SibApiV3Sdk.ContactsApi();
627627

628-
var listId = "listId_example"; // String | Id of the list
628+
var listId = 789; // Number | Id of the list
629629

630630
var opts = {
631-
'modifiedSince': "modifiedSince_example", // String | Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss)
631+
'modifiedSince': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
632632
'limit': 50, // Number | Number of documents per page
633633
'offset': 0 // Number | Index of the first document of the page
634634
};
@@ -644,8 +644,8 @@ apiInstance.getContactsFromList(listId, opts).then(function(data) {
644644

645645
Name | Type | Description | Notes
646646
------------- | ------------- | ------------- | -------------
647-
**listId** | **String**| Id of the list |
648-
**modifiedSince** | **String**| Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss) | [optional]
647+
**listId** | **Number**| Id of the list |
648+
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
649649
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
650650
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
651651

@@ -681,7 +681,7 @@ apiKey.apiKey = 'YOUR API KEY';
681681

682682
var apiInstance = new SibApiV3Sdk.ContactsApi();
683683

684-
var folderId = "folderId_example"; // String | id of the folder
684+
var folderId = 789; // Number | id of the folder
685685

686686
apiInstance.getFolder(folderId).then(function(data) {
687687
console.log('API called successfully. Returned data: ' + data);
@@ -695,7 +695,7 @@ apiInstance.getFolder(folderId).then(function(data) {
695695

696696
Name | Type | Description | Notes
697697
------------- | ------------- | ------------- | -------------
698-
**folderId** | **String**| id of the folder |
698+
**folderId** | **Number**| id of the folder |
699699

700700
### Return type
701701

@@ -729,7 +729,7 @@ apiKey.apiKey = 'YOUR API KEY';
729729

730730
var apiInstance = new SibApiV3Sdk.ContactsApi();
731731

732-
var folderId = "folderId_example"; // String | Id of the folder
732+
var folderId = 789; // Number | Id of the folder
733733

734734
var opts = {
735735
'limit': 10, // Number | Number of documents per page
@@ -747,7 +747,7 @@ apiInstance.getFolderLists(folderId, opts).then(function(data) {
747747

748748
Name | Type | Description | Notes
749749
------------- | ------------- | ------------- | -------------
750-
**folderId** | **String**| Id of the folder |
750+
**folderId** | **Number**| Id of the folder |
751751
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
752752
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
753753

@@ -834,7 +834,7 @@ apiKey.apiKey = 'YOUR API KEY';
834834

835835
var apiInstance = new SibApiV3Sdk.ContactsApi();
836836

837-
var listId = "listId_example"; // String | Id of the list
837+
var listId = 789; // Number | Id of the list
838838

839839
apiInstance.getList(listId).then(function(data) {
840840
console.log('API called successfully. Returned data: ' + data);
@@ -848,7 +848,7 @@ apiInstance.getList(listId).then(function(data) {
848848

849849
Name | Type | Description | Notes
850850
------------- | ------------- | ------------- | -------------
851-
**listId** | **String**| Id of the list |
851+
**listId** | **Number**| Id of the list |
852852

853853
### Return type
854854

@@ -983,7 +983,7 @@ apiKey.apiKey = 'YOUR API KEY';
983983

984984
var apiInstance = new SibApiV3Sdk.ContactsApi();
985985

986-
var listId = "listId_example"; // String | Id of the list
986+
var listId = 789; // Number | Id of the list
987987

988988
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails adresses of the contact
989989

@@ -999,7 +999,7 @@ apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
999999

10001000
Name | Type | Description | Notes
10011001
------------- | ------------- | ------------- | -------------
1002-
**listId** | **String**| Id of the list |
1002+
**listId** | **Number**| Id of the list |
10031003
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
10041004

10051005
### Return type
@@ -1118,7 +1118,7 @@ null (empty response body)
11181118

11191119
<a name="updateFolder"></a>
11201120
# **updateFolder**
1121-
> updateFolder(folderId, name)
1121+
> updateFolder(folderId, updateFolder)
11221122
11231123
Update a contact folder
11241124

@@ -1135,11 +1135,11 @@ apiKey.apiKey = 'YOUR API KEY';
11351135

11361136
var apiInstance = new SibApiV3Sdk.ContactsApi();
11371137

1138-
var folderId = "folderId_example"; // String | Id of the folder
1138+
var folderId = 789; // Number | Id of the folder
11391139

1140-
var name = new SibApiV3Sdk.CreaUpdateFolder(); // CreaUpdateFolder | Name of the folder
1140+
var updateFolder = new SibApiV3Sdk.CreateUpdateFolder(); // CreateUpdateFolder | Name of the folder
11411141

1142-
apiInstance.updateFolder(folderId, name).then(function() {
1142+
apiInstance.updateFolder(folderId, updateFolder).then(function() {
11431143
console.log('API called successfully.');
11441144
}, function(error) {
11451145
console.error(error);
@@ -1151,8 +1151,8 @@ apiInstance.updateFolder(folderId, name).then(function() {
11511151

11521152
Name | Type | Description | Notes
11531153
------------- | ------------- | ------------- | -------------
1154-
**folderId** | **String**| Id of the folder |
1155-
**name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
1154+
**folderId** | **Number**| Id of the folder |
1155+
**updateFolder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
11561156

11571157
### Return type
11581158

@@ -1186,7 +1186,7 @@ apiKey.apiKey = 'YOUR API KEY';
11861186

11871187
var apiInstance = new SibApiV3Sdk.ContactsApi();
11881188

1189-
var listId = "listId_example"; // String | Id of the list
1189+
var listId = 789; // Number | Id of the list
11901190

11911191
var updateList = new SibApiV3Sdk.UpdateList(); // UpdateList | Values to update a list
11921192

@@ -1202,7 +1202,7 @@ apiInstance.updateList(listId, updateList).then(function() {
12021202

12031203
Name | Type | Description | Notes
12041204
------------- | ------------- | ------------- | -------------
1205-
**listId** | **String**| Id of the list |
1205+
**listId** | **Number**| Id of the list |
12061206
**updateList** | [**UpdateList**](UpdateList.md)| Values to update a list |
12071207

12081208
### Return type

‎docs/CreateEmailCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**name** | **String** | Name of the campaign |
99
**htmlContent** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
1010
**htmlUrl** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
11-
**scheduledAt** | **String** | Sending date and time (YYYY-MM-DD HH:mm:ss) | [optional]
11+
**scheduledAt** | **Date** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1212
**subject** | **String** | Subject of the campaign |
1313
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
1414
**toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional]

‎docs/CreateSmsCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
77
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
88
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional]
99
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
10-
**scheduledAt** | **String** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional]
10+
**scheduledAt** | **Date** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1111

1212

‎docs/CreaUpdateFolder.md renamed to ‎docs/CreateUpdateFolder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SibApiV3Sdk.CreaUpdateFolder
1+
# SibApiV3Sdk.CreateUpdateFolder
22

33
## Properties
44
Name | Type | Description | Notes

0 commit comments

Comments
 (0)