@leaflow/sdk 0.0.0-dev.238.g68f98cb → 0.0.0-dev.242.g41f635a

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.
@@ -95,16 +95,6 @@ export type ListSubscriptionsResult = operations["list-subscriptions"]["response
95
95
  export type ListSubscriptionsQuery = operations["list-subscriptions"]["parameters"]["query"];
96
96
  /** The success response body of `GET /account/v1/subscriptions/{subscriptionId}`. */
97
97
  export type GetSubscriptionResult = operations["get-subscription"]["responses"][200]["content"]["application/json"];
98
- /** The success response body of `GET /account/v1/subscriptions/{subscriptionId}/cancellation-preview`. */
99
- export type PreviewCancellationResult = operations["preview-cancellation"]["responses"][200]["content"]["application/json"];
100
- /** The success response body of `POST /account/v1/subscriptions/{subscriptionId}/cancellation-requests`. */
101
- export type CreateCancellationRequestResult = operations["create-cancellation-request"]["responses"][201]["content"]["application/json"];
102
- /** The request body of `POST /account/v1/subscriptions/{subscriptionId}/cancellation-requests`. */
103
- export type CreateCancellationRequestBody = NonNullable<operations["create-cancellation-request"]["requestBody"]>["content"]["application/json"];
104
- /** The success response body of `GET /account/v1/cancellation-requests/{cancellationRequestId}`. */
105
- export type GetCancellationRequestResult = operations["get-cancellation-request"]["responses"][200]["content"]["application/json"];
106
- /** The success response body of `POST /account/v1/cancellation-requests/{cancellationRequestId}/cancel`. */
107
- export type CancelCancellationRequestResult = operations["cancel-cancellation-request"]["responses"][200]["content"]["application/json"];
108
98
  /** The success response body of `POST /account/v1/quotes`. */
109
99
  export type CreateQuoteResult = operations["create-quote"]["responses"][200]["content"]["application/json"];
110
100
  /** The request body of `POST /account/v1/quotes`. */
@@ -683,104 +683,6 @@ export interface paths {
683
683
  patch?: never;
684
684
  trace?: never;
685
685
  };
686
- "/account/v1/subscriptions/{subscriptionId}/cancellation-preview": {
687
- parameters: {
688
- query?: never;
689
- header?: never;
690
- path: {
691
- subscriptionId: components["parameters"]["SubscriptionId"];
692
- };
693
- cookie?: never;
694
- };
695
- /**
696
- * Preview cancellation
697
- * @deprecated
698
- * @description Reads confirmed terms and paid-period value without recording a request or locking a refund amount.
699
- *
700
- * Use create-quote with a `cancellation`, which quotes the subscriptions released together.
701
- */
702
- get: operations["preview-cancellation"];
703
- put?: never;
704
- post?: never;
705
- delete?: never;
706
- options?: never;
707
- head?: never;
708
- patch?: never;
709
- trace?: never;
710
- };
711
- "/account/v1/subscriptions/{subscriptionId}/cancellation-requests": {
712
- parameters: {
713
- query?: never;
714
- header?: never;
715
- path: {
716
- subscriptionId: components["parameters"]["SubscriptionId"];
717
- };
718
- cookie?: never;
719
- };
720
- get?: never;
721
- put?: never;
722
- /**
723
- * Request subscription cancellation
724
- * @deprecated
725
- * @description Ends the whole subscription under confirmed terms. The request does not itself stop service; actual end is confirmed by the owning service. Refund processing is separate.
726
- *
727
- * Use create-cancellation, which ends the subscriptions released together and checks the refund.
728
- */
729
- post: operations["create-cancellation-request"];
730
- delete?: never;
731
- options?: never;
732
- head?: never;
733
- patch?: never;
734
- trace?: never;
735
- };
736
- "/account/v1/cancellation-requests/{cancellationRequestId}": {
737
- parameters: {
738
- query?: never;
739
- header?: never;
740
- path: {
741
- cancellationRequestId: components["parameters"]["CancellationRequestId"];
742
- };
743
- cookie?: never;
744
- };
745
- /**
746
- * Get cancellation request
747
- * @deprecated
748
- * @description Use get-cancellation.
749
- */
750
- get: operations["get-cancellation-request"];
751
- put?: never;
752
- post?: never;
753
- delete?: never;
754
- options?: never;
755
- head?: never;
756
- patch?: never;
757
- trace?: never;
758
- };
759
- "/account/v1/cancellation-requests/{cancellationRequestId}/cancel": {
760
- parameters: {
761
- query?: never;
762
- header?: never;
763
- path: {
764
- cancellationRequestId: components["parameters"]["CancellationRequestId"];
765
- };
766
- cookie?: never;
767
- };
768
- get?: never;
769
- put?: never;
770
- /**
771
- * Cancel a cancellation request
772
- * @deprecated
773
- * @description Allowed only before release starts. Does not resume a previously suspended subscription.
774
- *
775
- * Use withdraw-cancellation, which withdraws the whole cancellation.
776
- */
777
- post: operations["cancel-cancellation-request"];
778
- delete?: never;
779
- options?: never;
780
- head?: never;
781
- patch?: never;
782
- trace?: never;
783
- };
784
686
  "/account/v1/quotes": {
785
687
  parameters: {
786
688
  query?: never;
@@ -1436,21 +1338,6 @@ export interface components {
1436
1338
  /** Format: int64 */
1437
1339
  total_count?: number;
1438
1340
  };
1439
- CancellationPreview: {
1440
- /** Format: uuid */
1441
- subscription_id: string;
1442
- mode: components["schemas"]["TerminationPolicy"];
1443
- /** Format: date-time */
1444
- scheduled_at?: string;
1445
- refundable_amount: string;
1446
- currency: string;
1447
- };
1448
- CancellationRequestCreate: {
1449
- mode?: components["schemas"]["TerminationPolicy"];
1450
- /** @default false */
1451
- forfeit_remaining_value?: boolean;
1452
- reason: string;
1453
- };
1454
1341
  /** @description A cancellation request for the original purchase. scheduled_at is the intended time; effective_at is the confirmed end of service. The request alone does not stop metering or issue a refund. */
1455
1342
  CancellationRequest: {
1456
1343
  reason?: string;
@@ -2890,9 +2777,33 @@ export interface components {
2890
2777
  */
2891
2778
  plan_name: string;
2892
2779
  quantity: string;
2780
+ /**
2781
+ * @description The unit amount of the price this line is charged under. Absent for a tiered price, which has no
2782
+ * single unit amount, and for a change that takes effect at once, which is charged the prorated
2783
+ * difference.
2784
+ */
2893
2785
  unit_amount?: components["schemas"]["Money"];
2786
+ /**
2787
+ * @description Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
2788
+ * times `quantity`; a minimum charge can make it higher. For a change that takes effect at once it is
2789
+ * the prorated difference. The setup fee is not part of it; see `setup_amount`.
2790
+ *
2791
+ * Under an inclusive tax rate it includes tax, as the price does, and the included part is
2792
+ * `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
2793
+ * tax, and tax is added to it.
2794
+ */
2894
2795
  gross_amount?: components["schemas"]["Money"];
2796
+ /**
2797
+ * @description The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,
2798
+ * from the discount the subscription carries.
2799
+ *
2800
+ * A carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then
2801
+ * `unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and
2802
+ * the carried discount is already reflected in it: the renewal order also uses a coupon the account
2803
+ * holds, or the account's tax rate is inclusive.
2804
+ */
2895
2805
  discount_amount?: components["schemas"]["Money"];
2806
+ /** @description `gross_amount` less `discount_amount`. */
2896
2807
  amount?: components["schemas"]["Money"];
2897
2808
  currency: string;
2898
2809
  /** Format: date-time */
@@ -3066,7 +2977,6 @@ export interface components {
3066
2977
  InvoiceId: string;
3067
2978
  OrderId: string;
3068
2979
  CancellationId: string;
3069
- CancellationRequestId: string;
3070
2980
  SubscriptionId: string;
3071
2981
  PaymentMethodId: string;
3072
2982
  };
@@ -3971,102 +3881,6 @@ export interface operations {
3971
3881
  default: components["responses"]["Error"];
3972
3882
  };
3973
3883
  };
3974
- "preview-cancellation": {
3975
- parameters: {
3976
- query?: never;
3977
- header?: never;
3978
- path: {
3979
- subscriptionId: components["parameters"]["SubscriptionId"];
3980
- };
3981
- cookie?: never;
3982
- };
3983
- requestBody?: never;
3984
- responses: {
3985
- /** @description Cancellation estimate */
3986
- 200: {
3987
- headers: {
3988
- [name: string]: unknown;
3989
- };
3990
- content: {
3991
- "application/json": components["schemas"]["CancellationPreview"];
3992
- };
3993
- };
3994
- default: components["responses"]["Error"];
3995
- };
3996
- };
3997
- "create-cancellation-request": {
3998
- parameters: {
3999
- query?: never;
4000
- header?: never;
4001
- path: {
4002
- subscriptionId: components["parameters"]["SubscriptionId"];
4003
- };
4004
- cookie?: never;
4005
- };
4006
- requestBody: {
4007
- content: {
4008
- "application/json": components["schemas"]["CancellationRequestCreate"];
4009
- };
4010
- };
4011
- responses: {
4012
- /** @description Cancellation requested */
4013
- 201: {
4014
- headers: {
4015
- [name: string]: unknown;
4016
- };
4017
- content: {
4018
- "application/json": components["schemas"]["CancellationRequest"];
4019
- };
4020
- };
4021
- default: components["responses"]["Error"];
4022
- };
4023
- };
4024
- "get-cancellation-request": {
4025
- parameters: {
4026
- query?: never;
4027
- header?: never;
4028
- path: {
4029
- cancellationRequestId: components["parameters"]["CancellationRequestId"];
4030
- };
4031
- cookie?: never;
4032
- };
4033
- requestBody?: never;
4034
- responses: {
4035
- /** @description Request and actual end receipt */
4036
- 200: {
4037
- headers: {
4038
- [name: string]: unknown;
4039
- };
4040
- content: {
4041
- "application/json": components["schemas"]["CancellationRequest"];
4042
- };
4043
- };
4044
- default: components["responses"]["Error"];
4045
- };
4046
- };
4047
- "cancel-cancellation-request": {
4048
- parameters: {
4049
- query?: never;
4050
- header?: never;
4051
- path: {
4052
- cancellationRequestId: components["parameters"]["CancellationRequestId"];
4053
- };
4054
- cookie?: never;
4055
- };
4056
- requestBody?: never;
4057
- responses: {
4058
- /** @description Canceled request */
4059
- 200: {
4060
- headers: {
4061
- [name: string]: unknown;
4062
- };
4063
- content: {
4064
- "application/json": components["schemas"]["CancellationRequest"];
4065
- };
4066
- };
4067
- default: components["responses"]["Error"];
4068
- };
4069
- };
4070
3884
  "create-quote": {
4071
3885
  parameters: {
4072
3886
  query?: never;
@@ -1198,9 +1198,33 @@ export interface components {
1198
1198
  */
1199
1199
  plan_name: string;
1200
1200
  quantity: string;
1201
+ /**
1202
+ * @description The unit amount of the price this line is charged under. Absent for a tiered price, which has no
1203
+ * single unit amount, and for a change that takes effect at once, which is charged the prorated
1204
+ * difference.
1205
+ */
1201
1206
  unit_amount?: components["schemas"]["Money"];
1207
+ /**
1208
+ * @description Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
1209
+ * times `quantity`; a minimum charge can make it higher. For a change that takes effect at once it is
1210
+ * the prorated difference. The setup fee is not part of it; see `setup_amount`.
1211
+ *
1212
+ * Under an inclusive tax rate it includes tax, as the price does, and the included part is
1213
+ * `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
1214
+ * tax, and tax is added to it.
1215
+ */
1202
1216
  gross_amount?: components["schemas"]["Money"];
1217
+ /**
1218
+ * @description The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,
1219
+ * from the discount the subscription carries.
1220
+ *
1221
+ * A carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then
1222
+ * `unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and
1223
+ * the carried discount is already reflected in it: the renewal order also uses a coupon the account
1224
+ * holds, or the account's tax rate is inclusive.
1225
+ */
1203
1226
  discount_amount?: components["schemas"]["Money"];
1227
+ /** @description `gross_amount` less `discount_amount`. */
1204
1228
  amount?: components["schemas"]["Money"];
1205
1229
  currency: string;
1206
1230
  /** Format: date-time */
@@ -753,6 +753,8 @@ export interface paths {
753
753
  /**
754
754
  * Detach a disk
755
755
  * @description Unmount the device inside the instance before calling this endpoint. Forcibly detaching a file system that is being written to corrupts data.
756
+ *
757
+ * The disk the instance boots from cannot be detached, whether it is the system disk bought with the instance or a disk the instance was created from with `boot_disk_id`. Such a request is refused with `INSTANCE_BOOT_DISK_LOCKED` and creates no task; releasing the instance is what frees that disk.
756
758
  */
757
759
  delete: operations["detach-disk"];
758
760
  options?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@leaflow/sdk",
3
- "version": "0.0.0-dev.238.g68f98cb",
3
+ "version": "0.0.0-dev.242.g41f635a",
4
4
  "description": "Leaflow 平台 API 的 TypeScript SDK",
5
5
  "license": "MIT",
6
6
  "repository": {