@leaflow/sdk 0.0.0-dev.214.g13f9d6c → 0.0.0-dev.218.g44bea88

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -391,7 +391,15 @@ export interface paths {
391
391
  put?: never;
392
392
  /**
393
393
  * Pay together
394
- * @description Pays outstanding invoices, including invoices associated with the listed orders. Gateway collection creates a top-up transaction applied to the original invoices. Paid invoices are not charged again. Unknown gateway results remain pending and are recovered through the original transaction and task.
394
+ * @description Pays outstanding invoices, including the invoices of the listed orders, from the account's
395
+ * eligible credit grants and then its balance. No payment gateway is used; an invoice to be
396
+ * paid online is paid on its own.
397
+ *
398
+ * Either every invoice is paid or none is. When the credit grants and balance cannot cover
399
+ * them all, the request fails with `BILLING_INSUFFICIENT_FUNDS` and nothing is charged.
400
+ * Invoices that are already paid are not charged again. An invoice with an online payment
401
+ * still in progress is refused with `BILLING_PAYMENT_PENDING`, and an order whose payment
402
+ * deadline has passed with `BILLING_ORDER_EXPIRED`.
395
403
  */
396
404
  post: operations["pay-together"];
397
405
  delete?: never;
@@ -1123,6 +1131,11 @@ export interface components {
1123
1131
  ProjectBillingInfo: {
1124
1132
  /** Format: uuid */
1125
1133
  project_id: string;
1134
+ /**
1135
+ * @description The project and its current name, for display. Absent when the project no longer exists or its
1136
+ * details cannot be read at the moment; `project_id` still identifies it.
1137
+ */
1138
+ project?: components["schemas"]["NamedIdentity"] | null;
1126
1139
  /** Format: int64 */
1127
1140
  billing_account_id: number;
1128
1141
  account_name?: string;
@@ -1428,9 +1441,12 @@ export interface components {
1428
1441
  * @description A usage invoice stays `draft` through its month: each charge is added to it as it is priced
1429
1442
  * and paid from credits and balance as it goes. It is issued at the end of the month, becoming
1430
1443
  * `paid` when everything was covered and `open` when something is still owed.
1444
+ *
1445
+ * `refunded` means the invoice was paid and has since been refunded in full; a partial refund
1446
+ * leaves it `paid`, with the refunded part in `amount_refunded`.
1431
1447
  * @enum {string}
1432
1448
  */
1433
- InvoiceStatus: "draft" | "open" | "paid" | "void" | "uncollectible";
1449
+ InvoiceStatus: "draft" | "open" | "paid" | "refunded" | "void" | "uncollectible";
1434
1450
  Invoice: {
1435
1451
  /** Format: date-time */
1436
1452
  due_at?: string;
@@ -1516,6 +1532,12 @@ export interface components {
1516
1532
  type?: "usage" | "subscription" | "one_time" | "setup" | "adjustment";
1517
1533
  /** Format: uuid */
1518
1534
  project_id?: string | null;
1535
+ /**
1536
+ * @description The project the charge was for and its current name, for display. Absent when the line is
1537
+ * not for a project, and when the project no longer exists or its details cannot be read at
1538
+ * the moment; `project_id` still identifies it then.
1539
+ */
1540
+ project?: components["schemas"]["NamedIdentity"] | null;
1519
1541
  resource_id?: string;
1520
1542
  /**
1521
1543
  * @description The wording as recorded when the invoice was issued. It is not re-translated
@@ -1667,6 +1689,11 @@ export interface components {
1667
1689
  id: string;
1668
1690
  /** Format: uuid */
1669
1691
  project_id?: string;
1692
+ /**
1693
+ * @description The project and its current name, for display. Absent when the project no longer exists or its
1694
+ * details cannot be read at the moment; `project_id` still identifies it.
1695
+ */
1696
+ project?: components["schemas"]["NamedIdentity"] | null;
1670
1697
  product: components["schemas"]["Product"];
1671
1698
  /** @description Which resource this was charged for. Empty for charges not tied to one. */
1672
1699
  resource_id?: string;
@@ -1760,6 +1787,12 @@ export interface components {
1760
1787
  * membership, which belongs to no single project.
1761
1788
  */
1762
1789
  project_id?: string | null;
1790
+ /**
1791
+ * @description The project and its current name, for display. Absent for a purchase at account level,
1792
+ * and when the project no longer exists or its details cannot be read at the moment;
1793
+ * `project_id` still identifies it then.
1794
+ */
1795
+ project?: components["schemas"]["NamedIdentity"] | null;
1763
1796
  product: components["schemas"]["Product"];
1764
1797
  /** Format: uuid */
1765
1798
  plan_id: string;
@@ -1882,6 +1915,12 @@ export interface components {
1882
1915
  * as a membership.
1883
1916
  */
1884
1917
  project_id?: string | null;
1918
+ /**
1919
+ * @description The project and its current name, for display. Absent for a purchase at account level,
1920
+ * and when the project no longer exists or its details cannot be read at the moment;
1921
+ * `project_id` still identifies it then.
1922
+ */
1923
+ project?: components["schemas"]["NamedIdentity"] | null;
1885
1924
  /**
1886
1925
  * Format: int64
1887
1926
  * @description The billing account the order was placed with. It does not change when the project is later
@@ -2284,6 +2323,21 @@ export interface components {
2284
2323
  * @example 10.2500000000
2285
2324
  */
2286
2325
  Money: string;
2326
+ /**
2327
+ * @description Which object this is, together with what a person currently calls it.
2328
+ *
2329
+ * The name is for display. It is chosen by whoever owns the object, it changes, it is not unique
2330
+ * between objects, and it may be empty when nobody has named it yet — so it must not be used to
2331
+ * address, match or deduplicate anything. Addressing is by id.
2332
+ *
2333
+ * This differs from an identity carrying a lookup key: a lookup key is written once by an operator,
2334
+ * is unique, and can be used to fetch the object. A name cannot.
2335
+ */
2336
+ NamedIdentity: {
2337
+ /** Format: uuid */
2338
+ id: string;
2339
+ name: string;
2340
+ };
2287
2341
  };
2288
2342
  responses: {
2289
2343
  /** @description Error */
@@ -562,8 +562,12 @@ export interface components {
562
562
  name: string;
563
563
  currency: string;
564
564
  };
565
- /** @enum {string} */
566
- InvoiceStatus: "draft" | "open" | "paid" | "void" | "uncollectible";
565
+ /**
566
+ * @description `refunded` means the invoice was paid and has since been refunded in full; a partial refund
567
+ * leaves it `paid`, with the refunded part in `amount_refunded`.
568
+ * @enum {string}
569
+ */
570
+ InvoiceStatus: "draft" | "open" | "paid" | "refunded" | "void" | "uncollectible";
567
571
  UsageCharge: {
568
572
  /** Format: uuid */
569
573
  subscription_id?: string;
@@ -571,6 +575,11 @@ export interface components {
571
575
  id: string;
572
576
  /** Format: uuid */
573
577
  project_id?: string;
578
+ /**
579
+ * @description The project and its current name, for display. Absent when the project no longer exists or its
580
+ * details cannot be read at the moment; `project_id` still identifies it.
581
+ */
582
+ project?: components["schemas"]["NamedIdentity"] | null;
574
583
  product: components["schemas"]["Product"];
575
584
  /** @description Which resource this was charged for. Empty for charges not tied to one. */
576
585
  resource_id?: string;
@@ -677,6 +686,12 @@ export interface components {
677
686
  * membership, which belongs to no single project.
678
687
  */
679
688
  project_id?: string | null;
689
+ /**
690
+ * @description The project and its current name, for display. Absent for a purchase at account level,
691
+ * and when the project no longer exists or its details cannot be read at the moment;
692
+ * `project_id` still identifies it then.
693
+ */
694
+ project?: components["schemas"]["NamedIdentity"] | null;
680
695
  product: components["schemas"]["Product"];
681
696
  /** Format: uuid */
682
697
  plan_id: string;
@@ -782,6 +797,12 @@ export interface components {
782
797
  * as a membership.
783
798
  */
784
799
  project_id?: string | null;
800
+ /**
801
+ * @description The project and its current name, for display. Absent for a purchase at account level,
802
+ * and when the project no longer exists or its details cannot be read at the moment;
803
+ * `project_id` still identifies it then.
804
+ */
805
+ project?: components["schemas"]["NamedIdentity"] | null;
785
806
  /**
786
807
  * Format: int64
787
808
  * @description The billing account the order was placed with. It does not change when the project is later
@@ -1011,6 +1032,21 @@ export interface components {
1011
1032
  * @example 10.2500000000
1012
1033
  */
1013
1034
  Money: string;
1035
+ /**
1036
+ * @description Which object this is, together with what a person currently calls it.
1037
+ *
1038
+ * The name is for display. It is chosen by whoever owns the object, it changes, it is not unique
1039
+ * between objects, and it may be empty when nobody has named it yet — so it must not be used to
1040
+ * address, match or deduplicate anything. Addressing is by id.
1041
+ *
1042
+ * This differs from an identity carrying a lookup key: a lookup key is written once by an operator,
1043
+ * is unique, and can be used to fetch the object. A name cannot.
1044
+ */
1045
+ NamedIdentity: {
1046
+ /** Format: uuid */
1047
+ id: string;
1048
+ name: string;
1049
+ };
1014
1050
  };
1015
1051
  responses: {
1016
1052
  /** @description Error */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@leaflow/sdk",
3
- "version": "0.0.0-dev.214.g13f9d6c",
3
+ "version": "0.0.0-dev.218.g44bea88",
4
4
  "description": "Leaflow 平台 API 的 TypeScript SDK",
5
5
  "license": "MIT",
6
6
  "repository": {