Skip to content

Commit 42fe7a5

Browse files
amitsendinblueamitsendinblue
committed
Updated version to v3.0.0
1 parent fa7116b commit 42fe7a5

File tree

80 files changed

+2167
-1233
lines changed

Some content is hidden

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

80 files changed

+2167
-1233
lines changed

‎README.md

Lines changed: 43 additions & 38 deletions
Large diffs are not rendered by default.

‎docs/AbTestCampaignResult.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
99
**OpenRate** | **string** | Open rate for current winning version | [optional]
1010
**ClickRate** | **string** | Click rate for current winning version | [optional]
1111
**WinningVersionRate** | **string** | Open/Click rate for the winner version | [optional]
12+
**Statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
13+
**ClickedLinks** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
1214

1315
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1416

‎docs/AbTestCampaignResultClickedLinks.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# sib_api_v3_sdk.Model.AbTestCampaignResultClickedLinks
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**VersionA** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
7+
**VersionB** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎docs/AbTestCampaignResultStatistics.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# sib_api_v3_sdk.Model.AbTestCampaignResultStatistics
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
7+
**Clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
8+
**Unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
9+
**HardBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
10+
**SoftBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
11+
**Complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+

‎docs/AbTestVersionClicks.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# sib_api_v3_sdk.Model.AbTestVersionClicks
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+

‎docs/AbTestVersionClicksInner.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# sib_api_v3_sdk.Model.AbTestVersionClicksInner
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Link** | **string** | URL of the link |
7+
**ClicksCount** | **decimal?** | Number of times a link is clicked |
8+
**ClickRate** | **string** | Percentage of clicks of link with respect to total clicks |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎docs/AbTestVersionStats.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# sib_api_v3_sdk.Model.AbTestVersionStats
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**VersionA** | **string** | percentage of an event for version A |
7+
**VersionB** | **string** | percentage of an event for version B |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎docs/AddContactToList.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**Emails** | **List<string>** | 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]
6+
**Emails** | **List<string>** | Mandatory if IDs are not passed, ignored otherwise. 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]
7+
**Ids** | **List<long?>** | Mandatory if Emails are not passed, ignored otherwise. 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]
78

89
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
910

