@remkoj/optimizely-cms-api 6.0.0-pre1 → 6.0.0-pre3

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.
@@ -40,24 +40,6 @@ export type Changeset = {
40
40
  readonly createdBy?: string;
41
41
  lastModified?: Date;
42
42
  };
43
- /**
44
- * Changesets are used to group work on several content items together.
45
- */
46
- export type ChangesetWritable = {
47
- /**
48
- * The unique key of this Changeset.
49
- */
50
- key: string;
51
- /**
52
- * The source of this Changeset
53
- */
54
- source?: string;
55
- /**
56
- * The name of this Changeset.
57
- */
58
- displayName: string;
59
- lastModified?: Date;
60
- };
61
43
  /**
62
44
  * Items in an changeset that contains a link to the specific content version.
63
45
  */
@@ -68,15 +50,6 @@ export type ChangesetItem = {
68
50
  */
69
51
  category?: string;
70
52
  };
71
- /**
72
- * Items in an changeset that contains a link to the specific content version.
73
- */
74
- export type ChangesetItemWritable = {
75
- /**
76
- * Gets/sets the changeset item category.
77
- */
78
- category?: string;
79
- };
80
53
  export type ChangesetItemPage = {
81
54
  /**
82
55
  * The items in this paged collection.
@@ -95,9 +68,6 @@ export type ChangesetItemPage = {
95
68
  */
96
69
  readonly totalItemCount?: number;
97
70
  };
98
- export type ChangesetItemPageWritable = {
99
- [key: string]: never;
100
- };
101
71
  export type ChangesetPage = {
102
72
  /**
103
73
  * The items in this paged collection.
@@ -116,9 +86,6 @@ export type ChangesetPage = {
116
86
  */
117
87
  readonly totalItemCount?: number;
118
88
  };
119
- export type ChangesetPageWritable = {
120
- [key: string]: never;
121
- };
122
89
  /**
123
90
  * Describes a property list item that can contain a component instance of a specific type.
124
91
  */
@@ -261,47 +228,6 @@ export type ContentItem = {
261
228
  */
262
229
  readonly lastModifiedBy?: string;
263
230
  };
264
- /**
265
- * Represents a version of a content item.
266
- */
267
- export type ContentItemWritable = {
268
- /**
269
- * Properties as they are defined by corresponding component or content type.
270
- */
271
- properties?: {
272
- [key: string]: unknown;
273
- };
274
- /**
275
- * The display name of this content item.
276
- */
277
- displayName: string;
278
- /**
279
- * Indicates a time when this content was published or should be published.
280
- */
281
- published?: Date | null;
282
- /**
283
- * Indicates a time when this content expired or should expire.
284
- */
285
- expired?: Date | null;
286
- status?: VersionStatus;
287
- /**
288
- * Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
289
- */
290
- delayPublishUntil?: Date | null;
291
- /**
292
- * The key that identifies the container content that this content item belongs to.
293
- */
294
- container?: string | null;
295
- /**
296
- * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
297
- */
298
- owner?: string | null;
299
- /**
300
- * A string that represents the segment that should be used when routing or generate routes to the current content instance.
301
- */
302
- routeSegment?: string | null;
303
- lastModified?: Date;
304
- };
305
231
  /**
306
232
  * The response object for Page`1 when used ContentType are included.
307
233
  */
@@ -327,12 +253,6 @@ export type ContentItemListWithContentTypes = {
327
253
  */
328
254
  readonly totalItemCount?: number;
329
255
  };
330
- /**
331
- * The response object for Page`1 when used ContentType are included.
332
- */
333
- export type ContentItemListWithContentTypesWritable = {
334
- [key: string]: never;
335
- };
336
256
  export type ContentItemPage = {
337
257
  /**
338
258
  * The items in this paged collection.
@@ -351,9 +271,6 @@ export type ContentItemPage = {
351
271
  */
352
272
  readonly totalItemCount?: number;
353
273
  };
354
- export type ContentItemPageWritable = {
355
- [key: string]: never;
356
- };
357
274
  /**
358
275
  * The response object for ContentItem when used ContentType are included.
359
276
  */
