@datocms/cma-client 5.1.11 → 5.1.13
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/README.md +313 -178
- package/dist/cjs/fieldTypes/file.js +6 -6
- package/dist/cjs/fieldTypes/gallery.js +7 -7
- package/dist/cjs/fieldTypes/rich_text.js +14 -12
- package/dist/cjs/fieldTypes/rich_text.js.map +1 -1
- package/dist/cjs/fieldTypes/schema.js +3 -0
- package/dist/cjs/fieldTypes/schema.js.map +1 -0
- package/dist/cjs/fieldTypes/single_block.js +13 -12
- package/dist/cjs/fieldTypes/single_block.js.map +1 -1
- package/dist/cjs/fieldTypes/structured_text.js +13 -12
- package/dist/cjs/fieldTypes/structured_text.js.map +1 -1
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/utilities/buildBlockRecord.js +1 -46
- package/dist/cjs/utilities/buildBlockRecord.js.map +1 -1
- package/dist/cjs/utilities/duplicateBlockRecord.js +50 -0
- package/dist/cjs/utilities/duplicateBlockRecord.js.map +1 -0
- package/dist/cjs/utilities/inspectItem.js +50 -20
- package/dist/cjs/utilities/inspectItem.js.map +1 -1
- package/dist/cjs/utilities/nonRecursiveBlocks.js +1 -170
- package/dist/cjs/utilities/nonRecursiveBlocks.js.map +1 -1
- package/dist/cjs/utilities/recursiveBlocks.js +52 -112
- package/dist/cjs/utilities/recursiveBlocks.js.map +1 -1
- package/dist/esm/fieldTypes/file.d.ts +3 -3
- package/dist/esm/fieldTypes/file.js +3 -3
- package/dist/esm/fieldTypes/gallery.d.ts +5 -5
- package/dist/esm/fieldTypes/gallery.js +5 -5
- package/dist/esm/fieldTypes/rich_text.d.ts +8 -9
- package/dist/esm/fieldTypes/rich_text.js +9 -7
- package/dist/esm/fieldTypes/rich_text.js.map +1 -1
- package/dist/esm/fieldTypes/schema.d.ts +59 -0
- package/dist/esm/fieldTypes/schema.js +2 -0
- package/dist/esm/fieldTypes/schema.js.map +1 -0
- package/dist/esm/fieldTypes/single_block.d.ts +30 -15
- package/dist/esm/fieldTypes/single_block.js +8 -7
- package/dist/esm/fieldTypes/single_block.js.map +1 -1
- package/dist/esm/fieldTypes/structured_text.d.ts +14 -15
- package/dist/esm/fieldTypes/structured_text.js +8 -7
- package/dist/esm/fieldTypes/structured_text.js.map +1 -1
- package/dist/esm/generated/ApiTypes.d.ts +94 -980
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +160 -999
- package/dist/esm/generated/resources/Field.d.ts +300 -300
- package/dist/esm/generated/resources/Item.d.ts +34 -34
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.d.ts +3 -1
- package/dist/esm/generated/resources/ScheduledPublication.d.ts +3 -3
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +3 -3
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/resources/Upload.d.ts +6 -6
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/utilities/buildBlockRecord.d.ts +11 -5
- package/dist/esm/utilities/buildBlockRecord.js +0 -44
- package/dist/esm/utilities/buildBlockRecord.js.map +1 -1
- package/dist/esm/utilities/duplicateBlockRecord.d.ts +6 -0
- package/dist/esm/utilities/duplicateBlockRecord.js +46 -0
- package/dist/esm/utilities/duplicateBlockRecord.js.map +1 -0
- package/dist/esm/utilities/inspectItem.d.ts +3 -3
- package/dist/esm/utilities/inspectItem.js +28 -21
- package/dist/esm/utilities/inspectItem.js.map +1 -1
- package/dist/esm/utilities/itemDefinition.d.ts +25 -27
- package/dist/esm/utilities/nonRecursiveBlocks.d.ts +10 -75
- package/dist/esm/utilities/nonRecursiveBlocks.js +1 -164
- package/dist/esm/utilities/nonRecursiveBlocks.js.map +1 -1
- package/dist/esm/utilities/recursiveBlocks.d.ts +53 -23
- package/dist/esm/utilities/recursiveBlocks.js +52 -112
- package/dist/esm/utilities/recursiveBlocks.js.map +1 -1
- package/dist/types/fieldTypes/file.d.ts +3 -3
- package/dist/types/fieldTypes/gallery.d.ts +5 -5
- package/dist/types/fieldTypes/rich_text.d.ts +8 -9
- package/dist/types/fieldTypes/schema.d.ts +59 -0
- package/dist/types/fieldTypes/single_block.d.ts +30 -15
- package/dist/types/fieldTypes/structured_text.d.ts +14 -15
- package/dist/types/generated/ApiTypes.d.ts +94 -980
- package/dist/types/generated/RawApiTypes.d.ts +160 -999
- package/dist/types/generated/resources/Field.d.ts +300 -300
- package/dist/types/generated/resources/Item.d.ts +34 -34
- package/dist/types/generated/resources/ItemVersion.d.ts +3 -1
- package/dist/types/generated/resources/ScheduledPublication.d.ts +3 -3
- package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +3 -3
- package/dist/types/generated/resources/Upload.d.ts +6 -6
- package/dist/types/index.d.ts +1 -0
- package/dist/types/utilities/buildBlockRecord.d.ts +11 -5
- package/dist/types/utilities/duplicateBlockRecord.d.ts +6 -0
- package/dist/types/utilities/inspectItem.d.ts +3 -3
- package/dist/types/utilities/itemDefinition.d.ts +25 -27
- package/dist/types/utilities/nonRecursiveBlocks.d.ts +10 -75
- package/dist/types/utilities/recursiveBlocks.d.ts +53 -23
- package/package.json +4 -4
- package/src/fieldTypes/file.ts +6 -6
- package/src/fieldTypes/gallery.ts +10 -10
- package/src/fieldTypes/rich_text.ts +26 -24
- package/src/fieldTypes/schema.ts +657 -0
- package/src/fieldTypes/single_block.ts +61 -38
- package/src/fieldTypes/structured_text.ts +57 -51
- package/src/generated/ApiTypes.ts +221 -1880
- package/src/generated/Client.ts +1 -1
- package/src/generated/RawApiTypes.ts +276 -2113
- package/src/generated/resources/Item.ts +93 -187
- package/src/generated/resources/ScheduledPublication.ts +4 -15
- package/src/generated/resources/ScheduledUnpublishing.ts +4 -15
- package/src/generated/resources/Upload.ts +9 -32
- package/src/index.ts +1 -0
- package/src/utilities/buildBlockRecord.ts +16 -56
- package/src/utilities/duplicateBlockRecord.ts +53 -0
- package/src/utilities/inspectItem.ts +64 -52
- package/src/utilities/itemDefinition.ts +109 -98
- package/src/utilities/nonRecursiveBlocks.ts +25 -279
- package/src/utilities/recursiveBlocks.ts +337 -72
|
@@ -1,11 +1,6 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type {
|
|
4
|
-
ItemTypeDefinition,
|
|
5
|
-
ToItemDefinition,
|
|
6
|
-
ToItemDefinitionAsRequest,
|
|
7
|
-
ToItemDefinitionWithNestedBlocks,
|
|
8
|
-
} from '../../utilities/itemDefinition';
|
|
3
|
+
import type { ItemTypeDefinition } from '../../utilities/itemDefinition';
|
|
9
4
|
import type * as ApiTypes from '../ApiTypes';
|
|
10
5
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
11
6
|
|
|
@@ -24,16 +19,12 @@ export default class Item extends BaseResource {
|
|
|
24
19
|
*/
|
|
25
20
|
list<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
26
21
|
queryParams: ApiTypes.ItemInstancesHrefSchema & { nested: true },
|
|
27
|
-
): Promise<
|
|
28
|
-
ApiTypes.ItemInstancesTargetSchema<
|
|
29
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
30
|
-
>
|
|
31
|
-
>;
|
|
22
|
+
): Promise<ApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
|
|
32
23
|
list<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
33
24
|
queryParams?: ApiTypes.ItemInstancesHrefSchema & {
|
|
34
25
|
nested?: false | undefined;
|
|
35
26
|
},
|
|
36
|
-
): Promise<ApiTypes.ItemInstancesTargetSchema<
|
|
27
|
+
): Promise<ApiTypes.ItemInstancesTargetSchema<NoInfer<D>, false>>;
|
|
37
28
|
/**
|
|
38
29
|
* List all records
|
|
39
30
|
*
|
|
@@ -60,25 +51,15 @@ export default class Item extends BaseResource {
|
|
|
60
51
|
*/
|
|
61
52
|
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
62
53
|
queryParams: RawApiTypes.ItemInstancesHrefSchema & { nested: true },
|
|
63
|
-
): Promise<
|
|
64
|
-
RawApiTypes.ItemInstancesTargetSchema<
|
|
65
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
66
|
-
>
|
|
67
|
-
>;
|
|
54
|
+
): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
|
|
68
55
|
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
69
56
|
queryParams?: RawApiTypes.ItemInstancesHrefSchema & {
|
|
70
57
|
nested?: false | undefined;
|
|
71
58
|
},
|
|
72
|
-
): Promise<
|
|
73
|
-
RawApiTypes.ItemInstancesTargetSchema<ToItemDefinition<NoInfer<D>>>
|
|
74
|
-
>;
|
|
59
|
+
): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, false>>;
|
|
75
60
|
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
76
61
|
queryParams?: RawApiTypes.ItemInstancesHrefSchema,
|
|
77
|
-
): Promise<
|
|
78
|
-
RawApiTypes.ItemInstancesTargetSchema<
|
|
79
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
80
|
-
>
|
|
81
|
-
>;
|
|
62
|
+
): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
|
|
82
63
|
/**
|
|
83
64
|
* List all records
|
|
84
65
|
*
|
|
@@ -96,11 +77,9 @@ export default class Item extends BaseResource {
|
|
|
96
77
|
url: '/items',
|
|
97
78
|
queryParams,
|
|
98
79
|
})
|
|
99
|
-
.then<
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
>
|
|
103
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
80
|
+
.then<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>(
|
|
81
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
82
|
+
);
|
|
104
83
|
}
|
|
105
84
|
|
|
106
85
|
/**
|
|
@@ -123,9 +102,7 @@ export default class Item extends BaseResource {
|
|
|
123
102
|
iteratorOptions,
|
|
124
103
|
)) {
|
|
125
104
|
yield Utils.deserializeJsonEntity<
|
|
126
|
-
ApiTypes.ItemInstancesTargetSchema<
|
|
127
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
128
|
-
>[0]
|
|
105
|
+
ApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>[0]
|
|
129
106
|
>(element);
|
|
130
107
|
}
|
|
131
108
|
}
|
|
@@ -148,9 +125,7 @@ export default class Item extends BaseResource {
|
|
|
148
125
|
Utils.warnOnPageQueryParam(queryParams);
|
|
149
126
|
|
|
150
127
|
return Utils.rawPageIterator<
|
|
151
|
-
RawApiTypes.ItemInstancesTargetSchema<
|
|
152
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
153
|
-
>['data'][0]
|
|
128
|
+
RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>['data'][0]
|
|
154
129
|
>(
|
|
155
130
|
{
|
|
156
131
|
defaultLimit: 30,
|
|
@@ -175,16 +150,12 @@ export default class Item extends BaseResource {
|
|
|
175
150
|
*/
|
|
176
151
|
validateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
177
152
|
itemId: string | ApiTypes.ItemData,
|
|
178
|
-
body: ApiTypes.ItemValidateExistingSchema<
|
|
179
|
-
ToItemDefinitionAsRequest<NoInfer<D>>
|
|
180
|
-
>,
|
|
153
|
+
body: ApiTypes.ItemValidateExistingSchema<NoInfer<D>>,
|
|
181
154
|
) {
|
|
182
155
|
return this.rawValidateExisting(
|
|
183
156
|
Utils.toId(itemId),
|
|
184
157
|
Utils.serializeRequestBody<
|
|
185
|
-
RawApiTypes.ItemValidateExistingSchema<
|
|
186
|
-
ToItemDefinitionAsRequest<NoInfer<D>>
|
|
187
|
-
>
|
|
158
|
+
RawApiTypes.ItemValidateExistingSchema<NoInfer<D>>
|
|
188
159
|
>(body, {
|
|
189
160
|
id: Utils.toId(itemId),
|
|
190
161
|
type: 'item',
|
|
@@ -206,9 +177,7 @@ export default class Item extends BaseResource {
|
|
|
206
177
|
*/
|
|
207
178
|
rawValidateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
208
179
|
itemId: string,
|
|
209
|
-
body: RawApiTypes.ItemValidateExistingSchema<
|
|
210
|
-
ToItemDefinitionAsRequest<NoInfer<D>>
|
|
211
|
-
>,
|
|
180
|
+
body: RawApiTypes.ItemValidateExistingSchema<NoInfer<D>>,
|
|
212
181
|
): Promise<void> {
|
|
213
182
|
return this.client.request<void>({
|
|
214
183
|
method: 'POST',
|
|
@@ -228,16 +197,17 @@ export default class Item extends BaseResource {
|
|
|
228
197
|
* @deprecated This API call is to be considered private and might change without notice
|
|
229
198
|
*/
|
|
230
199
|
validateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
231
|
-
body: ApiTypes.ItemValidateNewSchema<
|
|
200
|
+
body: ApiTypes.ItemValidateNewSchema<NoInfer<D>>,
|
|
232
201
|
) {
|
|
233
202
|
return this.rawValidateNew(
|
|
234
|
-
Utils.serializeRequestBody<
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
203
|
+
Utils.serializeRequestBody<RawApiTypes.ItemValidateNewSchema<NoInfer<D>>>(
|
|
204
|
+
body,
|
|
205
|
+
{
|
|
206
|
+
type: 'item',
|
|
207
|
+
attributes: '*',
|
|
208
|
+
relationships: ['item_type', 'creator'],
|
|
209
|
+
},
|
|
210
|
+
),
|
|
241
211
|
);
|
|
242
212
|
}
|
|
243
213
|
|
|
@@ -252,9 +222,7 @@ export default class Item extends BaseResource {
|
|
|
252
222
|
* @deprecated This API call is to be considered private and might change without notice
|
|
253
223
|
*/
|
|
254
224
|
rawValidateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
255
|
-
body: RawApiTypes.ItemValidateNewSchema<
|
|
256
|
-
ToItemDefinitionAsRequest<NoInfer<D>>
|
|
257
|
-
>,
|
|
225
|
+
body: RawApiTypes.ItemValidateNewSchema<NoInfer<D>>,
|
|
258
226
|
): Promise<void> {
|
|
259
227
|
return this.client.request<void>({
|
|
260
228
|
method: 'POST',
|
|
@@ -272,19 +240,20 @@ export default class Item extends BaseResource {
|
|
|
272
240
|
* @throws {TimeoutError}
|
|
273
241
|
*/
|
|
274
242
|
create<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
275
|
-
body: ApiTypes.ItemCreateSchema<
|
|
243
|
+
body: ApiTypes.ItemCreateSchema<NoInfer<D>>,
|
|
276
244
|
) {
|
|
277
245
|
return this.rawCreate<D>(
|
|
278
|
-
Utils.serializeRequestBody<
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
246
|
+
Utils.serializeRequestBody<RawApiTypes.ItemCreateSchema<NoInfer<D>>>(
|
|
247
|
+
body,
|
|
248
|
+
{
|
|
249
|
+
type: 'item',
|
|
250
|
+
attributes: '*',
|
|
251
|
+
relationships: ['item_type', 'creator'],
|
|
252
|
+
},
|
|
253
|
+
),
|
|
285
254
|
).then((body) =>
|
|
286
255
|
Utils.deserializeResponseBody<
|
|
287
|
-
ApiTypes.ItemCreateTargetSchema<
|
|
256
|
+
ApiTypes.ItemCreateTargetSchema<NoInfer<D>>
|
|
288
257
|
>(body),
|
|
289
258
|
);
|
|
290
259
|
}
|
|
@@ -298,23 +267,17 @@ export default class Item extends BaseResource {
|
|
|
298
267
|
* @throws {TimeoutError}
|
|
299
268
|
*/
|
|
300
269
|
rawCreate<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
301
|
-
body: RawApiTypes.ItemCreateSchema<
|
|
302
|
-
): Promise<
|
|
303
|
-
RawApiTypes.ItemCreateTargetSchema<
|
|
304
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
305
|
-
>
|
|
306
|
-
> {
|
|
270
|
+
body: RawApiTypes.ItemCreateSchema<NoInfer<D>>,
|
|
271
|
+
): Promise<RawApiTypes.ItemCreateTargetSchema<NoInfer<D>, true>> {
|
|
307
272
|
return this.client
|
|
308
273
|
.request({
|
|
309
274
|
method: 'POST',
|
|
310
275
|
url: '/items',
|
|
311
276
|
body: Utils.serializeRawRequestBodyWithItems(body),
|
|
312
277
|
})
|
|
313
|
-
.then<
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
>
|
|
317
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
278
|
+
.then<RawApiTypes.ItemCreateTargetSchema<NoInfer<D>, true>>(
|
|
279
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
280
|
+
);
|
|
318
281
|
}
|
|
319
282
|
|
|
320
283
|
/**
|
|
@@ -330,7 +293,7 @@ export default class Item extends BaseResource {
|
|
|
330
293
|
) {
|
|
331
294
|
return this.rawDuplicate<D>(Utils.toId(itemId)).then((body) =>
|
|
332
295
|
Utils.deserializeResponseBody<
|
|
333
|
-
ApiTypes.ItemDuplicateJobSchema<
|
|
296
|
+
ApiTypes.ItemDuplicateJobSchema<NoInfer<D>>
|
|
334
297
|
>(body),
|
|
335
298
|
);
|
|
336
299
|
}
|
|
@@ -345,21 +308,15 @@ export default class Item extends BaseResource {
|
|
|
345
308
|
*/
|
|
346
309
|
rawDuplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
347
310
|
itemId: string,
|
|
348
|
-
): Promise<
|
|
349
|
-
RawApiTypes.ItemDuplicateJobSchema<
|
|
350
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
351
|
-
>
|
|
352
|
-
> {
|
|
311
|
+
): Promise<RawApiTypes.ItemDuplicateJobSchema<NoInfer<D>, true>> {
|
|
353
312
|
return this.client
|
|
354
313
|
.request({
|
|
355
314
|
method: 'POST',
|
|
356
315
|
url: `/items/${itemId}/duplicate`,
|
|
357
316
|
})
|
|
358
|
-
.then<
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
>
|
|
362
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
317
|
+
.then<RawApiTypes.ItemDuplicateJobSchema<NoInfer<D>, true>>(
|
|
318
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
319
|
+
);
|
|
363
320
|
}
|
|
364
321
|
|
|
365
322
|
/**
|
|
@@ -372,21 +329,22 @@ export default class Item extends BaseResource {
|
|
|
372
329
|
*/
|
|
373
330
|
update<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
374
331
|
itemId: string | ApiTypes.ItemData,
|
|
375
|
-
body: ApiTypes.ItemUpdateSchema<
|
|
332
|
+
body: ApiTypes.ItemUpdateSchema<NoInfer<D>>,
|
|
376
333
|
) {
|
|
377
334
|
return this.rawUpdate<D>(
|
|
378
335
|
Utils.toId(itemId),
|
|
379
|
-
Utils.serializeRequestBody<
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
336
|
+
Utils.serializeRequestBody<RawApiTypes.ItemUpdateSchema<NoInfer<D>>>(
|
|
337
|
+
body,
|
|
338
|
+
{
|
|
339
|
+
id: Utils.toId(itemId),
|
|
340
|
+
type: 'item',
|
|
341
|
+
attributes: '*',
|
|
342
|
+
relationships: ['item_type', 'creator'],
|
|
343
|
+
},
|
|
344
|
+
),
|
|
387
345
|
).then((body) =>
|
|
388
346
|
Utils.deserializeResponseBody<
|
|
389
|
-
ApiTypes.ItemUpdateTargetSchema<
|
|
347
|
+
ApiTypes.ItemUpdateTargetSchema<NoInfer<D>>
|
|
390
348
|
>(body),
|
|
391
349
|
);
|
|
392
350
|
}
|
|
@@ -401,23 +359,17 @@ export default class Item extends BaseResource {
|
|
|
401
359
|
*/
|
|
402
360
|
rawUpdate<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
403
361
|
itemId: string,
|
|
404
|
-
body: RawApiTypes.ItemUpdateSchema<
|
|
405
|
-
): Promise<
|
|
406
|
-
RawApiTypes.ItemUpdateTargetSchema<
|
|
407
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
408
|
-
>
|
|
409
|
-
> {
|
|
362
|
+
body: RawApiTypes.ItemUpdateSchema<NoInfer<D>>,
|
|
363
|
+
): Promise<RawApiTypes.ItemUpdateTargetSchema<NoInfer<D>, true>> {
|
|
410
364
|
return this.client
|
|
411
365
|
.request({
|
|
412
366
|
method: 'PUT',
|
|
413
367
|
url: `/items/${itemId}`,
|
|
414
368
|
body: Utils.serializeRawRequestBodyWithItems(body),
|
|
415
369
|
})
|
|
416
|
-
.then<
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
>
|
|
420
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
370
|
+
.then<RawApiTypes.ItemUpdateTargetSchema<NoInfer<D>, true>>(
|
|
371
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
372
|
+
);
|
|
421
373
|
}
|
|
422
374
|
|
|
423
375
|
/**
|
|
@@ -431,17 +383,13 @@ export default class Item extends BaseResource {
|
|
|
431
383
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
432
384
|
itemId: string | ApiTypes.ItemData,
|
|
433
385
|
queryParams: ApiTypes.ItemReferencesHrefSchema & { nested: true },
|
|
434
|
-
): Promise<
|
|
435
|
-
ApiTypes.ItemReferencesTargetSchema<
|
|
436
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
437
|
-
>
|
|
438
|
-
>;
|
|
386
|
+
): Promise<ApiTypes.ItemReferencesTargetSchema<NoInfer<D>, true>>;
|
|
439
387
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
440
388
|
itemId: string | ApiTypes.ItemData,
|
|
441
389
|
queryParams?: ApiTypes.ItemReferencesHrefSchema & {
|
|
442
390
|
nested?: false | undefined;
|
|
443
391
|
},
|
|
444
|
-
): Promise<ApiTypes.ItemReferencesTargetSchema<
|
|
392
|
+
): Promise<ApiTypes.ItemReferencesTargetSchema<NoInfer<D>, false>>;
|
|
445
393
|
/**
|
|
446
394
|
* Referenced records
|
|
447
395
|
*
|
|
@@ -470,27 +418,17 @@ export default class Item extends BaseResource {
|
|
|
470
418
|
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
471
419
|
itemId: string,
|
|
472
420
|
queryParams: RawApiTypes.ItemReferencesHrefSchema & { nested: true },
|
|
473
|
-
): Promise<
|
|
474
|
-
RawApiTypes.ItemReferencesTargetSchema<
|
|
475
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
476
|
-
>
|
|
477
|
-
>;
|
|
421
|
+
): Promise<RawApiTypes.ItemReferencesTargetSchema<NoInfer<D>, true>>;
|
|
478
422
|
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
479
423
|
itemId: string,
|
|
480
424
|
queryParams?: RawApiTypes.ItemReferencesHrefSchema & {
|
|
481
425
|
nested?: false | undefined;
|
|
482
426
|
},
|
|
483
|
-
): Promise<
|
|
484
|
-
RawApiTypes.ItemReferencesTargetSchema<ToItemDefinition<NoInfer<D>>>
|
|
485
|
-
>;
|
|
427
|
+
): Promise<RawApiTypes.ItemReferencesTargetSchema<NoInfer<D>, false>>;
|
|
486
428
|
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
487
429
|
itemId: string,
|
|
488
430
|
queryParams?: RawApiTypes.ItemReferencesHrefSchema,
|
|
489
|
-
): Promise<
|
|
490
|
-
RawApiTypes.ItemReferencesTargetSchema<
|
|
491
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
492
|
-
>
|
|
493
|
-
>;
|
|
431
|
+
): Promise<RawApiTypes.ItemReferencesTargetSchema<NoInfer<D>, true>>;
|
|
494
432
|
/**
|
|
495
433
|
* Referenced records
|
|
496
434
|
*
|
|
@@ -509,11 +447,9 @@ export default class Item extends BaseResource {
|
|
|
509
447
|
url: `/items/${itemId}/references`,
|
|
510
448
|
queryParams,
|
|
511
449
|
})
|
|
512
|
-
.then<
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
>
|
|
516
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
450
|
+
.then<RawApiTypes.ItemReferencesTargetSchema<NoInfer<D>, true>>(
|
|
451
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
452
|
+
);
|
|
517
453
|
}
|
|
518
454
|
|
|
519
455
|
/**
|
|
@@ -527,13 +463,11 @@ export default class Item extends BaseResource {
|
|
|
527
463
|
find<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
528
464
|
itemId: string | ApiTypes.ItemData,
|
|
529
465
|
queryParams: ApiTypes.ItemSelfHrefSchema & { nested: true },
|
|
530
|
-
): Promise<
|
|
531
|
-
ApiTypes.ItemSelfTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>
|
|
532
|
-
>;
|
|
466
|
+
): Promise<ApiTypes.ItemSelfTargetSchema<NoInfer<D>, true>>;
|
|
533
467
|
find<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
534
468
|
itemId: string | ApiTypes.ItemData,
|
|
535
469
|
queryParams?: ApiTypes.ItemSelfHrefSchema & { nested?: false | undefined },
|
|
536
|
-
): Promise<ApiTypes.ItemSelfTargetSchema<
|
|
470
|
+
): Promise<ApiTypes.ItemSelfTargetSchema<NoInfer<D>, false>>;
|
|
537
471
|
/**
|
|
538
472
|
* Retrieve a record
|
|
539
473
|
*
|
|
@@ -562,25 +496,17 @@ export default class Item extends BaseResource {
|
|
|
562
496
|
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
563
497
|
itemId: string,
|
|
564
498
|
queryParams: RawApiTypes.ItemSelfHrefSchema & { nested: true },
|
|
565
|
-
): Promise<
|
|
566
|
-
RawApiTypes.ItemSelfTargetSchema<
|
|
567
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
568
|
-
>
|
|
569
|
-
>;
|
|
499
|
+
): Promise<RawApiTypes.ItemSelfTargetSchema<NoInfer<D>, true>>;
|
|
570
500
|
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
571
501
|
itemId: string,
|
|
572
502
|
queryParams?: RawApiTypes.ItemSelfHrefSchema & {
|
|
573
503
|
nested?: false | undefined;
|
|
574
504
|
},
|
|
575
|
-
): Promise<RawApiTypes.ItemSelfTargetSchema<
|
|
505
|
+
): Promise<RawApiTypes.ItemSelfTargetSchema<NoInfer<D>, false>>;
|
|
576
506
|
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
577
507
|
itemId: string,
|
|
578
508
|
queryParams?: RawApiTypes.ItemSelfHrefSchema,
|
|
579
|
-
): Promise<
|
|
580
|
-
RawApiTypes.ItemSelfTargetSchema<
|
|
581
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
582
|
-
>
|
|
583
|
-
>;
|
|
509
|
+
): Promise<RawApiTypes.ItemSelfTargetSchema<NoInfer<D>, true>>;
|
|
584
510
|
/**
|
|
585
511
|
* Retrieve a record
|
|
586
512
|
*
|
|
@@ -599,11 +525,9 @@ export default class Item extends BaseResource {
|
|
|
599
525
|
url: `/items/${itemId}`,
|
|
600
526
|
queryParams,
|
|
601
527
|
})
|
|
602
|
-
.then<
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
>
|
|
606
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
528
|
+
.then<RawApiTypes.ItemSelfTargetSchema<NoInfer<D>, true>>(
|
|
529
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
530
|
+
);
|
|
607
531
|
}
|
|
608
532
|
|
|
609
533
|
/**
|
|
@@ -657,9 +581,9 @@ export default class Item extends BaseResource {
|
|
|
657
581
|
itemId: string | ApiTypes.ItemData,
|
|
658
582
|
) {
|
|
659
583
|
return this.rawDestroy<D>(Utils.toId(itemId)).then((body) =>
|
|
660
|
-
Utils.deserializeResponseBody<
|
|
661
|
-
|
|
662
|
-
|
|
584
|
+
Utils.deserializeResponseBody<ApiTypes.ItemDestroyJobSchema<NoInfer<D>>>(
|
|
585
|
+
body,
|
|
586
|
+
),
|
|
663
587
|
);
|
|
664
588
|
}
|
|
665
589
|
|
|
@@ -673,21 +597,15 @@ export default class Item extends BaseResource {
|
|
|
673
597
|
*/
|
|
674
598
|
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
675
599
|
itemId: string,
|
|
676
|
-
): Promise<
|
|
677
|
-
RawApiTypes.ItemDestroyJobSchema<
|
|
678
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
679
|
-
>
|
|
680
|
-
> {
|
|
600
|
+
): Promise<RawApiTypes.ItemDestroyJobSchema<NoInfer<D>, true>> {
|
|
681
601
|
return this.client
|
|
682
602
|
.request({
|
|
683
603
|
method: 'DELETE',
|
|
684
604
|
url: `/items/${itemId}`,
|
|
685
605
|
})
|
|
686
|
-
.then<
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
>
|
|
690
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
606
|
+
.then<RawApiTypes.ItemDestroyJobSchema<NoInfer<D>, true>>(
|
|
607
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
608
|
+
);
|
|
691
609
|
}
|
|
692
610
|
|
|
693
611
|
/**
|
|
@@ -715,7 +633,7 @@ export default class Item extends BaseResource {
|
|
|
715
633
|
queryParams,
|
|
716
634
|
).then((body) =>
|
|
717
635
|
Utils.deserializeResponseBody<
|
|
718
|
-
ApiTypes.ItemPublishTargetSchema<
|
|
636
|
+
ApiTypes.ItemPublishTargetSchema<NoInfer<D>>
|
|
719
637
|
>(body),
|
|
720
638
|
);
|
|
721
639
|
}
|
|
@@ -732,11 +650,7 @@ export default class Item extends BaseResource {
|
|
|
732
650
|
itemId: string,
|
|
733
651
|
body?: RawApiTypes.ItemPublishSchema,
|
|
734
652
|
queryParams?: RawApiTypes.ItemPublishHrefSchema,
|
|
735
|
-
): Promise<
|
|
736
|
-
RawApiTypes.ItemPublishTargetSchema<
|
|
737
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
738
|
-
>
|
|
739
|
-
> {
|
|
653
|
+
): Promise<RawApiTypes.ItemPublishTargetSchema<NoInfer<D>, true>> {
|
|
740
654
|
return this.client
|
|
741
655
|
.request({
|
|
742
656
|
method: 'PUT',
|
|
@@ -744,11 +658,9 @@ export default class Item extends BaseResource {
|
|
|
744
658
|
body,
|
|
745
659
|
queryParams,
|
|
746
660
|
})
|
|
747
|
-
.then<
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
>
|
|
751
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
661
|
+
.then<RawApiTypes.ItemPublishTargetSchema<NoInfer<D>, true>>(
|
|
662
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
663
|
+
);
|
|
752
664
|
}
|
|
753
665
|
|
|
754
666
|
/**
|
|
@@ -776,7 +688,7 @@ export default class Item extends BaseResource {
|
|
|
776
688
|
queryParams,
|
|
777
689
|
).then((body) =>
|
|
778
690
|
Utils.deserializeResponseBody<
|
|
779
|
-
ApiTypes.ItemUnpublishTargetSchema<
|
|
691
|
+
ApiTypes.ItemUnpublishTargetSchema<NoInfer<D>>
|
|
780
692
|
>(body),
|
|
781
693
|
);
|
|
782
694
|
}
|
|
@@ -793,11 +705,7 @@ export default class Item extends BaseResource {
|
|
|
793
705
|
itemId: string,
|
|
794
706
|
body?: RawApiTypes.ItemUnpublishSchema,
|
|
795
707
|
queryParams?: RawApiTypes.ItemUnpublishHrefSchema,
|
|
796
|
-
): Promise<
|
|
797
|
-
RawApiTypes.ItemUnpublishTargetSchema<
|
|
798
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
799
|
-
>
|
|
800
|
-
> {
|
|
708
|
+
): Promise<RawApiTypes.ItemUnpublishTargetSchema<NoInfer<D>, true>> {
|
|
801
709
|
return this.client
|
|
802
710
|
.request({
|
|
803
711
|
method: 'PUT',
|
|
@@ -805,11 +713,9 @@ export default class Item extends BaseResource {
|
|
|
805
713
|
body,
|
|
806
714
|
queryParams,
|
|
807
715
|
})
|
|
808
|
-
.then<
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
>
|
|
812
|
-
>(Utils.deserializeRawResponseBodyWithItems);
|
|
716
|
+
.then<RawApiTypes.ItemUnpublishTargetSchema<NoInfer<D>, true>>(
|
|
717
|
+
Utils.deserializeRawResponseBodyWithItems,
|
|
718
|
+
);
|
|
813
719
|
}
|
|
814
720
|
|
|
815
721
|
/**
|
|
@@ -1,11 +1,6 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type {
|
|
4
|
-
ItemTypeDefinition,
|
|
5
|
-
ToItemDefinition,
|
|
6
|
-
ToItemDefinitionAsRequest,
|
|
7
|
-
ToItemDefinitionWithNestedBlocks,
|
|
8
|
-
} from '../../utilities/itemDefinition';
|
|
3
|
+
import type { ItemTypeDefinition } from '../../utilities/itemDefinition';
|
|
9
4
|
import type * as ApiTypes from '../ApiTypes';
|
|
10
5
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
11
6
|
|
|
@@ -77,9 +72,7 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
77
72
|
) {
|
|
78
73
|
return this.rawDestroy<D>(Utils.toId(itemId)).then((body) =>
|
|
79
74
|
Utils.deserializeResponseBody<
|
|
80
|
-
ApiTypes.ScheduledPublicationDestroyTargetSchema<
|
|
81
|
-
ToItemDefinition<NoInfer<D>>
|
|
82
|
-
>
|
|
75
|
+
ApiTypes.ScheduledPublicationDestroyTargetSchema<NoInfer<D>>
|
|
83
76
|
>(body),
|
|
84
77
|
);
|
|
85
78
|
}
|
|
@@ -95,9 +88,7 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
95
88
|
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
96
89
|
itemId: string,
|
|
97
90
|
): Promise<
|
|
98
|
-
RawApiTypes.ScheduledPublicationDestroyTargetSchema<
|
|
99
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
100
|
-
>
|
|
91
|
+
RawApiTypes.ScheduledPublicationDestroyTargetSchema<NoInfer<D>, true>
|
|
101
92
|
> {
|
|
102
93
|
return this.client
|
|
103
94
|
.request({
|
|
@@ -105,9 +96,7 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
105
96
|
url: `/items/${itemId}/scheduled-publication`,
|
|
106
97
|
})
|
|
107
98
|
.then<
|
|
108
|
-
RawApiTypes.ScheduledPublicationDestroyTargetSchema<
|
|
109
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
110
|
-
>
|
|
99
|
+
RawApiTypes.ScheduledPublicationDestroyTargetSchema<NoInfer<D>, true>
|
|
111
100
|
>(Utils.deserializeRawResponseBodyWithItems);
|
|
112
101
|
}
|
|
113
102
|
}
|
|
@@ -1,11 +1,6 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type {
|
|
4
|
-
ItemTypeDefinition,
|
|
5
|
-
ToItemDefinition,
|
|
6
|
-
ToItemDefinitionAsRequest,
|
|
7
|
-
ToItemDefinitionWithNestedBlocks,
|
|
8
|
-
} from '../../utilities/itemDefinition';
|
|
3
|
+
import type { ItemTypeDefinition } from '../../utilities/itemDefinition';
|
|
9
4
|
import type * as ApiTypes from '../ApiTypes';
|
|
10
5
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
11
6
|
|
|
@@ -77,9 +72,7 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
77
72
|
) {
|
|
78
73
|
return this.rawDestroy<D>(Utils.toId(itemId)).then((body) =>
|
|
79
74
|
Utils.deserializeResponseBody<
|
|
80
|
-
ApiTypes.ScheduledUnpublishingDestroyTargetSchema<
|
|
81
|
-
ToItemDefinition<NoInfer<D>>
|
|
82
|
-
>
|
|
75
|
+
ApiTypes.ScheduledUnpublishingDestroyTargetSchema<NoInfer<D>>
|
|
83
76
|
>(body),
|
|
84
77
|
);
|
|
85
78
|
}
|
|
@@ -95,9 +88,7 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
95
88
|
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
|
|
96
89
|
itemId: string,
|
|
97
90
|
): Promise<
|
|
98
|
-
RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<
|
|
99
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
100
|
-
>
|
|
91
|
+
RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<NoInfer<D>, true>
|
|
101
92
|
> {
|
|
102
93
|
return this.client
|
|
103
94
|
.request({
|
|
@@ -105,9 +96,7 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
105
96
|
url: `/items/${itemId}/scheduled-unpublishing`,
|
|
106
97
|
})
|
|
107
98
|
.then<
|
|
108
|
-
RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<
|
|
109
|
-
ToItemDefinitionWithNestedBlocks<NoInfer<D>>
|
|
110
|
-
>
|
|
99
|
+
RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<NoInfer<D>, true>
|
|
111
100
|
>(Utils.deserializeRawResponseBodyWithItems);
|
|
112
101
|
}
|
|
113
102
|
}
|