1.0.5 • Published 1 year ago
splitit-typescript-sdk v1.0.5
splitit-typescript-sdk@1.0.5
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json
. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run build
Consuming
navigate to the folder of your consuming project and run the following command.
npm install splitit-typescript-sdk@1.0.5 --save
Getting Started
import { Configuration, InstallmentPlanApi, FailedResponse, InstallmentPlanCancelResponse } from "splitit-typescript-sdk";
const oauthClientId = process.env.CLIENT_ID;
const oauthClientSecret = process.env.CLIENT_SECRET;
const config = new Configuration({ oauthClientId, oauthClientSecret });
const api = new InstallmentPlanApi(config);
const installmentPlanNumber: string = "installmentPlanNumber_example";
const xSplititIdempotencyKey: string = "xSplititIdempotencyKey_example";
const request = api.cancel(installmentPlanNumber, xSplititIdempotencyKey);
request.then(result => {
console.log(result)
})