@@ -364,12 +281,6 @@ export type ContentItemWithContentTypes = {
364
281
  readonly contentTypes?: Array<ContentType>;
365
282
  item?: ContentItem;
366
283
  };
367
- /**
368
- * The response object for ContentItem when used ContentType are included.
369
- */
370
- export type ContentItemWithContentTypesWritable = {
371
- item?: ContentItemWritable;
372
- };
373
284
  /**
374
285
  * Describes a property list item that can hold a content item.
375
286
  */
@@ -442,27 +353,6 @@ export type ContentMetadata = {
442
353
  */
443
354
  readonly deletedBy?: string | null;
444
355
  };
445
- /**
446
- * Represents metadata about a content item.
447
- */
448
- export type ContentMetadataWritable = {
449
- /**
450
- * The key that identifies this content.
451
- */
452
- key?: string;
453
- /**
454
- * The content type of this content.
455
- */
456
- contentType?: string;
457
- /**
458
- * The key that identifies the container content that this content belongs to.
459
- */
460
- container?: string | null;
461
- /**
462
- * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
463
- */
464
- owner?: string | null;
465
- };
466
356
  export type ContentMetadataPage = {
467
357
  /**
468
358
  * The items in this paged collection.
@@ -481,9 +371,6 @@ export type ContentMetadataPage = {
481
371
  */
482
372
  readonly totalItemCount?: number;
483
373
  };
484
- export type ContentMetadataPageWritable = {
485
- [key: string]: never;
486
- };
487
374
  /**
488
375
  * Describes a property that can contain a content item.
489
376
  */
@@ -644,88 +531,6 @@ export type ContentType = {
644
531
  };
645
532
  };
646
533
  };
647
- /**
648
- * A writable implementation of an ContentType.
649
- */
650
- export type ContentTypeWritable = {
651
- /**
652
- * The key that identifies this ContentType.
653
- */
654
- key: string;
655
- /**
656
- * The display name of this ContentType.
657
- */
658
- displayName?: string;
659
- /**
660
- * A description of this ContentType.
661
- */
662
- description?: string;
663
- baseType?: ContentBaseType;
664
- /**
665
- * An value that is used to when sorting ContentType instances.
666
- */
667
- sortOrder?: number;
668
- /**
669
- * Provides a set of features that content based on this ContentType supports.
670
- * This value is assigned based on the BaseType and cannot be modified.
671
- */
672
- features?: Array<ContentTypeFeature>;
673
- /**
674
- * Specifies how this ContentType can be used.
675
- */
676
- usage?: Array<ContentTypeUsage>;
677
- /**
678
- * Provides a set of content types that can be created in container of this type
679
- */
680
- mayContainTypes?: Array<string>;
681
- /**
682
- * Provides a set of media file extensions that this content type can handle.
683
- */
684
- mediaFileExtensions?: Array<string>;
685
- /**
686
- * Provides a set of composition behaviors specifying how this content type can be used within compositions.
687
- */
688
- compositionBehaviors?: Array<CompositionBehavior>;
689
- /**
690
- * Dictionary with all custom properties of this ContentType.
691
- */
692
- properties?: {
693
- [key: string]: (({
694
- type: 'BinaryProperty';
695
- } & BinaryProperty) | ({
696
- type: 'BooleanProperty';
697
- } & BooleanProperty) | ({
698
- type: 'ComponentProperty';
699
- } & ComponentProperty) | ({
700
- type: 'ContentProperty';
701
- } & ContentProperty) | ({
702
- type: 'ContentReferenceProperty';
703
- } & ContentReferenceProperty) | ({
704
- type: 'DateTimeProperty';
705
- } & DateTimeProperty) | ({
706
- type: 'FloatProperty';
707
- } & FloatProperty) | ({
708
- type: 'IntegerProperty';
709
- } & IntegerProperty) | ({
710
- type: 'StringProperty';
711
- } & StringProperty) | ({
712
- type: 'UrlProperty';
713
- } & UrlProperty) | ({
714
- type: 'JsonStringProperty';
715
- } & JsonStringProperty) | ({
716
- type: 'ListProperty';
717
- } & ListProperty)) & {
718
- /**
719
- * Settings for the editor.
720
- */
721
- editorSettings?: {
722
- [key: string]: {
723
- [key: string]: unknown;
724
- };
725
- } | null;
726
- };
727
- };
728
- };
729
534
  /**
730
535
  * Represent different features that a content type can have.
731
536
  */
