@usethrottle/api-client 5.5.0 → 5.7.0

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.
Files changed (11) hide show
  1. package/dist/generated/services/CartsService.d.ts +102 -1
  2. package/dist/generated/services/CartsService.d.ts.map +1 -1
  3. package/dist/generated/services/CartsService.js.map +1 -1
  4. package/dist/generated/services/OrdersService.d.ts +169 -2
  5. package/dist/generated/services/OrdersService.d.ts.map +1 -1
  6. package/dist/generated/services/OrdersService.js +1 -1
  7. package/dist/generated/services/OrdersService.js.map +1 -1
  8. package/dist/generated/services/SubscriptionsService.d.ts +155 -3
  9. package/dist/generated/services/SubscriptionsService.d.ts.map +1 -1
  10. package/dist/generated/services/SubscriptionsService.js.map +1 -1
  11. package/package.json +1 -1
package/dist/generated/services/OrdersService.d.ts CHANGED
@@ -260,6 +260,15 @@ export declare class OrdersService {
260
260
  */
261
261
  amount?: number | null;
262
262
  count?: number | null;
263
+ schedule?: Array<{
264
+ amount?: number;
265
+ intervalUnit?: string | null;
266
+ intervalCount?: number | null;
267
+ }> | null;
268
+ /**
269
+ * Amount in cents (e.g. 1999 = $19.99)
270
+ */
271
+ scheduleUnitTotal?: number | null;
263
272
  } | null;
264
273
  /**
265
274
  * Arbitrary key-value metadata
@@ -468,6 +477,15 @@ export declare class OrdersService {
468
477
  */
469
478
  amount?: number | null;
470
479
  count?: number | null;
480
+ schedule?: Array<{
481
+ amount?: number;
482
+ intervalUnit?: string | null;
483
+ intervalCount?: number | null;
484
+ }> | null;
485
+ /**
486
+ * Amount in cents (e.g. 1999 = $19.99)
487
+ */
488
+ scheduleUnitTotal?: number | null;
471
489
  } | null;
472
490
  /**
473
491
  * Arbitrary key-value metadata
@@ -684,6 +702,15 @@ export declare class OrdersService {
684
702
  */
685
703
  amount?: number | null;
686
704
  count?: number | null;
705
+ schedule?: Array<{
706
+ amount?: number;
707
+ intervalUnit?: string | null;
708
+ intervalCount?: number | null;
709
+ }> | null;
710
+ /**
711
+ * Amount in cents (e.g. 1999 = $19.99)
712
+ */
713
+ scheduleUnitTotal?: number | null;
687
714
  } | null;
688
715
  /**
689
716
  * Arbitrary key-value metadata
@@ -934,6 +961,15 @@ export declare class OrdersService {
934
961
  */
935
962
  amount?: number | null;
936
963
  count?: number | null;
964
+ schedule?: Array<{
965
+ amount?: number;
966
+ intervalUnit?: string | null;
967
+ intervalCount?: number | null;
968
+ }> | null;
969
+ /**
970
+ * Amount in cents (e.g. 1999 = $19.99)
971
+ */
972
+ scheduleUnitTotal?: number | null;
937
973
  } | null;
938
974
  /**
939
975
  * Arbitrary key-value metadata
@@ -1131,6 +1167,15 @@ export declare class OrdersService {
1131
1167
  */
1132
1168
  amount?: number | null;
1133
1169
  count?: number | null;
1170
+ schedule?: Array<{
1171
+ amount?: number;
1172
+ intervalUnit?: string | null;
1173
+ intervalCount?: number | null;
1174
+ }> | null;
1175
+ /**
1176
+ * Amount in cents (e.g. 1999 = $19.99)
1177
+ */
1178
+ scheduleUnitTotal?: number | null;
1134
1179
  } | null;
1135
1180
  /**
1136
1181
  * Arbitrary key-value metadata
@@ -1331,6 +1376,15 @@ export declare class OrdersService {
1331
1376
  */
1332
1377
  amount?: number | null;
1333
1378
  count?: number | null;
1379
+ schedule?: Array<{
1380
+ amount?: number;
1381
+ intervalUnit?: string | null;
1382
+ intervalCount?: number | null;
1383
+ }> | null;
1384
+ /**
1385
+ * Amount in cents (e.g. 1999 = $19.99)
1386
+ */
1387
+ scheduleUnitTotal?: number | null;
1334
1388
  } | null;
