Skip to content

Commit

Permalink
Merge pull request #24 from sendinblue/v3.0.0
Browse files Browse the repository at this point in the history
Updated version to v3.0.0
  • Loading branch information
amitsendinblue authored Nov 4, 2020
2 parents fa7116b + 42fe7a5 commit 04aa8e4
Show file tree
Hide file tree
Showing 80 changed files with 2,167 additions and 1,233 deletions.
81 changes: 43 additions & 38 deletions README.md

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/AbTestCampaignResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Name | Type | Description | Notes
**OpenRate** | **string** | Open rate for current winning version | [optional]
**ClickRate** | **string** | Click rate for current winning version | [optional]
**WinningVersionRate** | **string** | Open/Click rate for the winner version | [optional]
**Statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
**ClickedLinks** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]

[[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 changes: 10 additions & 0 deletions docs/AbTestCampaignResultClickedLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# sib_api_v3_sdk.Model.AbTestCampaignResultClickedLinks
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**VersionA** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
**VersionB** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |

[[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 changes: 14 additions & 0 deletions docs/AbTestCampaignResultStatistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# sib_api_v3_sdk.Model.AbTestCampaignResultStatistics
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
**Clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
**Unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
**HardBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
**SoftBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
**Complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | |

[[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 changes: 8 additions & 0 deletions docs/AbTestVersionClicks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# sib_api_v3_sdk.Model.AbTestVersionClicks
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[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 changes: 11 additions & 0 deletions docs/AbTestVersionClicksInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# sib_api_v3_sdk.Model.AbTestVersionClicksInner
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Link** | **string** | URL of the link |
**ClicksCount** | **decimal?** | Number of times a link is clicked |
**ClickRate** | **string** | Percentage of clicks of link with respect to total clicks |

[[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 changes: 10 additions & 0 deletions docs/AbTestVersionStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# sib_api_v3_sdk.Model.AbTestVersionStats
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**VersionA** | **string** | percentage of an event for version A |
**VersionB** | **string** | percentage of an event for version B |

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

3 changes: 2 additions & 1 deletion docs/AddContactToList.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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]
**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]

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

58 changes: 29 additions & 29 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Method | HTTP request | Description
[**AddContactToList**](ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
[**CreateAttribute**](ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
[**CreateContact**](ContactsApi.md#createcontact) | **POST** /contacts | Create a contact
[**CreateDoiContact**](ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form
[**CreateDoiContact**](ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
[**CreateFolder**](ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder
[**CreateList**](ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list
[**DeleteAttribute**](ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact
[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact
[**DeleteFolder**](ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
[**DeleteList**](ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
[**GetAttributes**](ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Get a contact's details
[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details
[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
[**GetContacts**](ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts
[**GetContactsFromList**](ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
[**GetFolder**](ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
Expand All @@ -28,7 +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
[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact
[**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 @@ -64,7 +64,7 @@ namespace Example
var apiInstance = new ContactsApi();
var listId = 789; // long? | Id of the list
var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses of the contacts
var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses OR IDs of the contacts
try
{
Expand All @@ -86,7 +86,7 @@ namespace Example
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**listId** | **long?**| Id of the list |
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
**contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |

### Return type

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

### Example
```csharp
Expand All @@ -272,11 +272,11 @@ namespace Example
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
var apiInstance = new ContactsApi();
var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the DOI contact
var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the Double opt-in (DOI) contact
try
{
// Create a contact to trigger the DOI workflow from a Landing Page form
// Create Contact via DOI (Double-Opt-In) Flow
apiInstance.CreateDoiContact(createDoiContact);
}
catch (Exception e)
Expand All @@ -292,7 +292,7 @@ namespace Example

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

### Return type

Expand Down Expand Up @@ -516,7 +516,7 @@ void (empty response body)

<a name="deletecontact"></a>
# **DeleteContact**
> void DeleteContact (string email)
> void DeleteContact (string identifier)
Delete a contact

Expand Down Expand Up @@ -544,12 +544,12 @@ namespace Example
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
var apiInstance = new ContactsApi();
var email = email_example; // string | Email (urlencoded) of the contact
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
try
{
// Delete a contact
apiInstance.DeleteContact(email);
apiInstance.DeleteContact(identifier);
}
catch (Exception e)
{
Expand All @@ -564,7 +564,7 @@ namespace Example

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**email** | **string**| Email (urlencoded) of the contact |
**identifier** | **string**| Email (urlencoded) OR ID of the contact |

### Return type

Expand Down Expand Up @@ -781,7 +781,7 @@ This endpoint does not need any parameter.

<a name="getcontactinfo"></a>
# **GetContactInfo**
> GetExtendedContactDetails GetContactInfo (string email)
> GetExtendedContactDetails GetContactInfo (string identifier)
Get a contact's details

Expand Down Expand Up @@ -809,12 +809,12 @@ namespace Example
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
var apiInstance = new ContactsApi();
var email = email_example; // string | Email (urlencoded) of the contact OR its SMS attribute value
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value
try
{
// Get a contact's details
GetExtendedContactDetails result = apiInstance.GetContactInfo(email);
GetExtendedContactDetails result = apiInstance.GetContactInfo(identifier);
Debug.WriteLine(result);
}
catch (Exception e)
Expand All @@ -830,7 +830,7 @@ namespace Example

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

### Return type

Expand All @@ -849,7 +849,7 @@ Name | Type | Description | Notes

<a name="getcontactstats"></a>
# **GetContactStats**
> GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null)
> GetContactCampaignStats GetContactStats (string identifier, DateTime? startDate = null, DateTime? endDate = null)
Get email campaigns' statistics for a contact

Expand Down Expand Up @@ -877,14 +877,14 @@ namespace Example
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
var apiInstance = new ContactsApi();
var email = email_example; // string | Email address (urlencoded) of the contact
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
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)
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)
try
{
// Get email campaigns' statistics for a contact
GetContactCampaignStats result = apiInstance.GetContactStats(email, startDate, endDate);
GetContactCampaignStats result = apiInstance.GetContactStats(identifier, startDate, endDate);
Debug.WriteLine(result);
}
catch (Exception e)
Expand All @@ -900,7 +900,7 @@ namespace Example

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**email** | **string**| Email address (urlencoded) of the contact |
**identifier** | **string**| Email (urlencoded) OR ID of the contact |
**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]
**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]

Expand Down Expand Up @@ -1514,7 +1514,7 @@ namespace Example
var apiInstance = new ContactsApi();
var listId = 789; // long? | Id of the list
var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact
var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails addresses OR IDs of the contacts
try
{
Expand All @@ -1536,7 +1536,7 @@ namespace Example
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**listId** | **long?**| Id of the list |
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
**contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |

### Return type

Expand Down Expand Up @@ -1696,7 +1696,7 @@ void (empty response body)

<a name="updatecontact"></a>
# **UpdateContact**
> void UpdateContact (string email, UpdateContact updateContact)
> void UpdateContact (string identifier, UpdateContact updateContact)
Update a contact

Expand Down Expand Up @@ -1724,13 +1724,13 @@ namespace Example
// Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");
var apiInstance = new ContactsApi();
var email = email_example; // string | Email (urlencoded) of the contact
var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact
var updateContact = new UpdateContact(); // UpdateContact | Values to update a contact
try
{
// Update a contact
apiInstance.UpdateContact(email, updateContact);
apiInstance.UpdateContact(identifier, updateContact);
}
catch (Exception e)
{
Expand All @@ -1745,7 +1745,7 @@ namespace Example

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

### Return type
Expand Down
1 change: 1 addition & 0 deletions docs/CreateChild.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**LastName** | **string** | Last name to use to create the child account |
**CompanyName** | **string** | Company name to use to create the child account |
**Password** | **string** | Password for the child account to login |
**Language** | **string** | Language of the child account | [optional]

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

4 changes: 2 additions & 2 deletions docs/CreateDoiContact.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Name | Type | Description | Notes
**Attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {&#39;FNAME&#39;:&#39;Elly&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional]
**IncludeListIds** | **List&lt;long?&gt;** | Lists under user account where contact should be added |
**ExcludeListIds** | **List&lt;long?&gt;** | Lists under user account where contact should not be added | [optional]
**TemplateId** | **long?** | Id of the DOI template |
**RedirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. | [optional]
**TemplateId** | **long?** | Id of the Double opt-in (DOI) template |
**RedirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. |

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

1 change: 1 addition & 0 deletions docs/CreateReseller.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AuthKey** | **string** | AuthKey of Reseller child created |
**Id** | **long?** | Id of Reseller child created | [optional]

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

2 changes: 1 addition & 1 deletion docs/CreateSender.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | From Name to use for the sender |
**Email** | **string** | From Email to use for the sender |
**Email** | **string** | From email to use for the sender. A verification email will be sent to this address. |
**Ips** | [**List&lt;CreateSenderIps&gt;**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional]

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

0 comments on commit 04aa8e4

Please sign in to comment.