Skip to content

Commit e3caaf3

Browse files
Merge pull request #59 from sendinblue/feature_updated_swagger_sync
Swagger updates for date format and some minor fixes
2 parents e9a0c47 + 77597a3 commit e3caaf3

11 files changed

+69
-72
lines changed

docs/DeleteHardbounces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**startDate** | **Date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7-
**endDate** | **Date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
6+
**startDate** | **String** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7+
**endDate** | **String** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
88
**contactEmail** | **String** | Target a specific email address | [optional]
99

1010

docs/GetAttributesAttributes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Name | Type | Description | Notes
3939

4040
* `id` (value: `"id"`)
4141

42+
* `boolean` (value: `"boolean"`)
43+
4244

4345

4446

docs/SMSCampaignsApi.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ null (empty response body)
126126

127127
<a name="getSmsCampaign"></a>
128128
# **getSmsCampaign**
129-
> GetSmsCampaign getSmsCampaign(campaignId, getSmsCampaign)
129+
> GetSmsCampaign getSmsCampaign(campaignId)
130130
131131
Get an SMS campaign
132132

@@ -151,9 +151,7 @@ var apiInstance = new SibApiV3Sdk.SMSCampaignsApi();
151151

152152
var campaignId = 789; // Number | id of the SMS campaign
153153

154-
var getSmsCampaign = new SibApiV3Sdk.GetSmsCampaign(); // GetSmsCampaign | Values to update an SMS Campaign
155-
156-
apiInstance.getSmsCampaign(campaignId, getSmsCampaign).then(function(data) {
154+
apiInstance.getSmsCampaign(campaignId).then(function(data) {
157155
console.log('API called successfully. Returned data: ' + data);
158156
}, function(error) {
159157
console.error(error);
@@ -166,7 +164,6 @@ apiInstance.getSmsCampaign(campaignId, getSmsCampaign).then(function(data) {
166164
Name | Type | Description | Notes
167165
------------- | ------------- | ------------- | -------------
168166
**campaignId** | **Number**| id of the SMS campaign |
169-
**getSmsCampaign** | [**GetSmsCampaign**](GetSmsCampaign.md)| Values to update an SMS Campaign |
170167

171168
### Return type
172169

docs/SMTPApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,8 @@ partnerKey.apiKey = 'YOUR API KEY';
209209
var apiInstance = new SibApiV3Sdk.SMTPApi();
210210

211211
var opts = {
212-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
213-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
212+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
213+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
214214
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
215215
'tag': "tag_example" // String | Tag of the emails
216216
};
@@ -226,8 +226,8 @@ apiInstance.getAggregatedSmtpReport(opts).then(function(data) {
226226

227227
Name | Type | Description | Notes
228228
------------- | ------------- | ------------- | -------------
229-
**startDate** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
230-
**endDate** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
229+
**startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
230+
**endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
231231
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
232232
**tag** | **String**| Tag of the emails | [optional]
233233

@@ -272,8 +272,8 @@ var apiInstance = new SibApiV3Sdk.SMTPApi();
272272
var opts = {
273273
'limit': 50, // Number | Number limitation for the result returned
274274
'offset': 0, // Number | Beginning point in the list to retrieve from.
275-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
276-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
275+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
276+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
277277
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
278278
'email': "email_example", // String | Filter the report for a specific email addresses
279279
'event': "event_example", // String | Filter the report for a specific event type
@@ -295,8 +295,8 @@ Name | Type | Description | Notes
295295
------------- | ------------- | ------------- | -------------
296296
**limit** | **Number**| Number limitation for the result returned | [optional] [default to 50]
297297
**offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
298-
**startDate** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
299-
**endDate** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
298+
**startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
299+
**endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
300300
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
301301
**email** | **String**| Filter the report for a specific email addresses | [optional]
302302
**event** | **String**| Filter the report for a specific event type | [optional]
@@ -345,8 +345,8 @@ var apiInstance = new SibApiV3Sdk.SMTPApi();
345345
var opts = {
346346
'limit': 50, // Number | Number of documents returned per page
347347
'offset': 0, // Number | Index of the first document on the page
348-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
349-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
348+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
349+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
350350
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
351351
'tag': "tag_example" // String | Tag of the emails
352352
};
@@ -364,8 +364,8 @@ Name | Type | Description | Notes
364364
------------- | ------------- | ------------- | -------------
365365
**limit** | **Number**| Number of documents returned per page | [optional] [default to 50]
366366
**offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
367-
**startDate** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
368-
**endDate** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
367+
**startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
368+
**endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
369369
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
370370
**tag** | **String**| Tag of the emails | [optional]
371371

docs/TransactionalSMSApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ var apiInstance = new SibApiV3Sdk.TransactionalSMSApi();
3737

3838
var opts = {
3939
'limit': 50, // Number | Number of documents per page
40-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
41-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
40+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
41+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
4242
'offset': 0, // Number | Index of the first document of the page
4343
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
4444
'phoneNumber': "phoneNumber_example", // String | Filter the report for a specific phone number
@@ -58,8 +58,8 @@ apiInstance.getSmsEvents(opts).then(function(data) {
5858
Name | Type | Description | Notes
5959
------------- | ------------- | ------------- | -------------
6060
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
61-
**startDate** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
62-
**endDate** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
61+
**startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
62+
**endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
6363
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
6464
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
6565
**phoneNumber** | **String**| Filter the report for a specific phone number | [optional]
@@ -105,8 +105,8 @@ partnerKey.apiKey = 'YOUR API KEY';
105105
var apiInstance = new SibApiV3Sdk.TransactionalSMSApi();
106106

107107
var opts = {
108-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
109-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
108+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
109+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
110110
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
111111
'tag': "tag_example" // String | Filter on a tag
112112
};
@@ -122,8 +122,8 @@ apiInstance.getTransacAggregatedSmsReport(opts).then(function(data) {
122122

123123
Name | Type | Description | Notes
124124
------------- | ------------- | ------------- | -------------
125-
**startDate** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
126-
**endDate** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
125+
**startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
126+
**endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
127127
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
128128
**tag** | **String**| Filter on a tag | [optional]
129129

@@ -166,8 +166,8 @@ partnerKey.apiKey = 'YOUR API KEY';
166166
var apiInstance = new SibApiV3Sdk.TransactionalSMSApi();
167167

168168
var opts = {
169-
'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
170-
'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
169+
'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
170+
'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
171171
'days': 56, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
172172
'tag': "tag_example" // String | Filter on a tag
173173
};
@@ -183,8 +183,8 @@ apiInstance.getTransacSmsReport(opts).then(function(data) {
183183

184184
Name | Type | Description | Notes
185185
------------- | ------------- | ------------- | -------------
186-
**startDate** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
187-
**endDate** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
186+
**startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
187+
**endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
188188
**days** | **Number**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
189189
**tag** | **String**| Filter on a tag | [optional]
190190

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": "7.1.1",
3+
"version": "7.1.2",
44
"description": "Official SendinBlue provided RESTFul API V3 nodejs library",
55
"license": "ISC",
66
"main": "src/index.js",

src/api/SMSCampaignsApi.js

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -153,22 +153,16 @@
153153
/**
154154
* Get an SMS campaign
155155
* @param {Number} campaignId id of the SMS campaign
156-
* @param {module:model/GetSmsCampaign} getSmsCampaign Values to update an SMS Campaign
157156
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetSmsCampaign} and HTTP response
158157
*/
159-
this.getSmsCampaignWithHttpInfo = function(campaignId, getSmsCampaign) {
160-
var postBody = getSmsCampaign;
158+
this.getSmsCampaignWithHttpInfo = function(campaignId) {
159+
var postBody = null;
161160

162161
// verify the required parameter 'campaignId' is set
163162
if (campaignId === undefined || campaignId === null) {
164163
throw new Error("Missing the required parameter 'campaignId' when calling getSmsCampaign");
165164
}
166165

167-
// verify the required parameter 'getSmsCampaign' is set
168-
if (getSmsCampaign === undefined || getSmsCampaign === null) {
169-
throw new Error("Missing the required parameter 'getSmsCampaign' when calling getSmsCampaign");
170-
}
171-
172166

173167
var pathParams = {
174168
'campaignId': campaignId
@@ -197,11 +191,10 @@
197191
/**
198192
* Get an SMS campaign
199193
* @param {Number} campaignId id of the SMS campaign
200-
* @param {module:model/GetSmsCampaign} getSmsCampaign Values to update an SMS Campaign
201194
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetSmsCampaign}
202195
*/
203-
this.getSmsCampaign = function(campaignId, getSmsCampaign) {
204-
return this.getSmsCampaignWithHttpInfo(campaignId, getSmsCampaign)
196+
this.getSmsCampaign = function(campaignId) {
197+
return this.getSmsCampaignWithHttpInfo(campaignId)
205198
.then(function(response_and_data) {
206199
return response_and_data.data;
207200
});

0 commit comments

Comments
 (0)