paisr-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rowellfortune
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# paisr-js
+
+A typed JavaScript/TypeScript client for the [Paisr API](https://github.com/paisrtechnologies/pcb-openapi) — wallets, transfers, customers, vouchers, plans, invoices, subscriptions, payments, provider connections, webhooks, and access tokens.
+
+Built on [`openapi-fetch`](https://github.com/openapi-ts/openapi-typescript/tree/main/packages/openapi-fetch) with types generated from Paisr's OpenAPI spec via [`openapi-typescript`](https://github.com/openapi-ts/openapi-typescript). Works in Node.js 18+ and in the browser.
+
+## Install
+
+```bash
+npm install paisr-js
+```
+
+## Usage
+
+```ts
+import { Paisr } from "paisr-js";
+
+const paisr = new Paisr({
+  apiKey: process.env.PAISR_API_KEY!,
+  environment: "live", // or "staging" (defaults to "live")
+});
+
+// List wallets
+const { wallets } = await paisr.wallets.list();
+
+// Create a wallet
+const created = await paisr.wallets.create({
+  type: "business",
+  currency: "USD",
+});
+
+// Nested wallet resources
+const balances = await paisr.wallets.balances.list(created.id);
+const transactions = await paisr.wallets.transactions.list(created.id, { limit: 25 });
+await paisr.wallets.pin.rotate(created.id);
+
+// Customers, invoices, subscriptions, payments...
+const customer = await paisr.customers.add({ email: "jane@example.com" });
+const invoice = await paisr.invoices.create({ customer_id: customer.id });
+await paisr.invoices.send(invoice.id);
+
+const payment = await paisr.payments.initiate("card", {
+  amount: 5000,
+  currency: "USD",
+});
+```
+
+### Error handling
+
+Every non-2xx response throws a `PaisrError` with the HTTP status and parsed response body attached:
+
+```ts
+import { Paisr, PaisrError } from "paisr-js";
+
+try {
+  await paisr.wallets.get("does-not-exist");
+} catch (err) {
+  if (err instanceof PaisrError) {
+    console.error(err.status, err.message, err.body);
+  }
+}
+```
+
+### Custom base URL / fetch
+
+```ts
+const paisr = new Paisr({
+  apiKey: "...",
+  baseUrl: "https://api.staging.paisr.tech/v2", // overrides `environment`
+  fetch: myCustomFetch, // e.g. for retries, proxying, or testing
+});
+```
+
+## Resources
+
+| Namespace | Covers |
+| --- | --- |
+| `paisr.accessTokens` | Access tokens & their permissions |
+| `paisr.webhooks` | Webhooks, secrets, triggers, delivery events |
+| `paisr.wallets` | Wallets, plus nested `.pin`, `.statements`, `.transactions`, `.balances`, `.accounts`, `.contacts`, `.links` |
+| `paisr.transfers` | Initiate/approve/cancel transfers, batch transfers |
+| `paisr.customers` | Customers |
+| `paisr.vouchers` | Vouchers, applying voucher codes |
+| `paisr.plans` | Plans, plus nested `.options` (price options) |
+| `paisr.invoices` | Invoices, plus nested `.items` (line items) |
+| `paisr.subscriptions` | Subscriptions, restore/cancel |
+| `paisr.payments` | Payments, refunds |
+| `paisr.providers` | Provider connections |
+| `paisr.metrics` | Invoice/subscription/payment/customer metrics |
+| `paisr.logs` | API request logs |
+
+All request/response types are generated directly from Paisr's OpenAPI spec (vendored at `src/spec/paisr.yaml`), so method signatures stay in sync with the API surface.
+
+## Development
+
+```bash
+npm install
+npm run generate   # regenerate src/generated/types.ts from src/spec/paisr.yaml
+npm run typecheck
+npm run build       # outputs ESM + CJS + .d.ts to dist/
+```
+
+To pick up API changes, replace `src/spec/paisr.yaml` with the latest spec and re-run `npm run generate`.