@nohead/sdk 0.6.0 → 0.8.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,9 +1536,25 @@ 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;
1542
+ /**
1543
+ * The URL of the file as uploaded, for ready assets of any type,
1544
+ * deleted ones included until they are purged; null otherwise. It
1545
+ * downloads the file under its `filename` (a rename applies within a
1546
+ * minute or so), is open and never expires, and is cached on a CDN.
1547
+ *
1548
+ */
1549
+ file_url: string | null;
1550
+ /**
1551
+ * The URL that plays a ready video or audio file inline, for
1552
+ * `<video>` and `<audio>` (with range requests, so players can seek),
1553
+ * deleted ones included until they are purged; null for other types.
1554
+ * Open, never expiring and cached on a CDN, like `file_url`.
1555
+ *
1556
+ */
1557
+ media_url: string | null;
1541
1558
  uploaded_at: NullableTimestamp;
1542
1559
  created_at: Timestamp;
1543
1560
  updated_at: Timestamp;
@@ -1568,17 +1585,11 @@ export type AssetUsage = {
1568
1585
  fields: Array<string>;
1569
1586
  }>;
1570
1587
  };
1571
- export type DownloadUrl = {
1572
- object: 'download_url';
1573
- asset_id: string;
1574
- url: string;
1575
- expires_at: Timestamp;
1576
- };
1577
1588
  export type AssetUploadCreate = {
1578
1589
  filename: string;
1579
1590
  content_type: string;
1580
1591
  /**
1581
- * Exact size of the file in bytes (at most 100 MB by default).
1592
+ * Exact size of the file in bytes, at most the plan's largest upload (10 MB on Free, 100 MB on paid plans).
1582
1593
  */
1583
1594
  byte_size: number;
1584
1595
  };
