Enterspeed.Delivery.Sdk 1.4.1

Enterspeed Delivery .NET SDK ·

Installation

With .NET CLI

dotnet add package Enterspeed.Delivery.Sdk --version <version>

With Package Manager

Install-Package Enterspeed.Delivery.Sdk -Version <version>

How to use

Register services

Service has to be added to the service collection. This can be one by using the following extension method.

using IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((_, services) =>
        services.AddEnterspeedDeliveryService())
    .Build();

Examples of usage

Example of a common implementation where the delivery service is being utilized.

using Enterspeed.Delivery.Sdk.Api.Models;
using Enterspeed.Delivery.Sdk.Api.Services;

namespace DeliverySdkStronglyTypeTest; 

public class TestService
{
    private readonly IEnterspeedDeliveryService _enterspeedDeliveryService;
    
    public TestService(IEnterspeedDeliveryService enterspeedDeliveryService)
    {
        _enterspeedDeliveryService = enterspeedDeliveryService;
    }

    // Handle that has been setup to return a view in Enterspeed.
    public async  Task<DeliveryApiResponse> WithHandle()
    {
        var response =await _enterspeedDeliveryService.Fetch("environment-******-****-****-****-**********", builder => builder.WithHandle("navigation"));
        return response;
    }

    // Example method that calls a Url route in Enterspeed.
    public async Task<DeliveryApiResponse> WithUrl()
    {
        var response =   await _enterspeedDeliveryService.Fetch("environment-******-****-****-****-**********", builder => builder.WithUrl("http://localhost:3000/"));
        return response;
    }
    
    // Example method that calls a fully qualified url in Enterspeed. This is typically used in cojunction with a webhook from Enterspeed.
    // Weebhook typically returns an Delivery Api Url. This means that we do not need to construct a Delivery Api Url in code.  
    public async Task<DeliveryApiResponse> WithDeliveryApiUrl()
    {
        var response =   await _enterspeedDeliveryService.Fetch("environment-******-****-****-****-**********", builder => builder.WithDeliveryApiUrl("absolute url returned from delivery api"));
        return response;
    }
    
    // Example of how to fetch many view in one request.
    public async Task<DeliveryApiResponse> WithDeliveryApiUrl()
    {
        var response =   await _enterspeedDeliveryService.FetchMany("environment-******-****-****-****-**********", ,
                                                                        new GetByIdsOrHandle { Handles = new List<string> { "R7034112", "R7034108" }, Ids = new List<string> { "id1", "id2" } });
        return response;
    }
}

Contributing

Pull requests are very welcome.
Please fork this repository and make a PR when you are ready.

Otherwise you are welcome to open an Issue in our issue tracker.

License

Enterspeed .NET SDK is MIT licensed