@doubao-apps/ai 0.0.33 → 0.0.34

package/dist/skills/doubao-apps-dev/references/reference/open-api/12-/346/224/257/344/273/230.md

@@ -0,0 +1,224 @@
+# Open API: 支付
+
+订单创建、签名和支付能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [createSignOrder](#createsignorder) | 创建签约订单。 |
+| [getOrderPaymentWithSign](#getorderpaymentwithsign) | 使用签名信息拉起收银台完成订单支付。 |
+| [getOrderPayment](#getorderpayment) | 拉起收银台完成订单支付。 |
+| [requestCombineOrder](#requestcombineorder) | 请求创建合单订单。 |
+| [requestOrder](#requestorder) | 发起订单支付流程。 |
+| [sign](#sign) | 拉起签约流程。 |
+
+## API 详情
+
+<a id="createsignorder"></a>
+### createSignOrder()
+
+创建签约订单。
+
+## 代码示例
+
+```typescript
+import { createSignOrder } from '@doubao-apps/framework/api';
+
+const result = await createSignOrder({
+  data: '{"planId":"plan_001"}',
+  dbAuthorization: 'authorization-token'
+});
+
+console.log(result);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`string`|是|签约订单请求数据。|
+|dbAuthorization|`string`|是|签约订单授权信息。|
+
+## 返回值
+
+返回一个 Promise，解析为签约订单结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|authOrderId|`string`|签约订单 ID。|
+|logId|`string`|用于问题排查的日志 ID。|
+|errLogId|`string`|用于问题排查的错误日志 ID。|
+|errMsg|`string`|错误信息。|
+|errNo|`string`|错误码。|
+
+<a id="getorderpaymentwithsign"></a>
+### getOrderPaymentWithSign()
+
+使用签名信息拉起收银台完成订单支付。
+
+## 代码示例
+
+```typescript
+import { getOrderPaymentWithSign } from '@doubao-apps/framework/api';
+
+const result = await getOrderPaymentWithSign({
+  orderId: 'order-id',
+  signData: 'sign-data',
+  signDbAuthorization: 'authorization-token'
+});
+
+console.log(result.orderId);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|orderId|`string`|是|订单 ID。|
+|signData|`string`|是|支付签名数据。|
+|signDbAuthorization|`string`|是|签名支付授权信息。|
+
+## 返回值
+
+返回一个 Promise，成功时解析为订单支付结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|logId|`string`|用于问题排查的日志 ID。|
+|orderId|`string`|订单 ID。|
+
+<a id="getorderpayment"></a>
+### getOrderPayment()
+
+拉起收银台完成订单支付。
+
+## 代码示例
+
+```typescript
+import { getOrderPayment } from '@doubao-apps/framework/api';
+
+const { orderId, logId } = await getOrderPayment({ orderId: 'order-id' });
+
+console.log(orderId, logId);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|orderId|`string`|是|订单 ID。|
+
+## 返回值
+
+返回一个 Promise，成功时解析为订单支付结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|logId|`string`|用于问题排查的日志 ID。|
+|orderId|`string`|订单 ID。|
+
+<a id="requestcombineorder"></a>
+### requestCombineOrder()
+
+请求创建合单订单。
+
+## 代码示例
+
+```typescript
+import { requestCombineOrder } from '@doubao-apps/framework/api';
+
+const result = await requestCombineOrder({
+  data: '{"orderList":["order_001","order_002"]}',
+  dbAuthorization: 'authorization-token'
+});
+
+console.log(result);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`string`|是|合单订单请求数据。|
+|dbAuthorization|`string`|是|合单订单授权信息。|
+
+## 返回值
+
+返回一个 Promise，解析为合单订单结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|combineOrderId|`string`|合单订单 ID。|
+|logId|`string`|用于问题排查的日志 ID。|
+|errLogId|`string`|用于问题排查的错误日志 ID。|
+|errMsg|`string`|错误信息。|
+|errNo|`string`|错误码。|
+
+<a id="requestorder"></a>
+### requestOrder()
+
+发起订单支付流程。
+
+## 代码示例
+
+```typescript
+import { requestOrder } from '@doubao-apps/framework/api';
+
+const { orderId, logId } = await requestOrder({
+  data: '{"skuId":"sku_001","count":1}',
+  dbAuthorization: 'authorization-token'
+});
+
+console.log(orderId, logId);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`string`|是|-|
+|dbAuthorization|`string`|是|-|
+
+## 返回值
+
+返回订单支付请求结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|logId|`string`|-|
+|orderId|`string`|-|
+
+<a id="sign"></a>
+### sign()
+
+拉起签约流程。
+
+## 代码示例
+
+```typescript
+import { sign } from '@doubao-apps/framework/api';
+
+const result = await sign({ orderId: 'sign-order-id' });
+
+console.log(result);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|orderId|`string`|是|签约订单 ID。|
+
+## 返回值
+
+返回一个 Promise，解析为签约结果。
+
+|字段名|类型|说明|
+|---|---|---|
+|code|`number`|错误码。|
+|errLogId|`string`|用于问题排查的错误日志 ID。|
+|errMsg|`string`|错误信息。|
+|errNo|`string`|错误编号。|

package/dist/skills/doubao-apps-dev/references/reference/open-api/13-/346/225/260/346/215/256/345/210/206/346/236/220.md

@@ -0,0 +1,43 @@
+# Open API: 数据分析
+
+监控上报、事件和数据分析上报。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [reportEvent](#reportevent) | 上报数据分析事件。 |
+
+## API 详情
+
+<a id="reportevent"></a>
+### reportEvent()
+
+上报数据分析事件。
+
+## 代码示例
+
+```typescript
+import { reportEvent } from '@doubao-apps/framework/api';
+
+await reportEvent({
+  eventName: 'page_view',
+  data: {
+    pageName: 'home',
+    source: 'feed'
+  }
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`Record<string, any>`|是|事件参数，会作为事件属性一并上报。|
+|eventName|`string`|是|事件名称。|
+
+## 返回值
+
+返回一个 Promise，在事件上报请求成功发起时解析。