@remkoj/optimizely-cms-api 2.0.0-pre3 → 2.0.0-pre5

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

@@ -0,0 +1,22 @@
+import type { DisplaySettingChoice } from './DisplaySettingChoice';
+/**
+ * Describes a setting for a display template.
+ */
+export type DisplaySetting = {
+    /**
+     * The display name of this display setting.
+     */
+    displayName: string;
+    /**
+     * The suggested editor for this display setting.
+     */
+    editor?: string;
+    /**
+     * The sort order of this display setting within the template.
+     */
+    sortOrder?: number;
+    /**
+     * The available choices for this display setting.
+     */
+    choices?: Record<string, DisplaySettingChoice>;
+};

package/dist/client/models/DisplaySetting.js

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

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

@@ -0,0 +1,13 @@
+/**
+ * Describes a setting for a display template.
+ */
+export type DisplaySettingChoice = {
+    /**
+     * The display name of this display setting.
+     */
+    displayName: string;
+    /**
+     * The sort order of this choice within the setting.
+     */
+    sortOrder?: number;
+};

package/dist/client/models/DisplaySettingChoice.js

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

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

@@ -0,0 +1,49 @@
+import type { ContentBaseType } from './ContentBaseType';
+import type { DisplaySetting } from './DisplaySetting';
+/**
+ * Describes a display template that can be assigned to content.
+ */
+export type DisplayTemplate = {
+    /**
+     * The key that identifies this display template.
+     */
+    readonly key: string;
+    /**
+     * The display name of this display template.
+     */
+    displayName: string;
+    /**
+     * The optional node type this display template is valid for.
+     */
+    nodeType?: string | null;
+    baseType?: ContentBaseType;
+    /**
+     * 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.
+     */
+    isDefault?: boolean;
+    /**
+     * A timestamp indicating when this display template was first created.
+     */
+    readonly created?: string;
+    /**
+     * The username of the user that created this display template.
+     */
+    readonly createdBy?: string;
+    /**
+     * A timestamp indicating when this display template was last modified.
+     */
+    readonly lastModified?: string;
+    /**
+     * The username of the user that last modified this display template.
+     */
+    readonly lastModifiedBy?: string;
+    /**
+     * The available settings for this display template.
+     */
+    settings?: Record<string, DisplaySetting>;
+};

package/dist/client/models/DisplayTemplate.js

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

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

@@ -0,0 +1,19 @@
+import type { DisplayTemplate } from './DisplayTemplate';
+export type DisplayTemplatePage = {
+    /**
+     * The items in this paged collection.
+     */
+    readonly items?: Array<DisplayTemplate>;
+    /**
+     * The zero-based index of the current page.
+     */
+    readonly pageIndex?: number;
+    /**
+     * The number of item in each page. Not necessarily the same as the number of items in this page.
+     */
+    readonly pageSize?: number;
+    /**
+     * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
+     */
+    readonly totalItemCount?: number;
+};

package/dist/client/models/DisplayTemplatePage.js

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

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

@@ -1,9 +1,9 @@
-/**
- * A writable implementation of an EnumerationSettings`1.
- */
-export type DoubleEnumerationSettings = {
-    /**
-     * Enumeration values for this property or format.
-     */
-    values?: Record<string, string>;
-};
+/**
+ * A writable implementation of an EnumerationSettings`1.
+ */
+export type DoubleEnumerationSettings = {
+    /**
+     * Enumeration values for this property or format.
+     */
+    values?: Record<string, string>;
+};

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

@@ -1,16 +1,10 @@
-import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
-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;
-});
+import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
+import type { ListPropertyItem } from './ListPropertyItem';
+/**
+ * Describes a property list item that can contain a float number.
+ */
+export type FloatListItem = (ListPropertyItem & {
+    minimum?: number | null;
+    maximum?: number | null;
+    enum?: DoubleEnumerationSettings;
+});

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

