@leaflow/sdk 0.117.0 → 0.117.1

package/dist/billing/v1/generated/functions.d.ts

@@ -907,7 +907,7 @@ export type listUsageChargesResponseError = listUsageChargesResponseDefault & {
 export type listUsageChargesResponse = listUsageChargesResponseSuccess | listUsageChargesResponseError;
 export declare const getListUsageChargesUrl: (params?: ListUsageChargesParams) => string;
 /**
- * Lists priced and pending usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Charges still waiting to be priced are included too.
+ * Lists priced and unrated usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Unrated charges had no applicable price when the usage occurred and are not billed.
  *
  * Only charges recorded against your billing accounts are included, before filtering, counting and pagination. Reassigning a project does not move previously recorded charges to its new account.
  * @summary List usage charges

package/dist/billing/v1/generated/functions.js

@@ -1009,7 +1009,7 @@ export const getListUsageChargesUrl = (params) => {
         : `https://billing.leaflow.cloud/api/v1/usage-charges`;
 };
 /**
- * Lists priced and pending usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Charges still waiting to be priced are included too.
+ * Lists priced and unrated usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Unrated charges had no applicable price when the usage occurred and are not billed.
  *
  * Only charges recorded against your billing accounts are included, before filtering, counting and pagination. Reassigning a project does not move previously recorded charges to its new account.
  * @summary List usage charges

package/dist/billing/v1/generated/models.d.ts

@@ -694,7 +694,7 @@ export interface CreditGroup {
  * Account balance, credits, and unpaid charges are reported separately.
  */
 export interface AccountBalance {
-    /** Cash balance minus pending cash returns, unbilled usage estimates and issued unpaid amounts. Credit grants are excluded; the result may be negative. */
+    /** Balance minus pending balance returns, unbilled usage estimates and issued unpaid amounts. Credit grants are excluded; the result may be negative. */
     available_credit: Money;
     /** Current estimate of rated usage that has not been invoiced. Final pricing and tax are fixed at issuance. */
     unbilled_amount: Money;
@@ -711,7 +711,7 @@ export interface AccountBalance {
      * credits balance does not imply that due is zero.
      */
     credits: Money;
-    /** Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from cash balance. */
+    /** Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from the balance. */
     restricted_credits: Money;
     /**
      * Currently valid, unspent credit grouped by permitted use. Restrictions and
@@ -1550,12 +1550,12 @@ export interface UsageCharge {
     amount?: Money;
     currency: string;
     /**
-     * The usage invoice this charge was added to. Absent while it waits to be priced.
+     * The usage invoice this charge was added to. Absent until its statement closes and always absent for unrated charges.
      * @nullable
      */
     invoice_id?: string | null;
     /**
-     * The usage invoice line this charge was summed into. Absent while it waits to be priced.
+     * The usage invoice line this charge was summed into. Absent until its statement closes and always absent for unrated charges.
      * @nullable
      */
     invoice_item_id?: string | null;
@@ -2702,7 +2702,7 @@ export interface Statement {
     /** 1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing. */
     sequence: number;
     status: StatementStatus;
-    /** True while the statement is open. The estimate is the priced usage plus tax for the current invoice contact; tier adjustments over the whole period and minimum charges are determined at closing. */
+    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
     estimated: boolean;
     amounts: StatementAmounts;
     closed_at?: string;
@@ -2724,7 +2724,7 @@ export interface StatementItem {
     /** Net usage quantity. Included only when grouping by meter. */
     quantity?: string;
     deducted_quantity?: string;
-    /** Usage not yet priced; not a zero-cost charge. */
+    /** Usage that had no applicable price when it occurred. It is not charged, either now or later. */
     unrated_quantity?: string;
     amount: Money;
 }

package/dist/billing/v1/generated/schemas.zod.d.ts

@@ -524,7 +524,7 @@ export declare const ListRefundsQueryParams: zod.ZodObject<{
     order_id: zod.ZodOptional<zod.ZodUUID>;
 }, zod.z.core.$strict>;
 /**
- * Lists priced and pending usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Charges still waiting to be priced are included too.
+ * Lists priced and unrated usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Unrated charges had no applicable price when the usage occurred and are not billed.
  *
  * Only charges recorded against your billing accounts are included, before filtering, counting and pagination. Reassigning a project does not move previously recorded charges to its new account.
  * @summary List usage charges

package/dist/billing/v1/generated/schemas.zod.js

@@ -665,7 +665,7 @@ export const ListRefundsQueryParams = zod.strictObject({
         .describe("Only the refunds that belong to this order: those of its invoice, such as the refund of a\npurchase that could not be delivered, and those it caused on an earlier invoice, such as\nthe difference returned after a downgrade."),
 });
 /**
- * Lists priced and pending usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Charges still waiting to be priced are included too.
+ * Lists priced and unrated usage charges. Requires `statement_id`, `invoice_item_id`, or both `from` and `to` spanning at most 31 days; use the statement summary or spend report for longer periods. Charges are summed into one line per subscription, project, resource, meter and rate when their statement closes; filter by `invoice_item_id` to see the charges behind a line. Unrated charges had no applicable price when the usage occurred and are not billed.
  *
  * Only charges recorded against your billing accounts are included, before filtering, counting and pagination. Reassigning a project does not move previously recorded charges to its new account.
  * @summary List usage charges

package/dist/billing/v1/generated/validators/accountBalance.zod.js

@@ -10,13 +10,13 @@ import { CreditGroup } from "./creditGroup.zod.js";
 import { Money } from "./money.zod.js";
 export const AccountBalance = zod
     .strictObject({
-    available_credit: Money.describe("Cash balance minus pending cash returns, unbilled usage estimates and issued unpaid amounts. Credit grants are excluded; the result may be negative."),
+    available_credit: Money.describe("Balance minus pending balance returns, unbilled usage estimates and issued unpaid amounts. Credit grants are excluded; the result may be negative."),
     unbilled_amount: Money.describe("Current estimate of rated usage that has not been invoiced. Final pricing and tax are fixed at issuance."),
     billing_account_id: zod.int(),
     currency: zod.string(),
     balance: Money.describe("Prepaid funds in the account currency, excluding credits. May be negative after a payment\ndispute. Outstanding charges are reported separately in due; this value is not a withdrawal quote."),
     credits: Money.describe("The recorded remaining credit, including restricted grants. It is not withdrawable\nand is not part of balance. credit_groups describes currently valid credit by permitted use; a positive\ncredits balance does not imply that due is zero."),
-    restricted_credits: Money.describe("Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from cash balance."),
+    restricted_credits: Money.describe("Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from the balance."),
     credit_groups: zod
         .array(CreditGroup)
         .describe("Currently valid, unspent credit grouped by permitted use. Restrictions and\nvalidity dates determine which charges a group can cover, so these groups are not a general\nspendable balance and may differ from the recorded credits total."),

package/dist/billing/v1/generated/validators/statement.zod.js

@@ -22,7 +22,7 @@ export const Statement = zod
     status: StatementStatus,
     estimated: zod
         .boolean()
-        .describe("True while the statement is open. The estimate is the priced usage plus tax for the current invoice contact; tier adjustments over the whole period and minimum charges are determined at closing."),
+        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
     amounts: StatementAmounts,
     closed_at: zod.iso.datetime({ offset: true }).optional(),
     invoice_id: zod

package/dist/billing/v1/generated/validators/statementItem.zod.js

@@ -20,6 +20,6 @@ export const StatementItem = zod.strictObject({
     unrated_quantity: zod
         .string()
         .optional()
-        .describe("Usage not yet priced; not a zero-cost charge."),
+        .describe("Usage that had no applicable price when it occurred. It is not charged, either now or later."),
     amount: Money,
 });

package/dist/billing/v1/generated/validators/usageCharge.zod.js

@@ -48,10 +48,10 @@ export const UsageCharge = zod.strictObject({
     invoice_id: zod
         .uuid()
         .nullish()
-        .describe("The usage invoice this charge was added to. Absent while it waits to be priced."),
+        .describe("The usage invoice this charge was added to. Absent until its statement closes and always absent for unrated charges."),
     invoice_item_id: zod
         .uuid()
         .nullish()
-        .describe("The usage invoice line this charge was summed into. Absent while it waits to be priced."),
+        .describe("The usage invoice line this charge was summed into. Absent until its statement closes and always absent for unrated charges."),
     statement_id: zod.uuid().optional().describe("The statement this charge was collected into."),
 });

package/package.json

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