Skip to content

Commit 826dc43

Browse files
swrnmswrnm
committed
docs files updated
1 parent 5c5c32d commit 826dc43

Some content is hidden

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

46 files changed

+513
-339
lines changed

‎README.md

Lines changed: 73 additions & 69 deletions
Large diffs are not rendered by default.

‎docs/AccountApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**getAccount**](AccountApi.md#getAccount) | **GET** /account | Get your account informations, plans and credits details
7+
[**getAccount**](AccountApi.md#getAccount) | **GET** /account | Get your account information, plan and credits details
88

99

1010
<a name="getAccount"></a>
1111
# **getAccount**
1212
> GetAccount getAccount()
1313
14-
Get your account informations, plans and credits details
14+
Get your account information, plan and credits details
1515

1616
### Example
1717
```java

‎docs/AddContactToList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**emails** | **List&lt;String&gt;** | Emails to add to a list | [optional]
7+
**emails** | **List&lt;String&gt;** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
88

99

1010

‎docs/AttributesApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
8-
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
9-
[**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | Lists all attributes
10-
[**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
7+
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
8+
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
9+
[**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
10+
[**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
1111

1212

1313
<a name="createAttribute"></a>
1414
# **createAttribute**
1515
> createAttribute(attributeCategory, attributeName, createAttribute)
1616
17-
Creates contact attribute
17+
Create contact attribute
1818

1919
### Example
2020
```java
@@ -76,7 +76,7 @@ null (empty response body)
7676
# **deleteAttribute**
7777
> deleteAttribute(attributeCategory, attributeName)
7878
79-
Deletes an attribute
79+
Delete an attribute
8080

8181
### Example
8282
```java
@@ -136,7 +136,7 @@ null (empty response body)
136136
# **getAttributes**
137137
> GetAttributes getAttributes()
138138
139-
Lists all attributes
139+
List all attributes
140140

141141
### Example
142142
```java
@@ -191,7 +191,7 @@ This endpoint does not need any parameter.
191191
# **updateAttribute**
192192
> updateAttribute(attributeCategory, attributeName, updateAttribute)
193193
194-
Updates contact attribute
194+
Update contact attribute
195195

196196
### Example
197197
```java

‎docs/ContactsApi.md

Lines changed: 98 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,31 @@ All URIs are relative to *https://api.sendinblue.com/v3*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**addContactToList**](ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
8-
[**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
8+
[**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
99
[**createContact**](ContactsApi.md#createContact) | **POST** /contacts | Create a contact
10+
[**createDoiContact**](ContactsApi.md#createDoiContact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
1011
[**createFolder**](ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder
1112
[**createList**](ContactsApi.md#createList) | **POST** /contacts/lists | Create a list
12-
[**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
13-
[**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{email} | Deletes a contact
13+
[**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14+
[**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{email} | Delete a contact
1415
[**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
1516
[**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
16-
[**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | Lists all attributes
17-
[**getContactInfo**](ContactsApi.md#getContactInfo) | **GET** /contacts/{email} | Retrieves contact informations
18-
[**getContactStats**](ContactsApi.md#getContactStats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact
17+
[**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
18+
[**getContactInfo**](ContactsApi.md#getContactInfo) | **GET** /contacts/{email} | Get a contact&#39;s details
19+
[**getContactStats**](ContactsApi.md#getContactStats) | **GET** /contacts/{email}/campaignStats | Get email campaigns&#39; statistics for a contact
1920
[**getContacts**](ContactsApi.md#getContacts) | **GET** /contacts | Get all the contacts
20-
[**getContactsFromList**](ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list
21-
[**getFolder**](ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns folder details
22-
[**getFolderLists**](ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
23-
[**getFolders**](ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all the folders
24-
[**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get the details of a list
21+
[**getContactsFromList**](ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
22+
[**getFolder**](ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder&#39;s details
23+
[**getFolderLists**](ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
24+
[**getFolders**](ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all folders
25+
[**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list&#39;s details
2526
[**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
2627
[**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
27-
[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
28+
[**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
2829
[**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
29-
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
30-
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
31-
[**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
30+
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
31+
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Update a contact
32+
[**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
3233
[**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
3334

3435

@@ -97,7 +98,7 @@ Name | Type | Description | Notes
9798
# **createAttribute**
9899
> createAttribute(attributeCategory, attributeName, createAttribute)
99100
100-
Creates contact attribute
101+
Create contact attribute
101102

102103
### Example
103104
```java
@@ -209,6 +210,64 @@ Name | Type | Description | Notes
209210

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

213+
### HTTP request headers
214+
215+
- **Content-Type**: application/json
216+
- **Accept**: application/json
217+
218+
<a name="createDoiContact"></a>
219+
# **createDoiContact**
220+
> createDoiContact(createDoiContact)
221+
222+
Create Contact via DOI (Double-Opt-In) Flow
223+
224+
### Example
225+
```java
226+
// Import classes:
227+
//import sendinblue.ApiClient;
228+
//import sendinblue.ApiException;
229+
//import sendinblue.Configuration;
230+
//import sendinblue.auth.*;
231+
//import sibApi.ContactsApi;
232+
233+
ApiClient defaultClient = Configuration.getDefaultApiClient();
234+
235+
// Configure API key authorization: api-key
236+
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
237+
apiKey.setApiKey("YOUR API KEY");
238+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
239+
//apiKey.setApiKeyPrefix("Token");
240+
241+
// Configure API key authorization: partner-key
242+
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
243+
partnerKey.setApiKey("YOUR API KEY");
244+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
245+
//partnerKey.setApiKeyPrefix("Token");
246+
247+
ContactsApi apiInstance = new ContactsApi();
248+
CreateDoiContact createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the Double opt-in (DOI) contact
249+
try {
250+
apiInstance.createDoiContact(createDoiContact);
251+
} catch (ApiException e) {
252+
System.err.println("Exception when calling ContactsApi#createDoiContact");
253+
e.printStackTrace();
254+
}
255+
```
256+
257+
### Parameters
258+
259+
Name | Type | Description | Notes
260+
------------- | ------------- | ------------- | -------------
261+
**createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
262+
263+
### Return type
264+
265+
null (empty response body)
266+
267+
### Authorization
268+
269+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
270+
212271
### HTTP request headers
213272

214273
- **Content-Type**: application/json
@@ -336,7 +395,7 @@ Name | Type | Description | Notes
336395
# **deleteAttribute**
337396
> deleteAttribute(attributeCategory, attributeName)
338397
339-
Deletes an attribute
398+
Delete an attribute
340399

341400
### Example
342401
```java
@@ -396,7 +455,7 @@ null (empty response body)
396455
# **deleteContact**
397456
> deleteContact(email)
398457
399-
Deletes a contact
458+
Delete a contact
400459

401460
### Example
402461
```java
@@ -570,7 +629,7 @@ null (empty response body)
570629
# **getAttributes**
571630
> GetAttributes getAttributes()
572631
573-
Lists all attributes
632+
List all attributes
574633

575634
### Example
576635
```java
@@ -625,7 +684,7 @@ This endpoint does not need any parameter.
625684
# **getContactInfo**
626685
> GetExtendedContactDetails getContactInfo(email)
627686
628-
Retrieves contact informations
687+
Get a contact&#39;s details
629688

630689
### Example
631690
```java
@@ -648,7 +707,7 @@ apiKey.setApiKey("YOUR API KEY");
648707
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
649708
partnerKey.setApiKey("YOUR PARTNER KEY");
650709
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
651-
//partnerK ey.setApiKeyPrefix("Token");
710+
//partnerKey.setApiKeyPrefix("Token");
652711

653712
ContactsApi apiInstance = new ContactsApi();
654713
String email = "email_example"; // String | Email (urlencoded) of the contact OR its SMS attribute value
@@ -682,9 +741,9 @@ Name | Type | Description | Notes
682741

683742
<a name="getContactStats"></a>
684743
# **getContactStats**
685-
> GetContactCampaignStats getContactStats(email)
744+
> GetContactCampaignStats getContactStats(email, startDate, endDate)
686745
687-
Get the campaigns statistics for a contact
746+
Get email campaigns&#39; statistics for a contact
688747

689748
### Example
690749
```java
@@ -711,8 +770,10 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
711770

712771
ContactsApi apiInstance = new ContactsApi();
713772
String email = "email_example"; // String | Email address (urlencoded) of the contact
773+
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
774+
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
714775
try {
715-
GetContactCampaignStats result = apiInstance.getContactStats(email);
776+
GetContactCampaignStats result = apiInstance.getContactStats(email, startDate, endDate);
716777
System.out.println(result);
717778
} catch (ApiException e) {
718779
System.err.println("Exception when calling ContactsApi#getContactStats");
@@ -725,6 +786,8 @@ try {
725786
Name | Type | Description | Notes
726787
------------- | ------------- | ------------- | -------------
727788
**email** | **String**| Email address (urlencoded) of the contact |
789+
**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]
790+
**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]
728791

729792
### Return type
730793

@@ -771,7 +834,7 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
771834
ContactsApi apiInstance = new ContactsApi();
772835
Long limit = 50L; // Long | Number of documents per page
773836
Long offset = 0L; // Long | Index of the first document of the page
774-
OffsetDateTime modifiedSince = new OffsetDateTime(); // 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.
837+
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.
775838
try {
776839
GetContacts result = apiInstance.getContacts(limit, offset, modifiedSince);
777840
System.out.println(result);
@@ -806,7 +869,7 @@ Name | Type | Description | Notes
806869
# **getContactsFromList**
807870
> GetContacts getContactsFromList(listId, modifiedSince, limit, offset)
808871
809-
Get the contacts in a list
872+
Get contacts in a list
810873

811874
### Example
812875
```java
@@ -833,7 +896,7 @@ partnerKey.setApiKey("YOUR PARTNER KEY");
833896

834897
ContactsApi apiInstance = new ContactsApi();
835898
Long listId = 789L; // Long | Id of the list
836-
OffsetDateTime modifiedSince = new OffsetDateTime(); // 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.
899+
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.
837900
Long limit = 50L; // Long | Number of documents per page
838901
Long offset = 0L; // Long | Index of the first document of the page
839902
try {
@@ -871,7 +934,7 @@ Name | Type | Description | Notes
871934
# **getFolder**
872935
> GetFolder getFolder(folderId)
873936
874-
Returns folder details
937+
Returns a folder&#39;s details
875938

876939
### Example
877940
```java
@@ -930,7 +993,7 @@ Name | Type | Description | Notes
930993
# **getFolderLists**
931994
> GetFolderLists getFolderLists(folderId, limit, offset)
932995
933-
Get the lists in a folder
996+
Get lists in a folder
934997

935998
### Example
936999
```java
@@ -993,7 +1056,7 @@ Name | Type | Description | Notes
9931056
# **getFolders**
9941057
> GetFolders getFolders(limit, offset)
9951058
996-
Get all the folders
1059+
Get all folders
9971060

9981061
### Example
9991062
```java
@@ -1054,7 +1117,7 @@ Name | Type | Description | Notes
10541117
# **getList**
10551118
> GetExtendedList getList(listId)
10561119
1057-
Get the details of a list
1120+
Get a list&#39;s details
10581121

10591122
### Example
10601123
```java
@@ -1235,7 +1298,7 @@ Name | Type | Description | Notes
12351298
# **removeContactFromList**
12361299
> PostContactInfo removeContactFromList(listId, contactEmails)
12371300
1238-
Remove existing contacts from a list
1301+
Delete a contact from a list
12391302

12401303
### Example
12411304
```java
@@ -1357,7 +1420,7 @@ Name | Type | Description | Notes
13571420
# **updateAttribute**
13581421
> updateAttribute(attributeCategory, attributeName, updateAttribute)
13591422
1360-
Updates contact attribute
1423+
Update contact attribute
13611424

13621425
### Example
13631426
```java
@@ -1419,7 +1482,7 @@ null (empty response body)
14191482
# **updateContact**
14201483
> updateContact(email, updateContact)
14211484
1422-
Updates a contact
1485+
Update a contact
14231486

14241487
### Example
14251488
```java
@@ -1479,7 +1542,7 @@ null (empty response body)
14791542
# **updateFolder**
14801543
> updateFolder(folderId, updateFolder)
14811544
1482-
Update a contact folder
1545+
Update a folder
14831546

14841547
### Example
14851548
```java

‎docs/CreateAttribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**value** | **String** | Value of the attribute. Use only if the attribute&#39;s category is &#39;calculated&#39; or &#39;global&#39; | [optional]
8-
**enumeration** | [**List&lt;CreateAttributeEnumeration&gt;**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attributes category is &quot;category&#39;. For example, [{&quot;value&quot;:1, &quot;label&quot;:&quot;male&quot;}, {&quot;value&quot;:2, &quot;label&quot;:&quot;female&quot;}] | [optional]
8+
**enumeration** | [**List&lt;CreateAttributeEnumeration&gt;**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute&#39;s category is &quot;category&quot;. For example, [{&quot;value&quot;:1, &quot;label&quot;:&quot;male&quot;}, {&quot;value&quot;:2, &quot;label&quot;:&quot;female&quot;}] | [optional]
99
**type** | [**TypeEnum**](#TypeEnum) | Type of the attribute. Use only if the attribute&#39;s category is &#39;normal&#39;, &#39;category&#39; or &#39;transactional&#39; ( type &#39;boolean&#39; is only available if the category is &#39;normal&#39; attribute, type &#39;id&#39; is only available if the category is &#39;transactional&#39; attribute &amp; type &#39;category&#39; is only available if the category is &#39;category&#39; attribute ) | [optional]
1010

1111

0 commit comments

Comments
 (0)