Elarian 0.0.4

Elarian

The SDK provides convenient access to the Elarian APIs from .NET applications.

Project Status: Still under ACTIVE DEVELOPMENT, APIs are unstable and may change at any time until release of v1.0.0.

Install

You can install the package from nuget by running:

dotnet add package elarian

Usage

General operations

Once you register your app, you can establish connection by creating a new instance of ElarianClient and passing connection information:

var client = new ElarianClient(new ElarianAppCredentials
{
    ApiKey = "el_api_key_62...",
    AppId = "test-app",
    OrgId = "og-S..."
});

await client.ConnectAsync();

Once you establish connection, you can call methods on the client instance:

var tag = await client.SendMessageByTag(
  new MessagingChannelNumber { Channel = MessagingChannel.Sms, Number = "254711234567" },
    new OutboundMessage
    {
    Body = new OutboundMessageBody
    {
      Text = "test"
    }
  }, new IndexMapping() { Key = "1", Value = "2" });

You can also subscribe to events sent by the server:

var subscribe = client.ReceivedMessageNotification.Subscribe(notification =>
 {
     Console.WriteLine(notification.Text);
 });

//Dispose subscription when no longer needed
subscribe.Dispose();

Customer specific operations

To execute customer specific operations, you can use Customer class:

var customer = new Customer(client, new CustomerNumber("+254711234567", CustomerNumber.Provider.Cellular));

var appData = await customer.LeaseAppDataAsync();

Documentation

Full documentation of Elarian Api is available at https://developers.elarian.com/

Issues

If you find a bug, please file an issue on our issue tracker on GitHub.