Skip to content

Commit 3d4af1a

Browse files
ekta-slitekta-slit
authored
Merge pull request #16 from sendinblue/feature_spec-updates
Mixed spec updates
2 parents 5bac7f4 + 78d6867 commit 3d4af1a

13 files changed

+148
-18
lines changed

‎README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,18 +173,19 @@ Class | Method | HTTP request | Description
173173
*SibApiV3Sdk.ResellerApi* | [**getResellerChilds**](docs/ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts
174174
*SibApiV3Sdk.ResellerApi* | [**removeCredits**](docs/ResellerApi.md#removeCredits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
175175
*SibApiV3Sdk.ResellerApi* | [**updateResellerChild**](docs/ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
176-
*SibApiV3Sdk.SMSCampaignsApi* | [**createSMSCampaign**](docs/SMSCampaignsApi.md#createSMSCampaign) | **POST** /smsCampaigns | Creates a SMS campaign
176+
*SibApiV3Sdk.SMSCampaignsApi* | [**createSMSCampaign**](docs/SMSCampaignsApi.md#createSMSCampaign) | **POST** /smsCampaigns | Creates an SMS campaign
177177
*SibApiV3Sdk.SMSCampaignsApi* | [**deleteSMSCampaigns**](docs/SMSCampaignsApi.md#deleteSMSCampaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
178178
*SibApiV3Sdk.SMSCampaignsApi* | [**getSMSCampaigns**](docs/SMSCampaignsApi.md#getSMSCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
179-
*SibApiV3Sdk.SMSCampaignsApi* | [**getSmsCampaign**](docs/SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get a SMS campaign
179+
*SibApiV3Sdk.SMSCampaignsApi* | [**getSmsCampaign**](docs/SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
180180
*SibApiV3Sdk.SMSCampaignsApi* | [**requestSMSRecipientExport**](docs/SMSCampaignsApi.md#requestSMSRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
181181
*SibApiV3Sdk.SMSCampaignsApi* | [**sendSMSCampaignNow**](docs/SMSCampaignsApi.md#sendSMSCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
182182
*SibApiV3Sdk.SMSCampaignsApi* | [**sendSMSReport**](docs/SMSCampaignsApi.md#sendSMSReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
183183
*SibApiV3Sdk.SMSCampaignsApi* | [**sendTestSms**](docs/SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
184184
*SibApiV3Sdk.SMSCampaignsApi* | [**updateSMSCampaignStatus**](docs/SMSCampaignsApi.md#updateSMSCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
185-
*SibApiV3Sdk.SMSCampaignsApi* | [**updateSmsCampaign**](docs/SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Updates a SMS campaign
185+
*SibApiV3Sdk.SMSCampaignsApi* | [**updateSmsCampaign**](docs/SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
186186
*SibApiV3Sdk.SMTPApi* | [**createSmtpTemplate**](docs/SMTPApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an smtp template
187187
*SibApiV3Sdk.SMTPApi* | [**deleteHardbounces**](docs/SMTPApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
188+
*SibApiV3Sdk.SMTPApi* | [**deleteSmtpTemplate**](docs/SMTPApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
188189
*SibApiV3Sdk.SMTPApi* | [**getAggregatedSmtpReport**](docs/SMTPApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
189190
*SibApiV3Sdk.SMTPApi* | [**getEmailEventReport**](docs/SMTPApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
190191
*SibApiV3Sdk.SMTPApi* | [**getSmtpReport**](docs/SMTPApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day

‎docs/ContactsApi.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,7 @@ Name | Type | Description | Notes
592592
------------- | ------------- | ------------- | -------------
593593
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
594594
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
595+
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
595596

596597
### Return type
597598

‎docs/CreateContact.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
88
**emailBlacklisted** | **Boolean** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
99
**smsBlacklisted** | **Boolean** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**listIds** | **[Number]** | Ids of the lists to add the contact to | [optional]
11+
**updateEnabled** | **Boolean** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
1112

1213

‎docs/SMSCampaignsApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createSMSCampaign**](SMSCampaignsApi.md#createSMSCampaign) | **POST** /smsCampaigns | Creates a SMS campaign
7+
[**createSMSCampaign**](SMSCampaignsApi.md#createSMSCampaign) | **POST** /smsCampaigns | Creates an SMS campaign
88
[**deleteSMSCampaigns**](SMSCampaignsApi.md#deleteSMSCampaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
99
[**getSMSCampaigns**](SMSCampaignsApi.md#getSMSCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
10-
[**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get a SMS campaign
10+
[**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
1111
[**requestSMSRecipientExport**](SMSCampaignsApi.md#requestSMSRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
1212
[**sendSMSCampaignNow**](SMSCampaignsApi.md#sendSMSCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
1313
[**sendSMSReport**](SMSCampaignsApi.md#sendSMSReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
1414
[**sendTestSms**](SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
1515
[**updateSMSCampaignStatus**](SMSCampaignsApi.md#updateSMSCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
16-
[**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Updates a SMS campaign
16+
[**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
1717

1818

1919
<a name="createSMSCampaign"></a>
2020
# **createSMSCampaign**
2121
> CreateModel createSMSCampaign(createSmsCampaign)
2222
23-
Creates a SMS campaign
23+
Creates an SMS campaign
2424

2525
### Example
2626
```javascript
@@ -169,7 +169,7 @@ Name | Type | Description | Notes
169169
# **getSmsCampaign**
170170
> GetSmsCampaign getSmsCampaign(campaignId, getSmsCampaign)
171171
172-
Get a SMS campaign
172+
Get an SMS campaign
173173

174174
### Example
175175
```javascript
@@ -477,7 +477,7 @@ null (empty response body)
477477
# **updateSmsCampaign**
478478
> updateSmsCampaign(campaignId, updateSmsCampaign)
479479
480-
Updates a SMS campaign
480+
Updates an SMS campaign
481481

482482
### Example
483483
```javascript

‎docs/SMTPApi.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**createSmtpTemplate**](SMTPApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an smtp template
88
[**deleteHardbounces**](SMTPApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
9+
[**deleteSmtpTemplate**](SMTPApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
910
[**getAggregatedSmtpReport**](SMTPApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
1011
[**getEmailEventReport**](SMTPApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
1112
[**getSmtpReport**](SMTPApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
@@ -111,6 +112,54 @@ null (empty response body)
111112

112113
[api-key](../README.md#api-key)
113114

115+
### HTTP request headers
116+
117+
- **Content-Type**: application/json
118+
- **Accept**: application/json
119+
120+
<a name="deleteSmtpTemplate"></a>
121+
# **deleteSmtpTemplate**
122+
> deleteSmtpTemplate(templateId)
123+
124+
Delete an inactive smtp template
125+
126+
### Example
127+
```javascript
128+
var SibApiV3Sdk = require('sib-api-v3-sdk');
129+
var defaultClient = SibApiV3Sdk.ApiClient.instance;
130+
131+
// Configure API key authorization: api-key
132+
var api-key = defaultClient.authentications['api-key'];
133+
api-key.apiKey = 'YOUR API KEY';
134+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
135+
//api-key.apiKeyPrefix = 'Token';
136+
137+
var apiInstance = new SibApiV3Sdk.SMTPApi();
138+
139+
var templateId = 789; // Number | id of the template
140+
141+
apiInstance.deleteSmtpTemplate(templateId).then(function() {
142+
console.log('API called successfully.');
143+
}, function(error) {
144+
console.error(error);
145+
});
146+
147+
```
148+
149+
### Parameters
150+
151+
Name | Type | Description | Notes
152+
------------- | ------------- | ------------- | -------------
153+
**templateId** | **Number**| id of the template |
154+
155+
### Return type
156+
157+
null (empty response body)
158+
159+
### Authorization
160+
161+
[api-key](../README.md#api-key)
162+
114163
### HTTP request headers
115164

116165
- **Content-Type**: application/json

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sib-api-v3-sdk",
3-
"version": "3.1.2",
3+
"version": "3.1.3",
44
"description": "Official SendinBlue provided RESTFul API V3 nodejs library",
55
"license": "ISC",
66
"main": "src/index.js",

‎src/api/ContactsApi.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,7 @@
588588
* @param {Object} opts Optional parameters
589589
* @param {Number} opts.limit Number of documents per page (default to 50)
590590
* @param {Number} opts.offset Index of the first document of the page (default to 0)
591+
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
591592
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContacts} and HTTP response
592593
*/
593594
this.getContactsWithHttpInfo = function(opts) {
@@ -599,7 +600,8 @@
599600
};
600601
var queryParams = {
601602
'limit': opts['limit'],
602-
'offset': opts['offset']
603+
'offset': opts['offset'],
604+
'modifiedSince': opts['modifiedSince']
603605
};
604606
var headerParams = {
605607
};
@@ -623,6 +625,7 @@
623625
* @param {Object} opts Optional parameters
624626
* @param {Number} opts.limit Number of documents per page (default to 50)
625627
* @param {Number} opts.offset Index of the first document of the page (default to 0)
628+
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
626629
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContacts}
627630
*/
628631
this.getContacts = function(opts) {

‎src/api/SMSCampaignsApi.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151

5252
/**
53-
* Creates a SMS campaign
53+
* Creates an SMS campaign
5454
* @param {module:model/CreateSmsCampaign} createSmsCampaign Values to create an SMS Campaign
5555
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateModel} and HTTP response
5656
*/
@@ -85,7 +85,7 @@
8585
}
8686

8787
/**
88-
* Creates a SMS campaign
88+
* Creates an SMS campaign
8989
* @param {module:model/CreateSmsCampaign} createSmsCampaign Values to create an SMS Campaign
9090
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateModel}
9191
*/
@@ -200,7 +200,7 @@
200200

201201

202202
/**
203-
* Get a SMS campaign
203+
* Get an SMS campaign
204204
* @param {Number} campaignId id of the SMS campaign
205205
* @param {module:model/GetSmsCampaign} getSmsCampaign Values to update an SMS Campaign
206206
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSmsCampaign} and HTTP response
@@ -242,7 +242,7 @@
242242
}
243243

244244
/**
245-
* Get a SMS campaign
245+
* Get an SMS campaign
246246
* @param {Number} campaignId id of the SMS campaign
247247
* @param {module:model/GetSmsCampaign} getSmsCampaign Values to update an SMS Campaign
248248
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSmsCampaign}
@@ -531,7 +531,7 @@
531531

532532

533533
/**
534-
* Updates a SMS campaign
534+
* Updates an SMS campaign
535535
* @param {Number} campaignId id of the SMS campaign
536536
* @param {module:model/UpdateSmsCampaign} updateSmsCampaign Values to update an SMS Campaign
537537
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
@@ -573,7 +573,7 @@
573573
}
574574

575575
/**
576-
* Updates a SMS campaign
576+
* Updates an SMS campaign
577577
* @param {Number} campaignId id of the SMS campaign
578578
* @param {module:model/UpdateSmsCampaign} updateSmsCampaign Values to update an SMS Campaign
579579
* @return {Promise} a {@link https://www.promisejs.org/|Promise}

‎src/api/SMTPApi.js

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,55 @@
145145
}
146146

147147

148+
/**
149+
* Delete an inactive smtp template
150+
* @param {Number} templateId id of the template
151+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
152+
*/
153+
this.deleteSmtpTemplateWithHttpInfo = function(templateId) {
154+
var postBody = null;
155+
156+
// verify the required parameter 'templateId' is set
157+
if (templateId === undefined || templateId === null) {
158+
throw new Error("Missing the required parameter 'templateId' when calling deleteSmtpTemplate");
159+
}
160+
161+
162+
var pathParams = {
163+
'templateId': templateId
164+
};
165+
var queryParams = {
166+
};
167+
var headerParams = {
168+
};
169+
var formParams = {
170+
};
171+
172+
var authNames = ['api-key'];
173+
var contentTypes = ['application/json'];
174+
var accepts = ['application/json'];
175+
var returnType = null;
176+
177+
return this.apiClient.callApi(
178+
'/smtp/templates/{templateId}', 'DELETE',
179+
pathParams, queryParams, headerParams, formParams, postBody,
180+
authNames, contentTypes, accepts, returnType
181+
);
182+
}
183+
184+
/**
185+
* Delete an inactive smtp template
186+
* @param {Number} templateId id of the template
187+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
188+
*/
189+
this.deleteSmtpTemplate = function(templateId) {
190+
return this.deleteSmtpTemplateWithHttpInfo(templateId)
191+
.then(function(response_and_data) {
192+
return response_and_data.data;
193+
});
194+
}
195+
196+
148197
/**
149198
* Get your SMTP activity aggregated over a period of time
150199
* @param {Object} opts Optional parameters

0 commit comments

Comments
 (0)