@nohead/sdk 0.5.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.
- package/CHANGELOG.md +46 -0
- package/README.md +54 -16
- package/dist/client.d.ts +2 -1
- package/dist/client.js +3 -1
- package/dist/core.d.ts +4 -1
- package/dist/generated/operations.gen.d.ts +16 -8
- package/dist/generated/operations.gen.js +2 -1
- package/dist/generated/schemas.gen.d.ts +1 -1
- package/dist/generated/types.gen.d.ts +509 -138
- package/dist/images.d.ts +75 -0
- package/dist/images.js +113 -0
- package/dist/resources/assets.d.ts +14 -7
- package/dist/resources/assets.js +52 -12
- package/dist/resources/records.d.ts +17 -6
- package/dist/resources/records.js +18 -5
- package/dist/types.d.ts +16 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +5 -1
|
@@ -174,7 +174,7 @@ export type TextFieldConfiguration = {
|
|
|
174
174
|
*/
|
|
175
175
|
description?: string;
|
|
176
176
|
/**
|
|
177
|
-
* Search words match the field (API
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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/
|
|
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;
|
|
@@ -574,11 +574,15 @@ export type Collection = {
|
|
|
574
574
|
*/
|
|
575
575
|
purge_after: NullableTimestamp;
|
|
576
576
|
/**
|
|
577
|
-
* Whether
|
|
578
|
-
*
|
|
577
|
+
* Whether the project's search tokens (made in the web app) find
|
|
578
|
+
* its published records, from a browser or a backend. Off by
|
|
579
|
+
* default: every field of those records becomes readable by anyone
|
|
580
|
+
* with a token, so turn it on only for collections whose published
|
|
581
|
+
* records are public. A change reaches search tokens within
|
|
582
|
+
* seconds.
|
|
579
583
|
*
|
|
580
584
|
*/
|
|
581
|
-
|
|
585
|
+
public_search: boolean;
|
|
582
586
|
/**
|
|
583
587
|
* Active fields in position order.
|
|
584
588
|
*/
|
|
@@ -587,17 +591,17 @@ export type Collection = {
|
|
|
587
591
|
updated_at: Timestamp;
|
|
588
592
|
};
|
|
589
593
|
export type CollectionCreate = {
|
|
590
|
-
search_enabled?: boolean;
|
|
591
594
|
name: string;
|
|
592
595
|
slug: string;
|
|
593
596
|
description?: string | null;
|
|
597
|
+
public_search?: boolean;
|
|
594
598
|
fields?: Array<FieldCreate>;
|
|
595
599
|
};
|
|
596
600
|
export type CollectionUpdate = {
|
|
597
|
-
search_enabled?: boolean;
|
|
598
601
|
name?: string;
|
|
599
602
|
slug?: string;
|
|
600
603
|
description?: string | null;
|
|
604
|
+
public_search?: boolean;
|
|
601
605
|
};
|
|
602
606
|
export type CollectionList = {
|
|
603
607
|
data: Array<Collection>;
|
|
@@ -612,7 +616,10 @@ export type SchemaDefinition = {
|
|
|
612
616
|
slug: string;
|
|
613
617
|
description: string | null;
|
|
614
618
|
deleted_at: NullableTimestamp;
|
|
615
|
-
|
|
619
|
+
/**
|
|
620
|
+
* Absent from schemas before the setting existed (off).
|
|
621
|
+
*/
|
|
622
|
+
public_search?: boolean;
|
|
616
623
|
fields: Array<{
|
|
617
624
|
id: string;
|
|
618
625
|
name: string;
|
|
@@ -876,7 +883,7 @@ export type TimeFilter = {
|
|
|
876
883
|
/**
|
|
877
884
|
* The client a change came through; `scheduler` for scheduled changes.
|
|
878
885
|
*/
|
|
879
|
-
export type Via = 'ui' | 'api' | 'cli' | 'sdk' | 'system' | 'scheduler';
|
|
886
|
+
export type Via = 'ui' | 'api' | 'cli' | 'sdk' | 'mcp' | 'system' | 'scheduler';
|
|
880
887
|
/**
|
|
881
888
|
* Changes to a record's content that wait until they are merged into
|
|
882
889
|
* it, now or at `schedule.merge_at`. Content only: whether the record
|
|
@@ -1022,6 +1029,16 @@ export type Record = {
|
|
|
1022
1029
|
export type RecordWrite = {
|
|
1023
1030
|
data: RecordData;
|
|
1024
1031
|
};
|
|
1032
|
+
export type RecordCreate = {
|
|
1033
|
+
data: RecordData;
|
|
1034
|
+
/**
|
|
1035
|
+
* The key of a `unique` field (a slug, or a field with `unique` on)
|
|
1036
|
+
* whose value `data` includes: update the record that has it, or
|
|
1037
|
+
* create one.
|
|
1038
|
+
*
|
|
1039
|
+
*/
|
|
1040
|
+
upsert_on?: string;
|
|
1041
|
+
};
|
|
1025
1042
|
export type RecordList = {
|
|
1026
1043
|
data: Array<Record>;
|
|
1027
1044
|
meta: ListMeta;
|
|
@@ -1140,9 +1157,11 @@ export type SearchIndex = {
|
|
|
1140
1157
|
object: 'search_index';
|
|
1141
1158
|
collection_id: string;
|
|
1142
1159
|
/**
|
|
1143
|
-
* The
|
|
1160
|
+
* The index's name in the search engine, which search tokens search
|
|
1161
|
+
* (`indexUid` in Meilisearch's search API). Opaque; it never changes.
|
|
1162
|
+
*
|
|
1144
1163
|
*/
|
|
1145
|
-
|
|
1164
|
+
index: string;
|
|
1146
1165
|
/**
|
|
1147
1166
|
* `building` until first built; `stale` from the change that queues a rebuild until it has run; `failed` if the last rebuild failed (it is retried).
|
|
1148
1167
|
*/
|
|
@@ -1157,7 +1176,7 @@ export type SearchIndex = {
|
|
|
1157
1176
|
* (`record.*`, `draft.*`, `collection.*`, `field.*`, `asset.*`) or `*` for all.
|
|
1158
1177
|
*
|
|
1159
1178
|
*/
|
|
1160
|
-
export type WebhookEventType = 'record.created' | 'record.updated' | 'record.published' | 'record.unpublished' | 'record.deleted' | 'record.restored' | 'record.reverted' | 'record.redacted' | 'record.scheduled' | 'record.unscheduled' | 'record.schedule_failed' | 'draft.created' | 'draft.updated' | 'draft.discarded' | 'draft.scheduled' | 'draft.unscheduled' | 'draft.schedule_failed' | 'collection.created' | 'collection.updated' | 'collection.deleted' | 'collection.restored' | 'collection.fields_reordered' | 'field.created' | 'field.updated' | 'field.deleted' | 'field.restored' | 'field.migrated' | 'field.alias_removed' | 'asset.created' | 'asset.deleted' | 'asset.restored' | 'asset.purged';
|
|
1179
|
+
export type WebhookEventType = 'record.created' | 'record.updated' | 'record.published' | 'record.unpublished' | 'record.deleted' | 'record.restored' | 'record.reverted' | 'record.redacted' | 'record.scheduled' | 'record.unscheduled' | 'record.schedule_failed' | 'draft.created' | 'draft.updated' | 'draft.discarded' | 'draft.scheduled' | 'draft.unscheduled' | 'draft.schedule_failed' | 'collection.created' | 'collection.updated' | 'collection.deleted' | 'collection.restored' | 'collection.fields_reordered' | 'field.created' | 'field.updated' | 'field.deleted' | 'field.restored' | 'field.migrated' | 'field.alias_removed' | 'asset.created' | 'asset.updated' | 'asset.deleted' | 'asset.restored' | 'asset.purged';
|
|
1161
1180
|
export type WebhookSubscription = WebhookEventType | 'record.*' | 'draft.*' | 'collection.*' | 'field.*' | 'asset.*' | '*';
|
|
1162
1181
|
export type Webhook = WebhookProperties;
|
|
1163
1182
|
export type WebhookProperties = {
|
|
@@ -1461,14 +1480,29 @@ export type WebhookTestEventData = {
|
|
|
1461
1480
|
webhook: null | Webhook;
|
|
1462
1481
|
};
|
|
1463
1482
|
export type Asset = AssetProperties;
|
|
1483
|
+
export type AssetKind = 'image' | 'video' | 'audio' | 'document' | 'other';
|
|
1484
|
+
export type AssetUpdate = {
|
|
1485
|
+
/**
|
|
1486
|
+
* Control characters are removed and path separators become `_`, as on upload.
|
|
1487
|
+
*/
|
|
1488
|
+
filename?: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* Surrounding whitespace is removed; empty or null clears it.
|
|
1491
|
+
*/
|
|
1492
|
+
alt?: string | null;
|
|
1493
|
+
};
|
|
1464
1494
|
export type AssetProperties = {
|
|
1465
1495
|
id: string;
|
|
1466
1496
|
object: 'asset';
|
|
1467
1497
|
project_id: string;
|
|
1468
1498
|
/**
|
|
1469
|
-
* The
|
|
1499
|
+
* The filename, any Unicode, as uploaded unless renamed since. Downloads use it.
|
|
1470
1500
|
*/
|
|
1471
1501
|
filename: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* Alternative text, saying what an image shows; null until set. The default wherever the asset is used.
|
|
1504
|
+
*/
|
|
1505
|
+
alt: string | null;
|
|
1472
1506
|
content_type: string;
|
|
1473
1507
|
byte_size: number;
|
|
1474
1508
|
/**
|
|
@@ -1489,7 +1523,20 @@ export type AssetProperties = {
|
|
|
1489
1523
|
*/
|
|
1490
1524
|
purge_after: NullableTimestamp;
|
|
1491
1525
|
/**
|
|
1492
|
-
*
|
|
1526
|
+
* The URL of the whole image, for ready images (JPEG, PNG, GIF, WebP
|
|
1527
|
+
* or AVIF), deleted ones included until they are purged; null
|
|
1528
|
+
* otherwise. Image URLs are open and never expire. For a rendition,
|
|
1529
|
+
* write [imgproxy processing options](https://docs.imgproxy.net/usage/processing)
|
|
1530
|
+
* before `/plain/`, and a format after `@`: for example
|
|
1531
|
+
* `https://images.nohead.io/rs:fill:800:600/g:sm/plain/…@webp`. Renditions
|
|
1532
|
+
* are at most 4096 pixels a side, from originals of at most 50
|
|
1533
|
+
* megapixels. Options that would return the file as stored (`raw`,
|
|
1534
|
+
* `skip_processing`, `strip_metadata`) are refused.
|
|
1535
|
+
*
|
|
1536
|
+
*/
|
|
1537
|
+
image_url: string | null;
|
|
1538
|
+
/**
|
|
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.
|
|
1493
1540
|
*/
|
|
1494
1541
|
preview_url: string | null;
|
|
1495
1542
|
uploaded_at: NullableTimestamp;
|
|
@@ -1500,16 +1547,6 @@ export type AssetList = {
|
|
|
1500
1547
|
data: Array<Asset>;
|
|
1501
1548
|
meta: ListMeta;
|
|
1502
1549
|
};
|
|
1503
|
-
export type ImageUrl = {
|
|
1504
|
-
object: 'image_url';
|
|
1505
|
-
asset_id: string;
|
|
1506
|
-
url: string;
|
|
1507
|
-
width: number | null;
|
|
1508
|
-
height: number | null;
|
|
1509
|
-
fit: 'contain' | 'cover' | 'fill';
|
|
1510
|
-
format: 'original' | 'webp' | 'avif' | 'jpeg' | 'png';
|
|
1511
|
-
quality: number | null;
|
|
1512
|
-
};
|
|
1513
1550
|
export type AssetUsage = {
|
|
1514
1551
|
object: 'asset_usage';
|
|
1515
1552
|
asset_id: string;
|
|
@@ -1632,6 +1669,7 @@ export type WebhookId = string;
|
|
|
1632
1669
|
export type DeliveryId = string;
|
|
1633
1670
|
export type RecordId = string;
|
|
1634
1671
|
export type DraftId = string;
|
|
1672
|
+
export type RevisionId = string;
|
|
1635
1673
|
/**
|
|
1636
1674
|
* Per-record revision number.
|
|
1637
1675
|
*/
|
|
@@ -1725,10 +1763,22 @@ export type DeletedFilter = {
|
|
|
1725
1763
|
* `type*` wildcard, or several with
|
|
1726
1764
|
* `filter[content_type][in]=image*,application/pdf`, for example the
|
|
1727
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.
|
|
1728
1772
|
*
|
|
1729
1773
|
*/
|
|
1730
1774
|
export type AssetFilter = {
|
|
1731
1775
|
deleted?: 'true' | 'false';
|
|
1776
|
+
kind?: AssetKind | {
|
|
1777
|
+
/**
|
|
1778
|
+
* Comma-separated kinds.
|
|
1779
|
+
*/
|
|
1780
|
+
in: string;
|
|
1781
|
+
};
|
|
1732
1782
|
content_type?: string | {
|
|
1733
1783
|
/**
|
|
1734
1784
|
* Up to 50 comma-separated MIME types or `type*` wildcards.
|
|
@@ -1847,7 +1897,10 @@ export type RecordsListErrors = {
|
|
|
1847
1897
|
* Too many requests for this API key or user (or, with failing
|
|
1848
1898
|
* credentials, this IP address). A published-only key is counted per
|
|
1849
1899
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
1850
|
-
* 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.
|
|
1851
1904
|
*
|
|
1852
1905
|
*/
|
|
1853
1906
|
429: Error;
|
|
@@ -1861,7 +1914,7 @@ export type RecordsListResponses = {
|
|
|
1861
1914
|
};
|
|
1862
1915
|
export type RecordsListResponse = RecordsListResponses[keyof RecordsListResponses];
|
|
1863
1916
|
export type RecordsCreateData = {
|
|
1864
|
-
body:
|
|
1917
|
+
body: RecordCreate;
|
|
1865
1918
|
headers?: {
|
|
1866
1919
|
/**
|
|
1867
1920
|
* A unique value (1-255 printable ASCII characters) that makes retrying
|
|
@@ -1873,6 +1926,10 @@ export type RecordsCreateData = {
|
|
|
1873
1926
|
*
|
|
1874
1927
|
*/
|
|
1875
1928
|
'Idempotency-Key'?: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* The revision you last read (the record's, or the draft's for a draft), e.g. `"7"`. Stale writes fail with 412.
|
|
1931
|
+
*/
|
|
1932
|
+
'If-Match'?: string;
|
|
1876
1933
|
/**
|
|
1877
1934
|
* First-party client identifier recorded in history (e.g. `cli/0.3.1`). Informational only.
|
|
1878
1935
|
*/
|
|
@@ -1924,6 +1981,12 @@ export type RecordsCreateErrors = {
|
|
|
1924
1981
|
* The request conflicts with current state.
|
|
1925
1982
|
*/
|
|
1926
1983
|
409: Error;
|
|
1984
|
+
/**
|
|
1985
|
+
* The resource changed since the revision given in `If-Match`. Nothing was
|
|
1986
|
+
* written; `details` includes the current revision.
|
|
1987
|
+
*
|
|
1988
|
+
*/
|
|
1989
|
+
412: Error;
|
|
1927
1990
|
/**
|
|
1928
1991
|
* The request failed validation.
|
|
1929
1992
|
*/
|
|
@@ -1932,13 +1995,20 @@ export type RecordsCreateErrors = {
|
|
|
1932
1995
|
* Too many requests for this API key or user (or, with failing
|
|
1933
1996
|
* credentials, this IP address). A published-only key is counted per
|
|
1934
1997
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
1935
|
-
* 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.
|
|
1936
2002
|
*
|
|
1937
2003
|
*/
|
|
1938
2004
|
429: Error;
|
|
1939
2005
|
};
|
|
1940
2006
|
export type RecordsCreateError = RecordsCreateErrors[keyof RecordsCreateErrors];
|
|
1941
2007
|
export type RecordsCreateResponses = {
|
|
2008
|
+
/**
|
|
2009
|
+
* The record.
|
|
2010
|
+
*/
|
|
2011
|
+
200: Record;
|
|
1942
2012
|
/**
|
|
1943
2013
|
* The created record.
|
|
1944
2014
|
*/
|
|
@@ -2014,7 +2084,10 @@ export type RecordsDeleteErrors = {
|
|
|
2014
2084
|
* Too many requests for this API key or user (or, with failing
|
|
2015
2085
|
* credentials, this IP address). A published-only key is counted per
|
|
2016
2086
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2017
|
-
* 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.
|
|
2018
2091
|
*
|
|
2019
2092
|
*/
|
|
2020
2093
|
429: Error;
|
|
@@ -2061,7 +2134,10 @@ export type RecordsGetErrors = {
|
|
|
2061
2134
|
* Too many requests for this API key or user (or, with failing
|
|
2062
2135
|
* credentials, this IP address). A published-only key is counted per
|
|
2063
2136
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2064
|
-
* 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.
|
|
2065
2141
|
*
|
|
2066
2142
|
*/
|
|
2067
2143
|
429: Error;
|
|
@@ -2147,7 +2223,10 @@ export type RecordsUpdateErrors = {
|
|
|
2147
2223
|
* Too many requests for this API key or user (or, with failing
|
|
2148
2224
|
* credentials, this IP address). A published-only key is counted per
|
|
2149
2225
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2150
|
-
* 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.
|
|
2151
2230
|
*
|
|
2152
2231
|
*/
|
|
2153
2232
|
429: Error;
|
|
@@ -2223,7 +2302,10 @@ export type RecordsCountErrors = {
|
|
|
2223
2302
|
* Too many requests for this API key or user (or, with failing
|
|
2224
2303
|
* credentials, this IP address). A published-only key is counted per
|
|
2225
2304
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2226
|
-
* 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.
|
|
2227
2309
|
*
|
|
2228
2310
|
*/
|
|
2229
2311
|
429: Error;
|
|
@@ -2302,7 +2384,10 @@ export type RecordsBulkErrors = {
|
|
|
2302
2384
|
* Too many requests for this API key or user (or, with failing
|
|
2303
2385
|
* credentials, this IP address). A published-only key is counted per
|
|
2304
2386
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2305
|
-
* 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.
|
|
2306
2391
|
*
|
|
2307
2392
|
*/
|
|
2308
2393
|
429: Error;
|
|
@@ -2390,7 +2475,10 @@ export type RecordsRestoreErrors = {
|
|
|
2390
2475
|
* Too many requests for this API key or user (or, with failing
|
|
2391
2476
|
* credentials, this IP address). A published-only key is counted per
|
|
2392
2477
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2393
|
-
* 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.
|
|
2394
2482
|
*
|
|
2395
2483
|
*/
|
|
2396
2484
|
429: Error;
|
|
@@ -2472,7 +2560,10 @@ export type RecordsUnpublishErrors = {
|
|
|
2472
2560
|
* Too many requests for this API key or user (or, with failing
|
|
2473
2561
|
* credentials, this IP address). A published-only key is counted per
|
|
2474
2562
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2475
|
-
* 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.
|
|
2476
2567
|
*
|
|
2477
2568
|
*/
|
|
2478
2569
|
429: Error;
|
|
@@ -2514,7 +2605,10 @@ export type RecordsGetPublicationErrors = {
|
|
|
2514
2605
|
* Too many requests for this API key or user (or, with failing
|
|
2515
2606
|
* credentials, this IP address). A published-only key is counted per
|
|
2516
2607
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2517
|
-
* 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.
|
|
2518
2612
|
*
|
|
2519
2613
|
*/
|
|
2520
2614
|
429: Error;
|
|
@@ -2596,7 +2690,10 @@ export type RecordsPublishErrors = {
|
|
|
2596
2690
|
* Too many requests for this API key or user (or, with failing
|
|
2597
2691
|
* credentials, this IP address). A published-only key is counted per
|
|
2598
2692
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2599
|
-
* 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.
|
|
2600
2697
|
*
|
|
2601
2698
|
*/
|
|
2602
2699
|
429: Error;
|
|
@@ -2658,7 +2755,10 @@ export type RecordsUnscheduleErrors = {
|
|
|
2658
2755
|
* Too many requests for this API key or user (or, with failing
|
|
2659
2756
|
* credentials, this IP address). A published-only key is counted per
|
|
2660
2757
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2661
|
-
* 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.
|
|
2662
2762
|
*
|
|
2663
2763
|
*/
|
|
2664
2764
|
429: Error;
|
|
@@ -2700,7 +2800,10 @@ export type RecordsGetScheduleErrors = {
|
|
|
2700
2800
|
* Too many requests for this API key or user (or, with failing
|
|
2701
2801
|
* credentials, this IP address). A published-only key is counted per
|
|
2702
2802
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2703
|
-
* 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.
|
|
2704
2807
|
*
|
|
2705
2808
|
*/
|
|
2706
2809
|
429: Error;
|
|
@@ -2766,7 +2869,10 @@ export type RecordsScheduleErrors = {
|
|
|
2766
2869
|
* Too many requests for this API key or user (or, with failing
|
|
2767
2870
|
* credentials, this IP address). A published-only key is counted per
|
|
2768
2871
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2769
|
-
* 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.
|
|
2770
2876
|
*
|
|
2771
2877
|
*/
|
|
2772
2878
|
429: Error;
|
|
@@ -2821,7 +2927,10 @@ export type ScheduledChangesListErrors = {
|
|
|
2821
2927
|
* Too many requests for this API key or user (or, with failing
|
|
2822
2928
|
* credentials, this IP address). A published-only key is counted per
|
|
2823
2929
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2824
|
-
* 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.
|
|
2825
2934
|
*
|
|
2826
2935
|
*/
|
|
2827
2936
|
429: Error;
|
|
@@ -2883,7 +2992,10 @@ export type RecordRevisionsListErrors = {
|
|
|
2883
2992
|
* Too many requests for this API key or user (or, with failing
|
|
2884
2993
|
* credentials, this IP address). A published-only key is counted per
|
|
2885
2994
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2886
|
-
* 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.
|
|
2887
2999
|
*
|
|
2888
3000
|
*/
|
|
2889
3001
|
429: Error;
|
|
@@ -2929,7 +3041,10 @@ export type RecordRevisionsGetErrors = {
|
|
|
2929
3041
|
* Too many requests for this API key or user (or, with failing
|
|
2930
3042
|
* credentials, this IP address). A published-only key is counted per
|
|
2931
3043
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
2932
|
-
* 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.
|
|
2933
3048
|
*
|
|
2934
3049
|
*/
|
|
2935
3050
|
429: Error;
|
|
@@ -2942,6 +3057,51 @@ export type RecordRevisionsGetResponses = {
|
|
|
2942
3057
|
200: RecordRevisionDetail;
|
|
2943
3058
|
};
|
|
2944
3059
|
export type RecordRevisionsGetResponse = RecordRevisionsGetResponses[keyof RecordRevisionsGetResponses];
|
|
3060
|
+
export type RevisionsGetData = {
|
|
3061
|
+
body?: never;
|
|
3062
|
+
path: {
|
|
3063
|
+
revision_id: string;
|
|
3064
|
+
};
|
|
3065
|
+
query?: never;
|
|
3066
|
+
url: '/v1/revisions/{revision_id}';
|
|
3067
|
+
};
|
|
3068
|
+
export type RevisionsGetErrors = {
|
|
3069
|
+
/**
|
|
3070
|
+
* 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).
|
|
3071
|
+
*/
|
|
3072
|
+
400: Error;
|
|
3073
|
+
/**
|
|
3074
|
+
* Authentication is missing or invalid.
|
|
3075
|
+
*/
|
|
3076
|
+
401: Error;
|
|
3077
|
+
/**
|
|
3078
|
+
* The caller is not allowed to perform this action.
|
|
3079
|
+
*/
|
|
3080
|
+
403: Error;
|
|
3081
|
+
/**
|
|
3082
|
+
* The resource does not exist or is not visible to the caller.
|
|
3083
|
+
*/
|
|
3084
|
+
404: Error;
|
|
3085
|
+
/**
|
|
3086
|
+
* Too many requests for this API key or user (or, with failing
|
|
3087
|
+
* credentials, this IP address). A published-only key is counted per
|
|
3088
|
+
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
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.
|
|
3093
|
+
*
|
|
3094
|
+
*/
|
|
3095
|
+
429: Error;
|
|
3096
|
+
};
|
|
3097
|
+
export type RevisionsGetError = RevisionsGetErrors[keyof RevisionsGetErrors];
|
|
3098
|
+
export type RevisionsGetResponses = {
|
|
3099
|
+
/**
|
|
3100
|
+
* The revision with its snapshot and changes.
|
|
3101
|
+
*/
|
|
3102
|
+
200: RecordRevisionDetail;
|
|
3103
|
+
};
|
|
3104
|
+
export type RevisionsGetResponse = RevisionsGetResponses[keyof RevisionsGetResponses];
|
|
2945
3105
|
export type RecordRevisionsRevertData = {
|
|
2946
3106
|
body?: never;
|
|
2947
3107
|
headers?: {
|
|
@@ -3021,7 +3181,10 @@ export type RecordRevisionsRevertErrors = {
|
|
|
3021
3181
|
* Too many requests for this API key or user (or, with failing
|
|
3022
3182
|
* credentials, this IP address). A published-only key is counted per
|
|
3023
3183
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3024
|
-
* 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.
|
|
3025
3188
|
*
|
|
3026
3189
|
*/
|
|
3027
3190
|
429: Error;
|
|
@@ -3066,7 +3229,10 @@ export type RecordsDiffErrors = {
|
|
|
3066
3229
|
* Too many requests for this API key or user (or, with failing
|
|
3067
3230
|
* credentials, this IP address). A published-only key is counted per
|
|
3068
3231
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3069
|
-
* 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.
|
|
3070
3236
|
*
|
|
3071
3237
|
*/
|
|
3072
3238
|
429: Error;
|
|
@@ -3117,7 +3283,10 @@ export type RecordDraftsListErrors = {
|
|
|
3117
3283
|
* Too many requests for this API key or user (or, with failing
|
|
3118
3284
|
* credentials, this IP address). A published-only key is counted per
|
|
3119
3285
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3120
|
-
* 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.
|
|
3121
3290
|
*
|
|
3122
3291
|
*/
|
|
3123
3292
|
429: Error;
|
|
@@ -3183,7 +3352,10 @@ export type DraftsCreateErrors = {
|
|
|
3183
3352
|
* Too many requests for this API key or user (or, with failing
|
|
3184
3353
|
* credentials, this IP address). A published-only key is counted per
|
|
3185
3354
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3186
|
-
* 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.
|
|
3187
3359
|
*
|
|
3188
3360
|
*/
|
|
3189
3361
|
429: Error;
|
|
@@ -3238,7 +3410,10 @@ export type DraftsListErrors = {
|
|
|
3238
3410
|
* Too many requests for this API key or user (or, with failing
|
|
3239
3411
|
* credentials, this IP address). A published-only key is counted per
|
|
3240
3412
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3241
|
-
* 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.
|
|
3242
3417
|
*
|
|
3243
3418
|
*/
|
|
3244
3419
|
429: Error;
|
|
@@ -3310,7 +3485,10 @@ export type DraftsDiscardErrors = {
|
|
|
3310
3485
|
* Too many requests for this API key or user (or, with failing
|
|
3311
3486
|
* credentials, this IP address). A published-only key is counted per
|
|
3312
3487
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3313
|
-
* 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.
|
|
3314
3492
|
*
|
|
3315
3493
|
*/
|
|
3316
3494
|
429: Error;
|
|
@@ -3357,7 +3535,10 @@ export type DraftsGetErrors = {
|
|
|
3357
3535
|
* Too many requests for this API key or user (or, with failing
|
|
3358
3536
|
* credentials, this IP address). A published-only key is counted per
|
|
3359
3537
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3360
|
-
* 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.
|
|
3361
3542
|
*
|
|
3362
3543
|
*/
|
|
3363
3544
|
429: Error;
|
|
@@ -3433,7 +3614,10 @@ export type DraftsUpdateErrors = {
|
|
|
3433
3614
|
* Too many requests for this API key or user (or, with failing
|
|
3434
3615
|
* credentials, this IP address). A published-only key is counted per
|
|
3435
3616
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3436
|
-
* 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.
|
|
3437
3621
|
*
|
|
3438
3622
|
*/
|
|
3439
3623
|
429: Error;
|
|
@@ -3519,7 +3703,10 @@ export type DraftsMergeErrors = {
|
|
|
3519
3703
|
* Too many requests for this API key or user (or, with failing
|
|
3520
3704
|
* credentials, this IP address). A published-only key is counted per
|
|
3521
3705
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3522
|
-
* 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.
|
|
3523
3710
|
*
|
|
3524
3711
|
*/
|
|
3525
3712
|
429: Error;
|
|
@@ -3581,7 +3768,10 @@ export type DraftsUnscheduleErrors = {
|
|
|
3581
3768
|
* Too many requests for this API key or user (or, with failing
|
|
3582
3769
|
* credentials, this IP address). A published-only key is counted per
|
|
3583
3770
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3584
|
-
* 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.
|
|
3585
3775
|
*
|
|
3586
3776
|
*/
|
|
3587
3777
|
429: Error;
|
|
@@ -3647,7 +3837,10 @@ export type DraftsScheduleErrors = {
|
|
|
3647
3837
|
* Too many requests for this API key or user (or, with failing
|
|
3648
3838
|
* credentials, this IP address). A published-only key is counted per
|
|
3649
3839
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3650
|
-
* 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.
|
|
3651
3844
|
*
|
|
3652
3845
|
*/
|
|
3653
3846
|
429: Error;
|
|
@@ -3704,7 +3897,10 @@ export type CollectionsListErrors = {
|
|
|
3704
3897
|
* Too many requests for this API key or user (or, with failing
|
|
3705
3898
|
* credentials, this IP address). A published-only key is counted per
|
|
3706
3899
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3707
|
-
* 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.
|
|
3708
3904
|
*
|
|
3709
3905
|
*/
|
|
3710
3906
|
429: Error;
|
|
@@ -3786,7 +3982,10 @@ export type CollectionsCreateErrors = {
|
|
|
3786
3982
|
* Too many requests for this API key or user (or, with failing
|
|
3787
3983
|
* credentials, this IP address). A published-only key is counted per
|
|
3788
3984
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3789
|
-
* 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.
|
|
3790
3989
|
*
|
|
3791
3990
|
*/
|
|
3792
3991
|
429: Error;
|
|
@@ -3861,7 +4060,10 @@ export type CollectionsDeleteErrors = {
|
|
|
3861
4060
|
* Too many requests for this API key or user (or, with failing
|
|
3862
4061
|
* credentials, this IP address). A published-only key is counted per
|
|
3863
4062
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3864
|
-
* 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.
|
|
3865
4067
|
*
|
|
3866
4068
|
*/
|
|
3867
4069
|
429: Error;
|
|
@@ -3906,7 +4108,10 @@ export type CollectionsGetErrors = {
|
|
|
3906
4108
|
* Too many requests for this API key or user (or, with failing
|
|
3907
4109
|
* credentials, this IP address). A published-only key is counted per
|
|
3908
4110
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3909
|
-
* 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.
|
|
3910
4115
|
*
|
|
3911
4116
|
*/
|
|
3912
4117
|
429: Error;
|
|
@@ -3985,7 +4190,10 @@ export type CollectionsUpdateErrors = {
|
|
|
3985
4190
|
* Too many requests for this API key or user (or, with failing
|
|
3986
4191
|
* credentials, this IP address). A published-only key is counted per
|
|
3987
4192
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
3988
|
-
* 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.
|
|
3989
4197
|
*
|
|
3990
4198
|
*/
|
|
3991
4199
|
429: Error;
|
|
@@ -4070,7 +4278,10 @@ export type CollectionsRestoreErrors = {
|
|
|
4070
4278
|
* Too many requests for this API key or user (or, with failing
|
|
4071
4279
|
* credentials, this IP address). A published-only key is counted per
|
|
4072
4280
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4073
|
-
* 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.
|
|
4074
4285
|
*
|
|
4075
4286
|
*/
|
|
4076
4287
|
429: Error;
|
|
@@ -4120,7 +4331,10 @@ export type CollectionsGetSchemaErrors = {
|
|
|
4120
4331
|
* Too many requests for this API key or user (or, with failing
|
|
4121
4332
|
* credentials, this IP address). A published-only key is counted per
|
|
4122
4333
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4123
|
-
* 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.
|
|
4124
4338
|
*
|
|
4125
4339
|
*/
|
|
4126
4340
|
429: Error;
|
|
@@ -4174,7 +4388,10 @@ export type SchemaChangesListErrors = {
|
|
|
4174
4388
|
* Too many requests for this API key or user (or, with failing
|
|
4175
4389
|
* credentials, this IP address). A published-only key is counted per
|
|
4176
4390
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4177
|
-
* 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.
|
|
4178
4395
|
*
|
|
4179
4396
|
*/
|
|
4180
4397
|
429: Error;
|
|
@@ -4216,7 +4433,10 @@ export type SchemaChangesGetErrors = {
|
|
|
4216
4433
|
* Too many requests for this API key or user (or, with failing
|
|
4217
4434
|
* credentials, this IP address). A published-only key is counted per
|
|
4218
4435
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4219
|
-
* 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.
|
|
4220
4440
|
*
|
|
4221
4441
|
*/
|
|
4222
4442
|
429: Error;
|
|
@@ -4276,7 +4496,10 @@ export type FieldsListErrors = {
|
|
|
4276
4496
|
* Too many requests for this API key or user (or, with failing
|
|
4277
4497
|
* credentials, this IP address). A published-only key is counted per
|
|
4278
4498
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4279
|
-
* 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.
|
|
4280
4503
|
*
|
|
4281
4504
|
*/
|
|
4282
4505
|
429: Error;
|
|
@@ -4355,7 +4578,10 @@ export type FieldsCreateErrors = {
|
|
|
4355
4578
|
* Too many requests for this API key or user (or, with failing
|
|
4356
4579
|
* credentials, this IP address). A published-only key is counted per
|
|
4357
4580
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4358
|
-
* 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.
|
|
4359
4585
|
*
|
|
4360
4586
|
*/
|
|
4361
4587
|
429: Error;
|
|
@@ -4427,7 +4653,10 @@ export type FieldsDeleteErrors = {
|
|
|
4427
4653
|
* Too many requests for this API key or user (or, with failing
|
|
4428
4654
|
* credentials, this IP address). A published-only key is counted per
|
|
4429
4655
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4430
|
-
* 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.
|
|
4431
4660
|
*
|
|
4432
4661
|
*/
|
|
4433
4662
|
429: Error;
|
|
@@ -4469,7 +4698,10 @@ export type FieldsGetErrors = {
|
|
|
4469
4698
|
* Too many requests for this API key or user (or, with failing
|
|
4470
4699
|
* credentials, this IP address). A published-only key is counted per
|
|
4471
4700
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4472
|
-
* 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.
|
|
4473
4705
|
*
|
|
4474
4706
|
*/
|
|
4475
4707
|
429: Error;
|
|
@@ -4545,7 +4777,10 @@ export type FieldsUpdateErrors = {
|
|
|
4545
4777
|
* Too many requests for this API key or user (or, with failing
|
|
4546
4778
|
* credentials, this IP address). A published-only key is counted per
|
|
4547
4779
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4548
|
-
* 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.
|
|
4549
4784
|
*
|
|
4550
4785
|
*/
|
|
4551
4786
|
429: Error;
|
|
@@ -4590,7 +4825,10 @@ export type FieldsGetOrderErrors = {
|
|
|
4590
4825
|
* Too many requests for this API key or user (or, with failing
|
|
4591
4826
|
* credentials, this IP address). A published-only key is counted per
|
|
4592
4827
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4593
|
-
* 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.
|
|
4594
4832
|
*
|
|
4595
4833
|
*/
|
|
4596
4834
|
429: Error;
|
|
@@ -4671,7 +4909,10 @@ export type FieldsReorderErrors = {
|
|
|
4671
4909
|
* Too many requests for this API key or user (or, with failing
|
|
4672
4910
|
* credentials, this IP address). A published-only key is counted per
|
|
4673
4911
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4674
|
-
* 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.
|
|
4675
4916
|
*
|
|
4676
4917
|
*/
|
|
4677
4918
|
429: Error;
|
|
@@ -4737,7 +4978,10 @@ export type FieldsRemoveAliasErrors = {
|
|
|
4737
4978
|
* Too many requests for this API key or user (or, with failing
|
|
4738
4979
|
* credentials, this IP address). A published-only key is counted per
|
|
4739
4980
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4740
|
-
* 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.
|
|
4741
4985
|
*
|
|
4742
4986
|
*/
|
|
4743
4987
|
429: Error;
|
|
@@ -4813,7 +5057,10 @@ export type FieldsRestoreErrors = {
|
|
|
4813
5057
|
* Too many requests for this API key or user (or, with failing
|
|
4814
5058
|
* credentials, this IP address). A published-only key is counted per
|
|
4815
5059
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4816
|
-
* 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.
|
|
4817
5064
|
*
|
|
4818
5065
|
*/
|
|
4819
5066
|
429: Error;
|
|
@@ -4867,7 +5114,10 @@ export type MigrationsListErrors = {
|
|
|
4867
5114
|
* Too many requests for this API key or user (or, with failing
|
|
4868
5115
|
* credentials, this IP address). A published-only key is counted per
|
|
4869
5116
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4870
|
-
* 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.
|
|
4871
5121
|
*
|
|
4872
5122
|
*/
|
|
4873
5123
|
429: Error;
|
|
@@ -4948,7 +5198,10 @@ export type MigrationsCreateErrors = {
|
|
|
4948
5198
|
* Too many requests for this API key or user (or, with failing
|
|
4949
5199
|
* credentials, this IP address). A published-only key is counted per
|
|
4950
5200
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4951
|
-
* 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.
|
|
4952
5205
|
*
|
|
4953
5206
|
*/
|
|
4954
5207
|
429: Error;
|
|
@@ -4994,7 +5247,10 @@ export type MigrationsGetErrors = {
|
|
|
4994
5247
|
* Too many requests for this API key or user (or, with failing
|
|
4995
5248
|
* credentials, this IP address). A published-only key is counted per
|
|
4996
5249
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
4997
|
-
* 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.
|
|
4998
5254
|
*
|
|
4999
5255
|
*/
|
|
5000
5256
|
429: Error;
|
|
@@ -5056,7 +5312,10 @@ export type MigrationsCancelErrors = {
|
|
|
5056
5312
|
* Too many requests for this API key or user (or, with failing
|
|
5057
5313
|
* credentials, this IP address). A published-only key is counted per
|
|
5058
5314
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5059
|
-
* 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.
|
|
5060
5319
|
*
|
|
5061
5320
|
*/
|
|
5062
5321
|
429: Error;
|
|
@@ -5075,6 +5334,13 @@ export type AssetsListData = {
|
|
|
5075
5334
|
project_id: string;
|
|
5076
5335
|
};
|
|
5077
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;
|
|
5078
5344
|
/**
|
|
5079
5345
|
* Page size.
|
|
5080
5346
|
*/
|
|
@@ -5089,10 +5355,22 @@ export type AssetsListData = {
|
|
|
5089
5355
|
* `type*` wildcard, or several with
|
|
5090
5356
|
* `filter[content_type][in]=image*,application/pdf`, for example the
|
|
5091
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.
|
|
5092
5364
|
*
|
|
5093
5365
|
*/
|
|
5094
5366
|
filter?: {
|
|
5095
5367
|
deleted?: 'true' | 'false';
|
|
5368
|
+
kind?: AssetKind | {
|
|
5369
|
+
/**
|
|
5370
|
+
* Comma-separated kinds.
|
|
5371
|
+
*/
|
|
5372
|
+
in: string;
|
|
5373
|
+
};
|
|
5096
5374
|
content_type?: string | {
|
|
5097
5375
|
/**
|
|
5098
5376
|
* Up to 50 comma-separated MIME types or `type*` wildcards.
|
|
@@ -5124,7 +5402,10 @@ export type AssetsListErrors = {
|
|
|
5124
5402
|
* Too many requests for this API key or user (or, with failing
|
|
5125
5403
|
* credentials, this IP address). A published-only key is counted per
|
|
5126
5404
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5127
|
-
* 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.
|
|
5128
5409
|
*
|
|
5129
5410
|
*/
|
|
5130
5411
|
429: Error;
|
|
@@ -5196,7 +5477,10 @@ export type AssetsUploadErrors = {
|
|
|
5196
5477
|
* Too many requests for this API key or user (or, with failing
|
|
5197
5478
|
* credentials, this IP address). A published-only key is counted per
|
|
5198
5479
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5199
|
-
* 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.
|
|
5200
5484
|
*
|
|
5201
5485
|
*/
|
|
5202
5486
|
429: Error;
|
|
@@ -5262,7 +5546,10 @@ export type AssetsCompleteErrors = {
|
|
|
5262
5546
|
* Too many requests for this API key or user (or, with failing
|
|
5263
5547
|
* credentials, this IP address). A published-only key is counted per
|
|
5264
5548
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5265
|
-
* 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.
|
|
5266
5553
|
*
|
|
5267
5554
|
*/
|
|
5268
5555
|
429: Error;
|
|
@@ -5324,7 +5611,10 @@ export type AssetsDeleteErrors = {
|
|
|
5324
5611
|
* Too many requests for this API key or user (or, with failing
|
|
5325
5612
|
* credentials, this IP address). A published-only key is counted per
|
|
5326
5613
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5327
|
-
* 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.
|
|
5328
5618
|
*
|
|
5329
5619
|
*/
|
|
5330
5620
|
429: Error;
|
|
@@ -5366,7 +5656,10 @@ export type AssetsGetErrors = {
|
|
|
5366
5656
|
* Too many requests for this API key or user (or, with failing
|
|
5367
5657
|
* credentials, this IP address). A published-only key is counted per
|
|
5368
5658
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5369
|
-
* 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.
|
|
5370
5663
|
*
|
|
5371
5664
|
*/
|
|
5372
5665
|
429: Error;
|
|
@@ -5379,24 +5672,31 @@ export type AssetsGetResponses = {
|
|
|
5379
5672
|
200: Asset;
|
|
5380
5673
|
};
|
|
5381
5674
|
export type AssetsGetResponse = AssetsGetResponses[keyof AssetsGetResponses];
|
|
5382
|
-
export type
|
|
5383
|
-
body
|
|
5384
|
-
|
|
5385
|
-
|
|
5386
|
-
|
|
5387
|
-
|
|
5388
|
-
|
|
5389
|
-
|
|
5675
|
+
export type AssetsUpdateData = {
|
|
5676
|
+
body: AssetUpdate;
|
|
5677
|
+
headers?: {
|
|
5678
|
+
/**
|
|
5679
|
+
* A unique value (1-255 printable ASCII characters) that makes retrying
|
|
5680
|
+
* this request safe. The first response (below 500) is stored for 24
|
|
5681
|
+
* hours per user or API key; retries with the same key and the same
|
|
5682
|
+
* request get it again with an `Idempotent-Replayed: true` header. The
|
|
5683
|
+
* same key with a different request is refused with `400`; a retry while
|
|
5684
|
+
* the first request is still running gets `409`.
|
|
5685
|
+
*
|
|
5686
|
+
*/
|
|
5687
|
+
'Idempotency-Key'?: string;
|
|
5390
5688
|
/**
|
|
5391
|
-
*
|
|
5689
|
+
* First-party client identifier recorded in history (e.g. `cli/0.3.1`). Informational only.
|
|
5392
5690
|
*/
|
|
5393
|
-
|
|
5394
|
-
format?: 'original' | 'webp' | 'avif' | 'jpeg' | 'png';
|
|
5395
|
-
quality?: number;
|
|
5691
|
+
'Nohead-Client'?: string;
|
|
5396
5692
|
};
|
|
5397
|
-
|
|
5693
|
+
path: {
|
|
5694
|
+
asset_id: string;
|
|
5695
|
+
};
|
|
5696
|
+
query?: never;
|
|
5697
|
+
url: '/v1/assets/{asset_id}';
|
|
5398
5698
|
};
|
|
5399
|
-
export type
|
|
5699
|
+
export type AssetsUpdateErrors = {
|
|
5400
5700
|
/**
|
|
5401
5701
|
* 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).
|
|
5402
5702
|
*/
|
|
@@ -5425,23 +5725,22 @@ export type AssetsImageUrlErrors = {
|
|
|
5425
5725
|
* Too many requests for this API key or user (or, with failing
|
|
5426
5726
|
* credentials, this IP address). A published-only key is counted per
|
|
5427
5727
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5428
|
-
* 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.
|
|
5429
5732
|
*
|
|
5430
5733
|
*/
|
|
5431
5734
|
429: Error;
|
|
5432
|
-
/**
|
|
5433
|
-
* The service is temporarily unavailable.
|
|
5434
|
-
*/
|
|
5435
|
-
503: Error;
|
|
5436
5735
|
};
|
|
5437
|
-
export type
|
|
5438
|
-
export type
|
|
5736
|
+
export type AssetsUpdateError = AssetsUpdateErrors[keyof AssetsUpdateErrors];
|
|
5737
|
+
export type AssetsUpdateResponses = {
|
|
5439
5738
|
/**
|
|
5440
|
-
* The
|
|
5739
|
+
* The asset.
|
|
5441
5740
|
*/
|
|
5442
|
-
200:
|
|
5741
|
+
200: Asset;
|
|
5443
5742
|
};
|
|
5444
|
-
export type
|
|
5743
|
+
export type AssetsUpdateResponse = AssetsUpdateResponses[keyof AssetsUpdateResponses];
|
|
5445
5744
|
export type AssetsDownloadUrlData = {
|
|
5446
5745
|
body?: never;
|
|
5447
5746
|
path: {
|
|
@@ -5475,7 +5774,10 @@ export type AssetsDownloadUrlErrors = {
|
|
|
5475
5774
|
* Too many requests for this API key or user (or, with failing
|
|
5476
5775
|
* credentials, this IP address). A published-only key is counted per
|
|
5477
5776
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5478
|
-
* 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.
|
|
5479
5781
|
*
|
|
5480
5782
|
*/
|
|
5481
5783
|
429: Error;
|
|
@@ -5517,7 +5819,10 @@ export type AssetsUsageErrors = {
|
|
|
5517
5819
|
* Too many requests for this API key or user (or, with failing
|
|
5518
5820
|
* credentials, this IP address). A published-only key is counted per
|
|
5519
5821
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5520
|
-
* 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.
|
|
5521
5826
|
*
|
|
5522
5827
|
*/
|
|
5523
5828
|
429: Error;
|
|
@@ -5579,7 +5884,10 @@ export type AssetsRestoreErrors = {
|
|
|
5579
5884
|
* Too many requests for this API key or user (or, with failing
|
|
5580
5885
|
* credentials, this IP address). A published-only key is counted per
|
|
5581
5886
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5582
|
-
* 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.
|
|
5583
5891
|
*
|
|
5584
5892
|
*/
|
|
5585
5893
|
429: Error;
|
|
@@ -5641,7 +5949,10 @@ export type AssetsPurgeErrors = {
|
|
|
5641
5949
|
* Too many requests for this API key or user (or, with failing
|
|
5642
5950
|
* credentials, this IP address). A published-only key is counted per
|
|
5643
5951
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5644
|
-
* 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.
|
|
5645
5956
|
*
|
|
5646
5957
|
*/
|
|
5647
5958
|
429: Error;
|
|
@@ -5738,7 +6049,10 @@ export type CollectionsSearchErrors = {
|
|
|
5738
6049
|
* Too many requests for this API key or user (or, with failing
|
|
5739
6050
|
* credentials, this IP address). A published-only key is counted per
|
|
5740
6051
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5741
|
-
* 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.
|
|
5742
6056
|
*
|
|
5743
6057
|
*/
|
|
5744
6058
|
429: Error;
|
|
@@ -5810,7 +6124,10 @@ export type ProjectsSearchErrors = {
|
|
|
5810
6124
|
* Too many requests for this API key or user (or, with failing
|
|
5811
6125
|
* credentials, this IP address). A published-only key is counted per
|
|
5812
6126
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5813
|
-
* 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.
|
|
5814
6131
|
*
|
|
5815
6132
|
*/
|
|
5816
6133
|
429: Error;
|
|
@@ -5859,7 +6176,10 @@ export type SearchIndexGetErrors = {
|
|
|
5859
6176
|
* Too many requests for this API key or user (or, with failing
|
|
5860
6177
|
* credentials, this IP address). A published-only key is counted per
|
|
5861
6178
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5862
|
-
* 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.
|
|
5863
6183
|
*
|
|
5864
6184
|
*/
|
|
5865
6185
|
429: Error;
|
|
@@ -5924,7 +6244,10 @@ export type SearchIndexRebuildErrors = {
|
|
|
5924
6244
|
* Too many requests for this API key or user (or, with failing
|
|
5925
6245
|
* credentials, this IP address). A published-only key is counted per
|
|
5926
6246
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5927
|
-
* 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.
|
|
5928
6251
|
*
|
|
5929
6252
|
*/
|
|
5930
6253
|
429: Error;
|
|
@@ -5981,7 +6304,10 @@ export type WebhooksListErrors = {
|
|
|
5981
6304
|
* Too many requests for this API key or user (or, with failing
|
|
5982
6305
|
* credentials, this IP address). A published-only key is counted per
|
|
5983
6306
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
5984
|
-
* 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.
|
|
5985
6311
|
*
|
|
5986
6312
|
*/
|
|
5987
6313
|
429: Error;
|
|
@@ -6053,7 +6379,10 @@ export type WebhooksCreateErrors = {
|
|
|
6053
6379
|
* Too many requests for this API key or user (or, with failing
|
|
6054
6380
|
* credentials, this IP address). A published-only key is counted per
|
|
6055
6381
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6056
|
-
* 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.
|
|
6057
6386
|
*
|
|
6058
6387
|
*/
|
|
6059
6388
|
429: Error;
|
|
@@ -6115,7 +6444,10 @@ export type WebhooksDeleteErrors = {
|
|
|
6115
6444
|
* Too many requests for this API key or user (or, with failing
|
|
6116
6445
|
* credentials, this IP address). A published-only key is counted per
|
|
6117
6446
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6118
|
-
* 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.
|
|
6119
6451
|
*
|
|
6120
6452
|
*/
|
|
6121
6453
|
429: Error;
|
|
@@ -6157,7 +6489,10 @@ export type WebhooksGetErrors = {
|
|
|
6157
6489
|
* Too many requests for this API key or user (or, with failing
|
|
6158
6490
|
* credentials, this IP address). A published-only key is counted per
|
|
6159
6491
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6160
|
-
* 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.
|
|
6161
6496
|
*
|
|
6162
6497
|
*/
|
|
6163
6498
|
429: Error;
|
|
@@ -6223,7 +6558,10 @@ export type WebhooksUpdateErrors = {
|
|
|
6223
6558
|
* Too many requests for this API key or user (or, with failing
|
|
6224
6559
|
* credentials, this IP address). A published-only key is counted per
|
|
6225
6560
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6226
|
-
* 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.
|
|
6227
6565
|
*
|
|
6228
6566
|
*/
|
|
6229
6567
|
429: Error;
|
|
@@ -6285,7 +6623,10 @@ export type WebhooksTestErrors = {
|
|
|
6285
6623
|
* Too many requests for this API key or user (or, with failing
|
|
6286
6624
|
* credentials, this IP address). A published-only key is counted per
|
|
6287
6625
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6288
|
-
* 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.
|
|
6289
6630
|
*
|
|
6290
6631
|
*/
|
|
6291
6632
|
429: Error;
|
|
@@ -6336,7 +6677,10 @@ export type WebhookSecretsListErrors = {
|
|
|
6336
6677
|
* Too many requests for this API key or user (or, with failing
|
|
6337
6678
|
* credentials, this IP address). A published-only key is counted per
|
|
6338
6679
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6339
|
-
* 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.
|
|
6340
6684
|
*
|
|
6341
6685
|
*/
|
|
6342
6686
|
429: Error;
|
|
@@ -6398,7 +6742,10 @@ export type WebhooksRotateSecretErrors = {
|
|
|
6398
6742
|
* Too many requests for this API key or user (or, with failing
|
|
6399
6743
|
* credentials, this IP address). A published-only key is counted per
|
|
6400
6744
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6401
|
-
* 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.
|
|
6402
6749
|
*
|
|
6403
6750
|
*/
|
|
6404
6751
|
429: Error;
|
|
@@ -6460,7 +6807,10 @@ export type WebhookSecretsRetireErrors = {
|
|
|
6460
6807
|
* Too many requests for this API key or user (or, with failing
|
|
6461
6808
|
* credentials, this IP address). A published-only key is counted per
|
|
6462
6809
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6463
|
-
* 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.
|
|
6464
6814
|
*
|
|
6465
6815
|
*/
|
|
6466
6816
|
429: Error;
|
|
@@ -6528,7 +6878,10 @@ export type WebhooksRestoreErrors = {
|
|
|
6528
6878
|
* Too many requests for this API key or user (or, with failing
|
|
6529
6879
|
* credentials, this IP address). A published-only key is counted per
|
|
6530
6880
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6531
|
-
* 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.
|
|
6532
6885
|
*
|
|
6533
6886
|
*/
|
|
6534
6887
|
429: Error;
|
|
@@ -6582,7 +6935,10 @@ export type WebhookDeliveriesListErrors = {
|
|
|
6582
6935
|
* Too many requests for this API key or user (or, with failing
|
|
6583
6936
|
* credentials, this IP address). A published-only key is counted per
|
|
6584
6937
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6585
|
-
* 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.
|
|
6586
6942
|
*
|
|
6587
6943
|
*/
|
|
6588
6944
|
429: Error;
|
|
@@ -6624,7 +6980,10 @@ export type WebhookDeliveriesGetErrors = {
|
|
|
6624
6980
|
* Too many requests for this API key or user (or, with failing
|
|
6625
6981
|
* credentials, this IP address). A published-only key is counted per
|
|
6626
6982
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6627
|
-
* 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.
|
|
6628
6987
|
*
|
|
6629
6988
|
*/
|
|
6630
6989
|
429: Error;
|
|
@@ -6686,7 +7045,10 @@ export type WebhookDeliveriesRetryErrors = {
|
|
|
6686
7045
|
* Too many requests for this API key or user (or, with failing
|
|
6687
7046
|
* credentials, this IP address). A published-only key is counted per
|
|
6688
7047
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6689
|
-
* 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.
|
|
6690
7052
|
*
|
|
6691
7053
|
*/
|
|
6692
7054
|
429: Error;
|
|
@@ -6761,7 +7123,10 @@ export type AuditEventsListErrors = {
|
|
|
6761
7123
|
* Too many requests for this API key or user (or, with failing
|
|
6762
7124
|
* credentials, this IP address). A published-only key is counted per
|
|
6763
7125
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6764
|
-
* 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.
|
|
6765
7130
|
*
|
|
6766
7131
|
*/
|
|
6767
7132
|
429: Error;
|
|
@@ -6809,7 +7174,10 @@ export type MeGetErrors = {
|
|
|
6809
7174
|
* Too many requests for this API key or user (or, with failing
|
|
6810
7175
|
* credentials, this IP address). A published-only key is counted per
|
|
6811
7176
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6812
|
-
* 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.
|
|
6813
7181
|
*
|
|
6814
7182
|
*/
|
|
6815
7183
|
429: Error;
|
|
@@ -6845,7 +7213,10 @@ export type FeatureFlagsListErrors = {
|
|
|
6845
7213
|
* Too many requests for this API key or user (or, with failing
|
|
6846
7214
|
* credentials, this IP address). A published-only key is counted per
|
|
6847
7215
|
* client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
|
|
6848
|
-
* 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.
|
|
6849
7220
|
*
|
|
6850
7221
|
*/
|
|
6851
7222
|
429: Error;
|