bukku-client

A TypeScript client library for interacting with the Bukku REST API. This package aims to provide an easy way to integrate Bukku services into your Node.js or TypeScript projects.

Features

• TypeScript-first: Written in TypeScript for strong typing and better developer experience.
• Provides convenient methods for accessing Bukku API endpoints.
• Easy to integrate and use.

Installation

You can install bukku-client using npm or yarn:

bun install bukku-client
# or
npm install bukku-client
# or
yarn add bukku-client

Usage

To use the bukku-client, you'll first need to instantiate the BukkuClient with your API Access Token and Company Subdomain. You can find your Access Token in the Control Panel > Integrations section of your Bukku web application.

import { BukkuClient } from "bukku-client";

const bukku = new BukkuClient({
  accessToken: "YOUR_BUKKU_ACCESS_TOKEN", // Replace with your actual Access Token
  companySubdomain: "YOUR_COMPANY_SUBDOMAIN", // Replace with your company's Bukku subdomain
  apiBaseUrl: "https://api.bukku.fyi", // Example for Bukku staging environment
});

Example: Contact Creation

const params: BukkuContactCreateParams = {
  entity_type: "MALAYSIAN_INDIVIDUAL",
  legal_name: "John Doe",
  reg_no_type: "NRIC",
  reg_no: "12345678",
  email: "[e-mail]",
  types: ["customer"],
};

const contact = await bukku.contacts.contacts.create(params);

API Documentation

This library aims to implement the functionalities exposed by the Bukku REST API. For detailed information about the API endpoints, request/response structures, and authentication, please refer to the official Bukku API Documentation:

• Bukku Official API Documentation

Detailed documentation for each method and available types within this library will be provided here as the library evolves.

The main client class, BukkuClient, will be the entry point for all API interactions.

Development

To get started with development:

1. Clone the repository:

   git clone https://github.com/farhan-syah/bukku-client.git
   cd bukku-client

2. Install dependencies:

   bun install

Contributing

Contributions are welcome! If you'd like to contribute, please:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature/your-feature-name).
6. Open a Pull Request.

Please make sure to update tests as appropriate.

License

This project is licensed under the LGPL-3.0 License - see the LICENSE file for details.

---

This is an unofficial client library for Bukku. Bukku is a trademark of its respective owners.