lark-billing 0.0.5 → 0.0.6

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 (123) hide show
  1. package/README.md +10 -10
  2. package/dist/cjs/Client.d.ts +1 -6
  3. package/dist/cjs/Client.js +2 -12
  4. package/dist/cjs/api/resources/checkout/client/Client.d.ts +19 -4
  5. package/dist/cjs/api/resources/checkout/client/Client.js +78 -9
  6. package/dist/cjs/api/resources/checkout/client/requests/{CreateRateCardCheckoutRequest.d.ts → CreateSubscriptionCheckoutSessionRequest.d.ts} +1 -1
  7. package/dist/cjs/api/resources/checkout/client/requests/index.d.ts +1 -1
  8. package/dist/cjs/api/resources/featureAccess/client/Client.d.ts +4 -0
  9. package/dist/cjs/api/resources/featureAccess/client/Client.js +7 -1
  10. package/dist/cjs/api/resources/index.d.ts +0 -2
  11. package/dist/cjs/api/resources/index.js +1 -3
  12. package/dist/cjs/api/resources/rateCards/client/Client.d.ts +8 -0
  13. package/dist/cjs/api/resources/rateCards/client/Client.js +16 -6
  14. package/dist/cjs/api/resources/rateCards/client/requests/CreateRateCardRequest.d.ts +1 -0
  15. package/dist/cjs/api/resources/rateCards/client/requests/CreateRateCardVersionRequest.d.ts +3 -0
  16. package/dist/cjs/api/resources/subjects/client/Client.d.ts +4 -0
  17. package/dist/cjs/api/resources/subjects/client/Client.js +11 -5
  18. package/dist/cjs/api/resources/subscriptions/client/Client.d.ts +4 -0
  19. package/dist/cjs/api/resources/subscriptions/client/Client.js +11 -5
  20. package/dist/cjs/api/resources/usageEvents/client/Client.d.ts +23 -0
  21. package/dist/cjs/api/resources/usageEvents/client/Client.js +75 -1
  22. package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventRequest.d.ts +1 -1
  23. package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.d.ts +30 -0
  24. package/dist/cjs/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.js +14 -0
  25. package/dist/cjs/api/resources/usageEvents/client/requests/index.d.ts +1 -0
  26. package/dist/cjs/api/types/CompleteSubscriptionCheckoutResponse.d.ts +8 -0
  27. package/dist/cjs/api/types/CreateDimensionalUsageBasedRateInterface.d.ts +2 -0
  28. package/dist/cjs/api/types/CreateFixedRateInterface.d.ts +1 -0
  29. package/dist/cjs/api/types/CreatePricingMetricInterface.d.ts +1 -0
  30. package/dist/cjs/api/types/CreateSimpleUsageBasedRateInterface.d.ts +2 -0
  31. package/dist/cjs/api/types/CreateSubscriptionCheckoutSessionResponse.d.ts +10 -0
  32. package/dist/cjs/api/{resources/creditPools/client/index.js → types/CreateSubscriptionCheckoutSessionResponse.js} +3 -0
  33. package/dist/cjs/api/types/CreateUsageEventSummaryResponse.d.ts +10 -0
  34. package/dist/cjs/api/{resources/pricingPlans/client/index.js → types/CreateUsageEventSummaryResponse.js} +3 -0
  35. package/dist/cjs/api/types/CustomAggregationPricingMetricInterface.d.ts +1 -0
  36. package/dist/cjs/api/types/DimensionalUsageBasedRateInterface.d.ts +3 -0
  37. package/dist/cjs/api/types/FixedRateInterface.d.ts +2 -0
  38. package/dist/cjs/api/types/LastAggregationPricingMetricInterface.d.ts +1 -0
  39. package/dist/cjs/api/types/MaxAggregationPricingMetricInterface.d.ts +1 -0
  40. package/dist/cjs/api/types/Period.d.ts +9 -0
  41. package/dist/cjs/api/types/Period.js +5 -0
  42. package/dist/cjs/api/types/PricingMetricInterface.d.ts +2 -0
  43. package/dist/cjs/api/types/SimpleUsageBasedRateInterface.d.ts +3 -0
  44. package/dist/cjs/api/types/SumAggregationPricingMetricInterface.d.ts +1 -0
  45. package/dist/cjs/api/types/index.d.ts +4 -1
  46. package/dist/cjs/api/types/index.js +4 -1
  47. package/dist/cjs/version.d.ts +1 -1
  48. package/dist/cjs/version.js +1 -1
  49. package/dist/esm/Client.d.mts +1 -6
  50. package/dist/esm/Client.mjs +2 -12
  51. package/dist/esm/api/resources/checkout/client/Client.d.mts +19 -4
  52. package/dist/esm/api/resources/checkout/client/Client.mjs +79 -10
  53. package/dist/esm/api/resources/checkout/client/requests/{CreateRateCardCheckoutRequest.d.mts → CreateSubscriptionCheckoutSessionRequest.d.mts} +1 -1
  54. package/dist/esm/api/resources/checkout/client/requests/index.d.mts +1 -1
  55. package/dist/esm/api/resources/featureAccess/client/Client.d.mts +4 -0
  56. package/dist/esm/api/resources/featureAccess/client/Client.mjs +8 -2
  57. package/dist/esm/api/resources/index.d.mts +0 -2
  58. package/dist/esm/api/resources/index.mjs +0 -2
  59. package/dist/esm/api/resources/rateCards/client/Client.d.mts +8 -0
  60. package/dist/esm/api/resources/rateCards/client/Client.mjs +17 -7
  61. package/dist/esm/api/resources/rateCards/client/requests/CreateRateCardRequest.d.mts +1 -0
  62. package/dist/esm/api/resources/rateCards/client/requests/CreateRateCardVersionRequest.d.mts +3 -0
  63. package/dist/esm/api/resources/subjects/client/Client.d.mts +4 -0
  64. package/dist/esm/api/resources/subjects/client/Client.mjs +12 -6
  65. package/dist/esm/api/resources/subscriptions/client/Client.d.mts +4 -0
  66. package/dist/esm/api/resources/subscriptions/client/Client.mjs +12 -6
  67. package/dist/esm/api/resources/usageEvents/client/Client.d.mts +23 -0
  68. package/dist/esm/api/resources/usageEvents/client/Client.mjs +76 -2
  69. package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventRequest.d.mts +1 -1
  70. package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.d.mts +30 -0
  71. package/dist/esm/api/resources/usageEvents/client/requests/CreateUsageEventSummaryRequest.mjs +11 -0
  72. package/dist/esm/api/resources/usageEvents/client/requests/index.d.mts +1 -0
  73. package/dist/esm/api/types/CompleteSubscriptionCheckoutResponse.d.mts +8 -0
  74. package/dist/esm/api/types/CreateDimensionalUsageBasedRateInterface.d.mts +2 -0
  75. package/dist/esm/api/types/CreateFixedRateInterface.d.mts +1 -0
  76. package/dist/esm/api/types/CreatePricingMetricInterface.d.mts +1 -0
  77. package/dist/esm/api/types/CreateSimpleUsageBasedRateInterface.d.mts +2 -0
  78. package/dist/esm/api/types/CreateSubscriptionCheckoutSessionResponse.d.mts +10 -0
  79. package/dist/{cjs/api/types/CreateRateCardCheckoutResponse.d.ts → esm/api/types/CreateSubscriptionCheckoutSessionResponse.mjs} +1 -3
  80. package/dist/esm/api/types/CreateUsageEventSummaryResponse.d.mts +10 -0
  81. package/dist/esm/api/types/{CreateRateCardCheckoutResponse.d.mts → CreateUsageEventSummaryResponse.mjs} +1 -3
  82. package/dist/esm/api/types/CustomAggregationPricingMetricInterface.d.mts +1 -0
  83. package/dist/esm/api/types/DimensionalUsageBasedRateInterface.d.mts +3 -0
  84. package/dist/esm/api/types/FixedRateInterface.d.mts +2 -0
  85. package/dist/esm/api/types/LastAggregationPricingMetricInterface.d.mts +1 -0
  86. package/dist/esm/api/types/MaxAggregationPricingMetricInterface.d.mts +1 -0
  87. package/dist/esm/api/types/Period.d.mts +9 -0
  88. package/dist/esm/api/types/Period.mjs +4 -0
  89. package/dist/esm/api/types/PricingMetricInterface.d.mts +2 -0
  90. package/dist/esm/api/types/SimpleUsageBasedRateInterface.d.mts +3 -0
  91. package/dist/esm/api/types/SumAggregationPricingMetricInterface.d.mts +1 -0
  92. package/dist/esm/api/types/index.d.mts +4 -1
  93. package/dist/esm/api/types/index.mjs +4 -1
  94. package/dist/esm/version.d.mts +1 -1
  95. package/dist/esm/version.mjs +1 -1
  96. package/package.json +1 -1
  97. package/reference.md +111 -351
  98. package/dist/cjs/api/resources/creditPools/client/Client.d.ts +0 -53
  99. package/dist/cjs/api/resources/creditPools/client/Client.js +0 -204
  100. package/dist/cjs/api/resources/creditPools/client/index.d.ts +0 -1
  101. package/dist/cjs/api/resources/creditPools/index.d.ts +0 -1
  102. package/dist/cjs/api/resources/creditPools/index.js +0 -17
  103. package/dist/cjs/api/resources/pricingPlans/client/Client.d.ts +0 -72
  104. package/dist/cjs/api/resources/pricingPlans/client/Client.js +0 -305
  105. package/dist/cjs/api/resources/pricingPlans/client/index.d.ts +0 -1
  106. package/dist/cjs/api/resources/pricingPlans/index.d.ts +0 -1
  107. package/dist/cjs/api/resources/pricingPlans/index.js +0 -17
  108. package/dist/esm/api/resources/creditPools/client/Client.d.mts +0 -53
  109. package/dist/esm/api/resources/creditPools/client/Client.mjs +0 -167
  110. package/dist/esm/api/resources/creditPools/client/index.d.mts +0 -1
  111. package/dist/esm/api/resources/creditPools/client/index.mjs +0 -1
  112. package/dist/esm/api/resources/creditPools/index.d.mts +0 -1
  113. package/dist/esm/api/resources/creditPools/index.mjs +0 -1
  114. package/dist/esm/api/resources/pricingPlans/client/Client.d.mts +0 -72
  115. package/dist/esm/api/resources/pricingPlans/client/Client.mjs +0 -268
  116. package/dist/esm/api/resources/pricingPlans/client/index.d.mts +0 -1
  117. package/dist/esm/api/resources/pricingPlans/client/index.mjs +0 -1
  118. package/dist/esm/api/resources/pricingPlans/index.d.mts +0 -1
  119. package/dist/esm/api/resources/pricingPlans/index.mjs +0 -1
  120. /package/dist/cjs/api/resources/checkout/client/requests/{CreateRateCardCheckoutRequest.js → CreateSubscriptionCheckoutSessionRequest.js} +0 -0
  121. /package/dist/cjs/api/types/{CreateRateCardCheckoutResponse.js → CompleteSubscriptionCheckoutResponse.js} +0 -0
  122. /package/dist/esm/api/resources/checkout/client/requests/{CreateRateCardCheckoutRequest.mjs → CreateSubscriptionCheckoutSessionRequest.mjs} +0 -0
  123. /package/dist/esm/api/types/{CreateRateCardCheckoutResponse.mjs → CompleteSubscriptionCheckoutResponse.mjs} +0 -0
