@nohead/sdk 0.3.0 → 0.5.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 +36 -0
- package/README.md +11 -7
- package/dist/core.js +5 -0
- package/dist/generated/operations.gen.d.ts +9 -9
- package/dist/generated/operations.gen.js +2 -2
- package/dist/generated/schemas.gen.d.ts +1 -1
- package/dist/generated/types.gen.d.ts +585 -208
- package/dist/resources/assets.d.ts +1 -1
- package/dist/resources/assets.js +9 -2
- package/dist/resources/drafts.d.ts +3 -4
- package/dist/resources/drafts.js +4 -15
- package/dist/resources/schema.d.ts +11 -10
- package/dist/resources/schema.js +6 -8
- package/dist/types.d.ts +7 -7
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -43,7 +43,80 @@ export type RecordFilterValue = string | {
|
|
|
43
43
|
exists?: 'true' | 'false';
|
|
44
44
|
};
|
|
45
45
|
export type FieldType = 'text' | 'long_text' | 'rich_text' | 'integer' | 'decimal' | 'date' | 'boolean' | 'enum' | 'asset' | 'relation' | 'json';
|
|
46
|
-
|
|
46
|
+
/**
|
|
47
|
+
* A field, typed by its `type`, which also decides the options its `configuration` takes.
|
|
48
|
+
*/
|
|
49
|
+
export type Field = ({
|
|
50
|
+
type: 'text';
|
|
51
|
+
} & TextField) | ({
|
|
52
|
+
type: 'long_text';
|
|
53
|
+
} & LongTextField) | ({
|
|
54
|
+
type: 'rich_text';
|
|
55
|
+
} & RichTextField) | ({
|
|
56
|
+
type: 'integer';
|
|
57
|
+
} & IntegerField) | ({
|
|
58
|
+
type: 'decimal';
|
|
59
|
+
} & DecimalField) | ({
|
|
60
|
+
type: 'date';
|
|
61
|
+
} & DateField) | ({
|
|
62
|
+
type: 'boolean';
|
|
63
|
+
} & BooleanField) | ({
|
|
64
|
+
type: 'enum';
|
|
65
|
+
} & EnumField) | ({
|
|
66
|
+
type: 'asset';
|
|
67
|
+
} & AssetField) | ({
|
|
68
|
+
type: 'relation';
|
|
69
|
+
} & RelationField) | ({
|
|
70
|
+
type: 'json';
|
|
71
|
+
} & JsonField);
|
|
72
|
+
export type TextField = FieldProperties & {
|
|
73
|
+
type: 'text';
|
|
74
|
+
configuration: TextFieldConfiguration;
|
|
75
|
+
};
|
|
76
|
+
export type LongTextField = FieldProperties & {
|
|
77
|
+
type: 'long_text';
|
|
78
|
+
configuration: LongTextFieldConfiguration;
|
|
79
|
+
};
|
|
80
|
+
export type RichTextField = FieldProperties & {
|
|
81
|
+
type: 'rich_text';
|
|
82
|
+
configuration: RichTextFieldConfiguration;
|
|
83
|
+
};
|
|
84
|
+
export type IntegerField = FieldProperties & {
|
|
85
|
+
type: 'integer';
|
|
86
|
+
configuration: IntegerFieldConfiguration;
|
|
87
|
+
};
|
|
88
|
+
export type DecimalField = FieldProperties & {
|
|
89
|
+
type: 'decimal';
|
|
90
|
+
configuration: DecimalFieldConfiguration;
|
|
91
|
+
};
|
|
92
|
+
export type DateField = FieldProperties & {
|
|
93
|
+
type: 'date';
|
|
94
|
+
configuration: DateFieldConfiguration;
|
|
95
|
+
};
|
|
96
|
+
export type BooleanField = FieldProperties & {
|
|
97
|
+
type: 'boolean';
|
|
98
|
+
configuration: BooleanFieldConfiguration;
|
|
99
|
+
};
|
|
100
|
+
export type EnumField = FieldProperties & {
|
|
101
|
+
type: 'enum';
|
|
102
|
+
configuration: EnumFieldConfiguration;
|
|
103
|
+
};
|
|
104
|
+
export type AssetField = FieldProperties & {
|
|
105
|
+
type: 'asset';
|
|
106
|
+
configuration: AssetFieldConfiguration;
|
|
107
|
+
};
|
|
108
|
+
export type RelationField = FieldProperties & {
|
|
109
|
+
type: 'relation';
|
|
110
|
+
configuration: RelationFieldConfiguration;
|
|
111
|
+
};
|
|
112
|
+
export type JsonField = FieldProperties & {
|
|
113
|
+
type: 'json';
|
|
114
|
+
configuration: JsonFieldConfiguration;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* What every field has; `Field` adds its `type` and that type's `configuration`.
|
|
118
|
+
*/
|
|
119
|
+
export type FieldProperties = {
|
|
47
120
|
/**
|
|
48
121
|
* Stable field ID. Never changes, even when the field is renamed.
|
|
49
122
|
*/
|
|
@@ -57,8 +130,7 @@ export type Field = {
|
|
|
57
130
|
/**
|
|
58
131
|
* Key used in record data. Part of the API contract.
|
|
59
132
|
*/
|
|
60
|
-
|
|
61
|
-
type: FieldType;
|
|
133
|
+
key: string;
|
|
62
134
|
/**
|
|
63
135
|
* Every record must have a value. Not available for boolean fields (a boolean is true or false; no value reads as false).
|
|
64
136
|
*/
|
|
@@ -71,47 +143,6 @@ export type Field = {
|
|
|
71
143
|
* Where the field sorts in the collection's order, lowest first. New fields are added last; `PUT /v1/collections/{collection_id}/field-order` changes the order, numbering the fields from 0.
|
|
72
144
|
*/
|
|
73
145
|
position: number;
|
|
74
|
-
/**
|
|
75
|
-
* Type-specific options, e.g. `max_length`, `options`, `target_collection_id`,
|
|
76
|
-
* `accepted_types` (asset fields: MIME types or `type*` wildcards that newly
|
|
77
|
-
* written values must have; any file when absent), `include_time` and
|
|
78
|
-
* `time_zone` (date fields, below), `format` (text fields, below),
|
|
79
|
-
* `unique` (text and integer fields, below), plus
|
|
80
|
-
* the options for searches with API keys: `searchable` (the search words match the
|
|
81
|
-
* field; default true for text, long_text, rich_text and enum), `filterable` and
|
|
82
|
-
* `sortable` (default false).
|
|
83
|
-
*
|
|
84
|
-
* Date fields hold a calendar date, `YYYY-MM-DD`, with no time and no
|
|
85
|
-
* time zone: returned exactly as written, so it never shows as the day
|
|
86
|
-
* before or after. With `include_time: true` they hold a moment: ISO
|
|
87
|
-
* 8601 with an offset, stored in UTC and returned in UTC, or with the
|
|
88
|
-
* offset of `time_zone` (an IANA name such as `Europe/Copenhagen`,
|
|
89
|
-
* daylight saving included) when the field has one. Input may use any
|
|
90
|
-
* offset. Changing `time_zone` never rewrites values; turning
|
|
91
|
-
* `include_time` on or off does, through a field migration.
|
|
92
|
-
*
|
|
93
|
-
* Text fields (not long text) can have a `format`: `slug`
|
|
94
|
-
* (lowercase letters, digits and single hyphens, at most 200
|
|
95
|
-
* characters; one value per record, never a list, and always
|
|
96
|
-
* unique: a slug field has `unique: true`), `url` (an absolute
|
|
97
|
-
* `http` or `https` address) or `email`. A value that doesn't match is
|
|
98
|
-
* refused with `invalid_format`. A format sets its own length limits
|
|
99
|
-
* (254 characters for emails, 2,048 for URLs), so `min_length` and
|
|
100
|
-
* `max_length` are for plain text. Text and integer
|
|
101
|
-
* fields with one value can be `unique`: no two active records of the
|
|
102
|
-
* collection share a value (emails compare ignoring capitals; records
|
|
103
|
-
* without a value don't count). A taken value is refused with
|
|
104
|
-
* `taken` and the `record_id` that has it. Turning `unique` on is
|
|
105
|
-
* refused with `duplicate_values` while records share a value (and
|
|
106
|
-
* so is restoring a deleted unique field, `409`). A field migration
|
|
107
|
-
* to a unique field is refused with `duplicate_values` when its
|
|
108
|
-
* converted values or backfill would be shared, and fails if values
|
|
109
|
-
* written while it waits would be.
|
|
110
|
-
*
|
|
111
|
-
*/
|
|
112
|
-
configuration: {
|
|
113
|
-
[key: string]: unknown;
|
|
114
|
-
};
|
|
115
146
|
/**
|
|
116
147
|
* When the field was deleted; null unless it is. Its values stay hidden in records until it is restored or purged.
|
|
117
148
|
*/
|
|
@@ -121,31 +152,383 @@ export type Field = {
|
|
|
121
152
|
*/
|
|
122
153
|
purge_after: NullableTimestamp;
|
|
123
154
|
/**
|
|
124
|
-
* Old
|
|
155
|
+
* Old keys of a renamed field that still work until `expires_at`:
|
|
125
156
|
* record data also carries the value under them, and writes, filters,
|
|
126
157
|
* sorts and `expand` accept them. Responses about the collection then
|
|
127
158
|
* have `Deprecation` and `Sunset` headers.
|
|
128
159
|
*
|
|
129
160
|
*/
|
|
130
161
|
aliases: Array<{
|
|
131
|
-
|
|
162
|
+
key: string;
|
|
132
163
|
expires_at: Timestamp;
|
|
133
164
|
}>;
|
|
134
165
|
created_at: Timestamp;
|
|
135
166
|
updated_at: Timestamp;
|
|
136
167
|
};
|
|
168
|
+
/**
|
|
169
|
+
* Plain text up to 10,000 characters, or a `format`.
|
|
170
|
+
*/
|
|
171
|
+
export type TextFieldConfiguration = {
|
|
172
|
+
/**
|
|
173
|
+
* Help text for editors.
|
|
174
|
+
*/
|
|
175
|
+
description?: string;
|
|
176
|
+
/**
|
|
177
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
178
|
+
*/
|
|
179
|
+
searchable?: boolean;
|
|
180
|
+
/**
|
|
181
|
+
* API searches can filter on it. Default false.
|
|
182
|
+
*/
|
|
183
|
+
filterable?: boolean;
|
|
184
|
+
/**
|
|
185
|
+
* API searches can sort on it (one value only). Default false.
|
|
186
|
+
*/
|
|
187
|
+
sortable?: boolean;
|
|
188
|
+
min_length?: number;
|
|
189
|
+
max_length?: number;
|
|
190
|
+
/**
|
|
191
|
+
* `slug` (always unique, one value), `url` (absolute http or https) or `email`; each sets its own length limits.
|
|
192
|
+
*/
|
|
193
|
+
format?: 'slug' | 'url' | 'email';
|
|
194
|
+
/**
|
|
195
|
+
* No two active records of the collection share a value (one value only; a slug is always unique).
|
|
196
|
+
*/
|
|
197
|
+
unique?: boolean;
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* Text up to 100,000 characters.
|
|
201
|
+
*/
|
|
202
|
+
export type LongTextFieldConfiguration = {
|
|
203
|
+
/**
|
|
204
|
+
* Help text for editors.
|
|
205
|
+
*/
|
|
206
|
+
description?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
209
|
+
*/
|
|
210
|
+
searchable?: boolean;
|
|
211
|
+
/**
|
|
212
|
+
* API searches can filter on it. Default false.
|
|
213
|
+
*/
|
|
214
|
+
filterable?: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* API searches can sort on it (one value only). Default false.
|
|
217
|
+
*/
|
|
218
|
+
sortable?: boolean;
|
|
219
|
+
min_length?: number;
|
|
220
|
+
max_length?: number;
|
|
221
|
+
};
|
|
222
|
+
export type RichTextFieldConfiguration = {
|
|
223
|
+
/**
|
|
224
|
+
* Help text for editors.
|
|
225
|
+
*/
|
|
226
|
+
description?: string;
|
|
227
|
+
/**
|
|
228
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
229
|
+
*/
|
|
230
|
+
searchable?: boolean;
|
|
231
|
+
/**
|
|
232
|
+
* API searches can filter on it. Default false.
|
|
233
|
+
*/
|
|
234
|
+
filterable?: boolean;
|
|
235
|
+
/**
|
|
236
|
+
* API searches can sort on it (one value only). Default false.
|
|
237
|
+
*/
|
|
238
|
+
sortable?: boolean;
|
|
239
|
+
};
|
|
240
|
+
export type IntegerFieldConfiguration = {
|
|
241
|
+
/**
|
|
242
|
+
* Help text for editors.
|
|
243
|
+
*/
|
|
244
|
+
description?: string;
|
|
245
|
+
/**
|
|
246
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
247
|
+
*/
|
|
248
|
+
searchable?: boolean;
|
|
249
|
+
/**
|
|
250
|
+
* API searches can filter on it. Default false.
|
|
251
|
+
*/
|
|
252
|
+
filterable?: boolean;
|
|
253
|
+
/**
|
|
254
|
+
* API searches can sort on it (one value only). Default false.
|
|
255
|
+
*/
|
|
256
|
+
sortable?: boolean;
|
|
257
|
+
min?: number;
|
|
258
|
+
max?: number;
|
|
259
|
+
/**
|
|
260
|
+
* No two active records of the collection share a value (one value only).
|
|
261
|
+
*/
|
|
262
|
+
unique?: boolean;
|
|
263
|
+
};
|
|
264
|
+
export type DecimalFieldConfiguration = {
|
|
265
|
+
/**
|
|
266
|
+
* Help text for editors.
|
|
267
|
+
*/
|
|
268
|
+
description?: string;
|
|
269
|
+
/**
|
|
270
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
271
|
+
*/
|
|
272
|
+
searchable?: boolean;
|
|
273
|
+
/**
|
|
274
|
+
* API searches can filter on it. Default false.
|
|
275
|
+
*/
|
|
276
|
+
filterable?: boolean;
|
|
277
|
+
/**
|
|
278
|
+
* API searches can sort on it (one value only). Default false.
|
|
279
|
+
*/
|
|
280
|
+
sortable?: boolean;
|
|
281
|
+
min?: number;
|
|
282
|
+
max?: number;
|
|
283
|
+
};
|
|
284
|
+
export type DateFieldConfiguration = {
|
|
285
|
+
/**
|
|
286
|
+
* Help text for editors.
|
|
287
|
+
*/
|
|
288
|
+
description?: string;
|
|
289
|
+
/**
|
|
290
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
291
|
+
*/
|
|
292
|
+
searchable?: boolean;
|
|
293
|
+
/**
|
|
294
|
+
* API searches can filter on it. Default false.
|
|
295
|
+
*/
|
|
296
|
+
filterable?: boolean;
|
|
297
|
+
/**
|
|
298
|
+
* API searches can sort on it (one value only). Default false.
|
|
299
|
+
*/
|
|
300
|
+
sortable?: boolean;
|
|
301
|
+
/**
|
|
302
|
+
* Holds a moment (ISO 8601 with an offset) instead of a calendar date; changing it is a field migration.
|
|
303
|
+
*/
|
|
304
|
+
include_time?: boolean;
|
|
305
|
+
/**
|
|
306
|
+
* An IANA time zone (`Europe/Copenhagen`) moments are returned in; changing it never rewrites values.
|
|
307
|
+
*/
|
|
308
|
+
time_zone?: string;
|
|
309
|
+
};
|
|
310
|
+
export type BooleanFieldConfiguration = {
|
|
311
|
+
/**
|
|
312
|
+
* Help text for editors.
|
|
313
|
+
*/
|
|
314
|
+
description?: string;
|
|
315
|
+
/**
|
|
316
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
317
|
+
*/
|
|
318
|
+
searchable?: boolean;
|
|
319
|
+
/**
|
|
320
|
+
* API searches can filter on it. Default false.
|
|
321
|
+
*/
|
|
322
|
+
filterable?: boolean;
|
|
323
|
+
/**
|
|
324
|
+
* API searches can sort on it (one value only). Default false.
|
|
325
|
+
*/
|
|
326
|
+
sortable?: boolean;
|
|
327
|
+
};
|
|
328
|
+
export type EnumFieldConfiguration = {
|
|
329
|
+
/**
|
|
330
|
+
* Help text for editors.
|
|
331
|
+
*/
|
|
332
|
+
description?: string;
|
|
333
|
+
/**
|
|
334
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
335
|
+
*/
|
|
336
|
+
searchable?: boolean;
|
|
337
|
+
/**
|
|
338
|
+
* API searches can filter on it. Default false.
|
|
339
|
+
*/
|
|
340
|
+
filterable?: boolean;
|
|
341
|
+
/**
|
|
342
|
+
* API searches can sort on it (one value only). Default false.
|
|
343
|
+
*/
|
|
344
|
+
sortable?: boolean;
|
|
345
|
+
options: Array<string>;
|
|
346
|
+
};
|
|
347
|
+
export type AssetFieldConfiguration = {
|
|
348
|
+
/**
|
|
349
|
+
* Help text for editors.
|
|
350
|
+
*/
|
|
351
|
+
description?: string;
|
|
352
|
+
/**
|
|
353
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
354
|
+
*/
|
|
355
|
+
searchable?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* API searches can filter on it. Default false.
|
|
358
|
+
*/
|
|
359
|
+
filterable?: boolean;
|
|
360
|
+
/**
|
|
361
|
+
* API searches can sort on it (one value only). Default false.
|
|
362
|
+
*/
|
|
363
|
+
sortable?: boolean;
|
|
364
|
+
/**
|
|
365
|
+
* MIME types or `type*` wildcards newly written values must have (`["image*", "application/pdf"]`); any file when absent.
|
|
366
|
+
*/
|
|
367
|
+
accepted_types?: Array<string>;
|
|
368
|
+
};
|
|
369
|
+
export type RelationFieldConfiguration = {
|
|
370
|
+
/**
|
|
371
|
+
* Help text for editors.
|
|
372
|
+
*/
|
|
373
|
+
description?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
376
|
+
*/
|
|
377
|
+
searchable?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* API searches can filter on it. Default false.
|
|
380
|
+
*/
|
|
381
|
+
filterable?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* API searches can sort on it (one value only). Default false.
|
|
384
|
+
*/
|
|
385
|
+
sortable?: boolean;
|
|
386
|
+
/**
|
|
387
|
+
* The collection (same project) whose records it points at.
|
|
388
|
+
*/
|
|
389
|
+
target_collection_id: string;
|
|
390
|
+
};
|
|
391
|
+
export type JsonFieldConfiguration = {
|
|
392
|
+
/**
|
|
393
|
+
* Help text for editors.
|
|
394
|
+
*/
|
|
395
|
+
description?: string;
|
|
396
|
+
/**
|
|
397
|
+
* Search words match the field (API searches). Default true for text, long_text, rich_text and enum.
|
|
398
|
+
*/
|
|
399
|
+
searchable?: boolean;
|
|
400
|
+
/**
|
|
401
|
+
* API searches can filter on it. Default false.
|
|
402
|
+
*/
|
|
403
|
+
filterable?: boolean;
|
|
404
|
+
/**
|
|
405
|
+
* API searches can sort on it (one value only). Default false.
|
|
406
|
+
*/
|
|
407
|
+
sortable?: boolean;
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Type-specific options, e.g. `max_length`, `options`, `target_collection_id`,
|
|
411
|
+
* `accepted_types` (asset fields: MIME types or `type*` wildcards that newly
|
|
412
|
+
* written values must have; any file when absent), `include_time` and
|
|
413
|
+
* `time_zone` (date fields, below), `format` (text fields, below),
|
|
414
|
+
* `unique` (text and integer fields, below), plus
|
|
415
|
+
* the options for searches with API keys: `searchable` (the search words match the
|
|
416
|
+
* field; default true for text, long_text, rich_text and enum), `filterable` and
|
|
417
|
+
* `sortable` (default false).
|
|
418
|
+
*
|
|
419
|
+
* Date fields hold a calendar date, `YYYY-MM-DD`, with no time and no
|
|
420
|
+
* time zone: returned exactly as written, so it never shows as the day
|
|
421
|
+
* before or after. With `include_time: true` they hold a moment: ISO
|
|
422
|
+
* 8601 with an offset, stored in UTC and returned in UTC, or with the
|
|
423
|
+
* offset of `time_zone` (an IANA name such as `Europe/Copenhagen`,
|
|
424
|
+
* daylight saving included) when the field has one. Input may use any
|
|
425
|
+
* offset. Changing `time_zone` never rewrites values; turning
|
|
426
|
+
* `include_time` on or off does, through a field migration.
|
|
427
|
+
*
|
|
428
|
+
* Text fields (not long text) can have a `format`: `slug`
|
|
429
|
+
* (lowercase letters, digits and single hyphens, at most 200
|
|
430
|
+
* characters; one value per record, never a list, and always
|
|
431
|
+
* unique: a slug field has `unique: true`), `url` (an absolute
|
|
432
|
+
* `http` or `https` address) or `email`. A value that doesn't match is
|
|
433
|
+
* refused with `invalid_format`. A format sets its own length limits
|
|
434
|
+
* (254 characters for emails, 2,048 for URLs), so `min_length` and
|
|
435
|
+
* `max_length` are for plain text. Text and integer
|
|
436
|
+
* fields with one value can be `unique`: no two active records of the
|
|
437
|
+
* collection share a value (emails compare ignoring capitals; records
|
|
438
|
+
* without a value don't count). A taken value is refused with
|
|
439
|
+
* `taken` and the `record_id` that has it. Turning `unique` on is
|
|
440
|
+
* refused with `duplicate_values` while records share a value (and
|
|
441
|
+
* so is restoring a deleted unique field, `409`). A field migration
|
|
442
|
+
* to a unique field is refused with `duplicate_values` when its
|
|
443
|
+
* converted values or backfill would be shared, and fails if values
|
|
444
|
+
* written while it waits would be.
|
|
445
|
+
*
|
|
446
|
+
*/
|
|
447
|
+
export type FieldConfiguration = TextFieldConfiguration | LongTextFieldConfiguration | RichTextFieldConfiguration | IntegerFieldConfiguration | DecimalFieldConfiguration | DateFieldConfiguration | BooleanFieldConfiguration | EnumFieldConfiguration | AssetFieldConfiguration | RelationFieldConfiguration | JsonFieldConfiguration;
|
|
137
448
|
export type RecordCount = {
|
|
138
449
|
object: 'record_count';
|
|
139
450
|
collection_id: string;
|
|
140
451
|
count: number;
|
|
141
452
|
};
|
|
142
|
-
|
|
453
|
+
/**
|
|
454
|
+
* A new field. Its `type` decides the options `configuration` takes.
|
|
455
|
+
*/
|
|
456
|
+
export type FieldCreate = ({
|
|
457
|
+
type: 'text';
|
|
458
|
+
} & TextFieldCreate) | ({
|
|
459
|
+
type: 'long_text';
|
|
460
|
+
} & LongTextFieldCreate) | ({
|
|
461
|
+
type: 'rich_text';
|
|
462
|
+
} & RichTextFieldCreate) | ({
|
|
463
|
+
type: 'integer';
|
|
464
|
+
} & IntegerFieldCreate) | ({
|
|
465
|
+
type: 'decimal';
|
|
466
|
+
} & DecimalFieldCreate) | ({
|
|
467
|
+
type: 'date';
|
|
468
|
+
} & DateFieldCreate) | ({
|
|
469
|
+
type: 'boolean';
|
|
470
|
+
} & BooleanFieldCreate) | ({
|
|
471
|
+
type: 'enum';
|
|
472
|
+
} & EnumFieldCreate) | ({
|
|
473
|
+
type: 'asset';
|
|
474
|
+
} & AssetFieldCreate) | ({
|
|
475
|
+
type: 'relation';
|
|
476
|
+
} & RelationFieldCreate) | ({
|
|
477
|
+
type: 'json';
|
|
478
|
+
} & JsonFieldCreate);
|
|
479
|
+
export type TextFieldCreate = FieldCreateProperties & {
|
|
480
|
+
type: 'text';
|
|
481
|
+
configuration?: TextFieldConfiguration;
|
|
482
|
+
};
|
|
483
|
+
export type LongTextFieldCreate = FieldCreateProperties & {
|
|
484
|
+
type: 'long_text';
|
|
485
|
+
configuration?: LongTextFieldConfiguration;
|
|
486
|
+
};
|
|
487
|
+
export type RichTextFieldCreate = FieldCreateProperties & {
|
|
488
|
+
type: 'rich_text';
|
|
489
|
+
configuration?: RichTextFieldConfiguration;
|
|
490
|
+
};
|
|
491
|
+
export type IntegerFieldCreate = FieldCreateProperties & {
|
|
492
|
+
type: 'integer';
|
|
493
|
+
configuration?: IntegerFieldConfiguration;
|
|
494
|
+
};
|
|
495
|
+
export type DecimalFieldCreate = FieldCreateProperties & {
|
|
496
|
+
type: 'decimal';
|
|
497
|
+
configuration?: DecimalFieldConfiguration;
|
|
498
|
+
};
|
|
499
|
+
export type DateFieldCreate = FieldCreateProperties & {
|
|
500
|
+
type: 'date';
|
|
501
|
+
configuration?: DateFieldConfiguration;
|
|
502
|
+
};
|
|
503
|
+
export type BooleanFieldCreate = FieldCreateProperties & {
|
|
504
|
+
type: 'boolean';
|
|
505
|
+
configuration?: BooleanFieldConfiguration;
|
|
506
|
+
};
|
|
507
|
+
export type EnumFieldCreate = FieldCreateProperties & {
|
|
508
|
+
type: 'enum';
|
|
509
|
+
configuration: EnumFieldConfiguration;
|
|
510
|
+
};
|
|
511
|
+
export type AssetFieldCreate = FieldCreateProperties & {
|
|
512
|
+
type: 'asset';
|
|
513
|
+
configuration?: AssetFieldConfiguration;
|
|
514
|
+
};
|
|
515
|
+
export type RelationFieldCreate = FieldCreateProperties & {
|
|
516
|
+
type: 'relation';
|
|
517
|
+
configuration: RelationFieldConfiguration;
|
|
518
|
+
};
|
|
519
|
+
export type JsonFieldCreate = FieldCreateProperties & {
|
|
520
|
+
type: 'json';
|
|
521
|
+
configuration?: JsonFieldConfiguration;
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* What every new field takes; `FieldCreate` adds its `type` and that type's `configuration`.
|
|
525
|
+
*/
|
|
526
|
+
export type FieldCreateProperties = {
|
|
143
527
|
name: string;
|
|
144
528
|
/**
|
|
145
529
|
* The field's key in records' `data`, filters and sorts. Reserved for records' own attributes, and a few kept for later: `id`, `object`, `collection`, `data`, `status`, `published_at`, `created_at`, `updated_at`, `deleted`, `deleted_at`, `purge_after`, `revision` and `schema_version`.
|
|
146
530
|
*/
|
|
147
|
-
|
|
148
|
-
type: FieldType;
|
|
531
|
+
key: string;
|
|
149
532
|
/**
|
|
150
533
|
* Every record must have a value. Not available for boolean fields (a boolean is true or false; no value reads as false).
|
|
151
534
|
*/
|
|
@@ -154,28 +537,21 @@ export type FieldCreate = {
|
|
|
154
537
|
* A list of distinct values (a repeated value is refused with `duplicate_value`, an empty string with `blank_value`). Not available for boolean, long_text, rich_text and json fields.
|
|
155
538
|
*/
|
|
156
539
|
multiple?: boolean;
|
|
157
|
-
configuration?: {
|
|
158
|
-
[key: string]: unknown;
|
|
159
|
-
};
|
|
160
540
|
};
|
|
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.
|
|
543
|
+
*/
|
|
161
544
|
export type FieldUpdate = {
|
|
162
545
|
name?: string;
|
|
163
546
|
/**
|
|
164
547
|
* The field's key in records' `data`, filters and sorts. Reserved for records' own attributes, and a few kept for later: `id`, `object`, `collection`, `data`, `status`, `published_at`, `created_at`, `updated_at`, `deleted`, `deleted_at`, `purge_after`, `revision` and `schema_version`.
|
|
165
548
|
*/
|
|
166
|
-
|
|
167
|
-
type?: FieldType;
|
|
549
|
+
key?: string;
|
|
168
550
|
/**
|
|
169
551
|
* Every record must have a value. Not available for boolean fields (a boolean is true or false; no value reads as false).
|
|
170
552
|
*/
|
|
171
553
|
required?: boolean;
|
|
172
|
-
|
|
173
|
-
* A list of distinct values (a repeated value is refused with `duplicate_value`, an empty string with `blank_value`). Not available for boolean, long_text, rich_text and json fields.
|
|
174
|
-
*/
|
|
175
|
-
multiple?: boolean;
|
|
176
|
-
configuration?: {
|
|
177
|
-
[key: string]: unknown;
|
|
178
|
-
};
|
|
554
|
+
configuration?: FieldConfiguration;
|
|
179
555
|
};
|
|
180
556
|
export type FieldList = {
|
|
181
557
|
data: Array<Field>;
|
|
@@ -240,14 +616,12 @@ export type SchemaDefinition = {
|
|
|
240
616
|
fields: Array<{
|
|
241
617
|
id: string;
|
|
242
618
|
name: string;
|
|
243
|
-
|
|
619
|
+
key: string;
|
|
244
620
|
type: FieldType;
|
|
245
621
|
required: boolean;
|
|
246
622
|
multiple: boolean;
|
|
247
623
|
position: number;
|
|
248
|
-
configuration:
|
|
249
|
-
[key: string]: unknown;
|
|
250
|
-
};
|
|
624
|
+
configuration: FieldConfiguration;
|
|
251
625
|
deleted_at: NullableTimestamp;
|
|
252
626
|
}>;
|
|
253
627
|
};
|
|
@@ -301,9 +675,7 @@ export type SchemaChangeList = {
|
|
|
301
675
|
};
|
|
302
676
|
export type FieldDefinition = {
|
|
303
677
|
type: FieldType;
|
|
304
|
-
configuration:
|
|
305
|
-
[key: string]: unknown;
|
|
306
|
-
};
|
|
678
|
+
configuration: FieldConfiguration;
|
|
307
679
|
/**
|
|
308
680
|
* A list of distinct values (a repeated value is refused with `duplicate_value`, an empty string with `blank_value`). Not available for boolean, long_text, rich_text and json fields.
|
|
309
681
|
*/
|
|
@@ -311,16 +683,18 @@ export type FieldDefinition = {
|
|
|
311
683
|
required: boolean;
|
|
312
684
|
};
|
|
313
685
|
/**
|
|
314
|
-
* The parts of
|
|
686
|
+
* The field, and the parts of its definition to change; omitted parts stay as they are.
|
|
315
687
|
*/
|
|
316
688
|
export type FieldMigrationRequest = {
|
|
689
|
+
/**
|
|
690
|
+
* One of the collection's fields (`422` otherwise).
|
|
691
|
+
*/
|
|
692
|
+
field_id: string;
|
|
317
693
|
type?: FieldType;
|
|
318
694
|
/**
|
|
319
695
|
* The complete new configuration. When the type changes and this is omitted, only `description`, `searchable`, `filterable` and `sortable` carry over.
|
|
320
696
|
*/
|
|
321
|
-
configuration?:
|
|
322
|
-
[key: string]: unknown;
|
|
323
|
-
};
|
|
697
|
+
configuration?: FieldConfiguration;
|
|
324
698
|
/**
|
|
325
699
|
* A list of distinct values (a repeated value is refused with `duplicate_value`, an empty string with `blank_value`). Not available for boolean, long_text, rich_text and json fields.
|
|
326
700
|
*/
|
|
@@ -500,9 +874,9 @@ export type TimeFilter = {
|
|
|
500
874
|
lt?: string;
|
|
501
875
|
};
|
|
502
876
|
/**
|
|
503
|
-
* The client a change came through; `scheduler` for scheduled changes.
|
|
877
|
+
* The client a change came through; `scheduler` for scheduled changes.
|
|
504
878
|
*/
|
|
505
|
-
export type Via = 'ui' | 'api' | 'cli' | 'sdk' | '
|
|
879
|
+
export type Via = 'ui' | 'api' | 'cli' | 'sdk' | 'system' | 'scheduler';
|
|
506
880
|
/**
|
|
507
881
|
* Changes to a record's content that wait until they are merged into
|
|
508
882
|
* it, now or at `schedule.merge_at`. Content only: whether the record
|
|
@@ -534,7 +908,7 @@ export type Draft = {
|
|
|
534
908
|
*/
|
|
535
909
|
data: RecordData;
|
|
536
910
|
/**
|
|
537
|
-
*
|
|
911
|
+
* Keys of the fields the draft changes.
|
|
538
912
|
*/
|
|
539
913
|
changed_fields: Array<string>;
|
|
540
914
|
schedule: DraftSchedule;
|
|
@@ -586,7 +960,7 @@ export type MergedDraft = {
|
|
|
586
960
|
edited_by: Array<Actor>;
|
|
587
961
|
};
|
|
588
962
|
/**
|
|
589
|
-
* Field values keyed by field `
|
|
963
|
+
* Field values keyed by field `key`. A rich text value is a
|
|
590
964
|
* ProseMirror/Tiptap JSON document (`{"type": "doc", "content": [...]}`).
|
|
591
965
|
* An image of an asset in it is `{"type": "image", "attrs": {"asset_id":
|
|
592
966
|
* "ast_...", "alt": "..."}}`, between the document's blocks (not inside
|
|
@@ -631,7 +1005,7 @@ export type Record = {
|
|
|
631
1005
|
data: RecordData;
|
|
632
1006
|
/**
|
|
633
1007
|
* Only with `expand`: what each requested relation, asset or rich
|
|
634
|
-
* text field points at, keyed by field
|
|
1008
|
+
* text field points at, keyed by field key: records for
|
|
635
1009
|
* relation fields, assets for asset fields. A single value is the object, or null when
|
|
636
1010
|
* it no longer exists; a multiple value is a list of those that still
|
|
637
1011
|
* exist. For a rich text field, the list of assets its images show,
|
|
@@ -680,11 +1054,11 @@ export type RecordRevisionProperties = {
|
|
|
680
1054
|
schema_version: number;
|
|
681
1055
|
reverted_to_revision: number | null;
|
|
682
1056
|
/**
|
|
683
|
-
*
|
|
1057
|
+
* Keys of changed fields, and changed attributes.
|
|
684
1058
|
*/
|
|
685
1059
|
changed_fields: Array<string>;
|
|
686
1060
|
/**
|
|
687
|
-
*
|
|
1061
|
+
* Keys of fields whose values in this revision were redacted (owners
|
|
688
1062
|
* and admins redact them in the web app); those values read
|
|
689
1063
|
* `{"$redacted": true}`.
|
|
690
1064
|
*
|
|
@@ -995,16 +1369,16 @@ export type WebhookEventPayload = {
|
|
|
995
1369
|
created_at: Timestamp;
|
|
996
1370
|
project_id: string;
|
|
997
1371
|
/**
|
|
998
|
-
* Who made the change.
|
|
1372
|
+
* Who made the change.
|
|
999
1373
|
*/
|
|
1000
|
-
actor
|
|
1374
|
+
actor: Actor;
|
|
1001
1375
|
/**
|
|
1002
|
-
* The client the change came through (null when not known).
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
1376
|
+
* The client the change came through (null when not known). An
|
|
1377
|
+
* integration that writes back can skip changes made with its own API
|
|
1378
|
+
* key (`actor`).
|
|
1005
1379
|
*
|
|
1006
1380
|
*/
|
|
1007
|
-
via
|
|
1381
|
+
via: null | Via;
|
|
1008
1382
|
data: RecordEventData | DraftEventData | AssetEventData | SchemaEventData | FieldAliasEventData | WebhookTestEventData;
|
|
1009
1383
|
};
|
|
1010
1384
|
/**
|
|
@@ -1153,7 +1527,7 @@ export type AssetUsage = {
|
|
|
1153
1527
|
uses: Array<{
|
|
1154
1528
|
record: Record;
|
|
1155
1529
|
/**
|
|
1156
|
-
*
|
|
1530
|
+
* Keys of the record's fields that use the asset, in its content or its draft.
|
|
1157
1531
|
*/
|
|
1158
1532
|
fields: Array<string>;
|
|
1159
1533
|
}>;
|
|
@@ -1208,7 +1582,7 @@ export type PublishedOnly = boolean;
|
|
|
1208
1582
|
export type ErrorType = 'invalid_request' | 'authentication_error' | 'plan_limit_exceeded' | 'authorization_error' | 'not_found' | 'conflict' | 'precondition_failed' | 'validation_error' | 'rate_limited' | 'internal_error' | 'service_unavailable';
|
|
1209
1583
|
export type ErrorDetail = {
|
|
1210
1584
|
/**
|
|
1211
|
-
*
|
|
1585
|
+
* Key of the offending field or parameter, when applicable.
|
|
1212
1586
|
*/
|
|
1213
1587
|
field?: string;
|
|
1214
1588
|
/**
|
|
@@ -1263,12 +1637,12 @@ export type DraftId = string;
|
|
|
1263
1637
|
*/
|
|
1264
1638
|
export type RevisionNumber = number;
|
|
1265
1639
|
/**
|
|
1266
|
-
* Comma-separated relation, asset or rich text field
|
|
1640
|
+
* Comma-separated relation, asset or rich text field keys whose records or assets to embed under `expanded` (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: `records:read` for relations, `assets:read` for assets and rich text (`403` otherwise).
|
|
1267
1641
|
*/
|
|
1268
1642
|
export type Expand = string;
|
|
1269
1643
|
/**
|
|
1270
1644
|
* `filter[<key>]=value` (equal), or `filter[<key>][<operator>]=value`;
|
|
1271
|
-
* filters combine with AND. Keys are field
|
|
1645
|
+
* filters combine with AND. Keys are field keys, `published_at`,
|
|
1272
1646
|
* `deleted` (`true` lists soft-deleted records instead) and, in record
|
|
1273
1647
|
* lists and counts, `created_at` and `updated_at`. In search,
|
|
1274
1648
|
* `published_at` takes only `exists`.
|
|
@@ -1330,7 +1704,7 @@ export type RecordRevisionFilter = {
|
|
|
1330
1704
|
actor_id?: string;
|
|
1331
1705
|
created_at?: TimeFilter;
|
|
1332
1706
|
};
|
|
1333
|
-
export type AuditEventSort = '
|
|
1707
|
+
export type AuditEventSort = 'created_at' | '-created_at';
|
|
1334
1708
|
/**
|
|
1335
1709
|
* Page size.
|
|
1336
1710
|
*/
|
|
@@ -1347,14 +1721,20 @@ export type DeletedFilter = {
|
|
|
1347
1721
|
};
|
|
1348
1722
|
/**
|
|
1349
1723
|
* `filter[deleted]=true` lists deleted assets instead.
|
|
1350
|
-
* `filter[content_type]` lists only assets of
|
|
1351
|
-
*
|
|
1352
|
-
*
|
|
1724
|
+
* `filter[content_type]` lists only assets of a type: a MIME type or a
|
|
1725
|
+
* `type*` wildcard, or several with
|
|
1726
|
+
* `filter[content_type][in]=image*,application/pdf`, for example the
|
|
1727
|
+
* ones an asset field accepts (its `accepted_types`).
|
|
1353
1728
|
*
|
|
1354
1729
|
*/
|
|
1355
1730
|
export type AssetFilter = {
|
|
1356
1731
|
deleted?: 'true' | 'false';
|
|
1357
|
-
content_type?: string
|
|
1732
|
+
content_type?: string | {
|
|
1733
|
+
/**
|
|
1734
|
+
* Up to 50 comma-separated MIME types or `type*` wildcards.
|
|
1735
|
+
*/
|
|
1736
|
+
in: string;
|
|
1737
|
+
};
|
|
1358
1738
|
};
|
|
1359
1739
|
/**
|
|
1360
1740
|
* The revision you last read (the record's, or the draft's for a draft), e.g. `"7"`. Stale writes fail with 412.
|
|
@@ -1395,7 +1775,7 @@ export type RecordsListData = {
|
|
|
1395
1775
|
query?: {
|
|
1396
1776
|
/**
|
|
1397
1777
|
* `filter[<key>]=value` (equal), or `filter[<key>][<operator>]=value`;
|
|
1398
|
-
* filters combine with AND. Keys are field
|
|
1778
|
+
* filters combine with AND. Keys are field keys, `published_at`,
|
|
1399
1779
|
* `deleted` (`true` lists soft-deleted records instead) and, in record
|
|
1400
1780
|
* lists and counts, `created_at` and `updated_at`. In search,
|
|
1401
1781
|
* `published_at` takes only `exists`.
|
|
@@ -1424,15 +1804,15 @@ export type RecordsListData = {
|
|
|
1424
1804
|
[key: string]: RecordFilterValue;
|
|
1425
1805
|
};
|
|
1426
1806
|
/**
|
|
1427
|
-
* `
|
|
1428
|
-
*
|
|
1807
|
+
* `created_at`, `updated_at`, `published_at` (unpublished records
|
|
1808
|
+
* first), or the key of a text, number, boolean, date or
|
|
1429
1809
|
* enum field with one value (records without a value last, in both
|
|
1430
1810
|
* directions; text by code point). `-` for descending.
|
|
1431
1811
|
*
|
|
1432
1812
|
*/
|
|
1433
1813
|
sort?: string;
|
|
1434
1814
|
/**
|
|
1435
|
-
* Comma-separated relation, asset or rich text field
|
|
1815
|
+
* Comma-separated relation, asset or rich text field keys whose records or assets to embed under `expanded` (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: `records:read` for relations, `assets:read` for assets and rich text (`403` otherwise).
|
|
1436
1816
|
*/
|
|
1437
1817
|
expand?: string;
|
|
1438
1818
|
/**
|
|
@@ -1448,7 +1828,7 @@ export type RecordsListData = {
|
|
|
1448
1828
|
};
|
|
1449
1829
|
export type RecordsListErrors = {
|
|
1450
1830
|
/**
|
|
1451
|
-
* The request was malformed.
|
|
1831
|
+
* 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).
|
|
1452
1832
|
*/
|
|
1453
1833
|
400: Error;
|
|
1454
1834
|
/**
|
|
@@ -1519,7 +1899,7 @@ export type RecordsCreateData = {
|
|
|
1519
1899
|
};
|
|
1520
1900
|
export type RecordsCreateErrors = {
|
|
1521
1901
|
/**
|
|
1522
|
-
* The request was malformed.
|
|
1902
|
+
* 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).
|
|
1523
1903
|
*/
|
|
1524
1904
|
400: Error;
|
|
1525
1905
|
/**
|
|
@@ -1605,7 +1985,7 @@ export type RecordsDeleteData = {
|
|
|
1605
1985
|
};
|
|
1606
1986
|
export type RecordsDeleteErrors = {
|
|
1607
1987
|
/**
|
|
1608
|
-
* The request was malformed.
|
|
1988
|
+
* 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).
|
|
1609
1989
|
*/
|
|
1610
1990
|
400: Error;
|
|
1611
1991
|
/**
|
|
@@ -1654,7 +2034,7 @@ export type RecordsGetData = {
|
|
|
1654
2034
|
};
|
|
1655
2035
|
query?: {
|
|
1656
2036
|
/**
|
|
1657
|
-
* Comma-separated relation, asset or rich text field
|
|
2037
|
+
* Comma-separated relation, asset or rich text field keys whose records or assets to embed under `expanded` (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: `records:read` for relations, `assets:read` for assets and rich text (`403` otherwise).
|
|
1658
2038
|
*/
|
|
1659
2039
|
expand?: string;
|
|
1660
2040
|
};
|
|
@@ -1662,7 +2042,7 @@ export type RecordsGetData = {
|
|
|
1662
2042
|
};
|
|
1663
2043
|
export type RecordsGetErrors = {
|
|
1664
2044
|
/**
|
|
1665
|
-
* The request was malformed.
|
|
2045
|
+
* 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).
|
|
1666
2046
|
*/
|
|
1667
2047
|
400: Error;
|
|
1668
2048
|
/**
|
|
@@ -1734,7 +2114,7 @@ export type RecordsUpdateData = {
|
|
|
1734
2114
|
};
|
|
1735
2115
|
export type RecordsUpdateErrors = {
|
|
1736
2116
|
/**
|
|
1737
|
-
* The request was malformed.
|
|
2117
|
+
* 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).
|
|
1738
2118
|
*/
|
|
1739
2119
|
400: Error;
|
|
1740
2120
|
/**
|
|
@@ -1791,7 +2171,7 @@ export type RecordsCountData = {
|
|
|
1791
2171
|
query?: {
|
|
1792
2172
|
/**
|
|
1793
2173
|
* `filter[<key>]=value` (equal), or `filter[<key>][<operator>]=value`;
|
|
1794
|
-
* filters combine with AND. Keys are field
|
|
2174
|
+
* filters combine with AND. Keys are field keys, `published_at`,
|
|
1795
2175
|
* `deleted` (`true` lists soft-deleted records instead) and, in record
|
|
1796
2176
|
* lists and counts, `created_at` and `updated_at`. In search,
|
|
1797
2177
|
* `published_at` takes only `exists`.
|
|
@@ -1824,7 +2204,7 @@ export type RecordsCountData = {
|
|
|
1824
2204
|
};
|
|
1825
2205
|
export type RecordsCountErrors = {
|
|
1826
2206
|
/**
|
|
1827
|
-
* The request was malformed.
|
|
2207
|
+
* 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).
|
|
1828
2208
|
*/
|
|
1829
2209
|
400: Error;
|
|
1830
2210
|
/**
|
|
@@ -1895,7 +2275,7 @@ export type RecordsBulkData = {
|
|
|
1895
2275
|
};
|
|
1896
2276
|
export type RecordsBulkErrors = {
|
|
1897
2277
|
/**
|
|
1898
|
-
* The request was malformed.
|
|
2278
|
+
* 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).
|
|
1899
2279
|
*/
|
|
1900
2280
|
400: Error;
|
|
1901
2281
|
/**
|
|
@@ -1975,7 +2355,7 @@ export type RecordsRestoreData = {
|
|
|
1975
2355
|
};
|
|
1976
2356
|
export type RecordsRestoreErrors = {
|
|
1977
2357
|
/**
|
|
1978
|
-
* The request was malformed.
|
|
2358
|
+
* 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).
|
|
1979
2359
|
*/
|
|
1980
2360
|
400: Error;
|
|
1981
2361
|
/**
|
|
@@ -2063,7 +2443,7 @@ export type RecordsUnpublishData = {
|
|
|
2063
2443
|
};
|
|
2064
2444
|
export type RecordsUnpublishErrors = {
|
|
2065
2445
|
/**
|
|
2066
|
-
* The request was malformed.
|
|
2446
|
+
* 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).
|
|
2067
2447
|
*/
|
|
2068
2448
|
400: Error;
|
|
2069
2449
|
/**
|
|
@@ -2115,7 +2495,7 @@ export type RecordsGetPublicationData = {
|
|
|
2115
2495
|
};
|
|
2116
2496
|
export type RecordsGetPublicationErrors = {
|
|
2117
2497
|
/**
|
|
2118
|
-
* The request was malformed.
|
|
2498
|
+
* 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).
|
|
2119
2499
|
*/
|
|
2120
2500
|
400: Error;
|
|
2121
2501
|
/**
|
|
@@ -2187,7 +2567,7 @@ export type RecordsPublishData = {
|
|
|
2187
2567
|
};
|
|
2188
2568
|
export type RecordsPublishErrors = {
|
|
2189
2569
|
/**
|
|
2190
|
-
* The request was malformed.
|
|
2570
|
+
* 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).
|
|
2191
2571
|
*/
|
|
2192
2572
|
400: Error;
|
|
2193
2573
|
/**
|
|
@@ -2255,7 +2635,7 @@ export type RecordsUnscheduleData = {
|
|
|
2255
2635
|
};
|
|
2256
2636
|
export type RecordsUnscheduleErrors = {
|
|
2257
2637
|
/**
|
|
2258
|
-
* The request was malformed.
|
|
2638
|
+
* 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).
|
|
2259
2639
|
*/
|
|
2260
2640
|
400: Error;
|
|
2261
2641
|
/**
|
|
@@ -2301,7 +2681,7 @@ export type RecordsGetScheduleData = {
|
|
|
2301
2681
|
};
|
|
2302
2682
|
export type RecordsGetScheduleErrors = {
|
|
2303
2683
|
/**
|
|
2304
|
-
* The request was malformed.
|
|
2684
|
+
* 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).
|
|
2305
2685
|
*/
|
|
2306
2686
|
400: Error;
|
|
2307
2687
|
/**
|
|
@@ -2359,7 +2739,7 @@ export type RecordsScheduleData = {
|
|
|
2359
2739
|
};
|
|
2360
2740
|
export type RecordsScheduleErrors = {
|
|
2361
2741
|
/**
|
|
2362
|
-
* The request was malformed.
|
|
2742
|
+
* 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).
|
|
2363
2743
|
*/
|
|
2364
2744
|
400: Error;
|
|
2365
2745
|
/**
|
|
@@ -2422,7 +2802,7 @@ export type ScheduledChangesListData = {
|
|
|
2422
2802
|
};
|
|
2423
2803
|
export type ScheduledChangesListErrors = {
|
|
2424
2804
|
/**
|
|
2425
|
-
* The request was malformed.
|
|
2805
|
+
* 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).
|
|
2426
2806
|
*/
|
|
2427
2807
|
400: Error;
|
|
2428
2808
|
/**
|
|
@@ -2484,7 +2864,7 @@ export type RecordRevisionsListData = {
|
|
|
2484
2864
|
};
|
|
2485
2865
|
export type RecordRevisionsListErrors = {
|
|
2486
2866
|
/**
|
|
2487
|
-
* The request was malformed.
|
|
2867
|
+
* 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).
|
|
2488
2868
|
*/
|
|
2489
2869
|
400: Error;
|
|
2490
2870
|
/**
|
|
@@ -2530,7 +2910,7 @@ export type RecordRevisionsGetData = {
|
|
|
2530
2910
|
};
|
|
2531
2911
|
export type RecordRevisionsGetErrors = {
|
|
2532
2912
|
/**
|
|
2533
|
-
* The request was malformed.
|
|
2913
|
+
* 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).
|
|
2534
2914
|
*/
|
|
2535
2915
|
400: Error;
|
|
2536
2916
|
/**
|
|
@@ -2608,7 +2988,7 @@ export type RecordRevisionsRevertData = {
|
|
|
2608
2988
|
};
|
|
2609
2989
|
export type RecordRevisionsRevertErrors = {
|
|
2610
2990
|
/**
|
|
2611
|
-
* The request was malformed.
|
|
2991
|
+
* 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).
|
|
2612
2992
|
*/
|
|
2613
2993
|
400: Error;
|
|
2614
2994
|
/**
|
|
@@ -2667,7 +3047,7 @@ export type RecordsDiffData = {
|
|
|
2667
3047
|
};
|
|
2668
3048
|
export type RecordsDiffErrors = {
|
|
2669
3049
|
/**
|
|
2670
|
-
* The request was malformed.
|
|
3050
|
+
* 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).
|
|
2671
3051
|
*/
|
|
2672
3052
|
400: Error;
|
|
2673
3053
|
/**
|
|
@@ -2718,7 +3098,7 @@ export type RecordDraftsListData = {
|
|
|
2718
3098
|
};
|
|
2719
3099
|
export type RecordDraftsListErrors = {
|
|
2720
3100
|
/**
|
|
2721
|
-
* The request was malformed.
|
|
3101
|
+
* 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).
|
|
2722
3102
|
*/
|
|
2723
3103
|
400: Error;
|
|
2724
3104
|
/**
|
|
@@ -2776,7 +3156,7 @@ export type DraftsCreateData = {
|
|
|
2776
3156
|
};
|
|
2777
3157
|
export type DraftsCreateErrors = {
|
|
2778
3158
|
/**
|
|
2779
|
-
* The request was malformed.
|
|
3159
|
+
* 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).
|
|
2780
3160
|
*/
|
|
2781
3161
|
400: Error;
|
|
2782
3162
|
/**
|
|
@@ -2825,14 +3205,6 @@ export type DraftsListData = {
|
|
|
2825
3205
|
collection_id: string;
|
|
2826
3206
|
};
|
|
2827
3207
|
query?: {
|
|
2828
|
-
filter?: {
|
|
2829
|
-
record_id?: string | {
|
|
2830
|
-
/**
|
|
2831
|
-
* Up to 100 comma-separated record IDs.
|
|
2832
|
-
*/
|
|
2833
|
-
in: string;
|
|
2834
|
-
};
|
|
2835
|
-
};
|
|
2836
3208
|
sort?: 'updated_at' | '-updated_at';
|
|
2837
3209
|
/**
|
|
2838
3210
|
* Page size.
|
|
@@ -2847,7 +3219,7 @@ export type DraftsListData = {
|
|
|
2847
3219
|
};
|
|
2848
3220
|
export type DraftsListErrors = {
|
|
2849
3221
|
/**
|
|
2850
|
-
* The request was malformed.
|
|
3222
|
+
* 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).
|
|
2851
3223
|
*/
|
|
2852
3224
|
400: Error;
|
|
2853
3225
|
/**
|
|
@@ -2909,7 +3281,7 @@ export type DraftsDiscardData = {
|
|
|
2909
3281
|
};
|
|
2910
3282
|
export type DraftsDiscardErrors = {
|
|
2911
3283
|
/**
|
|
2912
|
-
* The request was malformed.
|
|
3284
|
+
* 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).
|
|
2913
3285
|
*/
|
|
2914
3286
|
400: Error;
|
|
2915
3287
|
/**
|
|
@@ -2958,7 +3330,7 @@ export type DraftsGetData = {
|
|
|
2958
3330
|
};
|
|
2959
3331
|
query?: {
|
|
2960
3332
|
/**
|
|
2961
|
-
* Comma-separated relation, asset or rich text field
|
|
3333
|
+
* Comma-separated relation, asset or rich text field keys whose records or assets to embed under `expanded` (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: `records:read` for relations, `assets:read` for assets and rich text (`403` otherwise).
|
|
2962
3334
|
*/
|
|
2963
3335
|
expand?: string;
|
|
2964
3336
|
};
|
|
@@ -2966,7 +3338,7 @@ export type DraftsGetData = {
|
|
|
2966
3338
|
};
|
|
2967
3339
|
export type DraftsGetErrors = {
|
|
2968
3340
|
/**
|
|
2969
|
-
* The request was malformed.
|
|
3341
|
+
* 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).
|
|
2970
3342
|
*/
|
|
2971
3343
|
400: Error;
|
|
2972
3344
|
/**
|
|
@@ -3028,7 +3400,7 @@ export type DraftsUpdateData = {
|
|
|
3028
3400
|
};
|
|
3029
3401
|
export type DraftsUpdateErrors = {
|
|
3030
3402
|
/**
|
|
3031
|
-
* The request was malformed.
|
|
3403
|
+
* 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).
|
|
3032
3404
|
*/
|
|
3033
3405
|
400: Error;
|
|
3034
3406
|
/**
|
|
@@ -3114,7 +3486,7 @@ export type DraftsMergeData = {
|
|
|
3114
3486
|
};
|
|
3115
3487
|
export type DraftsMergeErrors = {
|
|
3116
3488
|
/**
|
|
3117
|
-
* The request was malformed.
|
|
3489
|
+
* 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).
|
|
3118
3490
|
*/
|
|
3119
3491
|
400: Error;
|
|
3120
3492
|
/**
|
|
@@ -3186,7 +3558,7 @@ export type DraftsUnscheduleData = {
|
|
|
3186
3558
|
};
|
|
3187
3559
|
export type DraftsUnscheduleErrors = {
|
|
3188
3560
|
/**
|
|
3189
|
-
* The request was malformed.
|
|
3561
|
+
* 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).
|
|
3190
3562
|
*/
|
|
3191
3563
|
400: Error;
|
|
3192
3564
|
/**
|
|
@@ -3248,7 +3620,7 @@ export type DraftsScheduleData = {
|
|
|
3248
3620
|
};
|
|
3249
3621
|
export type DraftsScheduleErrors = {
|
|
3250
3622
|
/**
|
|
3251
|
-
* The request was malformed.
|
|
3623
|
+
* 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).
|
|
3252
3624
|
*/
|
|
3253
3625
|
400: Error;
|
|
3254
3626
|
/**
|
|
@@ -3313,7 +3685,7 @@ export type CollectionsListData = {
|
|
|
3313
3685
|
};
|
|
3314
3686
|
export type CollectionsListErrors = {
|
|
3315
3687
|
/**
|
|
3316
|
-
* The request was malformed.
|
|
3688
|
+
* 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).
|
|
3317
3689
|
*/
|
|
3318
3690
|
400: Error;
|
|
3319
3691
|
/**
|
|
@@ -3381,7 +3753,7 @@ export type CollectionsCreateData = {
|
|
|
3381
3753
|
};
|
|
3382
3754
|
export type CollectionsCreateErrors = {
|
|
3383
3755
|
/**
|
|
3384
|
-
* The request was malformed.
|
|
3756
|
+
* 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).
|
|
3385
3757
|
*/
|
|
3386
3758
|
400: Error;
|
|
3387
3759
|
/**
|
|
@@ -3466,7 +3838,7 @@ export type CollectionsDeleteData = {
|
|
|
3466
3838
|
};
|
|
3467
3839
|
export type CollectionsDeleteErrors = {
|
|
3468
3840
|
/**
|
|
3469
|
-
* The request was malformed.
|
|
3841
|
+
* 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).
|
|
3470
3842
|
*/
|
|
3471
3843
|
400: Error;
|
|
3472
3844
|
/**
|
|
@@ -3515,7 +3887,7 @@ export type CollectionsGetData = {
|
|
|
3515
3887
|
};
|
|
3516
3888
|
export type CollectionsGetErrors = {
|
|
3517
3889
|
/**
|
|
3518
|
-
* The request was malformed.
|
|
3890
|
+
* 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).
|
|
3519
3891
|
*/
|
|
3520
3892
|
400: Error;
|
|
3521
3893
|
/**
|
|
@@ -3586,7 +3958,7 @@ export type CollectionsUpdateData = {
|
|
|
3586
3958
|
};
|
|
3587
3959
|
export type CollectionsUpdateErrors = {
|
|
3588
3960
|
/**
|
|
3589
|
-
* The request was malformed.
|
|
3961
|
+
* 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).
|
|
3590
3962
|
*/
|
|
3591
3963
|
400: Error;
|
|
3592
3964
|
/**
|
|
@@ -3665,7 +4037,7 @@ export type CollectionsRestoreData = {
|
|
|
3665
4037
|
};
|
|
3666
4038
|
export type CollectionsRestoreErrors = {
|
|
3667
4039
|
/**
|
|
3668
|
-
* The request was malformed.
|
|
4040
|
+
* 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).
|
|
3669
4041
|
*/
|
|
3670
4042
|
400: Error;
|
|
3671
4043
|
/**
|
|
@@ -3729,7 +4101,7 @@ export type CollectionsGetSchemaData = {
|
|
|
3729
4101
|
};
|
|
3730
4102
|
export type CollectionsGetSchemaErrors = {
|
|
3731
4103
|
/**
|
|
3732
|
-
* The request was malformed.
|
|
4104
|
+
* 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).
|
|
3733
4105
|
*/
|
|
3734
4106
|
400: Error;
|
|
3735
4107
|
/**
|
|
@@ -3783,7 +4155,7 @@ export type SchemaChangesListData = {
|
|
|
3783
4155
|
};
|
|
3784
4156
|
export type SchemaChangesListErrors = {
|
|
3785
4157
|
/**
|
|
3786
|
-
* The request was malformed.
|
|
4158
|
+
* 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).
|
|
3787
4159
|
*/
|
|
3788
4160
|
400: Error;
|
|
3789
4161
|
/**
|
|
@@ -3818,18 +4190,14 @@ export type SchemaChangesListResponse = SchemaChangesListResponses[keyof SchemaC
|
|
|
3818
4190
|
export type SchemaChangesGetData = {
|
|
3819
4191
|
body?: never;
|
|
3820
4192
|
path: {
|
|
3821
|
-
/**
|
|
3822
|
-
* Collection ID, or the collection slug when authenticating with an API key.
|
|
3823
|
-
*/
|
|
3824
|
-
collection_id: string;
|
|
3825
4193
|
schema_change_id: string;
|
|
3826
4194
|
};
|
|
3827
4195
|
query?: never;
|
|
3828
|
-
url: '/v1/
|
|
4196
|
+
url: '/v1/schema-changes/{schema_change_id}';
|
|
3829
4197
|
};
|
|
3830
4198
|
export type SchemaChangesGetErrors = {
|
|
3831
4199
|
/**
|
|
3832
|
-
* The request was malformed.
|
|
4200
|
+
* 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).
|
|
3833
4201
|
*/
|
|
3834
4202
|
400: Error;
|
|
3835
4203
|
/**
|
|
@@ -3889,7 +4257,7 @@ export type FieldsListData = {
|
|
|
3889
4257
|
};
|
|
3890
4258
|
export type FieldsListErrors = {
|
|
3891
4259
|
/**
|
|
3892
|
-
* The request was malformed.
|
|
4260
|
+
* 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).
|
|
3893
4261
|
*/
|
|
3894
4262
|
400: Error;
|
|
3895
4263
|
/**
|
|
@@ -3960,7 +4328,7 @@ export type FieldsCreateData = {
|
|
|
3960
4328
|
};
|
|
3961
4329
|
export type FieldsCreateErrors = {
|
|
3962
4330
|
/**
|
|
3963
|
-
* The request was malformed.
|
|
4331
|
+
* 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).
|
|
3964
4332
|
*/
|
|
3965
4333
|
400: Error;
|
|
3966
4334
|
/**
|
|
@@ -4036,7 +4404,7 @@ export type FieldsDeleteData = {
|
|
|
4036
4404
|
};
|
|
4037
4405
|
export type FieldsDeleteErrors = {
|
|
4038
4406
|
/**
|
|
4039
|
-
* The request was malformed.
|
|
4407
|
+
* 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).
|
|
4040
4408
|
*/
|
|
4041
4409
|
400: Error;
|
|
4042
4410
|
/**
|
|
@@ -4082,7 +4450,7 @@ export type FieldsGetData = {
|
|
|
4082
4450
|
};
|
|
4083
4451
|
export type FieldsGetErrors = {
|
|
4084
4452
|
/**
|
|
4085
|
-
* The request was malformed.
|
|
4453
|
+
* 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).
|
|
4086
4454
|
*/
|
|
4087
4455
|
400: Error;
|
|
4088
4456
|
/**
|
|
@@ -4150,7 +4518,7 @@ export type FieldsUpdateData = {
|
|
|
4150
4518
|
};
|
|
4151
4519
|
export type FieldsUpdateErrors = {
|
|
4152
4520
|
/**
|
|
4153
|
-
* The request was malformed.
|
|
4521
|
+
* 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).
|
|
4154
4522
|
*/
|
|
4155
4523
|
400: Error;
|
|
4156
4524
|
/**
|
|
@@ -4203,7 +4571,7 @@ export type FieldsGetOrderData = {
|
|
|
4203
4571
|
};
|
|
4204
4572
|
export type FieldsGetOrderErrors = {
|
|
4205
4573
|
/**
|
|
4206
|
-
* The request was malformed.
|
|
4574
|
+
* 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).
|
|
4207
4575
|
*/
|
|
4208
4576
|
400: Error;
|
|
4209
4577
|
/**
|
|
@@ -4276,7 +4644,7 @@ export type FieldsReorderData = {
|
|
|
4276
4644
|
};
|
|
4277
4645
|
export type FieldsReorderErrors = {
|
|
4278
4646
|
/**
|
|
4279
|
-
* The request was malformed.
|
|
4647
|
+
* 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).
|
|
4280
4648
|
*/
|
|
4281
4649
|
400: Error;
|
|
4282
4650
|
/**
|
|
@@ -4337,7 +4705,7 @@ export type FieldsRemoveAliasData = {
|
|
|
4337
4705
|
path: {
|
|
4338
4706
|
field_id: string;
|
|
4339
4707
|
/**
|
|
4340
|
-
* The old
|
|
4708
|
+
* The old key.
|
|
4341
4709
|
*/
|
|
4342
4710
|
alias: string;
|
|
4343
4711
|
};
|
|
@@ -4346,7 +4714,7 @@ export type FieldsRemoveAliasData = {
|
|
|
4346
4714
|
};
|
|
4347
4715
|
export type FieldsRemoveAliasErrors = {
|
|
4348
4716
|
/**
|
|
4349
|
-
* The request was malformed.
|
|
4717
|
+
* 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).
|
|
4350
4718
|
*/
|
|
4351
4719
|
400: Error;
|
|
4352
4720
|
/**
|
|
@@ -4418,7 +4786,7 @@ export type FieldsRestoreData = {
|
|
|
4418
4786
|
};
|
|
4419
4787
|
export type FieldsRestoreErrors = {
|
|
4420
4788
|
/**
|
|
4421
|
-
* The request was malformed.
|
|
4789
|
+
* 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).
|
|
4422
4790
|
*/
|
|
4423
4791
|
400: Error;
|
|
4424
4792
|
/**
|
|
@@ -4480,7 +4848,7 @@ export type MigrationsListData = {
|
|
|
4480
4848
|
};
|
|
4481
4849
|
export type MigrationsListErrors = {
|
|
4482
4850
|
/**
|
|
4483
|
-
* The request was malformed.
|
|
4851
|
+
* 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).
|
|
4484
4852
|
*/
|
|
4485
4853
|
400: Error;
|
|
4486
4854
|
/**
|
|
@@ -4512,7 +4880,7 @@ export type MigrationsListResponses = {
|
|
|
4512
4880
|
200: FieldMigrationList;
|
|
4513
4881
|
};
|
|
4514
4882
|
export type MigrationsListResponse = MigrationsListResponses[keyof MigrationsListResponses];
|
|
4515
|
-
export type
|
|
4883
|
+
export type MigrationsCreateData = {
|
|
4516
4884
|
body: FieldMigrationRequest;
|
|
4517
4885
|
headers?: {
|
|
4518
4886
|
/**
|
|
@@ -4541,16 +4909,19 @@ export type FieldsMigrateData = {
|
|
|
4541
4909
|
'Nohead-Change-Note'?: string;
|
|
4542
4910
|
};
|
|
4543
4911
|
path: {
|
|
4544
|
-
|
|
4912
|
+
/**
|
|
4913
|
+
* Collection ID, or the collection slug when authenticating with an API key.
|
|
4914
|
+
*/
|
|
4915
|
+
collection_id: string;
|
|
4545
4916
|
};
|
|
4546
4917
|
query?: {
|
|
4547
4918
|
dry_run?: boolean;
|
|
4548
4919
|
};
|
|
4549
|
-
url: '/v1/
|
|
4920
|
+
url: '/v1/collections/{collection_id}/migrations';
|
|
4550
4921
|
};
|
|
4551
|
-
export type
|
|
4922
|
+
export type MigrationsCreateErrors = {
|
|
4552
4923
|
/**
|
|
4553
|
-
* The request was malformed.
|
|
4924
|
+
* 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).
|
|
4554
4925
|
*/
|
|
4555
4926
|
400: Error;
|
|
4556
4927
|
/**
|
|
@@ -4582,8 +4953,8 @@ export type FieldsMigrateErrors = {
|
|
|
4582
4953
|
*/
|
|
4583
4954
|
429: Error;
|
|
4584
4955
|
};
|
|
4585
|
-
export type
|
|
4586
|
-
export type
|
|
4956
|
+
export type MigrationsCreateError = MigrationsCreateErrors[keyof MigrationsCreateErrors];
|
|
4957
|
+
export type MigrationsCreateResponses = {
|
|
4587
4958
|
/**
|
|
4588
4959
|
* A preview (dry runs only).
|
|
4589
4960
|
*/
|
|
@@ -4593,7 +4964,7 @@ export type FieldsMigrateResponses = {
|
|
|
4593
4964
|
*/
|
|
4594
4965
|
202: FieldMigration;
|
|
4595
4966
|
};
|
|
4596
|
-
export type
|
|
4967
|
+
export type MigrationsCreateResponse = MigrationsCreateResponses[keyof MigrationsCreateResponses];
|
|
4597
4968
|
export type MigrationsGetData = {
|
|
4598
4969
|
body?: never;
|
|
4599
4970
|
path: {
|
|
@@ -4604,7 +4975,7 @@ export type MigrationsGetData = {
|
|
|
4604
4975
|
};
|
|
4605
4976
|
export type MigrationsGetErrors = {
|
|
4606
4977
|
/**
|
|
4607
|
-
* The request was malformed.
|
|
4978
|
+
* 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).
|
|
4608
4979
|
*/
|
|
4609
4980
|
400: Error;
|
|
4610
4981
|
/**
|
|
@@ -4662,7 +5033,7 @@ export type MigrationsCancelData = {
|
|
|
4662
5033
|
};
|
|
4663
5034
|
export type MigrationsCancelErrors = {
|
|
4664
5035
|
/**
|
|
4665
|
-
* The request was malformed.
|
|
5036
|
+
* 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).
|
|
4666
5037
|
*/
|
|
4667
5038
|
400: Error;
|
|
4668
5039
|
/**
|
|
@@ -4714,21 +5085,27 @@ export type AssetsListData = {
|
|
|
4714
5085
|
cursor?: string;
|
|
4715
5086
|
/**
|
|
4716
5087
|
* `filter[deleted]=true` lists deleted assets instead.
|
|
4717
|
-
* `filter[content_type]` lists only assets of
|
|
4718
|
-
*
|
|
4719
|
-
*
|
|
5088
|
+
* `filter[content_type]` lists only assets of a type: a MIME type or a
|
|
5089
|
+
* `type*` wildcard, or several with
|
|
5090
|
+
* `filter[content_type][in]=image*,application/pdf`, for example the
|
|
5091
|
+
* ones an asset field accepts (its `accepted_types`).
|
|
4720
5092
|
*
|
|
4721
5093
|
*/
|
|
4722
5094
|
filter?: {
|
|
4723
5095
|
deleted?: 'true' | 'false';
|
|
4724
|
-
content_type?: string
|
|
5096
|
+
content_type?: string | {
|
|
5097
|
+
/**
|
|
5098
|
+
* Up to 50 comma-separated MIME types or `type*` wildcards.
|
|
5099
|
+
*/
|
|
5100
|
+
in: string;
|
|
5101
|
+
};
|
|
4725
5102
|
};
|
|
4726
5103
|
};
|
|
4727
5104
|
url: '/v1/projects/{project_id}/assets';
|
|
4728
5105
|
};
|
|
4729
5106
|
export type AssetsListErrors = {
|
|
4730
5107
|
/**
|
|
4731
|
-
* The request was malformed.
|
|
5108
|
+
* 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).
|
|
4732
5109
|
*/
|
|
4733
5110
|
400: Error;
|
|
4734
5111
|
/**
|
|
@@ -4786,7 +5163,7 @@ export type AssetsUploadData = {
|
|
|
4786
5163
|
};
|
|
4787
5164
|
export type AssetsUploadErrors = {
|
|
4788
5165
|
/**
|
|
4789
|
-
* The request was malformed.
|
|
5166
|
+
* 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).
|
|
4790
5167
|
*/
|
|
4791
5168
|
400: Error;
|
|
4792
5169
|
/**
|
|
@@ -4858,7 +5235,7 @@ export type AssetsCompleteData = {
|
|
|
4858
5235
|
};
|
|
4859
5236
|
export type AssetsCompleteErrors = {
|
|
4860
5237
|
/**
|
|
4861
|
-
* The request was malformed.
|
|
5238
|
+
* 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).
|
|
4862
5239
|
*/
|
|
4863
5240
|
400: Error;
|
|
4864
5241
|
/**
|
|
@@ -4924,7 +5301,7 @@ export type AssetsDeleteData = {
|
|
|
4924
5301
|
};
|
|
4925
5302
|
export type AssetsDeleteErrors = {
|
|
4926
5303
|
/**
|
|
4927
|
-
* The request was malformed.
|
|
5304
|
+
* 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).
|
|
4928
5305
|
*/
|
|
4929
5306
|
400: Error;
|
|
4930
5307
|
/**
|
|
@@ -4970,7 +5347,7 @@ export type AssetsGetData = {
|
|
|
4970
5347
|
};
|
|
4971
5348
|
export type AssetsGetErrors = {
|
|
4972
5349
|
/**
|
|
4973
|
-
* The request was malformed.
|
|
5350
|
+
* 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).
|
|
4974
5351
|
*/
|
|
4975
5352
|
400: Error;
|
|
4976
5353
|
/**
|
|
@@ -5021,7 +5398,7 @@ export type AssetsImageUrlData = {
|
|
|
5021
5398
|
};
|
|
5022
5399
|
export type AssetsImageUrlErrors = {
|
|
5023
5400
|
/**
|
|
5024
|
-
* The request was malformed.
|
|
5401
|
+
* 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).
|
|
5025
5402
|
*/
|
|
5026
5403
|
400: Error;
|
|
5027
5404
|
/**
|
|
@@ -5075,7 +5452,7 @@ export type AssetsDownloadUrlData = {
|
|
|
5075
5452
|
};
|
|
5076
5453
|
export type AssetsDownloadUrlErrors = {
|
|
5077
5454
|
/**
|
|
5078
|
-
* The request was malformed.
|
|
5455
|
+
* 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).
|
|
5079
5456
|
*/
|
|
5080
5457
|
400: Error;
|
|
5081
5458
|
/**
|
|
@@ -5121,7 +5498,7 @@ export type AssetsUsageData = {
|
|
|
5121
5498
|
};
|
|
5122
5499
|
export type AssetsUsageErrors = {
|
|
5123
5500
|
/**
|
|
5124
|
-
* The request was malformed.
|
|
5501
|
+
* 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).
|
|
5125
5502
|
*/
|
|
5126
5503
|
400: Error;
|
|
5127
5504
|
/**
|
|
@@ -5179,7 +5556,7 @@ export type AssetsRestoreData = {
|
|
|
5179
5556
|
};
|
|
5180
5557
|
export type AssetsRestoreErrors = {
|
|
5181
5558
|
/**
|
|
5182
|
-
* The request was malformed.
|
|
5559
|
+
* 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).
|
|
5183
5560
|
*/
|
|
5184
5561
|
400: Error;
|
|
5185
5562
|
/**
|
|
@@ -5241,7 +5618,7 @@ export type AssetsPurgeData = {
|
|
|
5241
5618
|
};
|
|
5242
5619
|
export type AssetsPurgeErrors = {
|
|
5243
5620
|
/**
|
|
5244
|
-
* The request was malformed.
|
|
5621
|
+
* 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).
|
|
5245
5622
|
*/
|
|
5246
5623
|
400: Error;
|
|
5247
5624
|
/**
|
|
@@ -5300,7 +5677,7 @@ export type CollectionsSearchData = {
|
|
|
5300
5677
|
cursor?: string;
|
|
5301
5678
|
/**
|
|
5302
5679
|
* `filter[<key>]=value` (equal), or `filter[<key>][<operator>]=value`;
|
|
5303
|
-
* filters combine with AND. Keys are field
|
|
5680
|
+
* filters combine with AND. Keys are field keys, `published_at`,
|
|
5304
5681
|
* `deleted` (`true` lists soft-deleted records instead) and, in record
|
|
5305
5682
|
* lists and counts, `created_at` and `updated_at`. In search,
|
|
5306
5683
|
* `published_at` takes only `exists`.
|
|
@@ -5330,7 +5707,7 @@ export type CollectionsSearchData = {
|
|
|
5330
5707
|
};
|
|
5331
5708
|
sort?: string;
|
|
5332
5709
|
/**
|
|
5333
|
-
* Comma-separated relation, asset or rich text field
|
|
5710
|
+
* Comma-separated relation, asset or rich text field keys whose records or assets to embed under `expanded` (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: `records:read` for relations, `assets:read` for assets and rich text (`403` otherwise).
|
|
5334
5711
|
*/
|
|
5335
5712
|
expand?: string;
|
|
5336
5713
|
};
|
|
@@ -5338,7 +5715,7 @@ export type CollectionsSearchData = {
|
|
|
5338
5715
|
};
|
|
5339
5716
|
export type CollectionsSearchErrors = {
|
|
5340
5717
|
/**
|
|
5341
|
-
* The request was malformed.
|
|
5718
|
+
* 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).
|
|
5342
5719
|
*/
|
|
5343
5720
|
400: Error;
|
|
5344
5721
|
/**
|
|
@@ -5414,7 +5791,7 @@ export type ProjectsSearchData = {
|
|
|
5414
5791
|
};
|
|
5415
5792
|
export type ProjectsSearchErrors = {
|
|
5416
5793
|
/**
|
|
5417
|
-
* The request was malformed.
|
|
5794
|
+
* 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).
|
|
5418
5795
|
*/
|
|
5419
5796
|
400: Error;
|
|
5420
5797
|
/**
|
|
@@ -5463,7 +5840,7 @@ export type SearchIndexGetData = {
|
|
|
5463
5840
|
};
|
|
5464
5841
|
export type SearchIndexGetErrors = {
|
|
5465
5842
|
/**
|
|
5466
|
-
* The request was malformed.
|
|
5843
|
+
* 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).
|
|
5467
5844
|
*/
|
|
5468
5845
|
400: Error;
|
|
5469
5846
|
/**
|
|
@@ -5524,7 +5901,7 @@ export type SearchIndexRebuildData = {
|
|
|
5524
5901
|
};
|
|
5525
5902
|
export type SearchIndexRebuildErrors = {
|
|
5526
5903
|
/**
|
|
5527
|
-
* The request was malformed.
|
|
5904
|
+
* 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).
|
|
5528
5905
|
*/
|
|
5529
5906
|
400: Error;
|
|
5530
5907
|
/**
|
|
@@ -5585,7 +5962,7 @@ export type WebhooksListData = {
|
|
|
5585
5962
|
};
|
|
5586
5963
|
export type WebhooksListErrors = {
|
|
5587
5964
|
/**
|
|
5588
|
-
* The request was malformed.
|
|
5965
|
+
* 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).
|
|
5589
5966
|
*/
|
|
5590
5967
|
400: Error;
|
|
5591
5968
|
/**
|
|
@@ -5643,7 +6020,7 @@ export type WebhooksCreateData = {
|
|
|
5643
6020
|
};
|
|
5644
6021
|
export type WebhooksCreateErrors = {
|
|
5645
6022
|
/**
|
|
5646
|
-
* The request was malformed.
|
|
6023
|
+
* 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).
|
|
5647
6024
|
*/
|
|
5648
6025
|
400: Error;
|
|
5649
6026
|
/**
|
|
@@ -5715,7 +6092,7 @@ export type WebhooksDeleteData = {
|
|
|
5715
6092
|
};
|
|
5716
6093
|
export type WebhooksDeleteErrors = {
|
|
5717
6094
|
/**
|
|
5718
|
-
* The request was malformed.
|
|
6095
|
+
* 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).
|
|
5719
6096
|
*/
|
|
5720
6097
|
400: Error;
|
|
5721
6098
|
/**
|
|
@@ -5761,7 +6138,7 @@ export type WebhooksGetData = {
|
|
|
5761
6138
|
};
|
|
5762
6139
|
export type WebhooksGetErrors = {
|
|
5763
6140
|
/**
|
|
5764
|
-
* The request was malformed.
|
|
6141
|
+
* 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).
|
|
5765
6142
|
*/
|
|
5766
6143
|
400: Error;
|
|
5767
6144
|
/**
|
|
@@ -5819,7 +6196,7 @@ export type WebhooksUpdateData = {
|
|
|
5819
6196
|
};
|
|
5820
6197
|
export type WebhooksUpdateErrors = {
|
|
5821
6198
|
/**
|
|
5822
|
-
* The request was malformed.
|
|
6199
|
+
* 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).
|
|
5823
6200
|
*/
|
|
5824
6201
|
400: Error;
|
|
5825
6202
|
/**
|
|
@@ -5885,7 +6262,7 @@ export type WebhooksTestData = {
|
|
|
5885
6262
|
};
|
|
5886
6263
|
export type WebhooksTestErrors = {
|
|
5887
6264
|
/**
|
|
5888
|
-
* The request was malformed.
|
|
6265
|
+
* 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).
|
|
5889
6266
|
*/
|
|
5890
6267
|
400: Error;
|
|
5891
6268
|
/**
|
|
@@ -5940,7 +6317,7 @@ export type WebhookSecretsListData = {
|
|
|
5940
6317
|
};
|
|
5941
6318
|
export type WebhookSecretsListErrors = {
|
|
5942
6319
|
/**
|
|
5943
|
-
* The request was malformed.
|
|
6320
|
+
* 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).
|
|
5944
6321
|
*/
|
|
5945
6322
|
400: Error;
|
|
5946
6323
|
/**
|
|
@@ -5998,7 +6375,7 @@ export type WebhooksRotateSecretData = {
|
|
|
5998
6375
|
};
|
|
5999
6376
|
export type WebhooksRotateSecretErrors = {
|
|
6000
6377
|
/**
|
|
6001
|
-
* The request was malformed.
|
|
6378
|
+
* 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).
|
|
6002
6379
|
*/
|
|
6003
6380
|
400: Error;
|
|
6004
6381
|
/**
|
|
@@ -6060,7 +6437,7 @@ export type WebhookSecretsRetireData = {
|
|
|
6060
6437
|
};
|
|
6061
6438
|
export type WebhookSecretsRetireErrors = {
|
|
6062
6439
|
/**
|
|
6063
|
-
* The request was malformed.
|
|
6440
|
+
* 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).
|
|
6064
6441
|
*/
|
|
6065
6442
|
400: Error;
|
|
6066
6443
|
/**
|
|
@@ -6122,7 +6499,7 @@ export type WebhooksRestoreData = {
|
|
|
6122
6499
|
};
|
|
6123
6500
|
export type WebhooksRestoreErrors = {
|
|
6124
6501
|
/**
|
|
6125
|
-
* The request was malformed.
|
|
6502
|
+
* 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).
|
|
6126
6503
|
*/
|
|
6127
6504
|
400: Error;
|
|
6128
6505
|
/**
|
|
@@ -6186,7 +6563,7 @@ export type WebhookDeliveriesListData = {
|
|
|
6186
6563
|
};
|
|
6187
6564
|
export type WebhookDeliveriesListErrors = {
|
|
6188
6565
|
/**
|
|
6189
|
-
* The request was malformed.
|
|
6566
|
+
* 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).
|
|
6190
6567
|
*/
|
|
6191
6568
|
400: Error;
|
|
6192
6569
|
/**
|
|
@@ -6228,7 +6605,7 @@ export type WebhookDeliveriesGetData = {
|
|
|
6228
6605
|
};
|
|
6229
6606
|
export type WebhookDeliveriesGetErrors = {
|
|
6230
6607
|
/**
|
|
6231
|
-
* The request was malformed.
|
|
6608
|
+
* 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).
|
|
6232
6609
|
*/
|
|
6233
6610
|
400: Error;
|
|
6234
6611
|
/**
|
|
@@ -6286,7 +6663,7 @@ export type WebhookDeliveriesRetryData = {
|
|
|
6286
6663
|
};
|
|
6287
6664
|
export type WebhookDeliveriesRetryErrors = {
|
|
6288
6665
|
/**
|
|
6289
|
-
* The request was malformed.
|
|
6666
|
+
* 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).
|
|
6290
6667
|
*/
|
|
6291
6668
|
400: Error;
|
|
6292
6669
|
/**
|
|
@@ -6359,13 +6736,13 @@ export type AuditEventsListData = {
|
|
|
6359
6736
|
actor_id?: string;
|
|
6360
6737
|
created_at?: TimeFilter;
|
|
6361
6738
|
};
|
|
6362
|
-
sort?: '
|
|
6739
|
+
sort?: 'created_at' | '-created_at';
|
|
6363
6740
|
};
|
|
6364
6741
|
url: '/v1/projects/{project_id}/audit-events';
|
|
6365
6742
|
};
|
|
6366
6743
|
export type AuditEventsListErrors = {
|
|
6367
6744
|
/**
|
|
6368
|
-
* The request was malformed.
|
|
6745
|
+
* 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).
|
|
6369
6746
|
*/
|
|
6370
6747
|
400: Error;
|
|
6371
6748
|
/**
|
|
@@ -6453,7 +6830,7 @@ export type FeatureFlagsListData = {
|
|
|
6453
6830
|
};
|
|
6454
6831
|
export type FeatureFlagsListErrors = {
|
|
6455
6832
|
/**
|
|
6456
|
-
* The request was malformed.
|
|
6833
|
+
* 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).
|
|
6457
6834
|
*/
|
|
6458
6835
|
400: Error;
|
|
6459
6836
|
/**
|