Skip to content

trolley/javascript-sdk

Folders and files

NameName
Last commit message
Last commit date
Jan 5, 2024
Jun 2, 2023
Jan 5, 2024
Jan 5, 2024
Oct 24, 2022
Oct 24, 2022
Oct 29, 2022
Jan 28, 2018
Sep 3, 2022
Aug 28, 2023
Jun 2, 2023
Jan 5, 2024
Jan 5, 2024
Jun 19, 2021
Aug 22, 2022
Jan 28, 2018

Repository files navigation

Trolley JavaScript SDK

Trolley's JavaScript SDK (written in TypeScript) - For more information about the API as well as NodeJS code samples check out the full API documentation

Installation

npm install --save trolleyhq

Getting Started

The Trolley API is built using promises and all methods except connect will return a promise. The connect call allows you to setup your API Key and Secret with a client that can be used for subsequent calls.

// A simple application using the Trolley/Payment Rails SDK
const trolley = require('trolleyhq');

const client = trolley.connect({
  key: "YOUR-ACCESS-KEY",
  secret: "YOUR-SECRET-SECRET",
});

// Async/Await version

async function main() {
  const recipient = await client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC");
  console.log(recipient.id);
}

main();

// Promise version

client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC").then(recipient => {
  console.log(recipient.id);
}).catch(err => {
  console.log("ERROR", err);
});

Usage

Methods should all have JSDoc comments to help you understand their usage. As mentioned the full API documentation is the best source of information about the API.

For more information please read the JavaScript API docs is available. The best starting point is:

Data Type SDK Documentation
Batch API Docs for Batch
Payment API Docs for Payment
Recipient API Docs for Recipient
Recipient Account API Docs for Recipient Account

Running Integration / Unit tests

If you're working on the library itself, here's easy way to run the tests.

// if not already, copy the example env file to create an env file
$ cp .env.test .env

// Set access key and secret in the env file
TROLLEY_ACCESS_KEY="ACCESS_KEY"
TROLLEY_SECRET_KEY="SECRET_KEY"

//Run the fixture based tests
$ npm test