diff --git a/README.md b/README.md index e6d5797..d06a79c 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,51 @@ npm install @paystack/paystack-sdk --save ## Usage Import and initialize the library: +```javascript +const Paystack = require('@paystack/paystack-sdk') +const paystack = new Paystack("sk_test_xxxxxx") + +paystack.transaction.initialize({email: "test@example.com", amount: 20000}) + .then(response => console.log(response)) + .catch(error => console.log(error)) ``` + +Import and initialize the library using ES module with `async/await`: +```javascript import Paystack from '@paystack/paystack-sdk' const paystack = new Paystack("sk_test_xxxxxx") -``` -Initiate a request and parse response: +const initialize = async(email, amount) => { + const response = await paystack.transaction.initialize({ + email, + amount + }) + + console.log(response) +} + +const email = 'test@example.com' +const amount = 2000 +initialize(email, amount) ``` -paystack.customer.fetch({code: "CUS_o9rf5kuwei3lt4vl"}) - .then(customer => console.log(customer)) - .catch(error => console.log(error)) + +### Typescript +```typescript +import Paystack from '@paystack/paystack-sdk'; +const paystack = new Paystack("sk_test_xxxxxx"); + +const initialize = async(email, amount) => { + const response = await paystack.transaction.initialize({ + email, + amount + }); + + console.log(response); +} + +const email = 'test@example.com'; +const amount = 2000; +initialize(email, amount); ``` ## Issues diff --git a/package.json b/package.json index d29aea8..3643821 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@paystack/paystack-sdk", - "version": "1.0.0-beta.6", + "version": "1.0.0", "description": "Paystack API wrapper for Node", "author": "Paystack (https://paystack.com/docs)", "keywords": [ diff --git a/src/apis/Customer.ts b/src/apis/Customer.ts index f84afc9..123a117 100644 --- a/src/apis/Customer.ts +++ b/src/apis/Customer.ts @@ -59,7 +59,7 @@ export interface UpdateRequest { metadata?: string; } -export interface ValidatteRequest { +export interface ValidateRequest { code: string; first_name: string; last_name: string; @@ -282,30 +282,30 @@ export class Customer extends BaseAPI { * Validate a customer\'s identity * Validate Customer */ - async validatte(requestParameters: ValidatteRequest): Promise { + async validate(requestParameters: ValidateRequest): Promise { if (requestParameters.code === null || requestParameters.code === undefined) { - throw new RequiredError('code','Required parameter code was null or undefined when calling validatte.'); + throw new RequiredError('code','Required parameter code was null or undefined when calling validate.'); } if (requestParameters.first_name === null || requestParameters.first_name === undefined) { - throw new RequiredError('first_name','Required parameter first_name was null or undefined when calling validatte.'); + throw new RequiredError('first_name','Required parameter first_name was null or undefined when calling validate.'); } if (requestParameters.last_name === null || requestParameters.last_name === undefined) { - throw new RequiredError('last_name','Required parameter last_name was null or undefined when calling validatte.'); + throw new RequiredError('last_name','Required parameter last_name was null or undefined when calling validate.'); } if (requestParameters.type === null || requestParameters.type === undefined) { - throw new RequiredError('type','Required parameter type was null or undefined when calling validatte.'); + throw new RequiredError('type','Required parameter type was null or undefined when calling validate.'); } if (requestParameters.country === null || requestParameters.country === undefined) { - throw new RequiredError('country','Required parameter country was null or undefined when calling validatte.'); + throw new RequiredError('country','Required parameter country was null or undefined when calling validate.'); } if (requestParameters.bvn === null || requestParameters.bvn === undefined) { - throw new RequiredError('bvn','Required parameter bvn was null or undefined when calling validatte.'); + throw new RequiredError('bvn','Required parameter bvn was null or undefined when calling validate.'); } if (requestParameters.bank_code === null || requestParameters.bank_code === undefined) { - throw new RequiredError('bank_code','Required parameter bank_code was null or undefined when calling validatte.'); + throw new RequiredError('bank_code','Required parameter bank_code was null or undefined when calling validate.'); } if (requestParameters.account_number === null || requestParameters.account_number === undefined) { - throw new RequiredError('account_number','Required parameter account_number was null or undefined when calling validatte.'); + throw new RequiredError('account_number','Required parameter account_number was null or undefined when calling validate.'); } const queryParameters: any = {}; diff --git a/src/index.ts b/src/index.ts index 5600aef..db2e1bf 100644 --- a/src/index.ts +++ b/src/index.ts @@ -30,4 +30,5 @@ class Paystack { } -module.exports = Paystack \ No newline at end of file +module.exports = Paystack; +module.exports.default = Paystack; \ No newline at end of file diff --git a/src/runtime.ts b/src/runtime.ts index 6067bdb..0f9ac2b 100644 --- a/src/runtime.ts +++ b/src/runtime.ts @@ -55,7 +55,7 @@ export class BaseAPI { path: tempPath, headers: { "authorization": `Bearer ${this.apiKey}`, - "paystack-version": `@paystack/paystack-sdk - 1.0.0-beta.6` + "user-agent": `@paystack/paystack-sdk - 1.0.0` } }