package/reference.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Checkout
4
4
 
5
- <details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">createRateCardCheckoutSession</a>({ ...params }) -> Lark.CreateRateCardCheckoutResponse</code></summary>
5
+ <details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">createSubscriptionCheckoutSession</a>({ ...params }) -> Lark.CreateSubscriptionCheckoutSessionResponse</code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -15,7 +15,7 @@
15
15
  <dd>
16
16
 
17
17
  ```typescript
18
- await client.checkout.createRateCardCheckoutSession({
18
+ await client.checkout.createSubscriptionCheckoutSession({
19
19
  subject_id: "subject_id",
20
20
  rate_card_id: "rate_card_id",
21
21
  });
@@ -34,7 +34,55 @@ await client.checkout.createRateCardCheckoutSession({
34
34
  <dl>
35
35
  <dd>
36
36
 
37
- **request:** `Lark.CreateRateCardCheckoutRequest`
37
+ **request:** `Lark.CreateSubscriptionCheckoutSessionRequest`
38
+
39
+ </dd>
40
+ </dl>
41
+
42
+ <dl>
43
+ <dd>
44
+
45
+ **requestOptions:** `Checkout.RequestOptions`
46
+
47
+ </dd>
48
+ </dl>
49
+ </dd>
50
+ </dl>
51
+
52
+ </dd>
53
+ </dl>
54
+ </details>
55
+
56
+ <details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">completeSubscriptionCheckout</a>(checkoutId) -> Lark.CompleteSubscriptionCheckoutResponse</code></summary>
57
+ <dl>
58
+ <dd>
59
+
60
+ #### 🔌 Usage
61
+
62
+ <dl>
63
+ <dd>
64
+
65
+ <dl>
66
+ <dd>
67
+
68
+ ```typescript
69
+ await client.checkout.completeSubscriptionCheckout("checkout_id");
70
+ ```
71
+
72
+ </dd>
73
+ </dl>
74
+ </dd>
75
+ </dl>
76
+
77
+ #### ⚙️ Parameters
78
+
79
+ <dl>
80
+ <dd>
81
+
82
+ <dl>
83
+ <dd>
84
+
85
+ **checkoutId:** `string`
38
86
 
39
87
  </dd>
40
88
  </dl>
@@ -125,6 +173,7 @@ await client.rateCards.createRateCard({
125
173
  usage_based_rates: [
126
174
  {
127
175
  usage_based_rate_type: "dimensional",
176
+ code: "code",
128
177
  name: "name",
129
178
  pricing_metric: {
130
179
  name: "name",
@@ -360,10 +409,13 @@ await client.rateCards.createRateCardVersion("rate_card_id", {
360
409
  usage_based_rates: [
361
410
  {
362
411
  usage_based_rate_type: "dimensional",
412
+ id: "id",
413
+ code: "code",
363
414
  name: "name",
364
415
  description: "description",
365
416
  included_units: 1,
366
417
  pricing_metric: {
418
+ id: "id",
367
419
  name: "name",
368
420
  event_name: "event_name",
369
421
  aggregation: {
@@ -500,6 +552,62 @@ await client.usageEvents.createUsageEvent({
500
552
  </dl>
501
553
  </details>
502
554
 
555
+ <details><summary><code>client.usageEvents.<a href="/src/api/resources/usageEvents/client/Client.ts">createUsageEventSummary</a>({ ...params }) -> Lark.CreateUsageEventSummaryResponse</code></summary>
556
+ <dl>
557
+ <dd>
558
+
559
+ #### 🔌 Usage
560
+
561
+ <dl>
562
+ <dd>
563
+
564
+ <dl>
565
+ <dd>
566
+
567
+ ```typescript
568
+ await client.usageEvents.createUsageEventSummary({
569
+ event_name: "event_name",
570
+ subject_id: "subject_id",
571
+ period: {
572
+ start: "2024-01-15T09:30:00Z",
573
+ end: "2024-01-15T09:30:00Z",
574
+ },
575
+ aggregation_type: "sum",
576
+ });
577
+ ```
578
+
579
+ </dd>
580
+ </dl>
581
+ </dd>
582
+ </dl>
583
+
584
+ #### ⚙️ Parameters
585
+
586
+ <dl>
587
+ <dd>
588
+
589
+ <dl>
590
+ <dd>
591
+
592
+ **request:** `Lark.CreateUsageEventSummaryRequest`
593
+
594
+ </dd>
595
+ </dl>
596
+
597
+ <dl>
598
+ <dd>
599
+
600
+ **requestOptions:** `UsageEvents.RequestOptions`
601
+
602
+ </dd>
603
+ </dl>
604
+ </dd>
605
+ </dl>
606
+
607
+ </dd>
608
+ </dl>
609
+ </details>
610
+
503
611
  ## Subscriptions
504
612
 
505
613
  <details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">listSubscriptions</a>({ ...params }) -> Lark.ListSubscriptionsResponse</code></summary>
@@ -1043,351 +1151,3 @@ await client.subjects.deleteSubject("subject_id");
1043
1151
  </dd>
1044
1152
  </dl>
1045
1153
  </details>
1046
-
1047
- ## PricingPlans
1048
-
1049
- <details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">listPricingPlans</a>() -> void</code></summary>
1050
- <dl>
1051
- <dd>
1052
-
1053
- #### 🔌 Usage
1054
-
1055
- <dl>
1056
- <dd>
1057
-
1058
- <dl>
1059
- <dd>
1060
-
1061
- ```typescript
1062
- await client.pricingPlans.listPricingPlans();
1063
- ```
1064
-
1065
- </dd>
1066
- </dl>
1067
- </dd>
1068
- </dl>
1069
-
1070
- #### ⚙️ Parameters
1071
-
1072
- <dl>
1073
- <dd>
1074
-
1075
- <dl>
1076
- <dd>
1077
-
1078
- **requestOptions:** `PricingPlans.RequestOptions`
1079
-
1080
- </dd>
1081
- </dl>
1082
- </dd>
1083
- </dl>
1084
-
1085
- </dd>
1086
- </dl>
1087
- </details>
1088
-
1089
- <details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">createPricingPlan</a>() -> void</code></summary>
1090
- <dl>
1091
- <dd>
1092
-
1093
- #### 🔌 Usage
1094
-
1095
- <dl>
1096
- <dd>
1097
-
1098
- <dl>
1099
- <dd>
1100
-
1101
- ```typescript
1102
- await client.pricingPlans.createPricingPlan();
1103
- ```
1104
-
1105
- </dd>
1106
- </dl>
1107
- </dd>
1108
- </dl>
1109
-
1110
- #### ⚙️ Parameters
1111
-
1112
- <dl>
1113
- <dd>
1114
-
1115
- <dl>
1116
- <dd>
1117
-
1118
- **requestOptions:** `PricingPlans.RequestOptions`
1119
-
1120
- </dd>
1121
- </dl>
1122
- </dd>
1123
- </dl>
1124
-
1125
- </dd>
1126
- </dl>
1127
- </details>
1128
-
1129
- <details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">getPricingPlan</a>(planId) -> void</code></summary>
1130
- <dl>
1131
- <dd>
1132
-
1133
- #### 🔌 Usage
1134
-
1135
- <dl>
1136
- <dd>
1137
-
1138
- <dl>
1139
- <dd>
1140
-
1141
- ```typescript
1142
- await client.pricingPlans.getPricingPlan("plan_id");
1143
- ```
1144
-
1145
- </dd>
1146
- </dl>
1147
- </dd>
1148
- </dl>
1149
-
1150
- #### ⚙️ Parameters
1151
-
1152
- <dl>
1153
- <dd>
1154
-
1155
- <dl>
1156
- <dd>
1157
-
1158
- **planId:** `string`
1159
-
1160
- </dd>
1161
- </dl>
1162
-
1163
- <dl>
1164
- <dd>
1165
-
1166
- **requestOptions:** `PricingPlans.RequestOptions`
1167
-
1168
- </dd>
1169
- </dl>
1170
- </dd>
1171
- </dl>
1172
-
1173
- </dd>
1174
- </dl>
1175
- </details>
1176
-
1177
- <details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">updatePricingPlan</a>(planId) -> void</code></summary>
1178
- <dl>
1179
- <dd>
1180
-
1181
- #### 🔌 Usage
1182
-
1183
- <dl>
1184
- <dd>
1185
-
1186
- <dl>
1187
- <dd>
1188
-
1189
- ```typescript
1190
- await client.pricingPlans.updatePricingPlan("plan_id");
1191
- ```
1192
-
1193
- </dd>
1194
- </dl>
1195
- </dd>
1196
- </dl>
1197
-
1198
- #### ⚙️ Parameters
1199
-
1200
- <dl>
1201
- <dd>
1202
-
1203
- <dl>
1204
- <dd>
1205
-
1206
- **planId:** `string`
1207
-
1208
- </dd>
1209
- </dl>
1210
-
1211
- <dl>
1212
- <dd>
1213
-
1214
- **requestOptions:** `PricingPlans.RequestOptions`
1215
-
1216
- </dd>
1217
- </dl>
1218
- </dd>
1219
- </dl>
1220
-
1221
- </dd>
1222
- </dl>
1223
- </details>
1224
-
1225
- <details><summary><code>client.pricingPlans.<a href="/src/api/resources/pricingPlans/client/Client.ts">deletePricingPlan</a>(planId) -> void</code></summary>
1226
- <dl>
1227
- <dd>
1228
-
1229
- #### 🔌 Usage
1230
-
1231
- <dl>
1232
- <dd>
1233
-
1234
- <dl>
1235
- <dd>
1236
-
1237
- ```typescript
1238
- await client.pricingPlans.deletePricingPlan("plan_id");
1239
- ```
1240
-
1241
- </dd>
1242
- </dl>
1243
- </dd>
1244
- </dl>
1245
-
1246
- #### ⚙️ Parameters
1247
-
1248
- <dl>
1249
- <dd>
1250
-
1251
- <dl>
1252
- <dd>
1253
-
1254
- **planId:** `string`
1255
-
1256
- </dd>
1257
- </dl>
1258
-
1259
- <dl>
1260
- <dd>
1261
-
1262
- **requestOptions:** `PricingPlans.RequestOptions`
1263
-
1264
- </dd>
1265
- </dl>
1266
- </dd>
1267
- </dl>
1268
-
1269
- </dd>
1270
- </dl>
1271
- </details>
1272
-
1273
- ## CreditPools
1274
-
1275
- <details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">listCreditPools</a>() -> void</code></summary>
1276
- <dl>
1277
- <dd>
1278
-
1279
- #### 🔌 Usage
1280
-
1281
- <dl>
1282
- <dd>
1283
-
1284
- <dl>
1285
- <dd>
1286
-
1287
- ```typescript
1288
- await client.creditPools.listCreditPools();
1289
- ```
1290
-
1291
- </dd>
1292
- </dl>
1293
- </dd>
1294
- </dl>
1295
-
1296
- #### ⚙️ Parameters
1297
-
1298
- <dl>
1299
- <dd>
1300
-
1301
- <dl>
1302
- <dd>
1303
-
1304
- **requestOptions:** `CreditPools.RequestOptions`
1305
-
1306
- </dd>
1307
- </dl>
1308
- </dd>
1309
- </dl>
1310
-
1311
- </dd>
1312
- </dl>
1313
- </details>
1314
-
1315
- <details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">createCreditPool</a>() -> void</code></summary>
1316
- <dl>
1317
- <dd>
1318
-
1319
- #### 🔌 Usage
1320
-
1321
- <dl>
1322
- <dd>
1323
-
1324
- <dl>
1325
- <dd>
1326
-
1327
- ```typescript
1328
- await client.creditPools.createCreditPool();
1329
- ```
1330
-
1331
- </dd>
1332
- </dl>
1333
- </dd>
1334
- </dl>
1335
-
1336
- #### ⚙️ Parameters
1337
-
1338
- <dl>
1339
- <dd>
1340
-
1341
- <dl>
1342
- <dd>
1343
-
1344
- **requestOptions:** `CreditPools.RequestOptions`
1345
-
1346
- </dd>
1347
- </dl>
1348
- </dd>
1349
- </dl>
1350
-
1351
- </dd>
1352
- </dl>
1353
- </details>
1354
-
1355
- <details><summary><code>client.creditPools.<a href="/src/api/resources/creditPools/client/Client.ts">grantCredits</a>() -> void</code></summary>
1356
- <dl>
1357
- <dd>
1358
-
1359
- #### 🔌 Usage
1360
-
1361
- <dl>
1362
- <dd>
1363
-
1364
- <dl>
1365
- <dd>
1366
-
1367
- ```typescript
1368
- await client.creditPools.grantCredits();
1369
- ```
1370
-
1371
- </dd>
1372
- </dl>
1373
- </dd>
1374
- </dl>
1375
-
1376
- #### ⚙️ Parameters
1377
-
1378
- <dl>
1379
- <dd>
1380
-
1381
- <dl>
1382
- <dd>
1383
-
1384
- **requestOptions:** `CreditPools.RequestOptions`
1385
-
1386
- </dd>
1387
- </dl>
1388
- </dd>
1389
- </dl>
1390
-
1391
- </dd>
1392
- </dl>
1393
- </details>
@@ -1,53 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as core from "../../../../core/index.js";
5
- export declare namespace CreditPools {
6
- interface Options {
7
- environment: core.Supplier<string>;
8
- /** Specify a custom URL to connect the client to. */
9
- baseUrl?: core.Supplier<string>;
10
- /** Additional headers to include in requests. */
11
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
12
- }
13
- interface RequestOptions {
14
- /** The maximum time to wait for a response in seconds. */
15
- timeoutInSeconds?: number;
16
- /** The number of times to retry the request. Defaults to 2. */
17
- maxRetries?: number;
18
- /** A hook to abort the request. */
19
- abortSignal?: AbortSignal;
20
- /** Additional query string parameters to include in the request. */
21
- queryParams?: Record<string, unknown>;
22
- /** Additional headers to include in the request. */
23
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
24
- }
25
- }
26
- export declare class CreditPools {
27
- protected readonly _options: CreditPools.Options;
28
- constructor(_options: CreditPools.Options);
29
- /**
30
- * @param {CreditPools.RequestOptions} requestOptions - Request-specific configuration.
31
- *
32
- * @example
33
- * await client.creditPools.listCreditPools()
34
- */
35
- listCreditPools(requestOptions?: CreditPools.RequestOptions): core.HttpResponsePromise<void>;
36
- private __listCreditPools;
37
- /**
38
- * @param {CreditPools.RequestOptions} requestOptions - Request-specific configuration.
39
- *
40
- * @example
41
- * await client.creditPools.createCreditPool()
42
- */
43
- createCreditPool(requestOptions?: CreditPools.RequestOptions): core.HttpResponsePromise<void>;
44
- private __createCreditPool;
45
- /**
46
- * @param {CreditPools.RequestOptions} requestOptions - Request-specific configuration.
47
- *
48
- * @example
49
- * await client.creditPools.grantCredits()
50
- */
51
- grantCredits(requestOptions?: CreditPools.RequestOptions): core.HttpResponsePromise<void>;
52
- private __grantCredits;
53
- }