bukku-client 0.1.0 → 0.1.2
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.
- package/README.md +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://badge.fury.io/js/bukku-client)
|
|
4
4
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
5
|
-
[](https://github.com/farhan-syah/bukku-client/actions/workflows/publish-npm.yml)
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
@@ -38,6 +38,21 @@ const bukku = new BukkuClient({
|
|
|
38
38
|
});
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
+
## Example: Contact Creation
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
const params: BukkuContactCreateParams = {
|
|
45
|
+
entity_type: "MALAYSIAN_INDIVIDUAL",
|
|
46
|
+
legal_name: "John Doe",
|
|
47
|
+
reg_no_type: "NRIC",
|
|
48
|
+
reg_no: "12345678",
|
|
49
|
+
email: "email@email.com",
|
|
50
|
+
types: ["customer"],
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const contact = await bukku.contacts.contacts.create(params);
|
|
54
|
+
```
|
|
55
|
+
|
|
41
56
|
## API Documentation
|
|
42
57
|
|
|
43
58
|
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:
|