@ufcalendar/sdk 0.8.3 → 0.8.5

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/index.d.ts CHANGED
@@ -1171,11 +1171,13 @@ interface Plan {
1171
1171
  interface Plans {
1172
1172
  currency: string;
1173
1173
  plans: Plan[];
1174
- trial: {
1175
- hours: number;
1176
- requests: number;
1174
+ /** The permanent free plan (2026-10-29): 1,000 requests a month, no card, never expires. */
1175
+ free_plan: {
1176
+ requests_per_month: number;
1177
+ rpm: number;
1178
+ key_limit: number;
1177
1179
  card_required: boolean;
1178
- per_account: number;
1180
+ expires: boolean;
1179
1181
  start_url: string;
1180
1182
  };
1181
1183
  mcp: {
@@ -1340,6 +1342,14 @@ interface Article {
1340
1342
  }
1341
1343
 
1342
1344
  declare const DEFAULT_BASE_URL = "https://api.ufcalendar.com/v1";
1345
+ /** Default number of times a GET that hit the per-minute limit is retried. */
1346
+ declare const DEFAULT_MAX_RETRIES = 3;
1347
+ /**
1348
+ * A 429 whose `Retry-After` is longer than this is not waited out: the
1349
+ * per-minute limit always resets within a minute, anything longer is the
1350
+ * monthly quota (or something we do not understand) and must surface.
1351
+ */
1352
+ declare const MAX_RETRY_AFTER_SECONDS = 60;
1343
1353
  interface FightAPIOptions {
1344
1354
  /** `ufcalendar_…` key from https://www.ufcalendar.com/account/api. Falls back
1345
1355
  * to `UFCALENDAR_API_KEY` / `UFCAL_API_KEY` in the environment. Only
@@ -1353,6 +1363,15 @@ interface FightAPIOptions {
1353
1363
  timeoutMs?: number;
1354
1364
  /** Extra headers on every request. */
1355
1365
  headers?: Record<string, string>;
1366
+ /**
1367
+ * How many times a GET that hit the per-minute limit (429 `rate_limited`
1368
+ * with `Retry-After` ≤ 60 s) is retried after waiting `Retry-After` plus a
1369
+ * little jitter. Default 3; `0` disables. The monthly quota
1370
+ * (`quota_exceeded`) and non-GET requests always throw at once.
1371
+ */
1372
+ maxRetries?: number;
1373
+ /** Replace the wait between rate-limit retries (tests, custom schedulers). */
1374
+ sleep?: (ms: number) => Promise<void>;
1356
1375
  }
1357
1376
  /** An error response from the Fight API. */
1358
1377
  declare class FightAPIError extends Error {
@@ -1367,6 +1386,8 @@ declare class FightAPI {
1367
1386
  #private;
1368
1387
  readonly baseUrl: string;
1369
1388
  readonly apiKey: string | undefined;
1389
+ /** Retries of a GET that hit the per-minute limit (see `FightAPIOptions.maxRetries`). */
1390
+ readonly maxRetries: number;
1370
1391
  /** `meta` of the most recent response (pagination cursor, generated_at …). */
1371
1392
  lastMeta: Meta | null;
1372
1393
  /** `X-RateLimit-*` of the most recent response. */
@@ -1377,7 +1398,7 @@ declare class FightAPI {
1377
1398
  /** Raw GET returning the whole `{data, meta}` envelope. */
1378
1399
  getWithMeta<T = unknown>(path: string, params?: Query): Promise<Envelope<T>>;
1379
1400
  /**
1380
- * Plans, quotas, the free 1-day trial rule, the MCP endpoint and the doc
1401
+ * Plans (Free first), quotas, the free-plan rule, the MCP endpoint and the doc
1381
1402
  * links. The only endpoint that answers without a credential.
1382
1403
  */
1383
1404
  plans(): Promise<Plans>;
@@ -1738,7 +1759,7 @@ declare class FightAPI {
1738
1759
 
1739
1760
  /** Kept in lockstep with package.json and the User-Agent by
1740
1761
  * `apps/api/src/surfaces.test.ts`. Bump all three together. */
1741
- declare const VERSION = "0.8.3";
1762
+ declare const VERSION = "0.8.5";
1742
1763
 
1743
1764
  /**
1744
1765
  * This file was auto-generated by openapi-typescript.
@@ -1755,7 +1776,7 @@ interface paths {
1755
1776
  };
1756
1777
  /**
1757
1778
  * Plans, quotas and how to connect (no key required)
1758
- * @description The only endpoint that answers without a credential. Returns every plan with its monthly request quota, per-minute limit, key limit and a `checkout_url`; the terms of the free 1-day trial and the URL that starts it; the MCP endpoint with both of its auth doors; and the documentation links. Static per deploy and cached an hour — poll it never, read it once.
1779
+ * @description The only endpoint that answers without a credential. Returns every plan, Free first, with its monthly request quota, per-minute limit, key limit and a `checkout_url`; the free-plan terms (1,000 requests a month, no card, never expires) and the URL that mints its key; the MCP endpoint with both of its auth doors; and the documentation links. Static per deploy and cached an hour — poll it never, read it once.
1759
1780
  */
1760
1781
  get: {
1761
1782
  parameters: {
@@ -1766,7 +1787,7 @@ interface paths {
1766
1787
  };
1767
1788
  requestBody?: never;
1768
1789
  responses: {
1769
- /** @description Plans, trial rule, MCP endpoint and links */
1790
+ /** @description Plans, the free-plan rule, MCP endpoint and links */
1770
1791
  200: {
1771
1792
  headers: {
1772
1793
  [name: string]: unknown;
@@ -1778,6 +1799,20 @@ interface paths {
1778
1799
  * "currency": "USD",
1779
1800
  * "plans": [
1780
1801
  * {
1802
+ * "key": "free",
1803
+ * "name": "Free",
1804
+ * "price_monthly_usd": 0,
1805
+ * "price_yearly_usd": 0,
1806
+ * "requests_per_month": 1000,
1807
+ * "rpm": 10,
1808
+ * "key_limit": 1,
1809
+ * "features": [
1810
+ * "no card",
1811
+ * "never expires"
1812
+ * ],
1813
+ * "checkout_url": "https://www.ufcalendar.com/account/api?trial=1"
1814
+ * },
1815
+ * {
1781
1816
  * "key": "hobby",
1782
1817
  * "name": "Hobby",
1783
1818
  * "price_monthly_usd": 19,
@@ -1789,11 +1824,12 @@ interface paths {
1789
1824
  * "checkout_url": "https://www.ufcalendar.com/account/api?plan=hobby"
1790
1825
  * }
1791
1826
  * ],
1792
- * "trial": {
1793
- * "hours": 24,
1794
- * "requests": 100,
1827
+ * "free_plan": {
1828
+ * "requests_per_month": 1000,
1829
+ * "rpm": 10,
1830
+ * "key_limit": 1,
1795
1831
  * "card_required": false,
1796
- * "per_account": 1,
1832
+ * "expires": false,
1797
1833
  * "start_url": "https://www.ufcalendar.com/account/api?trial=1"
1798
1834
  * },
1799
1835
  * "mcp": {
@@ -1919,7 +1955,7 @@ interface paths {
1919
1955
  "application/json": components["schemas"]["Error"];
1920
1956
  };
1921
1957
  };
1922
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
1958
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
1923
1959
  403: {
1924
1960
  headers: {
1925
1961
  [name: string]: unknown;
@@ -2024,7 +2060,7 @@ interface paths {
2024
2060
  "application/json": components["schemas"]["Error"];
2025
2061
  };
2026
2062
  };
2027
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2063
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2028
2064
  403: {
2029
2065
  headers: {
2030
2066
  [name: string]: unknown;
@@ -2230,7 +2266,7 @@ interface paths {
2230
2266
  "application/json": components["schemas"]["Error"];
2231
2267
  };
2232
2268
  };
2233
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2269
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2234
2270
  403: {
2235
2271
  headers: {
2236
2272
  [name: string]: unknown;
@@ -2411,7 +2447,7 @@ interface paths {
2411
2447
  "application/json": components["schemas"]["Error"];
2412
2448
  };
2413
2449
  };
2414
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2450
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2415
2451
  403: {
2416
2452
  headers: {
2417
2453
  [name: string]: unknown;
@@ -2544,7 +2580,7 @@ interface paths {
2544
2580
  "application/json": components["schemas"]["Error"];
2545
2581
  };
2546
2582
  };
2547
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2583
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2548
2584
  403: {
2549
2585
  headers: {
2550
2586
  [name: string]: unknown;
@@ -2659,7 +2695,7 @@ interface paths {
2659
2695
  "application/json": components["schemas"]["Error"];
2660
2696
  };
2661
2697
  };
2662
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2698
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2663
2699
  403: {
2664
2700
  headers: {
2665
2701
  [name: string]: unknown;
@@ -2838,7 +2874,7 @@ interface paths {
2838
2874
  "application/json": components["schemas"]["Error"];
2839
2875
  };
2840
2876
  };
2841
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
2877
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
2842
2878
  403: {
2843
2879
  headers: {
2844
2880
  [name: string]: unknown;
@@ -3069,7 +3105,7 @@ interface paths {
3069
3105
  "application/json": components["schemas"]["Error"];
3070
3106
  };
3071
3107
  };
3072
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
3108
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3073
3109
  403: {
3074
3110
  headers: {
3075
3111
  [name: string]: unknown;
@@ -3220,7 +3256,7 @@ interface paths {
3220
3256
  "application/json": components["schemas"]["Error"];
3221
3257
  };
3222
3258
  };
3223
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
3259
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3224
3260
  403: {
3225
3261
  headers: {
3226
3262
  [name: string]: unknown;
@@ -3427,7 +3463,7 @@ interface paths {
3427
3463
  "application/json": components["schemas"]["Error"];
3428
3464
  };
3429
3465
  };
3430
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
3466
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3431
3467
  403: {
3432
3468
  headers: {
3433
3469
  [name: string]: unknown;
@@ -3603,7 +3639,7 @@ interface paths {
3603
3639
  "application/json": components["schemas"]["Error"];
3604
3640
  };
3605
3641
  };
3606
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
3642
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3607
3643
  403: {
3608
3644
  headers: {
3609
3645
  [name: string]: unknown;
@@ -3809,7 +3845,7 @@ interface paths {
3809
3845
  "application/json": components["schemas"]["Error"];
3810
3846
  };
3811
3847
  };
3812
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
3848
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3813
3849
  403: {
3814
3850
  headers: {
3815
3851
  [name: string]: unknown;
@@ -3994,7 +4030,7 @@ interface paths {
3994
4030
  "application/json": components["schemas"]["Error"];
3995
4031
  };
3996
4032
  };
3997
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
4033
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
3998
4034
  403: {
3999
4035
  headers: {
4000
4036
  [name: string]: unknown;
@@ -4099,7 +4135,7 @@ interface paths {
4099
4135
  "application/json": components["schemas"]["Error"];
4100
4136
  };
4101
4137
  };
4102
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
4138
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
4103
4139
  403: {
4104
4140
  headers: {
4105
4141
  [name: string]: unknown;
@@ -4204,7 +4240,7 @@ interface paths {
4204
4240
  "application/json": components["schemas"]["Error"];
4205
4241
  };
4206
4242
  };
4207
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
4243
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
4208
4244
  403: {
4209
4245
  headers: {
4210
4246
  [name: string]: unknown;
@@ -4414,7 +4450,7 @@ interface paths {
4414
4450
  "application/json": components["schemas"]["Error"];
4415
4451
  };
4416
4452
  };
4417
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
4453
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
4418
4454
  403: {
4419
4455
  headers: {
4420
4456
  [name: string]: unknown;
@@ -4735,7 +4771,7 @@ interface paths {
4735
4771
  "application/json": components["schemas"]["Error"];
4736
4772
  };
4737
4773
  };
4738
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
4774
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
4739
4775
  403: {
4740
4776
  headers: {
4741
4777
  [name: string]: unknown;
@@ -5180,7 +5216,7 @@ interface paths {
5180
5216
  "application/json": components["schemas"]["Error"];
5181
5217
  };
5182
5218
  };
5183
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
5219
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
5184
5220
  403: {
5185
5221
  headers: {
5186
5222
  [name: string]: unknown;
@@ -5344,7 +5380,7 @@ interface paths {
5344
5380
  "application/json": components["schemas"]["Error"];
5345
5381
  };
5346
5382
  };
5347
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
5383
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
5348
5384
  403: {
5349
5385
  headers: {
5350
5386
  [name: string]: unknown;
@@ -5449,7 +5485,7 @@ interface paths {
5449
5485
  "application/json": components["schemas"]["Error"];
5450
5486
  };
5451
5487
  };
5452
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
5488
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
5453
5489
  403: {
5454
5490
  headers: {
5455
5491
  [name: string]: unknown;
@@ -5645,7 +5681,7 @@ interface paths {
5645
5681
  "application/json": components["schemas"]["Error"];
5646
5682
  };
5647
5683
  };
5648
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
5684
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
5649
5685
  403: {
5650
5686
  headers: {
5651
5687
  [name: string]: unknown;
@@ -5788,7 +5824,7 @@ interface paths {
5788
5824
  "application/json": components["schemas"]["Error"];
5789
5825
  };
5790
5826
  };
5791
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
5827
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
5792
5828
  403: {
5793
5829
  headers: {
5794
5830
  [name: string]: unknown;
@@ -6113,7 +6149,7 @@ interface paths {
6113
6149
  "application/json": components["schemas"]["Error"];
6114
6150
  };
6115
6151
  };
6116
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6152
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6117
6153
  403: {
6118
6154
  headers: {
6119
6155
  [name: string]: unknown;
@@ -6267,7 +6303,7 @@ interface paths {
6267
6303
  "application/json": components["schemas"]["Error"];
6268
6304
  };
6269
6305
  };
6270
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6306
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6271
6307
  403: {
6272
6308
  headers: {
6273
6309
  [name: string]: unknown;
@@ -6382,7 +6418,7 @@ interface paths {
6382
6418
  "application/json": components["schemas"]["Error"];
6383
6419
  };
6384
6420
  };
6385
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6421
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6386
6422
  403: {
6387
6423
  headers: {
6388
6424
  [name: string]: unknown;
@@ -6532,7 +6568,7 @@ interface paths {
6532
6568
  "application/json": components["schemas"]["Error"];
6533
6569
  };
6534
6570
  };
6535
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6571
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6536
6572
  403: {
6537
6573
  headers: {
6538
6574
  [name: string]: unknown;
@@ -6666,7 +6702,7 @@ interface paths {
6666
6702
  "application/json": components["schemas"]["Error"];
6667
6703
  };
6668
6704
  };
6669
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6705
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6670
6706
  403: {
6671
6707
  headers: {
6672
6708
  [name: string]: unknown;
@@ -6912,7 +6948,7 @@ interface paths {
6912
6948
  "application/json": components["schemas"]["Error"];
6913
6949
  };
6914
6950
  };
6915
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
6951
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
6916
6952
  403: {
6917
6953
  headers: {
6918
6954
  [name: string]: unknown;
@@ -7101,7 +7137,7 @@ interface paths {
7101
7137
  "application/json": components["schemas"]["Error"];
7102
7138
  };
7103
7139
  };
7104
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7140
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7105
7141
  403: {
7106
7142
  headers: {
7107
7143
  [name: string]: unknown;
@@ -7253,7 +7289,7 @@ interface paths {
7253
7289
  "application/json": components["schemas"]["Error"];
7254
7290
  };
7255
7291
  };
7256
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7292
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7257
7293
  403: {
7258
7294
  headers: {
7259
7295
  [name: string]: unknown;
@@ -7394,7 +7430,7 @@ interface paths {
7394
7430
  "application/json": components["schemas"]["Error"];
7395
7431
  };
7396
7432
  };
7397
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7433
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7398
7434
  403: {
7399
7435
  headers: {
7400
7436
  [name: string]: unknown;
@@ -7549,7 +7585,7 @@ interface paths {
7549
7585
  "application/json": components["schemas"]["Error"];
7550
7586
  };
7551
7587
  };
7552
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7588
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7553
7589
  403: {
7554
7590
  headers: {
7555
7591
  [name: string]: unknown;
@@ -7604,7 +7640,7 @@ interface paths {
7604
7640
  };
7605
7641
  /**
7606
7642
  * Matchmaker board
7607
- * @description UFCalendar's matchmaker for one MMA promotion (`ufc`, `pfl`, `oktagon`, `rizin`; `bkfc` 400s `unsupported_org` — the engine runs on the Power Index, which rates MMA only). Every candidate pair inside a division is scored 0–100 for rank proximity, momentum, competitiveness, readiness and story (rematches, trilogy deciders, eliminators): the promotion's official ladder where one exists plus the strongest active unranked Power Index fighters. A promotion with no official ladder (`rizin`) draws only on its current roster — fighters whose latest bout in the promotion is within 450 days — and its pairs are weighted by what each fighter has done there (title fights, wins, career pedigree), so a former champion is not paired with a two-fight prospect. UFC pairs are scored by UFCalendar's booking model (a ranker trained on every realized UFC booking), weighted by the stakes term; other promotions use the fitted heuristic. Fighters already booked leave the board, pairs already booked are excluded, and one fighter appears in at most two slips per division.
7643
+ * @description UFCalendar's matchmaker for one MMA promotion (`ufc`, `pfl`, `oktagon`, `rizin`; `bkfc` 400s `unsupported_org` — the engine runs on the Power Index, which rates MMA only). Every candidate pair inside a division is scored 0–100 for rank proximity, momentum, competitiveness, readiness and story (rematches, trilogy deciders, eliminators): the promotion's official ladder where one exists plus the strongest active unranked Power Index fighters. A promotion with no official ladder (`rizin`) draws only on its current roster — fighters whose latest bout in the promotion is within 450 days — and its pairs are weighted by what each fighter has done there (title fights, wins, career pedigree), so a former champion is not paired with a two-fight prospect. UFC and RIZIN pairs are scored by UFCalendar's booking model (a ranker trained on every realized UFC booking, which also beat the heuristic on RIZIN's own bookings), weighted by the stakes term; other promotions use the fitted heuristic. Fighters already booked leave the board, pairs already booked are excluded, and one fighter appears in at most two slips per division.
7608
7644
  *
7609
7645
  * Without `division` the list is the cross-division top board (at most two slips per division); with it, that division's best pairs. `meta.divisions` lists the promotion's divisions (an unknown one 400s `invalid_division`), `meta.rankings_date` the ladder snapshot used (null when the promotion has no current ladder). Each slip: `key` (`lo-hi` fighter ids), `a` (red corner — the better-credentialed side) and `b` with `rank` (0 = champion, null = unranked), `power_index`, `streak` (signed: +3 = three straight wins) and `booked`; `score`; `win_probability_a` from the two Power Index ratings; `tags` (`title`, `eliminator`, `coinFlip`, `bothStreaking`, `finishers`, `trilogyDecider`, `unfinishedBusiness`, `rematch`, `unrankedGem`, `bounceBack`, `steppingUp`, `bothDue`, `booked`).
7610
7646
  *
@@ -7728,7 +7764,7 @@ interface paths {
7728
7764
  "application/json": components["schemas"]["Error"];
7729
7765
  };
7730
7766
  };
7731
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7767
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7732
7768
  403: {
7733
7769
  headers: {
7734
7770
  [name: string]: unknown;
@@ -7901,7 +7937,7 @@ interface paths {
7901
7937
  "application/json": components["schemas"]["Error"];
7902
7938
  };
7903
7939
  };
7904
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
7940
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
7905
7941
  403: {
7906
7942
  headers: {
7907
7943
  [name: string]: unknown;
@@ -8083,7 +8119,7 @@ interface paths {
8083
8119
  "application/json": components["schemas"]["Error"];
8084
8120
  };
8085
8121
  };
8086
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8122
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8087
8123
  403: {
8088
8124
  headers: {
8089
8125
  [name: string]: unknown;
@@ -8275,7 +8311,7 @@ interface paths {
8275
8311
  "application/json": components["schemas"]["Error"];
8276
8312
  };
8277
8313
  };
8278
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8314
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8279
8315
  403: {
8280
8316
  headers: {
8281
8317
  [name: string]: unknown;
@@ -8511,7 +8547,7 @@ interface paths {
8511
8547
  "application/json": components["schemas"]["Error"];
8512
8548
  };
8513
8549
  };
8514
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8550
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8515
8551
  403: {
8516
8552
  headers: {
8517
8553
  [name: string]: unknown;
@@ -8617,7 +8653,7 @@ interface paths {
8617
8653
  "application/json": components["schemas"]["Error"];
8618
8654
  };
8619
8655
  };
8620
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8656
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8621
8657
  403: {
8622
8658
  headers: {
8623
8659
  [name: string]: unknown;
@@ -8754,7 +8790,7 @@ interface paths {
8754
8790
  "application/json": components["schemas"]["Error"];
8755
8791
  };
8756
8792
  };
8757
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8793
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8758
8794
  403: {
8759
8795
  headers: {
8760
8796
  [name: string]: unknown;
@@ -8896,7 +8932,7 @@ interface paths {
8896
8932
  "application/json": components["schemas"]["Error"];
8897
8933
  };
8898
8934
  };
8899
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
8935
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
8900
8936
  403: {
8901
8937
  headers: {
8902
8938
  [name: string]: unknown;
@@ -9061,7 +9097,7 @@ interface paths {
9061
9097
  "application/json": components["schemas"]["Error"];
9062
9098
  };
9063
9099
  };
9064
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9100
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9065
9101
  403: {
9066
9102
  headers: {
9067
9103
  [name: string]: unknown;
@@ -9184,7 +9220,7 @@ interface paths {
9184
9220
  "application/json": components["schemas"]["Error"];
9185
9221
  };
9186
9222
  };
9187
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9223
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9188
9224
  403: {
9189
9225
  headers: {
9190
9226
  [name: string]: unknown;
@@ -9333,7 +9369,7 @@ interface paths {
9333
9369
  "application/json": components["schemas"]["Error"];
9334
9370
  };
9335
9371
  };
9336
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9372
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9337
9373
  403: {
9338
9374
  headers: {
9339
9375
  [name: string]: unknown;
@@ -9474,7 +9510,7 @@ interface paths {
9474
9510
  "application/json": components["schemas"]["Error"];
9475
9511
  };
9476
9512
  };
9477
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9513
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9478
9514
  403: {
9479
9515
  headers: {
9480
9516
  [name: string]: unknown;
@@ -9614,7 +9650,7 @@ interface paths {
9614
9650
  "application/json": components["schemas"]["Error"];
9615
9651
  };
9616
9652
  };
9617
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9653
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9618
9654
  403: {
9619
9655
  headers: {
9620
9656
  [name: string]: unknown;
@@ -9703,7 +9739,7 @@ interface paths {
9703
9739
  "application/json": components["schemas"]["Error"];
9704
9740
  };
9705
9741
  };
9706
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
9742
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
9707
9743
  403: {
9708
9744
  headers: {
9709
9745
  [name: string]: unknown;
@@ -10198,7 +10234,7 @@ interface paths {
10198
10234
  };
10199
10235
  /**
10200
10236
  * Your quota usage
10201
- * @description Current-month usage for the calling key: tier, requests used/limit, rpm limit, and the reset as both a Unix timestamp (`reset`) and ISO-8601 (`reset_at`); `month` (`YYYYMM`) and `period` (`YYYY-MM`) are the same month in two spellings. On the free 1-day trial, `trial_ends_at` is when access stops (null on a paid plan) — plan around it, not `reset_at`.
10237
+ * @description Current-month usage for the calling key: tier, requests used/limit, rpm limit, and the reset as both a Unix timestamp (`reset`) and ISO-8601 (`reset_at`); `month` (`YYYYMM`) and `period` (`YYYY-MM`) are the same month in two spellings. On the free plan `tier` is `free` (1,000 requests a month, metered per account). On an owner-granted trial, `trial_ends_at` is when the trial ends (null otherwise) — plan around it, not `reset_at`.
10202
10238
  */
10203
10239
  get: {
10204
10240
  parameters: {
@@ -10262,7 +10298,7 @@ interface paths {
10262
10298
  "application/json": components["schemas"]["Error"];
10263
10299
  };
10264
10300
  };
10265
- /** @description No active plan on the key's account (`subscription_required`) — choose a plan or start the free 1-day trial at https://www.ufcalendar.com/account/api. */
10301
+ /** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
10266
10302
  403: {
10267
10303
  headers: {
10268
10304
  [name: string]: unknown;
@@ -10360,7 +10396,7 @@ interface components {
10360
10396
  * @description Plan tier.
10361
10397
  * @enum {string}
10362
10398
  */
10363
- Tier: "trial" | "hobby" | "pro" | "business";
10399
+ Tier: "free" | "trial" | "hobby" | "pro" | "business";
10364
10400
  /**
10365
10401
  * @description Webhook event types.
10366
10402
  * @enum {string}
@@ -12344,7 +12380,7 @@ interface components {
12344
12380
  reset_at: string;
12345
12381
  /**
12346
12382
  * Format: date-time
12347
- * @description Trial plans only: when the trial ends and access stops — usually well before `reset_at`. Null on a paid plan.
12383
+ * @description Owner-granted trials only: when the trial ends and the account falls back to the free plan — usually well before `reset_at`. Null on the free plan and on a paid plan.
12348
12384
  */
12349
12385
  trial_ends_at: string | null;
12350
12386
  };
@@ -12362,11 +12398,13 @@ interface components {
12362
12398
  Plans: {
12363
12399
  currency: string;
12364
12400
  plans: components["schemas"]["Plan"][];
12365
- trial: {
12366
- hours: number;
12367
- requests: number;
12401
+ free_plan: {
12402
+ requests_per_month: number;
12403
+ rpm: number;
12404
+ key_limit: number;
12368
12405
  card_required: boolean;
12369
- per_account: number;
12406
+ /** @description Always false: the free plan never expires. */
12407
+ expires: boolean;
12370
12408
  start_url: string;
12371
12409
  };
12372
12410
  mcp: {
@@ -12939,4 +12977,4 @@ interface components {
12939
12977
  }
12940
12978
  type operations = Record<string, never>;
12941
12979
 
12942
- export { type Article, type ArticleLocale, type ArticleSummary, type BonusAward, type BonusLedger, type Broadcast, type BroadcastRight, type CareerBout, type CareerStats, type Champion, type ChangeFeedEntry, type ChangeKind, type Compare, type CompareAggregates, type CompareBout, type CredentialConfidence, DEFAULT_BASE_URL, type DissentingJudge, type Envelope, type EventChange, type EventDetail, type EventHeadline, type EventInclude, type EventListInclude, type EventOdds, type EventOddsRow, type EventPickem, type EventRef, type EventStatus, type EventStorylines, type EventSummary, type EventWatch, type Fight, FightAPI, FightAPIError, type FightAPIOptions, type FightInclude, type FightOdds, type FightProps, type FightResult, type FightSearchMethod, type FightSearchRow, type Fighter, type FighterAffiliation, type FighterBout, type FighterCredential, type FighterCredentials, type FighterImage, type FighterInclude, type FighterRef, type FighterSummary, type HeadlineCorner, type Judge, type JudgeColleague, type JudgeLeague, type JudgeScorecardRow, type LeaderboardRow, type MatchmakerCorner, type MatchmakerTag, type Matchup, type Meta, type MethodNormalized, type OddsBlock, type OddsHistoryPoint, type OddsLine, type OddsMovement, type OddsPair, type Org, type OrgDivision, type PickemSplit, type Plan, type Plans, type PowerIndex, type PowerIndexFighter, type PowerIndexMover, type PowerIndexRow, type PowerIndexView, type ProbabilitySource, type PropLine, type PropMethodCorner, type PropTotalRounds, type PublicSource, type Query, type QueryValue, type RankingDivision, type RankingEntry, type RankingsBoard, type RateLimit, type RecordBookSection, type RecordEntry, type RightsSeries, type Scorecard, type ScorecardRound, type Scorecards, type SplitDecisionRow, type StatMetric, type StatScope, type StatsPanel, type StorylineCorner, type StorylineTag, type Usage, VERSION, type Venue, type WatchProvider, type WebhookEndpoint, type WhosNext, type YearStats, type operations, type paths };
12980
+ export { type Article, type ArticleLocale, type ArticleSummary, type BonusAward, type BonusLedger, type Broadcast, type BroadcastRight, type CareerBout, type CareerStats, type Champion, type ChangeFeedEntry, type ChangeKind, type Compare, type CompareAggregates, type CompareBout, type CredentialConfidence, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, type DissentingJudge, type Envelope, type EventChange, type EventDetail, type EventHeadline, type EventInclude, type EventListInclude, type EventOdds, type EventOddsRow, type EventPickem, type EventRef, type EventStatus, type EventStorylines, type EventSummary, type EventWatch, type Fight, FightAPI, FightAPIError, type FightAPIOptions, type FightInclude, type FightOdds, type FightProps, type FightResult, type FightSearchMethod, type FightSearchRow, type Fighter, type FighterAffiliation, type FighterBout, type FighterCredential, type FighterCredentials, type FighterImage, type FighterInclude, type FighterRef, type FighterSummary, type HeadlineCorner, type Judge, type JudgeColleague, type JudgeLeague, type JudgeScorecardRow, type LeaderboardRow, MAX_RETRY_AFTER_SECONDS, type MatchmakerCorner, type MatchmakerTag, type Matchup, type Meta, type MethodNormalized, type OddsBlock, type OddsHistoryPoint, type OddsLine, type OddsMovement, type OddsPair, type Org, type OrgDivision, type PickemSplit, type Plan, type Plans, type PowerIndex, type PowerIndexFighter, type PowerIndexMover, type PowerIndexRow, type PowerIndexView, type ProbabilitySource, type PropLine, type PropMethodCorner, type PropTotalRounds, type PublicSource, type Query, type QueryValue, type RankingDivision, type RankingEntry, type RankingsBoard, type RateLimit, type RecordBookSection, type RecordEntry, type RightsSeries, type Scorecard, type ScorecardRound, type Scorecards, type SplitDecisionRow, type StatMetric, type StatScope, type StatsPanel, type StorylineCorner, type StorylineTag, type Usage, VERSION, type Venue, type WatchProvider, type WebhookEndpoint, type WhosNext, type YearStats, type operations, type paths };