1335
1389
  /**
1336
1390
  * Arbitrary key-value metadata
@@ -1531,6 +1585,15 @@ export declare class OrdersService {
1531
1585
  */
1532
1586
  amount?: number | null;
1533
1587
  count?: number | null;
1588
+ schedule?: Array<{
1589
+ amount?: number;
1590
+ intervalUnit?: string | null;
1591
+ intervalCount?: number | null;
1592
+ }> | null;
1593
+ /**
1594
+ * Amount in cents (e.g. 1999 = $19.99)
1595
+ */
1596
+ scheduleUnitTotal?: number | null;
1534
1597
  } | null;
1535
1598
  /**
1536
1599
  * Arbitrary key-value metadata
@@ -1732,6 +1795,15 @@ export declare class OrdersService {
1732
1795
  */
1733
1796
  amount?: number | null;
1734
1797
  count?: number | null;
1798
+ schedule?: Array<{
1799
+ amount?: number;
1800
+ intervalUnit?: string | null;
1801
+ intervalCount?: number | null;
1802
+ }> | null;
1803
+ /**
1804
+ * Amount in cents (e.g. 1999 = $19.99)
1805
+ */
1806
+ scheduleUnitTotal?: number | null;
1735
1807
  } | null;
1736
1808
  /**
1737
1809
  * Arbitrary key-value metadata
@@ -1942,6 +2014,15 @@ export declare class OrdersService {
1942
2014
  */
1943
2015
  amount?: number | null;
1944
2016
  count?: number | null;
2017
+ schedule?: Array<{
2018
+ amount?: number;
2019
+ intervalUnit?: string | null;
2020
+ intervalCount?: number | null;
2021
+ }> | null;
2022
+ /**
2023
+ * Amount in cents (e.g. 1999 = $19.99)
2024
+ */
2025
+ scheduleUnitTotal?: number | null;
1945
2026
  } | null;
1946
2027
  /**
1947
2028
  * Arbitrary key-value metadata
@@ -2142,6 +2223,15 @@ export declare class OrdersService {
2142
2223
  */
2143
2224
  amount?: number | null;
2144
2225
  count?: number | null;
2226
+ schedule?: Array<{
2227
+ amount?: number;
2228
+ intervalUnit?: string | null;
2229
+ intervalCount?: number | null;
2230
+ }> | null;
2231
+ /**
2232
+ * Amount in cents (e.g. 1999 = $19.99)
2233
+ */
2234
+ scheduleUnitTotal?: number | null;
2145
2235
  } | null;
2146
2236
  /**
2147
2237
  * Arbitrary key-value metadata
@@ -2348,6 +2438,15 @@ export declare class OrdersService {
2348
2438
  */
2349
2439
  amount?: number | null;
2350
2440
  count?: number | null;
2441
+ schedule?: Array<{
2442
+ amount?: number;
2443
+ intervalUnit?: string | null;
2444
+ intervalCount?: number | null;
2445
+ }> | null;
2446
+ /**
2447
+ * Amount in cents (e.g. 1999 = $19.99)
2448
+ */
2449
+ scheduleUnitTotal?: number | null;
2351
2450
  } | null;
2352
2451
  /**
2353
2452
  * Arbitrary key-value metadata
@@ -2548,6 +2647,15 @@ export declare class OrdersService {
2548
2647
  */
2549
2648
  amount?: number | null;
2550
2649
  count?: number | null;
2650
+ schedule?: Array<{
2651
+ amount?: number;
2652
+ intervalUnit?: string | null;
2653
+ intervalCount?: number | null;
2654
+ }> | null;
2655
+ /**
2656
+ * Amount in cents (e.g. 1999 = $19.99)
2657
+ */
2658
+ scheduleUnitTotal?: number | null;
2551
2659
  } | null;
2552
2660
  /**
2553
2661
  * Arbitrary key-value metadata
@@ -2745,6 +2853,15 @@ export declare class OrdersService {
2745
2853
  */
2746
2854
  amount?: number | null;
2747
2855
  count?: number | null;
2856
+ schedule?: Array<{
2857
+ amount?: number;
2858
+ intervalUnit?: string | null;
2859
+ intervalCount?: number | null;
2860
+ }> | null;
2861
+ /**
2862
+ * Amount in cents (e.g. 1999 = $19.99)
2863
+ */
2864
+ scheduleUnitTotal?: number | null;
2748
2865
  } | null;
2749
2866
  /**
2750
2867
  * Arbitrary key-value metadata
@@ -3006,6 +3123,15 @@ export declare class OrdersService {
3006
3123
  */
