Skip to content

Latest commit

 

History

History
286 lines (228 loc) · 7.92 KB

README.md

File metadata and controls

286 lines (228 loc) · 7.92 KB
Raw

Lob.Net Build Status

Lob.Net is a wrapper for the Lob.com API. It follows the latest technology regarding dependency injection and strong typing.

This project is actively maintained and is in its early alpha stage. Many breaks will be introduced until stability is reached.

Installation

Install package:

PM> Install-Package Lob.Net

Setup

Load the Lob interfaces in your Startup.cs as such:

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}

private IConfiguration Configuration { get; }

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddLob(options => options.ApiKey = Configuration["Lob:ApiKey"]);
}

Include your API key in the appsettings.json

{
  "Lob": {
    "ApiKey": "test_api_key"
  }
}

Usage

Inject the appropriate interface in your controller in order to send postcards, letters, etc.

Postcards

[Route("api/[controller]")]
public class PostcardsController : Controller
{
    private readonly ILobPostcards lobPostcards;

    public PostcardsController(
        ILobPostcards lobPostcards
    )
    {
        this.lobPostcards = lobPostcards;
    }

    [HttpPost]
    [Route("")]
    public async Task SendPostcard()
    {
        try
        {
            var result1 = await lobPostcards.CreateAsync(new PostcardRequest
            {
                From = new AddressReference(new Address
                {
                    Name = "Jean-Sébastien Goupil",
                    Company = "JSGoupil, LLC",
                    AddressLine1 = "123 Main Street",
                    AddressCity = "Seattle",
                    AddressState = "WA",
                    AddressZip = "98103",
                    AddressCountry = "US"
                }),
                To = new AddressReference("adr_738379e5622a9f04"), // Saved address in LOB
                Front = "tmpl_7e7fdb7d1cb261d", // Saved template in LOB
                Back = "tmpl_7e7fdb7d1cb261d", // Saved template in LOB
                MergeVariables = new Dictionary<string, string>
                {
                    {"variable_name", "Jean-Sébastien" }
                }
            });
        }
        catch (LobException ex)
        {
            throw ex;
        }
    }
}

Postcards APIs:

public interface ILobPostcards
{
    Task<PostcardResponse> CreateAsync(PostcardRequest postcard, string idempotencyKey = null);
    Task<PostcardResponse> RetrieveAsync(string id);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<ListResponse<PostcardResponse>> ListAsync(PostcardFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<PostcardResponse> ListObjectsAsync(PostcardFilter filter = null);
}

Letters

public interface ILobLetters
{
    Task<LetterResponse> CreateAsync(LetterRequest letter, string idempotencyKey = null);
    Task<LetterResponse> RetrieveAsync(string id);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<ListResponse<LetterResponse>> ListAsync(LetterFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<LetterResponse> ListObjectsAsync(LetterFilter filter = null);
}

Bank Accounts

public interface ILobBankAccounts
{
    Task<BankAccountResponse> CreateAsync(BankAccountRequest bankAccount, string idempotencyKey = null);
    Task<BankAccountResponse> RetrieveAsync(string id);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<BankAccountResponse> VerifyAsync(string id, int amountInCents1, int amountInCents2);
    Task<ListResponse<BankAccountResponse>> ListAsync(BankAccountFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<BankAccountResponse> ListObjectsAsync(BankAccountFilter filter = null);
}

Checks

public interface ILobChecks
{
    Task<CheckResponse> CreateAsync(CheckRequest check, string idempotencyKey = null);
    Task<CheckResponse> RetrieveAsync(string id);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<ListResponse<CheckResponse>> ListAsync(CheckFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<CheckResponse> ListObjectsAsync(CheckFilter filter = null);
}

Addresses

public interface ILobAddresses
{
    Task<CheckResponse> CreateAsync(CheckRequest check, string idempotencyKey = null);
    Task<CheckResponse> RetrieveAsync(string id);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<ListResponse<CheckResponse>> ListAsync(CheckFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<CheckResponse> ListObjectsAsync(CheckFilter filter = null);
}

Templates

public interface ILobTemplates
{
    Task<TemplateResponse> CreateAsync(TemplateRequest template, string idempotencyKey = null);
    Task<TemplateResponse> RetrieveAsync(string id);
    Task<TemplateResponse> UpdateAsync(string id, TemplateUpdate templateUpdate);
    Task<DeleteResponse> DeleteAsync(string id);
    Task<ListResponse<TemplateResponse>> ListAsync(TemplateFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<TemplateResponse> ListObjectsAsync(TemplateFilter filter = null);

    Task<TemplateVersionResponse> CreateVersionAsync(string templateId, TemplateVersionRequest templateVersion, string idempotencyKey = null);
    Task<TemplateVersionResponse> RetrieveVersionAsync(string templateId, string versionId);
    Task<TemplateVersionResponse> UpdateVersionAsync(string templateId, string versionId, string description);
    Task<DeleteResponse> DeleteVersionAsync(string templateId, string versionId);
    Task<ListResponse<TemplateVersionResponse>> ListVersionAsync(string templateId, TemplateVersionFilter filter = null);

    // For .NET Standard 2.1
    IAsyncEnumerable<TemplateVersionResponse> ListVersionObjectsAsync(string templateId, TemplateVersionFilter filter = null);
}

US Verifications

public interface ILobUsVerifications
{
    Task<UsVerificationResponse> VerifyAsync(UsVerificationRequest request, UsVerificationCase @case = UsVerificationCase.Upper);
    Task<UsAutocompletionResponse> AutocompleteAsync(UsAutocompletionRequest request, string ipAddress = null);
    Task<UsZipLookupResponse> ZipLookupAsync(string zipCode);
    Task<UsZipLookupResponse> ZipLookupAsync(UsZipLookupRequest request);
}

Intl Verifications

public interface ILobIntlVerifications
{
    Task<IntlVerificationResponse> VerifyAsync(IntlVerificationRequest request);
}

Follow the other examples in the sample folder.

WebHooks .NET Core 2

You need to install this NuGet package:

PM> Install-Package Lob.Net.Formatters

The webhooks must be configured with Mvc with the following code:

services.AddMvc()
	.AddLobFormatters();

Create a controller and actions like this:

[AllowAnonymous]
[Produces("application/json")]
[Route("api/[controller]")]
public class ExternalsController : Controller
{
    public ExternalsController(
    )
    {
    }

    [HttpPost]
    [Route("postcard")]
    public IActionResult LobPostcard([FromBody] Lob.Net.Models.LobEvent<Lob.Net.Models.PostcardResponse> evt)
    {
        // If you know exactly which type you are getting.

        return Ok();
    }

    [HttpPost]
    [Route("object")]
    public IActionResult LobObject([FromBody] Lob.Net.Models.LobEvent evt)
    {
        // If you accept any type, use the non-generic version.
        if (evt.EventType.Resource == Lob.Net.Models.EventTypeResource.Postcards)
        {
            var postcardEvent = evt.ToPostcard();
        }

        return Ok();
    }
}

WebHooks .NET Core 3

Not supported. Contribution welcome. To make it work with System.Text.Json

Contributing

Contributions are welcome. Code or documentation!

  1. Fork this project
  2. Create a feature/bug fix branch
  3. Push your branch up to your fork
  4. Submit a pull request

License

Lob.Net is under the MIT license.