@datocms/cma-client 0.1.5 → 1.0.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.
Files changed (38) hide show
  1. package/dist/cjs/generated/resources/BuildTrigger.js +40 -2
  2. package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
  3. package/dist/cjs/generated/resources/Site.js +25 -3
  4. package/dist/cjs/generated/resources/Site.js.map +1 -1
  5. package/dist/cjs/generated/resources/User.js +26 -3
  6. package/dist/cjs/generated/resources/User.js.map +1 -1
  7. package/dist/esm/buildBlockRecord.d.ts +1 -1
  8. package/dist/esm/generated/SchemaTypes.d.ts +1296 -379
  9. package/dist/esm/generated/SimpleSchemaTypes.d.ts +1357 -457
  10. package/dist/esm/generated/resources/BuildTrigger.d.ts +26 -2
  11. package/dist/esm/generated/resources/BuildTrigger.js +40 -2
  12. package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
  13. package/dist/esm/generated/resources/Site.d.ts +14 -2
  14. package/dist/esm/generated/resources/Site.js +25 -3
  15. package/dist/esm/generated/resources/Site.js.map +1 -1
  16. package/dist/esm/generated/resources/User.d.ts +14 -2
  17. package/dist/esm/generated/resources/User.js +26 -3
  18. package/dist/esm/generated/resources/User.js.map +1 -1
  19. package/dist/types/buildBlockRecord.d.ts +1 -1
  20. package/dist/types/generated/SchemaTypes.d.ts +1296 -379
  21. package/dist/types/generated/SimpleSchemaTypes.d.ts +1357 -457
  22. package/dist/types/generated/resources/BuildTrigger.d.ts +26 -2
  23. package/dist/types/generated/resources/Site.d.ts +14 -2
  24. package/dist/types/generated/resources/User.d.ts +14 -2
  25. package/package.json +6 -5
  26. package/resources.json +1278 -0
  27. package/src/generated/SchemaTypes.ts +1320 -388
  28. package/src/generated/SimpleSchemaTypes.ts +1364 -463
  29. package/src/generated/resources/BuildTrigger.ts +44 -2
  30. package/src/generated/resources/Site.ts +33 -3
  31. package/src/generated/resources/User.ts +36 -3
  32. package/dist/cjs/generated/schemaInfo.js +0 -3063
  33. package/dist/cjs/generated/schemaInfo.js.map +0 -1
  34. package/dist/esm/generated/schemaInfo.d.ts +0 -940
  35. package/dist/esm/generated/schemaInfo.js +0 -3061
  36. package/dist/esm/generated/schemaInfo.js.map +0 -1
  37. package/dist/types/generated/schemaInfo.d.ts +0 -940
  38. package/src/generated/schemaInfo.ts +0 -3231