‎docs/ContactsApi.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ Method | HTTP request | Description
77
[**AddContactToList**](ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
88
[**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 a contact to trigger the DOI workflow from a Landing Page form
10+
[**CreateDoiContact**](ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
1111
[**CreateFolder**](ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder
1212
[**CreateList**](ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list
1313
[**DeleteAttribute**](ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14-
[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact
14+
[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact
1515
[**DeleteFolder**](ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
1616
[**DeleteList**](ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
1717
[**GetAttributes**](ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
18-
[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Get a contact's details
19-
[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
18+
[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details
19+
[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
2020
[**GetContacts**](ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts
2121
[**GetContactsFromList**](ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
2222
[**GetFolder**](ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -28,7 +28,7 @@ Method | HTTP request | Description
2828
[**RemoveContactFromList**](ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
2929
[**RequestContactExport**](ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts
3030
[**UpdateAttribute**](ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
31-
[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact
31+
[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | Update a contact
3232
[**UpdateFolder**](ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder
3333
[**UpdateList**](ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
3434

@@ -64,7 +64,7 @@ namespace Example
6464
6565
var apiInstance = new ContactsApi();
6666
var listId = 789; // long? | Id of the list
67-
var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses of the contacts
67+
var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses OR IDs of the contacts
6868
6969
try
7070
{
@@ -86,7 +86,7 @@ namespace Example
8686
Name | Type | Description | Notes
8787
------------- | ------------- | ------------- | -------------
8888
**listId** | **long?**| Id of the list |
89-
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
89+
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
9090

9191
### Return type
9292

@@ -246,7 +246,7 @@ Name | Type | Description | Notes
246246
# **CreateDoiContact**
247247
> void CreateDoiContact (CreateDoiContact createDoiContact)
248248
249-
Create a contact to trigger the DOI workflow from a Landing Page form
249+
Create Contact via DOI (Double-Opt-In) Flow
250250

251251
### Example
252252
```csharp
@@ -272,11 +272,11 @@ namespace Example
272272
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
273273
274274
var apiInstance = new ContactsApi();
275-
var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the DOI contact
275+
var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the Double opt-in (DOI) contact
276276
277277
try
278278
{
279-
// Create a contact to trigger the DOI workflow from a Landing Page form
279+
// Create Contact via DOI (Double-Opt-In) Flow
280280
apiInstance.CreateDoiContact(createDoiContact);
281281
}
282282
catch (Exception e)
@@ -292,7 +292,7 @@ namespace Example
292292

293293
Name | Type | Description | Notes
294294
------------- | ------------- | ------------- | -------------
295-
**createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact |
295+
**createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
296296

297297
### Return type
298298

@@ -516,7 +516,7 @@ void (empty response body)
516516

517517
<a name="deletecontact"></a>
518518
# **DeleteContact**
519-
> void DeleteContact (string email)
519+
> void DeleteContact (string identifier)
520520
521521
Delete a contact
522522

@@ -544,12 +544,12 @@ namespace Example
544544
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
545545
546546
var apiInstance = new ContactsApi();
547-
var email = email_example; // string | Email (urlencoded) of the contact
547+
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
548548
549549
try
550550
{
551551
// Delete a contact
552-
apiInstance.DeleteContact(email);
552+
apiInstance.DeleteContact(identifier);
553553
}
554554
catch (Exception e)
555555
{
@@ -564,7 +564,7 @@ namespace Example
564564

565565
Name | Type | Description | Notes
566566
------------- | ------------- | ------------- | -------------
567-
**email** | **string**| Email (urlencoded) of the contact |
567+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
568568

569569
### Return type
570570

@@ -781,7 +781,7 @@ This endpoint does not need any parameter.
781781

782782
<a name="getcontactinfo"></a>
783783
# **GetContactInfo**
784-
> GetExtendedContactDetails GetContactInfo (string email)
784+
> GetExtendedContactDetails GetContactInfo (string identifier)
785785
786786
Get a contact's details
787787

@@ -809,12 +809,12 @@ namespace Example
809809
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
810810
811811
var apiInstance = new ContactsApi();
812-
var email = email_example; // string | Email (urlencoded) of the contact OR its SMS attribute value
812+
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value
813813
814814
try
815815
{
816816
// Get a contact's details
817-
GetExtendedContactDetails result = apiInstance.GetContactInfo(email);
817+
GetExtendedContactDetails result = apiInstance.GetContactInfo(identifier);
818818
Debug.WriteLine(result);
819819
}
820820
catch (Exception e)
@@ -830,7 +830,7 @@ namespace Example
830830

831831
Name | Type | Description | Notes
832832
------------- | ------------- | ------------- | -------------
833-
**email** | **string**| Email (urlencoded) of the contact OR its SMS attribute value |
833+
**identifier** | **string**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
834834

835835
### Return type
836836

@@ -849,7 +849,7 @@ Name | Type | Description | Notes
849849

850850
<a name="getcontactstats"></a>
851851
# **GetContactStats**
852-
> GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null)
852+
> GetContactCampaignStats GetContactStats (string identifier, DateTime? startDate = null, DateTime? endDate = null)
853853
854854
Get email campaigns' statistics for a contact
855855

@@ -877,14 +877,14 @@ namespace Example
877877
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
878878
879879
var apiInstance = new ContactsApi();
880-
var email = email_example; // string | Email address (urlencoded) of the contact
880+
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
881881
var startDate = 2013-10-20; // DateTime? | 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)
882882
var endDate = 2013-10-20; // DateTime? | 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)
883883
884884
try
885885
{
886886
// Get email campaigns' statistics for a contact
887-
GetContactCampaignStats result = apiInstance.GetContactStats(email, startDate, endDate);
887+
GetContactCampaignStats result = apiInstance.GetContactStats(identifier, startDate, endDate);
888888
Debug.WriteLine(result);
889889
}
890890
catch (Exception e)
@@ -900,7 +900,7 @@ namespace Example
900900

901901
Name | Type | Description | Notes
902902
------------- | ------------- | ------------- | -------------
903-
**email** | **string**| Email address (urlencoded) of the contact |
903+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
904904
**startDate** | **DateTime?**| 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]
905905
**endDate** | **DateTime?**| 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]
906906

@@ -1514,7 +1514,7 @@ namespace Example
15141514
15151515
var apiInstance = new ContactsApi();
15161516
var listId = 789; // long? | Id of the list
1517-
var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
1517+
var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails addresses OR IDs of the contacts
15181518
15191519
try
15201520
{
@@ -1536,7 +1536,7 @@ namespace Example
15361536
Name | Type | Description | Notes
15371537
------------- | ------------- | ------------- | -------------
15381538
**listId** | **long?**| Id of the list |
1539-
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
1539+
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
15401540

15411541
### Return type
15421542

@@ -1696,7 +1696,7 @@ void (empty response body)
16961696

16971697
<a name="updatecontact"></a>
16981698
# **UpdateContact**
1699-
> void UpdateContact (string email, UpdateContact updateContact)
1699+
> void UpdateContact (string identifier, UpdateContact updateContact)
17001700
17011701
Update a contact
17021702

@@ -1724,13 +1724,13 @@ namespace Example
17241724
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
17251725
17261726
var apiInstance = new ContactsApi();
1727-
var email = email_example; // string | Email (urlencoded) of the contact
1727+
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
17281728
var updateContact = new UpdateContact(); // UpdateContact | Values to update a contact
17291729
17301730
try
17311731
{
17321732
// Update a contact
1733-
apiInstance.UpdateContact(email, updateContact);
1733+
apiInstance.UpdateContact(identifier, updateContact);
17341734
}
17351735
catch (Exception e)
17361736
{
@@ -1745,7 +1745,7 @@ namespace Example
17451745

17461746
Name | Type | Description | Notes
17471747
------------- | ------------- | ------------- | -------------
1748-
**email** | **string**| Email (urlencoded) of the contact |
1748+
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
17491749
**updateContact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
17501750

17511751
### Return type

‎docs/CreateChild.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**LastName** | **string** | Last name to use to create the child account |
99
**CompanyName** | **string** | Company name to use to create the child account |
1010
**Password** | **string** | Password for the child account to login |
11+
**Language** | **string** | Language of the child account | [optional]
1112

1213
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1314

0 commit comments

Comments
 (0)