@remkoj/optimizely-cms-api 2.0.0-pre2

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

@@ -0,0 +1,16 @@
+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;
+});

package/dist/client/models/FloatProperty.js

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

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

@@ -0,0 +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;
+};

package/dist/client/models/ImageDescriptor.js

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

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

@@ -0,0 +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;
+};

package/dist/client/models/ImportPackageMessage.js

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

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

@@ -0,0 +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>;
+};

package/dist/client/models/ImportPackageResult.js

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

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

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

package/dist/client/models/IndexingType.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexingType = void 0;
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Represent the indexing type of a ContentTypeProperty.
+ */
+var IndexingType;
+(function (IndexingType) {
+    IndexingType["DISABLED"] = "disabled";
+    IndexingType["QUERYABLE"] = "queryable";
+    IndexingType["SEARCHABLE"] = "searchable";
+})(IndexingType || (exports.IndexingType = IndexingType = {}));

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

@@ -0,0 +1,9 @@
+/**
+ * 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/Int32EnumerationSettings.js

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

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

@@ -0,0 +1,16 @@
+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;
+});

package/dist/client/models/IntegerListItem.js

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

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

@@ -0,0 +1,16 @@
+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;
+});

package/dist/client/models/IntegerProperty.js

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

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

@@ -0,0 +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;

package/dist/client/models/JsonStringProperty.js

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

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

@@ -0,0 +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);
+});

package/dist/client/models/ListProperty.js

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

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

@@ -0,0 +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;
+};

package/dist/client/models/ListPropertyItem.js

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

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

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

package/dist/client/models/LocaleStatus.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocaleStatus = void 0;
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Represent the different status values of a content locale.
+ */
+var LocaleStatus;
+(function (LocaleStatus) {
+    LocaleStatus["DRAFT"] = "draft";
+    LocaleStatus["PUBLISHED"] = "published";
+})(LocaleStatus || (exports.LocaleStatus = LocaleStatus = {}));

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

@@ -0,0 +1,19 @@
+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;
+};

package/dist/client/models/Manifest.js

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

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

@@ -0,0 +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;
+};

package/dist/client/models/OauthToken.js

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

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

@@ -0,0 +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;
+};

package/dist/client/models/OauthTokenError.js

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

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

@@ -0,0 +1,21 @@
+/**
+ * Represents an OAuth token request.
+ */
+export type OauthTokenRequest = {
+    /**
+     * Gets or sets the grant type.
+     */
+    grant_type?: string | null;
+    /**
+     * Gets or sets the client id.
+     */
+    client_id?: string | null;
+    /**
+     * Gets or sets the client secret.
+     */
+    client_secret?: string | null;
+    /**
+     * Get or sets the subject to act as.
+     */
+    act_as?: string | null;
+};

package/dist/client/models/OauthTokenRequest.js

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

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

@@ -0,0 +1,28 @@
+import type { PackageJobMessage } from './PackageJobMessage';
+import type { PackageJobStatus } from './PackageJobStatus';
+/**
+ * Describes the status of a package job.
+ */
+export type PackageJob = {
+    /**
+     * An unique key that can be used to track the staus of a package job.
+     */
+    readonly key?: string;
+    status?: PackageJobStatus;
+    /**
+     * List of messages describing the outcome from the package job.
+     */
+    outcomes?: Array<PackageJobMessage>;
+    /**
+     * List of error messages from the package job.
+     */
+    errors?: Array<PackageJobMessage>;
+    /**
+     * List of warning messages from the package job.
+     */
+    warnings?: Array<PackageJobMessage>;
+    /**
+     * A timestamp indicates when this task was first created.
+     */
+    readonly created?: string;
+};

package/dist/client/models/PackageJob.js

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

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