@@ -758,9 +563,6 @@ export type ContentTypePage = {
758
563
  */
759
564
  readonly totalItemCount?: number;
760
565
  };
761
- export type ContentTypePageWritable = {
762
- [key: string]: never;
763
- };
764
566
  /**
765
567
  * Describes a property of a ContentType in the CMS.
766
568
  */
@@ -957,35 +759,6 @@ export type DisplayTemplate = {
957
759
  [key: string]: DisplaySetting;
958
760
  };
959
761
  };
960
- /**
961
- * Describes a display template that can be assigned to content.
962
- */
963
- export type DisplayTemplateWritable = {
964
- /**
965
- * The display name of this display template.
966
- */
967
- displayName: string;
968
- /**
969
- * The optional node type this display template is valid for.
970
- */
971
- nodeType?: string | null;
972
- baseType?: ContentBaseType;
973
- /**
974
- * The optional key of the content type this display template is valid for.
975
- */
976
- contentType?: string | null;
977
- /**
978
- * If this is the default display template for the associated base type,
979
- * node type or content type.
980
- */
981
- isDefault?: boolean;
982
- /**
983
- * The available settings for this display template.
984
- */
985
- settings?: {
986
- [key: string]: DisplaySetting;
987
- };
988
- };
989
762
  export type DisplayTemplatePage = {
990
763
  /**
991
764
  * The items in this paged collection.
@@ -1004,9 +777,6 @@ export type DisplayTemplatePage = {
1004
777
  */
1005
778
  readonly totalItemCount?: number;
1006
779
  };
1007
- export type DisplayTemplatePageWritable = {
1008
- [key: string]: never;
1009
- };
1010
780
  /**
1011
781
  * Enumeration settings for a property or format.
1012
782
  */
@@ -1274,14 +1044,6 @@ export type ProblemDetails = {
1274
1044
  [key: string]: Array<string>;
1275
1045
  } | null) | undefined;
1276
1046
  };
1277
- export type ProblemDetailsWritable = {
1278
- type?: string | null;
1279
- title?: string | null;
1280
- status?: number | null;
1281
- detail?: string | null;
1282
- instance?: string | null;
1283
- [key: string]: unknown | (string | null) | (string | null) | (number | null) | (string | null) | (string | null) | undefined;
1284
- };
1285
1047
  /**
1286
1048
  * Represent the basic type that a PropertyFormat
1287
1049
  * is using for data storage and data transport.
@@ -1363,9 +1125,6 @@ export type PropertyFormatPage = {
1363
1125
  */
1364
1126
  readonly totalItemCount?: number;
1365
1127
  };
1366
- export type PropertyFormatPageWritable = {
1367
- [key: string]: never;
1368
- };
1369
1128
  /**
1370
1129
  * Describes a property group of a ContentType in the CMS.
1371
1130
  */
@@ -1387,19 +1146,6 @@ export type PropertyGroup = {
1387
1146
  */
1388
1147
  sortOrder?: number;
1389
1148
  };
1390
- /**
1391
- * Describes a property group of a ContentType in the CMS.
1392
- */
1393
- export type PropertyGroupWritable = {
1394
- /**
1395
- * The display name of this PropertyGroup.
1396
- */
1397
- displayName?: string;
1398
- /**
1399
- * An value that is used to when sorting PropertyGroup instances.
1400
- */
1401
- sortOrder?: number;
1402
- };
1403
1149
  export type PropertyGroupPage = {
1404
1150
  /**
1405
1151
  * The items in this paged collection.
@@ -1418,9 +1164,6 @@ export type PropertyGroupPage = {
1418
1164
  */
1419
1165
  readonly totalItemCount?: number;
1420
1166
  };
