zevvle-sdk-node v1.1.5

zevvle-sdk-node

The unofficial Node library and SDK for the Zevvle API.

Prerequisites

You can grab a SIM card from them and get hacking with the docs available here.

To get an API key, sign in here

Installation

Yarn:

yarn add zevvle-sdk-node

Npm:

npm install zevvle-sdk-node

Usage

As an import

import { Zevvle } from 'zevvle-sdk-node'
const zev = new Zevvle(`${ZEVVLE_KEY}`)

async function listSimCards() => {
  try {
    const simCards = await zev.listSimCards()
    console.log(simCards)
  } catch (err) {
    console.error(err)
  }
}

API

Table of contents

Constructors

• constructor

Methods

• logout
• getPricing
• getNonGeoPricing
• getAccount
• getCharge
• listCharges
• getUser
• getSim
• listSimCards
• getCallRecord
• listCallRecords
• createWebhook
• listWebhooks
• deleteWebhook

Constructors

constructor

+ new Zevvle(key: string, url?: string): Zevvle

Initialises the SDK.

Parameters:

Returns: Zevvle instance.

Methods

logout

▸ logout(): Promise<ResponseModel>

Logout and destroy your token.

Returns: Response message.

getPricing

▸ getPricing(originIso3?: string, destinationIso3?: string): Promise<PricingModel>

Get pricing for any country, or between 2 countries.

Parameters:

Returns: Pricing for a country, or between 2 countries.

getNonGeoPricing

▸ getNonGeoPricing(phoneNumber: string): Promise<NonGeoPricingModel>

Get pricing for Non-Geographic numbers.

Parameters:

Returns: Pricing for a non-geographic number.

getAccount

▸ getAccount(accountId: string): Promise<AccountModel>

Looks up Zevvle account.

Parameters:

Returns: Zevvle account details.

getCharge

▸ getCharge(chargeId: string): Promise<ChargeModel>

Looks up a charge.

Parameters:

Returns: The details of a charge.

listCharges

▸ listCharges(limit?: string, before?: string, after?: string): Promise<ChargeModel[]>

List all charges linked to the Zevvle API key.

Parameters:

Returns: A list of charges for your account.

getUser

▸ getUser(userId: string): Promise<UserModel>

Looks up Zevvle user.

Parameters:

Returns: Zevvle user details.

getSim

▸ getSim(simId: string): Promise<SIMCardModel>

Looks up a Zevvle SIM card.

Parameters:

Returns: Zevvle SIM card details.

listSimCards

▸ listSimCards(): Promise<SIMCardModel[]>

List all SIM cards linked to the Zevvle API key.

Returns: SIM cards for the API key in use.

getCallRecord

▸ getCallRecord(recordId: string): Promise<CallRecordModel>

Looks up Zevvle call record.

Parameters:

Returns: Zevvle call record details.

listCallRecords

▸ listCallRecords(simId: string, type?: string, limit?: string, before?: string, after?: string): Promise<CallRecordModel[]>

List call records for a given Zevvle SIM ID, according to filtering.

Parameters:

Returns: Call records for the given query.

createWebhook

▸ createWebhook(url: string, simCardId?: string, type?: string): Promise<WebhookResponseModel>

Create a webhook.

Parameters:

Returns: A webhook response.

deleteWebhook

▸ deleteWebhook(webhookId: string): Promise<any>

Delete a webhook

Parameters:

Returns: Response message.

listWebhooks

▸ listWebhooks(simCardId?: string): Promise<WebhookResponseModel[]>

List webhooks.

Parameters:

Returns: A list of webhooks.

Contributions

Contributions are welcome : )