Skip to content
This repository has been archived by the owner on Aug 21, 2020. It is now read-only.

Bump lodash from 4.17.10 to 4.17.20 #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ bKash API client for Browser & Node.js

bKash API docs: https://developer.bka.sh/v1.0.0-beta/reference

## NOTICE

**bKash used to publish OpenAPI Specification for their API on the [bKash-developer/openapi](https://github.com/bKash-developer/openapi) repository.**

**Which they decided to remove, for reasons I can't imagine.**

**As this library was created based on that spec, it is now outdated.**

**If anybody from bKash (who's related to the decision to unpublish the spec) sees this, if you care about developer experience I urge you to reconsider that decision.**

## Installation

via **npm**:
Expand Down Expand Up @@ -42,14 +52,17 @@ const clientOptions = {
const bkash = new BKash(clientOptions)

// https://developer.bka.sh/v1.0.0-beta/reference#querypaymentusingget
bkash.queryPayment({
paymentID: '42'
}).then(({ data, error, headers, meta }) => {
// data -> HTTP Status Code < 400
// error -> HTTP Status Code >= 400
}).catch(err => {
// HTTP Status Code >= 500
})
bkash
.queryPayment({
paymentID: '42'
})
.then(({ data, error, headers, meta }) => {
// data -> HTTP Status Code < 400
// error -> HTTP Status Code >= 400
})
.catch(err => {
// HTTP Status Code >= 500
})
```

## Authentication
Expand All @@ -59,14 +72,14 @@ bkash.queryPayment({
bkash.authenticate({
type: 'simple',
username: '...', // headers[`username`]
password: '...' // headers[`password`]
password: '...' // headers[`password`]
})

// required for all other methods
bkash.authenticate({
type: 'token',
token: '...', // headers[`authorization`]
appkey: '...' // headers[`x-app-key`]
token: '...', // headers[`authorization`]
appkey: '...' // headers[`x-app-key`]
})
```

Expand Down
43 changes: 26 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.