@remkoj/optimizely-cms-api 5.2.0 → 5.3.1

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

@@ -1,4 +1,3 @@
-import type { LocaleStatus } from './LocaleStatus';
 /**
  * Describes information about a locale instance of a content item.
  */
@@ -15,5 +14,17 @@ export type ContentLocaleInfo = {
      * The username of the user that created this locale version of content.
      */
     readonly createdBy?: string;
-    status?: LocaleStatus;
+    /**
+     * The status of the current locale.
+     */
+    readonly status?: ContentLocaleInfo.status;
 };
+export declare namespace ContentLocaleInfo {
+    /**
+     * The status of the current locale.
+     */
+    enum status {
+        DRAFT = "draft",
+        PUBLISHED = "published"
+    }
+}

package/dist/client/models/ContentLocaleInfo.js

@@ -1,2 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentLocaleInfo = void 0;
+var ContentLocaleInfo;
+(function (ContentLocaleInfo) {
+    /**
+     * The status of the current locale.
+     */
+    let status;
+    (function (status) {
+        status["DRAFT"] = "draft";
+        status["PUBLISHED"] = "published";
+    })(status = ContentLocaleInfo.status || (ContentLocaleInfo.status = {}));
+})(ContentLocaleInfo || (exports.ContentLocaleInfo = ContentLocaleInfo = {}));

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

