Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ var defaultClient = SibApiV3Sdk.ApiClient.instance;
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix = 'Token';
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.ContactsApi();

Expand Down Expand Up @@ -587,7 +587,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
var opts = {
'limit': 50, // Number | Number of documents per page
'offset': 0, // Number | Index of the first document of the page
'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)
'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)
};
apiInstance.getContacts(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
Expand All @@ -603,7 +603,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]

### Return type

Expand Down Expand Up @@ -640,7 +640,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
var listId = 789; // Number | Id of the list

var opts = {
'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)
'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)
'limit': 50, // Number | Number of documents per page
'offset': 0 // Number | Index of the first document of the page
};
Expand All @@ -657,7 +657,7 @@ apiInstance.getContactsFromList(listId, opts).then(function(data) {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**listId** | **Number**| Id of the list |
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the campaign |
**htmlContent** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
**htmlUrl** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
**scheduledAt** | **Date** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**subject** | **String** | Subject of the campaign |
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
**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]
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Name | Type | Description | Notes
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
**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]
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
**scheduledAt** | **Date** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]


2 changes: 1 addition & 1 deletion docs/GetCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**subject** | **String** | Subject of the campaign |
**type** | **String** | Type of campaign |
**status** | **String** | Status of the campaign |
**scheduledAt** | **Date** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduledAt** | **Date** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]


<a name="TypeEnum"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/GetContactCampaignStatsOpened.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignId** | **Number** | ID of the campaign which generated the event |
**count** | **Number** | Number of openings of the campaign |
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |
**ip** | **String** | IP from which the user has opened the campaign |


