@bzbs/react-api-client 1.2.5 → 1.3.0

package/dist/index.d.mts

@@ -120,6 +120,10 @@ interface ForgetPasswordResponse {
     expireinseconds?: number;
 }
 
+interface AccessTokenResponse {
+    key?: string;
+}
+
 /**
  * Response model for Apple token authentication
  */
@@ -544,6 +548,12 @@ interface Dashboard {
     line2?: string;
     line3?: string;
     line4?: string;
+    line5?: string;
+    line6?: string;
+    line7?: string;
+    line8?: string;
+    line9?: string;
+    line10?: string;
     ga_label?: string;
     start_date?: number;
     end_date?: number;
@@ -873,6 +883,7 @@ interface Version {
     welcome_page_times?: number;
     termandcondition?: number;
     dataprivacy?: number;
+    marketingoption?: number;
 }
 
 interface ResumeResponse {
@@ -1400,6 +1411,120 @@ declare class AuthenticateApi extends BaseService {
             [key: string]: unknown;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    /**
+     * Connect with LINE. If authorization token is provided, it will connect current user with given LINE credentials.
+     * Otherwise, it tries to login with those credentials.
+     *
+     * @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.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a ServiceResponse containing the login response.
+     */
+    connectLine(params: {
+        idToken: string;
+        lineAccessToken: string;
+        authorizationCode: string;
+        appId: string;
+        uuid: string;
+        deviceLocale: string;
+        os: string;
+        platform: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
+        macAddress: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    /**
+     * Connect with Facebook. If authorization token is provided, it will connect current user with given Facebook access token.
+     * Otherwise, it tries to login with that access token.
+     *
+     * @param params - The parameters.
+     * @param params.accessToken - The Facebook access 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.
+     */
+    connectFacebook(params: {
+        accessToken: string;
+        appId: string;
+        uuid: string;
+        deviceLocale: string;
+        os: string;
+        platform: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
+        macAddress: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    /**
+     * Connect with Google. If authorization token is provided, it will connect current user with given Google id token.
+     * Otherwise, it tries to login with that id token.
+     *
+     * @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.
+     */
+    connectGoogle(params: {
+        idToken: string;
+        appId: string;
+        uuid: string;
+        deviceLocale: string;
+        os: string;
+        platform: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
+        macAddress: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
+    /**
+     * Connect with Apple. If authorization token is provided, it will connect current user with given Apple credentials.
+     * Otherwise, it tries to login with those credentials.
+     *
+     * @param params - The parameters.
+     * @param params.idToken - The Apple id token.
+     * @param params.refreshToken - The Apple refresh token from appleToken().
+     * @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.
+     */
+    connectApple(params: {
+        idToken: string;
+        refreshToken: string;
+        appId: string;
+        uuid: string;
+        deviceLocale: string;
+        os: string;
+        platform: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
+        macAddress: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<LoginResponse>>;
     /**
      * Performs a logout for the user.
      *
@@ -1454,7 +1579,7 @@ declare class AuthenticateApi extends BaseService {
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<StatusResponse>>;
     /**
-     * Sends an OTP (One-Time Password) to the user for authentication.
+     * Sends an OTP (One-Time Password) to the user for authentication (GET method).
      *
      * @param params - The parameters.
      * @param params.uuid - The unique device identifier.
@@ -1474,6 +1599,46 @@ declare class AuthenticateApi extends BaseService {
             [key: string]: unknown;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<OtpResponse>>;
+    /**
+     * Sends an OTP (One-Time Password) to the user for authentication (POST method, V2).
+     *
+     * @param params - The parameters.
+     * @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.
+     */
+    otpV2(params: {
+        appId: string;
+        contactNumber: string;
+        channel?: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<OtpResponse>>;
+    /**
+     * Sends an OTP (One-Time Password) via email to the user for authentication.
+     *
+     * @param params - The parameters.
+     * @param params.uuid - The unique device identifier.
+     * @param params.appId - Your application id.
+     * @param params.email - The email address 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.
+     */
+    otpEmail(params: {
+        uuid: string;
+        appId: string;
+        email: string;
+        channel?: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<OtpResponse>>;
     /**
      * Confirm the OTP (One-Time Password) for authentication.
      *
@@ -1500,8 +1665,10 @@ declare class AuthenticateApi extends BaseService {
      * @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.type - Type of contact (email or contact_number).
+     * @param params.contactNumber - (Optional) The contact number for the user.
+     * @param params.email - (Optional) The email address for the user.
+     * @param params.use - Whether to use the OTP after validation (default: false).
      * @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.
@@ -1511,53 +1678,69 @@ declare class AuthenticateApi extends BaseService {
         appId: string;
         otp: string;
         refCode: string;
-        contactNumber: string;
-        use: boolean;
+        type: string;
+        contactNumber?: string;
+        email?: string;
+        use?: boolean;
         channel?: string;
         options?: {
             [key: string]: unknown;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<ValidateOtpResponse>>;
     /**
-     * Retrieve a new token and update the current device token.
+     * Refresh buzzebees token and retrieve a new token.
      *
      * @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.deviceAppId - Your application id.
+     * @param params.os - Your device operation system + version. Ex. ios 11.2.1, android 9.0
+     * @param params.platform - Your platform. Ex. iPhone, Android
+     * @param params.macAddress - Unique device identifier
+     * @param params.deviceNotificationEnabled - Enable push notification
+     * @param params.clientVersion - Number of version (App Prefix + Your application version, Ex. ios_buzzebeesdemo1.0.1)
+     * @param params.deviceToken - Device token used for send push notification
      * @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(params: {
         uuid: string;
-        appId: string;
-        clientVersion?: string;
-        deviceToken?: string;
-        macAddress?: string;
+        deviceAppId: string;
+        os: string;
+        platform: string;
+        macAddress: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
         options?: {
             [key: string]: unknown;
         };
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<ResumeResponse>>;
     /**
-     * Update the device token for push notification.
+     * Update device token for push notification.
      *
      * @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.deviceAppId - Your application id.
+     * @param params.os - Your device operation system + version. Ex. ios 11.2.1, android 9.0
+     * @param params.platform - Your platform. Ex. iPhone, Android
+     * @param params.macAddress - Unique device identifier
+     * @param params.deviceNotificationEnabled - Enable push notification
+     * @param params.clientVersion - Number of version (App Prefix + Your application version, Ex. ios_buzzebeesdemo1.0.1)
+     * @param params.deviceToken - Device token used for send push notification
      * @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(params: {
         uuid: string;
-        appId: string;
-        clientVersion?: string;
-        deviceToken?: string;
-        macAddress?: string;
+        deviceAppId: string;
+        os: string;
+        platform: string;
+        macAddress: string;
+        deviceNotificationEnabled: boolean;
+        clientVersion: string;
+        deviceToken: string;
         options?: {
             [key: string]: unknown;
         };
@@ -2790,6 +2973,31 @@ declare class RequestHelpApi extends BaseService {
     }, requestOptions?: RequestOptions): Promise<ServiceResponse<LikeForumResponse>>;
 }
 
+declare class SettingApi extends BaseService {
+    constructor(client: AxiosInstance, baseUrl: string);
+    /**
+     * Get access key for web landing.
+     *
+     * @param params - The parameters.
+     * @param params.data - JSON string of data. Available data:
+     *   - "app_id" (Required, string): App Id
+     *   - "campaign_id" (Required, int): Campaign ID
+     *   - "locale" (Required, int): User Locale
+     *   - "return_url" (Required, string): URL to redirect back to App
+     *   - "version" (Required, string): Version of landing interface
+     *   - "redeem_key" (Optional, string): Required for case history - Redeem Key from history API (CampaignID_ItemNumber)
+     * @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 access token response.
+     */
+    accessKey(params: {
+        data: string;
+        options?: {
+            [key: string]: unknown;
+        };
+    }, requestOptions?: RequestOptions): Promise<ServiceResponse<AccessTokenResponse>>;
+}
+
 declare class Blob extends BaseService {
     constructor(client: AxiosInstance, baseUrl: string);
     consentVersion(appId: string): Promise<ServiceResponse<ConsentVersion>>;
@@ -2820,8 +3028,9 @@ declare class BzbsService {
     addressApi: AddressApi;
     stampApi: StampApi;
     forumApi: RequestHelpApi;
+    settingApi: SettingApi;
     blob: Blob;
     constructor(client: AxiosInstance, baseUrl: string, baseLineUrl: string | "", baseBlobUrl: string);
 }
 
-export { type Address, AddressApi, type ApiResponse, type AppleToken, AuthenticateApi, type Badge, BadgeApi, BaseService, Blob, type Buzzebees, type BzbsErrorResponse, BzbsService, type Campaign, CampaignApi, type CampaignDetail, type CartAccessResponse, CartApi, type CartCountResponse, type Category, CategoryApi, type ChatMessage, type ClientError, type ConfirmOtpResponse, type Consent, ConsentApi, type ConsentVersion, type ConsentVersionValue, CouponApi, type CouponResponse, type CouponResponseData, type CreateStampResponse, type Dashboard, DashboardApi, type Detail, type District, type ErrorResponse, type ExpiringPoints, type FavoriteResponse, type ForgetPasswordResponse, HistoryApi, type LikeForumResponse, LineApi, type LineAuthResponse, type LoginResponse, type Maintenance, type Mission, type Notification, NotificationApi, type OtpResponse, type Picture, type Place, PlaceApi, type PlaceService, type PointLog, PointLogApi, type PointUnit, ProfileApi, type ProfileResponse, type Province, type Purchase, type RedeemResponse, RegistrationApi, type RegistrationResponse, RequestHelpApi, type RequestHelpCode, type RequestOptions, type ResumeResponse, type ServerError, type ServiceResponse, type Stamp, StampApi, type StampCampaign, type StampHistory, type StampProfileResponse, type StatusResponse, type Style, type SubCampaign, type SubCampaignStyle, type SubDistrict, type SuccessResponse, type Trace, type UpdatedPoints, type UseCampaignResponse, type ValidateOtpResponse, type Version, type ZipCode };
+export { type AccessTokenResponse, type Address, AddressApi, type ApiResponse, type AppleToken, AuthenticateApi, type Badge, BadgeApi, BaseService, Blob, type Buzzebees, type BzbsErrorResponse, BzbsService, type Campaign, CampaignApi, type CampaignDetail, type CartAccessResponse, CartApi, type CartCountResponse, type Category, CategoryApi, type ChatMessage, type ClientError, type ConfirmOtpResponse, type Consent, ConsentApi, type ConsentVersion, type ConsentVersionValue, CouponApi, type CouponResponse, type CouponResponseData, type CreateStampResponse, type Dashboard, DashboardApi, type Detail, type District, type ErrorResponse, type ExpiringPoints, type FavoriteResponse, type ForgetPasswordResponse, HistoryApi, type LikeForumResponse, LineApi, type LineAuthResponse, type LoginResponse, type Maintenance, type Mission, type Notification, NotificationApi, type OtpResponse, type Picture, type Place, PlaceApi, type PlaceService, type PointLog, PointLogApi, type PointUnit, ProfileApi, type ProfileResponse, type Province, type Purchase, type RedeemResponse, RegistrationApi, type RegistrationResponse, RequestHelpApi, type RequestHelpCode, type RequestOptions, type ResumeResponse, type ServerError, type ServiceResponse, SettingApi, type Stamp, StampApi, type StampCampaign, type StampHistory, type StampProfileResponse, type StatusResponse, type Style, type SubCampaign, type SubCampaignStyle, type SubDistrict, type SuccessResponse, type Trace, type UpdatedPoints, type UseCampaignResponse, type ValidateOtpResponse, type Version, type ZipCode };