Skip to content

Commit 10496ef

Browse files
committed
Add/Remove contact to list spec update + email event report non-mandatory fields removed
1 parent 5770a09 commit 10496ef

File tree

179 files changed

+470
-291
lines changed

Some content is hidden

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

179 files changed

+470
-291
lines changed

LICENSE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ISC License
22

3-
Copyright (c) 2017, SendinBlue
3+
Copyright (c) 2018, SendinBlue
44

55
Permission to use, copy, modify, and/or distribute this software for any
66
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
1212
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1313
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1414
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15-
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

+5-4
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: 4.0.x
12+
- Package version: 5.0.x
1313
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
1414

1515
## Installation
@@ -133,7 +133,7 @@ Class | Method | HTTP request | Description
133133
*SibApiV3Sdk.ContactsApi* | [**getList**](docs/ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
134134
*SibApiV3Sdk.ContactsApi* | [**getLists**](docs/ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
135135
*SibApiV3Sdk.ContactsApi* | [**importContacts**](docs/ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
136-
*SibApiV3Sdk.ContactsApi* | [**removeContactToList**](docs/ContactsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
136+
*SibApiV3Sdk.ContactsApi* | [**removeContactFromList**](docs/ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
137137
*SibApiV3Sdk.ContactsApi* | [**requestContactExport**](docs/ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
138138
*SibApiV3Sdk.ContactsApi* | [**updateAttribute**](docs/ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
139139
*SibApiV3Sdk.ContactsApi* | [**updateContact**](docs/ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
@@ -162,7 +162,7 @@ Class | Method | HTTP request | Description
162162
*SibApiV3Sdk.ListsApi* | [**getFolderLists**](docs/ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
163163
*SibApiV3Sdk.ListsApi* | [**getList**](docs/ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
164164
*SibApiV3Sdk.ListsApi* | [**getLists**](docs/ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
165-
*SibApiV3Sdk.ListsApi* | [**removeContactToList**](docs/ListsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
165+
*SibApiV3Sdk.ListsApi* | [**removeContactFromList**](docs/ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
166166
*SibApiV3Sdk.ListsApi* | [**updateList**](docs/ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
167167
*SibApiV3Sdk.ProcessApi* | [**getProcess**](docs/ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
168168
*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
216216

217217
## Documentation for Models
218218

219+
- [SibApiV3Sdk.AddContactToList](docs/AddContactToList.md)
219220
- [SibApiV3Sdk.AddCredits](docs/AddCredits.md)
220-
- [SibApiV3Sdk.AddRemoveContactToList](docs/AddRemoveContactToList.md)
221221
- [SibApiV3Sdk.CreateAttribute](docs/CreateAttribute.md)
222222
- [SibApiV3Sdk.CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
223223
- [SibApiV3Sdk.CreateChild](docs/CreateChild.md)
@@ -319,6 +319,7 @@ Class | Method | HTTP request | Description
319319
- [SibApiV3Sdk.RemainingCreditModel](docs/RemainingCreditModel.md)
320320
- [SibApiV3Sdk.RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
321321
- [SibApiV3Sdk.RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
322+
- [SibApiV3Sdk.RemoveContactFromList](docs/RemoveContactFromList.md)
322323
- [SibApiV3Sdk.RemoveCredits](docs/RemoveCredits.md)
323324
- [SibApiV3Sdk.RequestContactExport](docs/RequestContactExport.md)
324325
- [SibApiV3Sdk.RequestContactImport](docs/RequestContactImport.md)

docs/AddContactToList.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk.AddContactToList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**emails** | **[String]** | Emails to add to a list | [optional]
7+
8+

docs/AddRemoveContactToList.md

-8
This file was deleted.

docs/ContactsApi.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Method | HTTP request | Description
2323
[**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
2424
[**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
2525
[**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
26-
[**removeContactToList**](ContactsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
26+
[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
2727
[**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
2828
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
2929
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
@@ -52,7 +52,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
5252

5353
var listId = 789; // Number | Id of the list
5454

55-
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails addresses of the contacts
55+
var contactEmails = new SibApiV3Sdk.AddContactToList(); // AddContactToList | Emails addresses of the contacts
5656

5757
apiInstance.addContactToList(listId, contactEmails).then(function(data) {
5858
console.log('API called successfully. Returned data: ' + data);
@@ -67,7 +67,7 @@ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
6767
Name | Type | Description | Notes
6868
------------- | ------------- | ------------- | -------------
6969
**listId** | **Number**| Id of the list |
70-
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
70+
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
7171

7272
### Return type
7373

@@ -976,9 +976,9 @@ Name | Type | Description | Notes
976976
- **Content-Type**: application/json
977977
- **Accept**: application/json
978978

979-
<a name="removeContactToList"></a>
980-
# **removeContactToList**
981-
> PostContactInfo removeContactToList(listId, contactEmails)
979+
<a name="removeContactFromList"></a>
980+
# **removeContactFromList**
981+
> PostContactInfo removeContactFromList(listId, contactEmails)
982982
983983
Remove existing contacts from a list
984984

@@ -997,9 +997,9 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
997997

998998
var listId = 789; // Number | Id of the list
999999

1000-
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails adresses of the contact
1000+
var contactEmails = new SibApiV3Sdk.RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
10011001

1002-
apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
1002+
apiInstance.removeContactFromList(listId, contactEmails).then(function(data) {
10031003
console.log('API called successfully. Returned data: ' + data);
10041004
}, function(error) {
10051005
console.error(error);
@@ -1012,7 +1012,7 @@ apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
10121012
Name | Type | Description | Notes
10131013
------------- | ------------- | ------------- | -------------
10141014
**listId** | **Number**| Id of the list |
1015-
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
1015+
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
10161016

10171017
### Return type
10181018

docs/CreateEmailCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**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]
1212
**subject** | **String** | Subject of the campaign |
1313
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
14-
**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]
14+
**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]
1515
**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
1616
**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]
1717
**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/GetEmailEventReportEvents.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Name | Type | Description | Notes
99
**messageId** | **String** | Message ID which generated the event |
1010
**event** | **String** | Event which occurred |
1111
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
12-
**tag** | **String** | Tag of the email which generated the event |
12+
**tag** | **String** | Tag of the email which generated the event | [optional]
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]
15-
**from** | **String** | Sender email from which the emails are sent |
15+
**from** | **String** | Sender email from which the emails are sent | [optional]
1616

1717

1818
<a name="EventEnum"></a>

docs/ListsApi.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Method | HTTP request | Description
1111
[**getFolderLists**](ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
1212
[**getList**](ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
1313
[**getLists**](ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
14-
[**removeContactToList**](ListsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
14+
[**removeContactFromList**](ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
1515
[**updateList**](ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
1616

1717

@@ -36,7 +36,7 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
3636

3737
var listId = 789; // Number | Id of the list
3838

39-
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails addresses of the contacts
39+
var contactEmails = new SibApiV3Sdk.AddContactToList(); // AddContactToList | Emails addresses of the contacts
4040

4141
apiInstance.addContactToList(listId, contactEmails).then(function(data) {
4242
console.log('API called successfully. Returned data: ' + data);
@@ -51,7 +51,7 @@ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
5151
Name | Type | Description | Notes
5252
------------- | ------------- | ------------- | -------------
5353
**listId** | **Number**| Id of the list |
54-
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
54+
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
5555

5656
### Return type
5757

@@ -371,9 +371,9 @@ Name | Type | Description | Notes
371371
- **Content-Type**: application/json
372372
- **Accept**: application/json
373373

374-
<a name="removeContactToList"></a>
375-
# **removeContactToList**
376-
> PostContactInfo removeContactToList(listId, contactEmails)
374+
<a name="removeContactFromList"></a>
375+
# **removeContactFromList**
376+
> PostContactInfo removeContactFromList(listId, contactEmails)
377377
378378
Remove existing contacts from a list
379379

@@ -392,9 +392,9 @@ var apiInstance = new SibApiV3Sdk.ListsApi();
392392

393393
var listId = 789; // Number | Id of the list
394394

395-
var contactEmails = new SibApiV3Sdk.AddRemoveContactToList(); // AddRemoveContactToList | Emails adresses of the contact
395+
var contactEmails = new SibApiV3Sdk.RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
396396

397-
apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
397+
apiInstance.removeContactFromList(listId, contactEmails).then(function(data) {
398398
console.log('API called successfully. Returned data: ' + data);
399399
}, function(error) {
400400
console.error(error);
@@ -407,7 +407,7 @@ apiInstance.removeContactToList(listId, contactEmails).then(function(data) {
407407
Name | Type | Description | Notes
408408
------------- | ------------- | ------------- | -------------
409409
**listId** | **Number**| Id of the list |
410-
**contactEmails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
410+
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
411411

412412
### Return type
413413

docs/RemoveContactFromList.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk.RemoveContactFromList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**emails** | **[String]** | Required if &#39;all&#39; is false. Emails to remove from a list | [optional]
7+
**all** | **Boolean** | Required if &#39;emails&#39; is empty. Remove all existing contacts from a list | [optional]
8+
9+

docs/UpdateEmailCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**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]
1212
**subject** | **String** | Subject of the campaign | [optional]
1313
**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
14-
**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]
14+
**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]
1515
**recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional]
1616
**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]
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. 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/UpdateSmtpTemplate.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**htmlUrl** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional]
1111
**subject** | **String** | Subject of the email | [optional]
1212
**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
13-
**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]
13+
**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]
1414
**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]
1515
**isActive** | **Boolean** | Status of the template. isActive &#x3D; false means template is inactive, isActive &#x3D; true means template is active | [optional]
1616

0 commit comments

Comments
 (0)