2 changes: 1 addition & 1 deletion docs/GetContactDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **Number** | ID of the contact for which you requested the details |
**emailBlacklisted** | **Boolean** | Blacklist status for email campaigns (true&#x3D;blacklisted, false&#x3D;not blacklisted) |
**smsBlacklisted** | **Boolean** | Blacklist status for SMS campaigns (true&#x3D;blacklisted, false&#x3D;not blacklisted) |
**modifiedAt** | **Date** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**listIds** | **[Number]** | |
**listUnsubscribed** | **[Number]** | | [optional]
**attributes** | **{String: String}** | |
Expand Down
2 changes: 1 addition & 1 deletion docs/GetEmailEventReportEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **String** | Email address which generates the event |
**_date** | **Date** | Date on which the event has been generated |
**_date** | **Date** | UTC date-time on which the event has been generated |
**subject** | **String** | Subject of the event | [optional]
**messageId** | **String** | Message ID which generated the event |
**event** | **String** | Event which occurred |
Expand Down
4 changes: 2 additions & 2 deletions docs/GetExtendedCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Name | Type | Description | Notes
**htmlContent** | **String** | HTML content of the campaign |
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
**tag** | **String** | Tag of the campaign |
**createdAt** | **Date** | Creation date of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Date of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**createdAt** | **Date** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**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]
**mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive &#x3D; false means mirror links are deactivated, &amp; mirrorActive &#x3D; true means mirror links are activated, in the campaign | [optional]
**recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring &#x3D; false means contact can receive the same Trigger campaign only once, &amp; recurring &#x3D; true means contact can receive the same Trigger campaign several times | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **Number** | Number of clicks on this link for the campaign |
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |
**ip** | **String** | IP from which the user has clicked on the link |
**url** | **String** | URL of the clicked link |

Expand Down
2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsMessagesSent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignId** | **Number** | ID of the campaign which generated the event |
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |


2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsOpened.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignId** | **Number** | ID of the campaign which generated the event |
**count** | **Number** | Number of openings for the campaign |
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |
**ip** | **String** | IP from which the user has opened the email |


Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |
**ip** | **String** | IP from which the user has been unsubscribed |


Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaignId** | **Number** | ID of the campaign which generated the event |
**eventTime** | **Date** | Date of the event |
**eventTime** | **Date** | UTC date-time of the event |
**ip** | **String** | IP from which the user has unsubscribed |


2 changes: 1 addition & 1 deletion docs/GetExtendedList.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**folderId** | **Number** | ID of the folder |
**createdAt** | **Date** | Creation Date of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**createdAt** | **Date** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**campaignStats** | [**[GetExtendedListCampaignStats]**](GetExtendedListCampaignStats.md) | | [optional]
**dynamicList** | **Boolean** | Status telling if the list is dynamic or not (true&#x3D;dynamic, false&#x3D;not dynamic) | [optional]

Expand Down
6 changes: 3 additions & 3 deletions docs/GetSmsCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Name | Type | Description | Notes
**name** | **String** | Name of the SMS Campaign |
**status** | **String** | Status of the SMS Campaign |
**content** | **String** | Content of the SMS Campaign |
**scheduledAt** | **Date** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**scheduledAt** | **Date** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**testSent** | **Boolean** | Retrieved the status of test SMS sending. (true&#x3D;Test SMS has been sent false&#x3D;Test SMS has not been sent) |
**sender** | **String** | Sender of the SMS Campaign |
**createdAt** | **Date** | Creation date of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Date of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**createdAt** | **Date** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |


<a name="StatusEnum"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/GetSmtpTemplateOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**toField** | **String** | Customisation of the \&quot;to\&quot; field for the template |
**tag** | **String** | Tag of the template |
**htmlContent** | **String** | HTML content of the template |
**createdAt** | **Date** | Creation date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Last modification date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**createdAt** | **Date** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |


4 changes: 2 additions & 2 deletions docs/GetWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Name | Type | Description | Notes
**description** | **String** | Description of the webhook |
**events** | **[String]** | |
**type** | **String** | Type of webhook (marketing or transac) |
**createdAt** | **Date** | Creation date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Last modification date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**createdAt** | **Date** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modifiedAt** | **Date** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |


<a name="TypeEnum"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ListsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
var listId = 789; // Number | Id of the list

var opts = {
'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)
'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)
'limit': 50, // Number | Number of documents per page
'offset': 0 // Number | Index of the first document of the page
};
Expand All @@ -201,7 +201,7 @@ apiInstance.getContactsFromList(listId, opts).then(function(data) {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**listId** | **Number**| Id of the list |
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**limit** | **Number**| Number of documents per page | [optional] [default to 50]
**offset** | **Number**| Index of the first document of the page | [optional] [default to 0]

Expand Down
6 changes: 3 additions & 3 deletions docs/SMTPApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = 'YOUR API KEY';
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix = 'Token';
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.SMTPApi();

Expand Down
4 changes: 2 additions & 2 deletions docs/UpdateAttributeEnumeration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Id of the value | [optional]
**label** | **String** | Label of the value | [optional]
**value** | **Number** | Id of the value |
**label** | **String** | Label of the value |


2 changes: 1 addition & 1 deletion docs/UpdateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the campaign | [optional]
**htmlContent** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional]
**htmlUrl** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
**scheduledAt** | **Date** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**subject** | **String** | Subject of the campaign | [optional]
**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
**toField** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/UpdateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Name | Type | Description | Notes
**sender** | **String** | Name of the sender. The number of characters is limited to 11 | [optional]
**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]
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
**scheduledAt** | **Date** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]


2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sib-api-v3-sdk",
"version": "3.1.4",
"version": "3.1.5",
"description": "Official SendinBlue provided RESTFul API V3 nodejs library",
"license": "ISC",
"main": "src/index.js",
Expand Down
8 changes: 4 additions & 4 deletions src/api/ContactsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@
* @param {Object} opts Optional parameters
* @param {Number} opts.limit Number of documents per page (default to 50)
* @param {Number} opts.offset Index of the first document of the page (default to 0)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContacts} and HTTP response
*/
this.getContactsWithHttpInfo = function(opts) {
Expand Down Expand Up @@ -649,7 +649,7 @@
* @param {Object} opts Optional parameters
* @param {Number} opts.limit Number of documents per page (default to 50)
* @param {Number} opts.offset Index of the first document of the page (default to 0)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContacts}
*/
this.getContacts = function(opts) {
Expand All @@ -664,7 +664,7 @@
* Get the contacts in a list
* @param {Number} listId Id of the list
* @param {Object} opts Optional parameters
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Number} opts.limit Number of documents per page (default to 50)
* @param {Number} opts.offset Index of the first document of the page (default to 0)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetContacts} and HTTP response
Expand Down Expand Up @@ -708,7 +708,7 @@
* Get the contacts in a list
* @param {Number} listId Id of the list
* @param {Object} opts Optional parameters
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Date} opts.modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
* @param {Number} opts.limit Number of documents per page (default to 50)
* @param {Number} opts.offset Index of the first document of the page (default to 0)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetContacts}
Expand Down
Loading