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