@@ -1,16 +1,10 @@
-import type { ContentTypeProperty } from './ContentTypeProperty';
-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;
-});
+import type { ContentTypeProperty } from './ContentTypeProperty';
+import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
+/**
+ * Describes a property that can contain a float number.
+ */
+export type FloatProperty = (ContentTypeProperty & {
+    minimum?: number | null;
+    maximum?: number | null;
+    enum?: DoubleEnumerationSettings;
+});

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

@@ -1,17 +1,17 @@
-/**
- * Instruction for generating an alternative image from the main binary of an image content item.
- */
-export type ImageDescriptor = {
-    /**
-     * The image width in pixels.
-     */
-    width?: number;
-    /**
-     * The image height in pixels.
-     */
-    height?: number;
-    /**
-     * Indicates if the image should be pregenerated when a new image is uploaded rather than when first requested.
-     */
-    pregenerated?: boolean;
-};
+/**
+ * Instruction for generating an alternative image from the main binary of an image content item.
+ */
+export type ImageDescriptor = {
+    /**
+     * The image width in pixels.
+     */
+    width?: number;
+    /**
+     * The image height in pixels.
+     */
+    height?: number;
+    /**
+     * Indicates if the image should be pregenerated when a new image is uploaded rather than when first requested.
+     */
+    pregenerated?: boolean;
+};

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

@@ -1,17 +1,17 @@
-/**
- * Describes a message from a package importing operation.
- */
-export type ImportPackageMessage = {
-    /**
-     * The section where the message originated from.
-     */
-    readonly section?: string | null;
-    /**
-     * The message describing an outcome.
-     */
-    readonly message?: string;
-    /**
-     * The identifier of the resource that was the reason for this message to be created.
-     */
-    readonly identifier?: string | null;
-};
+/**
+ * Describes a message from a package importing operation.
+ */
+export type ImportPackageMessage = {
+    /**
+     * The section where the message originated from.
+     */
+    readonly section?: string | null;
+    /**
+     * The message describing an outcome.
+     */
+    readonly message?: string;
+    /**
+     * The identifier of the resource that was the reason for this message to be created.
+     */
+    readonly identifier?: string | null;
+};

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

@@ -1,22 +1,22 @@
-import type { ImportPackageMessage } from './ImportPackageMessage';
-/**
- * Describes the result of a data package import.
- */
-export type ImportPackageResult = {
-    /**
-     * Indication if the import succeeded.
-     */
-    readonly success?: boolean;
-    /**
-     * List of messages describing the outcome from the package import.
-     */
-    outcomes?: Array<ImportPackageMessage>;
-    /**
-     * List of error messages from the package import.
-     */
-    errors?: Array<ImportPackageMessage>;
-    /**
-     * List of warning messages from the package import.
-     */
-    warnings?: Array<ImportPackageMessage>;
-};
+import type { ImportPackageMessage } from './ImportPackageMessage';
+/**
+ * Describes the result of a data package import.
+ */
+export type ImportPackageResult = {
+    /**
+     * Indication if the import succeeded.
+     */
+    readonly success?: boolean;
+    /**
+     * List of messages describing the outcome from the package import.
+     */
+    outcomes?: Array<ImportPackageMessage>;
+    /**
+     * List of error messages from the package import.
+     */
+    errors?: Array<ImportPackageMessage>;
+    /**
+     * List of warning messages from the package import.
+     */
+    warnings?: Array<ImportPackageMessage>;
+};

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

@@ -1,8 +1,8 @@
-/**
- * Represent the indexing type of a ContentTypeProperty.
- */
-export declare enum IndexingType {
-    DISABLED = "disabled",
-    QUERYABLE = "queryable",
-    SEARCHABLE = "searchable"
-}
+/**
+ * Represent the indexing type of a ContentTypeProperty.
+ */
+export declare enum IndexingType {
+    DISABLED = "disabled",
+    QUERYABLE = "queryable",
+    SEARCHABLE = "searchable"
+}

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

