@leaflow/sdk 0.55.0 → 0.56.1
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.
- package/dist/account/v1/client.d.ts +4 -0
- package/dist/account/v1/client.js +7 -0
- package/dist/account/v1/index.d.ts +27 -26
- package/dist/account/v1/index.js +4 -4
- package/dist/assistant/v1/client.d.ts +4 -0
- package/dist/assistant/v1/client.js +7 -0
- package/dist/assistant/v1/index.d.ts +54 -53
- package/dist/assistant/v1/index.js +4 -4
- package/dist/billing/v1/index.d.ts +95 -95
- package/dist/billing/v1/index.js +3 -3
- package/dist/billing/v1/schema.d.ts +70 -56
- package/dist/canopy/v1/client.d.ts +4 -0
- package/dist/canopy/v1/client.js +7 -0
- package/dist/canopy/v1/index.d.ts +24 -23
- package/dist/canopy/v1/index.js +4 -4
- package/dist/compute/v1/client.d.ts +4 -0
- package/dist/compute/v1/client.js +7 -0
- package/dist/compute/v1/index.d.ts +124 -123
- package/dist/compute/v1/index.js +4 -4
- package/dist/dns/v1/client.d.ts +4 -0
- package/dist/dns/v1/client.js +7 -0
- package/dist/dns/v1/index.d.ts +21 -20
- package/dist/dns/v1/index.js +4 -4
- package/dist/fleet/v1/client.d.ts +4 -0
- package/dist/fleet/v1/client.js +7 -0
- package/dist/fleet/v1/index.d.ts +3 -2
- package/dist/fleet/v1/index.js +4 -4
- package/dist/iam/v1/client.d.ts +4 -0
- package/dist/iam/v1/client.js +7 -0
- package/dist/iam/v1/index.d.ts +42 -41
- package/dist/iam/v1/index.js +4 -4
- package/dist/index.d.ts +12 -12
- package/dist/index.js +20 -5
- package/dist/monitoring/v1/client.d.ts +4 -0
- package/dist/monitoring/v1/client.js +7 -0
- package/dist/monitoring/v1/index.d.ts +88 -87
- package/dist/monitoring/v1/index.js +4 -4
- package/dist/notification/v1/client.d.ts +4 -0
- package/dist/notification/v1/client.js +7 -0
- package/dist/notification/v1/index.d.ts +38 -37
- package/dist/notification/v1/index.js +4 -4
- package/dist/support/v1/client.d.ts +4 -0
- package/dist/support/v1/client.js +7 -0
- package/dist/support/v1/index.d.ts +25 -24
- package/dist/support/v1/index.js +4 -4
- package/dist/tunnel/v1/client.d.ts +4 -0
- package/dist/tunnel/v1/client.js +7 -0
- package/dist/tunnel/v1/index.d.ts +8 -7
- package/dist/tunnel/v1/index.js +4 -4
- package/package.json +6 -4
|
@@ -10,7 +10,7 @@ export interface paths {
|
|
|
10
10
|
path?: never;
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
|
-
/**
|
|
13
|
+
/** List catalog products */
|
|
14
14
|
get: operations["list-catalog-products"];
|
|
15
15
|
put?: never;
|
|
16
16
|
post?: never;
|
|
@@ -29,7 +29,7 @@ export interface paths {
|
|
|
29
29
|
};
|
|
30
30
|
cookie?: never;
|
|
31
31
|
};
|
|
32
|
-
/**
|
|
32
|
+
/** List catalog plans */
|
|
33
33
|
get: operations["list-catalog-plans"];
|
|
34
34
|
put?: never;
|
|
35
35
|
post?: never;
|
|
@@ -49,7 +49,7 @@ export interface paths {
|
|
|
49
49
|
cookie?: never;
|
|
50
50
|
};
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* List catalog prices
|
|
53
53
|
* @description Public list prices only. An account holding a negotiated agreement may be charged less;
|
|
54
54
|
* it is never charged more.
|
|
55
55
|
*/
|
|
@@ -72,7 +72,7 @@ export interface paths {
|
|
|
72
72
|
cookie?: never;
|
|
73
73
|
};
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* List catalog rates
|
|
76
76
|
* @description Only public price lists are readable here. A list written for a single agreement is not,
|
|
77
77
|
* and its identifier cannot be used to reach it.
|
|
78
78
|
*/
|
|
@@ -95,7 +95,7 @@ export interface paths {
|
|
|
95
95
|
get?: never;
|
|
96
96
|
put?: never;
|
|
97
97
|
/**
|
|
98
|
-
* Estimate a
|
|
98
|
+
* Estimate a basket
|
|
99
99
|
* @description Uses public list prices. Nothing is reserved and nothing is recorded, so this may be
|
|
100
100
|
* called as often as required.
|
|
101
101
|
*
|
|
@@ -119,11 +119,11 @@ export interface paths {
|
|
|
119
119
|
path?: never;
|
|
120
120
|
cookie?: never;
|
|
121
121
|
};
|
|
122
|
-
/**
|
|
122
|
+
/** List billing accounts */
|
|
123
123
|
get: operations["list-billing-accounts"];
|
|
124
124
|
put?: never;
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
126
|
+
* Create billing account
|
|
127
127
|
* @description The currency is chosen here and cannot be changed afterwards. Everything charged to the
|
|
128
128
|
* account — prices, orders, invoices, balance — is denominated in it.
|
|
129
129
|
*
|
|
@@ -145,6 +145,7 @@ export interface paths {
|
|
|
145
145
|
};
|
|
146
146
|
cookie?: never;
|
|
147
147
|
};
|
|
148
|
+
/** Get billing account */
|
|
148
149
|
get: operations["get-billing-account"];
|
|
149
150
|
put?: never;
|
|
150
151
|
post?: never;
|
|
@@ -152,7 +153,7 @@ export interface paths {
|
|
|
152
153
|
options?: never;
|
|
153
154
|
head?: never;
|
|
154
155
|
/**
|
|
155
|
-
*
|
|
156
|
+
* Update billing account
|
|
156
157
|
* @description The legal name, address and tax identifier are copied onto each invoice when it is
|
|
157
158
|
* issued. Changing them here affects invoices issued afterwards, not those already sent.
|
|
158
159
|
*
|
|
@@ -170,7 +171,7 @@ export interface paths {
|
|
|
170
171
|
};
|
|
171
172
|
cookie?: never;
|
|
172
173
|
};
|
|
173
|
-
/**
|
|
174
|
+
/** Get account balance */
|
|
174
175
|
get: operations["get-account-balance"];
|
|
175
176
|
put?: never;
|
|
176
177
|
post?: never;
|
|
@@ -187,7 +188,7 @@ export interface paths {
|
|
|
187
188
|
path?: never;
|
|
188
189
|
cookie?: never;
|
|
189
190
|
};
|
|
190
|
-
/**
|
|
191
|
+
/** List paid projects */
|
|
191
192
|
get: operations["list-paid-projects"];
|
|
192
193
|
put?: never;
|
|
193
194
|
post?: never;
|
|
@@ -207,12 +208,12 @@ export interface paths {
|
|
|
207
208
|
cookie?: never;
|
|
208
209
|
};
|
|
209
210
|
/**
|
|
210
|
-
*
|
|
211
|
+
* Find project payer
|
|
211
212
|
* @description Returns 404 when no account pays for it. No resources can be created until one does.
|
|
212
213
|
*/
|
|
213
214
|
get: operations["find-project-payer"];
|
|
214
215
|
/**
|
|
215
|
-
*
|
|
216
|
+
* Set project payer
|
|
216
217
|
* @description Charges already recorded remain with the account that was paying when they occurred, and
|
|
217
218
|
* are still invoiced to it. Metered resources are settled up to the moment of the change.
|
|
218
219
|
*
|
|
@@ -224,7 +225,7 @@ export interface paths {
|
|
|
224
225
|
put: operations["set-project-payer"];
|
|
225
226
|
post?: never;
|
|
226
227
|
/**
|
|
227
|
-
*
|
|
228
|
+
* Unbind project payer
|
|
228
229
|
* @description Permitted only when the project has nothing left to charge: no resources accruing
|
|
229
230
|
* charges, no subscriptions still running, no usage awaiting invoicing, and no unpaid
|
|
230
231
|
* invoice on the account.
|
|
@@ -252,7 +253,7 @@ export interface paths {
|
|
|
252
253
|
get?: never;
|
|
253
254
|
put?: never;
|
|
254
255
|
/**
|
|
255
|
-
*
|
|
256
|
+
* Settle project usage
|
|
256
257
|
* @description Metered usage is normally invoiced at the end of the month. This issues an invoice for
|
|
257
258
|
* everything charged to the project so far, to the account currently paying for it.
|
|
258
259
|
*
|
|
@@ -273,10 +274,11 @@ export interface paths {
|
|
|
273
274
|
path?: never;
|
|
274
275
|
cookie?: never;
|
|
275
276
|
};
|
|
277
|
+
/** List top ups */
|
|
276
278
|
get: operations["list-top-ups"];
|
|
277
279
|
put?: never;
|
|
278
280
|
/**
|
|
279
|
-
*
|
|
281
|
+
* Create top up
|
|
280
282
|
* @description Returns a checkout address. The balance increases when the payment provider confirms the
|
|
281
283
|
* payment, which may be after this call returns.
|
|
282
284
|
*
|
|
@@ -299,7 +301,7 @@ export interface paths {
|
|
|
299
301
|
};
|
|
300
302
|
cookie?: never;
|
|
301
303
|
};
|
|
302
|
-
/**
|
|
304
|
+
/** Get top up */
|
|
303
305
|
get: operations["get-top-up"];
|
|
304
306
|
put?: never;
|
|
305
307
|
post?: never;
|
|
@@ -316,6 +318,7 @@ export interface paths {
|
|
|
316
318
|
path?: never;
|
|
317
319
|
cookie?: never;
|
|
318
320
|
};
|
|
321
|
+
/** List payment methods */
|
|
319
322
|
get: operations["list-payment-methods"];
|
|
320
323
|
put?: never;
|
|
321
324
|
post?: never;
|
|
@@ -335,7 +338,7 @@ export interface paths {
|
|
|
335
338
|
get?: never;
|
|
336
339
|
put?: never;
|
|
337
340
|
/**
|
|
338
|
-
*
|
|
341
|
+
* Create payment method setup
|
|
339
342
|
* @description Returns what is needed to hand the browser over to the payment provider's own card
|
|
340
343
|
* form. Nothing is charged, and the method appears in the list once the provider
|
|
341
344
|
* confirms it.
|
|
@@ -359,7 +362,7 @@ export interface paths {
|
|
|
359
362
|
cookie?: never;
|
|
360
363
|
};
|
|
361
364
|
get?: never;
|
|
362
|
-
/**
|
|
365
|
+
/** Set default payment method */
|
|
363
366
|
put: operations["set-default-payment-method"];
|
|
364
367
|
post?: never;
|
|
365
368
|
delete?: never;
|
|
@@ -381,7 +384,7 @@ export interface paths {
|
|
|
381
384
|
put?: never;
|
|
382
385
|
post?: never;
|
|
383
386
|
/**
|
|
384
|
-
*
|
|
387
|
+
* Delete payment method
|
|
385
388
|
* @description Refused when it is the only method on an account that has resources billed by the hour,
|
|
386
389
|
* as there would be nothing left to charge when the balance runs out.
|
|
387
390
|
*/
|
|
@@ -403,7 +406,7 @@ export interface paths {
|
|
|
403
406
|
get?: never;
|
|
404
407
|
put?: never;
|
|
405
408
|
/**
|
|
406
|
-
* Pay
|
|
409
|
+
* Pay invoice
|
|
407
410
|
* @description Applies the account balance first, then charges the remainder to a payment method. Give
|
|
408
411
|
* `payment_method_id` to choose one, or omit it to use the default.
|
|
409
412
|
*
|
|
@@ -429,7 +432,7 @@ export interface paths {
|
|
|
429
432
|
get?: never;
|
|
430
433
|
put?: never;
|
|
431
434
|
/**
|
|
432
|
-
* Pay
|
|
435
|
+
* Pay together
|
|
433
436
|
* @description All of them or none. Nothing is settled unless everything named here can be, so a
|
|
434
437
|
* partial result is not a state this can leave behind.
|
|
435
438
|
*
|
|
@@ -463,7 +466,7 @@ export interface paths {
|
|
|
463
466
|
get?: never;
|
|
464
467
|
put?: never;
|
|
465
468
|
/**
|
|
466
|
-
*
|
|
469
|
+
* Pay order
|
|
467
470
|
* @description Use this to resume an order whose checkout was interrupted.
|
|
468
471
|
*
|
|
469
472
|
* An order reserves both funds and stock for a limited time. Once that reservation expires
|
|
@@ -484,6 +487,7 @@ export interface paths {
|
|
|
484
487
|
path?: never;
|
|
485
488
|
cookie?: never;
|
|
486
489
|
};
|
|
490
|
+
/** List invoices */
|
|
487
491
|
get: operations["list-invoices"];
|
|
488
492
|
put?: never;
|
|
489
493
|
post?: never;
|
|
@@ -502,6 +506,7 @@ export interface paths {
|
|
|
502
506
|
};
|
|
503
507
|
cookie?: never;
|
|
504
508
|
};
|
|
509
|
+
/** Get invoice */
|
|
505
510
|
get: operations["get-invoice"];
|
|
506
511
|
put?: never;
|
|
507
512
|
post?: never;
|
|
@@ -520,7 +525,7 @@ export interface paths {
|
|
|
520
525
|
};
|
|
521
526
|
cookie?: never;
|
|
522
527
|
};
|
|
523
|
-
/**
|
|
528
|
+
/** List invoice items */
|
|
524
529
|
get: operations["list-invoice-items"];
|
|
525
530
|
put?: never;
|
|
526
531
|
post?: never;
|
|
@@ -540,7 +545,7 @@ export interface paths {
|
|
|
540
545
|
cookie?: never;
|
|
541
546
|
};
|
|
542
547
|
/**
|
|
543
|
-
*
|
|
548
|
+
* Get invoice refund quote
|
|
544
549
|
* @description Show this before asking for a refund. Nothing is recorded and nothing is reserved; the
|
|
545
550
|
* answer follows from what has been paid and what has already been returned, so it may
|
|
546
551
|
* be read as often as required.
|
|
@@ -564,7 +569,7 @@ export interface paths {
|
|
|
564
569
|
path?: never;
|
|
565
570
|
cookie?: never;
|
|
566
571
|
};
|
|
567
|
-
/**
|
|
572
|
+
/** List transactions */
|
|
568
573
|
get: operations["list-transactions"];
|
|
569
574
|
put?: never;
|
|
570
575
|
post?: never;
|
|
@@ -582,7 +587,7 @@ export interface paths {
|
|
|
582
587
|
cookie?: never;
|
|
583
588
|
};
|
|
584
589
|
/**
|
|
585
|
-
*
|
|
590
|
+
* List credit grants
|
|
586
591
|
* @description Each grant shows what remains and what it may be used for. Credit is spent before cash
|
|
587
592
|
* and cannot be withdrawn.
|
|
588
593
|
*/
|
|
@@ -603,7 +608,7 @@ export interface paths {
|
|
|
603
608
|
cookie?: never;
|
|
604
609
|
};
|
|
605
610
|
/**
|
|
606
|
-
*
|
|
611
|
+
* List allocations
|
|
607
612
|
* @description Give `source_id` to follow one top-up or grant through to everything it paid for. Give
|
|
608
613
|
* `target_id` to see which sources paid for one line of an invoice.
|
|
609
614
|
*
|
|
@@ -626,10 +631,11 @@ export interface paths {
|
|
|
626
631
|
path?: never;
|
|
627
632
|
cookie?: never;
|
|
628
633
|
};
|
|
634
|
+
/** List refunds */
|
|
629
635
|
get: operations["list-refunds"];
|
|
630
636
|
put?: never;
|
|
631
637
|
/**
|
|
632
|
-
*
|
|
638
|
+
* Request refund
|
|
633
639
|
* @description Refunding ends the subscription and reclaims whatever it provisioned. That is the
|
|
634
640
|
* difference from letting a period lapse: a lapsed period keeps the machine around
|
|
635
641
|
* for a while so that topping up brings it back, whereas a refund returns the money
|
|
@@ -656,7 +662,7 @@ export interface paths {
|
|
|
656
662
|
cookie?: never;
|
|
657
663
|
};
|
|
658
664
|
/**
|
|
659
|
-
*
|
|
665
|
+
* List usage charges
|
|
660
666
|
* @description Includes charges that have not been invoiced yet, which is how the current month's
|
|
661
667
|
* spending is seen before the invoice is issued.
|
|
662
668
|
*/
|
|
@@ -676,6 +682,7 @@ export interface paths {
|
|
|
676
682
|
path?: never;
|
|
677
683
|
cookie?: never;
|
|
678
684
|
};
|
|
685
|
+
/** List subscriptions */
|
|
679
686
|
get: operations["list-subscriptions"];
|
|
680
687
|
put?: never;
|
|
681
688
|
post?: never;
|
|
@@ -692,7 +699,7 @@ export interface paths {
|
|
|
692
699
|
path?: never;
|
|
693
700
|
cookie?: never;
|
|
694
701
|
};
|
|
695
|
-
/**
|
|
702
|
+
/** List subscription items */
|
|
696
703
|
get: operations["list-subscription-items"];
|
|
697
704
|
put?: never;
|
|
698
705
|
post?: never;
|
|
@@ -714,7 +721,7 @@ export interface paths {
|
|
|
714
721
|
get?: never;
|
|
715
722
|
put?: never;
|
|
716
723
|
/**
|
|
717
|
-
* Renew
|
|
724
|
+
* Renew subscription item
|
|
718
725
|
* @description Extends the paid period from its current end, not from today, so renewing early does not
|
|
719
726
|
* shorten what has already been paid for.
|
|
720
727
|
*
|
|
@@ -739,7 +746,7 @@ export interface paths {
|
|
|
739
746
|
};
|
|
740
747
|
get?: never;
|
|
741
748
|
/**
|
|
742
|
-
*
|
|
749
|
+
* Set auto renew
|
|
743
750
|
* @description When on, the account balance is charged at the renewal date. Turning it off lets the
|
|
744
751
|
* current period run to its end and stops the resource afterwards.
|
|
745
752
|
*/
|
|
@@ -761,7 +768,7 @@ export interface paths {
|
|
|
761
768
|
get?: never;
|
|
762
769
|
put?: never;
|
|
763
770
|
/**
|
|
764
|
-
*
|
|
771
|
+
* Preview code
|
|
765
772
|
* @description Nothing is recorded and the code is not consumed. Use it to show the customer the effect
|
|
766
773
|
* before they commit.
|
|
767
774
|
*/
|
|
@@ -782,7 +789,7 @@ export interface paths {
|
|
|
782
789
|
get?: never;
|
|
783
790
|
put?: never;
|
|
784
791
|
/**
|
|
785
|
-
* Redeem
|
|
792
|
+
* Redeem code
|
|
786
793
|
* @description A voucher code adds credit to the account. A discount code records the entitlement, which
|
|
787
794
|
* is then applied to the next qualifying purchase.
|
|
788
795
|
*
|
|
@@ -806,7 +813,7 @@ export interface paths {
|
|
|
806
813
|
cookie?: never;
|
|
807
814
|
};
|
|
808
815
|
/**
|
|
809
|
-
*
|
|
816
|
+
* Get project billing account
|
|
810
817
|
* @description A deliberately narrow view: the payer's identity, its currency, and how much can still
|
|
811
818
|
* be spent. Cards, invoices and transaction history are not included; they belong to the
|
|
812
819
|
* account owner and are reached through `/account/v1/`.
|
|
@@ -833,7 +840,7 @@ export interface paths {
|
|
|
833
840
|
cookie?: never;
|
|
834
841
|
};
|
|
835
842
|
/**
|
|
836
|
-
*
|
|
843
|
+
* List project spend
|
|
837
844
|
* @description Covers a closed time range. Both bounds are required: a total without a stated period
|
|
838
845
|
* cannot be reconciled against an invoice.
|
|
839
846
|
*
|
|
@@ -858,7 +865,7 @@ export interface paths {
|
|
|
858
865
|
cookie?: never;
|
|
859
866
|
};
|
|
860
867
|
/**
|
|
861
|
-
*
|
|
868
|
+
* List project usage charges
|
|
862
869
|
* @description The individual charges behind the figures in `/spend`. Amounts here sum to the totals
|
|
863
870
|
* reported there over the same period.
|
|
864
871
|
*/
|
|
@@ -880,7 +887,7 @@ export interface paths {
|
|
|
880
887
|
};
|
|
881
888
|
cookie?: never;
|
|
882
889
|
};
|
|
883
|
-
/**
|
|
890
|
+
/** List project subscriptions */
|
|
884
891
|
get: operations["list-project-subscriptions"];
|
|
885
892
|
put?: never;
|
|
886
893
|
post?: never;
|
|
@@ -899,7 +906,7 @@ export interface paths {
|
|
|
899
906
|
};
|
|
900
907
|
cookie?: never;
|
|
901
908
|
};
|
|
902
|
-
/**
|
|
909
|
+
/** List project subscription items */
|
|
903
910
|
get: operations["list-project-subscription-items"];
|
|
904
911
|
put?: never;
|
|
905
912
|
post?: never;
|
|
@@ -921,7 +928,7 @@ export interface paths {
|
|
|
921
928
|
};
|
|
922
929
|
get?: never;
|
|
923
930
|
/**
|
|
924
|
-
*
|
|
931
|
+
* Set project auto renew
|
|
925
932
|
* @description Automatic renewal draws on the paying account's balance, which a project member may
|
|
926
933
|
* commit. Paying by card requires the account owner and is done from the billing centre.
|
|
927
934
|
*/
|
|
@@ -943,7 +950,7 @@ export interface paths {
|
|
|
943
950
|
cookie?: never;
|
|
944
951
|
};
|
|
945
952
|
/**
|
|
946
|
-
*
|
|
953
|
+
* List project orders
|
|
947
954
|
* @description An order awaiting payment shows what is outstanding. Paying it is done from the billing
|
|
948
955
|
* centre by the account owner.
|
|
949
956
|
*/
|
|
@@ -966,6 +973,7 @@ export interface paths {
|
|
|
966
973
|
};
|
|
967
974
|
cookie?: never;
|
|
968
975
|
};
|
|
976
|
+
/** Get project order */
|
|
969
977
|
get: operations["get-project-order"];
|
|
970
978
|
put?: never;
|
|
971
979
|
post?: never;
|
|
@@ -985,7 +993,7 @@ export interface paths {
|
|
|
985
993
|
cookie?: never;
|
|
986
994
|
};
|
|
987
995
|
/**
|
|
988
|
-
*
|
|
996
|
+
* List project active resources
|
|
989
997
|
* @description A resource that is running but does not appear here is not being charged for.
|
|
990
998
|
*/
|
|
991
999
|
get: operations["list-project-active-resources"];
|
|
@@ -1009,7 +1017,7 @@ export interface paths {
|
|
|
1009
1017
|
get?: never;
|
|
1010
1018
|
put?: never;
|
|
1011
1019
|
/**
|
|
1012
|
-
*
|
|
1020
|
+
* Quote for a project
|
|
1013
1021
|
* @description Priced in the paying account's currency, and at any rate negotiated for that account.
|
|
1014
1022
|
* Nothing is reserved and nothing is recorded, so this may be called as often as required.
|
|
1015
1023
|
*
|
|
@@ -1034,7 +1042,7 @@ export interface paths {
|
|
|
1034
1042
|
cookie?: never;
|
|
1035
1043
|
};
|
|
1036
1044
|
/**
|
|
1037
|
-
*
|
|
1045
|
+
* List allowances
|
|
1038
1046
|
* @description A quantity rather than an amount of money: bytes, seconds or tokens that are used before
|
|
1039
1047
|
* anything is charged for.
|
|
1040
1048
|
*
|
|
@@ -1066,7 +1074,7 @@ export interface paths {
|
|
|
1066
1074
|
cookie?: never;
|
|
1067
1075
|
};
|
|
1068
1076
|
/**
|
|
1069
|
-
*
|
|
1077
|
+
* List allowance consumptions
|
|
1070
1078
|
* @description Each entry names the charge it covered, so the granted amount, what has been used and
|
|
1071
1079
|
* what remains all reconcile.
|
|
1072
1080
|
*/
|
|
@@ -1087,7 +1095,7 @@ export interface paths {
|
|
|
1087
1095
|
cookie?: never;
|
|
1088
1096
|
};
|
|
1089
1097
|
/**
|
|
1090
|
-
*
|
|
1098
|
+
* List orders
|
|
1091
1099
|
* @description An order in `pending` still owes money; `amount_due` states how much and
|
|
1092
1100
|
* `reservation_expires_at` states how long it can still be paid.
|
|
1093
1101
|
*/
|
|
@@ -1109,6 +1117,7 @@ export interface paths {
|
|
|
1109
1117
|
};
|
|
1110
1118
|
cookie?: never;
|
|
1111
1119
|
};
|
|
1120
|
+
/** Get order */
|
|
1112
1121
|
get: operations["get-order"];
|
|
1113
1122
|
put?: never;
|
|
1114
1123
|
post?: never;
|
|
@@ -1130,7 +1139,7 @@ export interface paths {
|
|
|
1130
1139
|
get?: never;
|
|
1131
1140
|
put?: never;
|
|
1132
1141
|
/**
|
|
1133
|
-
*
|
|
1142
|
+
* Cancel scheduled change
|
|
1134
1143
|
* @description Only for a change scheduled for the end of the period, and only while it is still
|
|
1135
1144
|
* pending. An immediate change has already happened by the time it is placed, and there is
|
|
1136
1145
|
* nothing to call off.
|
|
@@ -1155,7 +1164,7 @@ export interface paths {
|
|
|
1155
1164
|
cookie?: never;
|
|
1156
1165
|
};
|
|
1157
1166
|
/**
|
|
1158
|
-
*
|
|
1167
|
+
* List order items
|
|
1159
1168
|
* @description One entry per item bought, with the price charged and the period it covers.
|
|
1160
1169
|
*/
|
|
1161
1170
|
get: operations["list-order-items"];
|
|
@@ -1177,7 +1186,7 @@ export interface paths {
|
|
|
1177
1186
|
cookie?: never;
|
|
1178
1187
|
};
|
|
1179
1188
|
/**
|
|
1180
|
-
*
|
|
1189
|
+
* Get order refund quote
|
|
1181
1190
|
* @description Show this before asking for a refund. Nothing is recorded and nothing is reserved; the
|
|
1182
1191
|
* answer follows from what has been paid and what has already been returned, so it may
|
|
1183
1192
|
* be read as often as required.
|
|
@@ -1207,7 +1216,7 @@ export interface paths {
|
|
|
1207
1216
|
};
|
|
1208
1217
|
cookie?: never;
|
|
1209
1218
|
};
|
|
1210
|
-
/**
|
|
1219
|
+
/** List project order items */
|
|
1211
1220
|
get: operations["list-project-order-items"];
|
|
1212
1221
|
put?: never;
|
|
1213
1222
|
post?: never;
|
|
@@ -1227,7 +1236,7 @@ export interface paths {
|
|
|
1227
1236
|
cookie?: never;
|
|
1228
1237
|
};
|
|
1229
1238
|
/**
|
|
1230
|
-
*
|
|
1239
|
+
* List project allowances
|
|
1231
1240
|
* @description These belong to the paying account and are shared with every other project it pays for,
|
|
1232
1241
|
* so what is left here may be consumed elsewhere.
|
|
1233
1242
|
*/
|
|
@@ -1248,7 +1257,7 @@ export interface paths {
|
|
|
1248
1257
|
cookie?: never;
|
|
1249
1258
|
};
|
|
1250
1259
|
/**
|
|
1251
|
-
*
|
|
1260
|
+
* List entitlements
|
|
1252
1261
|
* @description Capabilities that come with what has been bought. A capability that is not held simply
|
|
1253
1262
|
* does not appear, so that "this does not exist" and "this has not been bought" cannot be
|
|
1254
1263
|
* confused.
|
|
@@ -1275,7 +1284,7 @@ export interface paths {
|
|
|
1275
1284
|
cookie?: never;
|
|
1276
1285
|
};
|
|
1277
1286
|
/**
|
|
1278
|
-
*
|
|
1287
|
+
* List project entitlements
|
|
1279
1288
|
* @description Includes capabilities bought for this project and those the paying account holds at
|
|
1280
1289
|
* account level.
|
|
1281
1290
|
*
|
|
@@ -1393,7 +1402,7 @@ export interface components {
|
|
|
1393
1402
|
allowances?: components["schemas"]["IncludedAllowance"][];
|
|
1394
1403
|
/** @description Capabilities that buying this price makes available. */
|
|
1395
1404
|
features?: components["schemas"]["IncludedFeature"][];
|
|
1396
|
-
/** @description For prepaid prices */
|
|
1405
|
+
/** @description For prepaid prices, how many periods one purchase covers. */
|
|
1397
1406
|
term?: number;
|
|
1398
1407
|
/** @enum {string} */
|
|
1399
1408
|
period?: "none" | "day" | "month" | "year";
|
|
@@ -2084,7 +2093,7 @@ export interface components {
|
|
|
2084
2093
|
/** @description Signed. Positive increases the balance, negative reduces it. */
|
|
2085
2094
|
amount: components["schemas"]["Money"];
|
|
2086
2095
|
currency: string;
|
|
2087
|
-
/** @description Why */
|
|
2096
|
+
/** @description Why the money moved, on a manual adjustment. */
|
|
2088
2097
|
reason?: string;
|
|
2089
2098
|
/** Format: uuid */
|
|
2090
2099
|
invoice_id?: string | null;
|
|
@@ -2421,7 +2430,7 @@ export interface components {
|
|
|
2421
2430
|
ActiveResource: {
|
|
2422
2431
|
resource_id: string;
|
|
2423
2432
|
product_key: string;
|
|
2424
|
-
/** @description What it is */
|
|
2433
|
+
/** @description What it is, as its own service names it. */
|
|
2425
2434
|
resource_type?: string;
|
|
2426
2435
|
meter_key: string;
|
|
2427
2436
|
unit?: string;
|
|
@@ -2663,6 +2672,11 @@ export interface components {
|
|
|
2663
2672
|
* @description Which service this line belongs to.
|
|
2664
2673
|
*/
|
|
2665
2674
|
product_id?: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* @description How that service is named, such as `compute`. Read from the catalogue rather than
|
|
2677
|
+
* recorded on the line, so it always matches the service it points at.
|
|
2678
|
+
*/
|
|
2679
|
+
product_key?: string;
|
|
2666
2680
|
/**
|
|
2667
2681
|
* Format: uuid
|
|
2668
2682
|
* @description Which plan was bought.
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type ClientOptions } from "openapi-fetch";
|
|
2
|
+
import type { paths } from "./schema.js";
|
|
3
|
+
/** A client for the canopy service. Pass baseUrl to override the address. */
|
|
4
|
+
export declare function client(options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Code generated from the contract's servers[0]. DO NOT EDIT.
|
|
2
|
+
import createClient, {} from "openapi-fetch";
|
|
3
|
+
const defaultBaseUrl = "https://canopy.leaflow.cloud";
|
|
4
|
+
/** A client for the canopy service. Pass baseUrl to override the address. */
|
|
5
|
+
export function client(options = {}) {
|
|
6
|
+
return createClient({ baseUrl: defaultBaseUrl, ...options });
|
|
7
|
+
}
|
|
@@ -1,48 +1,49 @@
|
|
|
1
1
|
export type { paths, components, operations, webhooks } from "./schema.js";
|
|
2
|
+
export { client } from "./client.js";
|
|
2
3
|
import type { operations } from "./schema.js";
|
|
3
|
-
/** `GET /api/v1/keys
|
|
4
|
+
/** The success response body of `GET /api/v1/keys`. */
|
|
4
5
|
export type ListApiKeysResult = operations["list-api-keys"]["responses"][200]["content"]["application/json"];
|
|
5
|
-
/** `GET /api/v1/keys
|
|
6
|
+
/** The query parameters of `GET /api/v1/keys`. */
|
|
6
7
|
export type ListApiKeysQuery = operations["list-api-keys"]["parameters"]["query"];
|
|
7
|
-
/** `POST /api/v1/keys
|
|
8
|
+
/** The success response body of `POST /api/v1/keys`. */
|
|
8
9
|
export type CreateApiKeyResult = operations["create-api-key"]["responses"][201]["content"]["application/json"];
|
|
9
|
-
/** `POST /api/v1/keys
|
|
10
|
+
/** The request body of `POST /api/v1/keys`. */
|
|
10
11
|
export type CreateApiKeyBody = NonNullable<operations["create-api-key"]["requestBody"]>["content"]["application/json"];
|
|
11
|
-
/** `GET /api/v1/keys/{keyId}
|
|
12
|
+
/** The success response body of `GET /api/v1/keys/{keyId}`. */
|
|
12
13
|
export type GetApiKeyResult = operations["get-api-key"]["responses"][200]["content"]["application/json"];
|
|
13
|
-
/** `PATCH /api/v1/keys/{keyId}
|
|
14
|
+
/** The success response body of `PATCH /api/v1/keys/{keyId}`. */
|
|
14
15
|
export type UpdateApiKeyResult = operations["update-api-key"]["responses"][200]["content"]["application/json"];
|
|
15
|
-
/** `PATCH /api/v1/keys/{keyId}
|
|
16
|
+
/** The request body of `PATCH /api/v1/keys/{keyId}`. */
|
|
16
17
|
export type UpdateApiKeyBody = NonNullable<operations["update-api-key"]["requestBody"]>["content"]["application/json"];
|
|
17
|
-
/** `POST /api/v1/keys/{keyId}/disable
|
|
18
|
+
/** The success response body of `POST /api/v1/keys/{keyId}/disable`. */
|
|
18
19
|
export type DisableApiKeyResult = operations["disable-api-key"]["responses"][200]["content"]["application/json"];
|
|
19
|
-
/** `POST /api/v1/keys/{keyId}/enable
|
|
20
|
+
/** The success response body of `POST /api/v1/keys/{keyId}/enable`. */
|
|
20
21
|
export type EnableApiKeyResult = operations["enable-api-key"]["responses"][200]["content"]["application/json"];
|
|
21
|
-
/** `POST /api/v1/keys/{keyId}/revoke
|
|
22
|
+
/** The success response body of `POST /api/v1/keys/{keyId}/revoke`. */
|
|
22
23
|
export type RevokeApiKeyResult = operations["revoke-api-key"]["responses"][200]["content"]["application/json"];
|
|
23
|
-
/** `GET /api/v1/models
|
|
24
|
+
/** The success response body of `GET /api/v1/models`. */
|
|
24
25
|
export type ListModelsResult = operations["list-models"]["responses"][200]["content"]["application/json"];
|
|
25
|
-
/** `GET /api/v1/models/{modelId}
|
|
26
|
+
/** The success response body of `GET /api/v1/models/{modelId}`. */
|
|
26
27
|
export type GetModelResult = operations["get-model"]["responses"][200]["content"]["application/json"];
|
|
27
|
-
/** `GET /api/v1/requests
|
|
28
|
+
/** The success response body of `GET /api/v1/requests`. */
|
|
28
29
|
export type ListRequestsResult = operations["list-requests"]["responses"][200]["content"]["application/json"];
|
|
29
|
-
/** `GET /api/v1/requests
|
|
30
|
+
/** The query parameters of `GET /api/v1/requests`. */
|
|
30
31
|
export type ListRequestsQuery = operations["list-requests"]["parameters"]["query"];
|
|
31
|
-
/** `GET /api/v1/requests/{requestId}
|
|
32
|
+
/** The success response body of `GET /api/v1/requests/{requestId}`. */
|
|
32
33
|
export type GetRequestResult = operations["get-request"]["responses"][200]["content"]["application/json"];
|
|
33
|
-
/** `GET /api/v1/usage/by-api-key
|
|
34
|
+
/** The success response body of `GET /api/v1/usage/by-api-key`. */
|
|
34
35
|
export type ListUsageByApiKeyResult = operations["list-usage-by-api-key"]["responses"][200]["content"]["application/json"];
|
|
35
|
-
/** `GET /api/v1/usage/by-api-key
|
|
36
|
+
/** The query parameters of `GET /api/v1/usage/by-api-key`. */
|
|
36
37
|
export type ListUsageByApiKeyQuery = operations["list-usage-by-api-key"]["parameters"]["query"];
|
|
37
|
-
/** `GET /api/v1/usage/by-model
|
|
38
|
+
/** The success response body of `GET /api/v1/usage/by-model`. */
|
|
38
39
|
export type ListUsageByModelResult = operations["list-usage-by-model"]["responses"][200]["content"]["application/json"];
|
|
39
|
-
/** `GET /api/v1/usage/by-model
|
|
40
|
+
/** The query parameters of `GET /api/v1/usage/by-model`. */
|
|
40
41
|
export type ListUsageByModelQuery = operations["list-usage-by-model"]["parameters"]["query"];
|
|
41
|
-
/** `GET /api/v1/usage/summary
|
|
42
|
+
/** The success response body of `GET /api/v1/usage/summary`. */
|
|
42
43
|
export type GetUsageSummaryResult = operations["get-usage-summary"]["responses"][200]["content"]["application/json"];
|
|
43
|
-
/** `GET /api/v1/usage/summary
|
|
44
|
+
/** The query parameters of `GET /api/v1/usage/summary`. */
|
|
44
45
|
export type GetUsageSummaryQuery = operations["get-usage-summary"]["parameters"]["query"];
|
|
45
|
-
/** `GET /api/v1/usage/timeline
|
|
46
|
+
/** The success response body of `GET /api/v1/usage/timeline`. */
|
|
46
47
|
export type GetUsageTimelineResult = operations["get-usage-timeline"]["responses"][200]["content"]["application/json"];
|
|
47
|
-
/** `GET /api/v1/usage/timeline
|
|
48
|
+
/** The query parameters of `GET /api/v1/usage/timeline`. */
|
|
48
49
|
export type GetUsageTimelineQuery = operations["get-usage-timeline"]["parameters"]["query"];
|
package/dist/canopy/v1/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by scripts/generate.mjs. DO NOT EDIT.
|
|
2
2
|
//
|
|
3
|
-
//
|
|
4
|
-
//
|
|
5
|
-
export {};
|
|
3
|
+
// The aliases replace the operations[...] subscript chain with a name. The raw paths /
|
|
4
|
+
// components / operations are exported as well: paths is what createClient<paths>() takes.
|
|
5
|
+
export { client } from "./client.js";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type ClientOptions } from "openapi-fetch";
|
|
2
|
+
import type { paths } from "./schema.js";
|
|
3
|
+
/** A client for the compute service. Pass baseUrl to override the address. */
|
|
4
|
+
export declare function client(options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;
|