@datocms/cma-client 0.1.6 → 0.1.8

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