@@ -1,9 +1,9 @@
-/**
- * A writable implementation of an EnumerationSettings`1.
- */
-export type Int32EnumerationSettings = {
-    /**
-     * Enumeration values for this property or format.
-     */
-    values?: Record<string, string>;
-};
+/**
+ * A writable implementation of an EnumerationSettings`1.
+ */
+export type Int32EnumerationSettings = {
+    /**
+     * Enumeration values for this property or format.
+     */
+    values?: Record<string, string>;
+};

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

@@ -1,16 +1,10 @@
-import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
-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;
-});
+import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
+import type { ListPropertyItem } from './ListPropertyItem';
+/**
+ * Describes a property list item that can contain integers.
+ */
+export type IntegerListItem = (ListPropertyItem & {
+    minimum?: number | null;
+    maximum?: number | null;
+    enum?: Int32EnumerationSettings;
+});

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

@@ -1,16 +1,10 @@
-import type { ContentTypeProperty } from './ContentTypeProperty';
-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;
-});
+import type { ContentTypeProperty } from './ContentTypeProperty';
+import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
+/**
+ * Describes a property that can contain an integer.
+ */
+export type IntegerProperty = (ContentTypeProperty & {
+    minimum?: number | null;
+    maximum?: number | null;
+    enum?: Int32EnumerationSettings;
+});

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

@@ -1,5 +1,5 @@
-import type { ContentTypeProperty } from './ContentTypeProperty';
-/**
- * Describes a property that can contain a JSON value in the form of a string.
- */
-export type JsonStringProperty = ContentTypeProperty;
+import type { ContentTypeProperty } from './ContentTypeProperty';
+/**
+ * Describes a property that can contain a JSON value in the form of a string.
+ */
+export type JsonStringProperty = (ContentTypeProperty & Record<string, any>);

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

@@ -1,26 +1,26 @@
-import type { ComponentListItem } from './ComponentListItem';
-import type { ContentListItem } from './ContentListItem';
-import type { ContentReferenceListItem } from './ContentReferenceListItem';
-import type { ContentTypeProperty } from './ContentTypeProperty';
-import type { DateTimeListItem } from './DateTimeListItem';
-import type { FloatListItem } from './FloatListItem';
-import type { IntegerListItem } from './IntegerListItem';
-import type { StringListItem } from './StringListItem';
-import type { UrlListItem } from './UrlListItem';
-/**
- * A property in the CMS that may hold a list of items.
- */
-export type ListProperty = (ContentTypeProperty & {
-    /**
-     * Specifies the minimum number of items in this array property.
-     */
-    minItems?: number | null;
-    /**
-     * Specifies the maximum number of items in this array property.
-     */
-    maxItems?: number | null;
-    /**
-     * Describes the list item of a ListProperty in the CMS.
-     */
-    items: (ComponentListItem | ContentListItem | ContentReferenceListItem | DateTimeListItem | FloatListItem | IntegerListItem | StringListItem | UrlListItem);
-});
+import type { ComponentListItem } from './ComponentListItem';
+import type { ContentListItem } from './ContentListItem';
+import type { ContentReferenceListItem } from './ContentReferenceListItem';
+import type { ContentTypeProperty } from './ContentTypeProperty';
+import type { DateTimeListItem } from './DateTimeListItem';
+import type { FloatListItem } from './FloatListItem';
+import type { IntegerListItem } from './IntegerListItem';
+import type { StringListItem } from './StringListItem';
+import type { UrlListItem } from './UrlListItem';
+/**
+ * A property in the CMS that may hold a list of items.
+ */
+export type ListProperty = (ContentTypeProperty & {
+    /**
+     * Specifies the minimum number of items in this array property.
+     */
+    minItems?: number | null;
+    /**
+     * Specifies the maximum number of items in this array property.
+     */
+    maxItems?: number | null;
+    /**
+     * Describes the list item of a ListProperty in the CMS.
+     */
+    items: (ComponentListItem | ContentListItem | ContentReferenceListItem | DateTimeListItem | FloatListItem | IntegerListItem | StringListItem | UrlListItem);
+});

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

