@datocms/cma-client 3.3.7 → 3.3.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.
Files changed (41) hide show
  1. package/dist/cjs/generated/Client.js +2 -1
  2. package/dist/cjs/generated/Client.js.map +1 -1
  3. package/dist/cjs/generated/resources/Role.js +2 -0
  4. package/dist/cjs/generated/resources/Role.js.map +1 -1
  5. package/dist/cjs/generated/resources/Upload.js +34 -2
  6. package/dist/cjs/generated/resources/Upload.js.map +1 -1
  7. package/dist/cjs/generated/resources/UploadCollection.js +202 -0
  8. package/dist/cjs/generated/resources/UploadCollection.js.map +1 -0
  9. package/dist/cjs/generated/resources/index.js +3 -1
  10. package/dist/cjs/generated/resources/index.js.map +1 -1
  11. package/dist/esm/generated/Client.d.ts +1 -0
  12. package/dist/esm/generated/Client.js +2 -1
  13. package/dist/esm/generated/Client.js.map +1 -1
  14. package/dist/esm/generated/SchemaTypes.d.ts +272 -4
  15. package/dist/esm/generated/SimpleSchemaTypes.d.ts +176 -4
  16. package/dist/esm/generated/resources/Role.js +2 -0
  17. package/dist/esm/generated/resources/Role.js.map +1 -1
  18. package/dist/esm/generated/resources/Upload.d.ts +18 -0
  19. package/dist/esm/generated/resources/Upload.js +34 -2
  20. package/dist/esm/generated/resources/Upload.js.map +1 -1
  21. package/dist/esm/generated/resources/UploadCollection.d.ts +96 -0
  22. package/dist/esm/generated/resources/UploadCollection.js +174 -0
  23. package/dist/esm/generated/resources/UploadCollection.js.map +1 -0
  24. package/dist/esm/generated/resources/index.d.ts +1 -0
  25. package/dist/esm/generated/resources/index.js +1 -0
  26. package/dist/esm/generated/resources/index.js.map +1 -1
  27. package/dist/types/generated/Client.d.ts +1 -0
  28. package/dist/types/generated/SchemaTypes.d.ts +272 -4
  29. package/dist/types/generated/SimpleSchemaTypes.d.ts +176 -4
  30. package/dist/types/generated/resources/Upload.d.ts +18 -0
  31. package/dist/types/generated/resources/UploadCollection.d.ts +96 -0
  32. package/dist/types/generated/resources/index.d.ts +1 -0
  33. package/package.json +2 -2
  34. package/resources.json +148 -2
  35. package/src/generated/Client.ts +3 -1
  36. package/src/generated/SchemaTypes.ts +286 -4
  37. package/src/generated/SimpleSchemaTypes.ts +182 -4
  38. package/src/generated/resources/Role.ts +2 -0
  39. package/src/generated/resources/Upload.ts +49 -2
  40. package/src/generated/resources/UploadCollection.ts +204 -0
  41. package/src/generated/resources/index.ts +1 -0
