@remkoj/optimizely-cms-api 4.0.0 → 4.2.0

package/dist/client/index.d.ts

@@ -12,8 +12,8 @@ export type { ChangesetItemPage } from './models/ChangesetItemPage';
 export type { ChangesetPage } from './models/ChangesetPage';
 export type { ComponentListItem } from './models/ComponentListItem';
 export type { ComponentProperty } from './models/ComponentProperty';
+export { CompositionBehavior } from './models/CompositionBehavior';
 export { ContentBaseType } from './models/ContentBaseType';
-export type { ContentComponent } from './models/ContentComponent';
 export type { ContentItem } from './models/ContentItem';
 export type { ContentItemListWithContentTypes } from './models/ContentItemListWithContentTypes';
 export type { ContentItemPage } from './models/ContentItemPage';

package/dist/client/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyGroupsService = exports.PropertyFormatsService = exports.PackagesService = exports.OauthService = exports.DisplayTemplatesService = exports.ContentTypesService = exports.ContentService = exports.ChangesetsService = exports.VersionStatus = exports.PropertyDataType = exports.LocaleStatus = exports.IndexingType = exports.ContentTypeUsage = exports.ContentTypeFeature = exports.ContentBaseType = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.BaseHttpRequest = exports.ApiError = exports.CmsIntegrationApiClient = void 0;
+exports.PropertyGroupsService = exports.PropertyFormatsService = exports.PackagesService = exports.OauthService = exports.DisplayTemplatesService = exports.ContentTypesService = exports.ContentService = exports.ChangesetsService = exports.VersionStatus = exports.PropertyDataType = exports.LocaleStatus = exports.IndexingType = exports.ContentTypeUsage = exports.ContentTypeFeature = exports.ContentBaseType = exports.CompositionBehavior = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.BaseHttpRequest = exports.ApiError = exports.CmsIntegrationApiClient = void 0;
 /* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -16,6 +16,8 @@ Object.defineProperty(exports, "CancelablePromise", { enumerable: true, get: fun
 Object.defineProperty(exports, "CancelError", { enumerable: true, get: function () { return CancelablePromise_1.CancelError; } });
 var OpenAPI_1 = require("./core/OpenAPI");
 Object.defineProperty(exports, "OpenAPI", { enumerable: true, get: function () { return OpenAPI_1.OpenAPI; } });
+var CompositionBehavior_1 = require("./models/CompositionBehavior");
+Object.defineProperty(exports, "CompositionBehavior", { enumerable: true, get: function () { return CompositionBehavior_1.CompositionBehavior; } });
 var ContentBaseType_1 = require("./models/ContentBaseType");
 Object.defineProperty(exports, "ContentBaseType", { enumerable: true, get: function () { return ContentBaseType_1.ContentBaseType; } });
 var ContentTypeFeature_1 = require("./models/ContentTypeFeature");

package/dist/client/models/Changeset.d.ts

@@ -1,9 +1,9 @@
 /**
- * A writable implementation of an Changeset.
+ * Changesets are used to group work on several content items together.
  */
 export type Changeset = {
     /**
-     * The unique key of this Changeset
+     * The unique key of this Changeset.
      */
     key: string;
     /**
@@ -22,5 +22,5 @@ export type Changeset = {
      * The username of the user that created this changeset.
      */
     readonly createdBy?: string;
-    readonly lastModified?: string;
+    lastModified?: string;
 };

package/dist/client/models/ChangesetItem.d.ts

@@ -1,11 +1,11 @@
 import type { ContentReference } from './ContentReference';
 /**
- * A writable implementation of an ChangesetItem.
+ * Items in an changeset that contains a link to the specific content version.
  */
 export type ChangesetItem = {
     reference: ContentReference;
     /**
-     * Gets/sets item category.
+     * Gets/sets the changeset item category.
      */
     category?: string;
 };

package/dist/client/models/ComponentListItem.d.ts

@@ -3,5 +3,8 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can contain a component instance of a specific type.
  */
 export type ComponentListItem = (ListPropertyItem & {
+    /**
+     * The key of the ContentType that this ComponentListItem can contain.
+     */
     contentType: string;
 });

package/dist/client/models/ComponentProperty.d.ts