@@ -1,3061 +0,0 @@
1
- export default {
2
- baseUrl: 'https://site-api.datocms.com',
3
- resources: [
4
- {
5
- jsonApiType: 'role',
6
- endpoints: [
7
- {
8
- returnsCollection: false,
9
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/role/create',
10
- name: 'create',
11
- rawName: 'rawCreate',
12
- urlTemplate: '/roles',
13
- method: 'POST',
14
- comment: 'Create a new role',
15
- requestBodyType: 'RoleCreateSchema',
16
- simpleMethodAvailable: true,
17
- requestStructure: {
18
- type: 'role',
19
- attributes: [
20
- 'name',
21
- 'can_edit_favicon',
22
- 'can_edit_site',
23
- 'can_edit_schema',
24
- 'can_manage_menu',
25
- 'can_edit_environment',
26
- 'can_promote_environments',
27
- 'environments_access',
28
- 'can_manage_users',
29
- 'can_manage_shared_filters',
30
- 'can_manage_build_triggers',
31
- 'can_manage_webhooks',
32
- 'can_manage_environments',
33
- 'can_manage_sso',
34
- 'can_access_audit_log',
35
- 'can_manage_workflows',
36
- 'can_manage_access_tokens',
37
- 'can_perform_site_search',
38
- 'can_access_build_events_log',
39
- 'positive_item_type_permissions',
40
- 'negative_item_type_permissions',
41
- 'positive_upload_permissions',
42
- 'negative_upload_permissions',
43
- 'positive_build_trigger_permissions',
44
- 'negative_build_trigger_permissions',
45
- ],
46
- relationships: ['inherits_permissions_from'],
47
- },
48
- responseType: 'RoleCreateTargetSchema',
49
- },
50
- {
51
- returnsCollection: false,
52
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/role/update',
53
- name: 'update',
54
- rawName: 'rawUpdate',
55
- urlTemplate: '/roles/${roleId}',
56
- method: 'PUT',
57
- comment: 'Update a role',
58
- urlPlaceholder: {
59
- variableName: 'roleId',
60
- isEntityId: true,
61
- relType: 'RoleData',
62
- },
63
- requestBodyType: 'RoleUpdateSchema',
64
- simpleMethodAvailable: true,
65
- requestStructure: {
66
- type: 'role',
67
- attributes: [
68
- 'name',
69
- 'can_edit_favicon',
70
- 'can_edit_site',
71
- 'can_edit_schema',
72
- 'can_manage_menu',
73
- 'can_edit_environment',
74
- 'can_promote_environments',
75
- 'environments_access',
76
- 'can_manage_users',
77
- 'can_manage_shared_filters',
78
- 'can_manage_build_triggers',
79
- 'can_manage_webhooks',
80
- 'can_manage_environments',
81
- 'can_manage_sso',
82
- 'can_access_audit_log',
83
- 'can_manage_workflows',
84
- 'can_manage_access_tokens',
85
- 'can_perform_site_search',
86
- 'can_access_build_events_log',
87
- 'positive_item_type_permissions',
88
- 'negative_item_type_permissions',
89
- 'positive_upload_permissions',
90
- 'negative_upload_permissions',
91
- 'positive_build_trigger_permissions',
92
- 'negative_build_trigger_permissions',
93
- ],
94
- relationships: ['inherits_permissions_from'],
95
- },
96
- responseType: 'RoleUpdateTargetSchema',
97
- },
98
- {
99
- returnsCollection: true,
100
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/role/instances',
101
- name: 'list',
102
- rawName: 'rawList',
103
- urlTemplate: '/roles',
104
- method: 'GET',
105
- comment: 'List all roles',
106
- simpleMethodAvailable: true,
107
- responseType: 'RoleInstancesTargetSchema',
108
- },
109
- {
110
- returnsCollection: false,
111
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/role/self',
112
- name: 'find',
113
- rawName: 'rawFind',
114
- urlTemplate: '/roles/${roleId}',
115
- method: 'GET',
116
- comment: 'Retrieve a role',
117
- urlPlaceholder: {
118
- variableName: 'roleId',
119
- isEntityId: true,
120
- relType: 'RoleData',
121
- },
122
- simpleMethodAvailable: true,
123
- responseType: 'RoleSelfTargetSchema',
124
- },
125
- {
126
- returnsCollection: false,
127
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/role/destroy',
128
- name: 'destroy',
129
- rawName: 'rawDestroy',
130
- urlTemplate: '/roles/${roleId}',
131
- method: 'DELETE',
132
- comment: 'Delete a role',
133
- urlPlaceholder: {
134
- variableName: 'roleId',
135
- isEntityId: true,
136
- relType: 'RoleData',
137
- },
138
- simpleMethodAvailable: true,
139
- responseType: 'RoleDestroyTargetSchema',
140
- },
141
- ],
142
- namespace: 'roles',
143
- resourceClassName: 'Role',
144
- },
145
- {
146
- jsonApiType: 'user',
147
- endpoints: [
148
- {
149
- returnsCollection: false,
150
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/user/update',
151
- name: 'update',
152
- rawName: 'rawUpdate',
153
- urlTemplate: '/users/${userId}',
154
- method: 'PUT',
155
- comment: 'Update a collaborator',
156
- urlPlaceholder: {
157
- variableName: 'userId',
158
- isEntityId: true,
159
- relType: 'UserData',
160
- },
161
- requestBodyType: 'UserUpdateSchema',
162
- simpleMethodAvailable: true,
163
- requestStructure: {
164
- type: 'user',
165
- attributes: ['is_active'],
166
- relationships: ['role'],
167
- },
168
- responseType: 'UserUpdateTargetSchema',
169
- },
170
- {
171
- returnsCollection: true,
172
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/user/instances',
173
- name: 'list',
174
- rawName: 'rawList',
175
- urlTemplate: '/users',
176
- method: 'GET',
177
- comment: 'List all collaborators',
178
- simpleMethodAvailable: true,
179
- responseType: 'UserInstancesTargetSchema',
180
- },
181
- {
182
- returnsCollection: false,
183
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/user/self',
184
- name: 'find',
185
- rawName: 'rawFind',
186
- urlTemplate: '/users/${userId}',
187
- method: 'GET',
188
- comment: 'Retrieve a collaborator',
189
- urlPlaceholder: {
190
- variableName: 'userId',
191
- isEntityId: true,
192
- relType: 'UserData',
193
- },
194
- simpleMethodAvailable: true,
195
- responseType: 'UserSelfTargetSchema',
196
- },
197
- {
198
- returnsCollection: false,
199
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/user/destroy',
200
- name: 'destroy',
201
- rawName: 'rawDestroy',
202
- urlTemplate: '/users/${userId}',
203
- method: 'DELETE',
204
- comment: 'Delete a collaborator',
205
- urlPlaceholder: {
206
- variableName: 'userId',
207
- isEntityId: true,
208
- relType: 'UserData',
209
- },
210
- simpleMethodAvailable: true,
211
- queryParamsType: 'UserDestroyHrefSchema',
212
- responseType: 'UserDestroyTargetSchema',
213
- },
214
- ],
215
- namespace: 'users',
216
- resourceClassName: 'User',
217
- },
218
- {
219
- jsonApiType: 'sso_user',
220
- endpoints: [
221
- {
222
- returnsCollection: true,
223
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-user/instances',
224
- name: 'list',
225
- rawName: 'rawList',
226
- urlTemplate: '/sso-users',
227
- method: 'GET',
228
- comment: 'List all users',
229
- simpleMethodAvailable: true,
230
- responseType: 'SsoUserInstancesTargetSchema',
231
- },
232
- {
233
- returnsCollection: false,
234
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-user/self',
235
- name: 'find',
236
- rawName: 'rawFind',
237
- urlTemplate: '/sso-users/${userId}',
238
- method: 'GET',
239
- comment: 'Returns a SSO user',
240
- urlPlaceholder: {
241
- variableName: 'userId',
242
- isEntityId: false,
243
- relType: 'UserData',
244
- },
245
- simpleMethodAvailable: true,
246
- responseType: 'SsoUserSelfTargetSchema',
247
- },
248
- {
249
- returnsCollection: false,
250
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users',
251
- name: 'copyUsers',
252
- rawName: 'rawCopyUsers',
253
- urlTemplate: '/sso-users/copy-users',
254
- method: 'POST',
255
- comment: 'Copy editors as SSO users',
256
- simpleMethodAvailable: true,
257
- responseType: 'SsoUserCopyUsersTargetSchema',
258
- },
259
- {
260
- returnsCollection: false,
261
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy',
262
- name: 'destroy',
263
- rawName: 'rawDestroy',
264
- urlTemplate: '/sso-users/${userId}',
265
- method: 'DELETE',
266
- comment: 'Delete a SSO user',
267
- urlPlaceholder: {
268
- variableName: 'userId',
269
- isEntityId: false,
270
- relType: 'UserData',
271
- },
272
- simpleMethodAvailable: true,
273
- queryParamsType: 'SsoUserDestroyHrefSchema',
274
- responseType: 'SsoUserDestroyTargetSchema',
275
- },
276
- ],
277
- namespace: 'ssoUsers',
278
- resourceClassName: 'SsoUser',
279
- },
280
- {
281
- jsonApiType: 'audit_log_event',
282
- endpoints: [
283
- {
284
- returnsCollection: true,
285
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query',
286
- name: 'query',
287
- rawName: 'rawQuery',
288
- urlTemplate: '/audit-log-events/query',
289
- method: 'POST',
290
- comment: 'List Audit Log events',
291
- requestBodyType: 'AuditLogEventQuerySchema',
292
- simpleMethodAvailable: true,
293
- requestStructure: {
294
- type: 'audit_log_query',
295
- attributes: ['filter', 'next_token', 'detailed_log'],
296
- relationships: [],
297
- },
298
- responseType: 'AuditLogEventQueryTargetSchema',
299
- },
300
- ],
301
- namespace: 'auditLogEvents',
302
- resourceClassName: 'AuditLogEvent',
303
- },
304
- {
305
- jsonApiType: 'menu_item',
306
- endpoints: [
307
- {
308
- returnsCollection: false,
309
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/menu-item/create',
310
- name: 'create',
311
- rawName: 'rawCreate',
312
- urlTemplate: '/menu-items',
313
- method: 'POST',
314
- comment: 'Create a new menu item',
315
- requestBodyType: 'MenuItemCreateSchema',
316
- simpleMethodAvailable: true,
317
- requestStructure: {
318
- type: 'menu_item',
319
- attributes: [
320
- 'label',
321
- 'external_url',
322
- 'position',
323
- 'open_in_new_tab',
324
- ],
325
- relationships: ['item_type', 'parent'],
326
- },
327
- responseType: 'MenuItemCreateTargetSchema',
328
- },
329
- {
330
- returnsCollection: false,
331
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/menu-item/update',
332
- name: 'update',
333
- rawName: 'rawUpdate',
334
- urlTemplate: '/menu-items/${menuItemId}',
335
- method: 'PUT',
336
- comment: 'Update a menu item',
337
- urlPlaceholder: {
338
- variableName: 'menuItemId',
339
- isEntityId: true,
340
- relType: 'MenuItemData',
341
- },
342
- requestBodyType: 'MenuItemUpdateSchema',
343
- simpleMethodAvailable: true,
344
- requestStructure: {
345
- type: 'menu_item',
346
- attributes: [
347
- 'label',
348
- 'external_url',
349
- 'position',
350
- 'open_in_new_tab',
351
- ],
352
- relationships: ['item_type', 'parent'],
353
- },
354
- responseType: 'MenuItemUpdateTargetSchema',
355
- },
356
- {
357
- returnsCollection: true,
358
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/menu-item/instances',
359
- name: 'list',
360
- rawName: 'rawList',
361
- urlTemplate: '/menu-items',
362
- method: 'GET',
363
- comment: 'List all menu items',
364
- simpleMethodAvailable: true,
365
- queryParamsType: 'MenuItemInstancesHrefSchema',
366
- responseType: 'MenuItemInstancesTargetSchema',
367
- },
368
- {
369
- returnsCollection: false,
370
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/menu-item/self',
371
- name: 'find',
372
- rawName: 'rawFind',
373
- urlTemplate: '/menu-items/${menuItemId}',
374
- method: 'GET',
375
- comment: 'Retrieve a menu item',
376
- urlPlaceholder: {
377
- variableName: 'menuItemId',
378
- isEntityId: true,
379
- relType: 'MenuItemData',
380
- },
381
- simpleMethodAvailable: true,
382
- responseType: 'MenuItemSelfTargetSchema',
383
- },
384
- {
385
- returnsCollection: false,
386
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy',
387
- name: 'destroy',
388
- rawName: 'rawDestroy',
389
- urlTemplate: '/menu-items/${menuItemId}',
390
- method: 'DELETE',
391
- comment: 'Delete a menu item',
392
- urlPlaceholder: {
393
- variableName: 'menuItemId',
394
- isEntityId: true,
395
- relType: 'MenuItemData',
396
- },
397
- simpleMethodAvailable: true,
398
- responseType: 'MenuItemDestroyTargetSchema',
399
- },
400
- ],
401
- namespace: 'menuItems',
402
- resourceClassName: 'MenuItem',
403
- },
404
- {
405
- jsonApiType: 'item_type',
406
- endpoints: [
407
- {
408
- returnsCollection: false,
409
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/create',
410
- name: 'create',
411
- rawName: 'rawCreate',
412
- urlTemplate: '/item-types',
413
- method: 'POST',
414
- comment: 'Create a new model',
415
- requestBodyType: 'ItemTypeCreateSchema',
416
- simpleMethodAvailable: true,
417
- requestStructure: {
418
- type: 'item_type',
419
- attributes: [
420
- 'name',
421
- 'api_key',
422
- 'singleton',
423
- 'all_locales_required',
424
- 'sortable',
425
- 'modular_block',
426
- 'draft_mode_active',
427
- 'tree',
428
- 'ordering_direction',
429
- 'ordering_meta',
430
- 'collection_appeareance',
431
- 'collection_appearance',
432
- 'hint',
433
- ],
434
- relationships: [
435
- 'ordering_field',
436
- 'title_field',
437
- 'image_preview_field',
438
- 'excerpt_field',
439
- 'workflow',
440
- ],
441
- },
442
- responseType: 'ItemTypeCreateTargetSchema',
443
- },
444
- {
445
- returnsCollection: false,
446
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/update',
447
- name: 'update',
448
- rawName: 'rawUpdate',
449
- urlTemplate: '/item-types/${itemTypeId}',
450
- method: 'PUT',
451
- comment: 'Update a model',
452
- urlPlaceholder: {
453
- variableName: 'itemTypeId',
454
- isEntityId: true,
455
- relType: 'ItemTypeData',
456
- },
457
- requestBodyType: 'ItemTypeUpdateSchema',
458
- simpleMethodAvailable: true,
459
- requestStructure: {
460
- type: 'item_type',
461
- attributes: [
462
- 'name',
463
- 'api_key',
464
- 'collection_appeareance',
465
- 'collection_appearance',
466
- 'singleton',
467
- 'all_locales_required',
468
- 'sortable',
469
- 'modular_block',
470
- 'draft_mode_active',
471
- 'tree',
472
- 'ordering_direction',
473
- 'ordering_meta',
474
- 'has_singleton_item',
475
- 'hint',
476
- ],
477
- relationships: [
478
- 'ordering_field',
479
- 'title_field',
480
- 'image_preview_field',
481
- 'excerpt_field',
482
- 'workflow',
483
- ],
484
- },
485
- responseType: 'ItemTypeUpdateJobSchema',
486
- },
487
- {
488
- returnsCollection: true,
489
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/instances',
490
- name: 'list',
491
- rawName: 'rawList',
492
- urlTemplate: '/item-types',
493
- method: 'GET',
494
- comment: 'List all models',
495
- simpleMethodAvailable: true,
496
- responseType: 'ItemTypeInstancesTargetSchema',
497
- },
498
- {
499
- returnsCollection: false,
500
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/self',
501
- name: 'find',
502
- rawName: 'rawFind',
503
- urlTemplate: '/item-types/${itemTypeId}',
504
- method: 'GET',
505
- comment: 'Retrieve a model',
506
- urlPlaceholder: {
507
- variableName: 'itemTypeId',
508
- isEntityId: true,
509
- relType: 'ItemTypeData',
510
- },
511
- simpleMethodAvailable: true,
512
- responseType: 'ItemTypeSelfTargetSchema',
513
- },
514
- {
515
- returnsCollection: false,
516
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate',
517
- name: 'duplicate',
518
- rawName: 'rawDuplicate',
519
- urlTemplate: '/item-types/${itemTypeId}/duplicate',
520
- method: 'POST',
521
- comment: 'Duplicate model',
522
- urlPlaceholder: {
523
- variableName: 'itemTypeId',
524
- isEntityId: true,
525
- relType: 'ItemTypeData',
526
- },
527
- simpleMethodAvailable: true,
528
- responseType: 'ItemTypeDuplicateTargetSchema',
529
- },
530
- {
531
- returnsCollection: false,
532
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type/destroy',
533
- name: 'destroy',
534
- rawName: 'rawDestroy',
535
- urlTemplate: '/item-types/${itemTypeId}',
536
- method: 'DELETE',
537
- comment: 'Delete a model',
538
- urlPlaceholder: {
539
- variableName: 'itemTypeId',
540
- isEntityId: true,
541
- relType: 'ItemTypeData',
542
- },
543
- simpleMethodAvailable: true,
544
- responseType: 'ItemTypeDestroyJobSchema',
545
- },
546
- ],
547
- namespace: 'itemTypes',
548
- resourceClassName: 'ItemType',
549
- },
550
- {
551
- jsonApiType: 'field',
552
- endpoints: [
553
- {
554
- returnsCollection: false,
555
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/create',
556
- name: 'create',
557
- rawName: 'rawCreate',
558
- urlTemplate: '/item-types/${itemTypeId}/fields',
559
- method: 'POST',
560
- comment: 'Create a new field',
561
- urlPlaceholder: {
562
- variableName: 'itemTypeId',
563
- isEntityId: false,
564
- relType: 'ItemTypeData',
565
- },
566
- requestBodyType: 'FieldCreateSchema',
567
- simpleMethodAvailable: true,
568
- requestStructure: {
569
- type: 'field',
570
- attributes: [
571
- 'label',
572
- 'field_type',
573
- 'api_key',
574
- 'localized',
575
- 'validators',
576
- 'appeareance',
577
- 'appearance',
578
- 'position',
579
- 'hint',
580
- 'default_value',
581
- ],
582
- relationships: ['fieldset'],
583
- },
584
- responseType: 'FieldCreateJobSchema',
585
- },
586
- {
587
- returnsCollection: false,
588
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/update',
589
- name: 'update',
590
- rawName: 'rawUpdate',
591
- urlTemplate: '/fields/${fieldId}',
592
- method: 'PUT',
593
- comment: 'Update a field',
594
- urlPlaceholder: {
595
- variableName: 'fieldId',
596
- isEntityId: true,
597
- relType: 'FieldData',
598
- },
599
- requestBodyType: 'FieldUpdateSchema',
600
- simpleMethodAvailable: true,
601
- requestStructure: {
602
- type: 'field',
603
- attributes: [
604
- 'default_value',
605
- 'label',
606
- 'api_key',
607
- 'localized',
608
- 'validators',
609
- 'appeareance',
610
- 'appearance',
611
- 'position',
612
- 'field_type',
613
- 'hint',
614
- ],
615
- relationships: ['fieldset'],
616
- },
617
- responseType: 'FieldUpdateJobSchema',
618
- },
619
- {
620
- returnsCollection: true,
621
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/instances',
622
- name: 'list',
623
- rawName: 'rawList',
624
- urlTemplate: '/item-types/${itemTypeId}/fields',
625
- method: 'GET',
626
- comment: 'List all fields',
627
- urlPlaceholder: {
628
- variableName: 'itemTypeId',
629
- isEntityId: false,
630
- relType: 'ItemTypeData',
631
- },
632
- simpleMethodAvailable: true,
633
- responseType: 'FieldInstancesTargetSchema',
634
- },
635
- {
636
- returnsCollection: false,
637
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/referencing',
638
- name: 'referencing',
639
- rawName: 'rawReferencing',
640
- urlTemplate: '/item-types/${itemTypeId}/fields/referencing',
641
- method: 'GET',
642
- comment: 'List referenced fields',
643
- urlPlaceholder: {
644
- variableName: 'itemTypeId',
645
- isEntityId: false,
646
- relType: 'ItemTypeData',
647
- },
648
- simpleMethodAvailable: true,
649
- responseType: 'FieldReferencingTargetSchema',
650
- deprecated: 'This API call is to be considered private and might change without notice',
651
- },
652
- {
653
- returnsCollection: false,
654
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/related',
655
- name: 'related',
656
- rawName: 'rawRelated',
657
- urlTemplate: '/item-types/${itemTypeId}/fields/related',
658
- method: 'GET',
659
- comment: 'List related fields',
660
- urlPlaceholder: {
661
- variableName: 'itemTypeId',
662
- isEntityId: false,
663
- relType: 'ItemTypeData',
664
- },
665
- simpleMethodAvailable: true,
666
- responseType: 'FieldRelatedTargetSchema',
667
- deprecated: 'This API call is to be considered private and might change without notice',
668
- },
669
- {
670
- returnsCollection: false,
671
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/self',
672
- name: 'find',
673
- rawName: 'rawFind',
674
- urlTemplate: '/fields/${fieldId}',
675
- method: 'GET',
676
- comment: 'Retrieve a field',
677
- urlPlaceholder: {
678
- variableName: 'fieldId',
679
- isEntityId: true,
680
- relType: 'FieldData',
681
- },
682
- simpleMethodAvailable: true,
683
- responseType: 'FieldSelfTargetSchema',
684
- },
685
- {
686
- returnsCollection: false,
687
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/destroy',
688
- name: 'destroy',
689
- rawName: 'rawDestroy',
690
- urlTemplate: '/fields/${fieldId}',
691
- method: 'DELETE',
692
- comment: 'Delete a field',
693
- urlPlaceholder: {
694
- variableName: 'fieldId',
695
- isEntityId: true,
696
- relType: 'FieldData',
697
- },
698
- simpleMethodAvailable: true,
699
- responseType: 'FieldDestroyJobSchema',
700
- },
701
- {
702
- returnsCollection: false,
703
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/field/duplicate',
704
- name: 'duplicate',
705
- rawName: 'rawDuplicate',
706
- urlTemplate: '/fields/${fieldId}/duplicate',
707
- method: 'POST',
708
- comment: 'Duplicate a field',
709
- urlPlaceholder: {
710
- variableName: 'fieldId',
711
- isEntityId: true,
712
- relType: 'FieldData',
713
- },
714
- simpleMethodAvailable: true,
715
- responseType: 'FieldDuplicateJobSchema',
716
- },
717
- ],
718
- namespace: 'fields',
719
- resourceClassName: 'Field',
720
- },
721
- {
722
- jsonApiType: 'fieldset',
723
- endpoints: [
724
- {
725
- returnsCollection: false,
726
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/fieldset/create',
727
- name: 'create',
728
- rawName: 'rawCreate',
729
- urlTemplate: '/item-types/${itemTypeId}/fieldsets',
730
- method: 'POST',
731
- comment: 'Create a new fieldset',
732
- urlPlaceholder: {
733
- variableName: 'itemTypeId',
734
- isEntityId: false,
735
- relType: 'ItemTypeData',
736
- },
737
- requestBodyType: 'FieldsetCreateSchema',
738
- simpleMethodAvailable: true,
739
- requestStructure: {
740
- type: 'fieldset',
741
- attributes: [
742
- 'title',
743
- 'hint',
744
- 'position',
745
- 'collapsible',
746
- 'start_collapsed',
747
- ],
748
- relationships: [],
749
- },
750
- responseType: 'FieldsetCreateTargetSchema',
751
- },
752
- {
753
- returnsCollection: false,
754
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/fieldset/update',
755
- name: 'update',
756
- rawName: 'rawUpdate',
757
- urlTemplate: '/fieldsets/${fieldsetId}',
758
- method: 'PUT',
759
- comment: 'Update a fieldset',
760
- urlPlaceholder: {
761
- variableName: 'fieldsetId',
762
- isEntityId: true,
763
- relType: 'FieldsetData',
764
- },
765
- requestBodyType: 'FieldsetUpdateSchema',
766
- simpleMethodAvailable: true,
767
- requestStructure: {
768
- type: 'fieldset',
769
- attributes: [
770
- 'title',
771
- 'hint',
772
- 'position',
773
- 'collapsible',
774
- 'start_collapsed',
775
- ],
776
- relationships: [],
777
- },
778
- responseType: 'FieldsetUpdateTargetSchema',
779
- },
780
- {
781
- returnsCollection: true,
782
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/fieldset/instances',
783
- name: 'list',
784
- rawName: 'rawList',
785
- urlTemplate: '/item-types/${itemTypeId}/fieldsets',
786
- method: 'GET',
787
- comment: 'List all fieldsets',
788
- urlPlaceholder: {
789
- variableName: 'itemTypeId',
790
- isEntityId: false,
791
- relType: 'ItemTypeData',
792
- },
793
- simpleMethodAvailable: true,
794
- responseType: 'FieldsetInstancesTargetSchema',
795
- },
796
- {
797
- returnsCollection: false,
798
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/fieldset/self',
799
- name: 'find',
800
- rawName: 'rawFind',
801
- urlTemplate: '/fieldsets/${fieldsetId}',
802
- method: 'GET',
803
- comment: 'Retrieve a fieldset',
804
- urlPlaceholder: {
805
- variableName: 'fieldsetId',
806
- isEntityId: true,
807
- relType: 'FieldsetData',
808
- },
809
- simpleMethodAvailable: true,
810
- responseType: 'FieldsetSelfTargetSchema',
811
- },
812
- {
813
- returnsCollection: false,
814
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy',
815
- name: 'destroy',
816
- rawName: 'rawDestroy',
817
- urlTemplate: '/fieldsets/${fieldsetId}',
818
- method: 'DELETE',
819
- comment: 'Delete a fieldset',
820
- urlPlaceholder: {
821
- variableName: 'fieldsetId',
822
- isEntityId: true,
823
- relType: 'FieldsetData',
824
- },
825
- simpleMethodAvailable: true,
826
- responseType: 'FieldsetDestroyTargetSchema',
827
- },
828
- ],
829
- namespace: 'fieldsets',
830
- resourceClassName: 'Fieldset',
831
- },
832
- {
833
- jsonApiType: 'session',
834
- endpoints: [
835
- {
836
- returnsCollection: false,
837
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/session/create',
838
- name: 'create',
839
- rawName: 'rawCreate',
840
- urlTemplate: '/sessions',
841
- method: 'POST',
842
- comment: 'Create a new session',
843
- requestBodyType: 'SessionCreateSchema',
844
- simpleMethodAvailable: true,
845
- requestStructure: {
846
- type: 'email_credentials',
847
- attributes: ['email', 'password', 'otp_code'],
848
- relationships: [],
849
- },
850
- responseType: 'SessionCreateTargetSchema',
851
- deprecated: 'This API call is to be considered private and might change without notice',
852
- },
853
- ],
854
- namespace: 'session',
855
- resourceClassName: 'Session',
856
- },
857
- {
858
- jsonApiType: 'access_token',
859
- endpoints: [
860
- {
861
- returnsCollection: false,
862
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/create',
863
- name: 'create',
864
- rawName: 'rawCreate',
865
- urlTemplate: '/access_tokens',
866
- method: 'POST',
867
- comment: 'Create a new API token',
868
- requestBodyType: 'AccessTokenCreateSchema',
869
- simpleMethodAvailable: true,
870
- requestStructure: {
871
- type: 'access_token',
872
- attributes: [
873
- 'name',
874
- 'can_access_cda',
875
- 'can_access_cda_preview',
876
- 'can_access_cma',
877
- ],
878
- relationships: ['role'],
879
- },
880
- responseType: 'AccessTokenCreateTargetSchema',
881
- },
882
- {
883
- returnsCollection: false,
884
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/update',
885
- name: 'update',
886
- rawName: 'rawUpdate',
887
- urlTemplate: '/access_tokens/${accessTokenId}',
888
- method: 'PUT',
889
- comment: 'Update an API token',
890
- urlPlaceholder: {
891
- variableName: 'accessTokenId',
892
- isEntityId: true,
893
- relType: 'AccessTokenData',
894
- },
895
- requestBodyType: 'AccessTokenUpdateSchema',
896
- simpleMethodAvailable: true,
897
- requestStructure: {
898
- type: 'access_token',
899
- attributes: [
900
- 'name',
901
- 'can_access_cda',
902
- 'can_access_cda_preview',
903
- 'can_access_cma',
904
- ],
905
- relationships: ['role'],
906
- },
907
- responseType: 'AccessTokenUpdateTargetSchema',
908
- },
909
- {
910
- returnsCollection: true,
911
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/instances',
912
- name: 'list',
913
- rawName: 'rawList',
914
- urlTemplate: '/access_tokens',
915
- method: 'GET',
916
- comment: 'List all API tokens',
917
- simpleMethodAvailable: true,
918
- responseType: 'AccessTokenInstancesTargetSchema',
919
- },
920
- {
921
- returnsCollection: false,
922
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/self',
923
- name: 'find',
924
- rawName: 'rawFind',
925
- urlTemplate: '/access_tokens/${accessTokenId}',
926
- method: 'GET',
927
- comment: 'Retrieve an API token',
928
- urlPlaceholder: {
929
- variableName: 'accessTokenId',
930
- isEntityId: true,
931
- relType: 'AccessTokenData',
932
- },
933
- simpleMethodAvailable: true,
934
- responseType: 'AccessTokenSelfTargetSchema',
935
- },
936
- {
937
- returnsCollection: false,
938
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token',
939
- name: 'regenerateToken',
940
- rawName: 'rawRegenerateToken',
941
- urlTemplate: '/access_tokens/${accessTokenId}/regenerate_token',
942
- method: 'POST',
943
- comment: 'Rotate API token',
944
- urlPlaceholder: {
945
- variableName: 'accessTokenId',
946
- isEntityId: true,
947
- relType: 'AccessTokenData',
948
- },
949
- simpleMethodAvailable: true,
950
- responseType: 'AccessTokenRegenerateTokenTargetSchema',
951
- },
952
- {
953
- returnsCollection: false,
954
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/access-token/destroy',
955
- name: 'destroy',
956
- rawName: 'rawDestroy',
957
- urlTemplate: '/access_tokens/${accessTokenId}',
958
- method: 'DELETE',
959
- comment: 'Delete an API token',
960
- urlPlaceholder: {
961
- variableName: 'accessTokenId',
962
- isEntityId: true,
963
- relType: 'AccessTokenData',
964
- },
965
- simpleMethodAvailable: true,
966
- queryParamsType: 'AccessTokenDestroyHrefSchema',
967
- responseType: 'AccessTokenDestroyTargetSchema',
968
- },
969
- ],
970
- namespace: 'accessTokens',
971
- resourceClassName: 'AccessToken',
972
- },
973
- {
974
- jsonApiType: 'plugin',
975
- endpoints: [
976
- {
977
- returnsCollection: false,
978
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/create',
979
- name: 'create',
980
- rawName: 'rawCreate',
981
- urlTemplate: '/plugins',
982
- method: 'POST',
983
- comment: 'Create a new plugin',
984
- requestBodyType: 'PluginCreateSchema',
985
- simpleMethodAvailable: true,
986
- requestStructure: {
987
- type: 'plugin',
988
- attributes: [
989
- 'package_name',
990
- 'name',
991
- 'description',
992
- 'url',
993
- 'permissions',
994
- 'plugin_type',
995
- 'field_types',
996
- 'parameter_definitions',
997
- 'package_version',
998
- ],
999
- relationships: [],
1000
- },
1001
- responseType: 'PluginCreateTargetSchema',
1002
- },
1003
- {
1004
- returnsCollection: false,
1005
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/update',
1006
- name: 'update',
1007
- rawName: 'rawUpdate',
1008
- urlTemplate: '/plugins/${pluginId}',
1009
- method: 'PUT',
1010
- comment: 'Update a plugin',
1011
- urlPlaceholder: {
1012
- variableName: 'pluginId',
1013
- isEntityId: true,
1014
- relType: 'PluginData',
1015
- },
1016
- requestBodyType: 'PluginUpdateSchema',
1017
- simpleMethodAvailable: true,
1018
- requestStructure: {
1019
- type: 'plugin',
1020
- attributes: [
1021
- 'name',
1022
- 'description',
1023
- 'url',
1024
- 'parameters',
1025
- 'package_version',
1026
- 'permissions',
1027
- ],
1028
- relationships: [],
1029
- },
1030
- responseType: 'PluginUpdateTargetSchema',
1031
- },
1032
- {
1033
- returnsCollection: true,
1034
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/instances',
1035
- name: 'list',
1036
- rawName: 'rawList',
1037
- urlTemplate: '/plugins',
1038
- method: 'GET',
1039
- comment: 'List all plugins',
1040
- simpleMethodAvailable: true,
1041
- responseType: 'PluginInstancesTargetSchema',
1042
- },
1043
- {
1044
- returnsCollection: false,
1045
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/self',
1046
- name: 'find',
1047
- rawName: 'rawFind',
1048
- urlTemplate: '/plugins/${pluginId}',
1049
- method: 'GET',
1050
- comment: 'Retrieve a plugins',
1051
- urlPlaceholder: {
1052
- variableName: 'pluginId',
1053
- isEntityId: true,
1054
- relType: 'PluginData',
1055
- },
1056
- simpleMethodAvailable: true,
1057
- responseType: 'PluginSelfTargetSchema',
1058
- },
1059
- {
1060
- returnsCollection: false,
1061
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/destroy',
1062
- name: 'destroy',
1063
- rawName: 'rawDestroy',
1064
- urlTemplate: '/plugins/${pluginId}',
1065
- method: 'DELETE',
1066
- comment: 'Delete a plugin',
1067
- urlPlaceholder: {
1068
- variableName: 'pluginId',
1069
- isEntityId: true,
1070
- relType: 'PluginData',
1071
- },
1072
- simpleMethodAvailable: true,
1073
- responseType: 'PluginDestroyTargetSchema',
1074
- },
1075
- {
1076
- returnsCollection: false,
1077
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/plugin/fields',
1078
- name: 'fields',
1079
- rawName: 'rawFields',
1080
- urlTemplate: '/plugins/${pluginId}/fields',
1081
- method: 'GET',
1082
- comment: 'Retrieve all fields using the plugin',
1083
- urlPlaceholder: {
1084
- variableName: 'pluginId',
1085
- isEntityId: true,
1086
- relType: 'PluginData',
1087
- },
1088
- simpleMethodAvailable: true,
1089
- responseType: 'PluginFieldsTargetSchema',
1090
- },
1091
- ],
1092
- namespace: 'plugins',
1093
- resourceClassName: 'Plugin',
1094
- },
1095
- {
1096
- jsonApiType: 'job_result',
1097
- endpoints: [
1098
- {
1099
- returnsCollection: false,
1100
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/job-result/self',
1101
- name: 'find',
1102
- rawName: 'rawFind',
1103
- urlTemplate: '/job-results/${jobResultId}',
1104
- method: 'GET',
1105
- comment: 'Retrieve a job result',
1106
- urlPlaceholder: {
1107
- variableName: 'jobResultId',
1108
- isEntityId: true,
1109
- relType: 'JobResultData',
1110
- },
1111
- simpleMethodAvailable: true,
1112
- responseType: 'JobResultSelfTargetSchema',
1113
- },
1114
- ],
1115
- namespace: 'jobResults',
1116
- resourceClassName: 'JobResult',
1117
- },
1118
- {
1119
- jsonApiType: 'subscription_limit',
1120
- endpoints: [
1121
- {
1122
- returnsCollection: true,
1123
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances',
1124
- name: 'list',
1125
- rawName: 'rawList',
1126
- urlTemplate: '/subscription-limits',
1127
- method: 'GET',
1128
- comment: 'Get all the subscription limits',
1129
- simpleMethodAvailable: true,
1130
- responseType: 'SubscriptionLimitInstancesTargetSchema',
1131
- },
1132
- {
1133
- returnsCollection: false,
1134
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self',
1135
- name: 'find',
1136
- rawName: 'rawFind',
1137
- urlTemplate: '/subscription-limits/${subscriptionLimitId}',
1138
- method: 'GET',
1139
- comment: 'Get a single subscription limit',
1140
- urlPlaceholder: {
1141
- variableName: 'subscriptionLimitId',
1142
- isEntityId: true,
1143
- relType: 'SubscriptionLimitData',
1144
- },
1145
- simpleMethodAvailable: true,
1146
- responseType: 'SubscriptionLimitSelfTargetSchema',
1147
- },
1148
- ],
1149
- namespace: 'subscriptionLimits',
1150
- resourceClassName: 'SubscriptionLimit',
1151
- },
1152
- {
1153
- jsonApiType: 'subscription_feature',
1154
- endpoints: [
1155
- {
1156
- returnsCollection: true,
1157
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances',
1158
- name: 'list',
1159
- rawName: 'rawList',
1160
- urlTemplate: '/subscription-features',
1161
- method: 'GET',
1162
- comment: 'Get all the subscription features',
1163
- simpleMethodAvailable: true,
1164
- responseType: 'SubscriptionFeatureInstancesTargetSchema',
1165
- },
1166
- ],
1167
- namespace: 'subscriptionFeatures',
1168
- resourceClassName: 'SubscriptionFeature',
1169
- },
1170
- {
1171
- jsonApiType: 'build_event',
1172
- endpoints: [
1173
- {
1174
- returnsCollection: true,
1175
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-event/instances',
1176
- name: 'list',
1177
- rawName: 'rawList',
1178
- urlTemplate: '/build-events',
1179
- method: 'GET',
1180
- comment: 'List all deploy events',
1181
- simpleMethodAvailable: true,
1182
- responseType: 'BuildEventInstancesTargetSchema',
1183
- },
1184
- {
1185
- returnsCollection: false,
1186
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-event/self',
1187
- name: 'find',
1188
- rawName: 'rawFind',
1189
- urlTemplate: '/build-events/${buildEventId}',
1190
- method: 'GET',
1191
- comment: 'Retrieve a deploy event',
1192
- urlPlaceholder: {
1193
- variableName: 'buildEventId',
1194
- isEntityId: true,
1195
- relType: 'BuildEventData',
1196
- },
1197
- simpleMethodAvailable: true,
1198
- responseType: 'BuildEventSelfTargetSchema',
1199
- },
1200
- ],
1201
- namespace: 'buildEvents',
1202
- resourceClassName: 'BuildEvent',
1203
- },
1204
- {
1205
- jsonApiType: 'item',
1206
- endpoints: [
1207
- {
1208
- returnsCollection: true,
1209
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/instances',
1210
- name: 'list',
1211
- rawName: 'rawList',
1212
- urlTemplate: '/items',
1213
- method: 'GET',
1214
- comment: 'List all records',
1215
- simpleMethodAvailable: true,
1216
- queryParamsType: 'ItemInstancesHrefSchema',
1217
- responseType: 'ItemInstancesTargetSchema',
1218
- paginatedResponse: {
1219
- defaultLimit: 30,
1220
- maxLimit: 500,
1221
- },
1222
- },
1223
- {
1224
- returnsCollection: false,
1225
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/validate_existing',
1226
- name: 'validateExisting',
1227
- rawName: 'rawValidateExisting',
1228
- urlTemplate: '/items/${itemId}/validate',
1229
- method: 'POST',
1230
- comment: 'Validates an existing record field',
1231
- urlPlaceholder: {
1232
- variableName: 'itemId',
1233
- isEntityId: true,
1234
- relType: 'ItemData',
1235
- },
1236
- requestBodyType: 'ItemValidateExistingSchema',
1237
- simpleMethodAvailable: true,
1238
- requestStructure: {
1239
- type: 'item',
1240
- attributes: '*',
1241
- relationships: ['item_type', 'creator'],
1242
- },
1243
- deprecated: 'This API call is to be considered private and might change without notice',
1244
- },
1245
- {
1246
- returnsCollection: false,
1247
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/validate_new',
1248
- name: 'validateNew',
1249
- rawName: 'rawValidateNew',
1250
- urlTemplate: '/items/validate',
1251
- method: 'POST',
1252
- comment: 'Validates a record field',
1253
- requestBodyType: 'ItemValidateNewSchema',
1254
- simpleMethodAvailable: true,
1255
- requestStructure: {
1256
- type: 'item',
1257
- attributes: '*',
1258
- relationships: ['item_type'],
1259
- },
1260
- deprecated: 'This API call is to be considered private and might change without notice',
1261
- },
1262
- {
1263
- returnsCollection: false,
1264
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/create',
1265
- name: 'create',
1266
- rawName: 'rawCreate',
1267
- urlTemplate: '/items',
1268
- method: 'POST',
1269
- comment: 'Create a new record',
1270
- requestBodyType: 'ItemCreateSchema',
1271
- simpleMethodAvailable: true,
1272
- requestStructure: {
1273
- type: 'item',
1274
- attributes: '*',
1275
- relationships: ['item_type'],
1276
- },
1277
- responseType: 'ItemCreateTargetSchema',
1278
- },
1279
- {
1280
- returnsCollection: false,
1281
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/duplicate',
1282
- name: 'duplicate',
1283
- rawName: 'rawDuplicate',
1284
- urlTemplate: '/items/${itemId}/duplicate',
1285
- method: 'POST',
1286
- comment: 'Duplicate a record',
1287
- urlPlaceholder: {
1288
- variableName: 'itemId',
1289
- isEntityId: true,
1290
- relType: 'ItemData',
1291
- },
1292
- simpleMethodAvailable: true,
1293
- responseType: 'ItemDuplicateJobSchema',
1294
- },
1295
- {
1296
- returnsCollection: false,
1297
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/update',
1298
- name: 'update',
1299
- rawName: 'rawUpdate',
1300
- urlTemplate: '/items/${itemId}',
1301
- method: 'PUT',
1302
- comment: 'Update a record',
1303
- urlPlaceholder: {
1304
- variableName: 'itemId',
1305
- isEntityId: true,
1306
- relType: 'ItemData',
1307
- },
1308
- requestBodyType: 'ItemUpdateSchema',
1309
- simpleMethodAvailable: true,
1310
- requestStructure: {
1311
- type: 'item',
1312
- attributes: '*',
1313
- relationships: ['item_type', 'creator'],
1314
- },
1315
- responseType: 'ItemUpdateTargetSchema',
1316
- },
1317
- {
1318
- returnsCollection: false,
1319
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/references',
1320
- name: 'references',
1321
- rawName: 'rawReferences',
1322
- urlTemplate: '/items/${itemId}/references',
1323
- method: 'GET',
1324
- comment: 'Referenced records',
1325
- urlPlaceholder: {
1326
- variableName: 'itemId',
1327
- isEntityId: true,
1328
- relType: 'ItemData',
1329
- },
1330
- simpleMethodAvailable: true,
1331
- queryParamsType: 'ItemReferencesHrefSchema',
1332
- responseType: 'ItemReferencesTargetSchema',
1333
- },
1334
- {
1335
- returnsCollection: false,
1336
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/self',
1337
- name: 'find',
1338
- rawName: 'rawFind',
1339
- urlTemplate: '/items/${itemId}',
1340
- method: 'GET',
1341
- comment: 'Retrieve a record',
1342
- urlPlaceholder: {
1343
- variableName: 'itemId',
1344
- isEntityId: true,
1345
- relType: 'ItemData',
1346
- },
1347
- simpleMethodAvailable: true,
1348
- queryParamsType: 'ItemSelfHrefSchema',
1349
- responseType: 'ItemSelfTargetSchema',
1350
- },
1351
- {
1352
- returnsCollection: false,
1353
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/destroy',
1354
- name: 'destroy',
1355
- rawName: 'rawDestroy',
1356
- urlTemplate: '/items/${itemId}',
1357
- method: 'DELETE',
1358
- comment: 'Delete a record',
1359
- urlPlaceholder: {
1360
- variableName: 'itemId',
1361
- isEntityId: true,
1362
- relType: 'ItemData',
1363
- },
1364
- simpleMethodAvailable: true,
1365
- responseType: 'ItemDestroyJobSchema',
1366
- },
1367
- {
1368
- returnsCollection: false,
1369
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/batch_destroy',
1370
- name: 'batchDestroy',
1371
- rawName: 'rawBatchDestroy',
1372
- urlTemplate: '/items',
1373
- method: 'DELETE',
1374
- comment: 'Delete multiple records',
1375
- simpleMethodAvailable: true,
1376
- queryParamsType: 'ItemBatchDestroyHrefSchema',
1377
- responseType: 'ItemBatchDestroyJobSchema',
1378
- deprecated: 'This API call is to be considered private and might change without notice',
1379
- },
1380
- {
1381
- returnsCollection: false,
1382
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/batch_publish',
1383
- name: 'batchPublish',
1384
- rawName: 'rawBatchPublish',
1385
- urlTemplate: '/items/publish',
1386
- method: 'PUT',
1387
- comment: 'Publish multiple records',
1388
- simpleMethodAvailable: true,
1389
- queryParamsType: 'ItemBatchPublishHrefSchema',
1390
- responseType: 'ItemBatchPublishJobSchema',
1391
- deprecated: 'This API call is to be considered private and might change without notice',
1392
- },
1393
- {
1394
- returnsCollection: false,
1395
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/batch_unpublish',
1396
- name: 'batchUnpublish',
1397
- rawName: 'rawBatchUnpublish',
1398
- urlTemplate: '/items/unpublish',
1399
- method: 'PUT',
1400
- comment: 'Unpublish multiple records',
1401
- simpleMethodAvailable: true,
1402
- queryParamsType: 'ItemBatchUnpublishHrefSchema',
1403
- responseType: 'ItemBatchUnpublishJobSchema',
1404
- deprecated: 'This API call is to be considered private and might change without notice',
1405
- },
1406
- {
1407
- returnsCollection: false,
1408
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/publish',
1409
- name: 'publish',
1410
- rawName: 'rawPublish',
1411
- urlTemplate: '/items/${itemId}/publish',
1412
- method: 'PUT',
1413
- comment: 'Publish a record',
1414
- urlPlaceholder: {
1415
- variableName: 'itemId',
1416
- isEntityId: true,
1417
- relType: 'ItemData',
1418
- },
1419
- simpleMethodAvailable: true,
1420
- queryParamsType: 'ItemPublishHrefSchema',
1421
- responseType: 'ItemPublishTargetSchema',
1422
- },
1423
- {
1424
- returnsCollection: false,
1425
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/unpublish',
1426
- name: 'unpublish',
1427
- rawName: 'rawUnpublish',
1428
- urlTemplate: '/items/${itemId}/unpublish',
1429
- method: 'PUT',
1430
- comment: 'Unpublish a record',
1431
- urlPlaceholder: {
1432
- variableName: 'itemId',
1433
- isEntityId: true,
1434
- relType: 'ItemData',
1435
- },
1436
- simpleMethodAvailable: true,
1437
- queryParamsType: 'ItemUnpublishHrefSchema',
1438
- responseType: 'ItemUnpublishTargetSchema',
1439
- },
1440
- {
1441
- returnsCollection: false,
1442
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/bulk_publish',
1443
- name: 'bulkPublish',
1444
- rawName: 'rawBulkPublish',
1445
- urlTemplate: '/items/bulk/publish',
1446
- method: 'POST',
1447
- comment: 'Publish items in bulk',
1448
- requestBodyType: 'ItemBulkPublishSchema',
1449
- simpleMethodAvailable: true,
1450
- requestStructure: {
1451
- type: 'item_bulk_publish_operation',
1452
- attributes: [],
1453
- relationships: ['items'],
1454
- },
1455
- responseType: 'ItemBulkPublishJobSchema',
1456
- },
1457
- {
1458
- returnsCollection: false,
1459
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/bulk_unpublish',
1460
- name: 'bulkUnpublish',
1461
- rawName: 'rawBulkUnpublish',
1462
- urlTemplate: '/items/bulk/unpublish',
1463
- method: 'POST',
1464
- comment: 'Unpublish items in bulk',
1465
- requestBodyType: 'ItemBulkUnpublishSchema',
1466
- simpleMethodAvailable: true,
1467
- requestStructure: {
1468
- type: 'item_bulk_unpublish_operation',
1469
- attributes: [],
1470
- relationships: ['items'],
1471
- },
1472
- responseType: 'ItemBulkUnpublishJobSchema',
1473
- },
1474
- {
1475
- returnsCollection: false,
1476
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/bulk_destroy',
1477
- name: 'bulkDestroy',
1478
- rawName: 'rawBulkDestroy',
1479
- urlTemplate: '/items/bulk/destroy',
1480
- method: 'POST',
1481
- comment: 'Destroy items in bulk',
1482
- requestBodyType: 'ItemBulkDestroySchema',
1483
- simpleMethodAvailable: true,
1484
- requestStructure: {
1485
- type: 'item_bulk_destroy_operation',
1486
- attributes: [],
1487
- relationships: ['items'],
1488
- },
1489
- responseType: 'ItemBulkDestroyJobSchema',
1490
- },
1491
- {
1492
- returnsCollection: false,
1493
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item/bulk_move_to_stage',
1494
- name: 'bulkMoveToStage',
1495
- rawName: 'rawBulkMoveToStage',
1496
- urlTemplate: '/items/bulk/move-to-stage',
1497
- method: 'POST',
1498
- comment: 'Move items to stage in bulk',
1499
- requestBodyType: 'ItemBulkMoveToStageSchema',
1500
- simpleMethodAvailable: true,
1501
- requestStructure: {
1502
- type: 'item_bulk_move_to_stage_operation',
1503
- attributes: ['stage'],
1504
- relationships: ['items'],
1505
- },
1506
- responseType: 'ItemBulkMoveToStageJobSchema',
1507
- },
1508
- ],
1509
- namespace: 'items',
1510
- resourceClassName: 'Item',
1511
- },
1512
- {
1513
- jsonApiType: 'item_version',
1514
- endpoints: [
1515
- {
1516
- returnsCollection: false,
1517
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-version/restore',
1518
- name: 'restore',
1519
- rawName: 'rawRestore',
1520
- urlTemplate: '/versions/${itemVersionId}/restore',
1521
- method: 'POST',
1522
- comment: 'Restore an old record version',
1523
- urlPlaceholder: {
1524
- variableName: 'itemVersionId',
1525
- isEntityId: true,
1526
- relType: 'ItemVersionData',
1527
- },
1528
- simpleMethodAvailable: true,
1529
- responseType: 'ItemVersionRestoreJobSchema',
1530
- },
1531
- {
1532
- returnsCollection: true,
1533
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-version/instances',
1534
- name: 'list',
1535
- rawName: 'rawList',
1536
- urlTemplate: '/items/${itemId}/versions',
1537
- method: 'GET',
1538
- comment: 'List all record versions',
1539
- urlPlaceholder: {
1540
- variableName: 'itemId',
1541
- isEntityId: false,
1542
- relType: 'ItemData',
1543
- },
1544
- simpleMethodAvailable: true,
1545
- queryParamsType: 'ItemVersionInstancesHrefSchema',
1546
- responseType: 'ItemVersionInstancesTargetSchema',
1547
- paginatedResponse: {
1548
- defaultLimit: 15,
1549
- maxLimit: 50,
1550
- },
1551
- },
1552
- {
1553
- returnsCollection: false,
1554
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-version/self',
1555
- name: 'find',
1556
- rawName: 'rawFind',
1557
- urlTemplate: '/versions/${itemVersionId}',
1558
- method: 'GET',
1559
- comment: 'Retrieve a record version',
1560
- urlPlaceholder: {
1561
- variableName: 'itemVersionId',
1562
- isEntityId: true,
1563
- relType: 'ItemVersionData',
1564
- },
1565
- simpleMethodAvailable: true,
1566
- responseType: 'ItemVersionSelfTargetSchema',
1567
- },
1568
- ],
1569
- namespace: 'itemVersions',
1570
- resourceClassName: 'ItemVersion',
1571
- },
1572
- {
1573
- jsonApiType: 'upload',
1574
- endpoints: [
1575
- {
1576
- returnsCollection: false,
1577
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/create',
1578
- name: 'create',
1579
- rawName: 'rawCreate',
1580
- urlTemplate: '/uploads',
1581
- method: 'POST',
1582
- comment: 'Create a new upload',
1583
- requestBodyType: 'UploadCreateSchema',
1584
- simpleMethodAvailable: true,
1585
- requestStructure: {
1586
- type: 'upload',
1587
- attributes: [
1588
- 'path',
1589
- 'copyright',
1590
- 'author',
1591
- 'notes',
1592
- 'default_field_metadata',
1593
- 'tags',
1594
- ],
1595
- relationships: [],
1596
- },
1597
- responseType: 'UploadCreateJobSchema',
1598
- },
1599
- {
1600
- returnsCollection: true,
1601
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/instances',
1602
- name: 'list',
1603
- rawName: 'rawList',
1604
- urlTemplate: '/uploads',
1605
- method: 'GET',
1606
- comment: 'List all uploads',
1607
- simpleMethodAvailable: true,
1608
- queryParamsType: 'UploadInstancesHrefSchema',
1609
- responseType: 'UploadInstancesTargetSchema',
1610
- paginatedResponse: {
1611
- defaultLimit: 30,
1612
- maxLimit: 500,
1613
- },
1614
- },
1615
- {
1616
- returnsCollection: false,
1617
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/self',
1618
- name: 'find',
1619
- rawName: 'rawFind',
1620
- urlTemplate: '/uploads/${uploadId}',
1621
- method: 'GET',
1622
- comment: 'Retrieve an upload',
1623
- urlPlaceholder: {
1624
- variableName: 'uploadId',
1625
- isEntityId: true,
1626
- relType: 'UploadData',
1627
- },
1628
- simpleMethodAvailable: true,
1629
- responseType: 'UploadSelfTargetSchema',
1630
- },
1631
- {
1632
- returnsCollection: false,
1633
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/destroy',
1634
- name: 'destroy',
1635
- rawName: 'rawDestroy',
1636
- urlTemplate: '/uploads/${uploadId}',
1637
- method: 'DELETE',
1638
- comment: 'Delete an upload',
1639
- urlPlaceholder: {
1640
- variableName: 'uploadId',
1641
- isEntityId: true,
1642
- relType: 'UploadData',
1643
- },
1644
- simpleMethodAvailable: true,
1645
- responseType: 'UploadDestroyTargetSchema',
1646
- },
1647
- {
1648
- returnsCollection: false,
1649
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/update',
1650
- name: 'update',
1651
- rawName: 'rawUpdate',
1652
- urlTemplate: '/uploads/${uploadId}',
1653
- method: 'PUT',
1654
- comment: 'Update an upload',
1655
- urlPlaceholder: {
1656
- variableName: 'uploadId',
1657
- isEntityId: true,
1658
- relType: 'UploadData',
1659
- },
1660
- requestBodyType: 'UploadUpdateSchema',
1661
- simpleMethodAvailable: true,
1662
- requestStructure: {
1663
- type: 'upload',
1664
- attributes: [
1665
- 'path',
1666
- 'basename',
1667
- 'copyright',
1668
- 'author',
1669
- 'notes',
1670
- 'tags',
1671
- 'default_field_metadata',
1672
- ],
1673
- relationships: ['creator'],
1674
- },
1675
- responseType: 'UploadUpdateJobSchema',
1676
- },
1677
- {
1678
- returnsCollection: false,
1679
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags',
1680
- name: 'batchAddTags',
1681
- rawName: 'rawBatchAddTags',
1682
- urlTemplate: '/uploads/batch-add-tags',
1683
- method: 'PUT',
1684
- comment: 'Batch add tags to uploads',
1685
- requestBodyType: 'UploadBatchAddTagsSchema',
1686
- simpleMethodAvailable: true,
1687
- requestStructure: {
1688
- type: 'upload',
1689
- attributes: ['tags'],
1690
- relationships: [],
1691
- },
1692
- queryParamsType: 'UploadBatchAddTagsHrefSchema',
1693
- responseType: 'UploadBatchAddTagsJobSchema',
1694
- deprecated: 'This API call is to be considered private and might change without notice',
1695
- },
1696
- {
1697
- returnsCollection: false,
1698
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy',
1699
- name: 'batchDestroy',
1700
- rawName: 'rawBatchDestroy',
1701
- urlTemplate: '/uploads/batch-destroy',
1702
- method: 'DELETE',
1703
- comment: 'Delete multiple uploads',
1704
- simpleMethodAvailable: true,
1705
- queryParamsType: 'UploadBatchDestroyHrefSchema',
1706
- responseType: 'UploadBatchDestroyJobSchema',
1707
- deprecated: 'This API call is to be considered private and might change without notice',
1708
- },
1709
- {
1710
- returnsCollection: false,
1711
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/references',
1712
- name: 'references',
1713
- rawName: 'rawReferences',
1714
- urlTemplate: '/uploads/${uploadId}/references',
1715
- method: 'GET',
1716
- comment: 'Referenced records',
1717
- urlPlaceholder: {
1718
- variableName: 'uploadId',
1719
- isEntityId: true,
1720
- relType: 'UploadData',
1721
- },
1722
- simpleMethodAvailable: true,
1723
- queryParamsType: 'UploadReferencesHrefSchema',
1724
- responseType: 'UploadReferencesTargetSchema',
1725
- },
1726
- {
1727
- returnsCollection: false,
1728
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag',
1729
- name: 'bulkTag',
1730
- rawName: 'rawBulkTag',
1731
- urlTemplate: '/uploads/bulk/tag',
1732
- method: 'POST',
1733
- comment: 'Add tags to assets in bulk',
1734
- requestBodyType: 'UploadBulkTagSchema',
1735
- simpleMethodAvailable: true,
1736
- requestStructure: {
1737
- type: 'upload_bulk_tag_operation',
1738
- attributes: ['tags'],
1739
- relationships: ['uploads'],
1740
- },
1741
- responseType: 'UploadBulkTagJobSchema',
1742
- },
1743
- {
1744
- returnsCollection: false,
1745
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy',
1746
- name: 'bulkDestroy',
1747
- rawName: 'rawBulkDestroy',
1748
- urlTemplate: '/uploads/bulk/destroy',
1749
- method: 'POST',
1750
- comment: 'Destroy uploads',
1751
- requestBodyType: 'UploadBulkDestroySchema',
1752
- simpleMethodAvailable: true,
1753
- requestStructure: {
1754
- type: 'upload_bulk_destroy_operation',
1755
- attributes: [],
1756
- relationships: ['uploads'],
1757
- },
1758
- responseType: 'UploadBulkDestroyJobSchema',
1759
- },
1760
- ],
1761
- namespace: 'uploads',
1762
- resourceClassName: 'Upload',
1763
- },
1764
- {
1765
- jsonApiType: 'upload_request',
1766
- endpoints: [
1767
- {
1768
- returnsCollection: false,
1769
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-request/create',
1770
- name: 'create',
1771
- rawName: 'rawCreate',
1772
- urlTemplate: '/upload-requests',
1773
- method: 'POST',
1774
- comment: 'Request a new upload',
1775
- requestBodyType: 'UploadRequestCreateSchema',
1776
- simpleMethodAvailable: true,
1777
- requestStructure: {
1778
- type: 'upload_request',
1779
- attributes: ['filename'],
1780
- relationships: [],
1781
- },
1782
- responseType: 'UploadRequestCreateTargetSchema',
1783
- },
1784
- ],
1785
- namespace: 'uploadRequest',
1786
- resourceClassName: 'UploadRequest',
1787
- },
1788
- {
1789
- jsonApiType: 'scheduled_publication',
1790
- endpoints: [
1791
- {
1792
- returnsCollection: false,
1793
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create',
1794
- name: 'create',
1795
- rawName: 'rawCreate',
1796
- urlTemplate: '/items/${itemId}/scheduled-publication',
1797
- method: 'POST',
1798
- comment: 'Create a new scheduled publication',
1799
- urlPlaceholder: {
1800
- variableName: 'itemId',
1801
- isEntityId: false,
1802
- relType: 'ItemData',
1803
- },
1804
- requestBodyType: 'ScheduledPublicationCreateSchema',
1805
- simpleMethodAvailable: true,
1806
- requestStructure: {
1807
- type: 'scheduled_publication',
1808
- attributes: ['publication_scheduled_at'],
1809
- relationships: [],
1810
- },
1811
- responseType: 'ScheduledPublicationCreateTargetSchema',
1812
- },
1813
- {
1814
- returnsCollection: false,
1815
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy',
1816
- name: 'destroy',
1817
- rawName: 'rawDestroy',
1818
- urlTemplate: '/items/${itemId}/scheduled-publication',
1819
- method: 'DELETE',
1820
- comment: 'Delete a scheduled publication',
1821
- urlPlaceholder: {
1822
- variableName: 'itemId',
1823
- isEntityId: false,
1824
- relType: 'ItemData',
1825
- },
1826
- simpleMethodAvailable: true,
1827
- responseType: 'ScheduledPublicationDestroyTargetSchema',
1828
- },
1829
- ],
1830
- namespace: 'scheduledPublication',
1831
- resourceClassName: 'ScheduledPublication',
1832
- },
1833
- {
1834
- jsonApiType: 'scheduled_unpublishing',
1835
- endpoints: [
1836
- {
1837
- returnsCollection: false,
1838
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create',
1839
- name: 'create',
1840
- rawName: 'rawCreate',
1841
- urlTemplate: '/items/${itemId}/scheduled-unpublishing',
1842
- method: 'POST',
1843
- comment: 'Create a new scheduled unpublishing',
1844
- urlPlaceholder: {
1845
- variableName: 'itemId',
1846
- isEntityId: false,
1847
- relType: 'ItemData',
1848
- },
1849
- requestBodyType: 'ScheduledUnpublishingCreateSchema',
1850
- simpleMethodAvailable: true,
1851
- requestStructure: {
1852
- type: 'scheduled_unpublishing',
1853
- attributes: ['unpublishing_scheduled_at'],
1854
- relationships: [],
1855
- },
1856
- responseType: 'ScheduledUnpublishingCreateTargetSchema',
1857
- },
1858
- {
1859
- returnsCollection: false,
1860
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy',
1861
- name: 'destroy',
1862
- rawName: 'rawDestroy',
1863
- urlTemplate: '/items/${itemId}/scheduled-unpublishing',
1864
- method: 'DELETE',
1865
- comment: 'Delete a scheduled unpublishing',
1866
- urlPlaceholder: {
1867
- variableName: 'itemId',
1868
- isEntityId: false,
1869
- relType: 'ItemData',
1870
- },
1871
- simpleMethodAvailable: true,
1872
- responseType: 'ScheduledUnpublishingDestroyTargetSchema',
1873
- },
1874
- ],
1875
- namespace: 'scheduledUnpublishing',
1876
- resourceClassName: 'ScheduledUnpublishing',
1877
- },
1878
- {
1879
- jsonApiType: 'search_result',
1880
- endpoints: [
1881
- {
1882
- returnsCollection: true,
1883
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/search-result/instances',
1884
- name: 'list',
1885
- rawName: 'rawList',
1886
- urlTemplate: '/search-results',
1887
- method: 'GET',
1888
- comment: 'Search for results',
1889
- simpleMethodAvailable: true,
1890
- queryParamsType: 'SearchResultInstancesHrefSchema',
1891
- responseType: 'SearchResultInstancesTargetSchema',
1892
- },
1893
- ],
1894
- namespace: 'searchResults',
1895
- resourceClassName: 'SearchResult',
1896
- },
1897
- {
1898
- jsonApiType: 'environment',
1899
- endpoints: [
1900
- {
1901
- returnsCollection: false,
1902
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/environment/fork',
1903
- name: 'fork',
1904
- rawName: 'rawFork',
1905
- urlTemplate: '/environments/${environmentId}/fork',
1906
- method: 'POST',
1907
- comment: 'Fork an existing environment',
1908
- urlPlaceholder: {
1909
- variableName: 'environmentId',
1910
- isEntityId: true,
1911
- relType: 'EnvironmentData',
1912
- },
1913
- requestBodyType: 'EnvironmentForkSchema',
1914
- simpleMethodAvailable: true,
1915
- requestStructure: {
1916
- type: 'environment',
1917
- attributes: [],
1918
- relationships: [],
1919
- },
1920
- responseType: 'EnvironmentForkJobSchema',
1921
- },
1922
- {
1923
- returnsCollection: false,
1924
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/environment/promote',
1925
- name: 'promote',
1926
- rawName: 'rawPromote',
1927
- urlTemplate: '/environments/${environmentId}/promote',
1928
- method: 'PUT',
1929
- comment: 'Promote an environment to primary',
1930
- urlPlaceholder: {
1931
- variableName: 'environmentId',
1932
- isEntityId: true,
1933
- relType: 'EnvironmentData',
1934
- },
1935
- simpleMethodAvailable: true,
1936
- responseType: 'EnvironmentPromoteTargetSchema',
1937
- },
1938
- {
1939
- returnsCollection: true,
1940
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/environment/instances',
1941
- name: 'list',
1942
- rawName: 'rawList',
1943
- urlTemplate: '/environments',
1944
- method: 'GET',
1945
- comment: 'List all environments',
1946
- simpleMethodAvailable: true,
1947
- responseType: 'EnvironmentInstancesTargetSchema',
1948
- },
1949
- {
1950
- returnsCollection: false,
1951
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/environment/self',
1952
- name: 'find',
1953
- rawName: 'rawFind',
1954
- urlTemplate: '/environments/${environmentId}',
1955
- method: 'GET',
1956
- comment: 'Retrieve a environment',
1957
- urlPlaceholder: {
1958
- variableName: 'environmentId',
1959
- isEntityId: true,
1960
- relType: 'EnvironmentData',
1961
- },
1962
- simpleMethodAvailable: true,
1963
- responseType: 'EnvironmentSelfTargetSchema',
1964
- },
1965
- {
1966
- returnsCollection: false,
1967
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/environment/destroy',
1968
- name: 'destroy',
1969
- rawName: 'rawDestroy',
1970
- urlTemplate: '/environments/${environmentId}',
1971
- method: 'DELETE',
1972
- comment: 'Delete a environment',
1973
- urlPlaceholder: {
1974
- variableName: 'environmentId',
1975
- isEntityId: true,
1976
- relType: 'EnvironmentData',
1977
- },
1978
- simpleMethodAvailable: true,
1979
- responseType: 'EnvironmentDestroyJobSchema',
1980
- },
1981
- ],
1982
- namespace: 'environments',
1983
- resourceClassName: 'Environment',
1984
- },
1985
- {
1986
- jsonApiType: 'maintenance_mode',
1987
- endpoints: [
1988
- {
1989
- returnsCollection: false,
1990
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self',
1991
- name: 'find',
1992
- rawName: 'rawFind',
1993
- urlTemplate: '/maintenance-mode',
1994
- method: 'GET',
1995
- comment: 'Retrieve maintenence mode',
1996
- simpleMethodAvailable: true,
1997
- responseType: 'MaintenanceModeSelfTargetSchema',
1998
- },
1999
- {
2000
- returnsCollection: false,
2001
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate',
2002
- name: 'activate',
2003
- rawName: 'rawActivate',
2004
- urlTemplate: '/maintenance-mode/activate',
2005
- method: 'PUT',
2006
- comment: 'Activate maintenance mode: this means that the primary environment will be read-only',
2007
- simpleMethodAvailable: true,
2008
- queryParamsType: 'MaintenanceModeActivateHrefSchema',
2009
- responseType: 'MaintenanceModeActivateTargetSchema',
2010
- },
2011
- {
2012
- returnsCollection: false,
2013
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate',
2014
- name: 'deactivate',
2015
- rawName: 'rawDeactivate',
2016
- urlTemplate: '/maintenance-mode/deactivate',
2017
- method: 'PUT',
2018
- comment: 'De-activate maintenance mode',
2019
- simpleMethodAvailable: true,
2020
- responseType: 'MaintenanceModeDeactivateTargetSchema',
2021
- },
2022
- ],
2023
- namespace: 'maintenanceMode',
2024
- resourceClassName: 'MaintenanceMode',
2025
- },
2026
- {
2027
- jsonApiType: 'webhook',
2028
- endpoints: [
2029
- {
2030
- returnsCollection: false,
2031
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook/create',
2032
- name: 'create',
2033
- rawName: 'rawCreate',
2034
- urlTemplate: '/webhooks',
2035
- method: 'POST',
2036
- comment: 'Create a new webhook',
2037
- requestBodyType: 'WebhookCreateSchema',
2038
- simpleMethodAvailable: true,
2039
- requestStructure: {
2040
- type: 'webhook',
2041
- attributes: [
2042
- 'name',
2043
- 'url',
2044
- 'custom_payload',
2045
- 'headers',
2046
- 'events',
2047
- 'http_basic_user',
2048
- 'http_basic_password',
2049
- 'enabled',
2050
- 'payload_api_version',
2051
- 'nested_items_in_payload',
2052
- ],
2053
- relationships: [],
2054
- },
2055
- responseType: 'WebhookCreateTargetSchema',
2056
- },
2057
- {
2058
- returnsCollection: false,
2059
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook/update',
2060
- name: 'update',
2061
- rawName: 'rawUpdate',
2062
- urlTemplate: '/webhooks/${userId}',
2063
- method: 'PUT',
2064
- comment: 'Update a webhook',
2065
- urlPlaceholder: {
2066
- variableName: 'userId',
2067
- isEntityId: false,
2068
- relType: 'UserData',
2069
- },
2070
- requestBodyType: 'WebhookUpdateSchema',
2071
- simpleMethodAvailable: true,
2072
- requestStructure: {
2073
- type: 'webhook',
2074
- attributes: [
2075
- 'name',
2076
- 'url',
2077
- 'custom_payload',
2078
- 'headers',
2079
- 'events',
2080
- 'http_basic_user',
2081
- 'http_basic_password',
2082
- 'enabled',
2083
- 'payload_api_version',
2084
- 'nested_items_in_payload',
2085
- ],
2086
- relationships: [],
2087
- },
2088
- responseType: 'WebhookUpdateTargetSchema',
2089
- },
2090
- {
2091
- returnsCollection: true,
2092
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook/instances',
2093
- name: 'list',
2094
- rawName: 'rawList',
2095
- urlTemplate: '/webhooks',
2096
- method: 'GET',
2097
- comment: 'List all webhooks',
2098
- simpleMethodAvailable: true,
2099
- responseType: 'WebhookInstancesTargetSchema',
2100
- },
2101
- {
2102
- returnsCollection: false,
2103
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook/self',
2104
- name: 'find',
2105
- rawName: 'rawFind',
2106
- urlTemplate: '/webhooks/${userId}',
2107
- method: 'GET',
2108
- comment: 'Retrieve a webhook',
2109
- urlPlaceholder: {
2110
- variableName: 'userId',
2111
- isEntityId: false,
2112
- relType: 'UserData',
2113
- },
2114
- simpleMethodAvailable: true,
2115
- responseType: 'WebhookSelfTargetSchema',
2116
- },
2117
- {
2118
- returnsCollection: false,
2119
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook/destroy',
2120
- name: 'destroy',
2121
- rawName: 'rawDestroy',
2122
- urlTemplate: '/webhooks/${userId}',
2123
- method: 'DELETE',
2124
- comment: 'Delete a webhook',
2125
- urlPlaceholder: {
2126
- variableName: 'userId',
2127
- isEntityId: false,
2128
- relType: 'UserData',
2129
- },
2130
- simpleMethodAvailable: true,
2131
- responseType: 'WebhookDestroyTargetSchema',
2132
- },
2133
- ],
2134
- namespace: 'webhooks',
2135
- resourceClassName: 'Webhook',
2136
- },
2137
- {
2138
- jsonApiType: 'webhook_call',
2139
- endpoints: [
2140
- {
2141
- returnsCollection: true,
2142
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances',
2143
- name: 'list',
2144
- rawName: 'rawList',
2145
- urlTemplate: '/webhook_calls',
2146
- method: 'GET',
2147
- comment: 'List all webhooks calls',
2148
- simpleMethodAvailable: true,
2149
- queryParamsType: 'WebhookCallInstancesHrefSchema',
2150
- responseType: 'WebhookCallInstancesTargetSchema',
2151
- paginatedResponse: {
2152
- defaultLimit: 30,
2153
- maxLimit: 500,
2154
- },
2155
- },
2156
- {
2157
- returnsCollection: false,
2158
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook',
2159
- name: 'resendWebhook',
2160
- rawName: 'rawResendWebhook',
2161
- urlTemplate: '/webhook_calls/${userId}/resend_webhook',
2162
- method: 'POST',
2163
- comment: 'Re-send the webhook call',
2164
- urlPlaceholder: {
2165
- variableName: 'userId',
2166
- isEntityId: false,
2167
- relType: 'UserData',
2168
- },
2169
- simpleMethodAvailable: true,
2170
- },
2171
- ],
2172
- namespace: 'webhookCalls',
2173
- resourceClassName: 'WebhookCall',
2174
- },
2175
- {
2176
- jsonApiType: 'build_trigger',
2177
- endpoints: [
2178
- {
2179
- returnsCollection: true,
2180
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances',
2181
- name: 'list',
2182
- rawName: 'rawList',
2183
- urlTemplate: '/build-triggers',
2184
- method: 'GET',
2185
- comment: 'List all build triggers for a site',
2186
- simpleMethodAvailable: true,
2187
- responseType: 'BuildTriggerInstancesTargetSchema',
2188
- },
2189
- {
2190
- returnsCollection: false,
2191
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/self',
2192
- name: 'find',
2193
- rawName: 'rawFind',
2194
- urlTemplate: '/build-triggers/${buildTriggerId}',
2195
- method: 'GET',
2196
- comment: 'Retrieve a build trigger',
2197
- urlPlaceholder: {
2198
- variableName: 'buildTriggerId',
2199
- isEntityId: true,
2200
- relType: 'BuildTriggerData',
2201
- },
2202
- simpleMethodAvailable: true,
2203
- responseType: 'BuildTriggerSelfTargetSchema',
2204
- },
2205
- {
2206
- returnsCollection: false,
2207
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/create',
2208
- name: 'create',
2209
- rawName: 'rawCreate',
2210
- urlTemplate: '/build-triggers',
2211
- method: 'POST',
2212
- comment: 'Create build trigger',
2213
- requestBodyType: 'BuildTriggerCreateSchema',
2214
- simpleMethodAvailable: true,
2215
- requestStructure: {
2216
- type: 'build_trigger',
2217
- attributes: [
2218
- 'name',
2219
- 'webhook_token',
2220
- 'adapter',
2221
- 'indexing_enabled',
2222
- 'frontend_url',
2223
- 'autotrigger_on_scheduled_publications',
2224
- 'adapter_settings',
2225
- ],
2226
- relationships: [],
2227
- },
2228
- responseType: 'BuildTriggerCreateTargetSchema',
2229
- },
2230
- {
2231
- returnsCollection: false,
2232
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/update',
2233
- name: 'update',
2234
- rawName: 'rawUpdate',
2235
- urlTemplate: '/build-triggers/${buildTriggerId}',
2236
- method: 'PUT',
2237
- comment: 'Update build trigger',
2238
- urlPlaceholder: {
2239
- variableName: 'buildTriggerId',
2240
- isEntityId: true,
2241
- relType: 'BuildTriggerData',
2242
- },
2243
- requestBodyType: 'BuildTriggerUpdateSchema',
2244
- simpleMethodAvailable: true,
2245
- requestStructure: {
2246
- type: 'build_trigger',
2247
- attributes: [
2248
- 'name',
2249
- 'adapter',
2250
- 'indexing_enabled',
2251
- 'frontend_url',
2252
- 'autotrigger_on_scheduled_publications',
2253
- 'adapter_settings',
2254
- ],
2255
- relationships: [],
2256
- },
2257
- responseType: 'BuildTriggerUpdateTargetSchema',
2258
- },
2259
- {
2260
- returnsCollection: false,
2261
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger',
2262
- name: 'trigger',
2263
- rawName: 'rawTrigger',
2264
- urlTemplate: '/build-triggers/${buildTriggerId}/trigger',
2265
- method: 'POST',
2266
- comment: 'Trigger a deploy',
2267
- urlPlaceholder: {
2268
- variableName: 'buildTriggerId',
2269
- isEntityId: true,
2270
- relType: 'BuildTriggerData',
2271
- },
2272
- simpleMethodAvailable: true,
2273
- },
2274
- {
2275
- returnsCollection: false,
2276
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex',
2277
- name: 'reindex',
2278
- rawName: 'rawReindex',
2279
- urlTemplate: '/build-triggers/${buildTriggerId}/reindex',
2280
- method: 'PUT',
2281
- comment: 'Trigger a new Site Search spidering of the website',
2282
- urlPlaceholder: {
2283
- variableName: 'buildTriggerId',
2284
- isEntityId: true,
2285
- relType: 'BuildTriggerData',
2286
- },
2287
- simpleMethodAvailable: true,
2288
- },
2289
- {
2290
- returnsCollection: false,
2291
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy',
2292
- name: 'destroy',
2293
- rawName: 'rawDestroy',
2294
- urlTemplate: '/build-triggers/${buildTriggerId}',
2295
- method: 'DELETE',
2296
- comment: 'Delete a build trigger',
2297
- urlPlaceholder: {
2298
- variableName: 'buildTriggerId',
2299
- isEntityId: true,
2300
- relType: 'BuildTriggerData',
2301
- },
2302
- simpleMethodAvailable: true,
2303
- responseType: 'BuildTriggerDestroyTargetSchema',
2304
- },
2305
- ],
2306
- namespace: 'buildTriggers',
2307
- resourceClassName: 'BuildTrigger',
2308
- },
2309
- {
2310
- jsonApiType: 'item_type_filter',
2311
- endpoints: [
2312
- {
2313
- returnsCollection: false,
2314
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/create',
2315
- name: 'create',
2316
- rawName: 'rawCreate',
2317
- urlTemplate: '/item-type-filters',
2318
- method: 'POST',
2319
- comment: 'Create a new filter',
2320
- requestBodyType: 'ItemTypeFilterCreateSchema',
2321
- simpleMethodAvailable: true,
2322
- requestStructure: {
2323
- type: 'item_type_filter',
2324
- attributes: ['name', 'filter', 'shared'],
2325
- relationships: ['item_type'],
2326
- },
2327
- responseType: 'ItemTypeFilterCreateTargetSchema',
2328
- },
2329
- {
2330
- returnsCollection: false,
2331
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/update',
2332
- name: 'update',
2333
- rawName: 'rawUpdate',
2334
- urlTemplate: '/item-type-filters/${itemTypeFilterId}',
2335
- method: 'PUT',
2336
- comment: 'Update a filter',
2337
- urlPlaceholder: {
2338
- variableName: 'itemTypeFilterId',
2339
- isEntityId: true,
2340
- relType: 'ItemTypeFilterData',
2341
- },
2342
- requestBodyType: 'ItemTypeFilterUpdateSchema',
2343
- simpleMethodAvailable: true,
2344
- requestStructure: {
2345
- type: 'item_type_filter',
2346
- attributes: ['name', 'shared', 'filter'],
2347
- relationships: [],
2348
- },
2349
- responseType: 'ItemTypeFilterUpdateTargetSchema',
2350
- },
2351
- {
2352
- returnsCollection: true,
2353
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/instances',
2354
- name: 'list',
2355
- rawName: 'rawList',
2356
- urlTemplate: '/item-type-filters',
2357
- method: 'GET',
2358
- comment: 'List all filters',
2359
- simpleMethodAvailable: true,
2360
- responseType: 'ItemTypeFilterInstancesTargetSchema',
2361
- },
2362
- {
2363
- returnsCollection: false,
2364
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/self',
2365
- name: 'find',
2366
- rawName: 'rawFind',
2367
- urlTemplate: '/item-type-filters/${itemTypeFilterId}',
2368
- method: 'GET',
2369
- comment: 'Retrieve a filter',
2370
- urlPlaceholder: {
2371
- variableName: 'itemTypeFilterId',
2372
- isEntityId: true,
2373
- relType: 'ItemTypeFilterData',
2374
- },
2375
- simpleMethodAvailable: true,
2376
- responseType: 'ItemTypeFilterSelfTargetSchema',
2377
- },
2378
- {
2379
- returnsCollection: false,
2380
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/item-type_filter/destroy',
2381
- name: 'destroy',
2382
- rawName: 'rawDestroy',
2383
- urlTemplate: '/item-type-filters/${itemTypeFilterId}',
2384
- method: 'DELETE',
2385
- comment: 'Delete a filter',
2386
- urlPlaceholder: {
2387
- variableName: 'itemTypeFilterId',
2388
- isEntityId: true,
2389
- relType: 'ItemTypeFilterData',
2390
- },
2391
- simpleMethodAvailable: true,
2392
- responseType: 'ItemTypeFilterDestroyTargetSchema',
2393
- },
2394
- ],
2395
- namespace: 'itemTypeFilters',
2396
- resourceClassName: 'ItemTypeFilter',
2397
- },
2398
- {
2399
- jsonApiType: 'upload_filter',
2400
- endpoints: [
2401
- {
2402
- returnsCollection: false,
2403
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-filter/create',
2404
- name: 'create',
2405
- rawName: 'rawCreate',
2406
- urlTemplate: '/upload-filters',
2407
- method: 'POST',
2408
- comment: 'Create a new filter',
2409
- requestBodyType: 'UploadFilterCreateSchema',
2410
- simpleMethodAvailable: true,
2411
- requestStructure: {
2412
- type: 'upload_filter',
2413
- attributes: ['name', 'filter', 'shared'],
2414
- relationships: [],
2415
- },
2416
- responseType: 'UploadFilterCreateTargetSchema',
2417
- },
2418
- {
2419
- returnsCollection: false,
2420
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-filter/update',
2421
- name: 'update',
2422
- rawName: 'rawUpdate',
2423
- urlTemplate: '/upload-filters/${uploadFilterId}',
2424
- method: 'PUT',
2425
- comment: 'Update a filter',
2426
- urlPlaceholder: {
2427
- variableName: 'uploadFilterId',
2428
- isEntityId: true,
2429
- relType: 'UploadFilterData',
2430
- },
2431
- requestBodyType: 'UploadFilterUpdateSchema',
2432
- simpleMethodAvailable: true,
2433
- requestStructure: {
2434
- type: 'upload_filter',
2435
- attributes: ['name', 'shared', 'filter'],
2436
- relationships: [],
2437
- },
2438
- responseType: 'UploadFilterUpdateTargetSchema',
2439
- },
2440
- {
2441
- returnsCollection: true,
2442
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances',
2443
- name: 'list',
2444
- rawName: 'rawList',
2445
- urlTemplate: '/upload-filters',
2446
- method: 'GET',
2447
- comment: 'List all filters',
2448
- simpleMethodAvailable: true,
2449
- responseType: 'UploadFilterInstancesTargetSchema',
2450
- },
2451
- {
2452
- returnsCollection: false,
2453
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-filter/self',
2454
- name: 'find',
2455
- rawName: 'rawFind',
2456
- urlTemplate: '/upload-filters/${uploadFilterId}',
2457
- method: 'GET',
2458
- comment: 'Retrieve a filter',
2459
- urlPlaceholder: {
2460
- variableName: 'uploadFilterId',
2461
- isEntityId: true,
2462
- relType: 'UploadFilterData',
2463
- },
2464
- simpleMethodAvailable: true,
2465
- responseType: 'UploadFilterSelfTargetSchema',
2466
- },
2467
- {
2468
- returnsCollection: false,
2469
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy',
2470
- name: 'destroy',
2471
- rawName: 'rawDestroy',
2472
- urlTemplate: '/upload-filters/${uploadFilterId}',
2473
- method: 'DELETE',
2474
- comment: 'Delete a filter',
2475
- urlPlaceholder: {
2476
- variableName: 'uploadFilterId',
2477
- isEntityId: true,
2478
- relType: 'UploadFilterData',
2479
- },
2480
- simpleMethodAvailable: true,
2481
- responseType: 'UploadFilterDestroyTargetSchema',
2482
- },
2483
- ],
2484
- namespace: 'uploadFilters',
2485
- resourceClassName: 'UploadFilter',
2486
- },
2487
- {
2488
- jsonApiType: 'site_invitation',
2489
- endpoints: [
2490
- {
2491
- returnsCollection: false,
2492
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/create',
2493
- name: 'create',
2494
- rawName: 'rawCreate',
2495
- urlTemplate: '/site-invitations',
2496
- method: 'POST',
2497
- comment: 'Invite a new user',
2498
- requestBodyType: 'SiteInvitationCreateSchema',
2499
- simpleMethodAvailable: true,
2500
- requestStructure: {
2501
- type: 'site_invitation',
2502
- attributes: ['email'],
2503
- relationships: ['role'],
2504
- },
2505
- responseType: 'SiteInvitationCreateTargetSchema',
2506
- },
2507
- {
2508
- returnsCollection: false,
2509
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/update',
2510
- name: 'update',
2511
- rawName: 'rawUpdate',
2512
- urlTemplate: '/site-invitations/${siteInvitationId}',
2513
- method: 'PUT',
2514
- comment: 'Update an invitation',
2515
- urlPlaceholder: {
2516
- variableName: 'siteInvitationId',
2517
- isEntityId: true,
2518
- relType: 'SiteInvitationData',
2519
- },
2520
- requestBodyType: 'SiteInvitationUpdateSchema',
2521
- simpleMethodAvailable: true,
2522
- requestStructure: {
2523
- type: 'site_invitation',
2524
- attributes: [],
2525
- relationships: ['role'],
2526
- },
2527
- responseType: 'SiteInvitationUpdateTargetSchema',
2528
- },
2529
- {
2530
- returnsCollection: true,
2531
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances',
2532
- name: 'list',
2533
- rawName: 'rawList',
2534
- urlTemplate: '/site-invitations',
2535
- method: 'GET',
2536
- comment: 'List all invitations',
2537
- simpleMethodAvailable: true,
2538
- responseType: 'SiteInvitationInstancesTargetSchema',
2539
- },
2540
- {
2541
- returnsCollection: false,
2542
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/self',
2543
- name: 'find',
2544
- rawName: 'rawFind',
2545
- urlTemplate: '/site-invitations/${siteInvitationId}',
2546
- method: 'GET',
2547
- comment: 'Retrieve an invitation',
2548
- urlPlaceholder: {
2549
- variableName: 'siteInvitationId',
2550
- isEntityId: true,
2551
- relType: 'SiteInvitationData',
2552
- },
2553
- simpleMethodAvailable: true,
2554
- responseType: 'SiteInvitationSelfTargetSchema',
2555
- },
2556
- {
2557
- returnsCollection: false,
2558
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy',
2559
- name: 'destroy',
2560
- rawName: 'rawDestroy',
2561
- urlTemplate: '/site-invitations/${siteInvitationId}',
2562
- method: 'DELETE',
2563
- comment: 'Delete an invitation',
2564
- urlPlaceholder: {
2565
- variableName: 'siteInvitationId',
2566
- isEntityId: true,
2567
- relType: 'SiteInvitationData',
2568
- },
2569
- simpleMethodAvailable: true,
2570
- responseType: 'SiteInvitationDestroyTargetSchema',
2571
- },
2572
- {
2573
- returnsCollection: false,
2574
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend',
2575
- name: 'resend',
2576
- rawName: 'rawResend',
2577
- urlTemplate: '/site-invitations/${siteInvitationId}/resend',
2578
- method: 'POST',
2579
- comment: 'Resend an invitation',
2580
- urlPlaceholder: {
2581
- variableName: 'siteInvitationId',
2582
- isEntityId: true,
2583
- relType: 'SiteInvitationData',
2584
- },
2585
- simpleMethodAvailable: true,
2586
- },
2587
- ],
2588
- namespace: 'siteInvitations',
2589
- resourceClassName: 'SiteInvitation',
2590
- },
2591
- {
2592
- jsonApiType: 'editing_session',
2593
- endpoints: [
2594
- {
2595
- returnsCollection: true,
2596
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/editing-session/instances',
2597
- name: 'list',
2598
- rawName: 'rawList',
2599
- urlTemplate: '/editing-sessions',
2600
- method: 'GET',
2601
- comment: 'List all editing sessions',
2602
- simpleMethodAvailable: true,
2603
- responseType: 'EditingSessionInstancesTargetSchema',
2604
- deprecated: 'This API call is to be considered private and might change without notice',
2605
- },
2606
- {
2607
- returnsCollection: false,
2608
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/editing-session/update',
2609
- name: 'update',
2610
- rawName: 'rawUpdate',
2611
- urlTemplate: '/editing-sessions/${editingSessionId}',
2612
- method: 'PUT',
2613
- comment: 'Allows all actions on editing sessions',
2614
- urlPlaceholder: {
2615
- variableName: 'editingSessionId',
2616
- isEntityId: true,
2617
- relType: 'EditingSessionData',
2618
- },
2619
- requestBodyType: 'EditingSessionUpdateSchema',
2620
- simpleMethodAvailable: false,
2621
- requestStructure: {
2622
- type: '*',
2623
- attributes: [],
2624
- relationships: ['item', 'item', 'item'],
2625
- },
2626
- responseType: 'EditingSessionUpdateTargetSchema',
2627
- deprecated: 'This API call is to be considered private and might change without notice',
2628
- },
2629
- {
2630
- returnsCollection: false,
2631
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy',
2632
- name: 'destroy',
2633
- rawName: 'rawDestroy',
2634
- urlTemplate: '/editing-sessions/${editingSessionId}',
2635
- method: 'DELETE',
2636
- comment: 'Delete an editing session',
2637
- urlPlaceholder: {
2638
- variableName: 'editingSessionId',
2639
- isEntityId: true,
2640
- relType: 'EditingSessionData',
2641
- },
2642
- simpleMethodAvailable: true,
2643
- responseType: 'EditingSessionDestroyTargetSchema',
2644
- deprecated: 'This API call is to be considered private and might change without notice',
2645
- },
2646
- ],
2647
- namespace: 'editingSessions',
2648
- resourceClassName: 'EditingSession',
2649
- },
2650
- {
2651
- jsonApiType: 'sso_group',
2652
- endpoints: [
2653
- {
2654
- returnsCollection: true,
2655
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-group/instances',
2656
- name: 'list',
2657
- rawName: 'rawList',
2658
- urlTemplate: '/sso-groups',
2659
- method: 'GET',
2660
- comment: 'List all SSO groups',
2661
- simpleMethodAvailable: true,
2662
- responseType: 'SsoGroupInstancesTargetSchema',
2663
- },
2664
- {
2665
- returnsCollection: false,
2666
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles',
2667
- name: 'copyRoles',
2668
- rawName: 'rawCopyRoles',
2669
- urlTemplate: '/sso-groups/${ssoGroupId}/copy-roles',
2670
- method: 'POST',
2671
- comment: 'Sync SSO provider groups to DatoCMS roles',
2672
- urlPlaceholder: {
2673
- variableName: 'ssoGroupId',
2674
- isEntityId: true,
2675
- relType: 'SsoGroupData',
2676
- },
2677
- simpleMethodAvailable: true,
2678
- responseType: 'SsoGroupCopyRolesTargetSchema',
2679
- },
2680
- {
2681
- returnsCollection: false,
2682
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-group/update',
2683
- name: 'update',
2684
- rawName: 'rawUpdate',
2685
- urlTemplate: '/sso-groups/${ssoGroupId}',
2686
- method: 'PUT',
2687
- comment: 'Update a SSO group',
2688
- urlPlaceholder: {
2689
- variableName: 'ssoGroupId',
2690
- isEntityId: true,
2691
- relType: 'SsoGroupData',
2692
- },
2693
- requestBodyType: 'SsoGroupUpdateSchema',
2694
- simpleMethodAvailable: true,
2695
- requestStructure: {
2696
- type: 'sso_group',
2697
- attributes: ['priority'],
2698
- relationships: ['role'],
2699
- },
2700
- responseType: 'SsoGroupUpdateTargetSchema',
2701
- },
2702
- {
2703
- returnsCollection: false,
2704
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy',
2705
- name: 'destroy',
2706
- rawName: 'rawDestroy',
2707
- urlTemplate: '/sso-groups/${ssoGroupId}',
2708
- method: 'DELETE',
2709
- comment: 'Delete a group',
2710
- urlPlaceholder: {
2711
- variableName: 'ssoGroupId',
2712
- isEntityId: true,
2713
- relType: 'SsoGroupData',
2714
- },
2715
- simpleMethodAvailable: true,
2716
- responseType: 'SsoGroupDestroyTargetSchema',
2717
- },
2718
- ],
2719
- namespace: 'ssoGroups',
2720
- resourceClassName: 'SsoGroup',
2721
- },
2722
- {
2723
- jsonApiType: 'sso_settings',
2724
- endpoints: [
2725
- {
2726
- returnsCollection: false,
2727
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-settings/self',
2728
- name: 'find',
2729
- rawName: 'rawFind',
2730
- urlTemplate: '/sso-settings',
2731
- method: 'GET',
2732
- comment: 'Retrieve SSO Settings',
2733
- simpleMethodAvailable: true,
2734
- responseType: 'SsoSettingsSelfTargetSchema',
2735
- },
2736
- {
2737
- returnsCollection: false,
2738
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token',
2739
- name: 'generateToken',
2740
- rawName: 'rawGenerateToken',
2741
- urlTemplate: '/sso-settings/generate-token',
2742
- method: 'PUT',
2743
- comment: 'Generate SSO token',
2744
- simpleMethodAvailable: true,
2745
- responseType: 'SsoSettingsGenerateTokenTargetSchema',
2746
- },
2747
- {
2748
- returnsCollection: false,
2749
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/sso-settings/update',
2750
- name: 'update',
2751
- rawName: 'rawUpdate',
2752
- urlTemplate: '/sso-settings',
2753
- method: 'PUT',
2754
- comment: 'Update SSO Settings',
2755
- requestBodyType: 'SsoSettingsUpdateSchema',
2756
- simpleMethodAvailable: true,
2757
- requestStructure: {
2758
- type: 'sso_settings',
2759
- attributes: ['idp_saml_metadata_url'],
2760
- relationships: ['default_role'],
2761
- },
2762
- responseType: 'SsoSettingsUpdateTargetSchema',
2763
- },
2764
- ],
2765
- namespace: 'ssoSettings',
2766
- resourceClassName: 'SsoSettings',
2767
- },
2768
- {
2769
- jsonApiType: 'white_label_settings',
2770
- endpoints: [
2771
- {
2772
- returnsCollection: false,
2773
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self',
2774
- name: 'find',
2775
- rawName: 'rawFind',
2776
- urlTemplate: '/white-label-settings',
2777
- method: 'GET',
2778
- comment: 'Retrieve white-label settings',
2779
- simpleMethodAvailable: true,
2780
- responseType: 'WhiteLabelSettingsSelfTargetSchema',
2781
- },
2782
- {
2783
- returnsCollection: false,
2784
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update',
2785
- name: 'update',
2786
- rawName: 'rawUpdate',
2787
- urlTemplate: '/white-label-settings',
2788
- method: 'PUT',
2789
- comment: 'Update white-label settings',
2790
- requestBodyType: 'WhiteLabelSettingsUpdateSchema',
2791
- simpleMethodAvailable: true,
2792
- requestStructure: {
2793
- type: 'white_label_settings',
2794
- attributes: ['custom_i18n_messages_template_url'],
2795
- relationships: [],
2796
- },
2797
- responseType: 'WhiteLabelSettingsUpdateTargetSchema',
2798
- },
2799
- ],
2800
- namespace: 'whiteLabelSettings',
2801
- resourceClassName: 'WhiteLabelSettings',
2802
- },
2803
- {
2804
- jsonApiType: 'public_info',
2805
- endpoints: [
2806
- {
2807
- returnsCollection: false,
2808
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/public-info/self',
2809
- name: 'find',
2810
- rawName: 'rawFind',
2811
- urlTemplate: '/public-info',
2812
- method: 'GET',
2813
- comment: 'Retrieve public site info',
2814
- simpleMethodAvailable: true,
2815
- responseType: 'PublicInfoSelfTargetSchema',
2816
- },
2817
- ],
2818
- namespace: 'publicInfo',
2819
- resourceClassName: 'PublicInfo',
2820
- },
2821
- {
2822
- jsonApiType: 'daily_usage',
2823
- endpoints: [
2824
- {
2825
- returnsCollection: true,
2826
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances',
2827
- name: 'list',
2828
- rawName: 'rawList',
2829
- urlTemplate: '/daily-site-usages',
2830
- method: 'GET',
2831
- comment: "Retrieve project's daily usage info",
2832
- simpleMethodAvailable: true,
2833
- responseType: 'DailyUsageInstancesTargetSchema',
2834
- },
2835
- ],
2836
- namespace: 'dailyUsages',
2837
- resourceClassName: 'DailyUsage',
2838
- },
2839
- {
2840
- jsonApiType: 'usage_counter',
2841
- endpoints: [
2842
- {
2843
- returnsCollection: false,
2844
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/usage-counter/self',
2845
- name: 'find',
2846
- rawName: 'rawFind',
2847
- urlTemplate: '/usage-log-counters/${usageCounterId}',
2848
- method: 'GET',
2849
- comment: "Retrieve a project's usage counter",
2850
- urlPlaceholder: {
2851
- variableName: 'usageCounterId',
2852
- isEntityId: true,
2853
- relType: 'UsageCounterData',
2854
- },
2855
- simpleMethodAvailable: true,
2856
- queryParamsType: 'UsageCounterSelfHrefSchema',
2857
- responseType: 'UsageCounterSelfTargetSchema',
2858
- },
2859
- ],
2860
- namespace: 'usageCounters',
2861
- resourceClassName: 'UsageCounter',
2862
- },
2863
- {
2864
- jsonApiType: 'upload_tag',
2865
- endpoints: [
2866
- {
2867
- returnsCollection: true,
2868
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances',
2869
- name: 'list',
2870
- rawName: 'rawList',
2871
- urlTemplate: '/upload-tags',
2872
- method: 'GET',
2873
- comment: 'List all manually created upload tags',
2874
- simpleMethodAvailable: true,
2875
- queryParamsType: 'UploadTagInstancesHrefSchema',
2876
- responseType: 'UploadTagInstancesTargetSchema',
2877
- paginatedResponse: {
2878
- defaultLimit: 50,
2879
- maxLimit: 500,
2880
- },
2881
- },
2882
- {
2883
- returnsCollection: false,
2884
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-tag/create',
2885
- name: 'create',
2886
- rawName: 'rawCreate',
2887
- urlTemplate: '/upload-tags',
2888
- method: 'POST',
2889
- comment: 'Create a new upload tag',
2890
- requestBodyType: 'UploadTagCreateSchema',
2891
- simpleMethodAvailable: true,
2892
- requestStructure: {
2893
- type: 'upload_tag',
2894
- attributes: ['name'],
2895
- relationships: [],
2896
- },
2897
- responseType: 'UploadTagCreateTargetSchema',
2898
- },
2899
- ],
2900
- namespace: 'uploadTags',
2901
- resourceClassName: 'UploadTag',
2902
- },
2903
- {
2904
- jsonApiType: 'upload_smart_tag',
2905
- endpoints: [
2906
- {
2907
- returnsCollection: true,
2908
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances',
2909
- name: 'list',
2910
- rawName: 'rawList',
2911
- urlTemplate: '/upload-smart-tags',
2912
- method: 'GET',
2913
- comment: 'List all automatically created upload tags',
2914
- simpleMethodAvailable: true,
2915
- queryParamsType: 'UploadSmartTagInstancesHrefSchema',
2916
- responseType: 'UploadSmartTagInstancesTargetSchema',
2917
- paginatedResponse: {
2918
- defaultLimit: 50,
2919
- maxLimit: 500,
2920
- },
2921
- },
2922
- ],
2923
- namespace: 'uploadSmartTags',
2924
- resourceClassName: 'UploadSmartTag',
2925
- },
2926
- {
2927
- jsonApiType: 'site',
2928
- endpoints: [
2929
- {
2930
- returnsCollection: false,
2931
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site/self',
2932
- name: 'find',
2933
- rawName: 'rawFind',
2934
- urlTemplate: '/site',
2935
- method: 'GET',
2936
- comment: 'Retrieve the site',
2937
- simpleMethodAvailable: true,
2938
- responseType: 'SiteSelfTargetSchema',
2939
- },
2940
- {
2941
- returnsCollection: false,
2942
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/site/update',
2943
- name: 'update',
2944
- rawName: 'rawUpdate',
2945
- urlTemplate: '/site',
2946
- method: 'PUT',
2947
- comment: "Update the site's settings",
2948
- requestBodyType: 'SiteUpdateSchema',
2949
- simpleMethodAvailable: true,
2950
- requestStructure: {
2951
- type: 'site',
2952
- attributes: [
2953
- 'no_index',
2954
- 'favicon',
2955
- 'global_seo',
2956
- 'name',
2957
- 'theme',
2958
- 'locales',
2959
- 'timezone',
2960
- 'require_2fa',
2961
- 'ip_tracking_enabled',
2962
- ],
2963
- relationships: ['sso_default_role'],
2964
- },
2965
- responseType: 'SiteUpdateJobSchema',
2966
- },
2967
- ],
2968
- namespace: 'site',
2969
- resourceClassName: 'Site',
2970
- },
2971
- {
2972
- jsonApiType: 'workflow',
2973
- endpoints: [
2974
- {
2975
- returnsCollection: false,
2976
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/workflow/create',
2977
- name: 'create',
2978
- rawName: 'rawCreate',
2979
- urlTemplate: '/workflows',
2980
- method: 'POST',
2981
- comment: 'Create a new workflow',
2982
- requestBodyType: 'WorkflowCreateSchema',
2983
- simpleMethodAvailable: true,
2984
- requestStructure: {
2985
- type: 'workflow',
2986
- attributes: ['name', 'stages'],
2987
- relationships: [],
2988
- },
2989
- responseType: 'WorkflowCreateTargetSchema',
2990
- },
2991
- {
2992
- returnsCollection: false,
2993
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/workflow/update',
2994
- name: 'update',
2995
- rawName: 'rawUpdate',
2996
- urlTemplate: '/workflows/${workflowId}',
2997
- method: 'PUT',
2998
- comment: 'Update a workflow',
2999
- urlPlaceholder: {
3000
- variableName: 'workflowId',
3001
- isEntityId: true,
3002
- relType: 'WorkflowData',
3003
- },
3004
- requestBodyType: 'WorkflowUpdateSchema',
3005
- simpleMethodAvailable: true,
3006
- requestStructure: {
3007
- type: 'workflow',
3008
- attributes: ['name', 'stages'],
3009
- relationships: [],
3010
- },
3011
- responseType: 'WorkflowUpdateTargetSchema',
3012
- },
3013
- {
3014
- returnsCollection: true,
3015
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/workflow/instances',
3016
- name: 'list',
3017
- rawName: 'rawList',
3018
- urlTemplate: '/workflows',
3019
- method: 'GET',
3020
- comment: 'List all workflows',
3021
- simpleMethodAvailable: true,
3022
- responseType: 'WorkflowInstancesTargetSchema',
3023
- },
3024
- {
3025
- returnsCollection: false,
3026
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/workflow/self',
3027
- name: 'find',
3028
- rawName: 'rawFind',
3029
- urlTemplate: '/workflows/${workflowId}',
3030
- method: 'GET',
3031
- comment: 'Retrieve a workflow',
3032
- urlPlaceholder: {
3033
- variableName: 'workflowId',
3034
- isEntityId: true,
3035
- relType: 'WorkflowData',
3036
- },
3037
- simpleMethodAvailable: true,
3038
- responseType: 'WorkflowSelfTargetSchema',
3039
- },
3040
- {
3041
- returnsCollection: false,
3042
- docUrl: 'https://www.datocms.com/docs/content-management-api/resources/workflow/destroy',
3043
- name: 'destroy',
3044
- rawName: 'rawDestroy',
3045
- urlTemplate: '/workflows/${workflowId}',
3046
- method: 'DELETE',
3047
- comment: 'Delete a workflow',
3048
- urlPlaceholder: {
3049
- variableName: 'workflowId',
3050
- isEntityId: true,
3051
- relType: 'WorkflowData',
3052
- },
3053
- simpleMethodAvailable: true,
3054
- },
3055
- ],
3056
- namespace: 'workflows',
3057
- resourceClassName: 'Workflow',
3058
- },
3059
- ],
3060
- };
3061
- //# sourceMappingURL=schemaInfo.js.map