@@ -0,0 +1,96 @@
1
+ import BaseResource from '../../BaseResource';
2
+ import type * as SchemaTypes from '../SchemaTypes';
3
+ import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
4
+ export default class UploadCollection extends BaseResource {
5
+ static readonly TYPE: "upload_collection";
6
+ /**
7
+ * Create a new upload collection
8
+ *
9
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
10
+ *
11
+ * @throws {ApiError}
12
+ * @throws {TimeoutError}
13
+ */
14
+ create(body: SimpleSchemaTypes.UploadCollectionCreateSchema): Promise<SimpleSchemaTypes.UploadCollection>;
15
+ /**
16
+ * Create a new upload collection
17
+ *
18
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
19
+ *
20
+ * @throws {ApiError}
21
+ * @throws {TimeoutError}
22
+ */
23
+ rawCreate(body: SchemaTypes.UploadCollectionCreateSchema): Promise<SchemaTypes.UploadCollectionCreateTargetSchema>;
24
+ /**
25
+ * Update a upload collection
26
+ *
27
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
28
+ *
29
+ * @throws {ApiError}
30
+ * @throws {TimeoutError}
31
+ */
32
+ update(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData, body: SimpleSchemaTypes.UploadCollectionUpdateSchema): Promise<SimpleSchemaTypes.UploadCollection>;
33
+ /**
34
+ * Update a upload collection
35
+ *
36
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
37
+ *
38
+ * @throws {ApiError}
39
+ * @throws {TimeoutError}
40
+ */
41
+ rawUpdate(uploadCollectionId: string, body: SchemaTypes.UploadCollectionUpdateSchema): Promise<SchemaTypes.UploadCollectionUpdateTargetSchema>;
42
+ /**
43
+ * List all upload collections
44
+ *
45
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
46
+ *
47
+ * @throws {ApiError}
48
+ * @throws {TimeoutError}
49
+ */
50
+ list(queryParams?: SimpleSchemaTypes.UploadCollectionInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadCollectionInstancesTargetSchema>;
51
+ /**
52
+ * List all upload collections
53
+ *
54
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
55
+ *
56
+ * @throws {ApiError}
57
+ * @throws {TimeoutError}
58
+ */
59
+ rawList(queryParams?: SchemaTypes.UploadCollectionInstancesHrefSchema): Promise<SchemaTypes.UploadCollectionInstancesTargetSchema>;
60
+ /**
61
+ * Retrieve a upload collection
62
+ *
63
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
64
+ *
65
+ * @throws {ApiError}
66
+ * @throws {TimeoutError}
67
+ */
68
+ find(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData): Promise<SimpleSchemaTypes.UploadCollection>;
69
+ /**
70
+ * Retrieve a upload collection
71
+ *
72
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
73
+ *
74
+ * @throws {ApiError}
75
+ * @throws {TimeoutError}
76
+ */
77
+ rawFind(uploadCollectionId: string): Promise<SchemaTypes.UploadCollectionSelfTargetSchema>;
78
+ /**
79
+ * Delete a upload collection
80
+ *
81
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
82
+ *
83
+ * @throws {ApiError}
84
+ * @throws {TimeoutError}
85
+ */
86
+ destroy(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData): Promise<SimpleSchemaTypes.UploadCollection>;
87
+ /**
88
+ * Delete a upload collection
89
+ *
90
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
91
+ *
92
+ * @throws {ApiError}
93
+ * @throws {TimeoutError}
94
+ */
95
+ rawDestroy(uploadCollectionId: string): Promise<SchemaTypes.UploadCollectionDestroyTargetSchema>;
96
+ }
@@ -4,6 +4,7 @@ export { default as SsoUser } from './SsoUser';
4
4
  export { default as AuditLogEvent } from './AuditLogEvent';
5
5
  export { default as MenuItem } from './MenuItem';
6
6
  export { default as SchemaMenuItem } from './SchemaMenuItem';
7
+ export { default as UploadCollection } from './UploadCollection';
7
8
  export { default as ItemType } from './ItemType';
8
9
  export { default as Field } from './Field';
9
10
  export { default as Fieldset } from './Fieldset';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datocms/cma-client",
3
- "version": "3.3.7",
3
+ "version": "3.3.8",
4
4
  "description": "JS client for DatoCMS REST Content Management API",
5
5
  "keywords": [
6
6
  "datocms",
@@ -44,5 +44,5 @@
44
44
  "@datocms/dashboard-client": "^3.3.7",
45
45
  "@types/uuid": "^9.0.7"
46
46
  },
47
- "gitHead": "97f5a4a4c7c505305e90115907d2db971bacc2ce"
47
+ "gitHead": "e46a0db6a551cfa9d6b3bb5d087c68ea09a15f7f"
48
48
  }
package/resources.json CHANGED
@@ -25,6 +25,7 @@
25
25
  "environments_access",
26
26
  "can_manage_users",
27
27
  "can_manage_shared_filters",
28
+ "can_manage_upload_collections",
28
29
  "can_manage_build_triggers",
29
30
  "can_manage_webhooks",
30
31
  "can_manage_environments",
@@ -83,6 +84,7 @@
83
84
  "environments_access",
84
85
  "can_manage_users",
85
86
  "can_manage_shared_filters",
87
+ "can_manage_upload_collections",
86
88
  "can_manage_build_triggers",
87
89
  "can_manage_webhooks",