@@ -9,7 +9,7 @@ export type ContentMetadataPage = {
      */
     readonly pageIndex?: number;
     /**
-     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     * The number of items in each page. Not necessarily the same as the number of items in this page.
      */
     readonly pageSize?: number;
     /**

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

@@ -1,19 +1,4 @@
-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';
-import type { ContentTypeFeature } from './ContentTypeFeature';
-import type { ContentTypeUsage } from './ContentTypeUsage';
-import type { DateTimeProperty } from './DateTimeProperty';
-import type { FloatProperty } from './FloatProperty';
-import type { IntegerProperty } from './IntegerProperty';
-import type { JsonStringProperty } from './JsonStringProperty';
-import type { ListProperty } from './ListProperty';
-import type { StringProperty } from './StringProperty';
-import type { UrlProperty } from './UrlProperty';
+import type { ContentTypeProperty } from './ContentTypeProperty';
 /**
  * A writable implementation of an ContentType.
  */
@@ -21,7 +6,7 @@ export type ContentType = {
     /**
      * The key that identifies this ContentType.
      */
-    key: string;
+    key?: string;
     /**
      * The display name of this ContentType.
      */
@@ -30,26 +15,21 @@ export type ContentType = {
      * A description of this ContentType.
      */
     description?: string;
-    baseType?: ContentBaseType;
+    /**
+     * The base type of this ContentType.
+     * Ignored for contracts; required for all other content types.
+     */
+    baseType?: string | null;
     /**
      * A string that is used to indicate the source of this ContentType.
      */
     readonly source?: string;
     /**
-     * An value that is used to when sorting ContentType instances.
+     * A value that is used to when sorting ContentType instances.
      */
     sortOrder?: number;
     /**
-     * Provides a set of features that content based on this ContentType supports.
-     * This value is assigned based on the BaseType and cannot be modified.
-     */
-    features?: Array<ContentTypeFeature>;
-    /**
-     * Specifies how this ContentType can be used.
-     */
-    usage?: Array<ContentTypeUsage>;
-    /**
-     * Provides a set of content types that can be created in container of this type
+     * Provides a set of content types that can be created in containers of this type
      */
     mayContainTypes?: Array<string>;
     /**
@@ -59,7 +39,7 @@ export type ContentType = {
     /**
      * Provides a set of composition behaviors specifying how this content type can be used within compositions.
      */
-    compositionBehaviors?: Array<CompositionBehavior>;
+    compositionBehaviors?: Array<'sectionEnabled' | 'elementEnabled' | 'formsElementEnabled'>;
     /**
      * A timestamp indicating when this ContentType was first created.
      */
@@ -75,10 +55,5 @@ export type ContentType = {
     /**
      * Dictionary with all custom properties of this ContentType.
      */
-    properties?: Record<string, (BinaryProperty | BooleanProperty | ComponentProperty | ContentProperty | ContentReferenceProperty | DateTimeProperty | FloatProperty | IntegerProperty | StringProperty | UrlProperty | JsonStringProperty | ListProperty | {
-        /**
-         * Settings for the editor.
-         */
-        editorSettings?: Record<string, Record<string, any>> | null;
-    })>;
+    properties?: Record<string, ContentTypeProperty>;
 };

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

@@ -9,7 +9,7 @@ export type ContentTypePage = {
      */
     readonly pageIndex?: number;
     /**
-     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     * The number of items in each page. Not necessarily the same as the number of items in this page.
      */
     readonly pageSize?: number;
     /**

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

@@ -1,14 +1,22 @@
-import type { IndexingType } from './IndexingType';
-import type { PropertyDataType } from './PropertyDataType';
+import type { ArrayItem } from './ArrayItem';
+import type { EnumerationValue } from './EnumerationValue';
+import type { ImageDescriptor } from './ImageDescriptor';
 /**
  * Describes a property of a ContentType in the CMS.
  */
 export type ContentTypeProperty = {
-    type: PropertyDataType;
+    /**
+     * Gets the data type for the property.
+     */
+    type?: ContentTypeProperty.type;
     /**
      * The key of the PropertyFormat that this ContentTypeProperty is an instance of.
      */
     format?: string | null;
+    /**
+     * The key of the content type that a property with 'type': 'component' may contain.
+     */
+    contentType?: string | null;
     /**
      * The display name of this ContentTypeProperty.
      */
@@ -35,13 +43,81 @@ export type ContentTypeProperty = {
      * An value that is used to when sorting ContentTypeProperty instances.
      */
     sortOrder?: number;
-    indexingType?: IndexingType;
     /**
-     * Editor used for managing this property.
+     * Indicates how should this property will be indexed in the search engine.
+     * If this value is not explicitly set, the property will be indexed using default indexing setting of the search engine.
+     */
+    indexingType?: ContentTypeProperty.indexingType;
+    /**
+     * The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
+     */
+    minimum?: (number | null | string | null) | null;
+    /**
+     * The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
+     */
+    maximum?: (number | null | string | null) | null;
+    /**
+     * A list of possible values that properties of this type should be able to contain.
+     */
+    enum?: Array<EnumerationValue> | null;
+    imageDescriptor?: ImageDescriptor;
+    /**
+     * 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 value that a string type property should be able to contain.
+     */
+    pattern?: string | null;
+    /**
+     * Optional minimum list length validation.
+     */
+    minItems?: number | null;
+    /**
+     * Optional maximum list length validation.
      */
-    editor?: string | null;
+    maxItems?: number | null;
     /**
-     * Settings for the editor.
+     * Specifies which content types and base types these property items are allowed to contain.
      */
-    editorSettings?: Record<string, Record<string, any>> | null;
+    allowedTypes?: Array<string>;
+    /**
+     * Specifies which content types and base types these property items cannot contain.
+     */
+    restrictedTypes?: Array<string>;
+    items?: ArrayItem;
 };
+export declare namespace ContentTypeProperty {
+    /**
+     * Gets the data type for the property.
+     */
+    enum type {
+        STRING = "string",
+        URL = "url",
+        BOOLEAN = "boolean",
+        INTEGER = "integer",
+        FLOAT = "float",
+        DATE_TIME = "dateTime",
+        CONTENT_REFERENCE = "contentReference",
+        CONTENT = "content",
+        BINARY = "binary",
+        LINK = "link",
+        RICH_TEXT = "richText",
+        JSON = "json",
+        ARRAY = "array",
+        COMPONENT = "component"
+    }
+    /**
+     * Indicates how should this property will be indexed in the search engine.
+     * If this value is not explicitly set, the property will be indexed using default indexing setting of the search engine.
+     */
+    enum indexingType {
+        DISABLED = "disabled",
+        QUERYABLE = "queryable",
+        SEARCHABLE = "searchable"
+    }
+}

package/dist/client/models/ContentTypeProperty.js

@@ -1,2 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentTypeProperty = void 0;
+var ContentTypeProperty;
+(function (ContentTypeProperty) {
+    /**
+     * Gets the data type for the property.
+     */
+    let type;
+    (function (type) {
+        type["STRING"] = "string";
+        type["URL"] = "url";
+        type["BOOLEAN"] = "boolean";
+        type["INTEGER"] = "integer";
+        type["FLOAT"] = "float";
+        type["DATE_TIME"] = "dateTime";
+        type["CONTENT_REFERENCE"] = "contentReference";
+        type["CONTENT"] = "content";
+        type["BINARY"] = "binary";
+        type["LINK"] = "link";
+        type["RICH_TEXT"] = "richText";
+        type["JSON"] = "json";
+        type["ARRAY"] = "array";
+        type["COMPONENT"] = "component";
+    })(type = ContentTypeProperty.type || (ContentTypeProperty.type = {}));
+    /**
+     * Indicates how should this property will be indexed in the search engine.
+     * If this value is not explicitly set, the property will be indexed using default indexing setting of the search engine.
+     */
+    let indexingType;
+    (function (indexingType) {
+        indexingType["DISABLED"] = "disabled";
+        indexingType["QUERYABLE"] = "queryable";
+        indexingType["SEARCHABLE"] = "searchable";
+    })(indexingType = ContentTypeProperty.indexingType || (ContentTypeProperty.indexingType = {}));
+})(ContentTypeProperty || (exports.ContentTypeProperty = ContentTypeProperty = {}));

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

@@ -1,4 +1,3 @@
-import type { ContentBaseType } from './ContentBaseType';
 import type { DisplaySetting } from './DisplaySetting';
 /**
  * Describes a display template that can be assigned to content.
@@ -7,7 +6,7 @@ export type DisplayTemplate = {
     /**
      * The key that identifies this display template.
      */
-    readonly key: string;
+    key?: string;
     /**
      * The display name of this display template.
      */
@@ -16,14 +15,16 @@ export type DisplayTemplate = {
      * The optional node type this display template is valid for.
      */
     nodeType?: string | null;
-    baseType?: ContentBaseType;
+    /**
+     * The optional base type this display template is valid for.
+     */
+    baseType?: string | null;
     /**
      * The optional key of the content type this display template is valid for.
      */
     contentType?: string | null;
     /**
-     * If this is the default display template for the associated base type,
-     * node type or content type.
+     * If this is the default display template for the associated base type, node type or content type.
      */
     isDefault?: boolean;
     /**

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

@@ -9,7 +9,7 @@ export type DisplayTemplatePage = {
      */
     readonly pageIndex?: number;
     /**
-     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     * The number of items in each page. Not necessarily the same as the number of items in this page.
      */
     readonly pageSize?: number;
     /**

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

@@ -0,0 +1,13 @@
+/**
+ * Describes one value in an enumeration of possible values.
+ */
+export type EnumerationValue = {
+    /**
+     * The defined enumeration value. Value type must match the property type.
+     */
+    value: (number | null | string | null);
+    /**
+     * The display name of the enumeration value.
+     */
+    displayName: string;
+};

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

@@ -11,7 +11,7 @@ export type ImageDescriptor = {
      */
     height?: number;
     /**
-     * Indicates if the image should be pregenerated when a new image is uploaded rather than when first requested.
+     * Indicates if the image should be pre-generated when a new image is uploaded rather than when first requested.
      */
     pregenerated?: boolean;
 };

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

@@ -0,0 +1,21 @@
+/**
+ * Represents a hyperlink.
+ */
+export type Link = {
+    /**
+     * Gets or sets the URL.
+     */
+    url?: string | null;
+    /**
+     * Gets or sets where to display the URL in a browsing context.
+     */
+    target?: string;
+    /**
+     * Gets or sets the title of the link.
+     */
+    title?: string;
+    /**
+     * Gets or sets the content inside a link.
+     */
+    text?: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Represents a preview URL for a content item.
+ */
+export type Preview = {
+    /**
+     * The application that this preview URL is associated with.
+     */
+    application?: string;
+    /**
+     * Gets or sets the preview URL (may be relative or absolute).
+     */
+    url?: string;
+};

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

@@ -1,4 +1,3 @@
-import type { PropertyDataType } from './PropertyDataType';
 /**
  * Represent the definition of semantic property formats for content items.
  */
@@ -7,31 +6,76 @@ export type PropertyFormat = {
      * The key that identifies this PropertyFormat.
      */
     key?: string;
-    dataType?: PropertyDataType;
-    itemType?: PropertyDataType;
+    /**
+     * The underlying data type used for this PropertyFormat.
+     */
+    dataType?: PropertyFormat.dataType;
+    /**
+     * The underlying item type used for this PropertyFormat.
+     */
+    itemType?: PropertyFormat.itemType;
     /**
      * The name and identifier of this PropertyFormat.
      */
     displayName?: string;
     /**
-     * Editor used for managing properties with this format.
+     * Indicates if this property format has been deleted.
      */
-    editor?: string | null;
+    readonly deleted?: boolean;
     /**
-     * Indicates if this property format has been deleted.
+     * A timestamp indicating when this display template was first created.
      */
-    deleted?: boolean;
+    readonly created?: string;
     /**
-     * Settings for the editor.
+     * The username of the user that created this display template.
      */
-    editorSettings?: Record<string, Record<string, any>> | null;
+    readonly createdBy?: string;
     /**
-     * Enumerations for the format.
+     * A timestamp indicating when this display template was last modified.
      */
-    enum?: {
-        values?: Array<{
-            value?: (string | number);
-            displayName?: string;
-        }>;
-    } | null;
+    readonly lastModified?: string;
+    /**
+     * The username of the user that last modified this display template.
+     */
+    readonly lastModifiedBy?: string;
 };
+export declare namespace PropertyFormat {
+    /**
+     * The underlying data type used for this PropertyFormat.
+     */
+    enum dataType {
+        STRING = "string",
+        URL = "url",
+        BOOLEAN = "boolean",
+        INTEGER = "integer",
+        FLOAT = "float",
+        DATE_TIME = "dateTime",
+        CONTENT_REFERENCE = "contentReference",
+        CONTENT = "content",
+        BINARY = "binary",
+        LINK = "link",
+        RICH_TEXT = "richText",
+        JSON = "json",
+        ARRAY = "array",
+        COMPONENT = "component"
+    }
+    /**
+     * The underlying item type used for this PropertyFormat.
+     */
+    enum itemType {
+        STRING = "string",
+        URL = "url",
+        BOOLEAN = "boolean",
+        INTEGER = "integer",
+        FLOAT = "float",
+        DATE_TIME = "dateTime",
+        CONTENT_REFERENCE = "contentReference",
+        CONTENT = "content",
+        BINARY = "binary",
+        LINK = "link",
+        RICH_TEXT = "richText",
+        JSON = "json",
+        ARRAY = "array",
+        COMPONENT = "component"
+    }
+}

package/dist/client/models/PropertyFormat.js

@@ -1,2 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyFormat = void 0;
+var PropertyFormat;
+(function (PropertyFormat) {
+    /**
+     * The underlying data type used for this PropertyFormat.
+     */
+    let dataType;
+    (function (dataType) {
+        dataType["STRING"] = "string";
+        dataType["URL"] = "url";
+        dataType["BOOLEAN"] = "boolean";
+        dataType["INTEGER"] = "integer";
+        dataType["FLOAT"] = "float";
+        dataType["DATE_TIME"] = "dateTime";
+        dataType["CONTENT_REFERENCE"] = "contentReference";
+        dataType["CONTENT"] = "content";
+        dataType["BINARY"] = "binary";
+        dataType["LINK"] = "link";
+        dataType["RICH_TEXT"] = "richText";
+        dataType["JSON"] = "json";
+        dataType["ARRAY"] = "array";
+        dataType["COMPONENT"] = "component";
+    })(dataType = PropertyFormat.dataType || (PropertyFormat.dataType = {}));
+    /**
+     * The underlying item type used for this PropertyFormat.
+     */
+    let itemType;
+    (function (itemType) {
+        itemType["STRING"] = "string";
+        itemType["URL"] = "url";
+        itemType["BOOLEAN"] = "boolean";
+        itemType["INTEGER"] = "integer";
+        itemType["FLOAT"] = "float";
+        itemType["DATE_TIME"] = "dateTime";
+        itemType["CONTENT_REFERENCE"] = "contentReference";
+        itemType["CONTENT"] = "content";
+        itemType["BINARY"] = "binary";
+        itemType["LINK"] = "link";
+        itemType["RICH_TEXT"] = "richText";
+        itemType["JSON"] = "json";
+        itemType["ARRAY"] = "array";
+        itemType["COMPONENT"] = "component";
+    })(itemType = PropertyFormat.itemType || (PropertyFormat.itemType = {}));
+})(PropertyFormat || (exports.PropertyFormat = PropertyFormat = {}));

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

@@ -9,7 +9,7 @@ export type PropertyFormatPage = {
      */
     readonly pageIndex?: number;
     /**
-     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     * The number of items in each page. Not necessarily the same as the number of items in this page.
      */
     readonly pageSize?: number;
     /**

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

@@ -5,7 +5,7 @@ export type PropertyGroup = {
     /**
      * The key that identifies this PropertyGroup.
      */
-    readonly key: string;
+    key?: string;
     /**
      * The display name of this PropertyGroup.
      */
@@ -18,4 +18,17 @@ export type PropertyGroup = {
      * An value that is used to when sorting PropertyGroup instances.
      */
     sortOrder?: number;
+    /**
+     * A timestamp indicating when this property group was first created.
+     */
+    readonly created?: string;
+    /**
+     * The username of the user that created this property group.
+     */
+    readonly createdBy?: string;
+    readonly lastModified?: string;
+    /**
+     * The username of the user that last modified this property group.
+     */
+    readonly lastModifiedBy?: string;
 };

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

@@ -9,7 +9,7 @@ export type PropertyGroupPage = {
      */
     readonly pageIndex?: number;
     /**
-     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     * The number of items in each page. Not necessarily the same as the number of items in this page.
      */
     readonly pageSize?: number;
     /**

package/dist/client/services/BlueprintsService.d.ts

@@ -0,0 +1,56 @@
+import type { Blueprint } from '../models/Blueprint';
+import type { BlueprintPage } from '../models/BlueprintPage';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class BlueprintsService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * List blueprints
+     * List blueprints using the provided parameters. This API is experimental and may change in future releases.
+     * @param pageIndex
+     * @param pageSize
+     * @returns BlueprintPage OK
+     * @throws ApiError
+     */
+    blueprintsList(pageIndex?: number, pageSize?: number): CancelablePromise<BlueprintPage>;
+    /**
+     * Create a blueprint
+     * Create a new blueprint. This API is experimental and may change in future releases.
+     * @param requestBody The blueprint that should be created.
+     * @returns Blueprint Created
+     * @throws ApiError
+     */
+    blueprintsCreate(requestBody: Blueprint): CancelablePromise<Blueprint>;
+    /**
+     * Get a specific blueprint
+     * Get the blueprint with the provided key. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to retrieve.
+     * @param ifNoneMatch If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
+     * @param ifModifiedSince If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsGet(key: string, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<Blueprint>;
+    /**
+     * Patch blueprint
+     * Patch an existing blueprint. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to patch.
+     * @param requestBody The values of the blueprint that should be patched formatted according to RFC7396.
+     * @param ifMatch If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
+     * @param ifUnmodifiedSince If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsPatch(key: string, requestBody: Blueprint, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<Blueprint>;
+    /**
+     * Delete a blueprint
+     * Deletes the blueprint with the provided key. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to delete.
+     * @param ifMatch If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
+     * @param ifUnmodifiedSince If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsDelete(key: string, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<Blueprint>;
+}