@channelpayments/node-sdk 1.41.0 → 1.41.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,2 +1,27 @@
1
- # node-sdk
2
- > Typescript sdk for backend integration with Channel Payments
1
+ # Channel Payments Node SDK
2
+
3
+ Channel Payments provides developers with a user-friendly SDK, designed to streamline the integration process with the Channel Payments API.
4
+
5
+ This SDK offers a range of tools and functionalities that simplify the implementation of our payment features into your applications. For instructions on utilizing specific methods, please refer to the API guides within the Getting Started section.
6
+
7
+ ## Installation
8
+
9
+ > npm i @channelpayments/node-sdk
10
+
11
+ ## Usage
12
+
13
+ ```js
14
+ import { ChannelPaymentsApi } from "@channelpayments/node-sdk";
15
+ import * as fs from 'fs';
16
+
17
+ const channelPaymentsApi = new ChannelPaymentsApi({
18
+ keyId: '<integration key id>',
19
+ privateKey: fs.readFileSync('</path/to/... integration pem file', 'utf8'),
20
+ environment: '<**optional**, set to "sandbox" for sandbox testing>',
21
+ });
22
+
23
+ export async function getMerchant() {
24
+ const result = await channelPaymentsApi.getMerchant();
25
+ console.log('Merchant', result);
26
+ }
27
+ ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@channelpayments/node-sdk",
3
3
  "description": "Channel Payments nodejs sdk",
4
- "version": "1.41.0",
4
+ "version": "1.41.1",
5
5
  "author": "Channel Payments",
6
6
  "license": "ISC",
7
7
  "main": "dist/cjs/index.js",