88
90
  "can_manage_environments",
@@ -655,6 +657,130 @@
655
657
  "namespace": "schemaMenuItems",
656
658
  "resourceClassName": "SchemaMenuItem"
657
659
  },
660
+ {
661
+ "jsonApiType": "upload_collection",
662
+ "endpoints": [
663
+ {
664
+ "returnsCollection": false,
665
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/create",
666
+ "rel": "create",
667
+ "urlTemplate": "/upload-collections",
668
+ "method": "POST",
669
+ "comment": "Create a new upload collection",
670
+ "urlPlaceholders": [],
671
+ "requestBodyType": "UploadCollectionCreateSchema",
672
+ "optionalRequestBody": false,
673
+ "requestStructure": {
674
+ "type": "upload_collection",
675
+ "attributes": ["label", "position"],
676
+ "relationships": ["parent"]
677
+ },
678
+ "queryParamsRequired": false,
679
+ "responseType": "UploadCollectionCreateTargetSchema",
680
+ "name": "create",
681
+ "rawName": "rawCreate"
682
+ },
683
+ {
684
+ "returnsCollection": false,
685
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/update",
686
+ "rel": "update",
687
+ "urlTemplate": "/upload-collections/${uploadCollectionId}",
688
+ "method": "PUT",
689
+ "comment": "Update a upload collection",
690
+ "urlPlaceholders": [
691
+ {
692
+ "variableName": "uploadCollectionId",
693
+ "isEntityId": true,
694
+ "relType": "UploadCollectionData"
695
+ }
696
+ ],
697
+ "entityIdPlaceholder": {
698
+ "variableName": "uploadCollectionId",
699
+ "isEntityId": true,
700
+ "relType": "UploadCollectionData"
701
+ },
702
+ "requestBodyType": "UploadCollectionUpdateSchema",
703
+ "optionalRequestBody": false,
704
+ "requestStructure": {
705
+ "type": "upload_collection",
706
+ "idRequired": true,
707
+ "attributes": ["label", "position"],
708
+ "relationships": ["parent", "children"]
709
+ },
710
+ "queryParamsRequired": false,
711
+ "responseType": "UploadCollectionUpdateTargetSchema",
712
+ "name": "update",
713
+ "rawName": "rawUpdate"
714
+ },
715
+ {
716
+ "returnsCollection": true,
717
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances",
718
+ "rel": "instances",
719
+ "urlTemplate": "/upload-collections",
720
+ "method": "GET",
721
+ "comment": "List all upload collections",
722
+ "urlPlaceholders": [],
723
+ "optionalRequestBody": false,
724
+ "queryParamsType": "UploadCollectionInstancesHrefSchema",
725
+ "queryParamsRequired": false,
726
+ "responseType": "UploadCollectionInstancesTargetSchema",
727
+ "name": "list",
728
+ "rawName": "rawList"
729
+ },
730
+ {
731
+ "returnsCollection": false,
732
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/self",
733
+ "rel": "self",
734
+ "urlTemplate": "/upload-collections/${uploadCollectionId}",
735
+ "method": "GET",
736
+ "comment": "Retrieve a upload collection",
737
+ "urlPlaceholders": [
738
+ {
739
+ "variableName": "uploadCollectionId",
740
+ "isEntityId": true,
741
+ "relType": "UploadCollectionData"
742
+ }
743
+ ],
744
+ "entityIdPlaceholder": {
745
+ "variableName": "uploadCollectionId",
746
+ "isEntityId": true,
747
+ "relType": "UploadCollectionData"
748
+ },
749
+ "optionalRequestBody": false,
750
+ "queryParamsRequired": false,
751
+ "responseType": "UploadCollectionSelfTargetSchema",
752
+ "name": "find",
753
+ "rawName": "rawFind"
754
+ },
755
+ {
756
+ "returnsCollection": false,
757
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy",
758
+ "rel": "destroy",
759
+ "urlTemplate": "/upload-collections/${uploadCollectionId}",
760
+ "method": "DELETE",
761
+ "comment": "Delete a upload collection",
762
+ "urlPlaceholders": [
763
+ {
764
+ "variableName": "uploadCollectionId",
765
+ "isEntityId": true,
766
+ "relType": "UploadCollectionData"
767
+ }
768
+ ],
769
+ "entityIdPlaceholder": {
770
+ "variableName": "uploadCollectionId",
771
+ "isEntityId": true,
772
+ "relType": "UploadCollectionData"
773
+ },
774
+ "optionalRequestBody": false,
775
+ "queryParamsRequired": false,
776
+ "responseType": "UploadCollectionDestroyTargetSchema",
777
+ "name": "destroy",
778
+ "rawName": "rawDestroy"
779
+ }
780
+ ],
781
+ "namespace": "uploadCollections",
782
+ "resourceClassName": "UploadCollection"
783
+ },
658
784
  {
659
785
  "jsonApiType": "item_type",
660
786
  "endpoints": [
@@ -2273,7 +2399,7 @@
2273
2399
  "default_field_metadata",
2274
2400
  "tags"
2275
2401
  ],
2276
- "relationships": []
2402
+ "relationships": ["upload_collection"]
2277
2403
  },
