@doubao-apps/create 0.0.27 → 0.0.28

package/dist/template-starter/{.ai → references}/reference/open-api.md

@@ -328,6 +328,26 @@ closePage();
 
 ***
 
+### createSignOrder()
+
+> **createSignOrder**(`params`): `Promise`\<[`CreateSignOrderResult`](doubao-apps-sdk-open-api.md#createsignorderresult)\>
+
+创建签约订单。
+
+#### Parameters
+
+• **params**: [`CreateSignOrderParams`](doubao-apps-sdk-open-api.md#createsignorderparams)
+
+签约订单参数
+
+#### Returns
+
+`Promise`\<[`CreateSignOrderResult`](doubao-apps-sdk-open-api.md#createsignorderresult)\>
+
+返回一个 Promise，解析为签约订单结果。
+
+***
+
 ### disableAlertBeforeUnload()
 
 > **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
@@ -348,16 +368,24 @@ closePage();
 
 > **dispatchActionDirective**(`params`): `Promise`\<`object`\>
 
-描述用户行为，约束模型行为及指定执行路径
+描述用户行为，约束模型行为并指定后续执行路径。
 
 #### Parameters
 
 • **params**: [`DispatchActionDirectiveParams`](doubao-apps-sdk-open-api.md#dispatchactiondirectiveparams)
 
+动作描述、预期行为及工具调用约束参数。
+
 #### Returns
 
 `Promise`\<`object`\>
 
+返回一个 Promise，在动作指令成功下发时解析。
+
+#### Remarks
+
+适用于卡片交互后向模型补充结构化动作上下文，例如按钮点击、选项选择或表单提交。
+
 ***
 
 ### enableAlertBeforeUnload()
@@ -870,19 +898,39 @@ console.log(result.networkType);
 
 > **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
 
-查询订单支付结果。
+拉起收银台完成订单支付。
 
 #### Parameters
 
 • **params**: [`GetOrderPaymentParams`](doubao-apps-sdk-open-api.md#getorderpaymentparams)
 
-订单支付查询参数。
+支付参数
 
 #### Returns
 
 `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
 
-返回订单支付结果。
+返回一个 Promise，成功时解析为订单支付结果。
+
+***
+
+### getOrderPaymentWithSign()
+
+> **getOrderPaymentWithSign**(`params`): `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
+
+使用签名信息拉起收银台完成订单支付。
+
+#### Parameters
+
+• **params**: [`GetOrderPaymentWithSignParams`](doubao-apps-sdk-open-api.md#getorderpaymentwithsignparams)
+
+签名支付参数
+
+#### Returns
+
+`Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
+
+返回一个 Promise，成功时解析为订单支付结果。
 
 ***
 
@@ -1195,16 +1243,24 @@ console.log(result.safeArea?.top, result.screenTop);
 
 > **hideKeyboard**(`params`?): `Promise`\<`object`\>
 
-收起键盘。
+收起当前键盘。
 
 #### Parameters
 
-• **params?**
+• **params?**: [`HideKeyboardParam`](doubao-apps-sdk-open-api.md#hidekeyboardparam)
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Example
+
+```typescript
+import { hideKeyboard } from '@doubao-apps/framework/api';
+
+await hideKeyboard({});
+```
+
 ***
 
 ### hideLoading()
@@ -1797,6 +1853,40 @@ removeStorageSync({ key: 'profile' });
 
 ***
 
+### reportEvent()
+
+> **reportEvent**(`params`): `Promise`\<`object`\>
+
+上报数据分析事件。
+
+#### Parameters
+
+• **params**: [`ReportEventParams`](doubao-apps-sdk-open-api.md#reporteventparams)
+
+数据分析事件上报参数。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，在事件上报请求成功发起时解析。
+
+#### Example
+
+```typescript
+import { reportEvent } from '@doubao-apps/framework/api';
+
+await reportEvent({
+  eventName: 'page_view',
+  data: {
+    pageName: 'home',
+    source: 'feed'
+  }
+});
+```
+
+***
+
 ### request()
 
 > **request**(`params`): `Promise`\<[`RequestResponse`](doubao-apps-sdk-open-api.md#requestresponse)\>
@@ -1837,6 +1927,26 @@ console.log(result.statusCode, result.data);
 
 ***
 
+### requestCombineOrder()
+
+> **requestCombineOrder**(`params`): `Promise`\<[`RequestCombineOrderResult`](doubao-apps-sdk-open-api.md#requestcombineorderresult)\>
+
+请求创建合单订单。
+
+#### Parameters
+
+• **params**: [`RequestCombineOrderParams`](doubao-apps-sdk-open-api.md#requestcombineorderparams)
+
+合单订单参数
+
+#### Returns
+
+`Promise`\<[`RequestCombineOrderResult`](doubao-apps-sdk-open-api.md#requestcombineorderresult)\>
+
+返回一个 Promise，解析为合单订单结果。
+
+***
+
 ### requestOrder()
 
 > **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](doubao-apps-sdk-open-api.md#requestorderresult)\>
@@ -2285,6 +2395,26 @@ showToast({
 
 ***
 
+### sign()
+
+> **sign**(`params`): `Promise`\<[`SignResult`](doubao-apps-sdk-open-api.md#signresult)\>
+
+拉起签约流程。
+
+#### Parameters
+
+• **params**: [`SignParams`](doubao-apps-sdk-open-api.md#signparams)
+
+签约参数
+
+#### Returns
+
+`Promise`\<[`SignResult`](doubao-apps-sdk-open-api.md#signresult)\>
+
+返回一个 Promise，解析为签约结果。
+
+***
+
 ### startAccelerometer()
 
 > **startAccelerometer**(`params`?): `Promise`\<`object`\>
@@ -2539,13 +2669,13 @@ Wi-Fi 流程入口。
 
 ### updateModelContext()
 
-> **updateModelContext**(`params`?): `Promise`\<`object`\>
+> **updateModelContext**(`params`): `Promise`\<`object`\>
 
 向 Agent 捐赠上下文
 
 #### Parameters
 
-• **params?**: [`UpdateModelContextParams`](doubao-apps-sdk-open-api.md#updatemodelcontextparams)
+• **params**: [`UpdateModelContextParams`](doubao-apps-sdk-open-api.md#updatemodelcontextparams)
 
 #### Returns
 
@@ -2623,6 +2753,8 @@ value 需要是 ArrayBuffer。
 
 ### ActionDirectiveType
 
+用户动作指令类型。
+
 #### Enumeration Members
 
 ##### BUTTON\_CLICK
@@ -3649,8 +3781,70 @@ Wi-Fi SSID。
 
 ***
 
+### CreateSignOrderFailResult
+
+#### Properties
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误码。
+
+***
+
+### CreateSignOrderParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+签约订单请求数据。
+
+##### dbAuthorization
+
+> **dbAuthorization**: `string`
+
+签约订单授权信息。
+
+***
+
+### CreateSignOrderSuccessResult
+
+#### Properties
+
+##### authOrderId
+
+> **authOrderId**: `string`
+
+签约订单 ID。
+
+##### logId
+
+> **logId**: `string`
+
+用于问题排查的日志 ID。
+
+***
+
 ### DispatchActionDirectiveParams
 
+下发动作指令的请求参数。
+
 #### Properties
 
 ##### actionDescribe
@@ -3665,6 +3859,30 @@ Wi-Fi SSID。
 
 动作类型，参见 [ActionDirectiveType](doubao-apps-sdk-open-api.md#actiondirectivetype)
 
+##### expectedAction
+
+> **expectedAction**: `string`
+
+自然语言描述，例如：调用话费账单查询工具，基于工具返回回复用户。如果有卡片需要引用卡片
+
+##### responseHint?
+
+> `optional` **responseHint**: `string`
+
+自然语言描述，例如：严格参照提供的工具入参来调用工具，不要调用除bill_check以外的其他工具，只能严格基于bill_check工具返回结果进行回复
+
+##### toolName?
+
+> `optional` **toolName**: `string`
+
+mcp名称，如果expectedAction里预期要调用工具，需要在这里写明调用工具的mcp name
+
+##### toolParams?
+
+> `optional` **toolParams**: `Record`\<`string`, `string`\>
+
+mcp入参，如果expectedAction里预期要调用工具，需要在这里写明调用工具的入参
+
 ##### widgetInstanceId
 
 > **widgetInstanceId**: `string`
@@ -3721,12 +3939,24 @@ Wi-Fi SSID。
 
 #### Properties
 
+##### detailText?
+
+> `optional` **detailText**: `string`
+
+点击失效卡要跳转的页面 detailText
+
 ##### schema?
 
 > `optional` **schema**: `string`
 
 点击失效卡要跳转的页面 schema，格式与 navigateTo 的 url 相同
 
+##### title?
+
+> `optional` **title**: `string`
+
+点击失效卡要跳转的页面 title
+
 ##### widgetInstanceId
 
 > **widgetInstanceId**: `string`
@@ -4248,6 +4478,8 @@ RSSI 信号强度，单位 dBm。
 
 > **orderId**: `string`
 
+订单 ID。
+
 ***
 
 ### GetOrderPaymentResult
@@ -4258,10 +4490,38 @@ RSSI 信号强度，单位 dBm。
 
 > **logId**: `string`
 
+用于问题排查的日志 ID。
+
 ##### orderId
 
 > **orderId**: `string`
 
+订单 ID。
+
+***
+
+### GetOrderPaymentWithSignParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+订单 ID。
+
+##### signData
+
+> **signData**: `string`
+
+支付签名数据。
+
+##### signDbAuthorization
+
+> **signDbAuthorization**: `string`
+
+签名支付授权信息。
+
 ***
 
 ### GetRandomValuesParams
@@ -4512,6 +4772,10 @@ Wi-Fi 的系统开关
 
 ***
 
+### HideKeyboardParam
+
+***
+
 ### IsBluetoothDevicePairedParams
 
 查询蓝牙设备配对状态的请求参数。
@@ -4978,6 +5242,86 @@ Whether user authorization for privacy agreement is required
 
 ***
 
+### ReportEventParams
+
+上报数据分析事件的请求参数。
+
+#### Properties
+
+##### data
+
+> **data**: `Record`\<`string`, `any`\>
+
+事件参数，会作为事件属性一并上报。
+
+##### eventName
+
+> **eventName**: `string`
+
+事件名称。
+
+***
+
+### RequestCombineOrderFailResult
+
+#### Properties
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误码。
+
+***
+
+### RequestCombineOrderParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+合单订单请求数据。
+
+##### dbAuthorization
+
+> **dbAuthorization**: `string`
+
+合单订单授权信息。
+
+***
+
+### RequestCombineOrderSuccessResult
+
+#### Properties
+
+##### combineOrderId
+
+> **combineOrderId**: `string`
+
+合单订单 ID。
+
+##### logId
+
+> **logId**: `string`
+
+用于问题排查的日志 ID。
+
+***
+
 ### RequestOrderParams
 
 #### Properties
@@ -5479,6 +5823,48 @@ HTTP 状态码。
 
 ***
 
+### SignFailResult
+
+#### Properties
+
+##### code
+
+> **code**: `number`
+
+错误码。
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误编号。
+
+***
+
+### SignParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+签约订单 ID。
+
+***
+
 ### StartAccelerometerParams
 
 开始监听加速度的请求参数。
@@ -5577,9 +5963,9 @@ iOS 下是否忽略蓝牙可用性校验。
 
 #### Properties
 
-##### content?
+##### content
 
-> `optional` **content**: `string`
+> **content**: `string`
 
 上下文内容，格式无约束，可以与 MCP 服务下发的上下文格式保持一致
 
@@ -5913,6 +6299,12 @@ iBeacon 距离等级。
 
 ***
 
+### CreateSignOrderResult
+
+> **CreateSignOrderResult**: [`CreateSignOrderSuccessResult`](doubao-apps-sdk-open-api.md#createsignordersuccessresult) \| [`CreateSignOrderFailResult`](doubao-apps-sdk-open-api.md#createsignorderfailresult)
+
+***
+
 ### DeviceOrientation
 
 > **DeviceOrientation**: `"portrait"` \| `"landscape"`
@@ -5994,6 +6386,12 @@ Widget 登录类型。
 
 ***
 
+### RequestCombineOrderResult
+
+> **RequestCombineOrderResult**: [`RequestCombineOrderSuccessResult`](doubao-apps-sdk-open-api.md#requestcombineordersuccessresult) \| [`RequestCombineOrderFailResult`](doubao-apps-sdk-open-api.md#requestcombineorderfailresult)
+
+***
+
 ### RequestMethod
 
 > **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
@@ -6038,6 +6436,18 @@ Widget 登录类型。
 
 ***
 
+### SignResult
+
+> **SignResult**: [`SignSuccessResult`](doubao-apps-sdk-open-api.md#signsuccessresult) \| [`SignFailResult`](doubao-apps-sdk-open-api.md#signfailresult)
+
+***
+
+### SignSuccessResult
+
+> **SignSuccessResult**: `Record`\<`string`, `never`\>
+
+***
+
 ### UserCaptureScreenListener()
 
 > **UserCaptureScreenListener**: (`event`) => `void`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doubao-apps/create",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "Create Doubao Apps projects with a single command",
   "type": "module",
   "bin": {