@stripchatdev/ext-helper 0.1.14 → 0.1.15

package/dist/index.d.ts

@@ -300,7 +300,7 @@ export declare type TV1ExtUser = {
 
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods & TV1TipMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -604,12 +604,46 @@ export declare type TV1TipData = {
 };
 
 declare type TV1TipEvents = {
+    /** Fired when the tip menu has been updated.*/
+    'v1.tipMenu.updated': {
+        /** The current tip menu data. */
+        tipMenu: TV1TipMenu;
+    };
     /** Fired on every tip in chat for both model and user. Doesn't fire on private tips during public shows */
     'v1.tokens.spent': {
         tipData: TV1TipData;
     };
 };
 
+/** Tip menu data */
+export declare type TV1TipMenu = {
+    /** Whether tip menu is enabled or not. If it's disabled, the `items` array will be empty. */
+    isEnabled: boolean;
+    /** The list of tip menu items sorted by the model. */
+    items: TV1TipMenuItem[];
+};
+
+/** Tip menu item defined by the model. */
+export declare type TV1TipMenuItem = {
+    /** Activity name */
+    activity: string;
+    /** Price of the activity for the current user applying all discounts.
+     *  Discounds can be applied based on the user's fan club memberhip.
+     * */
+    price: number;
+};
+
+declare type TV1TipMethods = {
+    /** Get the current tip menu. Tip menu data might change during the broadcast, so subscribe to `v1.tipMenu.updated` to listen to these changes. */
+    'v1.tipMenu.get': {
+        params: null;
+        result: {
+            /** The current tip menu data. */
+            tipMenu: TV1TipMenu;
+        };
+    };
+};
+
 /** Source of the tip. Could be one of the following:
  *
  * `console` - tip was sent using / command

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stripchatdev/ext-helper",
   "private": false,
-  "version": "0.1.14",
+  "version": "0.1.15",
   "license": "Apache-2.0",
   "type": "module",
   "module": "./dist/ext-helper.js",