{"_id":"@aigens2/aigens-sdk-bksg-analytics","_rev":"4-4a357f2e50703bcdc47055764434edbd","name":"@aigens2/aigens-sdk-bksg-analytics","dist-tags":{"latest":"5.1.0"},"versions":{"5.0.0":{"name":"@aigens2/aigens-sdk-bksg-analytics","version":"5.0.0","keywords":["capacitor","plugin","native"],"author":"","license":"MIT","_id":"@aigens2/aigens-sdk-bksg-analytics@5.0.0","maintainers":[{"name":"jason_jj","email":"peijuechen@126.com"}],"homepage":"https://github.com/aigens/aigens-sdk-core#readme","bugs":{"url":"https://github.com/aigens/aigens-sdk-core/issues"},"dist":{"shasum":"8298b2137d0020799399becb214680313cc12017","tarball":"https://registry.npmjs.org/@aigens2/aigens-sdk-bksg-analytics/-/aigens-sdk-bksg-analytics-5.0.0.tgz","fileCount":27,"integrity":"sha512-CkDGwIUkzXk8e1euqMhiHFI89cXKG9Tz6OgkD1SNvpAlOdFF1pI/KL+1f+G1AmNpZVDYk5ClvzmvsIxruCGzhg==","signatures":[{"sig":"MEUCIDN8jCAOF7mTMK/n3KRtUgPo27igBA2R3ATtzuJSLX27AiEAkAJfKYjHY7wNbIZWGTbGU+zFMDautC9muQkJmk9zJ0E=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":115409},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"9719a8c4cee026bc63d0a7d261e66c23beb49cb8","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BksgAnalyticsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"jason_jj","email":"peijuechen@126.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/aigens/aigens-sdk-core.git","type":"git"},"_npmVersion":"11.12.1","description":"Aigens SDK BKSG Analytics","directories":{},"_nodeVersion":"24.15.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.31.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.2.0","swiftlint":"^1.0.1","typescript":"~4.8","@capacitor/ios":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.2.0","@capacitor/android":"^5.0.0","@ionic/eslint-config":"^0.3.0","prettier-plugin-java":"~1.0.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/aigens-sdk-bksg-analytics_5.0.0_1782205497076_0.16008031666152367","host":"s3://npm-registry-packages-npm-production"}},"5.0.1":{"name":"@aigens2/aigens-sdk-bksg-analytics","version":"5.0.1","keywords":["capacitor","plugin","native"],"author":"","license":"MIT","_id":"@aigens2/aigens-sdk-bksg-analytics@5.0.1","maintainers":[{"name":"jason_jj","email":"peijuechen@126.com"}],"homepage":"https://github.com/aigens/aigens-sdk-core#readme","bugs":{"url":"https://github.com/aigens/aigens-sdk-core/issues"},"dist":{"shasum":"e1c528af8f32eeed0b71429eb49a6b9474bb58d6","tarball":"https://registry.npmjs.org/@aigens2/aigens-sdk-bksg-analytics/-/aigens-sdk-bksg-analytics-5.0.1.tgz","fileCount":27,"integrity":"sha512-poZM8cetELLh8HWI1+PHvjOstcRl4Aday9+K+Z1c3Jx07kkwHFXAXilRrELdoBYwWEhF/AFWoeeA0qWghoj/aQ==","signatures":[{"sig":"MEUCICfxaSTLrt29XE8DfB7feUGqgjGxNpzqYRMjf9UQ2BbCAiEA0o5c1rMPMhlqRENVr3jZ5Be06YuzkiAagHo1PaI2qB0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":115411},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"566ac515848820db76d0a21305aeac194b040f31","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BksgAnalyticsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"jason_jj","email":"peijuechen@126.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/aigens/aigens-sdk-core.git","type":"git"},"_npmVersion":"11.12.1","description":"Aigens SDK BKSG Analytics","directories":{},"_nodeVersion":"24.15.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.31.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.2.0","swiftlint":"^1.0.1","typescript":"~4.8","@capacitor/ios":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.2.0","@capacitor/android":"^5.0.0","@ionic/eslint-config":"^0.3.0","prettier-plugin-java":"~1.0.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/aigens-sdk-bksg-analytics_5.0.1_1782379872170_0.9420405586031186","host":"s3://npm-registry-packages-npm-production"}},"5.0.2":{"name":"@aigens2/aigens-sdk-bksg-analytics","version":"5.0.2","keywords":["capacitor","plugin","native"],"author":"","license":"MIT","_id":"@aigens2/aigens-sdk-bksg-analytics@5.0.2","maintainers":[{"name":"jason_jj","email":"peijuechen@126.com"}],"homepage":"https://github.com/aigens/aigens-sdk-core#readme","bugs":{"url":"https://github.com/aigens/aigens-sdk-core/issues"},"dist":{"shasum":"e4a494bddbc51ecc9264e3acb1391425b933810e","tarball":"https://registry.npmjs.org/@aigens2/aigens-sdk-bksg-analytics/-/aigens-sdk-bksg-analytics-5.0.2.tgz","fileCount":27,"integrity":"sha512-aEUfGxdPp8G4umMkHabZAJd1e6cN/GVP9ZvJ1x919caEe/n9SEdcXM2j7E3YUQKXYFpaBX4Bx27+JVFJfEM6IA==","signatures":[{"sig":"MEQCID2vzFHcDixhxg6eYCDztI3NrVdEKezb2mSIeASb99gpAiB2YZhUCP5Y9fY0nDdoKvQxnV9Xq0xA5wZb5T5+PMTFgg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":115207},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"869c025d2157b6cc2696f3865f59a1c3e129c7dd","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BksgAnalyticsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"jason_jj","email":"peijuechen@126.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/aigens/aigens-sdk-core.git","type":"git"},"_npmVersion":"11.12.1","description":"Aigens SDK BKSG Analytics","directories":{},"_nodeVersion":"24.15.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.31.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.2.0","swiftlint":"^1.0.1","typescript":"~4.8","@capacitor/ios":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.2.0","@capacitor/android":"^5.0.0","@ionic/eslint-config":"^0.3.0","prettier-plugin-java":"~1.0.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/aigens-sdk-bksg-analytics_5.0.2_1782457420689_0.7280632646922289","host":"s3://npm-registry-packages-npm-production"}},"5.1.0":{"name":"@aigens2/aigens-sdk-bksg-analytics","version":"5.1.0","description":"Aigens SDK BKSG Analytics","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":"","license":"MIT","repository":{"type":"git","url":"git+https://github.com/aigens/aigens-sdk-core.git"},"bugs":{"url":"https://github.com/aigens/aigens-sdk-core/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api BksgAnalyticsPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.2.0","@capacitor/ios":"^5.0.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2","eslint":"^8.31.0","prettier":"~2.2.0","prettier-plugin-java":"~1.0.0","rimraf":"^3.0.2","rollup":"^2.32.0","swiftlint":"^1.0.1","typescript":"~4.8"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"fe3bfc38faea4fc9e9e994dad17579cc7bee2d93","_id":"@aigens2/aigens-sdk-bksg-analytics@5.1.0","homepage":"https://github.com/aigens/aigens-sdk-core#readme","_nodeVersion":"24.15.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-cXaiG5Smd8I3I0vEKQwyZVzXaSoz0skZWwTNqfBIlFMuMBmeS4pru/ePuhZNoGI+6+MOPH+IAunSVWTu+oCjPA==","shasum":"ebe81ed3f205981971e85d12f5681d97b14db05a","tarball":"https://registry.npmjs.org/@aigens2/aigens-sdk-bksg-analytics/-/aigens-sdk-bksg-analytics-5.1.0.tgz","fileCount":27,"unpackedSize":119150,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHfNVC+buxEVW0Wk7cT+eEHOkVwB53xkWi9Y759ktocMAiAMVcElMKdgKU6n6LalDSiEqK2B5WTq5uM2tgrg/4hiLQ=="}]},"_npmUser":{"name":"jason_jj","email":"peijuechen@126.com"},"directories":{},"maintainers":[{"name":"jason_jj","email":"peijuechen@126.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/aigens-sdk-bksg-analytics_5.1.0_1787804783933_0.6362324279566798"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-23T09:04:56.897Z","modified":"2026-08-27T04:26:24.223Z","5.0.0":"2026-06-23T09:04:57.201Z","5.0.1":"2026-06-25T09:31:12.315Z","5.0.2":"2026-06-26T07:03:40.856Z","5.1.0":"2026-08-27T04:26:24.074Z"},"bugs":{"url":"https://github.com/aigens/aigens-sdk-core/issues"},"license":"MIT","homepage":"https://github.com/aigens/aigens-sdk-core#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/aigens/aigens-sdk-core.git"},"description":"Aigens SDK BKSG Analytics","maintainers":[{"name":"jason_jj","email":"peijuechen@126.com"}],"readme":"# aigens-sdk-bksg-analytics\n\nAigens SDK BKSG Analytics\n\n## Install\n\n```bash\nnpm install @aigens2/aigens-sdk-bksg-analytics\nnpx cap sync\n```\n\n## API\n\n<docgen-index>\n\n* [`setUserProperties(...)`](#setuserproperties)\n* [`logScreenView(...)`](#logscreenview)\n* [`logDeepLinkOpen(...)`](#logdeeplinkopen)\n* [`logNotificationOpen(...)`](#lognotificationopen)\n* [`logNotificationReceived(...)`](#lognotificationreceived)\n* [`logSignUp(...)`](#logsignup)\n* [`logLogin(...)`](#loglogin)\n* [`logLogout()`](#loglogout)\n* [`logSelectStore(...)`](#logselectstore)\n* [`logSelectOrderType(...)`](#logselectordertype)\n* [`logSelectPickupTime(...)`](#logselectpickuptime)\n* [`logViewItemList(...)`](#logviewitemlist)\n* [`logSelectItem(...)`](#logselectitem)\n* [`logViewItem(...)`](#logviewitem)\n* [`logAddToCart(...)`](#logaddtocart)\n* [`logRemoveFromCart(...)`](#logremovefromcart)\n* [`logViewCart(...)`](#logviewcart)\n* [`logBeginCheckout(...)`](#logbegincheckout)\n* [`logAddPaymentInfo(...)`](#logaddpaymentinfo)\n* [`logPurchase(...)`](#logpurchase)\n* [`logViewPromotion(...)`](#logviewpromotion)\n* [`logSelectPromotion(...)`](#logselectpromotion)\n* [`logPromotionApply(...)`](#logpromotionapply)\n* [`logPromotionRemove(...)`](#logpromotionremove)\n* [`logReorder(...)`](#logreorder)\n* [`logOrderHistoryView()`](#logorderhistoryview)\n* [`logCheckoutError(...)`](#logcheckouterror)\n* [`logItemOutOfStock(...)`](#logitemoutofstock)\n* [`logStoreUnavailable(...)`](#logstoreunavailable)\n* [`requestTrackingAuthorization()`](#requesttrackingauthorization)\n* [`addListener('conversionDataSuccess', ...)`](#addlistenerconversiondatasuccess-)\n* [`addListener('conversionDataFail', ...)`](#addlistenerconversiondatafail-)\n* [`addListener('appOpenAttribution', ...)`](#addlistenerappopenattribution-)\n* [`addListener('appOpenAttributionFail', ...)`](#addlistenerappopenattributionfail-)\n* [`addListener('deepLinkResolved', ...)`](#addlistenerdeeplinkresolved-)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### setUserProperties(...)\n\n```typescript\nsetUserProperties(options: { memberStatus: MemberStatus; userId?: string; userIdHash?: string; pushEnabled?: boolean; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                  |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ memberStatus: <a href=\"#memberstatus\">MemberStatus</a>; userId?: string; userIdHash?: string; pushEnabled?: boolean; }</code> |\n\n--------------------\n\n\n### logScreenView(...)\n\n```typescript\nlogScreenView(options: { screenName: string; screenClass: string; }) => Promise<void>\n```\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | <code>{ screenName: string; screenClass: string; }</code> |\n\n--------------------\n\n\n### logDeepLinkOpen(...)\n\n```typescript\nlogDeepLinkOpen(options: { deepLinkUrl: string; destinationScreen: string; deepLinkType: string; }) => Promise<void>\n```\n\n| Param         | Type                                                                                   |\n| ------------- | -------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ deepLinkUrl: string; destinationScreen: string; deepLinkType: string; }</code> |\n\n--------------------\n\n\n### logNotificationOpen(...)\n\n```typescript\nlogNotificationOpen(options: { notificationId: string; notificationType: string; destinationScreen: string; }) => Promise<void>\n```\n\n| Param         | Type                                                                                          |\n| ------------- | --------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ notificationId: string; notificationType: string; destinationScreen: string; }</code> |\n\n--------------------\n\n\n### logNotificationReceived(...)\n\n```typescript\nlogNotificationReceived(options: { notificationId: string; notificationType: string; }) => Promise<void>\n```\n\n| Param         | Type                                                               |\n| ------------- | ------------------------------------------------------------------ |\n| **`options`** | <code>{ notificationId: string; notificationType: string; }</code> |\n\n--------------------\n\n\n### logSignUp(...)\n\n```typescript\nlogSignUp(options: { method: string; }) => Promise<void>\n```\n\n| Param         | Type                             |\n| ------------- | -------------------------------- |\n| **`options`** | <code>{ method: string; }</code> |\n\n--------------------\n\n\n### logLogin(...)\n\n```typescript\nlogLogin(options: { method: string; }) => Promise<void>\n```\n\n| Param         | Type                             |\n| ------------- | -------------------------------- |\n| **`options`** | <code>{ method: string; }</code> |\n\n--------------------\n\n\n### logLogout()\n\n```typescript\nlogLogout() => Promise<void>\n```\n\n--------------------\n\n\n### logSelectStore(...)\n\n```typescript\nlogSelectStore(options: { storeId: string; storeName: string; orderType: OrderType; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                |\n| ------------- | --------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ storeId: string; storeName: string; orderType: <a href=\"#ordertype\">OrderType</a>; }</code> |\n\n--------------------\n\n\n### logSelectOrderType(...)\n\n```typescript\nlogSelectOrderType(options: { orderType: OrderType; }) => Promise<void>\n```\n\n| Param         | Type                                                            |\n| ------------- | --------------------------------------------------------------- |\n| **`options`** | <code>{ orderType: <a href=\"#ordertype\">OrderType</a>; }</code> |\n\n--------------------\n\n\n### logSelectPickupTime(...)\n\n```typescript\nlogSelectPickupTime(options: { pickupTimeType: PickupTimeType; scheduledTimestamp?: string; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                        |\n| ------------- | ----------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ pickupTimeType: <a href=\"#pickuptimetype\">PickupTimeType</a>; scheduledTimestamp?: string; }</code> |\n\n--------------------\n\n\n### logViewItemList(...)\n\n```typescript\nlogViewItemList(options: { itemListId: string; itemListName: string; items?: AnalyticsCartItem[]; }) => Promise<void>\n```\n\n| Param         | Type                                                                                    |\n| ------------- | --------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ itemListId: string; itemListName: string; items?: AnalyticsCartItem[]; }</code> |\n\n--------------------\n\n\n### logSelectItem(...)\n\n```typescript\nlogSelectItem(options: { itemId: string; itemName: string; itemCategory?: string; itemVariant?: string; price?: number; quantity?: number; itemListId?: string; itemListName?: string; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                           |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **`options`** | <code>{ itemId: string; itemName: string; itemCategory?: string; itemVariant?: string; price?: number; quantity?: number; itemListId?: string; itemListName?: string; }</code> |\n\n--------------------\n\n\n### logViewItem(...)\n\n```typescript\nlogViewItem(options: { itemId: string; itemName: string; itemCategory?: string; itemVariant?: string; price?: number; quantity?: number; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                               |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ itemId: string; itemName: string; itemCategory?: string; itemVariant?: string; price?: number; quantity?: number; }</code> |\n\n--------------------\n\n\n### logAddToCart(...)\n\n```typescript\nlogAddToCart(options: { items: AnalyticsCartItem[]; value: number; storeId: string; orderType: OrderType; memberStatus: MemberStatus; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                                |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ items: AnalyticsCartItem[]; value: number; storeId: string; orderType: <a href=\"#ordertype\">OrderType</a>; memberStatus: <a href=\"#memberstatus\">MemberStatus</a>; }</code> |\n\n--------------------\n\n\n### logRemoveFromCart(...)\n\n```typescript\nlogRemoveFromCart(options: { items: AnalyticsCartItem[]; value: number; initiatedBy?: RemoveFromCartInitiator; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                      |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ items: AnalyticsCartItem[]; value: number; initiatedBy?: <a href=\"#removefromcartinitiator\">RemoveFromCartInitiator</a>; }</code> |\n\n--------------------\n\n\n### logViewCart(...)\n\n```typescript\nlogViewCart(options: { items: AnalyticsCartItem[]; value: number; }) => Promise<void>\n```\n\n| Param         | Type                                                        |\n| ------------- | ----------------------------------------------------------- |\n| **`options`** | <code>{ items: AnalyticsCartItem[]; value: number; }</code> |\n\n--------------------\n\n\n### logBeginCheckout(...)\n\n```typescript\nlogBeginCheckout(options: { promotionId?: string; storeId: string; value: number; items?: AnalyticsCartItem[]; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                |\n| ------------- | --------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ promotionId?: string; storeId: string; value: number; items?: AnalyticsCartItem[]; }</code> |\n\n--------------------\n\n\n### logAddPaymentInfo(...)\n\n```typescript\nlogAddPaymentInfo(options: { paymentType: PaymentType; }) => Promise<void>\n```\n\n| Param         | Type                                                                  |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | <code>{ paymentType: <a href=\"#paymenttype\">PaymentType</a>; }</code> |\n\n--------------------\n\n\n### logPurchase(...)\n\n```typescript\nlogPurchase(options: { transactionId: string; paymentType: PaymentType; value: number; tax?: number; promotionId?: string; storeId: string; orderType: OrderType; memberStatus: MemberStatus; items: AnalyticsCartItem[]; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                                                                                                                                                |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ transactionId: string; paymentType: <a href=\"#paymenttype\">PaymentType</a>; value: number; tax?: number; promotionId?: string; storeId: string; orderType: <a href=\"#ordertype\">OrderType</a>; memberStatus: <a href=\"#memberstatus\">MemberStatus</a>; items: AnalyticsCartItem[]; }</code> |\n\n--------------------\n\n\n### logViewPromotion(...)\n\n```typescript\nlogViewPromotion(options: { promotionId: string; promotionName: string; promotionType: PromotionType; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                    |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ promotionId: string; promotionName: string; promotionType: <a href=\"#promotiontype\">PromotionType</a>; }</code> |\n\n--------------------\n\n\n### logSelectPromotion(...)\n\n```typescript\nlogSelectPromotion(options: { promotionId: string; promotionName: string; promotionType: PromotionType; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                    |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ promotionId: string; promotionName: string; promotionType: <a href=\"#promotiontype\">PromotionType</a>; }</code> |\n\n--------------------\n\n\n### logPromotionApply(...)\n\n```typescript\nlogPromotionApply(options: { promotionId: string; promotionType: PromotionType; success: boolean; discountValue?: number; failureReason?: string; storeId?: string; orderType?: OrderType; memberStatus?: MemberStatus; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                                                                                                                                          |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ promotionId: string; promotionType: <a href=\"#promotiontype\">PromotionType</a>; success: boolean; discountValue?: number; failureReason?: string; storeId?: string; orderType?: <a href=\"#ordertype\">OrderType</a>; memberStatus?: <a href=\"#memberstatus\">MemberStatus</a>; }</code> |\n\n--------------------\n\n\n### logPromotionRemove(...)\n\n```typescript\nlogPromotionRemove(options: { promotionId: string; promotionType: PromotionType; }) => Promise<void>\n```\n\n| Param         | Type                                                                                             |\n| ------------- | ------------------------------------------------------------------------------------------------ |\n| **`options`** | <code>{ promotionId: string; promotionType: <a href=\"#promotiontype\">PromotionType</a>; }</code> |\n\n--------------------\n\n\n### logReorder(...)\n\n```typescript\nlogReorder(options: { sourceTransactionId: string; orderType: OrderType; storeId: string; memberStatus: MemberStatus; value: number; items: AnalyticsCartItem[]; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                                                             |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ sourceTransactionId: string; orderType: <a href=\"#ordertype\">OrderType</a>; storeId: string; memberStatus: <a href=\"#memberstatus\">MemberStatus</a>; value: number; items: AnalyticsCartItem[]; }</code> |\n\n--------------------\n\n\n### logOrderHistoryView()\n\n```typescript\nlogOrderHistoryView() => Promise<void>\n```\n\n--------------------\n\n\n### logCheckoutError(...)\n\n```typescript\nlogCheckoutError(options: { checkoutStep: CheckoutStep; errorCode: string; failureReason: string; paymentType?: PaymentType; cartValue?: number; storeId?: string; memberStatus?: MemberStatus; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                                                                                                                    |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ checkoutStep: <a href=\"#checkoutstep\">CheckoutStep</a>; errorCode: string; failureReason: string; paymentType?: <a href=\"#paymenttype\">PaymentType</a>; cartValue?: number; storeId?: string; memberStatus?: <a href=\"#memberstatus\">MemberStatus</a>; }</code> |\n\n--------------------\n\n\n### logItemOutOfStock(...)\n\n```typescript\nlogItemOutOfStock(options: { itemId: string; itemName: string; storeId: string; orderType?: OrderType; memberStatus?: MemberStatus; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                                         |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ itemId: string; itemName: string; storeId: string; orderType?: <a href=\"#ordertype\">OrderType</a>; memberStatus?: <a href=\"#memberstatus\">MemberStatus</a>; }</code> |\n\n--------------------\n\n\n### logStoreUnavailable(...)\n\n```typescript\nlogStoreUnavailable(options: { storeId: string; orderType: OrderType; failureReason: string; memberStatus?: MemberStatus; }) => Promise<void>\n```\n\n| Param         | Type                                                                                                                                                             |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | <code>{ storeId: string; orderType: <a href=\"#ordertype\">OrderType</a>; failureReason: string; memberStatus?: <a href=\"#memberstatus\">MemberStatus</a>; }</code> |\n\n--------------------\n\n\n### requestTrackingAuthorization()\n\n```typescript\nrequestTrackingAuthorization() => Promise<void>\n```\n\n--------------------\n\n\n### addListener('conversionDataSuccess', ...)\n\n```typescript\naddListener(eventName: 'conversionDataSuccess', listenerFunc: (data: { mediaSource?: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle\n```\n\n| Param              | Type                                                      |\n| ------------------ | --------------------------------------------------------- |\n| **`eventName`**    | <code>'conversionDataSuccess'</code>                      |\n| **`listenerFunc`** | <code>(data: { mediaSource?: string; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt; & <a href=\"#pluginlistenerhandle\">PluginListenerHandle</a></code>\n\n--------------------\n\n\n### addListener('conversionDataFail', ...)\n\n```typescript\naddListener(eventName: 'conversionDataFail', listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle\n```\n\n| Param              | Type                                               |\n| ------------------ | -------------------------------------------------- |\n| **`eventName`**    | <code>'conversionDataFail'</code>                  |\n| **`listenerFunc`** | <code>(data: { error: string; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt; & <a href=\"#pluginlistenerhandle\">PluginListenerHandle</a></code>\n\n--------------------\n\n\n### addListener('appOpenAttribution', ...)\n\n```typescript\naddListener(eventName: 'appOpenAttribution', listenerFunc: (data: { attributionData: any; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle\n```\n\n| Param              | Type                                                      |\n| ------------------ | --------------------------------------------------------- |\n| **`eventName`**    | <code>'appOpenAttribution'</code>                         |\n| **`listenerFunc`** | <code>(data: { attributionData: any; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt; & <a href=\"#pluginlistenerhandle\">PluginListenerHandle</a></code>\n\n--------------------\n\n\n### addListener('appOpenAttributionFail', ...)\n\n```typescript\naddListener(eventName: 'appOpenAttributionFail', listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle\n```\n\n| Param              | Type                                               |\n| ------------------ | -------------------------------------------------- |\n| **`eventName`**    | <code>'appOpenAttributionFail'</code>              |\n| **`listenerFunc`** | <code>(data: { error: string; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt; & <a href=\"#pluginlistenerhandle\">PluginListenerHandle</a></code>\n\n--------------------\n\n\n### addListener('deepLinkResolved', ...)\n\n```typescript\naddListener(eventName: 'deepLinkResolved', listenerFunc: (data: { deeplinkValue: string; matchType: string; status: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle\n```\n\n| Param              | Type                                                                                          |\n| ------------------ | --------------------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'deepLinkResolved'</code>                                                               |\n| **`listenerFunc`** | <code>(data: { deeplinkValue: string; matchType: string; status: string; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt; & <a href=\"#pluginlistenerhandle\">PluginListenerHandle</a></code>\n\n--------------------\n\n\n### Interfaces\n\n\n#### AnalyticsCartItem\n\n| Prop               | Type                |\n| ------------------ | ------------------- |\n| **`itemId`**       | <code>string</code> |\n| **`itemName`**     | <code>string</code> |\n| **`itemCategory`** | <code>string</code> |\n| **`itemVariant`**  | <code>string</code> |\n| **`price`**        | <code>number</code> |\n| **`quantity`**     | <code>number</code> |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n### Type Aliases\n\n\n#### MemberStatus\n\n<code>'member' | 'non_member'</code>\n\n\n#### OrderType\n\n<code>'pickup' | 'dine_in' | 'delivery'</code>\n\n\n#### PickupTimeType\n\n<code>'asap' | 'scheduled'</code>\n\n\n#### RemoveFromCartInitiator\n\n<code>'user' | 'system'</code>\n\n\n#### PaymentType\n\n<code>'card' | 'apple_pay' | 'google_pay'</code>\n\n\n#### PromotionType\n\n<code>'reward' | 'coupon' | 'promo_code'</code>\n\n\n#### CheckoutStep\n\n<code>'cart' | 'fulfilment' | 'payment' | 'confirmation'</code>\n\n</docgen-api>\n","readmeFilename":"README.md"}