Skip to main content

Official Elarian Python SDK

Reason this release was yanked:

Obsolete

Project description

Elarian Python SDK

The wrapper provides convenient access to the Elarian APIs.

Documentation

Take a look at the API docs here.

Install

You can install the package from pypi by running:

$ pip install elarian

Usage

import elarian

elarian_service = elarian.initialize(sandbox=True, api_key='test_api_key')

# build request
req = elarian.requests.GetCustomerStateRequest(app_id="fake-app-id", customer_id="el_cst_35f-fake")

# get customer state
resp = elarian_service.GetCustomerState(req)

print(resp)

Methods

  • AuthToken(): Generate auth token

  • GetCustomerState():

  • AdoptCustomerState():

  • AddCustomerReminder():

  • AddCustomerReminderByTag():

  • CancelCustomerReminder():

  • CancelCustomerReminderByTag():

  • UpdateCustomerTag():

  • DeleteCustomerTag():

  • UpdateCustomerSecondaryId():

  • DeleteCustomerSecondaryId():

  • UpdateCustomerMetadata():

  • DeleteCustomerMetadata ():

  • SendMessage(): Sending a message to your customer

  • SendMessageByTag(): Sending a message to a group of customers using tags

  • ReplyToMessage(): Replying to a message from your customer

  • MessagingConsent(): Opting a customer in or out of receiving messages from your app

  • SendPayment():

  • CheckoutPayment():

  • MakeVoiceCall():

  • StreamNotifications():

  • SendWebhookResponse():

Development

$ pip install grpcio grpcio-tools protobuf>=3.12.2
$ git clone --recurse-submodules https://github.com/ElarianLtd/python-sdk.git
$ cd python-sdk
$ python -m grpc_tools.protoc -I./elarian/utils/proto --python_out=./elarian/utils/generated --grpc_python_out=./elarian/utils/generated web.proto common.proto

Run all tests:

update the following params in your .env file then run python -m unittest discover -v

sandbox = True
api_key = 
app_id = 
product_id = 
messaging_short_code = 

Issues

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elarian-0.0.0.tar.gz (31.4 kB view hashes)

Uploaded Source

Built Distribution

elarian-0.0.0-py3-none-any.whl (33.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page