3007
3124
  amount?: number | null;
3008
3125
  count?: number | null;
3126
+ schedule?: Array<{
3127
+ amount?: number;
3128
+ intervalUnit?: string | null;
3129
+ intervalCount?: number | null;
3130
+ }> | null;
3131
+ /**
3132
+ * Amount in cents (e.g. 1999 = $19.99)
3133
+ */
3134
+ scheduleUnitTotal?: number | null;
3009
3135
  } | null;
3010
3136
  /**
3011
3137
  * Arbitrary key-value metadata
@@ -3087,7 +3213,7 @@ export declare class OrdersService {
3087
3213
  };
3088
3214
  }>;
3089
3215
  /**
3090
- * Add, update, or remove line items on an order. On a captured order the total delta is charged (increase) or refunded (decrease) automatically.
3216
+ * Add, update, or remove line items on an order. On a captured order the total delta is charged (increase) or refunded (decrease) automatically; on an order with an outstanding Net-N invoice, the invoice amount takes the delta instead.
3091
3217
  * @param id
3092
3218
  * @param requestBody
3093
3219
  * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
@@ -3307,6 +3433,15 @@ export declare class OrdersService {
3307
3433
  */
3308
3434
  amount?: number | null;
3309
3435
  count?: number | null;
3436
+ schedule?: Array<{
3437
+ amount?: number;
3438
+ intervalUnit?: string | null;
3439
+ intervalCount?: number | null;
3440
+ }> | null;
3441
+ /**
3442
+ * Amount in cents (e.g. 1999 = $19.99)
3443
+ */
3444
+ scheduleUnitTotal?: number | null;
3310
3445
  } | null;
3311
3446
  /**
3312
3447
  * Arbitrary key-value metadata
@@ -3325,7 +3460,7 @@ export declare class OrdersService {
3325
3460
  */
3326
3461
  adjustment: {
3327
3462
  /**
3328
- * Change in what the buyer owes, in minor units. On an order with a captured payment a positive delta was charged to the stored card and a negative one refunded; otherwise no money moved.
3463
+ * Change in what the buyer owes, in minor units. On an order with an outstanding Net-N invoice it is billed on that invoice (see `invoice`). Otherwise, on an order with a captured payment a positive delta was charged to the stored card and a negative one refunded; otherwise no money moved.
3329
3464
  */
3330
3465
  delta: number;
3331
3466
  /**
@@ -3351,6 +3486,38 @@ export declare class OrdersService {
3351
3486
  code?: string;
3352
3487
  message?: string;
3353
3488
  } | null;
3489
+ /**
3490
+ * Set when the order's balance is on an outstanding Net-N invoice. The delta is billed on that invoice instead of a card: an increase raises its amount, a decrease lowers it, and only a decrease larger than the invoice carries is refunded from money already collected. An invoice left owing nothing is voided. The buyer is not emailed; resend the invoice to send them the new amount. Null when there is no outstanding invoice.
3491
+ */
3492
+ invoice?: {
3493
+ /**
3494
+ * The Net-N invoice payment.
3495
+ */
3496
+ paymentId: string;
3497
+ /**
3498
+ * The invoice's number.
3499
+ */
3500
+ invoiceNumber?: string | null;
3501
+ /**
3502
+ * What the invoice billed before the edit, in minor units.
3503
+ */
3504
+ previousAmount: number;
3505
+ /**
3506
+ * What it bills now, in minor units. 0 means it owes nothing and was voided.
3507
+ */
3508
+ newAmount: number;
3509
+ /**
3510
+ * True when the invoice owed nothing after the edit and was voided.
3511
+ */
3512
+ voided: boolean;
3513
+ /**
3514
+ * Set when voiding an invoice left owing nothing failed. The line items were still changed; void the invoice from the order.
3515
+ */
3516
+ voidError?: {
3517
+ code?: string;
3518
+ message?: string;
3519
+ } | null;
3520
+ } | null;
3354
3521
  };
3355
3522
  /**
3356
3523
  * Present only when there is something to report. Notes from re-quoting tax with the tax provider (`taxMode: "app_based"`, e.g. Avalara) under the lenient tax fallback policy: `provider_fallback` (the provider could not answer, so your native tax rules priced the edit), `tax_address_missing` (there is no address to tax from, so no tax was charged), `tax_zero_from_provider` (the provider returned no tax for the address). Under the strict policy the same failures refuse the edit instead (503 / 422).