@leaflow/sdk 0.5.0 → 0.6.0

package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Leaflow Assistant 用户 API
+ * 控制台里的 AI 助手：对话、消息、工具调用与审批、附件，以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
+
+## 一次对话
+
+1. `POST /v1/threads` 创建对话；
+2. `POST /v1/threads/{thread}/messages` 发送消息，立即返回 `turnId`，助手的执行在后台进行；
+3. `GET /v1/threads/{thread}` 取回对话文档用于渲染，并按其中的 `stream` 连上实时输出；
+4. 助手需要用户参与时，文档中的 `wait` 会说明是哪一种：审批一批工具调用（`POST /v1/threads/{thread}/approvals/{batch}`），或回答几个问题（`POST /v1/threads/{thread}/questions/{item}`）。处理完成后助手自动继续。
+
+发送图片分两步：先 `POST /v1/attachments` 上传拿到 id，发送消息时放进 `attachmentIds`。
+
+## 实时输出
+
+```
+GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
+```
+
+这是一条 Server-Sent Events 流，因此不在下方的接口列表中。
+
+- `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径，按取回文档的地址解析；
+- `cursor` 是起始位置，取自对话文档的 `cursor`。不传则从可用范围的开头开始；
+- 推送的每一条都是对那份对话文档的一次增量编辑，套用同一套渲染逻辑即可；
+- 连接有生存期，到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传，无需额外处理；
+- 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
+ * OpenAPI spec version: 1.0.0
+ */
+export type CreateChannelRequestBodySenderPolicy = typeof CreateChannelRequestBodySenderPolicy[keyof typeof CreateChannelRequestBodySenderPolicy];
+export declare const CreateChannelRequestBodySenderPolicy: {
+    readonly bound_only: "bound_only";
+    readonly open: "open";
+};

package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.js

@@ -0,0 +1,35 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Leaflow Assistant 用户 API
+ * 控制台里的 AI 助手：对话、消息、工具调用与审批、附件，以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
+
+## 一次对话
+
+1. `POST /v1/threads` 创建对话；
+2. `POST /v1/threads/{thread}/messages` 发送消息，立即返回 `turnId`，助手的执行在后台进行；
+3. `GET /v1/threads/{thread}` 取回对话文档用于渲染，并按其中的 `stream` 连上实时输出；
+4. 助手需要用户参与时，文档中的 `wait` 会说明是哪一种：审批一批工具调用（`POST /v1/threads/{thread}/approvals/{batch}`），或回答几个问题（`POST /v1/threads/{thread}/questions/{item}`）。处理完成后助手自动继续。
+
+发送图片分两步：先 `POST /v1/attachments` 上传拿到 id，发送消息时放进 `attachmentIds`。
+
+## 实时输出
+
+```
+GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
+```
+
+这是一条 Server-Sent Events 流，因此不在下方的接口列表中。
+
+- `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径，按取回文档的地址解析；
+- `cursor` 是起始位置，取自对话文档的 `cursor`。不传则从可用范围的开头开始；
+- 推送的每一条都是对那份对话文档的一次增量编辑，套用同一套渲染逻辑即可；
+- 连接有生存期，到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传，无需额外处理；
+- 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
+ * OpenAPI spec version: 1.0.0
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const CreateChannelRequestBodySenderPolicy = {
+    bound_only: 'bound_only',
+    open: 'open',
+};

package/dist/generated/assistant/models/index.d.ts

@@ -31,14 +31,28 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
 export * from './answerRequestBody.js';
 export * from './answerRequestBodyAnswers.js';
 export * from './attachmentResource.js';
+export * from './bindingCodeResponseBody.js';
 export * from './bindingResource.js';
+export * from './bindingResourceConnState.js';
+export * from './bindingResourceStatus.js';
 export * from './bindingResourceVerifiedAt.js';
 export * from './channelResource.js';
 export * from './channelResourceAllowFrom.js';
+export * from './channelResourceConnState.js';
+export * from './channelResourceRuntimeState.js';
+export * from './channelResourceSenderPolicy.js';
+export * from './channelResourceStatus.js';
 export * from './channelResourceWebhookUrl.js';
+export * from './channelWithSecretResponseBody.js';
+export * from './channelWithSecretResponseBodyAllowFrom.js';
+export * from './channelWithSecretResponseBodyConnState.js';
+export * from './channelWithSecretResponseBodyRuntimeState.js';
+export * from './channelWithSecretResponseBodySenderPolicy.js';
+export * from './channelWithSecretResponseBodyStatus.js';
+export * from './channelWithSecretResponseBodyWebhookSecret.js';
+export * from './channelWithSecretResponseBodyWebhookUrl.js';
 export * from './checkSenderParams.js';
 export * from './choice.js';
-export * from './claimCodeResponseBody.js';
 export * from './contextResource.js';
 export * from './contextResourceCompactAt.js';
 export * from './contextResourceUsed.js';
@@ -46,6 +60,7 @@ export * from './contextResourceWindow.js';
 export * from './createChannelRequestBody.js';
 export * from './createChannelRequestBodyAllowFrom.js';
 export * from './createChannelRequestBodyCredentials.js';
+export * from './createChannelRequestBodySenderPolicy.js';
 export * from './createThreadRequestBody.js';
 export * from './createThreadRequestBodyApprovalMode.js';
 export * from './credentialFieldResource.js';
@@ -79,6 +94,7 @@ export * from './listChannelsParams.js';
 export * from './listEarlierItemsParams.js';
 export * from './listThreadsParams.js';
 export * from './loginResource.js';
+export * from './loginResourceStatus.js';
 export * from './modelListResponseBody.js';
 export * from './modelListResponseBodyModels.js';
 export * from './modelResource.js';

package/dist/generated/assistant/models/index.js

@@ -31,14 +31,28 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
 export * from './answerRequestBody.js';
 export * from './answerRequestBodyAnswers.js';
 export * from './attachmentResource.js';
+export * from './bindingCodeResponseBody.js';
 export * from './bindingResource.js';
+export * from './bindingResourceConnState.js';
+export * from './bindingResourceStatus.js';
 export * from './bindingResourceVerifiedAt.js';
 export * from './channelResource.js';
 export * from './channelResourceAllowFrom.js';
+export * from './channelResourceConnState.js';
+export * from './channelResourceRuntimeState.js';
+export * from './channelResourceSenderPolicy.js';
+export * from './channelResourceStatus.js';
 export * from './channelResourceWebhookUrl.js';
+export * from './channelWithSecretResponseBody.js';
+export * from './channelWithSecretResponseBodyAllowFrom.js';
+export * from './channelWithSecretResponseBodyConnState.js';
+export * from './channelWithSecretResponseBodyRuntimeState.js';
+export * from './channelWithSecretResponseBodySenderPolicy.js';
+export * from './channelWithSecretResponseBodyStatus.js';
+export * from './channelWithSecretResponseBodyWebhookSecret.js';
+export * from './channelWithSecretResponseBodyWebhookUrl.js';
 export * from './checkSenderParams.js';
 export * from './choice.js';
-export * from './claimCodeResponseBody.js';
 export * from './contextResource.js';
 export * from './contextResourceCompactAt.js';
 export * from './contextResourceUsed.js';
@@ -46,6 +60,7 @@ export * from './contextResourceWindow.js';
 export * from './createChannelRequestBody.js';
 export * from './createChannelRequestBodyAllowFrom.js';
 export * from './createChannelRequestBodyCredentials.js';
+export * from './createChannelRequestBodySenderPolicy.js';
 export * from './createThreadRequestBody.js';
 export * from './createThreadRequestBodyApprovalMode.js';
 export * from './credentialFieldResource.js';
@@ -79,6 +94,7 @@ export * from './listChannelsParams.js';
 export * from './listEarlierItemsParams.js';
 export * from './listThreadsParams.js';
 export * from './loginResource.js';
+export * from './loginResourceStatus.js';
 export * from './modelListResponseBody.js';
 export * from './modelListResponseBodyModels.js';
 export * from './modelResource.js';

package/dist/generated/assistant/models/itemResourceStatus.d.ts

@@ -35,5 +35,5 @@ export declare const ItemResourceStatus: {
     readonly completed: "completed";
     readonly failed: "failed";
     readonly declined: "declined";
-    readonly aborted: "aborted";
+    readonly interrupted: "interrupted";
 };

package/dist/generated/assistant/models/itemResourceStatus.js

@@ -35,5 +35,5 @@ export const ItemResourceStatus = {
     completed: 'completed',
     failed: 'failed',
     declined: 'declined',
-    aborted: 'aborted',
+    interrupted: 'interrupted',
 };

package/dist/generated/assistant/models/itemResourceType.d.ts

@@ -39,4 +39,5 @@ export declare const ItemResourceType: {
     readonly dynamic_tool_call: "dynamic_tool_call";
     readonly context_compaction: "context_compaction";
     readonly token_budget_reminder: "token_budget_reminder";
+    readonly turn_failure: "turn_failure";
 };

package/dist/generated/assistant/models/itemResourceType.js

@@ -36,4 +36,5 @@ export const ItemResourceType = {
     dynamic_tool_call: 'dynamic_tool_call',
     context_compaction: 'context_compaction',
     token_budget_reminder: 'token_budget_reminder',
+    turn_failure: 'turn_failure',
 };

package/dist/generated/assistant/models/loginResource.d.ts

@@ -28,11 +28,14 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
 - 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
  * OpenAPI spec version: 1.0.0
  */
+import type { LoginResourceStatus } from './loginResourceStatus.js';
 export interface LoginResource {
+    /** 这条登录流的截止时间。到点之后不要再轮询，重新发起一次 */
     expiresAt: string;
     id: string;
-    qrcode: string;
+    /** 二维码图片内容，直接作为 <img> 的 src 使用。码过期时这条流会自己换一张接着等，所以每次轮询拿到的可能是新的一张 */
     qrcodeData: string;
+    /** 失败原因。仅在 status 为 error 或 expired 时有内容 */
     reason: string;
-    status: string;
+    status: LoginResourceStatus;
 }

package/dist/generated/assistant/models/loginResource.js

@@ -1,31 +1 @@
-/**
- * Generated by orval v7.21.0 🍺
- * Do not edit manually.
- * Leaflow Assistant 用户 API
- * 控制台里的 AI 助手：对话、消息、工具调用与审批、附件，以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
-
-## 一次对话
-
-1. `POST /v1/threads` 创建对话；
-2. `POST /v1/threads/{thread}/messages` 发送消息，立即返回 `turnId`，助手的执行在后台进行；
-3. `GET /v1/threads/{thread}` 取回对话文档用于渲染，并按其中的 `stream` 连上实时输出；
-4. 助手需要用户参与时，文档中的 `wait` 会说明是哪一种：审批一批工具调用（`POST /v1/threads/{thread}/approvals/{batch}`），或回答几个问题（`POST /v1/threads/{thread}/questions/{item}`）。处理完成后助手自动继续。
-
-发送图片分两步：先 `POST /v1/attachments` 上传拿到 id，发送消息时放进 `attachmentIds`。
-
-## 实时输出
-
-```
-GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
-```
-
-这是一条 Server-Sent Events 流，因此不在下方的接口列表中。
-
-- `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径，按取回文档的地址解析；
-- `cursor` 是起始位置，取自对话文档的 `cursor`。不传则从可用范围的开头开始；
-- 推送的每一条都是对那份对话文档的一次增量编辑，套用同一套渲染逻辑即可；
-- 连接有生存期，到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传，无需额外处理；
-- 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
- * OpenAPI spec version: 1.0.0
- */
 export {};