2278
2404
  "queryParamsRequired": false,
2279
2405
  "responseType": "UploadCreateJobSchema",
@@ -2382,7 +2508,7 @@
2382
2508
  "tags",
2383
2509
  "default_field_metadata"
2384
2510
  ],
2385
- "relationships": ["creator"]
2511
+ "relationships": ["creator", "upload_collection"]
2386
2512
  },
2387
2513
  "queryParamsRequired": false,
2388
2514
  "responseType": "UploadUpdateJobSchema",
@@ -2473,6 +2599,26 @@
2473
2599
  "name": "bulkTag",
2474
2600
  "rawName": "rawBulkTag"
2475
2601
  },
2602
+ {
2603
+ "returnsCollection": false,
2604
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_set_upload_collection",
2605
+ "rel": "bulk_set_upload_collection",
2606
+ "urlTemplate": "/uploads/bulk/set-upload-collection",
2607
+ "method": "POST",
2608
+ "comment": "Put assets into a collection in bulk",
2609
+ "urlPlaceholders": [],
2610
+ "requestBodyType": "UploadBulkSetUploadCollectionSchema",
2611
+ "optionalRequestBody": false,
2612
+ "requestStructure": {
2613
+ "type": "upload_bulk_set_upload_collection_operation",
2614
+ "attributes": [],
2615
+ "relationships": ["upload_collection", "uploads"]
2616
+ },
2617
+ "queryParamsRequired": false,
2618
+ "responseType": "UploadBulkSetUploadCollectionJobSchema",
2619
+ "name": "bulkSetUploadCollection",
2620
+ "rawName": "rawBulkSetUploadCollection"
2621
+ },
2476
2622
  {
2477
2623
  "returnsCollection": false,
2478
2624
  "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy",
@@ -44,6 +44,7 @@ export class Client {
44
44
  auditLogEvents: Resources.AuditLogEvent;
45
45
  menuItems: Resources.MenuItem;
46
46
  schemaMenuItems: Resources.SchemaMenuItem;
47
+ uploadCollections: Resources.UploadCollection;
47
48
  itemTypes: Resources.ItemType;
48
49
  fields: Resources.Field;
49
50
  fieldsets: Resources.Fieldset;
@@ -96,6 +97,7 @@ export class Client {
96
97
  this.auditLogEvents = new Resources.AuditLogEvent(this);
97
98
  this.menuItems = new Resources.MenuItem(this);
98
99
  this.schemaMenuItems = new Resources.SchemaMenuItem(this);
100
+ this.uploadCollections = new Resources.UploadCollection(this);
99
101
  this.itemTypes = new Resources.ItemType(this);
100
102
  this.fields = new Resources.Field(this);
101
103
  this.fieldsets = new Resources.Fieldset(this);
@@ -145,7 +147,7 @@ export class Client {
145
147
  ...this.config,
146
148
  ...options,
147
149
  logFn: this.config.logFn || console.log,
148
- userAgent: '@datocms/cma-client v3.3.7',
150
+ userAgent: '@datocms/cma-client v3.3.8',
149
151
  baseUrl: this.baseUrl,
150
152
  preCallStack: new Error().stack,
151
153
  extraHeaders: {