@bzbs/react-api-client 2.0.3 → 2.1.1

package/dist/index.mjs

@@ -1019,6 +1019,7 @@ var CampaignApi = class extends BaseService {
    * @param params.contactNumber - The contact number of the user.
    * @param params.options - Additional options for the redemption.
    * @param params.spPoints - Point Per Unit x Quantity (Donate only).
+   * @param params.pointUnit - The point unit of the campaign (Point Service Only).
    * @param requestOptions - The options for the HTTP request.
    * @returns A promise that resolves to a service response containing the redeem response.
    */
@@ -1648,6 +1649,107 @@ var PointLogApi = class extends BaseService {
   }
 };
 
+// src/api/points/point-api.ts
+var PointApi = class extends BaseService {
+  constructor(client, baseUrl) {
+    super(client, baseUrl);
+  }
+  /**
+   * Retrieves the current point balance for the authenticated user across the requested point units.
+   *
+   * @param params - The parameters for retrieving the point balance.
+   * @param params.units - (Optional) Point unit codes (e.g. Point, Coin). Omit to use all units configured for the app.
+   * @param params.boxIds - (Optional) Box (sub-bucket) identifiers to filter by.
+   * @param params.onlyVisible - (Optional) When true (default), only units marked visible for the app are considered.
+   * @param params.options - (Optional) Additional options for the request.
+   * @param requestOptions - (Optional) The request options.
+   * @returns A promise that resolves to a service response containing an array of point balances.
+   */
+  balance(params, requestOptions) {
+    return __async(this, null, function* () {
+      return yield this.get(
+        "point/balance",
+        __spreadValues({
+          "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
+      );
+    });
+  }
+  /**
+   * Retrieves the point balance with Currents and Expires breakdowns keyed by date.
+   *
+   * @param params - The parameters for retrieving the point detail.
+   * @param params.units - (Optional) Point unit codes (e.g. Point, Coin). Omit to use all units configured for the app.
+   * @param params.boxIds - (Optional) Box (sub-bucket) identifiers to filter by.
+   * @param params.onlyVisible - (Optional) When true (default), only units marked visible for the app are considered.
+   * @param params.options - (Optional) Additional options for the request.
+   * @param requestOptions - (Optional) The request options.
+   * @returns A promise that resolves to a service response containing an array of point balances with breakdowns.
+   */
+  detail(params, requestOptions) {
+    return __async(this, null, function* () {
+      return yield this.get(
+        "point/detail",
+        __spreadValues({
+          "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
+      );
+    });
+  }
+  /**
+   * Retrieves a paginated list of earn/burn/transfer transactions between start and end dates.
+   *
+   * @param params - The parameters for retrieving the point history.
+   * @param params.start - Start of the range (inclusive), ISO-8601 with offset.
+   * @param params.end - End of the range (inclusive), ISO-8601 with offset.
+   * @param params.onlyVisible - (Optional) When true (default), only units marked visible for the app are considered.
+   * @param params.skip - (Optional) Number of records to skip (offset pagination).
+   * @param params.top - (Optional) Maximum number of records to return.
+   * @param params.sortType - (Optional) Sort direction for Timestamp: Asc|Desc.
+   * @param params.units - (Optional) Point unit codes to filter by.
+   * @param params.boxIds - (Optional) Box (sub-bucket) identifiers to filter by.
+   * @param params.references - (Optional) Filter by transaction reference.
+   * @param params.transactionIds - (Optional) Filter by exact transaction IDs.
+   * @param params.includeActions - (Optional) Only include transactions whose Action matches (e.g. Earn, Burn, Transfer).
+   * @param params.excludeActions - (Optional) Exclude transactions whose Action matches.
+   * @param params.includeTypes - (Optional) Only include transactions whose Type matches.
+   * @param params.excludeTypes - (Optional) Exclude transactions whose Type matches.
+   * @param params.options - (Optional) Additional options for the request.
+   * @param requestOptions - (Optional) The request options.
+   * @returns A promise that resolves to a service response containing an array of point history transactions.
+   */
+  history(params, requestOptions) {
+    return __async(this, null, function* () {
+      return yield this.get(
+        "point/history",
+        __spreadValues({
+          start: params.start,
+          end: params.end,
+          onlyVisible: params.onlyVisible,
+          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
+        }, params.options),
+        requestOptions
+      );
+    });
+  }
+};
+
 // src/api/profile/profile-api.ts
 var ProfileApi = class extends BaseService {
   constructor(client, baseUrl) {
@@ -2607,6 +2709,7 @@ var BzbsService = class {
     this.notificationApi = new NotificationApi(this.client, this.baseUrl);
     this.placeApi = new PlaceApi(this.client, this.baseUrl);
     this.pointLogApi = new PointLogApi(this.client, this.baseUrl);
+    this.pointApi = new PointApi(this.client, this.baseUrl);
     this.profileApi = new ProfileApi(this.client, this.baseUrl);
     this.registerApi = new RegistrationApi(this.client, this.baseUrl);
     this.addressApi = new AddressApi(this.client, this.baseUrl);
@@ -2629,6 +2732,7 @@ var BzbsService = class {
     this.notificationApi.setBaseUrl(baseUrl);
     this.placeApi.setBaseUrl(baseUrl);
     this.pointLogApi.setBaseUrl(baseUrl);
+    this.pointApi.setBaseUrl(baseUrl);
     this.profileApi.setBaseUrl(baseUrl);
     this.registerApi.setBaseUrl(baseUrl);
     this.addressApi.setBaseUrl(baseUrl);
@@ -2664,6 +2768,7 @@ export {
   LineApi,
   NotificationApi,
   PlaceApi,
+  PointApi,
   PointLogApi,
   ProfileApi,
   RegistrationApi,