@leaflow/sdk 0.0.0-dev.25.g6c5751f → 0.0.0-dev.250.g6df166c

package/README.md

@@ -7,7 +7,7 @@ Leaflow 平台的 TypeScript SDK(`@leaflow/sdk`),由
 npm i @leaflow/sdk openapi-fetch
 ```
 
-当前只含类型。请求由 `openapi-fetch` 发出,路径与参数由契约约束。
+包含 Node.js 可用的 JavaScript 客户端和 TypeScript 类型。请求由 `openapi-fetch` 发出，路径与参数由契约约束。
 
 ```ts
 import createClient from 'openapi-fetch';
@@ -32,3 +32,24 @@ npm run generate
 ```
 
 契约版本记在 `CONTRACTS_REF`。
+
+## Billing
+
+Billing 按职能分为三个子包,三者地址相同,凭据各不相同:
+
+```ts
+import { billing } from "@leaflow/sdk";
+
+// 公开目录与估价,无需凭据
+const catalog = billing.catalog.client();
+// 计费账户、充值、账单,使用 access token
+const account = billing.account.client({ headers });
+// 项目的支出与订单,使用 scoped token
+const project = billing.project.client({ headers });
+```
+
+也可按子路径单独导入,例如 `@leaflow/sdk/billing/catalog/v1`。
+
+公共目录、账户和项目接口使用 `@leaflow/sdk`，运营管理接口使用 `@leaflow/sdk-admin`。服务间 Proto 使用独立的 `@leaflow/billing` 包。
+
+本地契约可通过 `CONTRACTS_DIR=/absolute/path/to/contracts npm run generate` 生成。发布时将契约提交号写入 `CONTRACTS_REF`，再使用默认生成命令。

package/dist/account/v1/client.d.ts

@@ -0,0 +1,4 @@
+import { type ClientOptions } from "openapi-fetch";
+import type { paths } from "./schema.js";
+/** A client for the account service. Pass baseUrl to override the address. */
+export declare function client(options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;

package/dist/account/v1/client.js

@@ -0,0 +1,7 @@
+// Code generated from the contract's servers[0]. DO NOT EDIT.
+import createClient, {} from "openapi-fetch";
+const defaultBaseUrl = "https://account.leaflow.cloud";
+/** A client for the account service. Pass baseUrl to override the address. */
+export function client(options = {}) {
+    return createClient({ baseUrl: defaultBaseUrl, ...options });
+}

package/dist/account/v1/index.d.ts

@@ -1,44 +1,55 @@
 export type { paths, components, operations, webhooks } from "./schema.js";
+export { client } from "./client.js";
 import type { operations } from "./schema.js";
-/** `GET /account/v1/settings` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/settings`. */
 export type GetSettingsResult = operations["get-settings"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/agreements` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/locales`. */
+export type ListLocalesResult = operations["list-locales"]["responses"][200]["content"]["application/json"];
+/** The success response body of `GET /account/v1/agreements`. */
 export type ListAgreementsResult = operations["list-agreements"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/me/consents` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/me/consents`. */
 export type ListConsentsResult = operations["list-consents"]["responses"][200]["content"]["application/json"];
-/** `POST /account/v1/me/consents` 成功时的响应体。 */
+/** The success response body of `POST /account/v1/me/consents`. */
 export type AcceptAgreementsResult = operations["accept-agreements"]["responses"][200]["content"]["application/json"];
-/** `POST /account/v1/me/consents` 的请求体。 */
+/** The request body of `POST /account/v1/me/consents`. */
 export type AcceptAgreementsBody = NonNullable<operations["accept-agreements"]["requestBody"]>["content"]["application/json"];
-/** `POST /account/v1/register` 成功时的响应体。 */
+/** The success response body of `POST /account/v1/register`. */
 export type RegisterResult = operations["register"]["responses"][201]["content"]["application/json"];
-/** `POST /account/v1/register` 的请求体。 */
+/** The request body of `POST /account/v1/register`. */
 export type RegisterBody = NonNullable<operations["register"]["requestBody"]>["content"]["application/json"];
-/** `GET /account/v1/me` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/me`. */
 export type GetAccountResult = operations["get-account"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/me/identity-verification` 成功时的响应体。 */
+/** The success response body of `PATCH /account/v1/me`. */
+export type UpdateAccountResult = operations["update-account"]["responses"][200]["content"]["application/json"];
+/** The request body of `PATCH /account/v1/me`. */
+export type UpdateAccountBody = NonNullable<operations["update-account"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `GET /account/v1/me/identity-verification`. */
 export type GetIdentityVerificationResult = operations["get-identity-verification"]["responses"][200]["content"]["application/json"];
-/** `POST /account/v1/me/identity-verification` 成功时的响应体。 */
+/** The success response body of `POST /account/v1/me/identity-verification`. */
 export type SubmitIdentityVerificationResult = operations["submit-identity-verification"]["responses"][202]["content"]["application/json"];
-/** `POST /account/v1/me/identity-verification` 的请求体。 */
+/** The request body of `POST /account/v1/me/identity-verification`. */
 export type SubmitIdentityVerificationBody = NonNullable<operations["submit-identity-verification"]["requestBody"]>["content"]["application/json"];
-/** `GET /account/v1/me/invitations` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/me/invitations`. */
 export type ListMyInvitationsResult = operations["list-my-invitations"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/me/invitations` 的查询参数。 */
+/** The query parameters of `GET /account/v1/me/invitations`. */
 export type ListMyInvitationsQuery = operations["list-my-invitations"]["parameters"]["query"];
-/** `POST /account/v1/me/invitations/accept` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/invitations/by-token`. */
+export type PreviewInvitationByTokenResult = operations["preview-invitation-by-token"]["responses"][200]["content"]["application/json"];
+/** The query parameters of `GET /account/v1/invitations/by-token`. */
+export type PreviewInvitationByTokenQuery = operations["preview-invitation-by-token"]["parameters"]["query"];
+/** The success response body of `POST /account/v1/me/invitations/accept`. */
 export type AcceptInvitationByTokenResult = operations["accept-invitation-by-token"]["responses"][200]["content"]["application/json"];
-/** `POST /account/v1/me/invitations/accept` 的请求体。 */
+/** The request body of `POST /account/v1/me/invitations/accept`. */
 export type AcceptInvitationByTokenBody = NonNullable<operations["accept-invitation-by-token"]["requestBody"]>["content"]["application/json"];
-/** `POST /account/v1/me/invitations/{invitationId}/accept` 成功时的响应体。 */
+/** The success response body of `POST /account/v1/me/invitations/{invitationId}/accept`. */
 export type AcceptInvitationResult = operations["accept-invitation"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/projects` 成功时的响应体。 */
+/** The success response body of `GET /account/v1/projects`. */
 export type ListProjectsResult = operations["list-projects"]["responses"][200]["content"]["application/json"];
-/** `GET /account/v1/projects` 的查询参数。 */
+/** The query parameters of `GET /account/v1/projects`. */
 export type ListProjectsQuery = operations["list-projects"]["parameters"]["query"];
-/** `POST /account/v1/projects` 成功时的响应体。 */
+/** The success response body of `POST /account/v1/projects`. */
 export type CreateProjectResult = operations["create-project"]["responses"][201]["content"]["application/json"];
-/** `POST /account/v1/projects` 的请求体。 */
+/** The request body of `POST /account/v1/projects`. */
 export type CreateProjectBody = NonNullable<operations["create-project"]["requestBody"]>["content"]["application/json"];
-/** `POST /account/v1/projects/{projectId}/token` 成功时的响应体。 */
-export type ExchangeProjectTokenResult = operations["exchange-project-token"]["responses"][201]["content"]["application/json"];
+/** The success response body of `POST /account/v1/projects/{projectId}/scoped-tokens`. */
+export type CreateScopedTokenResult = operations["create-scoped-token"]["responses"][201]["content"]["application/json"];

package/dist/account/v1/index.js

@@ -1,5 +1,5 @@
-// 由 scripts/generate-ts.mjs 生成，不要手改。
+// Code generated by scripts/generate.mjs. DO NOT EDIT.
 //
-// 别名把 operations[...] 那串下标换成一个名字。原始的 paths / components / operations 也
-// 一并导出：paths 是给 openapi-fetch 的 createClient<paths>() 用的。
-export {};
+// The aliases replace the operations[...] subscript chain with a name. The raw paths /
+// components / operations are exported as well: paths is what createClient<paths>() takes.
+export { client } from "./client.js";