An (unofficial) Zai Typescript/Javascript client

types are swagger generated from - https://developer.hellozai.com/reference/overview

Usage

yarn

yarn add @mikeyzhang75/zai-payments

npm

npm install --save @mikeyzhang75/zai-payments

bun

bun add @mikeyzhang75/zai-payments

Contributing

Install

bun install

Run tests

bun spec

Type checking

bun typecheck

Linting & Formatting

bun check:fix

Author

👤 MikeyZhang75 [email protected]

Generating updated types

Before generating types, you must define the current Swagger version:

1. Download the desired Swagger spec version from Zai Developer Docs
2. Save it as swagger.yaml in the root directory
3. Run the type generation command:

npx swagger-typescript-api -p ./swagger.yaml -o ./src -n types.ts --no-client

Note: Always verify the Swagger spec version matches your target Zai API version to ensure type compatibility.

Example

import { createClient } from "@mikeyzhang75/zai-payments";

const baseURL = process.env.AP_SANDPIT
  ? "https://test.api.promisepay.com/"
  : "https://secure.api.promisepay.com/";

const authBaseURL = process.env.AP_SANDPIT
  ? "https://au-0000.sandbox.auth.assemblypay.com/"
  : "https://au-0000.auth.assemblypay.com/";

const dataURL = process.env.AP_SANDPIT
  ? "https://sandbox.au-0000.api.assemblypay.com/"
  : "https://au-0000.api.assemblypay.com/";

export const client = createClient({
  clientId: process.env.AP_CLIENT_ID,
  clientSecret: process.env.AP_CLIENT_SECRET,
  scope: process.env.AP_CLIENT_SCOPE,
  baseURL,
  authBaseURL,
  dataURL,
});

const itemResponse = await client.items.showItem(
  "6865E25F-3CFE-4C8C-8673-9231E0A19CF5"
);

console.log(itemResponse.items);