@@ -0,0 +1,17 @@
+/**
+ * Describes a status message from a package job.
+ */
+export type PackageJobMessage = {
+    /**
+     * The section where the message originated from.
+     */
+    readonly section?: string;
+    /**
+     * 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/PackageJobMessage.js

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

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

@@ -0,0 +1,4 @@
+/**
+ * Represent the status of a package job.
+ */
+export type PackageJobStatus = Record<string, any>;

package/dist/client/models/PackageJobStatus.js

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

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

@@ -0,0 +1 @@
+export type ProblemDetails = Record<string, any>;

package/dist/client/models/ProblemDetails.js

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

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

@@ -0,0 +1,18 @@
+/**
+ * Represent the basic type that a PropertyFormat
+ * is using for data storage and data transport.
+ */
+export declare enum PropertyDataType {
+    STRING = "string",
+    URL = "url",
+    BOOLEAN = "boolean",
+    INTEGER = "integer",
+    FLOAT = "float",
+    DATE_TIME = "dateTime",
+    CONTENT_REFERENCE = "contentReference",
+    CONTENT = "content",
+    BINARY = "binary",
+    JSON = "json",
+    ARRAY = "array",
+    COMPONENT = "component"
+}

package/dist/client/models/PropertyDataType.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyDataType = void 0;
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Represent the basic type that a PropertyFormat
+ * is using for data storage and data transport.
+ */
+var PropertyDataType;
+(function (PropertyDataType) {
+    PropertyDataType["STRING"] = "string";
+    PropertyDataType["URL"] = "url";
+    PropertyDataType["BOOLEAN"] = "boolean";
+    PropertyDataType["INTEGER"] = "integer";
+    PropertyDataType["FLOAT"] = "float";
+    PropertyDataType["DATE_TIME"] = "dateTime";
+    PropertyDataType["CONTENT_REFERENCE"] = "contentReference";
+    PropertyDataType["CONTENT"] = "content";
+    PropertyDataType["BINARY"] = "binary";
+    PropertyDataType["JSON"] = "json";
+    PropertyDataType["ARRAY"] = "array";
+    PropertyDataType["COMPONENT"] = "component";
+})(PropertyDataType || (exports.PropertyDataType = PropertyDataType = {}));

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

@@ -0,0 +1,34 @@
+import type { PropertyDataType } from './PropertyDataType';
+/**
+ * Represent the definition of semantic property formats for content items.
+ */
+export type PropertyFormat = {
+    /**
+     * The key that identifies this PropertyFormat.
+     */
+    key?: string;
+    dataType?: PropertyDataType;
+    itemType?: PropertyDataType;
+    /**
+     * The name and identifier of this PropertyFormat.
+     */
+    displayName?: string;
+    /**
+     * Editor used for managing properties with this format.
+     */
+    editor?: string | null;
+    deleted?: boolean;
+    /**
+     * Settings for the editor.
+     */
+    editorSettings?: Record<string, Record<string, any>> | null;
+    /**
+     * Enumerations for the format.
+     */
+    enum?: {
+        values?: Array<{
+            value?: (string | number);
+            displayName?: string;
+        }>;
+    } | null;
+};

package/dist/client/models/PropertyFormat.js

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

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

@@ -0,0 +1,19 @@
+import type { PropertyFormat } from './PropertyFormat';
+export type PropertyFormatPage = {
+    /**
+     * The items in this paged collection.
+     */
+    readonly items?: Array<PropertyFormat>;
+    /**
+     * 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/PropertyFormatPage.js

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

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

@@ -0,0 +1,21 @@
+/**
+ * Describes a property group of a ContentType in the CMS.
+ */
+export type PropertyGroup = {
+    /**
+     * The key that identifies this PropertyGroup.
+     */
+    key: string;
+    /**
+     * The display name of this PropertyGroup.
+     */
+    displayName?: string;
+    /**
+     * A string that is used to indicate the source of this PropertyGroup.
+     */
+    readonly source?: string;
+    /**
+     * An value that is used to when sorting PropertyGroup instances.
+     */
+    sortOrder?: number;
+};

package/dist/client/models/PropertyGroup.js

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

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

@@ -0,0 +1,19 @@
+import type { PropertyGroup } from './PropertyGroup';
+export type PropertyGroupPage = {
+    /**
+     * The items in this paged collection.
+     */
+    readonly items?: Array<PropertyGroup>;
+    /**
+     * 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/PropertyGroupPage.js

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

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

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

package/dist/client/models/StringEnumerationSettings.js

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

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

@@ -0,0 +1,14 @@
+import type { ListPropertyItem } from './ListPropertyItem';
+import type { StringEnumerationSettings } from './StringEnumerationSettings';
+/**
+ * Describes a property list item that can contain a string.
+ */
+export type StringListItem = (ListPropertyItem & {
+    minLength?: number | null;
+    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/StringListItem.js

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

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

@@ -0,0 +1,14 @@
+import type { ContentTypeProperty } from './ContentTypeProperty';
+import type { StringEnumerationSettings } from './StringEnumerationSettings';
+/**
+ * Describes a property that can contain strings.
+ */
+export type StringProperty = (ContentTypeProperty & {
+    minLength?: number | null;
+    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/client/models/StringProperty.js

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