@ray-js/api 1.5.29 → 1.5.30

package/@types/BizKit.d.ts

@@ -1,7 +1,7 @@
 /**
  * BizKit
  *
- * @version 4.5.1
+ * @version 4.10.4
  */
 declare namespace ty {
   /**
@@ -35,6 +35,35 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 获取AI助手组历史消息
+   */
+  export function getAIAssistantGroupHistory(params: {
+    /** 数量，不传递默认值30 */
+    size: number
+    /** 分页依据，传入0查询最近n条，其他值后根据 id < primaryId 往前查询n条 */
+    primaryId: number
+    /** 渠道列表，数组其中一个元素支持传递null表示原有AI组手，整个数组为空时，查询所有数据 */
+    channels?: string[]
+    /** 会话列表，数组其中一个元素支持传递null，整个数组为空时，查询所有数据 */
+    sessions?: string[]
+    complete?: () => void
+    success?: (params: {
+      /** 列表数据个数 */
+      size: number
+      /** 数据列表 */
+      list: GroupHistoryResItem[][]
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 删除消息
    */
@@ -61,10 +90,14 @@ declare namespace ty {
     block: string
     /** 可选参数 */
     options: string
-    /** 类型 TEXT / SKILL，存在DB中的类型是TEXT_FINISH, SKILL_FINISH */
+    /** 类型 TEXT/SKILL/其他任意字符CUSTOMXX，存在DB中的类型是TEXT_FINISH, SKILL_FINISH, CUSTOMXX_FINISH */
     type: string
     /** 可选字段，如果传递了，则会绑定到该消息上，如果没有传递，则会生成一个新的requestId */
     requestId?: string
+    /** 渠道, 兼容历史不传从options中获取 */
+    channel?: string
+    /** 会话 */
+    session?: string
     complete?: () => void
     success?: (params: {
       /** 单次对话消息标识 */
@@ -144,11 +177,18 @@ declare namespace ty {
      * 消息来源 1. 本地 2. 云端
      * 消息的绑定会根据插入的source值相关，只有source相同的才会绑定。比如requestId==1的数据在数据库中有两条，source分别是1和2，插入内容根据source匹配绑定到对应的消息上。
      */
-    source: string
+    source: number
     /** 渠道 可选参数，不传表示首页AI组手 */
-    channel: string
+    channel?: string
+    /** 会话 */
+    session?: string
+    /** 发送/接受ws 时候携带数据 */
+    options?: string
     complete?: () => void
-    success?: (params: null) => void
+    success?: (params: {
+      /** 主键 */
+      primaryId: number
+    }) => void
     fail?: (params: {
       errorMsg: string
       errorCode: string | number
@@ -166,13 +206,21 @@ declare namespace ty {
     /** 消息标识 */
     primaryId: number
     /** 消息内容 */
-    data: string
+    data?: string
     /** 错误码 */
-    code: string
+    code?: string
     /** 错误信息 */
-    message: string
+    message?: string
     /** 消息来源 1. 本地 2. 云端 */
-    source: string
+    source?: string
+    /** 类型，以_FINISH结尾 */
+    type: string
+    /** 渠道 可选参数，不传表示首页AI组手 */
+    channel?: string
+    /** 会话 */
+    session?: string
+    /** 发送/接受ws 时候携带数据 */
+    options?: string
     complete?: () => void
     success?: (params: null) => void
     fail?: (params: {
@@ -267,7 +315,7 @@ declare namespace ty {
       /** 消息标识 */
       requestId: string
       /** 消息来源 1. 本地 2. 云端 */
-      source: string
+      source: number
       /** 消息内容 */
       data: string
       /** 错误码 */
@@ -347,7 +395,6 @@ declare namespace ty {
   export function apiRequestByHighwayRestful(params: {
     /**
      * 域名
-     * e.g. apigw-cn.wgine.com
      */
     host?: string
     /**
@@ -500,6 +547,29 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 业务侧定义的性能数据,会显示在性能工具中
+   */
+  export function performanceEvent(params?: {
+    /**
+     * 性能数据, 这里的数据会以点击小程序的时间为起点，到调用performance方法的时间为终点自动计算耗时
+     * example: ty.performanceEvent({launchData: 'map_render_time'})
+     */
+    launchData?: string
+    /** 业务自定义性能数据，会以key-value的形式展示在性能工具中 */
+    perfData?: Record<string, string>
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 拿到当前App的业务信息
    */
@@ -654,6 +724,63 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 获取云端环境
+   */
+  export function getCloudEnv(params?: {
+    complete?: () => void
+    success?: (params: {
+      /** 云端环境 CloudEnvType */
+      env: number
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 当前环境是否支持小程序
+   */
+  export function isMiniAppAvailable(params?: {
+    complete?: () => void
+    success?: (params: {
+      /** 是否支持小程序环境 */
+      availalble: boolean
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 获取当前App的tab信息（仅Android）
+   */
+  export function getAppTabInfo(params?: {
+    complete?: () => void
+    success?: (params: {
+      /** tab信息 */
+      tabInfo: AppTabInfo[]
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 进入选择国家页面
    */
@@ -702,10 +829,30 @@ declare namespace ty {
     productID: string
     /** 订阅单预支付code */
     preFlowCode: string
+    /** 1: 订阅 0: 非订阅 */
+    subscription?: number
+    /**
+     * 指定订阅升级/降级期间的按比例分配模式
+     * Google提供的几种模式：
+     * int UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY = 0;
+     * int IMMEDIATE_WITH_TIME_PRORATION = 1;
+     * int IMMEDIATE_AND_CHARGE_PRORATED_PRICE = 2;
+     * int IMMEDIATE_WITHOUT_PRORATION = 3;
+     * int DEFERRED = 4
+     */
+    billing_mode?: number
+    /** 之前的sku商品，用于筛选和获取历史订单的令牌做升级处理 */
+    previous_sku?: string
     complete?: () => void
     success?: (params: {
       /** 订单ID */
-      orderID: string
+      orderID?: string
+      /** 选择订单为备选结算处理token，用于后台主动上报备选结算报告单 */
+      token?: string
+      /** 选择为备选结算处理的订单 */
+      products?: string
+      /** 0:iap  1:备选结算 */
+      paymentType?: number
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -723,7 +870,7 @@ declare namespace ty {
   export function iapType(params?: {
     complete?: () => void
     success?: (params: {
-      /** 支付类型 0:三方支付; 1:苹果支付 */
+      /** 支付类型 0:三方支付; 1:苹果支付,2:google支付,3:google支付支持备选结算 */
       data: number
     }) => void
     fail?: (params: {
@@ -790,6 +937,28 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 创建实时活动
+   */
+  export function createLiveActivity(params: {
+    /** 实时通知类型 */
+    activityType?: any
+    /** 实时通知ID */
+    activityId: string
+    /** 实时通知参数 */
+    data: Record<string, string>
+    complete?: () => void
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 获取手机当前地区语言 zh-hans 、en-GB
    */
@@ -1178,6 +1347,8 @@ declare namespace ty {
        * 2: google支付
        */
       iapType?: number
+      /** google支付下是否支持用户自选的备选结算 */
+      googleIapEnableUserChoice?: boolean
     }) => void
     fail?: (params: {
       errorMsg: string
@@ -1445,6 +1616,56 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 显示分享弹窗
+   */
+  export function showSharePanel(params: {
+    /** 分享内容类型 */
+    contentType: number
+    complete?: () => void
+    success?: (params: {
+      /** 分享平台类型 */
+      platformType: string
+      /** 选中平台是否安装 */
+      installed: boolean
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 直接分享
+   */
+  export function shareDirectly(params: {
+    /** 分享平台类型 */
+    platformType: string
+    /** 相册内容标识 */
+    localIdentifier: string
+    /** 分享内容类型 */
+    contentType: number
+    complete?: () => void
+    success?: (params: {
+      /** 分享结果码 */
+      code: number
+      /** 分享结果描述 */
+      msg: string
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 是否支持 siri, 仅 iOS
    */
@@ -1531,7 +1752,7 @@ declare namespace ty {
       /** 是否是临时用户 */
       isTemporaryUser: boolean
     }) => void
-    fail?: (params: {
+    failure?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -1627,6 +1848,28 @@ declare namespace ty {
     }) => void
   }): void
 
+  /**
+   * 截图
+   */
+  export function takeScreenShot(params?: {
+    complete?: () => void
+    success?: (params: {
+      /**
+       * 截图本地地址
+       * path 图片路径
+       */
+      path: string
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
   /**
    * 获取websocket的连接状态
    */
@@ -1782,12 +2025,16 @@ declare namespace ty {
   /**
    * 添加消息监听
    */
-  export function onAIAssistantChange(listener: (params: ReceiveBean) => void): void
+  export function onAIAssistantChange(
+    listener: (params: ReceiveBean) => void
+  ): void
 
   /**
    * 取消监听：添加消息监听
    */
-  export function offAIAssistantChange(listener: (params: ReceiveBean) => void): void
+  export function offAIAssistantChange(
+    listener: (params: ReceiveBean) => void
+  ): void
 
   /**
    * 国家列表界面选择的国家信息
@@ -1806,12 +2053,16 @@ declare namespace ty {
   /**
    * 上传进度回调
    */
-  export function onUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
+  export function onUploadProgressUpdate(
+    listener: (params: ProgressEvent) => void
+  ): void
 
   /**
    * 取消监听：上传进度回调
    */
-  export function offUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
+  export function offUploadProgressUpdate(
+    listener: (params: ProgressEvent) => void
+  ): void
 
   /**
    * 页面刷新事件
@@ -1821,27 +2072,51 @@ declare namespace ty {
   /**
    * 取消监听：页面刷新事件
    */
-  export function offPageRefresh(listener: (params: RefreshParams) => void): void
+  export function offPageRefresh(
+    listener: (params: RefreshParams) => void
+  ): void
 
   /**
    * 事件通道响应
    */
-  export function onReceiveMessage(listener: (params: EventChannelMessageParams) => void): void
+  export function onReceiveMessage(
+    listener: (params: EventChannelMessageParams) => void
+  ): void
 
   /**
    * 取消监听：事件通道响应
    */
-  export function offReceiveMessage(listener: (params: EventChannelMessageParams) => void): void
+  export function offReceiveMessage(
+    listener: (params: EventChannelMessageParams) => void
+  ): void
 
   /**
    * 订单状态监听, 只有在addOrderStatusListener之后, 才能收到监听
    */
-  export function onOrderStatusListener(listener: (params: OrderStatusEvent) => void): void
+  export function onOrderStatusListener(
+    listener: (params: OrderStatusEvent) => void
+  ): void
 
   /**
    * 取消监听：订单状态监听, 只有在addOrderStatusListener之后, 才能收到监听
    */
-  export function offOrderStatusListener(listener: (params: OrderStatusEvent) => void): void
+  export function offOrderStatusListener(
+    listener: (params: OrderStatusEvent) => void
+  ): void
+
+  /**
+   * 用户自选备选结算监听, 只有在addOrderStatusListener之后, 才能收到监听
+   */
+  export function onUserSelectedAlternativeBilling(
+    listener: (params: UserSelectedAlternativeEvent) => void
+  ): void
+
+  /**
+   * 取消监听：用户自选备选结算监听, 只有在addOrderStatusListener之后, 才能收到监听
+   */
+  export function offUserSelectedAlternativeBilling(
+    listener: (params: UserSelectedAlternativeEvent) => void
+  ): void
 
   /**
    * 统一路由事件通知
@@ -1856,45 +2131,84 @@ declare namespace ty {
   /**
    * 万能路由界面返回的数据
    */
-  export function onRouterResult(listener: (params: RouterResultResponse) => void): void
+  export function onRouterResult(
+    listener: (params: RouterResultResponse) => void
+  ): void
 
   /**
    * 取消监听：万能路由界面返回的数据
    */
-  export function offRouterResult(listener: (params: RouterResultResponse) => void): void
+  export function offRouterResult(
+    listener: (params: RouterResultResponse) => void
+  ): void
 
   /**
    * RN或小程序页面关闭事件（Android独有）
    */
-  export function onFrontPageClose(listener: (params: PageCloseResponse) => void): void
+  export function onFrontPageClose(
+    listener: (params: PageCloseResponse) => void
+  ): void
 
   /**
    * 取消监听：RN或小程序页面关闭事件（Android独有）
    */
-  export function offFrontPageClose(listener: (params: PageCloseResponse) => void): void
+  export function offFrontPageClose(
+    listener: (params: PageCloseResponse) => void
+  ): void
 
   /**
    * onWebSocketStatusChange 接受消息
    */
-  export function onWebSocketStatusChange(listener: (params: StatusBean) => void): void
+  export function onWebSocketStatusChange(
+    listener: (params: StatusBean) => void
+  ): void
 
   /**
    * 取消监听：onWebSocketStatusChange 接受消息
    */
-  export function offWebSocketStatusChange(listener: (params: StatusBean) => void): void
+  export function offWebSocketStatusChange(
+    listener: (params: StatusBean) => void
+  ): void
+
+  export type GroupHistoryResItem = {
+    /** 主键，消息标识 */
+    primaryId: number
+    /** 单条消息标识 */
+    requestId: string
+    /** 消息来源 1. 发送 2. 接收 */
+    source: number
+    /** 发送码 */
+    code: string
+    /** 错误信息 */
+    message: string
+    /** 类型，和发送时候type一致，以_Finish结尾 */
+    type: string
+    /** 创建时间 */
+    createTime: number
+    /** 家庭ID */
+    homeId: string
+    /** 渠道 */
+    channel: string
+    /** 会话 */
+    session: string
+    /** 发送/接收ws 时候携带数据 */
+    options: string
+    /** 数据内容 */
+    data: string
+  }
 
   export enum HighwayMethod {
     /** HTTP 请求 GET */
-    GET = 'GET',
+    GET = "GET",
 
     /** HTTP 请求 POST */
-    POST = 'POST',
+    POST = "POST",
 
     /** HTTP 请求 PUT */
-    PUT = 'PUT',
+    PUT = "PUT",
 
     /** HTTP 请求 DELETE */
-    DELETE = 'DELETE',
+    DELETE = "DELETE",
   }
 
   export type ThirdPartyServiceInfo = {
@@ -1908,6 +2222,17 @@ declare namespace ty {
     type: number
   }
 
+  export type AppTabInfo = {
+    /** tab的唯一标志符 */
+    key: string
+    /** tab的文案 */
+    text: string
+    /** tab的icon */
+    iconPath: string
+    /** tab的选中icon */
+    selectedIconPath: string
+  }
+
   export type PanelUiInfoBean = {
     /** phase 面板phase */
     phase?: string
@@ -2031,6 +2356,13 @@ declare namespace ty {
     errorMsg?: string
   }
 
+  export type UserSelectedAlternativeEvent = {
+    /** google支付下，在支持备选结算系统的情况下，用户选择备选结算方式，需要携带相关toke信息,后续完成支付以后，报告云端。 */
+    externalTransactionToken?: string
+    /** google支付下，在支持备选结算系统的情况下，用户选择备选结算方式，需要携带相关products信息。 */
+    products?: string
+  }
+
   export type RouterEvent = {
     /** 业务事件名称,例如设备定时更新onDeviceAlarmUpdate */
     bizEventName: string
@@ -2085,7 +2417,6 @@ declare namespace ty {
   export type HighwayReq = {
     /**
      * 域名
-     * e.g. apigw-cn.wgine.com
      */
     host?: string
     /**
@@ -2140,6 +2471,16 @@ declare namespace ty {
     params: string
   }
 
+  export type PerformanceBean = {
+    /**
+     * 性能数据, 这里的数据会以点击小程序的时间为起点，到调用performance方法的时间为终点自动计算耗时
+     * example: ty.performanceEvent({launchData: 'map_render_time'})
+     */
+    launchData?: string
+    /** 业务自定义性能数据，会以key-value的形式展示在性能工具中 */
+    perfData?: Record<string, string>
+  }
+
   export type ManagerContext = {
     /** managerId */
     managerId: number
@@ -2151,7 +2492,7 @@ declare namespace ty {
     channels: number
     /** 编码格式，eg：ThingAudioAsrCodeTypePCM = 0 ,ThingAudioAsrCodeTypePCMU = 1 */
     codec: string
-    /** 云端asr解析选项，参考：https://wiki.tuya-inc.com:7799/page/1400707433826881594#5A14F9， 注意不要设置其他跟文本无关的参数，本检测只会处理跟文本相关的数据，nlp，skill，tts不包含。 */
+    /** 云端asr解析选项， 注意不要设置其他跟文本无关的参数，本检测只会处理跟文本相关的数据，nlp，skill，tts不包含。 */
     options: string
   }
 
@@ -2240,6 +2581,21 @@ declare namespace ty {
     data: Record<string, {}>
   }
 
+  export type CloudEnvResult = {
+    /** 云端环境 CloudEnvType */
+    env: number
+  }
+
+  export type MiniAppAvailableRes = {
+    /** 是否支持小程序环境 */
+    availalble: boolean
+  }
+
+  export type AppTabInfoResponse = {
+    /** tab信息 */
+    tabInfo: AppTabInfo[]
+  }
+
   export type IconfontInfoBean = {
     /**
      * iconfont 信息结构体
@@ -2255,15 +2611,35 @@ declare namespace ty {
     productID: string
     /** 订阅单预支付code */
     preFlowCode: string
+    /** 1: 订阅 0: 非订阅 */
+    subscription?: number
+    /**
+     * 指定订阅升级/降级期间的按比例分配模式
+     * Google提供的几种模式：
+     * int UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY = 0;
+     * int IMMEDIATE_WITH_TIME_PRORATION = 1;
+     * int IMMEDIATE_AND_CHARGE_PRORATED_PRICE = 2;
+     * int IMMEDIATE_WITHOUT_PRORATION = 3;
+     * int DEFERRED = 4
+     */
+    billing_mode?: number
+    /** 之前的sku商品，用于筛选和获取历史订单的令牌做升级处理 */
+    previous_sku?: string
   }
 
   export type PaymentResponse = {
     /** 订单ID */
-    orderID: string
+    orderID?: string
+    /** 选择订单为备选结算处理token，用于后台主动上报备选结算报告单 */
+    token?: string
+    /** 选择为备选结算处理的订单 */
+    products?: string
+    /** 0:iap  1:备选结算 */
+    paymentType?: number
   }
 
   export type TypeResponse = {
-    /** 支付类型 0:三方支付; 1:苹果支付 */
+    /** 支付类型 0:三方支付; 1:苹果支付,2:google支付,3:google支付支持备选结算 */
     data: number
   }
 
@@ -2294,6 +2670,15 @@ declare namespace ty {
     contentType?: string
   }
 
+  export type RequestModel = {
+    /** 实时通知类型 */
+    activityType?: any
+    /** 实时通知ID */
+    activityId: string
+    /** 实时通知参数 */
+    data: Record<string, string>
+  }
+
   export type LocalConstants = {
     /** 手机当前地区语言 */
     langKey: string
@@ -2311,7 +2696,7 @@ declare namespace ty {
     langContent: {}
   }
 
-  export type ManagerContext_QpZPYN = {
+  export type ManagerContext_asWhI2 = {
     /** managerId */
     managerId: number
     /** 自定义标记 */
@@ -2450,6 +2835,8 @@ declare namespace ty {
      * 2: google支付
      */
     iapType?: number
+    /** google支付下是否支持用户自选的备选结算 */
+    googleIapEnableUserChoice?: boolean
   }
 
   export type iapPayReadyReq = {
@@ -2568,6 +2955,34 @@ declare namespace ty {
     shareChannelList: string[]
   }
 
+  export type SharePanelParams = {
+    /** 分享内容类型 */
+    contentType: number
+  }
+
+  export type SharePanelResponse = {
+    /** 分享平台类型 */
+    platformType: string
+    /** 选中平台是否安装 */
+    installed: boolean
+  }
+
+  export type ShareContentParams = {
+    /** 分享平台类型 */
+    platformType: string
+    /** 相册内容标识 */
+    localIdentifier: string
+    /** 分享内容类型 */
+    contentType: number
+  }
+
+  export type ShareContentResponse = {
+    /** 分享结果码 */
+    code: number
+    /** 分享结果描述 */
+    msg: string
+  }
+
   export type SiriEnabledResponse = {
     /** 是否支持 */
     isSupported: boolean
@@ -2663,6 +3078,14 @@ declare namespace ty {
     orientation: number
   }
 
+  export type ScreenShotResultBean = {
+    /**
+     * 截图本地地址
+     * path 图片路径
+     */
+    path: string
+  }
+
   export type WechatSupport = {
     /** 是否支持微信绑定 */
     isSupport: boolean
@@ -2712,7 +3135,7 @@ declare namespace ty {
         /** 状态 */
         isActive: boolean
       }) => void
-      fail?: (params: {
+      failure?: (params: {
         errorMsg: string
         errorCode: string | number
         innerError: {
@@ -2795,11 +3218,11 @@ declare namespace ty {
     channels: number
     /** 编码格式，eg：ThingAudioAsrCodeTypePCM = 0 ,ThingAudioAsrCodeTypePCMU = 1 */
     codec: string
-    /** 云端asr解析选项，参考：https://wiki.tuya-inc.com:7799/page/1400707433826881594#5A14F9， 注意不要设置其他跟文本无关的参数，本检测只会处理跟文本相关的数据，nlp，skill，tts不包含。 */
+    /** 云端asr解析选项， 注意不要设置其他跟文本无关的参数，本检测只会处理跟文本相关的数据，nlp，skill，tts不包含。 */
     options: string
     complete?: () => void
     success?: (params: null) => void
-    fail?: (params: {
+    failure?: (params: {
       errorMsg: string
       errorCode: string | number
       innerError: {
@@ -2810,7 +3233,7 @@ declare namespace ty {
   }): GetAsrListenerManagerTask
 
   /**
-   * AI语音助手管理器
+   * 日志管理器
    */
   interface GetLogManagerTask {
     /**