@bzbs/react-api-client 0.0.4 → 0.0.6

package/dist/index.d.mts

@@ -819,144 +819,282 @@ declare class AuthenticateApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
     /**
      * Performs a device login using the provided device uuid.
-     * @param appId - Your application id.
-     * @param uuid - The unique device identifier.
+     *
+     * @param params - The parameters.
+     * @param params.appId - Your application id.
+     * @param params.uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    deviceLogin(appId: string, uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    deviceLogin(params: {
+        appId: string;
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
      * Performs a Facebook login using the provided Facebook access token.
+     *
+     * @param params - The parameters.
      * @param accessToken - The access token obtained from Facebook.
      * @param appId - Your application id.
      * @param uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    facebookLogin(accessToken: string, appId: string, uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    facebookLogin(params: {
+        accessToken: string;
+        appId: string;
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
      * Performs a Google login using the provided id token, app id, and uuid.
-     * @param idToken - The Google id token.
-     * @param appId - Your application id.
-     * @param uuid - The unique device identifier.
+     *
+     * @param params - The parameters.
+     * @param params.idToken - The Google id token.
+     * @param params.appId - Your application id.
+     * @param params.uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    googleLogin(idToken: string, appId: string, uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    googleLogin(params: {
+        idToken: string;
+        appId: string;
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
      * Performs a Line login using the provided id token, Line access token and authorization code.
-     * @param idToken - The Line id token.
-     * @param lineAccessToken - The Line access token.
-     * @param authorizationCode - The authorization code.
-     * @param appId - Your application id.
-     * @param uuid - The unique device identifier.
-     * @param requestOptions - Optional request options.
+     *
+     * @param params - The parameters.
+     * @param params.idToken - The Line id token.
+     * @param params.lineAccessToken - The Line access token.
+     * @param params.authorizationCode - The Line authorization code.
+     * @param params.appId - Your application id.
+     * @param params.uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    lineLogin(idToken: string, lineAccessToken: string, authorizationCode: string, appId: string, uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    lineLogin(params: {
+        idToken: string;
+        lineAccessToken: string;
+        authorizationCode: string;
+        appId: string;
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
      * Performs an Apple login using the provided id token and Apple refresh token.
-     * @param idToken - The Apple id token.
-     * @param refreshToken - The Apple access token.
-     * @param appId - Your application id.
-     * @param uuid - The unique device identifier.
+     *
+     * @param params - The parameters.
+     * @param params.idToken - The Apple id token.
+     * @param params.refreshToken - The Apple refresh token.
+     * @param params.appId - Your application id.
+     * @param params.uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    appleLogin(idToken: string, refreshToken: string, appId: string, uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    appleLogin(params: {
+        idToken: string;
+        refreshToken: string;
+        appId: string;
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
-     * Authenticates a user using a username and password.
+     * Performs a username and password login using the provided username and password.
      *
-     * @param username - The username of the user.
-     * @param password - The password of the user.
-     * @param uuid - The unique device identifier.
-     * @param appId - Your application id.
-     * @param requestOptions - Optional request options.
+     * @param params - The parameters.
+     * @param params.username - The username of the user.
+     * @param params.password - The password of the user.
+     * @param params.uuid - The unique device identifier.
+     * @param params.appId - Your application id.
+     * @param params.options - (Optional) Additional params for the request.
      * @returns A promise that resolves to a ServiceResponse containing the login response.
      */