@@ -1,11 +1,11 @@
-import type { PropertyDataType } from './PropertyDataType';
-/**
- * Describes the list item of a ListProperty in the CMS.
- */
-export type ListPropertyItem = {
-    type: PropertyDataType;
-    /**
-     * The key of the PropertyFormat that this property item is an instance of.
-     */
-    format?: string | null;
-};
+import type { PropertyDataType } from './PropertyDataType';
+/**
+ * Describes the list item of a ListProperty in the CMS.
+ */
+export type ListPropertyItem = {
+    type: PropertyDataType;
+    /**
+     * The key of the PropertyFormat that this property item is an instance of.
+     */
+    format?: string | null;
+};

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

@@ -1,7 +1,7 @@
-/**
- * Represent the different status values of a content locale.
- */
-export declare enum LocaleStatus {
-    DRAFT = "draft",
-    PUBLISHED = "published"
-}
+/**
+ * Represent the different status values of a content locale.
+ */
+export declare enum LocaleStatus {
+    DRAFT = "draft",
+    PUBLISHED = "published"
+}

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

@@ -1,19 +1,24 @@
-import type { ContentType } from './ContentType';
-import type { PropertyGroup } from './PropertyGroup';
-/**
- * Manifest that describest CMS definitions.
- */
-export type Manifest = {
-    /**
-     * List of content type property groups.
-     */
-    propertyGroups?: Array<PropertyGroup>;
-    /**
-     * List of content types.
-     */
-    contentTypes?: Array<ContentType>;
-    /**
-     * A timestamp indicated when any item in this manifest was last modified.
-     */
-    readonly lastModified?: string;
-};
+import type { ContentType } from './ContentType';
+import type { DisplayTemplate } from './DisplayTemplate';
+import type { PropertyGroup } from './PropertyGroup';
+/**
+ * Manifest that describest CMS definitions.
+ */
+export type Manifest = {
+    /**
+     * List of content type property groups.
+     */
+    propertyGroups?: Array<PropertyGroup>;
+    /**
+     * List of content types.
+     */
+    contentTypes?: Array<ContentType>;
+    /**
+     * List of display templates.
+     */
+    displayTemplates?: Array<DisplayTemplate>;
+    /**
+     * A timestamp indicated when any item in this manifest was last modified.
+     */
+    readonly lastModified?: string;
+};

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

@@ -1,18 +1,18 @@
-/**
- * Represents an OAuth JSON Web Token (JWT) and
- * its expiry in seconds.
- */
-export type OauthToken = {
-    /**
-     * Gets or sets the access token.
-     */
-    access_token?: string | null;
-    /**
-     * Gets or sets the expiry time in seconds.
-     */
-    expires_in?: number;
-    /**
-     * Gets or sets the token type.
-     */
-    token_type?: string;
-};
+/**
+ * Represents an OAuth JSON Web Token (JWT) and
+ * its expiry in seconds.
+ */
+export type OauthToken = {
+    /**
+     * Gets or sets the access token.
+     */
+    access_token?: string | null;
+    /**
+     * Gets or sets the expiry time in seconds.
+     */
+    expires_in?: number;
+    /**
+     * Gets or sets the token type.
+     */
+    token_type?: string;
+};

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

@@ -1,13 +1,13 @@
-/**
- * Represents an OAuth error.
- */
-export type OauthTokenError = {
-    /**
-     * Gets or sets the error.
-     */
-    error?: string | null;
-    /**
-     * Gets or sets the error description.
-     */
-    error_description?: string | null;
-};
+/**
+ * Represents an OAuth error.
+ */
+export type OauthTokenError = {
+    /**
+     * Gets or sets the error.
+     */
+    error?: string | null;
+    /**
+     * Gets or sets the error description.
+     */
+    error_description?: string | null;
+};