@leaflow/sdk 0.84.0 → 0.84.2

package/dist/billing/v1/schema.d.ts

@@ -350,7 +350,16 @@ export interface components {
         };
         /** @description Immutable platform service identifier, such as compute, canopy or assistant. */
         ProductID: string;
-        /** @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id. */
+        /**
+         * @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id.
+         *
+         *     A line that gives a meter, `dimensions` or `duration_seconds` estimates usage and is
+         *     priced only at a postpaid price. Such a line is refused with HTTP 400
+         *     `BILLING_PURCHASE_INVALID` when `price_type` is `prepaid` or `one_time`, or when the price
+         *     it names is not postpaid; `meta.field` is `price_type`, `price_id` or `price_lookup_key`
+         *     accordingly. When the plan has no postpaid price, the line is returned unpriced with
+         *     `no_price`.
+         */
         QuoteLine: {
             price_lookup_key?: string;
             plan_lookup_key?: string;
@@ -387,7 +396,8 @@ export interface components {
             /**
              * Format: int64
              * @description For metered items, how long to price for. This allows an estimate such as "about
-             *     this much per month" to be shown before anything exists.
+             *     this much per month" to be shown before anything exists. The priced quantity is
+             *     `quantity` multiplied by this duration.
              */
             duration_seconds?: number;
         };
@@ -451,6 +461,10 @@ export interface components {
             price_id?: string;
             plan_name?: string;
             unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description The quantity actually priced. When `duration_seconds` is given, it is the requested
+             *     `quantity` multiplied by that duration.
+             */
             quantity?: string;
             /** @description Not rounded. Round only for display. */
             amount?: components["schemas"]["Money"];

package/dist/billingaccount/v1/schema.d.ts

@@ -1270,7 +1270,16 @@ export interface components {
             /** Format: int64 */
             total_count?: number;
         };
-        /** @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id. */
+        /**
+         * @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id.
+         *
+         *     A line that gives a meter, `dimensions` or `duration_seconds` estimates usage and is
+         *     priced only at a postpaid price. Such a line is refused with HTTP 400
+         *     `BILLING_PURCHASE_INVALID` when `price_type` is `prepaid` or `one_time`, or when the price
+         *     it names is not postpaid; `meta.field` is `price_type`, `price_id` or `price_lookup_key`
+         *     accordingly. When the plan has no postpaid price, the line is returned unpriced with
+         *     `no_price`.
+         */
         QuoteLine: {
             price_lookup_key?: string;
             plan_lookup_key?: string;
@@ -1307,7 +1316,8 @@ export interface components {
             /**
              * Format: int64
              * @description For metered items, how long to price for. This allows an estimate such as "about
-             *     this much per month" to be shown before anything exists.
+             *     this much per month" to be shown before anything exists. The priced quantity is
+             *     `quantity` multiplied by this duration.
              */
             duration_seconds?: number;
         };
@@ -1352,6 +1362,10 @@ export interface components {
             price_id?: string;
             plan_name?: string;
             unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description The quantity actually priced. When `duration_seconds` is given, it is the requested
+             *     `quantity` multiplied by that duration.
+             */
             quantity?: string;
             /** @description Not rounded. Round only for display. */
             amount?: components["schemas"]["Money"];
@@ -1528,9 +1542,11 @@ export interface components {
             /**
              * @description `pending` until the payment gateway reaches a result. The balance increases on `succeeded`.
              *
-             *     `failed` means the gateway declined the payment. `canceled` means the attempt was withdrawn
-             *     without collecting money; `cancellation_reason` says why. Unknown gateway outcomes remain
-             *     `pending`, and a browser redirect is not proof of payment.
+             *     `failed` means the gateway declined the payment. A declined attempt ends the top-up at once
+             *     and the payment is withdrawn at the gateway; to pay another way, create a new top-up.
+             *     `canceled` means the attempt was withdrawn without collecting money; `cancellation_reason`
+             *     says why. Unknown gateway outcomes remain `pending`, and a browser redirect is not proof of
+             *     payment.
              *
              *     `failed` and `canceled` are final. If the gateway nevertheless collects payment for such an
              *     attempt, the amount is credited as a separate `succeeded` top-up.
@@ -1553,7 +1569,13 @@ export interface components {
              *     the figure that appears on the customer's card or wallet statement.
              */
             presentment_amount?: components["schemas"]["Money"];
-            /** @description Why the gateway declined it. Present with `failed`. */
+            /**
+             * @description Why the gateway declined it. Present with `failed`. The value is the gateway's own code,
+             *     passed on unchanged: the card issuer's decline code when there is one (Stripe's decline_code,
+             *     such as insufficient_funds or lost_card), otherwise the gateway's error code (Stripe's code,
+             *     such as card_declined, expired_card or payment_intent_authentication_failure). Clients map it
+             *     to their own wording and treat an unknown value as a generic decline.
+             */
             failure_reason?: string;
             /**
              * @description The customer's next step while the top-up is `pending` and the gateway still awaits them. Returned
@@ -1732,7 +1754,9 @@ export interface components {
          *
          *     succeeded means payment is complete. processing means confirmation is pending; poll the invoice or
          *     order rather than submitting another payment. requires_action means the customer must complete the
-         *     supplied action. failed means the attempt did not succeed and failure_reason explains the outcome.
+         *     supplied action. failed means the attempt did not succeed and failure_reason explains the outcome; a
+         *     declined gateway payment is withdrawn at the gateway, and paying again starts a new payment with the
+         *     same or another method.
          * @enum {string}
          */
         PaymentStatus: "succeeded" | "processing" | "requires_action" | "failed";
@@ -1773,6 +1797,14 @@ export interface components {
             invoice_id?: string | null;
             /** Format: uuid */
             order_id?: string | null;
+            /**
+             * @description Why the payment did not go through. Present with `failed`. For a declined gateway payment the
+             *     value is the gateway's own code, passed on unchanged: the card issuer's decline code when
+             *     there is one (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the
+             *     gateway's error code (Stripe's code, such as card_declined, expired_card or
+             *     payment_intent_authentication_failure). Clients map it to their own wording and treat an
+             *     unknown value as a generic decline.
+             */
             failure_reason?: string;
         };
         /**
@@ -1907,9 +1939,9 @@ export interface components {
             /** Format: uuid */
             refund_id?: string;
             /**
-             * @description `failed` means the operation did not succeed; for a gateway payment, that the gateway declined it.
-             *     `canceled` means a gateway payment was withdrawn without collecting money; an invoice it was meant
-             *     to pay remains open for another payment.
+             * @description `failed` means the operation did not succeed; for a gateway payment, that the gateway declined
+             *     it. `canceled` means a gateway payment was withdrawn without collecting money. After either,
+             *     an invoice the payment was meant to pay remains open for another payment.
              * @enum {string}
              */
             status?: "pending" | "succeeded" | "failed" | "canceled";
@@ -1917,7 +1949,14 @@ export interface components {
             cancellation_reason?: components["schemas"]["PaymentCancellationReason"];
             payment_gateway?: string;
             method_type?: string;
-            /** @description Why it failed. Present with `failed`. */
+            /**
+             * @description Why it failed. Present with `failed`. For a declined gateway payment the value is the
+             *     gateway's own code, passed on unchanged: the card issuer's decline code when there is one
+             *     (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the gateway's
+             *     error code (Stripe's code, such as card_declined, expired_card or
+             *     payment_intent_authentication_failure). Clients map it to their own wording and treat an
+             *     unknown value as a generic decline.
+             */
             failure_reason?: string;
             /** Format: date-time */
             settled_at?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.84.0",
+  "version": "0.84.2",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {