@bzbs/react-api-client 1.4.15 → 2.0.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.14 | **License:** ISC | **Author:** Buzzebees Co., Ltd.
+**Version:** 1.4.15 | **License:** ISC | **Author:** Buzzebees Co., Ltd.
 **Repository:** [Azure DevOps](https://dev.azure.com/buzzebees/Buzzebees/_git/React_API_Client)
 
 ---
@@ -11,6 +11,7 @@ A TypeScript library providing a type-safe API client for Buzzebees loyalty and
 
 - [Installation](#installation)
 - [Quick Start](#quick-start)
+- [API Version](#api-version)
 - [Configuration](#configuration)
 - [Architecture](#architecture)
 - [BzbsService Properties](#bzbsservice-properties)
@@ -98,6 +99,18 @@ if (result.type === 'success') {
 
 ---
 
+## API Version
+
+This library targets **Buzzebees API v2**. Key differences from v1:
+
+- All POST request bodies use **JSON** (`application/json`) — no more `application/x-www-form-urlencoded`
+- Profile image upload uses `multipart/form-data` via the dedicated `updateProfileImage()` method
+- Flat endpoint paths replace REST-style path parameters (e.g. `campaign/detail?campaignId=123` replaces `campaign/123`)
+- `profile/me/` prefix removed — the auth token identifies the user (e.g. `profile/info` replaces `profile/me`)
+- Address lookups moved from `main/` to `address/` prefix
+
+---
+
 ## Configuration
 
 ### Constructor
@@ -158,21 +171,21 @@ BzbsService (entry point)
  ├── BadgeApi            → profile/me/badges
  ├── CampaignApi         → campaign/
  ├── CartApi             → cart/
- ├── CategoryApi         → campaigncat/
+ ├── CategoryApi         → category/
  ├── ConsentApi          → consent/
  ├── CouponApi           → coupon/
- ├── DashboardApi        → dashboard/
+ ├── DashboardApi        → dashboard/config
  ├── HistoryApi          → redeem/
  ├── LineApi             → LINE OAuth (optional)
- ├── NotificationApi     → noti/
+ ├── NotificationApi     → notification/
  ├── PlaceApi            → place/
  ├── PointLogApi         → log/points
- ├── ProfileApi          → profile/me
+ ├── ProfileApi          → profile/
  ├── RegistrationApi     → auth/register
- ├── AddressApi          → profile/me/address, main/
+ ├── AddressApi          → profile/address, address/
  ├── StampApi            → stamp/
  ├── RequestHelpApi      → buzz/, profile/me/help
- ├── SettingApi          → setting/
+ ├── SettingApi          → setting/add
  └── Blob                → blob storage
           │
           ▼
@@ -344,8 +357,8 @@ const response = await bzbsService.profileApi.profile(undefined, {
 | `authApi` | `connectGoogle` | POST | `auth/google_login` | idToken, appId, uuid, os, platform, deviceToken, macAddress | `LoginResponse` | `#auth` |
 | `authApi` | `connectApple` | POST | `auth/apple_login` | idToken, refreshToken, appId, uuid, os, platform, deviceToken, macAddress | `LoginResponse` | `#auth` |
 | `authApi` | `logout` | POST | `auth/logout` | uuid | `unknown` | `#auth` |
-| `authApi` | `forgetPassword` | GET | `profile/{contact}/forget_password` | contact, type (`email`\|`contact_number`) | `ForgetPasswordResponse` | `#auth #profile` |
-| `authApi` | `resetPassword` | POST | `profile/{contact}/forget_password` | contact, refCode, newPassword; opt: otp | `StatusResponse` | `#auth #profile` |
+| `authApi` | `forgetPassword` | GET | `profile/forget_password` | contact (as `id` param), type (`email`\|`contact_number`\|`email_otp`) | `ForgetPasswordResponse` | `#auth #profile` |
+| `authApi` | `resetPassword` | POST | `profile/forget_password` | contact (as `id`), refCode, newPassword; opt: otp | `StatusResponse` | `#auth #profile` |
 | `authApi` | `otp` | GET | `auth/otp` | uuid, appId, contactNumber; opt: channel | `OtpResponse` | `#auth` |
 | `authApi` | `otpV2` | POST | `auth/otp` | appId, contactNumber; opt: channel | `OtpResponse` | `#auth` |
 | `authApi` | `otpEmail` | GET | `auth/otp_email` | uuid, appId, email; opt: channel | `OtpResponse` | `#auth` |
@@ -356,55 +369,56 @@ const response = await bzbsService.profileApi.profile(undefined, {
 | `authApi` | `version` | GET | `auth/version` | clientVersion | `Version` | `#auth` |
 | `authApi` | `versionRaw` | GET | `auth/version` | clientVersion | `any` | `#auth` |
 | `badgeApi` | `badges` | GET | `profile/me/badges` | opt: badgeId | `Badge[]` | `#profile` |
-| `campaignApi` | `campaigns` | GET | `campaign` | config; opt: cat, byConfig, skip, top, locale, keyword, startDate, sponsorId, maxPoints, minPoints, sortBy, center, hashTags, locationAgencyId | `Campaign[]` | `#campaign` |
-| `campaignApi` | `favoriteCampaigns` | GET | `profile/me/favourite_campaign` | opt: skip, top, locale | `Campaign[]` | `#campaign #profile` |
-| `campaignApi` | `campaignDetails` | GET | `campaign/{id}` | id; opt: deviceLocale | `CampaignDetail` | `#campaign` |
-| `campaignApi` | `addToFavorite` | POST | `campaign/{id}/favourite` | id | `FavoriteResponse` | `#campaign` |
-| `campaignApi` | `removeFromFavorite` | DELETE | `campaign/{id}/favourite` | id | `FavoriteResponse` | `#campaign` |
-| `campaignApi` | `redeem` | POST | `campaign/{id}/redeem` | id; opt: addressKey, contactNumber, pointUnit, spPoints | `RedeemResponse` | `#campaign #points` |
+| `campaignApi` | `campaigns` | GET | `campaign/list` | config; opt: cat, byConfig, skip, top, locale, keyword, startDate, sponsorId, maxPoints, minPoints, sortBy, center, hashTags, locationAgencyId | `Campaign[]` | `#campaign` |
+| `campaignApi` | `favoriteCampaigns` | GET | `profile/favourite_campaign` | opt: skip, top, locale | `Campaign[]` | `#campaign #profile` |
+| `campaignApi` | `campaignDetails` | GET | `campaign/detail` | id (as `campaignId`); opt: deviceLocale | `CampaignDetail` | `#campaign` |
+| `campaignApi` | `addToFavorite` | POST | `campaign/favourite` | id (as body `id`, `favourite: true`) | `FavoriteResponse` | `#campaign` |
+| `campaignApi` | `removeFromFavorite` | DELETE | `campaign/favourite` | id (as query param) | `FavoriteResponse` | `#campaign` |
+| `campaignApi` | `redeem` | POST | `campaign/redeem` | id (as `campaignid`); opt: addressKey, contactNumber, pointUnit, spPoints | `RedeemResponse` | `#campaign #points` |
 | `campaignApi` | `bulkRedeem` | POST | `campaign/{id}/bulkredeem` | id, quantity; opt: addressKey, contactNumber, pointUnit, spPoints | `RedeemResponse` | `#campaign #points` |
 | `cartApi` | `addCart` | POST | `cart/{id}/add` | id; opt: mode, qty, sideCampaignJson | `CartCountResponse` | `#cart #campaign` |
 | `cartApi` | `cartCount` | GET | `cart/count` | opt: options | `CartCountResponse` | `#cart` |
-| `cartApi` | `cartAccess` | POST | `setting` | errorUrl, successUrl, returnUrl, appId, appName | `CartAccessResponse` | `#cart #setting` |
-| `categoryApi` | `categories` | GET | `campaigncat/menu` | config; opt: byConfig | `Category[]` | `#category #campaign` |
-| `consentApi` | `consent` | GET | `consent` | opt: options | `Consent` | `#consent` |
-| `consentApi` | `updateConsent` | POST | `consent` | opt: termsAndConditions, dataPrivacy, marketingOption, consentAge, email, sms, notification, line, analyticsBuzzebeesCookies, analyticsFirebaseCookies, analyticsGoogleCookies, analyticsMetaCookies, analyticsOtherCookies, functionalCookies, marketingCookies, necessaryCookies | `Consent` | `#consent` |
+| `cartApi` | `cartAccess` | POST | `setting/add` | errorUrl, successUrl, returnUrl, appId, appName | `CartAccessResponse` | `#cart #setting` |
+| `categoryApi` | `categories` | GET | `category/menu` | config; opt: byConfig | `Category[]` | `#category #campaign` |
+| `consentApi` | `consent` | GET | `consent/status` | opt: options | `Consent` | `#consent` |
+| `consentApi` | `updateConsent` | POST | `consent/consent` | opt: termsAndConditions, dataPrivacy, marketingOption, consentAge, email, sms, notification, line, analyticsBuzzebeesCookies, analyticsFirebaseCookies, analyticsGoogleCookies, analyticsMetaCookies, analyticsOtherCookies, functionalCookies, marketingCookies, necessaryCookies | `Consent` | `#consent` |
 | `consentApi` | `unconsent` | POST | `consent/unconsent` | opt: options | `unknown` | `#consent` |
-| `couponApi` | `processCodes` | POST | `coupon/process` | codes (string) | `CouponResponse` | `#coupon #campaign` |
-| `dashboardApi` | `mainDashboard` | GET | `dashboard/main` | appName, locale | `Dashboard[]` | `#dashboard` |
-| `dashboardApi` | `subDashboard` | GET | `dashboard/{dashboardName}` | dashboardName, locale | `Dashboard[]` | `#dashboard` |
-| `historyApi` | `redeemHistories` | GET | `redeem` | byConfig, config, skip, top; opt: locale, startDate, endDate | `Purchase[]` | `#history #campaign` |
-| `historyApi` | `use` | POST | `redeem/{redeemKey}/use` | redeemKey | `UseCampaignResponse` | `#history #campaign` |
+| `couponApi` | `processCodes` | POST | `coupon/process` | codes (string or string[], sent as JSON array) | `CouponResponse` | `#coupon #campaign` |
+| `dashboardApi` | `mainDashboard` | GET | `dashboard/config` | appName (as `config`), locale | `Dashboard[]` | `#dashboard` |
+| `dashboardApi` | `subDashboard` | GET | `dashboard/config` | dashboardName (as `config`), locale | `Dashboard[]` | `#dashboard` |
+| `historyApi` | `redeemHistories` | GET | `redeem/list` | byConfig, config, skip, top; opt: locale, startDate, endDate | `Purchase[]` | `#history #campaign` |
+| `historyApi` | `use` | POST | `redeem/use` | redeemKey (as `redeemkey` in body) | `UseCampaignResponse` | `#history #campaign` |
 | `lineApi` | `lineAuth` | POST | `oauth2/v2.1/token` _(baseLineUrl)_ | grantType, code, clientId, clientSecret, redirectUrl | `LineAuthResponse` | `#line #auth` |
-| `notificationApi` | `notifications` | GET | `noti` | mode (`new`\|`all`), sortBy (`createdate_desc`\|`createdate_asc`); opt: top, skip | `Notification[]` | `#notification` |
-| `notificationApi` | `read` | POST | `noti/read` | ids (comma-separated) | `unknown` | `#notification` |
+| `notificationApi` | `notifications` | GET | `notification/list` | mode (`new`\|`all`), sortBy (`createdate_desc`\|`createdate_asc`); opt: top, skip | `Notification[]` | `#notification` |
+| `notificationApi` | `read` | POST | `notification/read` | ids (comma-separated, sent as JSON body) | `unknown` | `#notification` |
 | `placeApi` | `placeList` | GET | `place` | agencyId, center, distance, top; opt: provinceCode, category, mode, requiredCampaign, keyword, isFavourite | `Place[]` | `#place` |
 | `placeApi` | `place` | GET | `place/{id}` | id, agencyId; opt: requiredCampaign, isFavourite | `Place` | `#place` |
 | `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` |
-| `profileApi` | `profile` | GET | `profile/me` | opt: options | `ProfileResponse` | `#profile` |
-| `profileApi` | `updateProfile` | POST | `profile/me` | opt: profileImage (File), 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, ... | `ProfileResponse` | `#profile` |
-| `profileApi` | `changePassword` | POST | `profile/me/change_password` | current, change | `StatusResponse` | `#profile #auth` |
-| `profileApi` | `updateShipping` | POST | `profile/me/shipping` | opt: shippingFirstName, shippingLastName, shippingProvinceCode, shippingDistrictCode, shippingSubDistrictCode, shippingZipCode, shippingAddress, shippingContactNumber, ... | `unknown` | `#profile #address` |
+| `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` |
+| `profileApi` | `changePassword` | POST | `profile/change_password` | current, change | `StatusResponse` | `#profile #auth` |
+| `profileApi` | `updateShipping` | POST | `profile/shipping` | opt: shippingFirstName, shippingLastName, shippingProvinceCode, shippingDistrictCode, shippingSubDistrictCode, shippingZipCode, shippingAddress, shippingContactNumber, ... | `unknown` | `#profile #address` |
 | `profileApi` | `changeContactNumber` | POST | `auth/change_authen` | contactNumber, otp, refCode; opt: idCard | `ConfirmOtpResponse` | `#profile #auth` |
-| `profileApi` | `changeContactNumberV2` | POST | `profile/me/contact_number` | contactNumber, otp, refCode | `any` | `#profile #auth` |
-| `profileApi` | `changeContactNumberV3` | POST | `profile/{userId}/contact_number` | userId, contactNumber, otp, refCode | `any` | `#profile #auth` |
-| `profileApi` | `points` | GET | `profile/me/updated_points` | opt: options | `UpdatedPoints` | `#profile #points` |
-| `profileApi` | `expiringPoints` | GET | `profile/me/allexpiring_points` | opt: options | `ExpiringPoints` | `#profile #points` |
-| `profileApi` | `deactivate` | POST | `profile/me/deactivate` | opt: options | `unknown` | `#profile` |
+| `profileApi` | `changeContactNumberV2` | POST | `profile/contact_number` | contactNumber, otp, refCode | `any` | `#profile #auth` |
+| `profileApi` | `changeContactNumberV3` | POST | `profile/contact_number` | userId (as `userid` in body), contactNumber, otp, refCode | `any` | `#profile #auth` |
+| `profileApi` | `points` | GET | `profile/updated_points` | opt: options | `UpdatedPoints` | `#profile #points` |
+| `profileApi` | `expiringPoints` | GET | `profile/allexpiring_points` | opt: options | `ExpiringPoints` | `#profile #points` |
+| `profileApi` | `deactivate` | POST | `profile/deactivate` | opt: options | `unknown` | `#profile` |
 | `registerApi` | `validateRegister` | POST | `auth/validate_register` | appId, username, email, contactNumber | `OtpResponse` | `#registration #auth` |
 | `registerApi` | `register` | POST | `auth/register` | appId, uuid, macAddress, os, platform, clientVersion, deviceNotificationEnable, username, password, confirmPassword, firstName, lastName, contactNumber, otp, refCode, options; opt: address, gender, birthdate, email, refUserCode, termAndConditionVersion, dataPrivacyVersion, marketingOptionsVersion, consentAge, emailMarketing, smsMarketing, notificationMarketing, lineMarketing, phoneMarketing | `RegistrationResponse` | `#registration #auth` |
-| `addressApi` | `zipCodes` | GET | `main/postcode` | opt: zipCode | `ZipCode[]` | `#address` |
-| `addressApi` | `provinces` | GET | `main/province` | opt: options | `Province[]` | `#address` |
-| `addressApi` | `districts` | GET | `main/district` | opt: provinceCode | `District[]` | `#address` |
-| `addressApi` | `subDistricts` | GET | `main/subdistrict` | opt: provinceCode, districtCode | `SubDistrict[]` | `#address` |
-| `addressApi` | `userAddresses` | GET | `profile/me/addresses` | opt: options | `Address[]` | `#address #profile` |
-| `addressApi` | `updateAddress` | POST | `profile/me/address` | opt: name, addressName, firstName, lastName, address, zipcode, provinceCode, provinceName, districtCode, districtName, subDistrictCode, subDistrictName, contactNumber, countryCode, countryName, isDefault, rowKey | `Address` | `#address #profile` |
-| `addressApi` | `deleteAddress` | DELETE | `profile/me/address` | opt: rowKey | `unknown` | `#address #profile` |
-| `addressApi` | `userTaxAddresses` | GET | `profile/me/taxes` | opt: options | `Address[]` | `#address #profile` |
-| `addressApi` | `updateTaxAddress` | POST | `profile/me/tax` | opt: rowKey, taxId, isDefault, personType, title, name, firstName, lastName, email, contactNumber, companyName, address, addressName, floor, building, moo, road, room, soi, village, districtCode, provinceName, subDistrictCode, zipcode | `Address` | `#address #profile` |
-| `addressApi` | `deleteTaxAddress` | DELETE | `profile/me/tax` | opt: rowKey | `unknown` | `#address #profile` |
+| `addressApi` | `zipCodes` | GET | `address/postcode` | opt: zipCode | `ZipCode[]` | `#address` |
+| `addressApi` | `provinces` | GET | `address/province` | opt: options | `Province[]` | `#address` |
+| `addressApi` | `districts` | GET | `address/district` | opt: provinceCode | `District[]` | `#address` |
+| `addressApi` | `subDistricts` | GET | `address/subdistrict` | opt: provinceCode, districtCode | `SubDistrict[]` | `#address` |
+| `addressApi` | `userAddresses` | GET | `profile/addresses` | opt: options | `Address[]` | `#address #profile` |
+| `addressApi` | `updateAddress` | POST | `profile/address` | opt: name, addressName, firstName, lastName, address, zipcode, provinceCode, provinceName, districtCode, districtName, subDistrictCode, subDistrictName, contactNumber, countryCode, countryName, latitude, longitude, landmark, isDefault, rowKey | `Address` | `#address #profile` |
+| `addressApi` | `deleteAddress` | DELETE | `profile/address` | opt: rowKey | `unknown` | `#address #profile` |
+| `addressApi` | `userTaxAddresses` | GET | `profile/taxes` | opt: options | `Address[]` | `#address #profile` |
+| `addressApi` | `updateTaxAddress` | POST | `profile/tax` | opt: rowKey, taxId, isDefault, personType, title, name, firstName, lastName, email, contactNumber, brnachId, branchName, companyName, address, addressName, floor, building, moo, road, room, soi, village, districtCode, provinceName, subDistrictCode, zipcode | `Address` | `#address #profile` |
+| `addressApi` | `deleteTaxAddress` | DELETE | `profile/tax` | opt: rowKey | `unknown` | `#address #profile` |
 | `stampApi` | `createStamp` | POST | `stamp/create` | opt: imei, issuer, os, platform | `CreateStampResponse` | `#stamp` |
 | `stampApi` | `stamps` | GET | `stamp` | options | `Stamp[]` | `#stamp` |
 | `stampApi` | `stampProfile` | GET | `stamp/{id}/profile` | id, cardId | `StampProfileResponse` | `#stamp` |
@@ -416,7 +430,7 @@ const response = await bzbsService.profileApi.profile(undefined, {
 | `forumApi` | `postComment` | POST | `buzz/{buzzKey}/comments` | buzzKey, message; opt: image (File) | `ChatMessage` | `#forum` |
 | `forumApi` | `like` | POST | `buzz/{buzzKey}/like` | buzzKey | `LikeForumResponse` | `#forum` |
 | `forumApi` | `unlike` | DELETE | `buzz/{buzzKey}/like` | buzzKey | `LikeForumResponse` | `#forum` |
-| `settingApi` | `accessKey` | POST | `setting` | data (JSON: app_id, campaign_id, locale, return_url, version; opt: redeem_key) | `AccessTokenResponse` | `#setting #campaign` |
+| `settingApi` | `accessKey` | POST | `setting/add` | data (JSON: app_id, campaign_id, locale, return_url, version; opt: redeem_key) | `AccessTokenResponse` | `#setting #campaign` |
 | `blob` | `consentVersion` | GET | `pdpaconsent/{appId}/version` _(baseBlobUrl)_ | appId | `ConsentVersion` | `#blob #consent` |
 | `blob` | `maintenance` | GET | `config/maintenance/{appId}.json` _(baseBlobUrl)_ | appId | `Maintenance` | `#blob` |
 | `blob` | `blob` | GET | `{path}` _(baseBlobUrl)_ | path | `unknown` | `#blob` |
@@ -551,7 +565,8 @@ const redeem = await bzbsService.campaignApi.redeem({
 | Method | Description | Returns |
 |---|---|---|
 | `profile()` | Get current user profile | `ProfileResponse` |
-| `updateProfile(params)` | Update user profile (supports image upload) | `ProfileResponse` |
+| `updateProfile(params)` | Update user profile fields (JSON body) | `ProfileResponse` |
+| `updateProfileImage(params)` | Upload profile picture (multipart/form-data) | `ProfileResponse` |
 | `changePassword(params)` | Change user password | `StatusResponse` |
 | `updateShipping(params)` | Update shipping information | `unknown` |
 | `changeContactNumber(params)` | Change contact number (v1) | `ConfirmOtpResponse` |
@@ -562,15 +577,19 @@ const redeem = await bzbsService.campaignApi.redeem({
 | `deactivate()` | Deactivate user account | `unknown` |
 
 ```typescript
-// Update profile with image
+// Update profile fields (JSON)
 const result = await bzbsService.profileApi.updateProfile({
   firstName: 'John',
   lastName: 'Doe',
   email: 'john@example.com',
   contactNumber: '0812345678',
   gender: 'male',
-  birthDate: 946684800,   // Unix timestamp in seconds
-  profileImage: fileObject,
+  birthDate: 946684800, // Unix timestamp in seconds
+});
+
+// Upload profile picture (multipart/form-data, field key: "data")
+await bzbsService.profileApi.updateProfileImage({
+  image: imageFile, // File | { uri: string; name: string; type: string }
 });
 ```
 
@@ -775,6 +794,8 @@ const badge = await bzbsService.badgeApi.badges({ badgeId: '123' });
 
 `bzbsService.consentApi` — PDPA and marketing consent management.
 
+> **v2 change:** `consent()` now calls `consent/status`; `updateConsent()` now calls `consent/consent`.
+
 | Method | Description | Returns |
 |---|---|---|
 | `consent()` | Get user's consent status | `Consent` |
@@ -805,6 +826,8 @@ await bzbsService.consentApi.updateConsent({
 
 `bzbsService.dashboardApi` — Dashboard content configuration.
 
+> **v2 change:** Both `mainDashboard` and `subDashboard` now call `dashboard/config`. The `appName`/`dashboardName` param is sent as `config`.
+
 | Method | Description | Returns |
 |---|---|---|
 | `mainDashboard(params)` | Get main dashboard data | `Dashboard[]` |
@@ -812,12 +835,12 @@ await bzbsService.consentApi.updateConsent({
 
 ```typescript
 const dashboard = await bzbsService.dashboardApi.mainDashboard({
-  appName: 'buzzebeesdemo',
-  locale: 1054, // Thai locale
+  appName: 'buzzebeesdemo', // sent as `config` query param
+  locale: 1054,
 });
 
 const sub = await bzbsService.dashboardApi.subDashboard({
-  dashboardName: 'featured',
+  dashboardName: 'featured', // sent as `config` query param
   locale: 1054,
 });
 ```
@@ -943,6 +966,8 @@ await bzbsService.forumApi.postRequestHelp({
 
 `bzbsService.settingApi` — Web landing page access tokens.
 
+> **v2 change:** Endpoint changed from `setting` to `setting/add`.
+
 | Method | Description | Returns |
 |---|---|---|
 | `accessKey(params)` | Get access key for web landing pages | `AccessTokenResponse` |

package/dist/index.d.mts

@@ -1583,7 +1583,7 @@ declare class AuthenticateApi extends BaseService {
      */
     forgetPassword(params: {
         contact: string;
-        type: 'email' | 'contact_number';
+        type: 'email' | 'contact_number' | 'email_otp';
         options?: {
             [key: string]: unknown;
         };
@@ -1825,14 +1825,18 @@ declare class CampaignApi extends BaseService {
      * @param params.deviceLocale - The device locale for the campaigns.
      * @param params.locale - The locale for the campaigns.
      * @param params.keyword - The keyword for the campaigns.
-     * @param params.startDate - The start date for the campaigns.
+     * @param params.startDate - The start date for the campaigns. Example: 2017-07-21T17:32:28Z
      * @param params.sponsorId - The sponsor ID for the campaigns.
      * @param params.maxPoints - The maximum points for the campaigns.
      * @param params.minPoints - The minimum points for the campaigns.
+     * @param params.minPrice - The minimum price for the campaigns.
+     * @param params.maxPrice - The maximum price for the campaigns.
      * @param params.sortBy - The sort order for the campaigns.
      * @param params.center - The coordinates for the center of the campaigns.
      * @param params.hashTags - The hash tags for the campaigns.
      * @param params.locationAgencyId - The location agency ID for the campaigns.
+     * @param params.campaignservice - Use campaign service.
+     * @param params.mode - The mode for the campaigns.
      * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - The options for the HTTP request.
      * @returns A promise that resolves to a ServiceResponse containing an array of Campaign objects.
@@ -1850,10 +1854,14 @@ declare class CampaignApi extends BaseService {
         sponsorId?: string;
         maxPoints?: string;
         minPoints?: string;
+        minPrice?: string;
+        maxPrice?: string;
         sortBy?: string;
         center?: string;
         hashTags?: string;
         locationAgencyId?: string;
+        campaignservice?: boolean;
+        mode?: string | 'hot' | 'all' | 'bzbs' | 'sponsor' | 'draw' | 'free' | 'deal' | 'buy' | 'ads' | 'full' | 'cart';
         options?: {
             [key: string]: unknown;
         };
@@ -2054,7 +2062,7 @@ declare class ConsentApi extends BaseService {
         [key: string]: unknown;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Consent>>;
     /**
-     * Retrieves the user's consent information.
+     * Update the user's consent information.
      *
      * @param params - The parameters for the consent request.
      * @param params.termsAndConditions - The terms and conditions consent version.
@@ -2099,10 +2107,10 @@ declare class ConsentApi extends BaseService {
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Consent>>;
     /**
-     * Unconsents the user.
+     * Revoke user consent.
      *
      * @param requestOptions - The options for the request.
-     * @returns A promise that resolves to a ServiceResponse containing the result of the unconsent operation.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the revoke consent operation.
      */
     unconsent(options?: {
         [key: string]: unknown;
@@ -2112,7 +2120,7 @@ declare class ConsentApi extends BaseService {
 declare class CouponApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
     /**
-     * Processes coupon codes.
+     * Process coupon codes to earn points.
      *
      * @param params - The parameters.
      * @param params.codes - The coupon codes to process.
@@ -2410,11 +2418,6 @@ declare class ProfileApi extends BaseService {
      * @returns A promise that resolves to a ServiceResponse containing the updated profile.
      */
     updateProfile(params: {
-        profileImage?: File | {
-            uri: string;
-            name: string;
-            type: string;
-        } | object;
         firstName?: string;
         lastName?: string;
         contactNumber?: string;
@@ -2586,6 +2589,25 @@ declare class ProfileApi extends BaseService {
     expiringPoints(options?: {
         [key: string]: unknown;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<ExpiringPoints>>;
+    /**
+     * Updates the user's profile picture.
+     *
+     * @param params - The parameters.
+     * @param params.image - The image file to upload (File or cross-platform file object with uri, name, type).
+     * @param params.options - Optional additional parameters.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the updated profile.
+     */
+    updateProfileImage(params: {
+        image: File | {
+            uri: string;
+            name: string;
+            type: string;
+        } | object;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ProfileResponse>>;
     /**
      * Deactivates the user's profile.
      *
@@ -2788,6 +2810,9 @@ declare class AddressApi extends BaseService {
         contactNumber?: string;
         countryCode?: string;
         countryName?: string;
+        latitude?: number;
+        longitude?: number;
+        landmark?: string;
         isDefault?: boolean;
         rowKey?: string;
         options?: {
@@ -2837,6 +2862,8 @@ declare class AddressApi extends BaseService {
         lastName?: string;
         email?: string;
         contactNumber?: string;
+        brnachId?: string;
+        branchName?: string;
         companyName?: string;
         address?: string;
         addressName?: string;

package/dist/index.d.ts

@@ -1583,7 +1583,7 @@ declare class AuthenticateApi extends BaseService {
      */
     forgetPassword(params: {
         contact: string;
-        type: 'email' | 'contact_number';
+        type: 'email' | 'contact_number' | 'email_otp';
         options?: {
             [key: string]: unknown;
         };
@@ -1825,14 +1825,18 @@ declare class CampaignApi extends BaseService {
      * @param params.deviceLocale - The device locale for the campaigns.
      * @param params.locale - The locale for the campaigns.
      * @param params.keyword - The keyword for the campaigns.
-     * @param params.startDate - The start date for the campaigns.
+     * @param params.startDate - The start date for the campaigns. Example: 2017-07-21T17:32:28Z
      * @param params.sponsorId - The sponsor ID for the campaigns.
      * @param params.maxPoints - The maximum points for the campaigns.
      * @param params.minPoints - The minimum points for the campaigns.
+     * @param params.minPrice - The minimum price for the campaigns.
+     * @param params.maxPrice - The maximum price for the campaigns.
      * @param params.sortBy - The sort order for the campaigns.
      * @param params.center - The coordinates for the center of the campaigns.
      * @param params.hashTags - The hash tags for the campaigns.
      * @param params.locationAgencyId - The location agency ID for the campaigns.
+     * @param params.campaignservice - Use campaign service.
+     * @param params.mode - The mode for the campaigns.
      * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - The options for the HTTP request.
      * @returns A promise that resolves to a ServiceResponse containing an array of Campaign objects.
@@ -1850,10 +1854,14 @@ declare class CampaignApi extends BaseService {
         sponsorId?: string;
         maxPoints?: string;
         minPoints?: string;
+        minPrice?: string;
+        maxPrice?: string;
         sortBy?: string;
         center?: string;
         hashTags?: string;
         locationAgencyId?: string;
+        campaignservice?: boolean;
+        mode?: string | 'hot' | 'all' | 'bzbs' | 'sponsor' | 'draw' | 'free' | 'deal' | 'buy' | 'ads' | 'full' | 'cart';
         options?: {
             [key: string]: unknown;
         };
@@ -2054,7 +2062,7 @@ declare class ConsentApi extends BaseService {
         [key: string]: unknown;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Consent>>;
     /**
-     * Retrieves the user's consent information.
+     * Update the user's consent information.
      *
      * @param params - The parameters for the consent request.
      * @param params.termsAndConditions - The terms and conditions consent version.
@@ -2099,10 +2107,10 @@ declare class ConsentApi extends BaseService {
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Consent>>;
     /**
-     * Unconsents the user.
+     * Revoke user consent.
      *
      * @param requestOptions - The options for the request.
-     * @returns A promise that resolves to a ServiceResponse containing the result of the unconsent operation.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the revoke consent operation.
      */
     unconsent(options?: {
         [key: string]: unknown;
@@ -2112,7 +2120,7 @@ declare class ConsentApi extends BaseService {
 declare class CouponApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
     /**
-     * Processes coupon codes.
+     * Process coupon codes to earn points.
      *
      * @param params - The parameters.
      * @param params.codes - The coupon codes to process.
@@ -2410,11 +2418,6 @@ declare class ProfileApi extends BaseService {
      * @returns A promise that resolves to a ServiceResponse containing the updated profile.
      */
     updateProfile(params: {
-        profileImage?: File | {
-            uri: string;
-            name: string;
-            type: string;
-        } | object;
         firstName?: string;
         lastName?: string;
         contactNumber?: string;
@@ -2586,6 +2589,25 @@ declare class ProfileApi extends BaseService {
     expiringPoints(options?: {
         [key: string]: unknown;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<ExpiringPoints>>;
+    /**
+     * Updates the user's profile picture.
+     *
+     * @param params - The parameters.
+     * @param params.image - The image file to upload (File or cross-platform file object with uri, name, type).
+     * @param params.options - Optional additional parameters.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the updated profile.
+     */
+    updateProfileImage(params: {
+        image: File | {
+            uri: string;
+            name: string;
+            type: string;
+        } | object;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ProfileResponse>>;
     /**
      * Deactivates the user's profile.
      *
@@ -2788,6 +2810,9 @@ declare class AddressApi extends BaseService {
         contactNumber?: string;
         countryCode?: string;
         countryName?: string;
+        latitude?: number;
+        longitude?: number;
+        landmark?: string;
         isDefault?: boolean;
         rowKey?: string;
         options?: {
@@ -2837,6 +2862,8 @@ declare class AddressApi extends BaseService {
         lastName?: string;
         email?: string;
         contactNumber?: string;
+        brnachId?: string;
+        branchName?: string;
         companyName?: string;
         address?: string;
         addressName?: string;