SitecoreSend.SDK
1.0.6
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.6.1
This package targets .NET Framework 4.6.1. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package SitecoreSend.SDK --version 1.0.6
NuGet\Install-Package SitecoreSend.SDK -Version 1.0.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SitecoreSend.SDK" Version="1.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SitecoreSend.SDK --version 1.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SitecoreSend.SDK, 1.0.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SitecoreSend.SDK as a Cake Addin
#addin nuget:?package=SitecoreSend.SDK&version=1.0.6
// Install SitecoreSend.SDK as a Cake Tool
#tool nuget:?package=SitecoreSend.SDK&version=1.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Sitecore Send SDK (Unofficial)
Provides .NET wrapper around Sitecore Send API
Usage
var apiConfiguration = new ApiConfiguration
{
ApiKey = "[YOUR API KEY]",
};
// or any other service
IMailingListService mailingListService = new MailingListService(apiConfiguration);
var response = await mailingListService.GetAllMailingLists();
// ensure response is not null and Success is true
if (response is {Success: true})
{
IList<MailingList>? allLists = response.Data?.MailingLists;
// handle allLists
}
Configuration with DI:
var apiConfiguration = new ApiConfiguration
{
ApiKey = "[YOUR API KEY]",
};
serviceCollection.AddHttpClient("SitecoreSendClient",
(client) => { client.BaseAddress = new Uri(apiConfiguration.BaseUri); });
serviceCollection.AddScoped<IMailingListService>(provider => new MailingListService(apiConfiguration,
provider.GetService<IHttpClientFactory>()!.CreateClient("SitecoreSendClient")));
Integration tests
Overview
Integration tests are located in SitecoreSend.SDK.Tests
project.
Running locally
Create file appsettings.local.json
in SitecoreSend.SDK.Tests
project.
Fill it with the following content:
{
"SitecoreSend": {
"ApiKey": "[YOUR API KEY]",
"TestListId": "[TEST LIST ID]"
},
"UnitTests": {
"HideSecrets": false // specify, if hide api secrets and emails in test outputs
}
}
Contribute / Bug / Help
You can contact me via email or in Sitecore Slack: zharikovigor97@gmail.com
. Or please open an issue.
Roadmap
Documented API
- Mailing list service
- Subscribers service
- Campaigns service (WIP)
- Segments service
Internal API
- Websites management
- Automations
- Senders API
Tracking API
- Tracking API
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.6.1
- System.Net.Http.Json (>= 5.0.0)
- System.Text.Json (>= 5.0.0)
-
.NETStandard 2.0
- System.Net.Http.Json (>= 5.0.0)
- System.Text.Json (>= 5.0.0)
-
net6.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.7-preview.3 | 38 | 5/14/2024 |
1.0.6 | 51 | 5/14/2024 |
1.0.5 | 47 | 5/14/2024 |
1.0.4 | 39 | 5/14/2024 |
1.0.3 | 41 | 5/14/2024 |
1.0.2 | 41 | 5/14/2024 |
1.0.2-develop-191a634-preview | 36 | 5/14/2024 |
1.0.1 | 44 | 5/14/2024 |
1.0.1-develop-9706a29-preview | 37 | 5/14/2024 |
1.0.0 | 85 | 5/8/2024 |
0.1.5-alpha | 52 | 4/26/2024 |
0.1.4-alpha | 52 | 4/26/2024 |
0.1.3-alpha | 52 | 4/26/2024 |
0.1.2-preview-2 | 67 | 4/25/2024 |
0.1.2-preview-1 | 66 | 4/25/2024 |
0.1.0 | 89 | 4/25/2024 |