@@ -1762,10 +1773,22 @@ export type DeletedFilter = {
1762
1773
  * `type*` wildcard, or several with
1763
1774
  * `filter[content_type][in]=image*,application/pdf`, for example the
1764
1775
  * ones an asset field accepts (its `accepted_types`).
1776
+ * `filter[kind]` lists only assets of a kind, or several with
1777
+ * `filter[kind][in]=image,video`: `image`, `video` and `audio` by
1778
+ * their types (`image*` and so on); `document` for PDFs, plain text,
1779
+ * Markdown, CSV, and word processing, spreadsheet and presentation
1780
+ * files (Microsoft Office, OpenDocument, RTF); `other` for every other
1781
+ * file.
1765
1782
  *
1766
1783
  */
1767
1784
  export type AssetFilter = {
1768
1785
  deleted?: 'true' | 'false';
1786
+ kind?: AssetKind | {
1787
+ /**
1788
+ * Comma-separated kinds.
1789
+ */
1790
+ in: string;
1791
+ };
1769
1792
  content_type?: string | {
1770
1793
  /**
1771
1794
  * Up to 50 comma-separated MIME types or `type*` wildcards.
@@ -1884,7 +1907,10 @@ export type RecordsListErrors = {
1884
1907
  * Too many requests for this API key or user (or, with failing
1885
1908
  * credentials, this IP address). A published-only key is counted per
1886
1909
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
1887
- * are safe.
1910
+ * are safe. On the Free plan, an organization's API keys are also
1911
+ * refused once its API requests reach the month's limit, with a
1912
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
1913
+ * until the next month (UTC) or an upgrade.
1888
1914
  *
1889
1915
  */
1890
1916
  429: Error;
@@ -1979,7 +2005,10 @@ export type RecordsCreateErrors = {
1979
2005
  * Too many requests for this API key or user (or, with failing
1980
2006
  * credentials, this IP address). A published-only key is counted per
1981
2007
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
1982
- * are safe.
2008
+ * are safe. On the Free plan, an organization's API keys are also
2009
+ * refused once its API requests reach the month's limit, with a
2010
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2011
+ * until the next month (UTC) or an upgrade.
1983
2012
  *
1984
2013
  */
1985
2014
  429: Error;
@@ -2065,7 +2094,10 @@ export type RecordsDeleteErrors = {
2065
2094
  * Too many requests for this API key or user (or, with failing
2066
2095
  * credentials, this IP address). A published-only key is counted per
2067
2096
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2068
- * are safe.
2097
+ * are safe. On the Free plan, an organization's API keys are also
2098
+ * refused once its API requests reach the month's limit, with a
2099
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2100
+ * until the next month (UTC) or an upgrade.
2069
2101
  *
2070
2102
  */
2071
2103
  429: Error;
@@ -2112,7 +2144,10 @@ export type RecordsGetErrors = {
2112
2144
  * Too many requests for this API key or user (or, with failing
2113
2145
  * credentials, this IP address). A published-only key is counted per
2114
2146
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2115
- * are safe.
2147
+ * are safe. On the Free plan, an organization's API keys are also
2148
+ * refused once its API requests reach the month's limit, with a
2149
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2150
+ * until the next month (UTC) or an upgrade.
2116
2151
  *
2117
2152
  */
2118
2153
  429: Error;
@@ -2198,7 +2233,10 @@ export type RecordsUpdateErrors = {
2198
2233
  * Too many requests for this API key or user (or, with failing
2199
2234
  * credentials, this IP address). A published-only key is counted per
2200
2235
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2201
- * are safe.
2236
+ * are safe. On the Free plan, an organization's API keys are also
2237
+ * refused once its API requests reach the month's limit, with a
2238
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2239
+ * until the next month (UTC) or an upgrade.
2202
2240
  *
2203
2241
  */
2204
2242
  429: Error;
@@ -2274,7 +2312,10 @@ export type RecordsCountErrors = {
2274
2312
  * Too many requests for this API key or user (or, with failing
2275
2313
  * credentials, this IP address). A published-only key is counted per
2276
2314
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2277
- * are safe.
2315
+ * are safe. On the Free plan, an organization's API keys are also
2316
+ * refused once its API requests reach the month's limit, with a
2317
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2318
+ * until the next month (UTC) or an upgrade.
2278
2319
  *
2279
2320
  */
2280
2321
  429: Error;
@@ -2353,7 +2394,10 @@ export type RecordsBulkErrors = {
2353
2394
  * Too many requests for this API key or user (or, with failing
2354
2395
  * credentials, this IP address). A published-only key is counted per
2355
2396
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2356
- * are safe.
2397
+ * are safe. On the Free plan, an organization's API keys are also
2398
+ * refused once its API requests reach the month's limit, with a
2399
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2400
+ * until the next month (UTC) or an upgrade.
2357
2401
  *
2358
2402
  */
2359
2403
  429: Error;
@@ -2441,7 +2485,10 @@ export type RecordsRestoreErrors = {
2441
2485
  * Too many requests for this API key or user (or, with failing
2442
2486
  * credentials, this IP address). A published-only key is counted per
2443
2487
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2444
- * are safe.
2488
+ * are safe. On the Free plan, an organization's API keys are also
2489
+ * refused once its API requests reach the month's limit, with a
2490
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2491
+ * until the next month (UTC) or an upgrade.
2445
2492
  *
2446
2493
  */
2447
2494
  429: Error;
@@ -2523,7 +2570,10 @@ export type RecordsUnpublishErrors = {
2523
2570
  * Too many requests for this API key or user (or, with failing
2524
2571
  * credentials, this IP address). A published-only key is counted per
2525
2572
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2526
- * are safe.
2573
+ * are safe. On the Free plan, an organization's API keys are also
2574
+ * refused once its API requests reach the month's limit, with a
2575
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2576
+ * until the next month (UTC) or an upgrade.
2527
2577
  *
2528
2578
  */
2529
2579
  429: Error;
@@ -2565,7 +2615,10 @@ export type RecordsGetPublicationErrors = {
2565
2615
  * Too many requests for this API key or user (or, with failing
2566
2616
  * credentials, this IP address). A published-only key is counted per
2567
2617
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2568
- * are safe.
2618
+ * are safe. On the Free plan, an organization's API keys are also
2619
+ * refused once its API requests reach the month's limit, with a
2620
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2621
+ * until the next month (UTC) or an upgrade.
2569
2622
  *
2570
2623
  */
2571
2624
  429: Error;
@@ -2647,7 +2700,10 @@ export type RecordsPublishErrors = {
2647
2700
  * Too many requests for this API key or user (or, with failing
2648
2701
  * credentials, this IP address). A published-only key is counted per
2649
2702
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2650
- * are safe.
2703
+ * are safe. On the Free plan, an organization's API keys are also
2704
+ * refused once its API requests reach the month's limit, with a
2705
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2706
+ * until the next month (UTC) or an upgrade.
2651
2707
  *
2652
2708
  */
2653
2709
  429: Error;
@@ -2709,7 +2765,10 @@ export type RecordsUnscheduleErrors = {
2709
2765
  * Too many requests for this API key or user (or, with failing
2710
2766
  * credentials, this IP address). A published-only key is counted per
2711
2767
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2712
- * are safe.
2768
+ * are safe. On the Free plan, an organization's API keys are also
2769
+ * refused once its API requests reach the month's limit, with a
2770
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2771
+ * until the next month (UTC) or an upgrade.
2713
2772
  *
2714
2773
  */
2715
2774
  429: Error;
@@ -2751,7 +2810,10 @@ export type RecordsGetScheduleErrors = {
2751
2810
  * Too many requests for this API key or user (or, with failing
2752
2811
  * credentials, this IP address). A published-only key is counted per
2753
2812
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2754
- * are safe.
2813
+ * are safe. On the Free plan, an organization's API keys are also
2814
+ * refused once its API requests reach the month's limit, with a
2815
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2816
+ * until the next month (UTC) or an upgrade.
2755
2817
  *
2756
2818
  */
2757
2819
  429: Error;
@@ -2817,7 +2879,10 @@ export type RecordsScheduleErrors = {
2817
2879
  * Too many requests for this API key or user (or, with failing
2818
2880
  * credentials, this IP address). A published-only key is counted per
2819
2881
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2820
- * are safe.
2882
+ * are safe. On the Free plan, an organization's API keys are also
2883
+ * refused once its API requests reach the month's limit, with a
2884
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2885
+ * until the next month (UTC) or an upgrade.
2821
2886
  *
2822
2887
  */
2823
2888
  429: Error;
@@ -2872,7 +2937,10 @@ export type ScheduledChangesListErrors = {
2872
2937
  * Too many requests for this API key or user (or, with failing
2873
2938
  * credentials, this IP address). A published-only key is counted per
2874
2939
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2875
- * are safe.
2940
+ * are safe. On the Free plan, an organization's API keys are also
2941
+ * refused once its API requests reach the month's limit, with a
2942
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
2943
+ * until the next month (UTC) or an upgrade.
2876
2944
  *
2877
2945
  */
2878
2946
  429: Error;
@@ -2934,7 +3002,10 @@ export type RecordRevisionsListErrors = {
2934
3002
  * Too many requests for this API key or user (or, with failing
2935
3003
  * credentials, this IP address). A published-only key is counted per
2936
3004
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2937
- * are safe.
3005
+ * are safe. On the Free plan, an organization's API keys are also
3006
+ * refused once its API requests reach the month's limit, with a
3007
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3008
+ * until the next month (UTC) or an upgrade.
2938
3009
  *
2939
3010
  */
2940
3011
  429: Error;
@@ -2980,7 +3051,10 @@ export type RecordRevisionsGetErrors = {
2980
3051
  * Too many requests for this API key or user (or, with failing
2981
3052
  * credentials, this IP address). A published-only key is counted per
2982
3053
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
2983
- * are safe.
3054
+ * are safe. On the Free plan, an organization's API keys are also
3055
+ * refused once its API requests reach the month's limit, with a
3056
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3057
+ * until the next month (UTC) or an upgrade.
2984
3058
  *
2985
3059
  */
2986
3060
  429: Error;
@@ -3022,7 +3096,10 @@ export type RevisionsGetErrors = {
3022
3096
  * Too many requests for this API key or user (or, with failing
3023
3097
  * credentials, this IP address). A published-only key is counted per
3024
3098
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3025
- * are safe.
3099
+ * are safe. On the Free plan, an organization's API keys are also
3100
+ * refused once its API requests reach the month's limit, with a
3101
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3102
+ * until the next month (UTC) or an upgrade.
3026
3103
  *
3027
3104
  */
3028
3105
  429: Error;
@@ -3114,7 +3191,10 @@ export type RecordRevisionsRevertErrors = {
3114
3191
  * Too many requests for this API key or user (or, with failing
3115
3192
  * credentials, this IP address). A published-only key is counted per
3116
3193
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3117
- * are safe.
3194
+ * are safe. On the Free plan, an organization's API keys are also
3195
+ * refused once its API requests reach the month's limit, with a
3196
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3197
+ * until the next month (UTC) or an upgrade.
3118
3198
  *
3119
3199
  */
3120
3200
  429: Error;
@@ -3159,7 +3239,10 @@ export type RecordsDiffErrors = {
3159
3239
  * Too many requests for this API key or user (or, with failing
3160
3240
  * credentials, this IP address). A published-only key is counted per
3161
3241
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3162
- * are safe.
3242
+ * are safe. On the Free plan, an organization's API keys are also
3243
+ * refused once its API requests reach the month's limit, with a
3244
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3245
+ * until the next month (UTC) or an upgrade.
3163
3246
  *
3164
3247
  */
3165
3248
  429: Error;
@@ -3210,7 +3293,10 @@ export type RecordDraftsListErrors = {
3210
3293
  * Too many requests for this API key or user (or, with failing
3211
3294
  * credentials, this IP address). A published-only key is counted per
3212
3295
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3213
- * are safe.
3296
+ * are safe. On the Free plan, an organization's API keys are also
3297
+ * refused once its API requests reach the month's limit, with a
3298
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3299
+ * until the next month (UTC) or an upgrade.
3214
3300
  *
3215
3301
  */
3216
3302
  429: Error;
@@ -3276,7 +3362,10 @@ export type DraftsCreateErrors = {
3276
3362
  * Too many requests for this API key or user (or, with failing
3277
3363
  * credentials, this IP address). A published-only key is counted per
3278
3364
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3279
- * are safe.
3365
+ * are safe. On the Free plan, an organization's API keys are also
3366
+ * refused once its API requests reach the month's limit, with a
3367
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3368
+ * until the next month (UTC) or an upgrade.
3280
3369
  *
3281
3370
  */
3282
3371
  429: Error;
@@ -3331,7 +3420,10 @@ export type DraftsListErrors = {
3331
3420
  * Too many requests for this API key or user (or, with failing
3332
3421
  * credentials, this IP address). A published-only key is counted per
3333
3422
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3334
- * are safe.
3423
+ * are safe. On the Free plan, an organization's API keys are also
3424
+ * refused once its API requests reach the month's limit, with a
3425
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3426
+ * until the next month (UTC) or an upgrade.
3335
3427
  *
3336
3428
  */
3337
3429
  429: Error;
@@ -3403,7 +3495,10 @@ export type DraftsDiscardErrors = {
3403
3495
  * Too many requests for this API key or user (or, with failing
3404
3496
  * credentials, this IP address). A published-only key is counted per
3405
3497
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3406
- * are safe.
3498
+ * are safe. On the Free plan, an organization's API keys are also
3499
+ * refused once its API requests reach the month's limit, with a
3500
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3501
+ * until the next month (UTC) or an upgrade.
3407
3502
  *
3408
3503
  */
3409
3504
  429: Error;
@@ -3450,7 +3545,10 @@ export type DraftsGetErrors = {
3450
3545
  * Too many requests for this API key or user (or, with failing
3451
3546
  * credentials, this IP address). A published-only key is counted per
3452
3547
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3453
- * are safe.
3548
+ * are safe. On the Free plan, an organization's API keys are also
3549
+ * refused once its API requests reach the month's limit, with a
3550
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3551
+ * until the next month (UTC) or an upgrade.
3454
3552
  *
3455
3553
  */
3456
3554
  429: Error;
@@ -3526,7 +3624,10 @@ export type DraftsUpdateErrors = {
3526
3624
  * Too many requests for this API key or user (or, with failing
3527
3625
  * credentials, this IP address). A published-only key is counted per
3528
3626
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3529
- * are safe.
3627
+ * are safe. On the Free plan, an organization's API keys are also
3628
+ * refused once its API requests reach the month's limit, with a
3629
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3630
+ * until the next month (UTC) or an upgrade.
3530
3631
  *
3531
3632
  */
3532
3633
  429: Error;
@@ -3612,7 +3713,10 @@ export type DraftsMergeErrors = {
3612
3713
  * Too many requests for this API key or user (or, with failing
3613
3714
  * credentials, this IP address). A published-only key is counted per
3614
3715
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3615
- * are safe.
3716
+ * are safe. On the Free plan, an organization's API keys are also
3717
+ * refused once its API requests reach the month's limit, with a
3718
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3719
+ * until the next month (UTC) or an upgrade.
3616
3720
  *
3617
3721
  */
3618
3722
  429: Error;
@@ -3674,7 +3778,10 @@ export type DraftsUnscheduleErrors = {
3674
3778
  * Too many requests for this API key or user (or, with failing
3675
3779
  * credentials, this IP address). A published-only key is counted per
3676
3780
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3677
- * are safe.
3781
+ * are safe. On the Free plan, an organization's API keys are also
3782
+ * refused once its API requests reach the month's limit, with a
3783
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3784
+ * until the next month (UTC) or an upgrade.
3678
3785
  *
3679
3786
  */
3680
3787
  429: Error;
@@ -3740,7 +3847,10 @@ export type DraftsScheduleErrors = {
3740
3847
  * Too many requests for this API key or user (or, with failing
3741
3848
  * credentials, this IP address). A published-only key is counted per
3742
3849
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3743
- * are safe.
3850
+ * are safe. On the Free plan, an organization's API keys are also
3851
+ * refused once its API requests reach the month's limit, with a
3852
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3853
+ * until the next month (UTC) or an upgrade.
3744
3854
  *
3745
3855
  */
3746
3856
  429: Error;
@@ -3797,7 +3907,10 @@ export type CollectionsListErrors = {
3797
3907
  * Too many requests for this API key or user (or, with failing
3798
3908
  * credentials, this IP address). A published-only key is counted per
3799
3909
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3800
- * are safe.
3910
+ * are safe. On the Free plan, an organization's API keys are also
3911
+ * refused once its API requests reach the month's limit, with a
3912
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3913
+ * until the next month (UTC) or an upgrade.
3801
3914
  *
3802
3915
  */
3803
3916
  429: Error;
@@ -3879,7 +3992,10 @@ export type CollectionsCreateErrors = {
3879
3992
  * Too many requests for this API key or user (or, with failing
3880
3993
  * credentials, this IP address). A published-only key is counted per
3881
3994
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3882
- * are safe.
3995
+ * are safe. On the Free plan, an organization's API keys are also
3996
+ * refused once its API requests reach the month's limit, with a
3997
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
3998
+ * until the next month (UTC) or an upgrade.
3883
3999
  *
3884
4000
  */
3885
4001
  429: Error;
@@ -3954,7 +4070,10 @@ export type CollectionsDeleteErrors = {
3954
4070
  * Too many requests for this API key or user (or, with failing
3955
4071
  * credentials, this IP address). A published-only key is counted per
3956
4072
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
3957
- * are safe.
4073
+ * are safe. On the Free plan, an organization's API keys are also
4074
+ * refused once its API requests reach the month's limit, with a
4075
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4076
+ * until the next month (UTC) or an upgrade.
3958
4077
  *
3959
4078
  */
3960
4079
  429: Error;
@@ -3999,7 +4118,10 @@ export type CollectionsGetErrors = {
3999
4118
  * Too many requests for this API key or user (or, with failing
4000
4119
  * credentials, this IP address). A published-only key is counted per
4001
4120
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4002
- * are safe.
4121
+ * are safe. On the Free plan, an organization's API keys are also
4122
+ * refused once its API requests reach the month's limit, with a
4123
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4124
+ * until the next month (UTC) or an upgrade.
4003
4125
  *
4004
4126
  */
4005
4127
  429: Error;
@@ -4078,7 +4200,10 @@ export type CollectionsUpdateErrors = {
4078
4200
  * Too many requests for this API key or user (or, with failing
4079
4201
  * credentials, this IP address). A published-only key is counted per
4080
4202
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4081
- * are safe.
4203
+ * are safe. On the Free plan, an organization's API keys are also
4204
+ * refused once its API requests reach the month's limit, with a
4205
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4206
+ * until the next month (UTC) or an upgrade.
4082
4207
  *
4083
4208
  */
4084
4209
  429: Error;
@@ -4163,7 +4288,10 @@ export type CollectionsRestoreErrors = {
4163
4288
  * Too many requests for this API key or user (or, with failing
4164
4289
  * credentials, this IP address). A published-only key is counted per
4165
4290
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4166
- * are safe.
4291
+ * are safe. On the Free plan, an organization's API keys are also
4292
+ * refused once its API requests reach the month's limit, with a
4293
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4294
+ * until the next month (UTC) or an upgrade.
4167
4295
  *
4168
4296
  */
4169
4297
  429: Error;
@@ -4213,7 +4341,10 @@ export type CollectionsGetSchemaErrors = {
4213
4341
  * Too many requests for this API key or user (or, with failing
4214
4342
  * credentials, this IP address). A published-only key is counted per
4215
4343
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4216
- * are safe.
4344
+ * are safe. On the Free plan, an organization's API keys are also
4345
+ * refused once its API requests reach the month's limit, with a
4346
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4347
+ * until the next month (UTC) or an upgrade.
4217
4348
  *
4218
4349
  */
4219
4350
  429: Error;
@@ -4267,7 +4398,10 @@ export type SchemaChangesListErrors = {
4267
4398
  * Too many requests for this API key or user (or, with failing
4268
4399
  * credentials, this IP address). A published-only key is counted per
4269
4400
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4270
- * are safe.
4401
+ * are safe. On the Free plan, an organization's API keys are also
4402
+ * refused once its API requests reach the month's limit, with a
4403
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4404
+ * until the next month (UTC) or an upgrade.
4271
4405
  *
4272
4406
  */
4273
4407
  429: Error;
@@ -4309,7 +4443,10 @@ export type SchemaChangesGetErrors = {
4309
4443
  * Too many requests for this API key or user (or, with failing
4310
4444
  * credentials, this IP address). A published-only key is counted per
4311
4445
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4312
- * are safe.
4446
+ * are safe. On the Free plan, an organization's API keys are also
4447
+ * refused once its API requests reach the month's limit, with a
4448
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4449
+ * until the next month (UTC) or an upgrade.
4313
4450
  *
4314
4451
  */
4315
4452
  429: Error;
@@ -4369,7 +4506,10 @@ export type FieldsListErrors = {
4369
4506
  * Too many requests for this API key or user (or, with failing
4370
4507
  * credentials, this IP address). A published-only key is counted per
4371
4508
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4372
- * are safe.
4509
+ * are safe. On the Free plan, an organization's API keys are also
4510
+ * refused once its API requests reach the month's limit, with a
4511
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4512
+ * until the next month (UTC) or an upgrade.
4373
4513
  *
4374
4514
  */
4375
4515
  429: Error;
@@ -4448,7 +4588,10 @@ export type FieldsCreateErrors = {
4448
4588
  * Too many requests for this API key or user (or, with failing
4449
4589
  * credentials, this IP address). A published-only key is counted per
4450
4590
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4451
- * are safe.
4591
+ * are safe. On the Free plan, an organization's API keys are also
4592
+ * refused once its API requests reach the month's limit, with a
4593
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4594
+ * until the next month (UTC) or an upgrade.
4452
4595
  *
4453
4596
  */
4454
4597
  429: Error;
@@ -4520,7 +4663,10 @@ export type FieldsDeleteErrors = {
4520
4663
  * Too many requests for this API key or user (or, with failing
4521
4664
  * credentials, this IP address). A published-only key is counted per
4522
4665
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4523
- * are safe.
4666
+ * are safe. On the Free plan, an organization's API keys are also
4667
+ * refused once its API requests reach the month's limit, with a
4668
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4669
+ * until the next month (UTC) or an upgrade.
4524
4670
  *
4525
4671
  */
4526
4672
  429: Error;
@@ -4562,7 +4708,10 @@ export type FieldsGetErrors = {
4562
4708
  * Too many requests for this API key or user (or, with failing
4563
4709
  * credentials, this IP address). A published-only key is counted per
4564
4710
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4565
- * are safe.
4711
+ * are safe. On the Free plan, an organization's API keys are also
4712
+ * refused once its API requests reach the month's limit, with a
4713
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4714
+ * until the next month (UTC) or an upgrade.
4566
4715
  *
4567
4716
  */
4568
4717
  429: Error;
@@ -4638,7 +4787,10 @@ export type FieldsUpdateErrors = {
4638
4787
  * Too many requests for this API key or user (or, with failing
4639
4788
  * credentials, this IP address). A published-only key is counted per
4640
4789
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4641
- * are safe.
4790
+ * are safe. On the Free plan, an organization's API keys are also
4791
+ * refused once its API requests reach the month's limit, with a
4792
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4793
+ * until the next month (UTC) or an upgrade.
4642
4794
  *
4643
4795
  */
4644
4796
  429: Error;
@@ -4683,7 +4835,10 @@ export type FieldsGetOrderErrors = {
4683
4835
  * Too many requests for this API key or user (or, with failing
4684
4836
  * credentials, this IP address). A published-only key is counted per
4685
4837
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4686
- * are safe.
4838
+ * are safe. On the Free plan, an organization's API keys are also
4839
+ * refused once its API requests reach the month's limit, with a
4840
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4841
+ * until the next month (UTC) or an upgrade.
4687
4842
  *
4688
4843
  */
4689
4844
  429: Error;
@@ -4764,7 +4919,10 @@ export type FieldsReorderErrors = {
4764
4919
  * Too many requests for this API key or user (or, with failing
4765
4920
  * credentials, this IP address). A published-only key is counted per
4766
4921
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4767
- * are safe.
4922
+ * are safe. On the Free plan, an organization's API keys are also
4923
+ * refused once its API requests reach the month's limit, with a
4924
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4925
+ * until the next month (UTC) or an upgrade.
4768
4926
  *
4769
4927
  */
4770
4928
  429: Error;
@@ -4830,7 +4988,10 @@ export type FieldsRemoveAliasErrors = {
4830
4988
  * Too many requests for this API key or user (or, with failing
4831
4989
  * credentials, this IP address). A published-only key is counted per
4832
4990
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4833
- * are safe.
4991
+ * are safe. On the Free plan, an organization's API keys are also
4992
+ * refused once its API requests reach the month's limit, with a
4993
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
4994
+ * until the next month (UTC) or an upgrade.
4834
4995
  *
4835
4996
  */
4836
4997
  429: Error;
@@ -4906,7 +5067,10 @@ export type FieldsRestoreErrors = {
4906
5067
  * Too many requests for this API key or user (or, with failing
4907
5068
  * credentials, this IP address). A published-only key is counted per
4908
5069
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4909
- * are safe.
5070
+ * are safe. On the Free plan, an organization's API keys are also
5071
+ * refused once its API requests reach the month's limit, with a
5072
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5073
+ * until the next month (UTC) or an upgrade.
4910
5074
  *
4911
5075
  */
4912
5076
  429: Error;
@@ -4960,7 +5124,10 @@ export type MigrationsListErrors = {
4960
5124
  * Too many requests for this API key or user (or, with failing
4961
5125
  * credentials, this IP address). A published-only key is counted per
4962
5126
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
4963
- * are safe.
5127
+ * are safe. On the Free plan, an organization's API keys are also
5128
+ * refused once its API requests reach the month's limit, with a
5129
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5130
+ * until the next month (UTC) or an upgrade.
4964
5131
  *
4965
5132
  */
4966
5133
  429: Error;
@@ -5041,7 +5208,10 @@ export type MigrationsCreateErrors = {
5041
5208
  * Too many requests for this API key or user (or, with failing
5042
5209
  * credentials, this IP address). A published-only key is counted per
5043
5210
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5044
- * are safe.
5211
+ * are safe. On the Free plan, an organization's API keys are also
5212
+ * refused once its API requests reach the month's limit, with a
5213
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5214
+ * until the next month (UTC) or an upgrade.
5045
5215
  *
5046
5216
  */
5047
5217
  429: Error;
@@ -5087,7 +5257,10 @@ export type MigrationsGetErrors = {
5087
5257
  * Too many requests for this API key or user (or, with failing
5088
5258
  * credentials, this IP address). A published-only key is counted per
5089
5259
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5090
- * are safe.
5260
+ * are safe. On the Free plan, an organization's API keys are also
5261
+ * refused once its API requests reach the month's limit, with a
5262
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5263
+ * until the next month (UTC) or an upgrade.
5091
5264
  *
5092
5265
  */
5093
5266
  429: Error;
@@ -5149,7 +5322,10 @@ export type MigrationsCancelErrors = {
5149
5322
  * Too many requests for this API key or user (or, with failing
5150
5323
  * credentials, this IP address). A published-only key is counted per
5151
5324
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5152
- * are safe.
5325
+ * are safe. On the Free plan, an organization's API keys are also
5326
+ * refused once its API requests reach the month's limit, with a
5327
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5328
+ * until the next month (UTC) or an upgrade.
5153
5329
  *
5154
5330
  */
5155
5331
  429: Error;
@@ -5168,6 +5344,13 @@ export type AssetsListData = {
5168
5344
  project_id: string;
5169
5345
  };
5170
5346
  query?: {
5347
+ /**
5348
+ * Words that must each appear in the filename or the alt text,
5349
+ * ignoring case: `q=hero jpg` finds `Hero-banner.jpg`. Up to 10
5350
+ * words and 200 characters (`400` beyond).
5351
+ *
5352
+ */
5353
+ q?: string;
5171
5354
  /**
5172
5355
  * Page size.
5173
5356
  */
@@ -5182,10 +5365,22 @@ export type AssetsListData = {
5182
5365
  * `type*` wildcard, or several with
5183
5366
  * `filter[content_type][in]=image*,application/pdf`, for example the
5184
5367
  * ones an asset field accepts (its `accepted_types`).
5368
+ * `filter[kind]` lists only assets of a kind, or several with
5369
+ * `filter[kind][in]=image,video`: `image`, `video` and `audio` by
5370
+ * their types (`image*` and so on); `document` for PDFs, plain text,
5371
+ * Markdown, CSV, and word processing, spreadsheet and presentation
5372
+ * files (Microsoft Office, OpenDocument, RTF); `other` for every other
5373
+ * file.
5185
5374
  *
5186
5375
  */
5187
5376
  filter?: {
5188
5377
  deleted?: 'true' | 'false';
5378
+ kind?: AssetKind | {
5379
+ /**
5380
+ * Comma-separated kinds.
5381
+ */
5382
+ in: string;
5383
+ };
5189
5384
  content_type?: string | {
5190
5385
  /**
5191
5386
  * Up to 50 comma-separated MIME types or `type*` wildcards.
@@ -5217,7 +5412,10 @@ export type AssetsListErrors = {
5217
5412
  * Too many requests for this API key or user (or, with failing
5218
5413
  * credentials, this IP address). A published-only key is counted per
5219
5414
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5220
- * are safe.
5415
+ * are safe. On the Free plan, an organization's API keys are also
5416
+ * refused once its API requests reach the month's limit, with a
5417
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5418
+ * until the next month (UTC) or an upgrade.
5221
5419
  *
5222
5420
  */
5223
5421
  429: Error;
@@ -5289,7 +5487,10 @@ export type AssetsUploadErrors = {
5289
5487
  * Too many requests for this API key or user (or, with failing
5290
5488
  * credentials, this IP address). A published-only key is counted per
5291
5489
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5292
- * are safe.
5490
+ * are safe. On the Free plan, an organization's API keys are also
5491
+ * refused once its API requests reach the month's limit, with a
5492
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5493
+ * until the next month (UTC) or an upgrade.
5293
5494
  *
5294
5495
  */
5295
5496
  429: Error;
@@ -5355,7 +5556,10 @@ export type AssetsCompleteErrors = {
5355
5556
  * Too many requests for this API key or user (or, with failing
5356
5557
  * credentials, this IP address). A published-only key is counted per
5357
5558
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5358
- * are safe.
5559
+ * are safe. On the Free plan, an organization's API keys are also
5560
+ * refused once its API requests reach the month's limit, with a
5561
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5562
+ * until the next month (UTC) or an upgrade.
5359
5563
  *
5360
5564
  */
5361
5565
  429: Error;
@@ -5417,7 +5621,10 @@ export type AssetsDeleteErrors = {
5417
5621
  * Too many requests for this API key or user (or, with failing
5418
5622
  * credentials, this IP address). A published-only key is counted per
5419
5623
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5420
- * are safe.
5624
+ * are safe. On the Free plan, an organization's API keys are also
5625
+ * refused once its API requests reach the month's limit, with a
5626
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5627
+ * until the next month (UTC) or an upgrade.
5421
5628
  *
5422
5629
  */
5423
5630
  429: Error;
@@ -5459,7 +5666,10 @@ export type AssetsGetErrors = {
5459
5666
  * Too many requests for this API key or user (or, with failing
5460
5667
  * credentials, this IP address). A published-only key is counted per
5461
5668
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5462
- * are safe.
5669
+ * are safe. On the Free plan, an organization's API keys are also
5670
+ * refused once its API requests reach the month's limit, with a
5671
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5672
+ * until the next month (UTC) or an upgrade.
5463
5673
  *
5464
5674
  */
5465
5675
  429: Error;
@@ -5525,7 +5735,10 @@ export type AssetsUpdateErrors = {
5525
5735
  * Too many requests for this API key or user (or, with failing
5526
5736
  * credentials, this IP address). A published-only key is counted per
5527
5737
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5528
- * are safe.
5738
+ * are safe. On the Free plan, an organization's API keys are also
5739
+ * refused once its API requests reach the month's limit, with a
5740
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5741
+ * until the next month (UTC) or an upgrade.
5529
5742
  *
5530
5743
  */
5531
5744
  429: Error;
@@ -5538,52 +5751,6 @@ export type AssetsUpdateResponses = {
5538
5751
  200: Asset;
5539
5752
  };
5540
5753
  export type AssetsUpdateResponse = AssetsUpdateResponses[keyof AssetsUpdateResponses];
5541
- export type AssetsDownloadUrlData = {
5542
- body?: never;
5543
- path: {
5544
- asset_id: string;
5545
- };
5546
- query?: never;
5547
- url: '/v1/assets/{asset_id}/download-url';
5548
- };
5549
- export type AssetsDownloadUrlErrors = {
5550
- /**
5551
- * The request was malformed: unparseable JSON, an invalid query parameter, or a body key the operation doesn't take (detail code `unknown_parameter`, naming the key).
5552
- */
5553
- 400: Error;
5554
- /**
5555
- * Authentication is missing or invalid.
5556
- */
5557
- 401: Error;
5558
- /**
5559
- * The caller is not allowed to perform this action.
5560
- */
5561
- 403: Error;
5562
- /**
5563
- * The resource does not exist or is not visible to the caller.
5564
- */
5565
- 404: Error;
5566
- /**
5567
- * The request conflicts with current state.
5568
- */
5569
- 409: Error;
5570
- /**
5571
- * Too many requests for this API key or user (or, with failing
5572
- * credentials, this IP address). A published-only key is counted per
5573
- * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5574
- * are safe.
5575
- *
5576
- */
5577
- 429: Error;
5578
- };
5579
- export type AssetsDownloadUrlError = AssetsDownloadUrlErrors[keyof AssetsDownloadUrlErrors];
5580
- export type AssetsDownloadUrlResponses = {
5581
- /**
5582
- * The download URL.
5583
- */
5584
- 200: DownloadUrl;
5585
- };
5586
- export type AssetsDownloadUrlResponse = AssetsDownloadUrlResponses[keyof AssetsDownloadUrlResponses];
5587
5754
  export type AssetsUsageData = {
5588
5755
  body?: never;
5589
5756
  path: {
@@ -5613,7 +5780,10 @@ export type AssetsUsageErrors = {
5613
5780
  * Too many requests for this API key or user (or, with failing
5614
5781
  * credentials, this IP address). A published-only key is counted per
5615
5782
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5616
- * are safe.
5783
+ * are safe. On the Free plan, an organization's API keys are also
5784
+ * refused once its API requests reach the month's limit, with a
5785
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5786
+ * until the next month (UTC) or an upgrade.
5617
5787
  *
5618
5788
  */
5619
5789
  429: Error;
@@ -5675,7 +5845,10 @@ export type AssetsRestoreErrors = {
5675
5845
  * Too many requests for this API key or user (or, with failing
5676
5846
  * credentials, this IP address). A published-only key is counted per
5677
5847
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5678
- * are safe.
5848
+ * are safe. On the Free plan, an organization's API keys are also
5849
+ * refused once its API requests reach the month's limit, with a
5850
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5851
+ * until the next month (UTC) or an upgrade.
5679
5852
  *
5680
5853
  */
5681
5854
  429: Error;
@@ -5737,7 +5910,10 @@ export type AssetsPurgeErrors = {
5737
5910
  * Too many requests for this API key or user (or, with failing
5738
5911
  * credentials, this IP address). A published-only key is counted per
5739
5912
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5740
- * are safe.
5913
+ * are safe. On the Free plan, an organization's API keys are also
5914
+ * refused once its API requests reach the month's limit, with a
5915
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
5916
+ * until the next month (UTC) or an upgrade.
5741
5917
  *
5742
5918
  */
5743
5919
  429: Error;
@@ -5834,7 +6010,10 @@ export type CollectionsSearchErrors = {
5834
6010
  * Too many requests for this API key or user (or, with failing
5835
6011
  * credentials, this IP address). A published-only key is counted per
5836
6012
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5837
- * are safe.
6013
+ * are safe. On the Free plan, an organization's API keys are also
6014
+ * refused once its API requests reach the month's limit, with a
6015
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6016
+ * until the next month (UTC) or an upgrade.
5838
6017
  *
5839
6018
  */
5840
6019
  429: Error;
@@ -5906,7 +6085,10 @@ export type ProjectsSearchErrors = {
5906
6085
  * Too many requests for this API key or user (or, with failing
5907
6086
  * credentials, this IP address). A published-only key is counted per
5908
6087
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5909
- * are safe.
6088
+ * are safe. On the Free plan, an organization's API keys are also
6089
+ * refused once its API requests reach the month's limit, with a
6090
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6091
+ * until the next month (UTC) or an upgrade.
5910
6092
  *
5911
6093
  */
5912
6094
  429: Error;
@@ -5955,7 +6137,10 @@ export type SearchIndexGetErrors = {
5955
6137
  * Too many requests for this API key or user (or, with failing
5956
6138
  * credentials, this IP address). A published-only key is counted per
5957
6139
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
5958
- * are safe.
6140
+ * are safe. On the Free plan, an organization's API keys are also
6141
+ * refused once its API requests reach the month's limit, with a
6142
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6143
+ * until the next month (UTC) or an upgrade.
5959
6144
  *
5960
6145
  */
5961
6146
  429: Error;
@@ -6020,7 +6205,10 @@ export type SearchIndexRebuildErrors = {
6020
6205
  * Too many requests for this API key or user (or, with failing
6021
6206
  * credentials, this IP address). A published-only key is counted per
6022
6207
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6023
- * are safe.
6208
+ * are safe. On the Free plan, an organization's API keys are also
6209
+ * refused once its API requests reach the month's limit, with a
6210
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6211
+ * until the next month (UTC) or an upgrade.
6024
6212
  *
6025
6213
  */
6026
6214
  429: Error;
@@ -6077,7 +6265,10 @@ export type WebhooksListErrors = {
6077
6265
  * Too many requests for this API key or user (or, with failing
6078
6266
  * credentials, this IP address). A published-only key is counted per
6079
6267
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6080
- * are safe.
6268
+ * are safe. On the Free plan, an organization's API keys are also
6269
+ * refused once its API requests reach the month's limit, with a
6270
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6271
+ * until the next month (UTC) or an upgrade.
6081
6272
  *
6082
6273
  */
6083
6274
  429: Error;
@@ -6149,7 +6340,10 @@ export type WebhooksCreateErrors = {
6149
6340
  * Too many requests for this API key or user (or, with failing
6150
6341
  * credentials, this IP address). A published-only key is counted per
6151
6342
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6152
- * are safe.
6343
+ * are safe. On the Free plan, an organization's API keys are also
6344
+ * refused once its API requests reach the month's limit, with a
6345
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6346
+ * until the next month (UTC) or an upgrade.
6153
6347
  *
6154
6348
  */
6155
6349
  429: Error;
@@ -6211,7 +6405,10 @@ export type WebhooksDeleteErrors = {
6211
6405
  * Too many requests for this API key or user (or, with failing
6212
6406
  * credentials, this IP address). A published-only key is counted per
6213
6407
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6214
- * are safe.
6408
+ * are safe. On the Free plan, an organization's API keys are also
6409
+ * refused once its API requests reach the month's limit, with a
6410
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6411
+ * until the next month (UTC) or an upgrade.
6215
6412
  *
6216
6413
  */
6217
6414
  429: Error;
@@ -6253,7 +6450,10 @@ export type WebhooksGetErrors = {
6253
6450
  * Too many requests for this API key or user (or, with failing
6254
6451
  * credentials, this IP address). A published-only key is counted per
6255
6452
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6256
- * are safe.
6453
+ * are safe. On the Free plan, an organization's API keys are also
6454
+ * refused once its API requests reach the month's limit, with a
6455
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6456
+ * until the next month (UTC) or an upgrade.
6257
6457
  *
6258
6458
  */
6259
6459
  429: Error;
@@ -6319,7 +6519,10 @@ export type WebhooksUpdateErrors = {
6319
6519
  * Too many requests for this API key or user (or, with failing
6320
6520
  * credentials, this IP address). A published-only key is counted per
6321
6521
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6322
- * are safe.
6522
+ * are safe. On the Free plan, an organization's API keys are also
6523
+ * refused once its API requests reach the month's limit, with a
6524
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6525
+ * until the next month (UTC) or an upgrade.
6323
6526
  *
6324
6527
  */
6325
6528
  429: Error;
@@ -6381,7 +6584,10 @@ export type WebhooksTestErrors = {
6381
6584
  * Too many requests for this API key or user (or, with failing
6382
6585
  * credentials, this IP address). A published-only key is counted per
6383
6586
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6384
- * are safe.
6587
+ * are safe. On the Free plan, an organization's API keys are also
6588
+ * refused once its API requests reach the month's limit, with a
6589
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6590
+ * until the next month (UTC) or an upgrade.
6385
6591
  *
6386
6592
  */
6387
6593
  429: Error;
@@ -6432,7 +6638,10 @@ export type WebhookSecretsListErrors = {
6432
6638
  * Too many requests for this API key or user (or, with failing
6433
6639
  * credentials, this IP address). A published-only key is counted per
6434
6640
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6435
- * are safe.
6641
+ * are safe. On the Free plan, an organization's API keys are also
6642
+ * refused once its API requests reach the month's limit, with a
6643
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6644
+ * until the next month (UTC) or an upgrade.
6436
6645
  *
6437
6646
  */
6438
6647
  429: Error;
@@ -6494,7 +6703,10 @@ export type WebhooksRotateSecretErrors = {
6494
6703
  * Too many requests for this API key or user (or, with failing
6495
6704
  * credentials, this IP address). A published-only key is counted per
6496
6705
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6497
- * are safe.
6706
+ * are safe. On the Free plan, an organization's API keys are also
6707
+ * refused once its API requests reach the month's limit, with a
6708
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6709
+ * until the next month (UTC) or an upgrade.
6498
6710
  *
6499
6711
  */
6500
6712
  429: Error;
@@ -6556,7 +6768,10 @@ export type WebhookSecretsRetireErrors = {
6556
6768
  * Too many requests for this API key or user (or, with failing
6557
6769
  * credentials, this IP address). A published-only key is counted per
6558
6770
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6559
- * are safe.
6771
+ * are safe. On the Free plan, an organization's API keys are also
6772
+ * refused once its API requests reach the month's limit, with a
6773
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6774
+ * until the next month (UTC) or an upgrade.
6560
6775
  *
6561
6776
  */
6562
6777
  429: Error;
@@ -6624,7 +6839,10 @@ export type WebhooksRestoreErrors = {
6624
6839
  * Too many requests for this API key or user (or, with failing
6625
6840
  * credentials, this IP address). A published-only key is counted per
6626
6841
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6627
- * are safe.
6842
+ * are safe. On the Free plan, an organization's API keys are also
6843
+ * refused once its API requests reach the month's limit, with a
6844
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6845
+ * until the next month (UTC) or an upgrade.
6628
6846
  *
6629
6847
  */
6630
6848
  429: Error;
@@ -6678,7 +6896,10 @@ export type WebhookDeliveriesListErrors = {
6678
6896
  * Too many requests for this API key or user (or, with failing
6679
6897
  * credentials, this IP address). A published-only key is counted per
6680
6898
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6681
- * are safe.
6899
+ * are safe. On the Free plan, an organization's API keys are also
6900
+ * refused once its API requests reach the month's limit, with a
6901
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6902
+ * until the next month (UTC) or an upgrade.
6682
6903
  *
6683
6904
  */
6684
6905
  429: Error;
@@ -6720,7 +6941,10 @@ export type WebhookDeliveriesGetErrors = {
6720
6941
  * Too many requests for this API key or user (or, with failing
6721
6942
  * credentials, this IP address). A published-only key is counted per
6722
6943
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6723
- * are safe.
6944
+ * are safe. On the Free plan, an organization's API keys are also
6945
+ * refused once its API requests reach the month's limit, with a
6946
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
6947
+ * until the next month (UTC) or an upgrade.
6724
6948
  *
6725
6949
  */
6726
6950
  429: Error;
@@ -6782,7 +7006,10 @@ export type WebhookDeliveriesRetryErrors = {
6782
7006
  * Too many requests for this API key or user (or, with failing
6783
7007
  * credentials, this IP address). A published-only key is counted per
6784
7008
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6785
- * are safe.
7009
+ * are safe. On the Free plan, an organization's API keys are also
7010
+ * refused once its API requests reach the month's limit, with a
7011
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7012
+ * until the next month (UTC) or an upgrade.
6786
7013
  *
6787
7014
  */
6788
7015
  429: Error;
@@ -6857,7 +7084,10 @@ export type AuditEventsListErrors = {
6857
7084
  * Too many requests for this API key or user (or, with failing
6858
7085
  * credentials, this IP address). A published-only key is counted per
6859
7086
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6860
- * are safe.
7087
+ * are safe. On the Free plan, an organization's API keys are also
7088
+ * refused once its API requests reach the month's limit, with a
7089
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7090
+ * until the next month (UTC) or an upgrade.
6861
7091
  *
6862
7092
  */
6863
7093
  429: Error;
@@ -6905,7 +7135,10 @@ export type MeGetErrors = {
6905
7135
  * Too many requests for this API key or user (or, with failing
6906
7136
  * credentials, this IP address). A published-only key is counted per
6907
7137
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6908
- * are safe.
7138
+ * are safe. On the Free plan, an organization's API keys are also
7139
+ * refused once its API requests reach the month's limit, with a
7140
+ * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
7141
+ * until the next month (UTC) or an upgrade.
6909
7142
  *
6910
7143
  */
6911
7144
  429: Error;
@@ -6941,7 +7174,10 @@ export type FeatureFlagsListErrors = {
6941
7174
  * Too many requests for this API key or user (or, with failing
6942
7175
  * credentials, this IP address). A published-only key is counted per
6943
7176
  * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
6944
- * 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.
6945
7181
  *
6946
7182
  */
6947
7183
  429: Error;