@nohead/sdk 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -174,7 +174,7 @@ export type TextFieldConfiguration = {
174
174
  */
175
175
  description?: string;
176
176
  /**
177
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
177
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
178
178
  */
179
179
  searchable?: boolean;
180
180
  /**
@@ -205,7 +205,7 @@ export type LongTextFieldConfiguration = {
205
205
  */
206
206
  description?: string;
207
207
  /**
208
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
208
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
209
209
  */
210
210
  searchable?: boolean;
211
211
  /**
@@ -225,7 +225,7 @@ export type RichTextFieldConfiguration = {
225
225
  */
226
226
  description?: string;
227
227
  /**
228
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
228
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
229
229
  */
230
230
  searchable?: boolean;
231
231
  /**
@@ -243,7 +243,7 @@ export type IntegerFieldConfiguration = {
243
243
  */
244
244
  description?: string;
245
245
  /**
246
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
246
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
247
247
  */
248
248
  searchable?: boolean;
249
249
  /**
@@ -267,7 +267,7 @@ export type DecimalFieldConfiguration = {
267
267
  */
268
268
  description?: string;
269
269
  /**
270
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
270
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
271
271
  */
272
272
  searchable?: boolean;
273
273
  /**
@@ -287,7 +287,7 @@ export type DateFieldConfiguration = {
287
287
  */
288
288
  description?: string;
289
289
  /**
290
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
290
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
291
291
  */
292
292
  searchable?: boolean;
293
293
  /**
@@ -313,7 +313,7 @@ export type BooleanFieldConfiguration = {
313
313
  */
314
314
  description?: string;
315
315
  /**
316
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
316
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
317
317
  */
318
318
  searchable?: boolean;
319
319
  /**
@@ -331,7 +331,7 @@ export type EnumFieldConfiguration = {
331
331
  */
332
332
  description?: string;
333
333
  /**
334
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
334
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
335
335
  */
336
336
  searchable?: boolean;
337
337
  /**
@@ -350,7 +350,7 @@ export type AssetFieldConfiguration = {
350
350
  */
351
351
  description?: string;
352
352
  /**
353
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
353
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
354
354
  */
355
355
  searchable?: boolean;
356
356
  /**
@@ -372,7 +372,7 @@ export type RelationFieldConfiguration = {
372
372
  */
373
373
  description?: string;
374
374
  /**
375
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
375
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
376
376
  */
377
377
  searchable?: boolean;
378
378
  /**
@@ -394,7 +394,7 @@ export type JsonFieldConfiguration = {
394
394
  */
395
395
  description?: string;
396
396
  /**
397
- * Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
397
+ * Search words match the field, in every search (API keys, search tokens, members). Default true for text, long_text, rich_text and enum.
398
398
  */
399
399
  searchable?: boolean;
400
400
  /**
@@ -539,7 +539,7 @@ export type FieldCreateProperties = {
539
539
  multiple?: boolean;
540
540
  };
541
541
  /**
542
- * Renames, describes or loosens a field. A change to its `type` or `multiple` rewrites record values, so it is a field migration (`POST /v1/fields/{id}/migrations`); either key here is `400` `unknown_parameter`, saying so.
542
+ * Renames, describes or loosens a field. A change to its `type` or `multiple` rewrites record values, so it is a field migration (`POST /v1/collections/{collection_id}/migrations`); either key here is `400` `unknown_parameter`, saying so.
543
543
  */
544
544
  export type FieldUpdate = {
545
545
  name?: string;
@@ -1480,6 +1480,7 @@ export type WebhookTestEventData = {
1480
1480
  webhook: null | Webhook;
1481
1481
  };
1482
1482
  export type Asset = AssetProperties;
1483
+ export type AssetKind = 'image' | 'video' | 'audio' | 'document' | 'other';
1483
1484
  export type AssetUpdate = {
1484
1485
  /**
1485
1486
  * Control characters are removed and path separators become `_`, as on upload.
@@ -1535,7 +1536,7 @@ export type AssetProperties = {
1535
1536
  */
1536
1537
  image_url: string | null;
1537
1538
  /**
1538
- * The URL of a small rendition (fits in 640×640, WebP), for ready images, deleted ones included until they are purged; null otherwise.
1539
+ * The URL of a small rendition (fits in 640×640, WebP), for ready images and SVGs (rasterized; SVGs have no `image_url`), deleted ones included until they are purged; null otherwise.
1539
1540
  */
1540
1541
  preview_url: string | null;
1541
1542
  uploaded_at: NullableTimestamp;
@@ -1762,10 +1763,22 @@ export type DeletedFilter = {
1762
1763
  * `type*` wildcard, or several with
1763
1764
  * `filter[content_type][in]=image*,application/pdf`, for example the
1764
1765
  * ones an asset field accepts (its `accepted_types`).
1766
+ * `filter[kind]` lists only assets of a kind, or several with
1767
+ * `filter[kind][in]=image,video`: `image`, `video` and `audio` by
1768
+ * their types (`image*` and so on); `document` for PDFs, plain text,
1769
+ * Markdown, CSV, and word processing, spreadsheet and presentation
1770
+ * files (Microsoft Office, OpenDocument, RTF); `other` for every other
1771
+ * file.
1765
1772
  *
1766
1773
  */
1767
1774
  export type AssetFilter = {
1768
1775
  deleted?: 'true' | 'false';
1776
+ kind?: AssetKind | {
1777
+ /**
1778
+ * Comma-separated kinds.
1779
+ */
1780
+ in: string;
1781
+ };
1769
1782
  content_type?: string | {
1770
1783
  /**
1771
1784
  * Up to 50 comma-separated MIME types or `type*` wildcards.
@@ -1884,7 +1897,10 @@ export type RecordsListErrors = {
1884
1897
  * Too many requests for this API key or user (or, with failing
1885
1898
  * credentials, this IP address). A published-only key is counted per
1886
1899
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
1887
- * are safe.
1900
+ * are safe. On the Free plan, an organization's API keys are also
1901
+ * refused once its API requests reach the month's limit, with a
1902
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
1903
+ * until the next month (UTC) or an upgrade.
1888
1904
  *
1889
1905
  */
1890
1906
  429: Error;
@@ -1979,7 +1995,10 @@ export type RecordsCreateErrors = {
1979
1995
  * Too many requests for this API key or user (or, with failing
1980
1996
  * credentials, this IP address). A published-only key is counted per
1981
1997
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
1982
- * are safe.
1998
+ * are safe. On the Free plan, an organization's API keys are also
1999
+ * refused once its API requests reach the month's limit, with a
2000
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2001
+ * until the next month (UTC) or an upgrade.
1983
2002
  *
1984
2003
  */
1985
2004
  429: Error;
@@ -2065,7 +2084,10 @@ export type RecordsDeleteErrors = {
2065
2084
  * Too many requests for this API key or user (or, with failing
2066
2085
  * credentials, this IP address). A published-only key is counted per
2067
2086
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2068
- * are safe.
2087
+ * are safe. On the Free plan, an organization's API keys are also
2088
+ * refused once its API requests reach the month's limit, with a
2089
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2090
+ * until the next month (UTC) or an upgrade.
2069
2091
  *
2070
2092
  */
2071
2093
  429: Error;
@@ -2112,7 +2134,10 @@ export type RecordsGetErrors = {
2112
2134
  * Too many requests for this API key or user (or, with failing
2113
2135
  * credentials, this IP address). A published-only key is counted per
2114
2136
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2115
- * are safe.
2137
+ * are safe. On the Free plan, an organization's API keys are also
2138
+ * refused once its API requests reach the month's limit, with a
2139
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2140
+ * until the next month (UTC) or an upgrade.
2116
2141
  *
2117
2142
  */
2118
2143
  429: Error;
@@ -2198,7 +2223,10 @@ export type RecordsUpdateErrors = {
2198
2223
  * Too many requests for this API key or user (or, with failing
2199
2224
  * credentials, this IP address). A published-only key is counted per
2200
2225
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2201
- * are safe.
2226
+ * are safe. On the Free plan, an organization's API keys are also
2227
+ * refused once its API requests reach the month's limit, with a
2228
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2229
+ * until the next month (UTC) or an upgrade.
2202
2230
  *
2203
2231
  */
2204
2232
  429: Error;
@@ -2274,7 +2302,10 @@ export type RecordsCountErrors = {
2274
2302
  * Too many requests for this API key or user (or, with failing
2275
2303
  * credentials, this IP address). A published-only key is counted per
2276
2304
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2277
- * are safe.
2305
+ * are safe. On the Free plan, an organization's API keys are also
2306
+ * refused once its API requests reach the month's limit, with a
2307
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2308
+ * until the next month (UTC) or an upgrade.
2278
2309
  *
2279
2310
  */
2280
2311
  429: Error;
@@ -2353,7 +2384,10 @@ export type RecordsBulkErrors = {
2353
2384
  * Too many requests for this API key or user (or, with failing
2354
2385
  * credentials, this IP address). A published-only key is counted per
2355
2386
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2356
- * are safe.
2387
+ * are safe. On the Free plan, an organization's API keys are also
2388
+ * refused once its API requests reach the month's limit, with a
2389
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2390
+ * until the next month (UTC) or an upgrade.
2357
2391
  *
2358
2392
  */
2359
2393
  429: Error;
@@ -2441,7 +2475,10 @@ export type RecordsRestoreErrors = {
2441
2475
  * Too many requests for this API key or user (or, with failing
2442
2476
  * credentials, this IP address). A published-only key is counted per
2443
2477
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2444
- * are safe.
2478
+ * are safe. On the Free plan, an organization's API keys are also
2479
+ * refused once its API requests reach the month's limit, with a
2480
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2481
+ * until the next month (UTC) or an upgrade.
2445
2482
  *
2446
2483
  */
2447
2484
  429: Error;
@@ -2523,7 +2560,10 @@ export type RecordsUnpublishErrors = {
2523
2560
  * Too many requests for this API key or user (or, with failing
2524
2561
  * credentials, this IP address). A published-only key is counted per
2525
2562
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2526
- * are safe.
2563
+ * are safe. On the Free plan, an organization's API keys are also
2564
+ * refused once its API requests reach the month's limit, with a
2565
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2566
+ * until the next month (UTC) or an upgrade.
2527
2567
  *
2528
2568
  */
2529
2569
  429: Error;
@@ -2565,7 +2605,10 @@ export type RecordsGetPublicationErrors = {
2565
2605
  * Too many requests for this API key or user (or, with failing
2566
2606
  * credentials, this IP address). A published-only key is counted per
2567
2607
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2568
- * are safe.
2608
+ * are safe. On the Free plan, an organization's API keys are also
2609
+ * refused once its API requests reach the month's limit, with a
2610
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2611
+ * until the next month (UTC) or an upgrade.
2569
2612
  *
2570
2613
  */
2571
2614
  429: Error;
@@ -2647,7 +2690,10 @@ export type RecordsPublishErrors = {
2647
2690
  * Too many requests for this API key or user (or, with failing
2648
2691
  * credentials, this IP address). A published-only key is counted per
2649
2692
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2650
- * are safe.
2693
+ * are safe. On the Free plan, an organization's API keys are also
2694
+ * refused once its API requests reach the month's limit, with a
2695
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2696
+ * until the next month (UTC) or an upgrade.
2651
2697
  *
2652
2698
  */
2653
2699
  429: Error;
@@ -2709,7 +2755,10 @@ export type RecordsUnscheduleErrors = {
2709
2755
  * Too many requests for this API key or user (or, with failing
2710
2756
  * credentials, this IP address). A published-only key is counted per
2711
2757
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2712
- * are safe.
2758
+ * are safe. On the Free plan, an organization's API keys are also
2759
+ * refused once its API requests reach the month's limit, with a
2760
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2761
+ * until the next month (UTC) or an upgrade.
2713
2762
  *
2714
2763
  */
2715
2764
  429: Error;
@@ -2751,7 +2800,10 @@ export type RecordsGetScheduleErrors = {
2751
2800
  * Too many requests for this API key or user (or, with failing
2752
2801
  * credentials, this IP address). A published-only key is counted per
2753
2802
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2754
- * are safe.
2803
+ * are safe. On the Free plan, an organization's API keys are also
2804
+ * refused once its API requests reach the month's limit, with a
2805
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2806
+ * until the next month (UTC) or an upgrade.
2755
2807
  *
2756
2808
  */
2757
2809
  429: Error;
@@ -2817,7 +2869,10 @@ export type RecordsScheduleErrors = {
2817
2869
  * Too many requests for this API key or user (or, with failing
2818
2870
  * credentials, this IP address). A published-only key is counted per
2819
2871
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2820
- * are safe.
2872
+ * are safe. On the Free plan, an organization's API keys are also
2873
+ * refused once its API requests reach the month's limit, with a
2874
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2875
+ * until the next month (UTC) or an upgrade.
2821
2876
  *
2822
2877
  */
2823
2878
  429: Error;
@@ -2872,7 +2927,10 @@ export type ScheduledChangesListErrors = {
2872
2927
  * Too many requests for this API key or user (or, with failing
2873
2928
  * credentials, this IP address). A published-only key is counted per
2874
2929
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2875
- * are safe.
2930
+ * are safe. On the Free plan, an organization's API keys are also
2931
+ * refused once its API requests reach the month's limit, with a
2932
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2933
+ * until the next month (UTC) or an upgrade.
2876
2934
  *
2877
2935
  */
2878
2936
  429: Error;
@@ -2934,7 +2992,10 @@ export type RecordRevisionsListErrors = {
2934
2992
  * Too many requests for this API key or user (or, with failing
2935
2993
  * credentials, this IP address). A published-only key is counted per
2936
2994
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2937
- * are safe.
2995
+ * are safe. On the Free plan, an organization's API keys are also
2996
+ * refused once its API requests reach the month's limit, with a
2997
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2998
+ * until the next month (UTC) or an upgrade.
2938
2999
  *
2939
3000
  */
2940
3001
  429: Error;
@@ -2980,7 +3041,10 @@ export type RecordRevisionsGetErrors = {
2980
3041
  * Too many requests for this API key or user (or, with failing
2981
3042
  * credentials, this IP address). A published-only key is counted per
2982
3043
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2983
- * are safe.
3044
+ * are safe. On the Free plan, an organization's API keys are also
3045
+ * refused once its API requests reach the month's limit, with a
3046
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3047
+ * until the next month (UTC) or an upgrade.
2984
3048
  *
2985
3049
  */
2986
3050
  429: Error;
@@ -3022,7 +3086,10 @@ export type RevisionsGetErrors = {
3022
3086
  * Too many requests for this API key or user (or, with failing
3023
3087
  * credentials, this IP address). A published-only key is counted per
3024
3088
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3025
- * are safe.
3089
+ * are safe. On the Free plan, an organization's API keys are also
3090
+ * refused once its API requests reach the month's limit, with a
3091
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3092
+ * until the next month (UTC) or an upgrade.
3026
3093
  *
3027
3094
  */
3028
3095
  429: Error;
@@ -3114,7 +3181,10 @@ export type RecordRevisionsRevertErrors = {
3114
3181
  * Too many requests for this API key or user (or, with failing
3115
3182
  * credentials, this IP address). A published-only key is counted per
3116
3183
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3117
- * are safe.
3184
+ * are safe. On the Free plan, an organization's API keys are also
3185
+ * refused once its API requests reach the month's limit, with a
3186
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3187
+ * until the next month (UTC) or an upgrade.
3118
3188
  *
3119
3189
  */
3120
3190
  429: Error;
@@ -3159,7 +3229,10 @@ export type RecordsDiffErrors = {
3159
3229
  * Too many requests for this API key or user (or, with failing
3160
3230
  * credentials, this IP address). A published-only key is counted per
3161
3231
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3162
- * are safe.
3232
+ * are safe. On the Free plan, an organization's API keys are also
3233
+ * refused once its API requests reach the month's limit, with a
3234
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3235
+ * until the next month (UTC) or an upgrade.
3163
3236
  *
3164
3237
  */
3165
3238
  429: Error;
@@ -3210,7 +3283,10 @@ export type RecordDraftsListErrors = {
3210
3283
  * Too many requests for this API key or user (or, with failing
3211
3284
  * credentials, this IP address). A published-only key is counted per
3212
3285
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3213
- * are safe.
3286
+ * are safe. On the Free plan, an organization's API keys are also
3287
+ * refused once its API requests reach the month's limit, with a
3288
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3289
+ * until the next month (UTC) or an upgrade.
3214
3290
  *
3215
3291
  */
3216
3292
  429: Error;
@@ -3276,7 +3352,10 @@ export type DraftsCreateErrors = {
3276
3352
  * Too many requests for this API key or user (or, with failing
3277
3353
  * credentials, this IP address). A published-only key is counted per
3278
3354
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3279
- * are safe.
3355
+ * are safe. On the Free plan, an organization's API keys are also
3356
+ * refused once its API requests reach the month's limit, with a
3357
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3358
+ * until the next month (UTC) or an upgrade.
3280
3359
  *
3281
3360
  */
3282
3361
  429: Error;
@@ -3331,7 +3410,10 @@ export type DraftsListErrors = {
3331
3410
  * Too many requests for this API key or user (or, with failing
3332
3411
  * credentials, this IP address). A published-only key is counted per
3333
3412
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3334
- * are safe.
3413
+ * are safe. On the Free plan, an organization's API keys are also
3414
+ * refused once its API requests reach the month's limit, with a
3415
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3416
+ * until the next month (UTC) or an upgrade.
3335
3417
  *
3336
3418
  */
3337
3419
  429: Error;
@@ -3403,7 +3485,10 @@ export type DraftsDiscardErrors = {
3403
3485
  * Too many requests for this API key or user (or, with failing
3404
3486
  * credentials, this IP address). A published-only key is counted per
3405
3487
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3406
- * are safe.
3488
+ * are safe. On the Free plan, an organization's API keys are also
3489
+ * refused once its API requests reach the month's limit, with a
3490
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3491
+ * until the next month (UTC) or an upgrade.
3407
3492
  *
3408
3493
  */
3409
3494
  429: Error;
@@ -3450,7 +3535,10 @@ export type DraftsGetErrors = {
3450
3535
  * Too many requests for this API key or user (or, with failing
3451
3536
  * credentials, this IP address). A published-only key is counted per
3452
3537
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3453
- * are safe.
3538
+ * are safe. On the Free plan, an organization's API keys are also
3539
+ * refused once its API requests reach the month's limit, with a
3540
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3541
+ * until the next month (UTC) or an upgrade.
3454
3542
  *
3455
3543
  */
3456
3544
  429: Error;
@@ -3526,7 +3614,10 @@ export type DraftsUpdateErrors = {
3526
3614
  * Too many requests for this API key or user (or, with failing
3527
3615
  * credentials, this IP address). A published-only key is counted per
3528
3616
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3529
- * are safe.
3617
+ * are safe. On the Free plan, an organization's API keys are also
3618
+ * refused once its API requests reach the month's limit, with a
3619
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3620
+ * until the next month (UTC) or an upgrade.
3530
3621
  *
3531
3622
  */
3532
3623
  429: Error;
@@ -3612,7 +3703,10 @@ export type DraftsMergeErrors = {
3612
3703
  * Too many requests for this API key or user (or, with failing
3613
3704
  * credentials, this IP address). A published-only key is counted per
3614
3705
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3615
- * are safe.
3706
+ * are safe. On the Free plan, an organization's API keys are also
3707
+ * refused once its API requests reach the month's limit, with a
3708
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3709
+ * until the next month (UTC) or an upgrade.
3616
3710
  *
3617
3711
  */
3618
3712
  429: Error;
@@ -3674,7 +3768,10 @@ export type DraftsUnscheduleErrors = {
3674
3768
  * Too many requests for this API key or user (or, with failing
3675
3769
  * credentials, this IP address). A published-only key is counted per
3676
3770
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3677
- * are safe.
3771
+ * are safe. On the Free plan, an organization's API keys are also
3772
+ * refused once its API requests reach the month's limit, with a
3773
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3774
+ * until the next month (UTC) or an upgrade.
3678
3775
  *
3679
3776
  */
3680
3777
  429: Error;
@@ -3740,7 +3837,10 @@ export type DraftsScheduleErrors = {
3740
3837
  * Too many requests for this API key or user (or, with failing
3741
3838
  * credentials, this IP address). A published-only key is counted per
3742
3839
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3743
- * are safe.
3840
+ * are safe. On the Free plan, an organization's API keys are also
3841
+ * refused once its API requests reach the month's limit, with a
3842
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3843
+ * until the next month (UTC) or an upgrade.
3744
3844
  *
3745
3845
  */
3746
3846
  429: Error;
@@ -3797,7 +3897,10 @@ export type CollectionsListErrors = {
3797
3897
  * Too many requests for this API key or user (or, with failing
3798
3898
  * credentials, this IP address). A published-only key is counted per
3799
3899
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3800
- * are safe.
3900
+ * are safe. On the Free plan, an organization's API keys are also
3901
+ * refused once its API requests reach the month's limit, with a
3902
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3903
+ * until the next month (UTC) or an upgrade.
3801
3904
  *
3802
3905
  */
3803
3906
  429: Error;
@@ -3879,7 +3982,10 @@ export type CollectionsCreateErrors = {
3879
3982
  * Too many requests for this API key or user (or, with failing
3880
3983
  * credentials, this IP address). A published-only key is counted per
3881
3984
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3882
- * are safe.
3985
+ * are safe. On the Free plan, an organization's API keys are also
3986
+ * refused once its API requests reach the month's limit, with a
3987
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3988
+ * until the next month (UTC) or an upgrade.
3883
3989
  *
3884
3990
  */
3885
3991
  429: Error;
@@ -3954,7 +4060,10 @@ export type CollectionsDeleteErrors = {
3954
4060
  * Too many requests for this API key or user (or, with failing
3955
4061
  * credentials, this IP address). A published-only key is counted per
3956
4062
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3957
- * are safe.
4063
+ * are safe. On the Free plan, an organization's API keys are also
4064
+ * refused once its API requests reach the month's limit, with a
4065
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4066
+ * until the next month (UTC) or an upgrade.
3958
4067
  *
3959
4068
  */
3960
4069
  429: Error;
@@ -3999,7 +4108,10 @@ export type CollectionsGetErrors = {
3999
4108
  * Too many requests for this API key or user (or, with failing
4000
4109
  * credentials, this IP address). A published-only key is counted per
4001
4110
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4002
- * are safe.
4111
+ * are safe. On the Free plan, an organization's API keys are also
4112
+ * refused once its API requests reach the month's limit, with a
4113
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4114
+ * until the next month (UTC) or an upgrade.
4003
4115
  *
4004
4116
  */
4005
4117
  429: Error;
@@ -4078,7 +4190,10 @@ export type CollectionsUpdateErrors = {
4078
4190
  * Too many requests for this API key or user (or, with failing
4079
4191
  * credentials, this IP address). A published-only key is counted per
4080
4192
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4081
- * are safe.
4193
+ * are safe. On the Free plan, an organization's API keys are also
4194
+ * refused once its API requests reach the month's limit, with a
4195
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4196
+ * until the next month (UTC) or an upgrade.
4082
4197
  *
4083
4198
  */
4084
4199
  429: Error;
@@ -4163,7 +4278,10 @@ export type CollectionsRestoreErrors = {
4163
4278
  * Too many requests for this API key or user (or, with failing
4164
4279
  * credentials, this IP address). A published-only key is counted per
4165
4280
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4166
- * are safe.
4281
+ * are safe. On the Free plan, an organization's API keys are also
4282
+ * refused once its API requests reach the month's limit, with a
4283
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4284
+ * until the next month (UTC) or an upgrade.
4167
4285
  *
4168
4286
  */
4169
4287
  429: Error;
@@ -4213,7 +4331,10 @@ export type CollectionsGetSchemaErrors = {
4213
4331
  * Too many requests for this API key or user (or, with failing
4214
4332
  * credentials, this IP address). A published-only key is counted per
4215
4333
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4216
- * are safe.
4334
+ * are safe. On the Free plan, an organization's API keys are also
4335
+ * refused once its API requests reach the month's limit, with a
4336
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4337
+ * until the next month (UTC) or an upgrade.
4217
4338
  *
4218
4339
  */
4219
4340
  429: Error;
@@ -4267,7 +4388,10 @@ export type SchemaChangesListErrors = {
4267
4388
  * Too many requests for this API key or user (or, with failing
4268
4389
  * credentials, this IP address). A published-only key is counted per
4269
4390
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4270
- * are safe.
4391
+ * are safe. On the Free plan, an organization's API keys are also
4392
+ * refused once its API requests reach the month's limit, with a
4393
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4394
+ * until the next month (UTC) or an upgrade.
4271
4395
  *
4272
4396
  */
4273
4397
  429: Error;
@@ -4309,7 +4433,10 @@ export type SchemaChangesGetErrors = {
4309
4433
  * Too many requests for this API key or user (or, with failing
4310
4434
  * credentials, this IP address). A published-only key is counted per
4311
4435
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4312
- * are safe.
4436
+ * are safe. On the Free plan, an organization's API keys are also
4437
+ * refused once its API requests reach the month's limit, with a
4438
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4439
+ * until the next month (UTC) or an upgrade.
4313
4440
  *
4314
4441
  */
4315
4442
  429: Error;
@@ -4369,7 +4496,10 @@ export type FieldsListErrors = {
4369
4496
  * Too many requests for this API key or user (or, with failing
4370
4497
  * credentials, this IP address). A published-only key is counted per
4371
4498
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4372
- * are safe.
4499
+ * are safe. On the Free plan, an organization's API keys are also
4500
+ * refused once its API requests reach the month's limit, with a
4501
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4502
+ * until the next month (UTC) or an upgrade.
4373
4503
  *
4374
4504
  */
4375
4505
  429: Error;
@@ -4448,7 +4578,10 @@ export type FieldsCreateErrors = {
4448
4578
  * Too many requests for this API key or user (or, with failing
4449
4579
  * credentials, this IP address). A published-only key is counted per
4450
4580
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4451
- * are safe.
4581
+ * are safe. On the Free plan, an organization's API keys are also
4582
+ * refused once its API requests reach the month's limit, with a
4583
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4584
+ * until the next month (UTC) or an upgrade.
4452
4585
  *
4453
4586
  */
4454
4587
  429: Error;
@@ -4520,7 +4653,10 @@ export type FieldsDeleteErrors = {
4520
4653
  * Too many requests for this API key or user (or, with failing
4521
4654
  * credentials, this IP address). A published-only key is counted per
4522
4655
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4523
- * are safe.
4656
+ * are safe. On the Free plan, an organization's API keys are also
4657
+ * refused once its API requests reach the month's limit, with a
4658
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4659
+ * until the next month (UTC) or an upgrade.
4524
4660
  *
4525
4661
  */
4526
4662
  429: Error;
@@ -4562,7 +4698,10 @@ export type FieldsGetErrors = {
4562
4698
  * Too many requests for this API key or user (or, with failing
4563
4699
  * credentials, this IP address). A published-only key is counted per
4564
4700
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4565
- * are safe.
4701
+ * are safe. On the Free plan, an organization's API keys are also
4702
+ * refused once its API requests reach the month's limit, with a
4703
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4704
+ * until the next month (UTC) or an upgrade.
4566
4705
  *
4567
4706
  */
4568
4707
  429: Error;
@@ -4638,7 +4777,10 @@ export type FieldsUpdateErrors = {
4638
4777
  * Too many requests for this API key or user (or, with failing
4639
4778
  * credentials, this IP address). A published-only key is counted per
4640
4779
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4641
- * are safe.
4780
+ * are safe. On the Free plan, an organization's API keys are also
4781
+ * refused once its API requests reach the month's limit, with a
4782
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4783
+ * until the next month (UTC) or an upgrade.
4642
4784
  *
4643
4785
  */
4644
4786
  429: Error;
@@ -4683,7 +4825,10 @@ export type FieldsGetOrderErrors = {
4683
4825
  * Too many requests for this API key or user (or, with failing
4684
4826
  * credentials, this IP address). A published-only key is counted per
4685
4827
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4686
- * are safe.
4828
+ * are safe. On the Free plan, an organization's API keys are also
4829
+ * refused once its API requests reach the month's limit, with a
4830
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4831
+ * until the next month (UTC) or an upgrade.
4687
4832
  *
4688
4833
  */
4689
4834
  429: Error;
@@ -4764,7 +4909,10 @@ export type FieldsReorderErrors = {
4764
4909
  * Too many requests for this API key or user (or, with failing
4765
4910
  * credentials, this IP address). A published-only key is counted per
4766
4911
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4767
- * are safe.
4912
+ * are safe. On the Free plan, an organization's API keys are also
4913
+ * refused once its API requests reach the month's limit, with a
4914
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4915
+ * until the next month (UTC) or an upgrade.
4768
4916
  *
4769
4917
  */
4770
4918
  429: Error;
@@ -4830,7 +4978,10 @@ export type FieldsRemoveAliasErrors = {
4830
4978
  * Too many requests for this API key or user (or, with failing
4831
4979
  * credentials, this IP address). A published-only key is counted per
4832
4980
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4833
- * are safe.
4981
+ * are safe. On the Free plan, an organization's API keys are also
4982
+ * refused once its API requests reach the month's limit, with a
4983
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4984
+ * until the next month (UTC) or an upgrade.
4834
4985
  *
4835
4986
  */
4836
4987
  429: Error;
@@ -4906,7 +5057,10 @@ export type FieldsRestoreErrors = {
4906
5057
  * Too many requests for this API key or user (or, with failing
4907
5058
  * credentials, this IP address). A published-only key is counted per
4908
5059
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4909
- * are safe.
5060
+ * are safe. On the Free plan, an organization's API keys are also
5061
+ * refused once its API requests reach the month's limit, with a
5062
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5063
+ * until the next month (UTC) or an upgrade.
4910
5064
  *
4911
5065
  */
4912
5066
  429: Error;
@@ -4960,7 +5114,10 @@ export type MigrationsListErrors = {
4960
5114
  * Too many requests for this API key or user (or, with failing
4961
5115
  * credentials, this IP address). A published-only key is counted per
4962
5116
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4963
- * are safe.
5117
+ * are safe. On the Free plan, an organization's API keys are also
5118
+ * refused once its API requests reach the month's limit, with a
5119
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5120
+ * until the next month (UTC) or an upgrade.
4964
5121
  *
4965
5122
  */
4966
5123
  429: Error;
@@ -5041,7 +5198,10 @@ export type MigrationsCreateErrors = {
5041
5198
  * Too many requests for this API key or user (or, with failing
5042
5199
  * credentials, this IP address). A published-only key is counted per
5043
5200
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5044
- * are safe.
5201
+ * are safe. On the Free plan, an organization's API keys are also
5202
+ * refused once its API requests reach the month's limit, with a
5203
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5204
+ * until the next month (UTC) or an upgrade.
5045
5205
  *
5046
5206
  */
5047
5207
  429: Error;
@@ -5087,7 +5247,10 @@ export type MigrationsGetErrors = {
5087
5247
  * Too many requests for this API key or user (or, with failing
5088
5248
  * credentials, this IP address). A published-only key is counted per
5089
5249
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5090
- * are safe.
5250
+ * are safe. On the Free plan, an organization's API keys are also
5251
+ * refused once its API requests reach the month's limit, with a
5252
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5253
+ * until the next month (UTC) or an upgrade.
5091
5254
  *
5092
5255
  */
5093
5256
  429: Error;
@@ -5149,7 +5312,10 @@ export type MigrationsCancelErrors = {
5149
5312
  * Too many requests for this API key or user (or, with failing
5150
5313
  * credentials, this IP address). A published-only key is counted per
5151
5314
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5152
- * are safe.
5315
+ * are safe. On the Free plan, an organization's API keys are also
5316
+ * refused once its API requests reach the month's limit, with a
5317
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5318
+ * until the next month (UTC) or an upgrade.
5153
5319
  *
5154
5320
  */
5155
5321
  429: Error;
@@ -5168,6 +5334,13 @@ export type AssetsListData = {
5168
5334
  project_id: string;
5169
5335
  };
5170
5336
  query?: {
5337
+ /**
5338
+ * Words that must each appear in the filename or the alt text,
5339
+ * ignoring case: `q=hero jpg` finds `Hero-banner.jpg`. Up to 10
5340
+ * words and 200 characters (`400` beyond).
5341
+ *
5342
+ */
5343
+ q?: string;
5171
5344
  /**
5172
5345
  * Page size.
5173
5346
  */
@@ -5182,10 +5355,22 @@ export type AssetsListData = {
5182
5355
  * `type*` wildcard, or several with
5183
5356
  * `filter[content_type][in]=image*,application/pdf`, for example the
5184
5357
  * ones an asset field accepts (its `accepted_types`).
5358
+ * `filter[kind]` lists only assets of a kind, or several with
5359
+ * `filter[kind][in]=image,video`: `image`, `video` and `audio` by
5360
+ * their types (`image*` and so on); `document` for PDFs, plain text,
5361
+ * Markdown, CSV, and word processing, spreadsheet and presentation
5362
+ * files (Microsoft Office, OpenDocument, RTF); `other` for every other
5363
+ * file.
5185
5364
  *
5186
5365
  */
5187
5366
  filter?: {
5188
5367
  deleted?: 'true' | 'false';
5368
+ kind?: AssetKind | {
5369
+ /**
5370
+ * Comma-separated kinds.
5371
+ */
5372
+ in: string;
5373
+ };
5189
5374
  content_type?: string | {
5190
5375
  /**
5191
5376
  * Up to 50 comma-separated MIME types or `type*` wildcards.
@@ -5217,7 +5402,10 @@ export type AssetsListErrors = {
5217
5402
  * Too many requests for this API key or user (or, with failing
5218
5403
  * credentials, this IP address). A published-only key is counted per
5219
5404
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5220
- * are safe.
5405
+ * are safe. On the Free plan, an organization's API keys are also
5406
+ * refused once its API requests reach the month's limit, with a
5407
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5408
+ * until the next month (UTC) or an upgrade.
5221
5409
  *
5222
5410
  */
5223
5411
  429: Error;
@@ -5289,7 +5477,10 @@ export type AssetsUploadErrors = {
5289
5477
  * Too many requests for this API key or user (or, with failing
5290
5478
  * credentials, this IP address). A published-only key is counted per
5291
5479
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5292
- * are safe.
5480
+ * are safe. On the Free plan, an organization's API keys are also
5481
+ * refused once its API requests reach the month's limit, with a
5482
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5483
+ * until the next month (UTC) or an upgrade.
5293
5484
  *
5294
5485
  */
5295
5486
  429: Error;
@@ -5355,7 +5546,10 @@ export type AssetsCompleteErrors = {
5355
5546
  * Too many requests for this API key or user (or, with failing
5356
5547
  * credentials, this IP address). A published-only key is counted per
5357
5548
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5358
- * are safe.
5549
+ * are safe. On the Free plan, an organization's API keys are also
5550
+ * refused once its API requests reach the month's limit, with a
5551
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5552
+ * until the next month (UTC) or an upgrade.
5359
5553
  *
5360
5554
  */
5361
5555
  429: Error;
@@ -5417,7 +5611,10 @@ export type AssetsDeleteErrors = {
5417
5611
  * Too many requests for this API key or user (or, with failing
5418
5612
  * credentials, this IP address). A published-only key is counted per
5419
5613
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5420
- * are safe.
5614
+ * are safe. On the Free plan, an organization's API keys are also
5615
+ * refused once its API requests reach the month's limit, with a
5616
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5617
+ * until the next month (UTC) or an upgrade.
5421
5618
  *
5422
5619
  */
5423
5620
  429: Error;
@@ -5459,7 +5656,10 @@ export type AssetsGetErrors = {
5459
5656
  * Too many requests for this API key or user (or, with failing
5460
5657
  * credentials, this IP address). A published-only key is counted per
5461
5658
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5462
- * are safe.
5659
+ * are safe. On the Free plan, an organization's API keys are also
5660
+ * refused once its API requests reach the month's limit, with a
5661
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5662
+ * until the next month (UTC) or an upgrade.
5463
5663
  *
5464
5664
  */
5465
5665
  429: Error;
@@ -5525,7 +5725,10 @@ export type AssetsUpdateErrors = {
5525
5725
  * Too many requests for this API key or user (or, with failing
5526
5726
  * credentials, this IP address). A published-only key is counted per
5527
5727
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5528
- * are safe.
5728
+ * are safe. On the Free plan, an organization's API keys are also
5729
+ * refused once its API requests reach the month's limit, with a
5730
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5731
+ * until the next month (UTC) or an upgrade.
5529
5732
  *
5530
5733
  */
5531
5734
  429: Error;
@@ -5571,7 +5774,10 @@ export type AssetsDownloadUrlErrors = {
5571
5774
  * Too many requests for this API key or user (or, with failing
5572
5775
  * credentials, this IP address). A published-only key is counted per
5573
5776
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5574
- * are safe.
5777
+ * are safe. On the Free plan, an organization's API keys are also
5778
+ * refused once its API requests reach the month's limit, with a
5779
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5780
+ * until the next month (UTC) or an upgrade.
5575
5781
  *
5576
5782
  */
5577
5783
  429: Error;
@@ -5613,7 +5819,10 @@ export type AssetsUsageErrors = {
5613
5819
  * Too many requests for this API key or user (or, with failing
5614
5820
  * credentials, this IP address). A published-only key is counted per
5615
5821
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5616
- * are safe.
5822
+ * are safe. On the Free plan, an organization's API keys are also
5823
+ * refused once its API requests reach the month's limit, with a
5824
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5825
+ * until the next month (UTC) or an upgrade.
5617
5826
  *
5618
5827
  */
5619
5828
  429: Error;
@@ -5675,7 +5884,10 @@ export type AssetsRestoreErrors = {
5675
5884
  * Too many requests for this API key or user (or, with failing
5676
5885
  * credentials, this IP address). A published-only key is counted per
5677
5886
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5678
- * are safe.
5887
+ * are safe. On the Free plan, an organization's API keys are also
5888
+ * refused once its API requests reach the month's limit, with a
5889
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5890
+ * until the next month (UTC) or an upgrade.
5679
5891
  *
5680
5892
  */
5681
5893
  429: Error;
@@ -5737,7 +5949,10 @@ export type AssetsPurgeErrors = {
5737
5949
  * Too many requests for this API key or user (or, with failing
5738
5950
  * credentials, this IP address). A published-only key is counted per
5739
5951
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5740
- * are safe.
5952
+ * are safe. On the Free plan, an organization's API keys are also
5953
+ * refused once its API requests reach the month's limit, with a
5954
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5955
+ * until the next month (UTC) or an upgrade.
5741
5956
  *
5742
5957
  */
5743
5958
  429: Error;
@@ -5834,7 +6049,10 @@ export type CollectionsSearchErrors = {
5834
6049
  * Too many requests for this API key or user (or, with failing
5835
6050
  * credentials, this IP address). A published-only key is counted per
5836
6051
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5837
- * are safe.
6052
+ * are safe. On the Free plan, an organization's API keys are also
6053
+ * refused once its API requests reach the month's limit, with a
6054
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6055
+ * until the next month (UTC) or an upgrade.
5838
6056
  *
5839
6057
  */
5840
6058
  429: Error;
@@ -5906,7 +6124,10 @@ export type ProjectsSearchErrors = {
5906
6124
  * Too many requests for this API key or user (or, with failing
5907
6125
  * credentials, this IP address). A published-only key is counted per
5908
6126
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5909
- * are safe.
6127
+ * are safe. On the Free plan, an organization's API keys are also
6128
+ * refused once its API requests reach the month's limit, with a
6129
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6130
+ * until the next month (UTC) or an upgrade.
5910
6131
  *
5911
6132
  */
5912
6133
  429: Error;
@@ -5955,7 +6176,10 @@ export type SearchIndexGetErrors = {
5955
6176
  * Too many requests for this API key or user (or, with failing
5956
6177
  * credentials, this IP address). A published-only key is counted per
5957
6178
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5958
- * are safe.
6179
+ * are safe. On the Free plan, an organization's API keys are also
6180
+ * refused once its API requests reach the month's limit, with a
6181
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6182
+ * until the next month (UTC) or an upgrade.
5959
6183
  *
5960
6184
  */
5961
6185
  429: Error;
@@ -6020,7 +6244,10 @@ export type SearchIndexRebuildErrors = {
6020
6244
  * Too many requests for this API key or user (or, with failing
6021
6245
  * credentials, this IP address). A published-only key is counted per
6022
6246
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6023
- * are safe.
6247
+ * are safe. On the Free plan, an organization's API keys are also
6248
+ * refused once its API requests reach the month's limit, with a
6249
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6250
+ * until the next month (UTC) or an upgrade.
6024
6251
  *
6025
6252
  */
6026
6253
  429: Error;
@@ -6077,7 +6304,10 @@ export type WebhooksListErrors = {
6077
6304
  * Too many requests for this API key or user (or, with failing
6078
6305
  * credentials, this IP address). A published-only key is counted per
6079
6306
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6080
- * are safe.
6307
+ * are safe. On the Free plan, an organization's API keys are also
6308
+ * refused once its API requests reach the month's limit, with a
6309
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6310
+ * until the next month (UTC) or an upgrade.
6081
6311
  *
6082
6312
  */
6083
6313
  429: Error;
@@ -6149,7 +6379,10 @@ export type WebhooksCreateErrors = {
6149
6379
  * Too many requests for this API key or user (or, with failing
6150
6380
  * credentials, this IP address). A published-only key is counted per
6151
6381
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6152
- * are safe.
6382
+ * are safe. On the Free plan, an organization's API keys are also
6383
+ * refused once its API requests reach the month's limit, with a
6384
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6385
+ * until the next month (UTC) or an upgrade.
6153
6386
  *
6154
6387
  */
6155
6388
  429: Error;
@@ -6211,7 +6444,10 @@ export type WebhooksDeleteErrors = {
6211
6444
  * Too many requests for this API key or user (or, with failing
6212
6445
  * credentials, this IP address). A published-only key is counted per
6213
6446
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6214
- * are safe.
6447
+ * are safe. On the Free plan, an organization's API keys are also
6448
+ * refused once its API requests reach the month's limit, with a
6449
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6450
+ * until the next month (UTC) or an upgrade.
6215
6451
  *
6216
6452
  */
6217
6453
  429: Error;
@@ -6253,7 +6489,10 @@ export type WebhooksGetErrors = {
6253
6489
  * Too many requests for this API key or user (or, with failing
6254
6490
  * credentials, this IP address). A published-only key is counted per
6255
6491
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6256
- * are safe.
6492
+ * are safe. On the Free plan, an organization's API keys are also
6493
+ * refused once its API requests reach the month's limit, with a
6494
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6495
+ * until the next month (UTC) or an upgrade.
6257
6496
  *
6258
6497
  */
6259
6498
  429: Error;
@@ -6319,7 +6558,10 @@ export type WebhooksUpdateErrors = {
6319
6558
  * Too many requests for this API key or user (or, with failing
6320
6559
  * credentials, this IP address). A published-only key is counted per
6321
6560
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6322
- * are safe.
6561
+ * are safe. On the Free plan, an organization's API keys are also
6562
+ * refused once its API requests reach the month's limit, with a
6563
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6564
+ * until the next month (UTC) or an upgrade.
6323
6565
  *
6324
6566
  */
6325
6567
  429: Error;
@@ -6381,7 +6623,10 @@ export type WebhooksTestErrors = {
6381
6623
  * Too many requests for this API key or user (or, with failing
6382
6624
  * credentials, this IP address). A published-only key is counted per
6383
6625
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6384
- * are safe.
6626
+ * are safe. On the Free plan, an organization's API keys are also
6627
+ * refused once its API requests reach the month's limit, with a
6628
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6629
+ * until the next month (UTC) or an upgrade.
6385
6630
  *
6386
6631
  */
6387
6632
  429: Error;
@@ -6432,7 +6677,10 @@ export type WebhookSecretsListErrors = {
6432
6677
  * Too many requests for this API key or user (or, with failing
6433
6678
  * credentials, this IP address). A published-only key is counted per
6434
6679
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6435
- * are safe.
6680
+ * are safe. On the Free plan, an organization's API keys are also
6681
+ * refused once its API requests reach the month's limit, with a
6682
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6683
+ * until the next month (UTC) or an upgrade.
6436
6684
  *
6437
6685
  */
6438
6686
  429: Error;
@@ -6494,7 +6742,10 @@ export type WebhooksRotateSecretErrors = {
6494
6742
  * Too many requests for this API key or user (or, with failing
6495
6743
  * credentials, this IP address). A published-only key is counted per
6496
6744
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6497
- * are safe.
6745
+ * are safe. On the Free plan, an organization's API keys are also
6746
+ * refused once its API requests reach the month's limit, with a
6747
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6748
+ * until the next month (UTC) or an upgrade.
6498
6749
  *
6499
6750
  */
6500
6751
  429: Error;
@@ -6556,7 +6807,10 @@ export type WebhookSecretsRetireErrors = {
6556
6807
  * Too many requests for this API key or user (or, with failing
6557
6808
  * credentials, this IP address). A published-only key is counted per
6558
6809
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6559
- * are safe.
6810
+ * are safe. On the Free plan, an organization's API keys are also
6811
+ * refused once its API requests reach the month's limit, with a
6812
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6813
+ * until the next month (UTC) or an upgrade.
6560
6814
  *
6561
6815
  */
6562
6816
  429: Error;
@@ -6624,7 +6878,10 @@ export type WebhooksRestoreErrors = {
6624
6878
  * Too many requests for this API key or user (or, with failing
6625
6879
  * credentials, this IP address). A published-only key is counted per
6626
6880
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6627
- * are safe.
6881
+ * are safe. On the Free plan, an organization's API keys are also
6882
+ * refused once its API requests reach the month's limit, with a
6883
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6884
+ * until the next month (UTC) or an upgrade.
6628
6885
  *
6629
6886
  */
6630
6887
  429: Error;
@@ -6678,7 +6935,10 @@ export type WebhookDeliveriesListErrors = {
6678
6935
  * Too many requests for this API key or user (or, with failing
6679
6936
  * credentials, this IP address). A published-only key is counted per
6680
6937
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6681
- * are safe.
6938
+ * are safe. On the Free plan, an organization's API keys are also
6939
+ * refused once its API requests reach the month's limit, with a
6940
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6941
+ * until the next month (UTC) or an upgrade.
6682
6942
  *
6683
6943
  */
6684
6944
  429: Error;
@@ -6720,7 +6980,10 @@ export type WebhookDeliveriesGetErrors = {
6720
6980
  * Too many requests for this API key or user (or, with failing
6721
6981
  * credentials, this IP address). A published-only key is counted per
6722
6982
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6723
- * are safe.
6983
+ * are safe. On the Free plan, an organization's API keys are also
6984
+ * refused once its API requests reach the month's limit, with a
6985
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6986
+ * until the next month (UTC) or an upgrade.
6724
6987
  *
6725
6988
  */
6726
6989
  429: Error;
@@ -6782,7 +7045,10 @@ export type WebhookDeliveriesRetryErrors = {
6782
7045
  * Too many requests for this API key or user (or, with failing
6783
7046
  * credentials, this IP address). A published-only key is counted per
6784
7047
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6785
- * are safe.
7048
+ * are safe. On the Free plan, an organization's API keys are also
7049
+ * refused once its API requests reach the month's limit, with a
7050
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7051
+ * until the next month (UTC) or an upgrade.
6786
7052
  *
6787
7053
  */
6788
7054
  429: Error;
@@ -6857,7 +7123,10 @@ export type AuditEventsListErrors = {
6857
7123
  * Too many requests for this API key or user (or, with failing
6858
7124
  * credentials, this IP address). A published-only key is counted per
6859
7125
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6860
- * are safe.
7126
+ * are safe. On the Free plan, an organization's API keys are also
7127
+ * refused once its API requests reach the month's limit, with a
7128
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7129
+ * until the next month (UTC) or an upgrade.
6861
7130
  *
6862
7131
  */
6863
7132
  429: Error;
@@ -6905,7 +7174,10 @@ export type MeGetErrors = {
6905
7174
  * Too many requests for this API key or user (or, with failing
6906
7175
  * credentials, this IP address). A published-only key is counted per
6907
7176
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6908
- * are safe.
7177
+ * are safe. On the Free plan, an organization's API keys are also
7178
+ * refused once its API requests reach the month's limit, with a
7179
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7180
+ * until the next month (UTC) or an upgrade.
6909
7181
  *
6910
7182
  */
6911
7183
  429: Error;
@@ -6941,7 +7213,10 @@ export type FeatureFlagsListErrors = {
6941
7213
  * Too many requests for this API key or user (or, with failing
6942
7214
  * credentials, this IP address). A published-only key is counted per
6943
7215
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6944
- * are safe.
7216
+ * are safe. On the Free plan, an organization's API keys are also
7217
+ * refused once its API requests reach the month's limit, with a
7218
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7219
+ * until the next month (UTC) or an upgrade.
6945
7220
  *
6946
7221
  */
6947
7222
  429: Error;