1421
- export type PropertyGroupPageWritable = {
1422
- [key: string]: never;
1423
- };
1424
1167
  /**
1425
1168
  * Enumeration settings for a property or format.
1426
1169
  */
@@ -1542,7 +1285,7 @@ export type ChangesetsCreateData = {
1542
1285
  /**
1543
1286
  * The changeset that should be created.
1544
1287
  */
1545
- body: ChangesetWritable;
1288
+ body: Changeset;
1546
1289
  path?: never;
1547
1290
  query?: never;
1548
1291
  url: '/changesets';
@@ -1623,7 +1366,7 @@ export type ChangesetsPutData = {
1623
1366
  /**
1624
1367
  * The values of the created or replaced changeset.
1625
1368
  */
1626
- body: ChangesetWritable;
1369
+ body: Changeset;
1627
1370
  path: {
1628
1371
  /**
1629
1372
  * The key of the changeset to update or create.
@@ -1753,7 +1496,7 @@ export type ChangesetsCreateItemData = {
1753
1496
  /**
1754
1497
  * The changeset item
1755
1498
  */
1756
- body: ChangesetItemWritable;
1499
+ body: ChangesetItem;
1757
1500
  path: {
1758
1501
  /**
1759
1502
  * The changeset key
@@ -1785,7 +1528,7 @@ export type ChangesetsUpdateItemData = {
1785
1528
  /**
1786
1529
  * The changeset item
1787
1530
  */
1788
- body: ChangesetItemWritable;
1531
+ body: ChangesetItem;
1789
1532
  path: {
1790
1533
  /**
1791
1534
  * The changeset key
@@ -1830,7 +1573,7 @@ export type ContentCreateData = {
1830
1573
  /**
1831
1574
  * The content item that should be created.
1832
1575
  */
1833
- body: ContentItemWritable;
1576
+ body: ContentItem;
1834
1577
  path?: never;
1835
1578
  query?: {
1836
1579
  /**
@@ -1926,7 +1669,7 @@ export type ContentPatchMetadataData = {
1926
1669
  /**
1927
1670
  * The values of the content item that should be updated.
1928
1671
  */
1929
- body: ContentMetadataWritable;
1672
+ body: ContentMetadata;
1930
1673
  path: {
1931
1674
  /**
1932
1675
  * The key of the content item to patch.
@@ -2205,7 +1948,7 @@ export type ContentCreateVersionData = {
2205
1948
  /**
2206
1949
  * The content version that should be created.
2207
1950
  */
2208
- body: ContentItemWritable;
1951
+ body: ContentItem;
2209
1952
  path: {
2210
1953
  /**
2211
1954
  * The key of the content item for which a new content version should be created.
@@ -2294,7 +2037,7 @@ export type ContentPatchVersionData = {
2294
2037
  /**
2295
2038
  * The content information that should be updated.
2296
2039
  */
2297
- body: ContentItemWritable;
2040
+ body: ContentItem;
2298
2041
  path: {
2299
2042
  /**
2300
2043
  * The key of the content item that should be updated.
@@ -2372,7 +2115,7 @@ export type ContentTypesCreateData = {
2372
2115
  /**
2373
2116
  * The content type that should be created.
2374
2117
  */
2375
- body: ContentTypeWritable;
2118
+ body: ContentType;
2376
2119
  path?: never;
2377
2120
  query?: never;
2378
2121
  url: '/contenttypes';
@@ -2453,7 +2196,7 @@ export type ContentTypesPatchData = {
2453
2196
  /**
2454
2197
  * The values of the content type that should be updated.
2455
2198
  */
2456
- body: ContentTypeWritable;
2199
+ body: ContentType;
2457
2200
  path: {
2458
2201
  /**
2459
2202
  * The key of the content type to patch.
@@ -2490,7 +2233,7 @@ export type ContentTypesPutData = {
2490
2233
  /**
2491
2234
  * The values of the created or replaced content type.
2492
2235
  */
2493
- body: ContentTypeWritable;
2236
+ body: ContentType;
2494
2237
  path: {
2495
2238
  /**
2496
2239
  * The key of the content type to update or create.
@@ -2550,7 +2293,7 @@ export type DisplayTemplatesCreateData = {
2550
2293
  /**
2551
2294
  * The display template that should be created.
2552
2295
  */
2553
- body: DisplayTemplateWritable;
2296
+ body: DisplayTemplate;
2554
2297
  path?: never;
2555
2298
  query?: never;
2556
2299
  url: '/displaytemplates';
@@ -2631,7 +2374,7 @@ export type DisplayTemplatesPatchData = {
2631
2374
  /**
2632
2375
  * The values of the display template that should be updated.
2633
2376
  */
2634
- body: DisplayTemplateWritable;
2377
+ body: DisplayTemplate;
2635
2378
  path: {
2636
2379
  /**
2637
2380
  * The key of the display template to patch.
@@ -2663,7 +2406,7 @@ export type DisplayTemplatesPutData = {
2663
2406
  /**
2664
2407
  * The values of the created or replaced display template.
2665
2408
  */
2666
- body: DisplayTemplateWritable;
2409
+ body: DisplayTemplate;
2667
2410
  path: {
2668
2411
  /**
2669
2412
  * The key of the display template to update or create.
@@ -2795,7 +2538,7 @@ export type PropertyGroupsCreateData = {
2795
2538
  /**
2796
2539
  * The property group that should be created.
2797
2540
  */
2798
- body: PropertyGroupWritable;
2541
+ body: PropertyGroup;
2799
2542
  path?: never;
2800
2543
  query?: never;
2801
2544
  url: '/propertygroups';
@@ -2876,7 +2619,7 @@ export type PropertyGroupsPatchData = {
2876
2619
  /**
2877
2620
  * The values of the property group that should be updated.
2878
2621
  */
2879
- body: PropertyGroupWritable;
2622
+ body: PropertyGroup;
2880
2623
  path: {
2881
2624
  /**
2882
2625
  * The key of the property group to patch.
@@ -2908,7 +2651,7 @@ export type PropertyGroupsPutData = {
2908
2651
  /**
2909
2652
  * The values of the created or replaced property group.
2910
2653
  */
2911
- body: PropertyGroupWritable;
2654
+ body: PropertyGroup;
2912
2655
  path: {
2913
2656
  /**
2914
2657
  * The key of the property group to update or create.
package/dist/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "api": "preview2-1.0.0",
3
- "service": "2025.06.18.1735",
4
- "cms": "2025.06.18.1735"
3
+ "service": "2025.06.18.1736",
4
+ "cms": "2025.06.18.1736"
5
5
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@remkoj/optimizely-cms-api",
3
3
  "displayName": "Optimizely CMS - Integration API Client",
4
4
  "description": "A Javascript client for the Integration API provided by the Optimizely CMS.",
5
- "version": "6.0.0-pre1",
5
+ "version": "6.0.0-pre3",
6
6
  "type": "commonjs",
7
7
  "license": "Apache-2.0",
8
8
  "main": "./dist/index.js",
@@ -12,17 +12,17 @@
12
12
  ],
13
13
  "devDependencies": {
14
14
  "@hey-api/client-fetch": "^0.13.1",
15
- "@hey-api/openapi-ts": "^0.77.0",
16
- "@types/node": "^22.16.0",
17
- "dotenv": "^17.0.1",
15
+ "@hey-api/openapi-ts": "^0.78.2",
16
+ "@types/node": "^22.16.2",
17
+ "dotenv": "^17.1.0",
18
18
  "dotenv-expand": "^12.0.2",
19
19
  "glob": "^11.0.3",
20
20
  "rimraf": "^6.0.1",
21
21
  "typescript": "^5.8.3"
22
22
  },
23
23
  "dependencies": {
24
- "@types/node": "^22.16.0",
25
- "dotenv": "^17.0.1",
24
+ "@types/node": "^22.16.2",
25
+ "dotenv": "^17.1.0",
26
26
  "glob": "^11.0.3",
27
27
  "openapi-typescript-codegen": "^0.29.0",
28
28
  "tslib": "^2.8.1",