npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tasheel-sdk

v0.0.3

Published

Tasheel Node.js SDK is a wrapper for the Tasheel API.

Downloads

1

Readme

nodejs SDK

Tasheel Node.js SDK is a wrapper for the Tasheel API.

Installation

There are two ways to install Tasheel Nodejs SDK in the project:

  1. Use local pacakge Copy nodejs-sdk-1.0.0.tgz to your folder. Update dependency in package.json and run npm install
    {
        "dependencies": {
            "nodejs-sdk": "file:lib/nodejs-sdk-1.0.0.tgz"
        }
    }
  2. Install online package from https://www.npmjs.com
    npm i Tasheel-sdk --save

Usage

1. Create configuration for sdk

Create a object or load a json file with template below:

{
    "clientVersion": "1.0.0",
    "baseUrl": "your baseUrl",
    "requestTimeoutInSecond": 0,
    "apiToken": "your token",
    "notificationPrivateKey": "your private key",
    "logger":{
      "useLog": true,
      "filePath": "./logs"
    }
}
- baseUrl (Required): Url points to api, example: https://api-sandbox.Tasheel.co
- requestTimeoutInSecond (Optional): timeout for request in seconds (0 or remove this field if you don't apply).
- apiToken (Required): authenticate token for api.
- notificationPrivateKey (Required): authenticate token for notification service.
- logger (Optional): configure logger for sdk (winston). 
    + Set userlog = false if you don't apply.
    + filePath: Input your out put folder otherwise remove this field, system will log in console by default.

2. Api Client

Using TasheelClientFactory with sample code:

   const apiConfiguration = require("../public/apiConfiguration.json");
   var client = TasheelClientFactory.createApiClient(apiConfiguration);
   //1. GetPaymentTypes
     var rs = client.getPaymentTypes("SA", {currency: 'SAR', amount: 200}).then((response)=>{
        console.log(response.data[0].supportedInstalments);
    }); 

3. Notification Service

1. Register notification service

Using TasheelClientFactory with sample code:

 const apiConfiguration = require("../public/apiConfiguration.json");
const notificationService = TasheelClientFactory.createNotificationService(apiConfiguration);
2. Create a endpoint to receive notification from Tasheel

Sample code

       const server = createServer((request: IncomingMessage, response: ServerResponse) => {
        switch (request.url) {
            case '/testWebhook': {
              if (request.method === 'POST') {
                  var res = notificationService.processWebhook(request);
                  res.then((reponse) => {
                    //handle the response here
                  })
              }
              break;
            }
            case '/testAuthorise': {
                if (request.method === 'POST') {
                    var res = notificationService.processAuthoriseNotification(request);
                    res.then((reponse) => {
                         //handle the response here
                      })
                }
                break;
              }
            default: {
              response.statusCode = 404;
              response.end();
            }
          }
    });

API Support:

  1. GetPaymentTypes --- /checkout/payment-types
  2. CreateCheckout --- /checkout
  3. AuthoriseOrder --- /orders/{orderId}/authorise
  4. CancelOrder --- /orders/{orderId}/cancel
  5. Capture --- /payments/capture
  6. Refund --- /merchants/orders/{orderId}/refund
  7. GetOrderDetails --- /orders/{orderId}
  8. UpdateOrderReferenceId --- /orders/{orderId}/reference-id
  9. RegisterWebhook --- /webhooks
  10. RetrieveWebhook --- /webhooks/{webhookId}
  11. RemoveWebhook --- /webhooks/{webhookId}
  12. UpdateWebhook --- /webhooks/{webhookId}
  13. GetOrderDetailsByReference --- /merchants/orders/reference-id/{orderReferenceId}

Versions:

1.0.6: Updated RiskAssesstment, AuthorisedOrder response, OrderDetails, Simple refund 1.0.7: Updated Simple refund