-    usernamePasswordLogin(username: string, password: string, uuid: string, appId: string, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    usernamePasswordLogin(params: {
+        username: string;
+        password: string;
+        uuid: string;
+        appId: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
-     * Logs out the user with the specified UUID.
-     * @param uuid - The unique device identifier.
+     * Performs a logout for the user.
+     *
+     * @param params - The parameters.
+     * @param params.uuid - The unique device identifier.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
-     * @returns A promise that resolves to a ServiceResponse containing the logout result.
+     * @returns A promise that resolves to a ServiceResponse containing the logout response.
      */
-    logout(uuid: string, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
+    logout(params: {
+        uuid: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
     /**
-     * Sends a forget password request to the server.
+     * Sends a forget password request to the user.
      *
-     * @param contact - The contact information for the user (email or contact number).
-     * @param type - The type of contact information provided ('email' or 'contact_number').
+     * @param params - The parameters.
+     * @param params.contact - The contact information for the user (email or contact number).
+     * @param params.type - The type of contact information.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - Optional request options.
      * @returns A promise that resolves to a ServiceResponse containing the forget password response.
      */
-    forgetPassword(contact: string, type: 'email' | 'contact_number', requestOptions?: RequestOptions): Promise<ServiceResponse<ForgetPasswordResponse>>;
+    forgetPassword(params: {
+        contact: string;
+        type: 'email' | 'contact_number';
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ForgetPasswordResponse>>;
     /**
      * Resets the password for a user.
      *
-     * @param contact - The contact information for the user (email or contact number).
-     * @param refCode - The reference code for password reset.
-     * @param newPassword - The new password to set.
-     * @param otp - (Optional) The one-time password.
+     * @param params - The parameters.
+     * @param params.contact - The contact information for the user (email or contact number).
+     * @param params.refCode - The reference code for password reset.
+     * @param params.newPassword - The new password to set.
+     * @param params.otp - (Optional) The one-time password.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - (Optional) Additional options for the request.
      * @returns A promise that resolves to a ServiceResponse containing the status response.
      */
-    resetPassword(contact: string, refCode: string, newPassword: string, otp?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<StatusResponse>>;
+    resetPassword(params: {
+        contact: string;
+        refCode: string;
+        newPassword: string;
+        otp?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<StatusResponse>>;
     /**
-     * Send an OTP (One-Time Password) to the user for authentication.
+     * Sends an OTP (One-Time Password) to the user for authentication.
      *
-     * @param uuid - The unique device identifier.
-     * @param appId - Your application id.
-     * @param contactNumber - The contact number of the user.
-     * @param channel - (Optional) The channel through which the OTP should be sent.
+     * @param params - The parameters.
+     * @param params.uuid - The unique device identifier.
+     * @param params.appId - Your application id.
+     * @param params.contactNumber - The contact number for the user.
+     * @param params.channel - (Optional) The channel to use for OTP delivery.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - (Optional) Additional options for the request.
      * @returns A promise that resolves to a ServiceResponse containing the OTP response.
      */
-    getOtp(uuid: string, appId: string, contactNumber: string, channel?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<OtpResponse>>;
+    getOtp(params: {
+        uuid: string;
+        appId: string;
+        contactNumber: string;
+        channel?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<OtpResponse>>;
     /**
-     * Confirms the OTP (One-Time Password) for authentication.
+     * Confirm the OTP (One-Time Password) for authentication.
      *
-     * @param otp - The OTP to be confirmed.
-     * @param refCode - The reference code for the OTP.
-     * @param contactNumber - The contact number associated with the OTP.
-     * @param requestOptions - Optional request options.
-     * @returns A promise that resolves to a ServiceResponse containing the confirmation response.
+     * @param params - The parameters.
+     * @param params.otp - The OTP to confirm.
+     * @param params.refCode - The reference code for the OTP.
+     * @param params.contactNumber - The contact number for the user.
+     * @param params.options - (Optional) Additional params for the request.
+     * @param requestOptions - (Optional) Additional options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the confirm OTP response.
      */
-    confirmOtp(otp: string, refCode: string, contactNumber: string, requestOptions?: RequestOptions): Promise<ServiceResponse<ConfirmOtpResponse>>;
+    confirmOtp(params: {
+        otp: string;
+        refCode: string;
+        contactNumber: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ConfirmOtpResponse>>;
     /**
-     * Validates the OTP (One-Time Password) for a given app and contact number.
-     * @param appId - Your application id.
-     * @param otp - The OTP to validate.
-     * @param refCode - The reference code.
-     * @param contactNumber - The contact number.
-     * @param use - A boolean indicating whether the OTP should be used.
-     * @param channel - (Optional) The channel to use for OTP validation.
+     * Validate the OTP (One-Time Password) for authentication.
+     *
+     * @param params - The parameters.
+     * @param params.appId - Your application id.
+     * @param params.otp - The OTP to validate.
+     * @param params.refCode - The reference code for the OTP.
+     * @param params.contactNumber - The contact number for the user.
+     * @param params.use - Whether to use the OTP after validation.
+     * @param params.channel - (Optional) The channel to use for OTP delivery.
+     * @param params.options - (Optional) Additional params for the request.
      * @param requestOptions - (Optional) Additional options for the request.
-     * @returns A promise that resolves to a ServiceResponse containing the validation result.
+     * @returns A promise that resolves to a ServiceResponse containing the validate OTP response.
      */
-    validateOtp(appId: string, otp: string, refCode: string, contactNumber: string, use: boolean, channel?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<ValidateOtpResponse>>;
+    validateOtp(params: {
+        appId: string;
+        otp: string;
+        refCode: string;
+        contactNumber: string;
+        use: boolean;
+        channel?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ValidateOtpResponse>>;
     /**
      * Retrieve a new token and update the current device token.
      *
-     * @param uuid - The unique device identifier.
-     * @param appId - Your application id.
-     * @param clientVersion - The version of the client.
-     * @param deviceToken - The token of the device.
-     * @param requestOptions - The options for the request.
+     * @param params - The parameters.
+     * @param params.uuid - The unique device identifier.
+     * @param params.appId - Your application id.
+     * @param params.clientVersion - The version of the client.
+     * @param params.deviceToken - The token of the device.
+     * @param params.options - (Optional) Additional params for the request.
+     * @param requestOptions - (Optional) Additional options for the request.
      * @returns A promise that resolves to a ServiceResponse containing the resume response.
      */
-    resume(uuid: string, appId: string, clientVersion?: string, deviceToken?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<ResumeResponse>>;
+    resume(params: {
+        uuid: string;
+        appId: string;
+        clientVersion?: string;
+        deviceToken?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ResumeResponse>>;
     /**
      * Update the device token for push notification.
      *
-     * @param uuid - The unique device identifier.
-     * @param appId - Your application id.
-     * @param clientVersion - The version of the client.
-     * @param deviceToken - The token of the device.
-     * @param requestOptions - The options for the request.
+     * @param params - The parameters.
+     * @param params.uuid - The unique device identifier.
+     * @param params.appId - Your application id.
+     * @param params.clientVersion - The version of the client.
+     * @param params.deviceToken - The token of the device.
+     * @param params.options - (Optional) Additional params for the request.
+     * @param requestOptions - (Optional) Additional options for the request.
      * @returns A promise that resolves to a ServiceResponse containing the resume response.
      */
-    updateDevice(uuid: string, appId: string, clientVersion?: string, deviceToken?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<ResumeResponse>>;
+    updateDevice(params: {
+        uuid: string;
+        appId: string;
+        clientVersion?: string;
+        deviceToken?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ResumeResponse>>;
     /**
      * Retrieves the version information for the current app version.
      * @param clientVersion - The version of the client (App Prefix + Your application version , Ex. ios_buzzebeesdemo1.0.1).
@@ -975,9 +1113,18 @@ declare class AuthenticateApi extends BaseService {
 
 declare class BadgeApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
-    getBadge(params: {
+    /**
+     * Retrieves user badges.
+     *
+     * @param params - The parameters.
+     * @param params.badgeId - The ID of the badge to retrieve.
+     * @param params.options - (Optional) Additional params for the request.
+     * @param requestOptions - (Optional) Additional options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing an array of Badge objects.
+     */
+    getBadges(params: {
         badgeId?: string;
-        option?: {
+        options?: {
             [key: string]: any;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Badge[]>>;
@@ -985,6 +1132,30 @@ declare class BadgeApi extends BaseService {
 
 declare class CampaignApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves a list of campaigns based on the provided parameters.
+     *
+     * @param params - The parameters for the campaign list.
+     * @param params.config - The configuration for the campaign (list name).
+     * @param params.cat - The category for the campaign.
+     * @param params.byConfig - A boolean indicating whether to filter by configuration.
+     * @param params.skip - The number of campaigns to skip.
+     * @param params.top - The number of campaigns to retrieve.
+     * @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.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.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.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.
+     */
     campaign(params: {
         config: string;
         cat?: string;
@@ -1002,53 +1173,176 @@ declare class CampaignApi extends BaseService {
         center?: string;
         hashTags?: string;
         locationAgencyId?: string;
-        option?: {
+        options?: {
             [key: string]: any;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Campaign[]>>;
+    /**
+     * Retrieves a list of user's favorite campaigns.
+     *
+     * @param params - The parameters.
+     * @param params.skip - The number of campaigns to skip.
+     * @param params.top - The number of campaigns to retrieve.
+     * @param params.locale - The locale for the campaigns.
+     * @param params.options - (Optional) Additional params for the request.
+     * @param requestOptions - The options for the API request.
+     * @returns A promise that resolves to a ServiceResponse containing an array of Campaign objects.
+     */
     favoriteCampaigns(params: {
         skip?: number;
         top?: number;
         locale?: number;
-        option?: {
+        options?: {
             [key: string]: any;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Campaign[]>>;
+    /**
+     * Retrieves the details of a campaign.
+     *
+     * @param param - The parameters.
+     * @param param.id - The ID of the campaign.
+     * @param param.deviceLocale - The device locale (optional).
+     * @param param.options - Additional options for the request (optional).
+     * @param requestOptions - The options for the request (optional).
+     * @returns A promise that resolves to a service response containing the campaign details.
+     */
     campaignDetails(param: {
         id: string;
         deviceLocale?: number;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<CampaignDetail>>;
+    /**
+     * Adds a campaign to the user's favorites.
+     * @param id - The ID of the campaign to add to favorites.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the FavoriteResponse.
+     */
     addToFavorite(id: string, requestOptions?: RequestOptions): Promise<ServiceResponse<FavoriteResponse>>;
+    /**
+     * Removes a campaign from user's favorites.
+     * @param id - The ID of the campaign to remove from favorites.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the FavoriteResponse.
+     */
     removeFromFavorite(id: string, requestOptions?: RequestOptions): Promise<ServiceResponse<FavoriteResponse>>;
+    /**
+     * Redeems a campaign.
+     *
+     * @param params - The parameters for redeeming the campaign.
+     * @param params.id - The ID of the campaign to redeem.
+     * @param params.addressKey - The address key of a user's address.
+     * @param params.contactNumber - The contact number of the user.
+     * @param params.options - Additional options for the redemption.
+     * @param requestOptions - The options for the HTTP request.
+     * @returns A promise that resolves to a service response containing the redeem response.
+     */
     redeem(params: {
         id: string;
         addressKey?: string;
         contactNumber?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<RedeemResponse>>;
+    /**
+     * Redeems a campaign in bulk.
+     *
+     * @param params - The parameters.
+     * @param params.id - The ID of the campaign to redeem.
+     * @param params.quantity - The quantity to redeem.
+     * @param params.options - Additional options for the redemption.
+     * @param requestOptions - The options for the HTTP request.
+     * @returns A promise that resolves to a service response containing the redeem response.
+     */
+    bulkRedeem(params: {
+        id: string;
+        quantity: number;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<RedeemResponse>>;
-    bulkRedeem(id: string, quantity: number, requestOptions?: RequestOptions): Promise<ServiceResponse<RedeemResponse>>;
 }
 
 declare class CartApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Adds an item to the cart.
+     *
+     * @param params - The parameters.
+     * @param params.id - The ID of the item to add to the cart.
+     * @param params.mode - The mode off adding.
+     * @param params.qty - The quantity of the item.
+     * @param params.sideCampaignJson - The side campaign JSON.
+     * @param params.options - Additional options for adding the item to the cart.
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the cart count response.
+     */
     addCart(params: {
         id: string;
         mode?: string;
         qty?: number;
         sideCampaignJson?: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<CartCountResponse>>;
+    /**
+     * Retrieves the count of items in the cart.
+     *
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the CartCountResponse.
+     */
     cartCount(requestOptions?: RequestOptions): Promise<ServiceResponse<CartCountResponse>>;
 }
 
 declare class CategoryApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves the campaign categories.
+     *
+     * @param params - The parameters.
+     * @param params.config - The configuration string.
+     * @param params.byConfig - Optional. Specifies whether to retrieve categories by configuration.
+     * @param params.options - Optional. Additional options for retrieving the categories.
+     * @param requestOptions - Optional. The request options.
+     * @returns A promise that resolves to a service response containing an array of categories.
+     */
     categories(params: {
-        byConfig: boolean;
         config: string;
+        byConfig?: boolean;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Category[]>>;
 }
 
 declare class ConsentApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves the user's consent information.
+     *
+     * @param params - The parameters for the consent request.
+     * @param params.termsAndConditions - The terms and conditions consent version.
+     * @param params.dataPrivacy - The data privacy consent version.
+     * @param params.marketingOption - The marketing option consent version.
+     * @param params.email - The email consent (0 for false, 1 for true).
+     * @param params.sms - The SMS consent (0 for false, 1 for true).
+     * @param params.notification - The notification consent (0 for false, 1 for true).
+     * @param params.line - The LINE consent (0 for false, 1 for true).
+     * @param params.analyticsBuzzebeesCookies - The analytics Buzzebees cookies consent (0 for false, 1 for true).
+     * @param params.analyticsFirebaseCookies - The analytics Firebase cookies consent (0 for false, 1 for true).
+     * @param params.analyticsGoogleCookies - The analytics Google cookies consent (0 for false, 1 for true).
+     * @param params.analyticsMetaCookies - The analytics Meta cookies consent (0 for false, 1 for true).
+     * @param params.analyticsOtherCookies - The analytics other cookies consent (0 for false, 1 for true).
+     * @param params.functionalCookies - The functional cookies consent (0 for false, 1 for true).
+     * @param params.marketingCookies - The marketing cookies consent (0 for false, 1 for true).
+     * @param params.necessaryCookies - The necessary cookies consent (0 for false, 1 for true).
+     * @param params.options - Additional params.
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the consent information.
+     */
     getConsent(params: {
         termsAndConditions?: string;
         dataPrivacy?: string;
@@ -1065,28 +1359,93 @@ declare class ConsentApi extends BaseService {
         functionalCookies?: string;
         marketingCookies?: string;
         necessaryCookies?: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Consent>>;
+    /**
+     * Unconsents the user.
+     *
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the unconsent operation.
+     */
     unconsent(requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
 }
 
 declare class CouponApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Processes coupon codes.
+     *
+     * @param params - The parameters.
+     * @param params.codes - The coupon codes to process.
+     * @param params.options - Additional options for processing coupon codes.
+     * @param requestOptions - The options for making the API request.
+     * @returns A promise that resolves to a service response containing the coupon response.
+     */
     processCodes(params: {
         codes: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<CouponResponse>>;
 }
 
 declare class DashboardApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
-    mainDashboard(appName: string, locale: number, requestOptions?: RequestOptions): Promise<ServiceResponse<Dashboard[]>>;
+    /**
+     * Retrieves the main dashboard data.
+     *
+     * @param params - The parameters.
+     * @param params.appName - The name of the application.
+     * @param params.locale - The locale number.
+     * @param params.options - Additional options for the request.
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a service response containing an array of Dashboard objects.
+     */
+    mainDashboard(params: {
+        appName: string;
+        locale: number;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<Dashboard[]>>;
+    /**
+     * Retrieves a sub-dashboard data.
+     *
+     * @param params - The parameters.
+     * @param params.dashboardName - The name of the sub-dashboard to retrieve.
+     * @param params.locale - The locale of the sub-dashboard.
+     * @param params.options - Additional options for retrieving the sub-dashboard.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a service response containing an array of dashboards.
+     */
     subDashboard(params: {
         dashboardName: string;
         locale: number;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Dashboard[]>>;
 }
 
 declare class HistoryApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves the redeem histories based on the specified parameters.
+     *
+     * @param params - The parameters for retrieving redeem histories.
+     * @param params.byConfig - Indicates whether to retrieve redeem histories by config.
+     * @param params.config - The config for retrieving redeem histories.
+     * @param params.skip - The number of records to skip.
+     * @param params.top - The number of records to retrieve.
+     * @param params.locale - The locale for retrieving redeem histories (optional).
+     * @param params.startDate - The start date for retrieving redeem histories (optional).
+     * @param params.endDate - The end date for retrieving redeem histories (optional).
+     * @param params.options - Additional options for retrieving redeem histories (optional).
+     * @param requestOptions - The options for the request (optional).
+     * @returns A promise that resolves to a service response containing an array of purchase objects.
+     */
     redeemHistories(params: {
         byConfig: boolean;
         config: string;
@@ -1095,36 +1454,109 @@ declare class HistoryApi extends BaseService {
         locale?: number;
         startDate?: string;
         endDate?: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Purchase[]>>;
+    /**
+     * Marks the specified redeem key as used.
+     *
+     * @param params - The parameters.
+     * @param params.redeemKey - The redeem key for the campaign.
+     * @param params.options - Additional options for using the campaign.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a service response containing the result of the redemption.
+     */
     use(params: {
         redeemKey: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<UseCampaignResponse>>;
 }
 
 declare class LineApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Authenticates with the LINE API.
+     *
+     * @param params - The authentication parameters.
+     * @param params.grantType - The grant type.
+     * @param params.code - The code.
+     * @param params.clientId - The client ID.
+     * @param params.clientSecret - The client secret.
+     * @param params.redirectUrl - The redirect URL.
+     * @param params.options - Additional options for the request.
+     * @param requestOptions - The optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the LineAuthResponse.
+     */
     lineAuth(params: {
         grantType: string;
         code: string;
         clientId: string;
         clientSecret: string;
         redirectUrl: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<LineAuthResponse>>;
 }
 
 declare class NotificationApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves notifications.
+     *
+     * @param params - The parameters for retrieving notifications.
+     * @param params.mode - The mode for retrieving notifications (new or all)
+     * @param params.sortBy - The sort order for the notifications (createdate_desc or createdate_asc)
+     * @param requestOptions - The options for the HTTP request.
+     * @returns A promise that resolves to a service response containing an array of notifications.
+     */
     notifications(params: {
-        mode: string;
-        sortBy: string;
+        mode: string | 'new' | 'all';
+        sortBy: string | 'createdate_desc' | 'createdate_asc';
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Notification[]>>;
+    /**
+     * Marks notifications as read.
+     *
+     * @param params - The parameters for marking notifications as read.
+     * @param params.ids - The IDs(RowKeys) of the notifications to mark as read. (RowKey1, RowKey2)
+     * @param params.options - Additional options for marking notifications as read.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a service response containing the result of marking notifications as read.
+     */
     read(params: {
         ids: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
 }
 
 declare class PlaceApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves a list of places based on the provided parameters.
+     *
+     * @param params - The parameters for the place list request.
+     * @param params.agencyId - The ID of the agency.
+     * @param params.center - The center of the search area.
+     * @param params.distance - The distance from the center.
+     * @param params.top - The number of places to retrieve.
+     * @param params.provinceCode - The province code (optional).
+     * @param params.category - The category of the place (optional).
+     * @param params.mode - The mode of the place (optional).
+     * @param params.requiredCampaign - Indicates whether the place requires a campaign (optional).
+     * @param params.keyword - The keyword to search for (optional).
+     * @param params.isFavourite - Indicates whether the place is a favourite (optional).
+     * @param params.options - Additional options for the request (optional).
+     * @param requestOptions - The options for the request (optional).
+     * @returns A promise that resolves to a ServiceResponse containing an array of Place objects.
+     */
     placeList(params: {
         agencyId: string;
         center: string;
@@ -1136,16 +1568,50 @@ declare class PlaceApi extends BaseService {
         requiredCampaign?: boolean;
         keyword?: string;
         isFavourite?: boolean;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Place[]>>;
+    /**
+     * Retrieves information about a specific place.
+     *
+     * @param params - The parameters for the place request.
+     * @param params.id - The ID of the place.
+     * @param params.agencyId - The ID of the agency.
+     * @param params.requiredCampaign - (Optional) Indicates if a campaign is required.
+     * @param params.isFavourite - (Optional) Indicates if the place is a favorite.
+     * @param params.options - (Optional) Additional options for the request.
+     * @param requestOptions - (Optional) Additional options for the HTTP request.
+     * @returns A promise that resolves to a ServiceResponse containing the place information.
+     */
     place(params: {
         id: string;
         agencyId: string;
         requiredCampaign?: boolean;
         isFavourite?: boolean;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<Place>>;
+    /**
+     * Adds a place to the user's favorites.
+     *
+     * @param params - The parameters.
+     * @param params.id - The ID of the place to be added to favorites.
+     * @param requestOptions - The optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the operation.
+     */
     addToFavourite(params: {
         id: string;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
+    /**
+     * Removes a place from the user's favorites.
+     *
+     * @param params - The parameters.
+     * @param params.id - The ID of the place to be removed from favorites.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the operation.
+     */
     removeFromFavourite(params: {
         id: string;
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
@@ -1153,15 +1619,38 @@ declare class PlaceApi extends BaseService {
 
 declare class PointLogApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
-    getPointLog(month: string, options?: {
+    /**
+     * Retrieves the point log.
+     *
+     * @param params - The parameters for retrieving the point log.
+     * @param params.month - The month for which to retrieve the point log.
+     * @param params.type - (Optional) The type of point log to retrieve. (earn/burn/etc)
+     * @param params.lastRowKey - (Optional) The last row key for pagination.
+     * @param params.top - (Optional) The maximum number of records to retrieve.
+     * @param params.options - (Optional) Additional options for the request.
+     * @param requestOption - (Optional) The request options.
+     * @returns A promise that resolves to a service response containing an array of point logs.
+     */
+    getPointLog(params: {
+        month: string;
         type?: string;
         lastRowKey?: string;
         top?: number;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOption?: RequestOptions): Promise<ServiceResponse<PointLog[]>>;
 }
 
 declare class ProfileApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Updates the user profile with the provided parameters.
+     *
+     * @param params - The parameters for updating the profile.
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the updated profile.
+     */
     updateProfile(params: {
         profileImage?: File;
         firstName?: string;
@@ -1211,8 +1700,34 @@ declare class ProfileApi extends BaseService {
         occupation?: string;
         remark?: string;
         displayName?: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<ProfileResponse>>;
-    changePassword(current: string, change: string, requestOptions?: RequestOptions): Promise<ServiceResponse<StatusResponse>>;
+    /**
+     * Changes the user's password.
+     *
+     * @param params - The parameters.
+     * @param params.current - The current password.
+     * @param params.change - The new password.
+     * @param params.options - Optional additional options.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the status response.
+     */
+    changePassword(params: {
+        current: string;
+        change: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<StatusResponse>>;
+    /**
+     * Updates the shipping information for the user.
+     *
+     * @param params - The parameters for updating the shipping information.
+     * @param requestOptions - The options for the HTTP request.
+     * @returns A promise that resolves to a ServiceResponse containing the updated shipping information.
+     */
     updateShipping(params: {
         shippingFirstName?: string;
         shippingLastName?: string;
@@ -1225,16 +1740,82 @@ declare class ProfileApi extends BaseService {
         shippingDistrictName?: string;
         shippingSubFDistrictName?: string;
         shippingContactNumber?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
+    /**
+     * Changes the contact number of the user.
+     *
+     * @param params - The parameters for changing the contact number.
+     * @param params.contactNumber - The new contact number.
+     * @param params.otp - The one-time password.
+     * @param params.refCode - The reference code.
+     * @param params.idCard - (Optional) The ID card for additional verification.
+     * @param params.options - (Optional) Additional options for the request.
+     * @param requestOptions - (Optional) The options for the request.
+     * @returns A promise that resolves to the response of the request.
+     */
+    changeContactNumber(params: {
+        contactNumber: string;
+        otp: string;
+        refCode: string;
+        idCard?: string;
+        options?: {
+            [key: string]: any;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<ConfirmOtpResponse>>;
+    /**
+     * Changes the contact number for the current user.
+     *
+     * @param params - The parameters for changing the contact number.
+     * @param params.contactNumber - The new contact number.
+     * @param params.otp - The one-time password for verification.
+     * @param params.refCode - The reference code for verification.
+     * @param params.options - Additional options for the request.
+     * @param requestOptions - The options for the request.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the request.
+     */
+    changeContactNumberV2(params: {
+        contactNumber: string;
+        otp: string;
+        refCode: string;
+        options?: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
-    changeContactNumber(contactNumber: string, otp: string, refCode: string, idCard?: string, requestOptions?: RequestOptions): Promise<ServiceResponse<unknown>>;
-    changeContactNumberV2(contactNumber: string, otp: string, refCode: string, requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
+    /**
+     * Retrieves the updated points for the current user's profile.
+     *
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the updated points.
+     */
     points(requestOptions?: RequestOptions): Promise<ServiceResponse<UpdatedPoints>>;
+    /**
+     * Retrieves the expiring points for the current user's profile.
+     *
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the expiring points.
+     */
     expiringPoints(requestOptions?: RequestOptions): Promise<ServiceResponse<ExpiringPoints>>;
+    /**
+     * Deactivates the user's profile.
+     *
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the result of the deactivation.
+     */
     deactivate(requestOptions?: RequestOptions): Promise<ServiceResponse<any>>;
 }
 
 declare class RegistrationApi extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Registers a user with the provided registration parameters.
+     *
+     * @param params - The registration parameters.
+     * @param requestOptions - The optional request options.
+     * @returns A promise that resolves to a service response containing the registration response.
+     */
     register(params: {
         appId: string;
         uuid: string;
@@ -1265,6 +1846,9 @@ declare class RegistrationApi extends BaseService {
         notificationMarketing?: string;
         lineMarketing?: string;
         phoneMarketing?: string;
+        options: {
+            [key: string]: any;
+        };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<RegistrationResponse>>;
 }