Skip to content

Commit

Permalink
Merge pull request #29 from sendinblue/v5.2.0
Browse files Browse the repository at this point in the history
v5.2.0
  • Loading branch information
amitsendinblue authored Mar 25, 2021
2 parents c002120 + 026bd8d commit c4f97c6
Show file tree
Hide file tree
Showing 249 changed files with 1,295 additions and 707 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.sendinblue</groupId>
<artifactId>sib-api-v3-sdk</artifactId>
<version>5.1.0</version>
<version>5.2.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -32,20 +32,20 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.sendinblue:sib-api-v3-sdk:5.1.0"
compile "com.sendinblue:sib-api-v3-sdk:5.2.0"
```

### Others

At first generate the JAR by executing:

```shell
mvn package
mvn package
```

Then manually install the following JARs:

* `target/sib-api-v3-sdk-5.1.0.jar`
* `target/sib-api-v3-sdk-5.2.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -371,9 +371,12 @@ Class | Method | HTTP request | Description
- [SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
- [SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
- [SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
- [SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
- [SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
- [SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
- [SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
- [SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
- [SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
- [SendTemplateEmail](docs/SendTemplateEmail.md)
- [SendTestEmail](docs/SendTestEmail.md)
- [SendTestSms](docs/SendTestSms.md)
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'idea'
apply plugin: 'eclipse'

group = 'com.sendinblue'
version = '5.1.0'
version = '5.2.0'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "com.sendinblue",
name := "sib-api-v3-sdk",
version := "5.1.0",
version := "5.2.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
36 changes: 18 additions & 18 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -770,8 +770,8 @@ partnerKey.setApiKey("YOUR PARTNER KEY");

ContactsApi apiInstance = new ContactsApi();
String identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact
LocalDate startDate = LocalDate.now(); // LocalDate | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
LocalDate endDate = LocalDate.now(); // LocalDate | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
String startDate = "startDate_example"; // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
String endDate = "endDate_example"; // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
try {
GetContactCampaignStats result = apiInstance.getContactStats(identifier, startDate, endDate);
System.out.println(result);
Expand All @@ -786,8 +786,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
**startDate** | **LocalDate**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
**endDate** | **LocalDate**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
**startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
**endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]

### Return type

Expand Down Expand Up @@ -834,8 +834,8 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
ContactsApi apiInstance = new ContactsApi();
Long limit = 50L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document of the page
OffsetDateTime modifiedSince = OffsetDateTime.now(); // OffsetDateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String modifiedSince = "modifiedSince_example"; // String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetContacts result = apiInstance.getContacts(limit, offset, modifiedSince, sort);
System.out.println(result);
Expand All @@ -851,8 +851,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Long**| Number of documents per page | [optional] [default to 50]
**offset** | **Long**| Index of the first document of the page | [optional] [default to 0]
**modifiedSince** | **OffsetDateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**modifiedSince** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down Expand Up @@ -898,10 +898,10 @@ partnerKey.setApiKey("YOUR PARTNER KEY");

ContactsApi apiInstance = new ContactsApi();
Long listId = 789L; // Long | Id of the list
OffsetDateTime modifiedSince = OffsetDateTime.now(); // OffsetDateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
String modifiedSince = "modifiedSince_example"; // String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
Long limit = 50L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document of the page
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetContacts result = apiInstance.getContactsFromList(listId, modifiedSince, limit, offset, sort);
System.out.println(result);
Expand All @@ -916,10 +916,10 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**listId** | **Long**| Id of the list |
**modifiedSince** | **OffsetDateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**modifiedSince** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**limit** | **Long**| Number of documents per page | [optional] [default to 50]
**offset** | **Long**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down Expand Up @@ -1026,7 +1026,7 @@ ContactsApi apiInstance = new ContactsApi();
Long folderId = 789L; // Long | Id of the folder
Long limit = 10L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document of the page
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetFolderLists result = apiInstance.getFolderLists(folderId, limit, offset, sort);
System.out.println(result);
Expand All @@ -1043,7 +1043,7 @@ Name | Type | Description | Notes
**folderId** | **Long**| Id of the folder |
**limit** | **Long**| Number of documents per page | [optional] [default to 10]
**offset** | **Long**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down Expand Up @@ -1090,7 +1090,7 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
ContactsApi apiInstance = new ContactsApi();
Long limit = 10L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document of the page
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetFolders result = apiInstance.getFolders(limit, offset, sort);
System.out.println(result);
Expand All @@ -1106,7 +1106,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Long**| Number of documents per page | [default to 10]
**offset** | **Long**| Index of the first document of the page | [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down Expand Up @@ -1212,7 +1212,7 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
ContactsApi apiInstance = new ContactsApi();
Long limit = 10L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document of the page
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetLists result = apiInstance.getLists(limit, offset, sort);
System.out.println(result);
Expand All @@ -1228,7 +1228,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Long**| Number of documents per page | [optional] [default to 10]
**offset** | **Long**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**htmlContent** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
**htmlUrl** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
**templateId** | **Long** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status &#39;active&#39;. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
**scheduledAt** | [**OffsetDateTime**] | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
**scheduledAt** | **String** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
**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 |
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
**scheduledAt** | [**OffsetDateTime**] | 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]
**scheduledAt** | **String** | 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]



3 changes: 2 additions & 1 deletion docs/CreateSmtpEmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**messageId** | **String** | Message ID of the transactional email sent |
**messageId** | **String** | Message ID of the transactional email sent | [optional]
**messageIds** | **List&lt;String&gt;** | | [optional]



12 changes: 6 additions & 6 deletions docs/EmailCampaignsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,11 +349,11 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
EmailCampaignsApi apiInstance = new EmailCampaignsApi();
String type = "type_example"; // String | Filter on the type of the campaigns
String status = "status_example"; // String | Filter on the status of the campaign
OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
String startDate = "startDate_example"; // String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
String endDate = "endDate_example"; // String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
Long limit = 500L; // Long | Number of documents per page
Long offset = 0L; // Long | Index of the first document in the page
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation
String sort = "desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
try {
GetEmailCampaigns result = apiInstance.getEmailCampaigns(type, status, startDate, endDate, limit, offset, sort);
System.out.println(result);
Expand All @@ -369,11 +369,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | **String**| Filter on the type of the campaigns | [optional] [enum: classic, trigger]
**status** | **String**| Filter on the status of the campaign | [optional] [enum: suspended, archive, sent, queued, draft, inProcess]
**startDate** | **OffsetDateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
**endDate** | **OffsetDateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
**startDate** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
**endDate** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
**limit** | **Long**| Number of documents per page | [optional] [default to 500]
**offset** | **Long**| Index of the first document in the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] [enum: asc, desc]
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] [enum: asc, desc]

### Return type

Expand Down
Loading

0 comments on commit c4f97c6

Please sign in to comment.