package/dist/generated/assistant/models/loginResourceStatus.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Leaflow Assistant 用户 API
+ * 控制台里的 AI 助手：对话、消息、工具调用与审批、附件，以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
+
+## 一次对话
+
+1. `POST /v1/threads` 创建对话；
+2. `POST /v1/threads/{thread}/messages` 发送消息，立即返回 `turnId`，助手的执行在后台进行；
+3. `GET /v1/threads/{thread}` 取回对话文档用于渲染，并按其中的 `stream` 连上实时输出；
+4. 助手需要用户参与时，文档中的 `wait` 会说明是哪一种：审批一批工具调用（`POST /v1/threads/{thread}/approvals/{batch}`），或回答几个问题（`POST /v1/threads/{thread}/questions/{item}`）。处理完成后助手自动继续。
+
+发送图片分两步：先 `POST /v1/attachments` 上传拿到 id，发送消息时放进 `attachmentIds`。
+
+## 实时输出
+
+```
+GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
+```
+
+这是一条 Server-Sent Events 流，因此不在下方的接口列表中。
+
+- `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径，按取回文档的地址解析；
+- `cursor` 是起始位置，取自对话文档的 `cursor`。不传则从可用范围的开头开始；
+- 推送的每一条都是对那份对话文档的一次增量编辑，套用同一套渲染逻辑即可；
+- 连接有生存期，到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传，无需额外处理；
+- 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
+ * OpenAPI spec version: 1.0.0
+ */
+export type LoginResourceStatus = typeof LoginResourceStatus[keyof typeof LoginResourceStatus];
+export declare const LoginResourceStatus: {
+    readonly wait: "wait";
+    readonly scanned: "scanned";
+    readonly confirmed: "confirmed";
+    readonly expired: "expired";
+    readonly error: "error";
+    readonly need_verify_code: "need_verify_code";
+};

package/dist/generated/assistant/models/loginResourceStatus.js

@@ -0,0 +1,39 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Leaflow Assistant 用户 API
+ * 控制台里的 AI 助手：对话、消息、工具调用与审批、附件，以及把助手接到微信、飞书、Telegram 等即时通讯平台上。
+
+## 一次对话
+
+1. `POST /v1/threads` 创建对话；
+2. `POST /v1/threads/{thread}/messages` 发送消息，立即返回 `turnId`，助手的执行在后台进行；
+3. `GET /v1/threads/{thread}` 取回对话文档用于渲染，并按其中的 `stream` 连上实时输出；
+4. 助手需要用户参与时，文档中的 `wait` 会说明是哪一种：审批一批工具调用（`POST /v1/threads/{thread}/approvals/{batch}`），或回答几个问题（`POST /v1/threads/{thread}/questions/{item}`）。处理完成后助手自动继续。
+
+发送图片分两步：先 `POST /v1/attachments` 上传拿到 id，发送消息时放进 `attachmentIds`。
+
+## 实时输出
+
+```
+GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
+```
+
+这是一条 Server-Sent Events 流，因此不在下方的接口列表中。
+
+- `path` 与 `ticket` 都取自对话文档的 `stream`。`path` 是相对路径，按取回文档的地址解析；
+- `cursor` 是起始位置，取自对话文档的 `cursor`。不传则从可用范围的开头开始；
+- 推送的每一条都是对那份对话文档的一次增量编辑，套用同一套渲染逻辑即可；
+- 连接有生存期，到时会正常关闭。使用 `EventSource` 时浏览器会自动携带 `Last-Event-ID` 重连并从断点续传，无需额外处理；
+- 三种结束事件：`done` 本次 turn 完成（附带最终状态）、`paused` 助手在等待用户处理（重新取回对话文档读 `wait`）、`stalled` 执行已中断且不会恢复，不要重连。
+ * OpenAPI spec version: 1.0.0
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const LoginResourceStatus = {
+    wait: 'wait',
+    scanned: 'scanned',
+    confirmed: 'confirmed',
+    expired: 'expired',
+    error: 'error',
+    need_verify_code: 'need_verify_code',
+};

package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.d.ts

@@ -33,6 +33,6 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
  */
 export type UpdateChannelRequestBodySenderPolicy = typeof UpdateChannelRequestBodySenderPolicy[keyof typeof UpdateChannelRequestBodySenderPolicy];
 export declare const UpdateChannelRequestBodySenderPolicy: {
-    readonly BOUND_ONLY: "BOUND_ONLY";
-    readonly OPEN: "OPEN";
+    readonly bound_only: "bound_only";
+    readonly open: "open";
 };

package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.js

@@ -30,6 +30,6 @@ GET /v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
  */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const UpdateChannelRequestBodySenderPolicy = {
-    BOUND_ONLY: 'BOUND_ONLY',
-    OPEN: 'OPEN',
+    bound_only: 'bound_only',
+    open: 'open',
 };

package/dist/generated/tunnel/index.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Leaflow 隧道用户 API
+ * Leaflow 隧道的用户接口，用于开通与管理项目的加速隧道、订阅地址和流量用量。
+
+## 身份与鉴权
+
+每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌，再用它向 IAM 换取项目令牌（`POST /api/v1/projects/{projectId}/token`）。一张项目令牌同时说明当前用户和当前项目。
+
+**路径和请求头上都没有 `project_id`**：当前项目由令牌决定。
+
+鉴权在网关完成，失败的请求不会到达这些接口。按错误码区分处理方式：`TOKEN_MISSING` 表示没带令牌；`TOKEN_EXPIRED` 表示令牌过期，用账号令牌重新换取即可，无需重新登录；`TOKEN_INVALID` 表示令牌验不过；`NOT_A_MEMBER` 表示当前账号不是该项目成员；`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
+
+## 通用约定
+
+- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`，不带 id。已经有一条时再开通会被拒绝（`TUNNEL_ALREADY_OPEN`）。
+- **订阅地址是凭据。** 它等同于密码，只由 `GET /tunnel/subscription` 单独返回，不出现在隧道详情或任何列表里。怀疑泄露时用重置接口，它会让已分发的每一份订阅立即失效。
+- **停用不是退订。** 停用保留端口和订阅地址，重新启用后原样回来；退订不可逆，重新开通得到的是全新的地址。
+- **判断超额只看 `billed_bytes`。** 线路可以设置倍率（如 1.5× 或 0×），`raw_bytes` 是实际传输量，两者不一定相等。
+- **用量最多滞后一个采集周期。** 适合用量管控，不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存，`usage.synced_at` 说明它有多旧。
+- **换套餐不是瞬时的。** 多出来的线路马上可用，少掉的那些有宽限期，到期才真正释放。
+ * OpenAPI spec version: 1.0.0
+ */
+import type { ActOnTunnelRequestBody, ChangeTunnelPlanRequestBody, LengthAwarePageOperationLogResource, ListTunnelOperationLogsParams, ListTunnelUsageSeriesParams, OpenTunnelRequestBody, SubscriptionResource, TunnelPlanListResponseBody, TunnelResource, UpdateTunnelProfileRequestBody, UsageResource, UsageSeriesResource } from './models/index.js';
+import { request } from '../../http.js';
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+/**
+* 记录每一次**写**操作：谁、什么时候、做了什么、成功还是失败。读操作不记录。
+
+`actor` 为 null 表示该操作由平台执行（例如自动重试删除、项目停服）——平台做了什么是看得到的，但具体是哪位运营人员不会展示。
+
+`payload` 只包含路径参数与查询串，且其中像凭据的字段已被替换为占位符。
+* @summary 查看本项目的操作日志
+*/
+export declare const listTunnelOperationLogs: (params?: ListTunnelOperationLogsParams, options?: SecondParameter<typeof request<LengthAwarePageOperationLogResource>>) => Promise<LengthAwarePageOperationLogResource>;
+/**
+ * 只返回在售的套餐，按 `sort` 升序。已下架的不在其中——但正在用它的隧道仍然正常，下架只是不再接新单。
+
+`quota_bytes` 是套餐**标称**的额度，仅供比较；实际额度由上游按线路分组决定，以隧道用量接口返回的 `quota_bytes` 为准。
+ * @summary 列出可开通的套餐
+ */
+export declare const listTunnelPlans: (options?: SecondParameter<typeof request<TunnelPlanListResponseBody>>) => Promise<TunnelPlanListResponseBody>;
+/**
+ * **不可逆。** 上游账户会被删除，订阅地址立刻失效，重新开通得到的是一条全新的隧道和一条全新的订阅地址。
+
+删除是异步的：返回时 `status` 可能仍是 `deleting`，表示上游还没删干净（通常是某台服务器暂时连不上）。平台会自动重试，期间这条隧道仍然出现在查询接口里。退订完成前无法重新开通。
+
+只是暂时不用的话请用停用，它保留端口和订阅地址。
+ * @summary 退订隧道
+ */
+export declare const closeTunnel: (options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * 每个项目最多一条隧道。尚未开通时返回 404（`TUNNEL_NOT_FOUND`）。
+
+响应里的 `usage` 是**缓存**的用量，`usage.synced_at` 说明它是什么时候采集的；为 null 表示尚未采集过，而不是用量为零。需要当前值请调用量接口。
+
+**订阅地址不在这里**，它是一条长期有效的凭据，只由订阅接口单独返回。
+ * @summary 查看本项目的隧道
+ */
+export declare const getTunnel: (options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * 改显示名和联系邮箱，**不影响订阅、用量或线路**。
+
+`email` 不传表示不改动，传空字符串表示清空。它会被转发给上游面板——上游拿它做什么由面板决定，平台不使用它。
+ * @summary 修改隧道的显示信息
+ */
+export declare const updateTunnelProfile: (updateTunnelProfileRequestBody: UpdateTunnelProfileRequestBody, options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * 为当前项目开通一条隧道，返回时订阅通常处于 `preparing`——节点仍在下发，但**订阅地址此时已经可用**，内容会在拉取那一刻按当时的状态重新派生。
+
+一个项目只能有一条。已经有了返回 `TUNNEL_ALREADY_OPEN`；上一条还在退订中返回 `TUNNEL_CLOSING`，稍后重试即可。
+
+套餐必须处于在售状态，已下架的返回 `TUNNEL_PLAN_RETIRED`。若返回 `TUNNEL_PLAN_GROUPS_MISSING`，说明该套餐在上游对应的线路分组不存在——这是一个配置问题，请联系运营，换一款套餐或稍后重试都不会有帮助。
+ * @summary 开通隧道
+ */
+export declare const openTunnel: (openTunnelRequestBody: OpenTunnelRequestBody, options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * **停用不是退订。** 停用会把这条隧道的实例从上游调度器撤下，但端口保留，重新启用后原样回来，订阅地址也不变。适合「这段时间不用」。
+
+被平台停用的隧道（`suspended` 为 true）无法自行启用，会返回 `TUNNEL_SUSPENDED`——那通常是欠费或违规，需要先处理对应的问题。
+ * @summary 启用或停用隧道
+ */
+export declare const actOnTunnel: (actOnTunnelRequestBody: ActOnTunnelRequestBody, options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * 换套餐会立刻重判线路资格：多出来的线路马上可用，**少掉的那些进入删除队列——宽限期内照常可用，到期才真正释放**。所以换套餐不是一次瞬时切换，订阅内容会在接下来一段时间内变化。
+
+换完之后建议重新拉取一次订阅。
+ * @summary 更换套餐
+ */
+export declare const changeTunnelPlan: (changeTunnelPlanRequestBody: ChangeTunnelPlanRequestBody, options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * **返回的是一条长期有效的凭据，等同于密码。** 拿到它就能取得本项目全部节点与密码，请勿转发、截图或提交到工单。
+
+它不会出现在隧道详情或任何列表里，只由这个接口返回。
+
+`status` 为 `preparing` 时链接**照样可用**，内容会在拉取那一刻按当时的状态重新派生。
+
+怀疑泄露时请调用重置接口。
+ * @summary 获取订阅地址
+ */
+export declare const getTunnelSubscription: (options?: SecondParameter<typeof request<SubscriptionResource>>) => Promise<SubscriptionResource>;
+/**
+ * **这是凭据泄露时的处置手段，会让已分发出去的每一份订阅立即失效。**
+
+订阅 token 和节点密码同时更换，所有客户端都必须重新拉取一次订阅才能继续使用。调用前请确认这确实是想要的结果。
+
+重置后再调订阅接口取新地址。
+ * @summary 重置订阅地址与节点密码
+ */
+export declare const rotateTunnelSubscription: (options?: SecondParameter<typeof request<TunnelResource>>) => Promise<TunnelResource>;
+/**
+ * 现场向上游查询，比隧道详情里那份缓存新。
+
+**判断是否超额只看 `billed_bytes`**：线路可以设置倍率（如 1.5× 或 0×），`raw_bytes` 是实际传输量，两者不一定相等。`over_quota` 已经算好。
+
+用量由上游定期采集，**最多滞后一个采集周期**，适合用量管控，不适合作为计费结算依据。
+ * @summary 查看本期用量
+ */
+export declare const getTunnelUsage: (options?: SecondParameter<typeof request<UsageResource>>) => Promise<UsageResource>;
+/**
+ * 按**自然日**切分，用于画趋势图。
+
+**没有流量的日子不会出现在结果里**（不补零），画图前需要自行补齐日期轴，否则空档会被连成一条斜线。
+
+**把这里的天加起来不等于本期用量**，这是有意的：本期用量按计费周期切，而且「重置本期用量」只作用于本期，日汇总一行都不删。两者回答的是不同的问题。
+ * @summary 查看按天用量
+ */
+export declare const listTunnelUsageSeries: (params?: ListTunnelUsageSeriesParams, options?: SecondParameter<typeof request<UsageSeriesResource>>) => Promise<UsageSeriesResource>;
+export type ListTunnelOperationLogsResult = NonNullable<Awaited<ReturnType<typeof listTunnelOperationLogs>>>;
+export type ListTunnelPlansResult = NonNullable<Awaited<ReturnType<typeof listTunnelPlans>>>;
+export type CloseTunnelResult = NonNullable<Awaited<ReturnType<typeof closeTunnel>>>;
+export type GetTunnelResult = NonNullable<Awaited<ReturnType<typeof getTunnel>>>;
+export type UpdateTunnelProfileResult = NonNullable<Awaited<ReturnType<typeof updateTunnelProfile>>>;
+export type OpenTunnelResult = NonNullable<Awaited<ReturnType<typeof openTunnel>>>;
+export type ActOnTunnelResult = NonNullable<Awaited<ReturnType<typeof actOnTunnel>>>;
+export type ChangeTunnelPlanResult = NonNullable<Awaited<ReturnType<typeof changeTunnelPlan>>>;
+export type GetTunnelSubscriptionResult = NonNullable<Awaited<ReturnType<typeof getTunnelSubscription>>>;
+export type RotateTunnelSubscriptionResult = NonNullable<Awaited<ReturnType<typeof rotateTunnelSubscription>>>;
+export type GetTunnelUsageResult = NonNullable<Awaited<ReturnType<typeof getTunnelUsage>>>;
+export type ListTunnelUsageSeriesResult = NonNullable<Awaited<ReturnType<typeof listTunnelUsageSeries>>>;
+export {};

package/dist/generated/tunnel/index.js

@@ -0,0 +1,149 @@
+import { request } from '../../http.js';
+/**
+* 记录每一次**写**操作：谁、什么时候、做了什么、成功还是失败。读操作不记录。
+
+`actor` 为 null 表示该操作由平台执行（例如自动重试删除、项目停服）——平台做了什么是看得到的，但具体是哪位运营人员不会展示。
+
+`payload` 只包含路径参数与查询串，且其中像凭据的字段已被替换为占位符。
+* @summary 查看本项目的操作日志
+*/
+export const listTunnelOperationLogs = (params, options) => {
+    return request({ url: `/api/v1/operation-logs`, method: 'GET',
+        params
+    }, options);
+};
+/**
+ * 只返回在售的套餐，按 `sort` 升序。已下架的不在其中——但正在用它的隧道仍然正常，下架只是不再接新单。
+
+`quota_bytes` 是套餐**标称**的额度，仅供比较；实际额度由上游按线路分组决定，以隧道用量接口返回的 `quota_bytes` 为准。
+ * @summary 列出可开通的套餐
+ */
+export const listTunnelPlans = (options) => {
+    return request({ url: `/api/v1/plans`, method: 'GET'
+    }, options);
+};
+/**
+ * **不可逆。** 上游账户会被删除，订阅地址立刻失效，重新开通得到的是一条全新的隧道和一条全新的订阅地址。
+
+删除是异步的：返回时 `status` 可能仍是 `deleting`，表示上游还没删干净（通常是某台服务器暂时连不上）。平台会自动重试，期间这条隧道仍然出现在查询接口里。退订完成前无法重新开通。
+
+只是暂时不用的话请用停用，它保留端口和订阅地址。
+ * @summary 退订隧道
+ */
+export const closeTunnel = (options) => {
+    return request({ url: `/api/v1/tunnel`, method: 'DELETE'
+    }, options);
+};
+/**
+ * 每个项目最多一条隧道。尚未开通时返回 404（`TUNNEL_NOT_FOUND`）。
+
+响应里的 `usage` 是**缓存**的用量，`usage.synced_at` 说明它是什么时候采集的；为 null 表示尚未采集过，而不是用量为零。需要当前值请调用量接口。
+
+**订阅地址不在这里**，它是一条长期有效的凭据，只由订阅接口单独返回。
+ * @summary 查看本项目的隧道
+ */
+export const getTunnel = (options) => {
+    return request({ url: `/api/v1/tunnel`, method: 'GET'
+    }, options);
+};
+/**
+ * 改显示名和联系邮箱，**不影响订阅、用量或线路**。
+
+`email` 不传表示不改动，传空字符串表示清空。它会被转发给上游面板——上游拿它做什么由面板决定，平台不使用它。
+ * @summary 修改隧道的显示信息
+ */
+export const updateTunnelProfile = (updateTunnelProfileRequestBody, options) => {
+    return request({ url: `/api/v1/tunnel`, method: 'PATCH',
+        headers: { 'Content-Type': 'application/json', },
+        data: updateTunnelProfileRequestBody
+    }, options);
+};
+/**
+ * 为当前项目开通一条隧道，返回时订阅通常处于 `preparing`——节点仍在下发，但**订阅地址此时已经可用**，内容会在拉取那一刻按当时的状态重新派生。
+
+一个项目只能有一条。已经有了返回 `TUNNEL_ALREADY_OPEN`；上一条还在退订中返回 `TUNNEL_CLOSING`，稍后重试即可。
+
+套餐必须处于在售状态，已下架的返回 `TUNNEL_PLAN_RETIRED`。若返回 `TUNNEL_PLAN_GROUPS_MISSING`，说明该套餐在上游对应的线路分组不存在——这是一个配置问题，请联系运营，换一款套餐或稍后重试都不会有帮助。
+ * @summary 开通隧道
+ */
+export const openTunnel = (openTunnelRequestBody, options) => {
+    return request({ url: `/api/v1/tunnel`, method: 'POST',
+        headers: { 'Content-Type': 'application/json', },
+        data: openTunnelRequestBody
+    }, options);
+};
+/**
+ * **停用不是退订。** 停用会把这条隧道的实例从上游调度器撤下，但端口保留，重新启用后原样回来，订阅地址也不变。适合「这段时间不用」。
+
+被平台停用的隧道（`suspended` 为 true）无法自行启用，会返回 `TUNNEL_SUSPENDED`——那通常是欠费或违规，需要先处理对应的问题。
+ * @summary 启用或停用隧道
+ */
+export const actOnTunnel = (actOnTunnelRequestBody, options) => {
+    return request({ url: `/api/v1/tunnel/actions`, method: 'POST',
+        headers: { 'Content-Type': 'application/json', },
+        data: actOnTunnelRequestBody
+    }, options);
+};
+/**
+ * 换套餐会立刻重判线路资格：多出来的线路马上可用，**少掉的那些进入删除队列——宽限期内照常可用，到期才真正释放**。所以换套餐不是一次瞬时切换，订阅内容会在接下来一段时间内变化。
+
+换完之后建议重新拉取一次订阅。
+ * @summary 更换套餐
+ */
+export const changeTunnelPlan = (changeTunnelPlanRequestBody, options) => {
+    return request({ url: `/api/v1/tunnel/plan`, method: 'PUT',
+        headers: { 'Content-Type': 'application/json', },
+        data: changeTunnelPlanRequestBody
+    }, options);
+};
+/**
+ * **返回的是一条长期有效的凭据，等同于密码。** 拿到它就能取得本项目全部节点与密码，请勿转发、截图或提交到工单。
+
+它不会出现在隧道详情或任何列表里，只由这个接口返回。
+
+`status` 为 `preparing` 时链接**照样可用**，内容会在拉取那一刻按当时的状态重新派生。
+
+怀疑泄露时请调用重置接口。
+ * @summary 获取订阅地址
+ */
+export const getTunnelSubscription = (options) => {
+    return request({ url: `/api/v1/tunnel/subscription`, method: 'GET'
+    }, options);
+};
+/**
+ * **这是凭据泄露时的处置手段，会让已分发出去的每一份订阅立即失效。**
+
+订阅 token 和节点密码同时更换，所有客户端都必须重新拉取一次订阅才能继续使用。调用前请确认这确实是想要的结果。
+
+重置后再调订阅接口取新地址。
+ * @summary 重置订阅地址与节点密码
+ */
+export const rotateTunnelSubscription = (options) => {
+    return request({ url: `/api/v1/tunnel/subscription/rotate`, method: 'POST'
+    }, options);
+};
+/**
+ * 现场向上游查询，比隧道详情里那份缓存新。
+
+**判断是否超额只看 `billed_bytes`**：线路可以设置倍率（如 1.5× 或 0×），`raw_bytes` 是实际传输量，两者不一定相等。`over_quota` 已经算好。
+
+用量由上游定期采集，**最多滞后一个采集周期**，适合用量管控，不适合作为计费结算依据。
+ * @summary 查看本期用量
+ */
+export const getTunnelUsage = (options) => {
+    return request({ url: `/api/v1/tunnel/usage`, method: 'GET'
+    }, options);
+};
+/**
+ * 按**自然日**切分，用于画趋势图。
+
+**没有流量的日子不会出现在结果里**（不补零），画图前需要自行补齐日期轴，否则空档会被连成一条斜线。
+
+**把这里的天加起来不等于本期用量**，这是有意的：本期用量按计费周期切，而且「重置本期用量」只作用于本期，日汇总一行都不删。两者回答的是不同的问题。
+ * @summary 查看按天用量
+ */
+export const listTunnelUsageSeries = (params, options) => {
+    return request({ url: `/api/v1/tunnel/usage/series`, method: 'GET',
+        params
+    }, options);
+};