Skip to content

Commit

Permalink
Merge pull request #35 from sendinblue/6.0.0
Browse files Browse the repository at this point in the history
AP-1634 : Release includes major changes.
  • Loading branch information
ashvini-sib authored Mar 9, 2022
2 parents cea3343 + 20f917c commit d932cda
Show file tree
Hide file tree
Showing 322 changed files with 15,901 additions and 4,866 deletions.
Binary file added .DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.4.9
2.4.26
6 changes: 3 additions & 3 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.3.0</version>
<version>6.0.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -32,7 +32,7 @@ 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.3.0"
compile "com.sendinblue:sib-api-v3-sdk:6.0.0"
```

### Others
Expand All @@ -45,7 +45,7 @@ mvn package

Then manually install the following JARs:

* `target/sib-api-v3-sdk-5.3.0.jar`
* `target/sib-api-v3-sdk-6.0.0.jar`
* `target/lib/*.jar`

## Getting Started
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.3.0'
version = '6.0.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.3.0",
version := "6.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
20 changes: 20 additions & 0 deletions docs/Body.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

# Body

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of task |
**duration** | **Long** | Duration of task | [optional]
**taskTypeId** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
**date** | [**OffsetDateTime**] | Task date/time |
**notes** | **String** | Notes added to a task | [optional]
**done** | **Boolean** | Task marked as done | [optional]
**assignToId** | **String** | User id to whom task is assigned | [optional]
**contactsIds** | **List&lt;Integer&gt;** | Contact ids for contacts linked to this task | [optional]
**dealsIds** | **List&lt;String&gt;** | Deal ids for deals a task is linked to | [optional]
**companiesIds** | **List&lt;String&gt;** | Companies ids for companies a task is linked to | [optional]
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]



20 changes: 20 additions & 0 deletions docs/Body1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

# Body1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of task |
**duration** | **Integer** | Duration of task | [optional]
**taskTypeId** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
**date** | [**OffsetDateTime**] | Task date/time |
**notes** | **String** | Notes added to a task | [optional]
**done** | **Boolean** | Task marked as done | [optional]
**assignToId** | **String** | User id to whom task is assigned | [optional]
**contactsIds** | **List&lt;Integer&gt;** | Contact ids for contacts linked to this task | [optional]
**dealsIds** | **List&lt;String&gt;** | Deal ids for deals a task is linked to | [optional]
**companiesIds** | **List&lt;String&gt;** | Companies ids for companies a task is linked to | [optional]
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]



17 changes: 17 additions & 0 deletions docs/Contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

# Contact

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**virtualNextTask** | **Object** | Next incomplete task of contact | [optional]
**email** | **String** | Contact email |
**assignToId** | **String** | User id to whom contact is assigned | [optional]
**contactsId** | **Integer** | Contact id | [optional]
**crmLists** | **Object** | CRM lists in which contact is added |
**attributes** | **Object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional]
**createdAt** | [**OffsetDateTime**] | Contact created date/time | [optional]
**updatedAt** | [**OffsetDateTime**] | Contact updated date/time | [optional]



65 changes: 63 additions & 2 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Method | HTTP request | Description
[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
[**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
[**updateBatchContacts**](ContactsApi.md#updateBatchContacts) | **POST** /contacts/batch | Update multiple contacts
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{identifier} | Update a contact
[**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
[**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
Expand Down Expand Up @@ -686,6 +687,8 @@ This endpoint does not need any parameter.
Get a contact&#39;s details

Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.

### Example
```java
// Import classes:
Expand Down Expand Up @@ -771,7 +774,7 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
ContactsApi apiInstance = new ContactsApi();
String identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact
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
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. Maximum difference between startDate and endDate should not be greater than 90 days
try {
GetContactCampaignStats result = apiInstance.getContactStats(identifier, startDate, endDate);
System.out.println(result);
Expand All @@ -787,7 +790,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
**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]
**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. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]

### Return type

Expand Down Expand Up @@ -1483,6 +1486,64 @@ null (empty response body)

[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

<a name="updateBatchContacts"></a>
# **updateBatchContacts**
> updateBatchContacts(updateBatchContacts)
Update multiple contacts

### Example
```java
// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ContactsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ContactsApi apiInstance = new ContactsApi();
UpdateBatchContacts updateBatchContacts = new UpdateBatchContacts(); // UpdateBatchContacts | Values to update multiple contacts
try {
apiInstance.updateBatchContacts(updateBatchContacts);
} catch (ApiException e) {
System.err.println("Exception when calling ContactsApi#updateBatchContacts");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**updateBatchContacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts |

### Return type

null (empty response body)

### Authorization

[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)

### HTTP request headers

- **Content-Type**: application/json
Expand Down
1 change: 1 addition & 0 deletions docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**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** | **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]
**unicodeEnabled** | **Boolean** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional]



25 changes: 25 additions & 0 deletions docs/CreateSubAccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

# CreateSubAccount

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**companyName** | **String** | Name of the organization |
**email** | **String** | Email address for the organization |
**language** | [**LanguageEnum**](#LanguageEnum) | Language for identifying localization information | [optional]
**timezone** | **String** | Request timezone of the client | [optional]


<a name="LanguageEnum"></a>
## Enum: LanguageEnum
Name | Value
---- | -----
EN | &quot;en&quot;
FR | &quot;fr&quot;
IT | &quot;it&quot;
ES | &quot;es&quot;
PT | &quot;pt&quot;
DE | &quot;de&quot;



5 changes: 4 additions & 1 deletion docs/CreateWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | URL of the webhook |
**description** | **String** | Description of the webhook | [optional]
**events** | [**List&lt;EventsEnum&gt;**](#List&lt;EventsEnum&gt;) | Events triggering the webhook. Possible values for Transactional type webhook &#x60;sent&#x60; OR &#x60;request&#x60;, &#x60;delivered&#x60;, &#x60;hardBounce&#x60;, &#x60;softBounce&#x60;, &#x60;blocked&#x60;, &#x60;spam&#x60;, &#x60;invalid&#x60;, &#x60;deferred&#x60;, &#x60;click&#x60;, &#x60;opened&#x60;, &#x60;uniqueOpened&#x60; and &#x60;unsubscribed&#x60; and possible values for Marketing type webhook &#x60;spam&#x60;, &#x60;opened&#x60;, &#x60;click&#x60;, &#x60;hardBounce&#x60;, &#x60;softBounce&#x60;, &#x60;unsubscribed&#x60;, &#x60;listAddition&#x60; &amp; &#x60;delivered&#x60; |
**events** | [**List&lt;EventsEnum&gt;**](#List&lt;EventsEnum&gt;) | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### &#x60;sent&#x60; OR &#x60;request&#x60;, &#x60;delivered&#x60;, &#x60;hardBounce&#x60;, &#x60;softBounce&#x60;, &#x60;blocked&#x60;, &#x60;spam&#x60;, &#x60;invalid&#x60;, &#x60;deferred&#x60;, &#x60;click&#x60;, &#x60;opened&#x60;, &#x60;uniqueOpened&#x60; and &#x60;unsubscribed&#x60; - Possible values for **Marketing** type webhook: #### &#x60;spam&#x60;, &#x60;opened&#x60;, &#x60;click&#x60;, &#x60;hardBounce&#x60;, &#x60;softBounce&#x60;, &#x60;unsubscribed&#x60;, &#x60;listAddition&#x60; &amp; &#x60;delivered&#x60; - Possible values for **Inbound** type webhook: #### &#x60;inboundEmailProcessed&#x60; |
**type** | [**TypeEnum**](#TypeEnum) | Type of the webhook | [optional]
**domain** | **String** | Inbound domain of webhook, required in case of event type &#x60;inbound&#x60; | [optional]


<a name="List<EventsEnum>"></a>
Expand All @@ -30,6 +31,7 @@ UNSUBSCRIBED | &quot;unsubscribed&quot;
LISTADDITION | &quot;listAddition&quot;
CONTACTUPDATED | &quot;contactUpdated&quot;
CONTACTDELETED | &quot;contactDeleted&quot;
INBOUNDEMAILPROCESSED | &quot;inboundEmailProcessed&quot;


<a name="TypeEnum"></a>
Expand All @@ -38,6 +40,7 @@ Name | Value
---- | -----
TRANSACTIONAL | &quot;transactional&quot;
MARKETING | &quot;marketing&quot;
INBOUND | &quot;inbound&quot;



Loading

0 comments on commit d932cda

Please sign in to comment.