@@ -3,5 +3,8 @@ import type { ContentTypeProperty } from './ContentTypeProperty';
  * Describes a property that can contain a component instance of a specific type.
  */
 export type ComponentProperty = (ContentTypeProperty & {
+    /**
+     * The key of the ContentType that this ComponentProperty can contain.
+     */
     contentType: string;
 });

package/dist/client/models/CompositionBehavior.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Represent a Composition behavior for a ContentType.
+ */
+export declare enum CompositionBehavior {
+    SECTION_ENABLED = "sectionEnabled",
+    ELEMENT_ENABLED = "elementEnabled"
+}

package/dist/client/models/CompositionBehavior.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompositionBehavior = void 0;
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Represent a Composition behavior for a ContentType.
+ */
+var CompositionBehavior;
+(function (CompositionBehavior) {
+    CompositionBehavior["SECTION_ENABLED"] = "sectionEnabled";
+    CompositionBehavior["ELEMENT_ENABLED"] = "elementEnabled";
+})(CompositionBehavior || (exports.CompositionBehavior = CompositionBehavior = {}));

package/dist/client/models/ContentItem.d.ts

@@ -4,7 +4,7 @@ import type { VersionStatus } from './VersionStatus';
  */
 export type ContentItem = {
     /**
-     * Set of content type properties.
+     * Properties as they are defined by corresponding component or content type.
      */
     properties?: Record<string, any>;
     /**
@@ -40,11 +40,6 @@ export type ContentItem = {
      * Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
      */
     delayPublishUntil?: string | null;
-    readonly lastModified?: string;
-    /**
-     * The username of the user that made the latest modification to this content instance.
-     */
-    readonly lastModifiedBy?: string;
     /**
      * The key that identifies the container content that this content item belongs to.
      */
@@ -57,4 +52,9 @@ export type ContentItem = {
      * A string that represents the segment that should be used when routing or generate routes to the current content instance.
      */
     routeSegment?: string | null;
+    lastModified?: string;
+    /**
+     * The username of the user that made the latest modification to this content instance.
+     */
+    readonly lastModifiedBy?: string;
 };

package/dist/client/models/ContentListItem.d.ts

@@ -3,6 +3,12 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can hold a content item.
  */
 export type ContentListItem = (ListPropertyItem & {
+    /**
+     * Specifies which content types and base types these property items are allowed to contain.
+     */
     allowedTypes?: Array<string>;
+    /**
+     * Specifies which content types and base types these property items cannot contain.
+     */
     restrictedTypes?: Array<string>;
 });

package/dist/client/models/ContentMetadata.d.ts

@@ -11,6 +11,10 @@ export type ContentMetadata = {
      * The content type of this content.
      */
     contentType?: string;
+    /**
+     * Set of locales that this content has been created for.
+     */
+    readonly locales?: Record<string, ContentLocaleInfo>;
     /**
      * The key that identifies the container content that this content belongs to.
      */
@@ -23,10 +27,6 @@ export type ContentMetadata = {
      * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
      */
     owner?: string | null;
-    /**
-     * Set of locales that the content item has been created for.
-     */
-    readonly locales?: Record<string, ContentLocaleInfo>;
     /**
      * A timestamp, which if provided, indicates when this content was deleted.
      */

package/dist/client/models/ContentProperty.d.ts

@@ -3,6 +3,12 @@ import type { ContentTypeProperty } from './ContentTypeProperty';
  * Describes a property that can contain a content item.
  */
 export type ContentProperty = (ContentTypeProperty & {
+    /**
+     * Specifies which content types and base types this property is allowed to contain.
+     */
     allowedTypes?: Array<string>;
+    /**
+     * Specifies which content types and base types this property cannot contain.
+     */
     restrictedTypes?: Array<string>;
 });

package/dist/client/models/ContentReferenceListItem.d.ts

@@ -3,6 +3,12 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can hold a reference to a content item.
  */
 export type ContentReferenceListItem = (ListPropertyItem & {
+    /**
+     * Specifies which content types and base types these list items are allowed to reference.
+     */
     allowedTypes?: Array<string>;
+    /**
+     * Specifies which content types and base types these list items cannot contain.
+     */
     restrictedTypes?: Array<string>;
 });

package/dist/client/models/ContentReferenceProperty.d.ts

@@ -3,6 +3,12 @@ import type { ContentTypeProperty } from './ContentTypeProperty';
  * Describes a property that can contain a reference to a content item.
  */
 export type ContentReferenceProperty = (ContentTypeProperty & {
+    /**
+     * Specifies which content types and base types this property is allowed to reference.
+     */
     allowedTypes?: Array<string>;
+    /**
+     * Specifies which content types and base types this property is restricted from referencing.
+     */
     restrictedTypes?: Array<string>;
 });

package/dist/client/models/ContentType.d.ts

@@ -1,6 +1,7 @@
 import type { BinaryProperty } from './BinaryProperty';
 import type { BooleanProperty } from './BooleanProperty';
 import type { ComponentProperty } from './ComponentProperty';
+import type { CompositionBehavior } from './CompositionBehavior';
 import type { ContentBaseType } from './ContentBaseType';
 import type { ContentProperty } from './ContentProperty';
 import type { ContentReferenceProperty } from './ContentReferenceProperty';
@@ -56,17 +57,21 @@ export type ContentType = {
      */
     mediaFileExtensions?: Array<string>;
     /**
-     * A timestamp indicating when this ContentType was first created.
+     * Provides a set of composition behaviors specifying how this content type can be used within compositions.
      */
-    readonly created?: string;
+    compositionBehaviors?: Array<CompositionBehavior>;
     /**
-     * The username of the user that made the latest modification to this ContentType.
+     * A timestamp indicating when this ContentType was first created.
      */
-    readonly lastModifiedBy?: string;
+    readonly created?: string;
     /**
      * Indicates the last time this content type was modified.
      */
     readonly lastModified?: string;
+    /**
+     * The username of the user that made the latest modification to this ContentType.
+     */
+    readonly lastModifiedBy?: string;
     /**
      * Dictionary with all custom properties of this ContentType.
      */

package/dist/client/models/ContentTypeProperty.d.ts

@@ -1,7 +1,7 @@
 import type { IndexingType } from './IndexingType';
 import type { PropertyDataType } from './PropertyDataType';
 /**
- * A writable implementation of an ContentTypeProperty.
+ * Describes a property of a ContentType in the CMS.
  */
 export type ContentTypeProperty = {
     type: PropertyDataType;
@@ -17,15 +17,15 @@ export type ContentTypeProperty = {
      * A description of this ContentTypeProperty.
      */
     description?: string;
-    /**
-     * Indicates if a property instance of this type must always be assigned a value.
-     */
-    required?: boolean;
     /**
      * Indicates if a property instance of this type should be localized for each locale
      * or if values are shared between all locales.
      */
     localized?: boolean;
+    /**
+     * Indicates if a property instance of this type must always be assigned a value.
+     */
+    required?: boolean;
     /**
      * A reference to the PropertyGroup that this ContentTypeProperty is part of.
      * If this value is empty, a group may be assigned by the system.

package/dist/client/models/DateTimeListItem.d.ts

@@ -3,6 +3,12 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can contain a timestamp.
  */
 export type DateTimeListItem = (ListPropertyItem & {
+    /**
+     * The earliest timestamp that list items of this type should be able to contain.
+     */
     minimum?: string | null;
+    /**
+     * The latest timestamp that list items of this type should be able to contain.
+     */
     maximum?: string | null;
 });

package/dist/client/models/DateTimeProperty.d.ts

@@ -3,6 +3,12 @@ import type { ContentTypeProperty } from './ContentTypeProperty';
  * Describes a property that can contain a timestamp.
  */
 export type DateTimeProperty = (ContentTypeProperty & {
+    /**
+     * The earliest timestamp that properties of this type should be able to contain.
+     */
     minimum?: string | null;
+    /**
+     * The latest timestamp that properties of this type should be able to contain.
+     */
     maximum?: string | null;
 });

package/dist/client/models/DisplaySettingChoice.d.ts

@@ -3,7 +3,7 @@
  */
 export type DisplaySettingChoice = {
     /**
-     * The display name of this display setting.
+     * The display name of this display setting choice.
      */
     displayName: string;
     /**

package/dist/client/models/DoubleEnumerationSettings.d.ts

@@ -1,6 +1,6 @@
 import type { DoubleEnumerationValue } from './DoubleEnumerationValue';
 /**
- * A writable implementation of an EnumerationSettings`1.
+ * Enumeration settings for a property or format.
  */
 export type DoubleEnumerationSettings = {
     /**

package/dist/client/models/DoubleEnumerationValue.d.ts

@@ -3,11 +3,11 @@
  */
 export type DoubleEnumerationValue = {
     /**
-     * The display name of the enumeration.
+     * The display name of the value.
      */
     displayName?: string;
     /**
-     * The value of the enumeration.
+     * The underlying enumeration value.
      */
     value?: number;
 };

package/dist/client/models/FloatListItem.d.ts

@@ -4,7 +4,13 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can contain a float number.
  */
 export type FloatListItem = (ListPropertyItem & {
+    /**
+     * The minimum value that list items of this type should be able to contain.
+     */
     minimum?: number | null;
+    /**
+     * The maximum value that list items of this type should be able to contain.
+     */
     maximum?: number | null;
     enum?: DoubleEnumerationSettings;
 });

package/dist/client/models/FloatProperty.d.ts

@@ -4,7 +4,13 @@ import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
  * Describes a property that can contain a float number.
  */
 export type FloatProperty = (ContentTypeProperty & {
+    /**
+     * The minimum value that properties of this type should be able to contain.
+     */
     minimum?: number | null;
+    /**
+     * The maximum value that properties of this type should be able to contain.
+     */
     maximum?: number | null;
     enum?: DoubleEnumerationSettings;
 });

package/dist/client/models/IndexingType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Represent the indexing type of a ContentTypeProperty.
+ * Represents the indexing type of a content type property.
  */
 export declare enum IndexingType {
     DISABLED = "disabled",

package/dist/client/models/IndexingType.js

@@ -6,7 +6,7 @@ exports.IndexingType = void 0;
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Represent the indexing type of a ContentTypeProperty.
+ * Represents the indexing type of a content type property.
  */
 var IndexingType;
 (function (IndexingType) {

package/dist/client/models/Int32EnumerationSettings.d.ts

@@ -1,6 +1,6 @@
 import type { Int32EnumerationValue } from './Int32EnumerationValue';
 /**
- * A writable implementation of an EnumerationSettings`1.
+ * Enumeration settings for a property or format.
  */
 export type Int32EnumerationSettings = {
     /**

package/dist/client/models/Int32EnumerationValue.d.ts

@@ -3,11 +3,11 @@
  */
 export type Int32EnumerationValue = {
     /**
-     * The display name of the enumeration.
+     * The display name of the value.
      */
     displayName?: string;
     /**
-     * The value of the enumeration.
+     * The underlying enumeration value.
      */
     value?: number;
 };

package/dist/client/models/IntegerListItem.d.ts

@@ -4,7 +4,13 @@ import type { ListPropertyItem } from './ListPropertyItem';
  * Describes a property list item that can contain integers.
  */
 export type IntegerListItem = (ListPropertyItem & {
+    /**
+     * The minimum value that list items of this type should be able to contain.
+     */
     minimum?: number | null;
+    /**
+     * The maximum value that list items of this type should be able to contain.
+     */
     maximum?: number | null;
     enum?: Int32EnumerationSettings;
 });

package/dist/client/models/IntegerProperty.d.ts

@@ -4,7 +4,13 @@ import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
  * Describes a property that can contain an integer.
  */
 export type IntegerProperty = (ContentTypeProperty & {
+    /**
+     * The minimum value that properties of this type should be able to contain.
+     */
     minimum?: number | null;
+    /**
+     * The maximum value that properties of this type should be able to contain.
+     */
     maximum?: number | null;
     enum?: Int32EnumerationSettings;
 });

package/dist/client/models/Manifest.d.ts

@@ -2,19 +2,19 @@ import type { ContentType } from './ContentType';
 import type { DisplayTemplate } from './DisplayTemplate';
 import type { PropertyGroup } from './PropertyGroup';
 /**
- * Manifest that describest CMS definitions.
+ * Manifest that describe CMS definitions.
  */
 export type Manifest = {
     /**
-     * List of content type property groups.
+     * List of content type property groups that are part of this manifest.
      */
     propertyGroups?: Array<PropertyGroup>;
     /**
-     * List of content types.
+     * List of content types that are part of this manifest.
      */
     contentTypes?: Array<ContentType>;
     /**
-     * List of display templates.
+     * List of display templates that are part of this manifest.
      */
     displayTemplates?: Array<DisplayTemplate>;
     /**

package/dist/client/models/PropertyFormat.d.ts

@@ -17,6 +17,9 @@ export type PropertyFormat = {
      * Editor used for managing properties with this format.
      */
     editor?: string | null;
+    /**
+     * Indicates if this property format has been deleted.
+     */
     deleted?: boolean;
     /**
      * Settings for the editor.

package/dist/client/models/StringEnumerationSettings.d.ts

@@ -1,6 +1,6 @@
 import type { StringEnumerationValue } from './StringEnumerationValue';
 /**
- * A writable implementation of an EnumerationSettings`1.
+ * Enumeration settings for a property or format.
  */
 export type StringEnumerationSettings = {
     /**

package/dist/client/models/StringEnumerationValue.d.ts

@@ -3,11 +3,11 @@
  */
 export type StringEnumerationValue = {
     /**
-     * The display name of the enumeration.
+     * The display name of the value.
      */
     displayName?: string;
     /**
-     * The value of the enumeration.
+     * The underlying enumeration value.
      */
     value?: string;
 };

package/dist/client/models/StringListItem.d.ts

@@ -4,8 +4,17 @@ import type { StringEnumerationSettings } from './StringEnumerationSettings';
  * Describes a property list item that can contain a string.
  */
 export type StringListItem = (ListPropertyItem & {
+    /**
+     * The minimum string length that list items of this type should be able to contain.
+     */
     minLength?: number | null;
+    /**
+     * The maximum string length that list items of this type should be able to contain.
+     */
     maxLength?: number | null;
+    /**
+     * Regular expression pattern that limits what strings that list items of this type should be able to contain.
+     */
     pattern?: string | null;
     enum?: StringEnumerationSettings;
 });

package/dist/client/models/StringProperty.d.ts

@@ -4,8 +4,17 @@ import type { StringEnumerationSettings } from './StringEnumerationSettings';
  * Describes a property that can contain strings.
  */
 export type StringProperty = (ContentTypeProperty & {
+    /**
+     * The minimum string length that properties of this type should be able to contain.
+     */
     minLength?: number | null;
+    /**
+     * The maximum string length that properties of this type should be able to contain.
+     */
     maxLength?: number | null;
+    /**
+     * Regular expression pattern that limits what strings that properties of this type should be able to contain.
+     */
     pattern?: string | null;
     enum?: StringEnumerationSettings;
 });

package/dist/version.json

@@ -1,5 +1,5 @@
 {
     "api": "preview2-1.0.0",
-    "service": "2024.09.13.0710",
-    "cms": "2024.09.13.0710"
+    "service": "2024.12.20.1349",
+    "cms": "2024.12.20.1349"
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@remkoj/optimizely-cms-api",
   "displayName": "Optimizely CMS - Integration API Client",
   "description": "A Javascript client for the Integration API provided by the Optimizely CMS.",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "type": "commonjs",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -11,12 +11,12 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^22.10.1",
+    "@types/node": "^22.10.7",
     "dotenv": "^16.4.7",
-    "glob": "^11.0.0",
+    "glob": "^11.0.1",
     "openapi-typescript-codegen": "^0.29.0",
     "tslib": "^2.8.1",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "scripts": {
     "clean": "tsc --build --clean",

package/dist/client/models/ContentComponent.d.ts

@@ -1,34 +0,0 @@
-/**
- * Represents a content component.
- */
-export type ContentComponent = {
-    /**
-     * The name of the content component. If Reference is set, the name is automatically set to the name of the referenced content.
-     */
-    name?: string;
-    /**
-     * An optional display option for the content component.
-     */
-    displayOption?: string;
-    /**
-     * An optional group for the personalizable component.
-     */
-    segmentationGroup?: string;
-    /**
-     * Specifies the settings for the content component.
-     */
-    segments?: Array<string>;
-    /**
-     * A reference to the content of this component.
-     * Cannot be assigned together with Content.
-     */
-    reference?: string;
-    /**
-     * The key of the content type that this is an embedded instance of.
-     */
-    contentType?: string;
-    /**
-     * Dictionary with all custom properties as specified by associated ContentType
-     */
-    content?: any;
-};

package/dist/client/models/ContentComponent.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });