Skip to content

Commit 2e18066

Browse files
shubhamUpadhyayInBlueshubhamUpadhyayInBlue
authored
Merge pull request #91 from sendinblue/feature_AP-1067_AP-1122
Feature AP-1067 AP-1122
2 parents 4153cc4 + 14254da commit 2e18066

Some content is hidden

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

67 files changed

+1002
-240
lines changed

‎README.md

+6-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.0.2
12+
- Package version: 8.1.0
1313
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
1414

1515
## Installation
@@ -209,10 +209,13 @@ Class | Method | HTTP request | Description
209209
*SibApiV3Sdk.SendersApi* | [**getIpsFromSender**](docs/SendersApi.md#getIpsFromSender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
210210
*SibApiV3Sdk.SendersApi* | [**getSenders**](docs/SendersApi.md#getSenders) | **GET** /senders | Get the list of all your senders
211211
*SibApiV3Sdk.SendersApi* | [**updateSender**](docs/SendersApi.md#updateSender) | **PUT** /senders/{senderId} | Update a sender
212+
*SibApiV3Sdk.TransactionalEmailsApi* | [**blockNewDomain**](docs/TransactionalEmailsApi.md#blockNewDomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
212213
*SibApiV3Sdk.TransactionalEmailsApi* | [**createSmtpTemplate**](docs/TransactionalEmailsApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an email template
214+
*SibApiV3Sdk.TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/TransactionalEmailsApi.md#deleteBlockedDomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
213215
*SibApiV3Sdk.TransactionalEmailsApi* | [**deleteHardbounces**](docs/TransactionalEmailsApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
214216
*SibApiV3Sdk.TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/TransactionalEmailsApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
215217
*SibApiV3Sdk.TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/TransactionalEmailsApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
218+
*SibApiV3Sdk.TransactionalEmailsApi* | [**getBlockedDomains**](docs/TransactionalEmailsApi.md#getBlockedDomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
216219
*SibApiV3Sdk.TransactionalEmailsApi* | [**getEmailEventReport**](docs/TransactionalEmailsApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
217220
*SibApiV3Sdk.TransactionalEmailsApi* | [**getSmtpReport**](docs/TransactionalEmailsApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
218221
*SibApiV3Sdk.TransactionalEmailsApi* | [**getSmtpTemplate**](docs/TransactionalEmailsApi.md#getSmtpTemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
@@ -248,6 +251,7 @@ Class | Method | HTTP request | Description
248251
- [SibApiV3Sdk.AddChildDomain](docs/AddChildDomain.md)
249252
- [SibApiV3Sdk.AddContactToList](docs/AddContactToList.md)
250253
- [SibApiV3Sdk.AddCredits](docs/AddCredits.md)
254+
- [SibApiV3Sdk.BlockDomain](docs/BlockDomain.md)
251255
- [SibApiV3Sdk.CreateAttribute](docs/CreateAttribute.md)
252256
- [SibApiV3Sdk.CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
253257
- [SibApiV3Sdk.CreateChild](docs/CreateChild.md)
@@ -282,6 +286,7 @@ Class | Method | HTTP request | Description
282286
- [SibApiV3Sdk.GetAttributes](docs/GetAttributes.md)
283287
- [SibApiV3Sdk.GetAttributesAttributes](docs/GetAttributesAttributes.md)
284288
- [SibApiV3Sdk.GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
289+
- [SibApiV3Sdk.GetBlockedDomains](docs/GetBlockedDomains.md)
285290
- [SibApiV3Sdk.GetCampaignOverview](docs/GetCampaignOverview.md)
286291
- [SibApiV3Sdk.GetCampaignRecipients](docs/GetCampaignRecipients.md)
287292
- [SibApiV3Sdk.GetCampaignStats](docs/GetCampaignStats.md)

‎docs/BlockDomain.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk.BlockDomain
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domain** | **String** | name of the domain to be blocked |
7+
8+

‎docs/ContactsApi.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,8 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
775775
var opts = {
776776
'limit': 50, // Number | Number of documents per page
777777
'offset': 0, // Number | Index of the first document of the page
778-
'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.
778+
'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.
779+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
779780
};
780781
apiInstance.getContacts(opts).then(function(data) {
781782
console.log('API called successfully. Returned data: ' + data);
@@ -792,6 +793,7 @@ Name | Type | Description | Notes
792793
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
793794
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
794795
**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]
796+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
795797

796798
### Return type
797799

@@ -836,7 +838,8 @@ var listId = 789; // Number | Id of the list
836838
var opts = {
837839
'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.
838840
'limit': 50, // Number | Number of documents per page
839-
'offset': 0 // Number | Index of the first document of the page
841+
'offset': 0, // Number | Index of the first document of the page
842+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
840843
};
841844
apiInstance.getContactsFromList(listId, opts).then(function(data) {
842845
console.log('API called successfully. Returned data: ' + data);
@@ -854,6 +857,7 @@ Name | Type | Description | Notes
854857
**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]
855858
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
856859
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
860+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
857861

858862
### Return type
859863

@@ -951,7 +955,8 @@ var folderId = 789; // Number | Id of the folder
951955

952956
var opts = {
953957
'limit': 10, // Number | Number of documents per page
954-
'offset': 0 // Number | Index of the first document of the page
958+
'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
955960
};
956961
apiInstance.getFolderLists(folderId, opts).then(function(data) {
957962
console.log('API called successfully. Returned data: ' + data);
@@ -968,6 +973,7 @@ Name | Type | Description | Notes
968973
**folderId** | **Number**| Id of the folder |
969974
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
970975
**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]
971977

972978
### Return type
973979

@@ -984,7 +990,7 @@ Name | Type | Description | Notes
984990

985991
<a name="getFolders"></a>
986992
# **getFolders**
987-
> GetFolders getFolders(limit, offset)
993+
> GetFolders getFolders(limit, offset, opts)
988994
989995
Get all folders
990996

@@ -1011,7 +1017,10 @@ var limit = 10; // Number | Number of documents per page
10111017

10121018
var offset = 0; // Number | Index of the first document of the page
10131019

1014-
apiInstance.getFolders(limit, offset).then(function(data) {
1020+
var opts = {
1021+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
1022+
};
1023+
apiInstance.getFolders(limit, offset, opts).then(function(data) {
10151024
console.log('API called successfully. Returned data: ' + data);
10161025
}, function(error) {
10171026
console.error(error);
@@ -1025,6 +1034,7 @@ Name | Type | Description | Notes
10251034
------------- | ------------- | ------------- | -------------
10261035
**limit** | **Number**| Number of documents per page | [default to 10]
10271036
**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]
10281038

10291039
### Return type
10301040

@@ -1120,7 +1130,8 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
11201130

11211131
var opts = {
11221132
'limit': 10, // Number | Number of documents per page
1123-
'offset': 0 // Number | Index of the first document of the page
1133+
'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
11241135
};
11251136
apiInstance.getLists(opts).then(function(data) {
11261137
console.log('API called successfully. Returned data: ' + data);
@@ -1136,6 +1147,7 @@ Name | Type | Description | Notes
11361147
------------- | ------------- | ------------- | -------------
11371148
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
11381149
**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]
11391151

11401152
### Return type
11411153

‎docs/CreateSmtpTemplateSender.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
7-
**email** | **String** | Email of the sender |
7+
**email** | **String** | Email of the sender | [optional]
88
**id** | **Number** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
99

1010

‎docs/EmailCampaignsApi.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,8 @@ var opts = {
326326
'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Mandatory if endDate is used. Starting (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' )
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
329-
'offset': 0 // Number | Index of the first document in the page
329+
'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
330331
};
331332
apiInstance.getEmailCampaigns(opts).then(function(data) {
332333
console.log('API called successfully. Returned data: ' + data);
@@ -346,6 +347,7 @@ Name | Type | Description | Notes
346347
**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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
347348
**limit** | **Number**| Number of documents per page | [optional] [default to 500]
348349
**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]
349351

350352
### Return type
351353

‎docs/FoldersApi.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,8 @@ var folderId = 789; // Number | Id of the folder
203203

204204
var opts = {
205205
'limit': 10, // Number | Number of documents per page
206-
'offset': 0 // Number | Index of the first document of the page
206+
'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
207208
};
208209
apiInstance.getFolderLists(folderId, opts).then(function(data) {
209210
console.log('API called successfully. Returned data: ' + data);
@@ -220,6 +221,7 @@ Name | Type | Description | Notes
220221
**folderId** | **Number**| Id of the folder |
221222
**limit** | **Number**| Number of documents per page | [optional] [default to 10]
222223
**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]
223225

224226
### Return type
225227

@@ -236,7 +238,7 @@ Name | Type | Description | Notes
236238

237239
<a name="getFolders"></a>
238240
# **getFolders**
239-
> GetFolders getFolders(limit, offset)
241+
> GetFolders getFolders(limit, offset, opts)
240242
241243
Get all folders
242244

@@ -263,7 +265,10 @@ var limit = 10; // Number | Number of documents per page
263265

264266
var offset = 0; // Number | Index of the first document of the page
265267

266-
apiInstance.getFolders(limit, offset).then(function(data) {
268+
var opts = {
269+
'sort': "desc" // String | Sort the results in the ascending/descending order of record creation
270+
};
271+
apiInstance.getFolders(limit, offset, opts).then(function(data) {
267272
console.log('API called successfully. Returned data: ' + data);
268273
}, function(error) {
269274
console.error(error);
@@ -277,6 +282,7 @@ Name | Type | Description | Notes
277282
------------- | ------------- | ------------- | -------------
278283
**limit** | **Number**| Number of documents per page | [default to 10]
279284
**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]
280286

281287
### Return type
282288

‎docs/GetBlockedDomains.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk.GetBlockedDomains
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domains** | **[String]** | List of all blocked domains |
7+
8+

‎docs/GetChildDomain.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**domain** | **String** | Sender domain |
7-
**active** | **Boolean** | indicates whether a domain is verified or not |
6+
**domain** | **String** | Sender domain | [optional]
7+
**active** | **Boolean** | indicates whether a domain is verified or not | [optional]
88

99

‎docs/GetChildrenList.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**children** | **[Object]** | Your children&#39;s account information | [optional]
7-
**count** | **Number** | Number of child accounts |
7+
**count** | **Number** | Number of child accounts | [optional]
88

99

‎docs/GetEmailCampaigns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaigns** | **[Object]** | | [optional]
7-
**count** | **Number** | Number of Email campaigns retrieved |
7+
**count** | **Number** | Number of Email campaigns retrieved | [optional]
88

99

‎docs/GetEmailEventReportEvents.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
1414
**link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
1515
**from** | **String** | Sender email from which the emails are sent | [optional]
16+
**templateId** | **Number** | ID of the template (only available if the email is template based) | [optional]
1617

1718

1819
<a name="EventEnum"></a>
@@ -43,6 +44,8 @@ Name | Type | Description | Notes
4344

4445
* `unsubscribed` (value: `"unsubscribed"`)
4546

47+
* `error` (value: `"error"`)
48+
4649

4750

4851

‎docs/GetExtendedCampaignOverview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
88
**footer** | **String** | Footer of the campaign |
99
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
1010
**replyTo** | **String** | Email defined as the \&quot;Reply to\&quot; of the campaign |
11-
**toField** | **String** | Customisation of the \&quot;to\&quot; field of the campaign |
11+
**toField** | **String** | Customisation of the \&quot;to\&quot; field of the campaign | [optional]
1212
**htmlContent** | **String** | HTML content of the campaign |
1313
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
14-
**tag** | **String** | Tag of the campaign |
14+
**tag** | **String** | Tag of the campaign | [optional]
1515
**createdAt** | **Date** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1616
**modifiedAt** | **Date** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1717
**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation &#x3D; false means image can’t be embedded, &amp; inlineImageActivation &#x3D; true means image can be embedded, in the email. | [optional]

‎docs/GetFolderLists.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**lists** | **[Object]** | |
7-
**count** | **Number** | Number of lists in the folder |
6+
**lists** | **[Object]** | | [optional]
7+
**count** | **Number** | Number of lists in the folder | [optional]
88

99

‎docs/GetLists.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**lists** | **[Object]** | Listing of all the lists available in your account |
7-
**count** | **Number** | Number of lists in your account |
6+
**lists** | **[Object]** | Listing of all the lists available in your account | [optional]
7+
**count** | **Number** | Number of lists in your account | [optional]
88

99

‎docs/GetProcesses.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**processes** | [**[GetProcess]**](GetProcess.md) | List of processes available on your account | [optional]
7-
**count** | **Number** | Number of processes available on your account |
7+
**count** | **Number** | Number of processes available on your account | [optional]
88

99

‎docs/GetSmsCampaignOverview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the SMS Campaign |
88
**status** | **String** | Status of the SMS Campaign |
99
**content** | **String** | Content of the SMS Campaign |
10-
**scheduledAt** | **Date** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
10+
**scheduledAt** | **Date** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
1111
**sender** | **String** | Sender of the SMS Campaign |
1212
**createdAt** | **Date** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1313
**modifiedAt** | **Date** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |

‎docs/GetSmsCampaigns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaigns** | **[Object]** | | [optional]
7-
**count** | **Number** | Number of SMS campaigns retrieved |
7+
**count** | **Number** | Number of SMS campaigns retrieved | [optional]
88

99

0 commit comments

Comments
 (0)