Add/Remove contact to list spec update + email event report non-mandatory fields removed

Author: ekta-slit

LICENSE.md

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2017, SendinBlue
+Copyright (c) 2018, SendinBlue
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
@@ -12,4 +12,4 @@ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -9,7 +9,7 @@ SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/).
 This library is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:
 
 - API version: 3.0.0
-- Package version: 4.0.x
+- Package version: 5.0.x
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -133,7 +133,7 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk.ContactsApi* | [**getList**](docs/ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
 *SibApiV3Sdk.ContactsApi* | [**getLists**](docs/ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
 *SibApiV3Sdk.ContactsApi* | [**importContacts**](docs/ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
-*SibApiV3Sdk.ContactsApi* | [**removeContactToList**](docs/ContactsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+*SibApiV3Sdk.ContactsApi* | [**removeContactFromList**](docs/ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 *SibApiV3Sdk.ContactsApi* | [**requestContactExport**](docs/ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
 *SibApiV3Sdk.ContactsApi* | [**updateAttribute**](docs/ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 *SibApiV3Sdk.ContactsApi* | [**updateContact**](docs/ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
@@ -162,7 +162,7 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk.ListsApi* | [**getFolderLists**](docs/ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
 *SibApiV3Sdk.ListsApi* | [**getList**](docs/ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
 *SibApiV3Sdk.ListsApi* | [**getLists**](docs/ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
-*SibApiV3Sdk.ListsApi* | [**removeContactToList**](docs/ListsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+*SibApiV3Sdk.ListsApi* | [**removeContactFromList**](docs/ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 *SibApiV3Sdk.ListsApi* | [**updateList**](docs/ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
 *SibApiV3Sdk.ProcessApi* | [**getProcess**](docs/ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
 *SibApiV3Sdk.ProcessApi* | [**getProcesses**](docs/ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account
@@ -216,8 +216,8 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [SibApiV3Sdk.AddContactToList](docs/AddContactToList.md)
  - [SibApiV3Sdk.AddCredits](docs/AddCredits.md)
- - [SibApiV3Sdk.AddRemoveContactToList](docs/AddRemoveContactToList.md)
  - [SibApiV3Sdk.CreateAttribute](docs/CreateAttribute.md)
  - [SibApiV3Sdk.CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
  - [SibApiV3Sdk.CreateChild](docs/CreateChild.md)
@@ -319,6 +319,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk.RemainingCreditModel](docs/RemainingCreditModel.md)
  - [SibApiV3Sdk.RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
  - [SibApiV3Sdk.RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
+ - [SibApiV3Sdk.RemoveContactFromList](docs/RemoveContactFromList.md)
  - [SibApiV3Sdk.RemoveCredits](docs/RemoveCredits.md)
  - [SibApiV3Sdk.RequestContactExport](docs/RequestContactExport.md)
  - [SibApiV3Sdk.RequestContactImport](docs/RequestContactImport.md)

docs/AddContactToList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk.AddContactToList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **[String]** | Emails to add to a list | [optional] 
+
+

docs/AddRemoveContactToList.md

@@ -23,7 +23,7 @@ Method | HTTP request | Description
 [**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
 [**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
 [**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
-[**removeContactToList**](ContactsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 [**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
 [**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 [**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
@@ -52,7 +52,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
 
 var listId = 789; // Number | Id of the list
 
-var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails addresses of the contacts
+var contactEmails = new SibApiV3Sdk.AddContactToList(); // AddContactToList | Emails addresses of the contacts
 
 apiInstance.addContactToList(listId, contactEmails).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
@@ -67,7 +67,7 @@ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **listId** | **Number**| Id of the list | 
- **contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts | 
+ **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
 
 ### Return type
 
@@ -976,9 +976,9 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
-<a name="removeContactToList"></a>
-# **removeContactToList**
-> PostContactInfo removeContactToList(listId, contactEmails)
+<a name="removeContactFromList"></a>
+# **removeContactFromList**
+> PostContactInfo removeContactFromList(listId, contactEmails)
 
 Remove existing contacts from a list
 
@@ -997,9 +997,9 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
 
 var listId = 789; // Number | Id of the list
 
-var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails adresses of the contact
+var contactEmails = new SibApiV3Sdk.RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
 
-apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
+apiInstance.removeContactFromList(listId, contactEmails).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
 }, function(error) {
   console.error(error);
@@ -1012,7 +1012,7 @@ apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **listId** | **Number**| Id of the list | 
- **contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact | 
+ **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
 
 ### Return type
 

docs/ContactsApi.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [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] 
+**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] 
 **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]

docs/CreateEmailCampaign.md

@@ -9,10 +9,10 @@ Name | Type | Description | Notes
 **messageId** | **String** | Message ID which generated the event | 
 **event** | **String** | Event which occurred | 
 **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 
-**tag** | **String** | Tag of the email which generated the event | 
+**tag** | **String** | Tag of the email which generated the event | [optional] 
 **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] 
 **link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional] 
-**from** | **String** | Sender email from which the emails are sent | 
+**from** | **String** | Sender email from which the emails are sent | [optional] 
 
 
 <a name="EventEnum"></a>

docs/GetEmailEventReportEvents.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 [**getFolderLists**](ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
 [**getList**](ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
 [**getLists**](ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
-[**removeContactToList**](ListsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+[**removeContactFromList**](ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 [**updateList**](ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
 
 
@@ -36,7 +36,7 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
 
 var listId = 789; // Number | Id of the list
 
-var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails addresses of the contacts
+var contactEmails = new SibApiV3Sdk.AddContactToList(); // AddContactToList | Emails addresses of the contacts
 
 apiInstance.addContactToList(listId, contactEmails).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
@@ -51,7 +51,7 @@ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **listId** | **Number**| Id of the list | 
- **contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts | 
+ **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
 
 ### Return type
 
@@ -371,9 +371,9 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
-<a name="removeContactToList"></a>
-# **removeContactToList**
-> PostContactInfo removeContactToList(listId, contactEmails)
+<a name="removeContactFromList"></a>
+# **removeContactFromList**
+> PostContactInfo removeContactFromList(listId, contactEmails)
 
 Remove existing contacts from a list
 
@@ -392,9 +392,9 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
 
 var listId = 789; // Number | Id of the list
 
-var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails adresses of the contact
+var contactEmails = new SibApiV3Sdk.RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
 
-apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
+apiInstance.removeContactFromList(listId, contactEmails).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
 }, function(error) {
   console.error(error);
@@ -407,7 +407,7 @@ apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **listId** | **Number**| Id of the list | 
- **contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact | 
+ **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
 
 ### Return type
 

docs/ListsApi.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk.RemoveContactFromList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **[String]** | Required if 'all' is false. Emails to remove from a list | [optional] 
+**all** | **Boolean** | Required if 'emails' is empty. Remove all existing contacts from a list | [optional] 
+
+

docs/RemoveContactFromList.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [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] 
+**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] 
 **recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]

docs/UpdateEmailCampaign.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **htmlUrl** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
 **subject** | **String** | Subject of the email | [optional] 
 **replyTo** | **String** | Email on which 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, add [FNAME] [LNAME]. These attributes must already exist in contacts database | [optional] 
+**toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **isActive** | **Boolean** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional]