Helio SDK

Introduction

A lightweight and easy-to-use SDK for interacting with the Helio API. Supports API key endpoints only.

It wraps and enhances the Helio API away into one NPM package which is easy to install and upgrade.

The Helio SDK is written in Typescript.

Please use the latest production version. Only used ALPHA versions if advised to do so.

Installation

npm i @heliofi/sdk

or

yarn add @heliofi/sdk

IMPORTANT: You will also need to add the following line in your code, ideally at the very top of the project:

import 'reflect-metadata';

Usage

import { HelioSDK } from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);

const paylinkWebhook = await sdk.paylinkWebhook.create(createPaylinkWebhookDto);

Methods

| Methods | Params | Return | | ------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- | | Paylink | | paylink.create | dto: CreatePaylinkWithApiDto | ShallowEnrichedPaylink | | paylink.update | paylinkId: string; dto: UpdatePaylinkWithApiDto | Paylink | | paylink.disable | paylinkId: string | boolean | | Currency | | currency.getAllCurrencies | type?: CurrencyType | Currency[] | | Transaction | | transaction.getTransaction | transactionSignature: string | Transaction | | transaction.getDepositTransaction | depositId: string; from?: string; to?: string; senderPK?: string | Transaction | | transaction.getDepositTransactionsByCustomerToken | customerToken: string; from?: string; to?: string; senderPK?: string | Transaction | | Deposit | | deposit.create | dto: CreateDepositCustomerDto | DepositCustomerEntity | | deposit.recordActivity | tokenId: string | void | | Deposit Webhook | | depositWebhook.createDepositWebhook | dto: CreateDepositHookByApiKeyDto | DepositHook | | Paylink Webhook | | paylinkWebhook.createPaylinkWebhook | dto: CreatePaylinkTransactionHookDto | PaylinkTransactionHookEntity | | paylinkWebhook.getAllPaylinkWebhooks | paylinkId: string | PaylinkTransactionHookEntity[] | | paylinkWebhook.getPaylinkWebhook | webhookId: string | PaylinkTransactionHookEntity | | paylinkWebhook.deletePaylinkWebhook | webhookId: string | void | | Subscription Webhook | | subscriptionWebhook.createSubscriptionWebhook | dto: CreatePaylinkSubscriptionHookDto | PaylinkSubscriptionHookEntity | | subscriptionWebhook.getAllSubscriptionWebhooks | paylinkId: string | PaylinkSubscriptionHookEntity[] | | subscriptionWebhook.getSubscriptionWebhook | webhookId: string | PaylinkSubscriptionHookEntity | | subscriptionWebhook.deleteSubscriptionWebhook | webhookId: string | void | | Transaction Webhook | | transactionWebhook.createTransactionWebhook | dto: CreatePaylinkTransactionHookDto | PaylinkTransactionHookEntity | | transactionWebhook.getAllTransactionWebhooks | paylinkId: string | PaylinkTransactionHookEntity[] | | transactionWebhook.getTransactionWebhook | webhookId: string | PaylinkTransactionHookEntity | | transactionWebhook.deleteTransactionWebhook | webhookId: string | void |