@bzbs/react-api-client 2.1.0 → 2.1.1

package/README.md

@@ -2,7 +2,7 @@
 
 A TypeScript library providing a type-safe API client for Buzzebees loyalty and reward services. Supports authentication, campaigns, user profiles, shopping carts, notifications, stamps, consent management, and more.
 
-**Version:** 1.4.15 | **License:** ISC | **Author:** Buzzebees Co., Ltd.
+**Version:** 2.1.0 | **License:** ISC | **Author:** Buzzebees Co., Ltd.
 **Repository:** [Azure DevOps](https://dev.azure.com/buzzebees/Buzzebees/_git/React_API_Client)
 
 ---
@@ -34,6 +34,7 @@ A TypeScript library providing a type-safe API client for Buzzebees loyalty and
   - [LineApi](#lineapi)
   - [PlaceApi](#placeapi)
   - [PointLogApi](#pointlogapi)
+  - [PointApi](#pointapi)
   - [StampApi](#stampapi)
   - [RequestHelpApi (Forum)](#requesthelpapi-forum)
   - [SettingApi](#settingapi)
@@ -180,6 +181,7 @@ BzbsService (entry point)
  ├── NotificationApi     → notification/
  ├── PlaceApi            → place/
  ├── PointLogApi         → log/points
+ ├── PointApi            → point/
  ├── ProfileApi          → profile/
  ├── RegistrationApi     → auth/register
  ├── AddressApi          → profile/address, address/
@@ -224,6 +226,7 @@ src/
 │   ├── notification/notification-api.ts
 │   ├── place/place-api.ts
 │   ├── point-log/point-log-api.ts
+│   ├── points/point-api.ts
 │   ├── profile/profile-api.ts
 │   ├── registration/registration-api.ts
 │   ├── request-help/request-help-api.ts
@@ -252,6 +255,7 @@ src/
 | `notificationApi` | `NotificationApi` | Push notifications |
 | `placeApi` | `PlaceApi` | Locations / stores |
 | `pointLogApi` | `PointLogApi` | Point transaction logs |
+| `pointApi` | `PointApi` | Multi-unit point balances and transaction history |
 | `profileApi` | `ProfileApi` | User profile, points, account |
 | `registerApi` | `RegistrationApi` | User registration |
 | `addressApi` | `AddressApi` | Addresses, provinces, districts |
@@ -396,6 +400,9 @@ const response = await bzbsService.profileApi.profile(undefined, {
 | `placeApi` | `addToFavourite` | POST | `place/{id}/favourite` | id | `unknown` | `#place` |
 | `placeApi` | `removeFromFavourite` | POST | `place/{id}/unfavourite` | id | `unknown` | `#place` |
 | `pointLogApi` | `getPointLog` | GET | `log/points` | month; opt: type, lastRowKey, top | `PointLog[]` | `#points #profile` |
+| `pointApi` | `balance` | GET | `point/balance` | opt: units, boxIds, onlyVisible | `PointBalance[]` | `#points` |
+| `pointApi` | `detail` | GET | `point/detail` | opt: units, boxIds, onlyVisible | `PointBalance[]` | `#points` |
+| `pointApi` | `history` | GET | `point/history` | start, end; opt: onlyVisible, skip, top, sortType, units, boxIds, references, transactionIds, includeActions, excludeActions, includeTypes, excludeTypes | `PointHistory[]` | `#points` |
 | `profileApi` | `profile` | GET | `profile/info` | opt: options | `ProfileResponse` | `#profile` |
 | `profileApi` | `updateProfile` | POST | `profile/info` | opt: firstName, lastName, contactNumber, email, notification, locale, title, gender, birthDate, address, subdistrictCode, districtCode, provinceCode, countryCode, zipCode, idCard, passport, maritalStatus, displayName, latitude, longitude, income, interests, region, occupation, remark, ... (JSON body) | `ProfileResponse` | `#profile` |
 | `profileApi` | `updateProfileImage` | POST | `profile/picture` | image (File or `{uri, name, type}`, sent as `multipart/form-data` with key `data`) | `ProfileResponse` | `#profile` |
@@ -910,6 +917,65 @@ const logs = await bzbsService.pointLogApi.getPointLog({
 
 ---
 
+### PointApi
+
+`bzbsService.pointApi` — Multi-unit point balances, breakdowns, and transaction history (earn/burn/transfer).
+
+| Method | Description | Returns |
+|---|---|---|
+| `balance(params?)` | Current point balance for the user across requested units | `PointBalance[]` |
+| `detail(params?)` | Point balance with `Currents` and `Expires` breakdowns keyed by date | `PointBalance[]` |
+| `history(params)` | Paginated list of earn/burn/transfer transactions in a date range | `PointHistory[]` |
+
+**Common params (`balance` / `detail`):**
+
+| Param | Type | Required | Description |
+|---|---|---|---|
+| `units` | `string` | No | Point unit codes (e.g. `Point`, `Coin`). Omit for all configured units. Sent as `units[]`. |
+| `boxIds` | `string` | No | Box (sub-bucket) identifiers. Sent as `boxIds[]`. |
+| `onlyVisible` | `boolean` | No | When `true` (default), only units marked visible for the app are considered. |
+
+**`history` params:**
+
+| Param | Type | Required | Description |
+|---|---|---|---|
+| `start` | `string` | Yes | Start of the range (inclusive), ISO-8601 with offset |
+| `end` | `string` | Yes | End of the range (inclusive), ISO-8601 with offset |
+| `skip` | `number` | No | Offset pagination |
+| `top` | `number` | No | Maximum records to return |
+| `sortType` | `'Asc' \| 'Desc'` | No | Sort direction by `Timestamp` |
+| `units` | `string` | No | Filter by point unit codes (sent as `units[]`) |
+| `boxIds` | `string` | No | Filter by box ids (sent as `boxIds[]`) |
+| `references` | `string` | No | Filter by transaction reference (sent as `references[]`) |
+| `transactionIds` | `string` | No | Filter by exact transaction ids (sent as `transactionIds[]`) |
+| `includeActions` | `string` | No | Only include actions (e.g. `Earn`, `Burn`, `Transfer`) — sent as `includeActions[]` |
+| `excludeActions` | `string` | No | Exclude actions — sent as `excludeActions[]` |
+| `includeTypes` | `string` | No | Only include types — sent as `includeTypes[]` |
+| `excludeTypes` | `string` | No | Exclude types — sent as `excludeTypes[]` |
+| `onlyVisible` | `boolean` | No | Restrict to visible units (default `true`) |
+
+```typescript
+// Current balance across all configured units
+const balance = await bzbsService.pointApi.balance();
+
+// Specific units only
+const coinBalance = await bzbsService.pointApi.balance({ units: 'Coin' });
+
+// Balance with current/expiring breakdowns
+const detail = await bzbsService.pointApi.detail({ onlyVisible: true });
+
+// Paginated transaction history
+const history = await bzbsService.pointApi.history({
+  start: '2025-01-01T00:00:00+07:00',
+  end: '2025-01-31T23:59:59+07:00',
+  top: 50,
+  sortType: 'Desc',
+  includeActions: 'Earn',
+});
+```
+
+---
+
 ### StampApi
 
 `bzbsService.stampApi` — Stamp card system.
@@ -1064,6 +1130,8 @@ import {
 | `Badge` | badgeId, name, description, imageUrl, missions (Mission[]) |
 | `Mission` | missionId, name, current, target, isCompleted |
 | `PointLog` | UserId, Info, Detail, Points, Type, Timestamp |
+| `PointBalance` | Unit, Balance, Currents (date → amount map), Expires (date → amount map) |
+| `PointHistory` | Unit, TransactionId, Reference, Timestamp, TotalChange, Action, Type, Message, Data |
 
 ### Address & Location Models
 

package/dist/index.js

@@ -1715,8 +1715,8 @@ var PointApi = class extends BaseService {
       return yield this.get(
         "point/balance",
         __spreadValues({
-          units: params == null ? void 0 : params.units,
-          boxIds: params == null ? void 0 : params.boxIds,
+          "units[]": params == null ? void 0 : params.units,
+          "boxIds[]": params == null ? void 0 : params.boxIds,
           onlyVisible: params == null ? void 0 : params.onlyVisible
         }, params == null ? void 0 : params.options),
         requestOptions
@@ -1739,8 +1739,8 @@ var PointApi = class extends BaseService {
       return yield this.get(
         "point/detail",
         __spreadValues({
-          units: params == null ? void 0 : params.units,
-          boxIds: params == null ? void 0 : params.boxIds,
+          "units[]": params == null ? void 0 : params.units,
+          "boxIds[]": params == null ? void 0 : params.boxIds,
           onlyVisible: params == null ? void 0 : params.onlyVisible
         }, params == null ? void 0 : params.options),
         requestOptions
@@ -1780,14 +1780,14 @@ var PointApi = class extends BaseService {
           skip: params.skip,
           top: params.top,
           sortType: params.sortType,
-          units: params.units,
-          boxIds: params.boxIds,
-          references: params.references,
-          transactionIds: params.transactionIds,
-          includeActions: params.includeActions,
-          excludeActions: params.excludeActions,
-          includeTypes: params.includeTypes,
-          excludeTypes: params.excludeTypes
+          "units[]": params.units,
+          "boxIds[]": params.boxIds,
+          "references[]": params.references,
+          "transactionIds[]": params.transactionIds,
+          "includeActions[]": params.includeActions,
+          "excludeActions[]": params.excludeActions,
+          "includeTypes[]": params.includeTypes,
+          "excludeTypes[]": params.excludeTypes
         }, params.options),
         requestOptions
       );