@remkoj/optimizely-cms-api 5.1.7 → 5.3.0

package/dist/client/services/PropertyGroupsService.js

@@ -8,9 +8,8 @@ class PropertyGroupsService {
     /**
      * List property groups
      * List property groups using the provided options.
-     * @param sources Indicates which property groups sources that should be listed.
-     * Use All to include groups from all sources or
-     * Default to include groups without a specific sources.
+     * @param sources Indicates which property groups sources should be listed.
+     * Use 'DEFAULT' to include groups without a specific sources.
      * @returns PropertyGroupPage OK
      * @throws ApiError
      */
@@ -30,7 +29,7 @@ class PropertyGroupsService {
      * Create property group
      * Create a new property group.
      * @param requestBody The property group that should be created.
-     * @returns PropertyGroup OK
+     * @returns PropertyGroup Created
      * @throws ApiError
      */
     propertyGroupsCreate(requestBody) {
@@ -49,65 +48,57 @@ class PropertyGroupsService {
      * Get property group
      * Get the property group with the provided key.
      * @param key The key of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsGet(key) {
+    propertyGroupsGet(key, ifNoneMatch, ifModifiedSince) {
         return this.httpRequest.request({
             method: 'GET',
             url: '/propertygroups/{key}',
             path: {
                 'key': key,
             },
-            errors: {
-                403: `Forbidden`,
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
             },
-        });
-    }
-    /**
-     * Create or replace property group
-     * Create or replace a property group. If a property group with the provided key exist it is replaced.
-     * Otherwise a new property group is created.
-     * @param key The key of the property group to update or create.
-     * @param requestBody The values of the created or replaced property group.
-     * @returns PropertyGroup OK
-     * @throws ApiError
-     */
-    propertyGroupsPut(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
             errors: {
-                400: `Bad Request`,
+                304: `Not Modified`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
-     * Update property group
-     * Update an existing property group.
+     * Patch property group
+     * Patch an existing property group.
      * @param key The key of the property group to patch.
-     * @param requestBody The values of the property group that should be updated.
+     * @param requestBody The values of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsPatch(key, requestBody) {
+    propertyGroupsPatch(key, requestBody, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'PATCH',
             url: '/propertygroups/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
             body: requestBody,
             mediaType: 'application/merge-patch+json',
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
             },
         });
     }
@@ -115,19 +106,27 @@ class PropertyGroupsService {
      * Delete property group
      * Deletes the property group with the provided key.
      * @param key The key of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsDelete(key) {
+    propertyGroupsDelete(key, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'DELETE',
             url: '/propertygroups/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
             },
         });
     }

package/dist/enums.d.ts

@@ -0,0 +1,35 @@
+/**
+ * List of content base types used by the CMS
+ *
+ * @deprecated Only retained here for compatibility
+ */
+export declare enum ContentBaseType {
+    PAGE = "page",
+    COMPONENT = "component",
+    MEDIA = "media",
+    IMAGE = "image",
+    VIDEO = "video",
+    FOLDER = "folder",
+    EXPERIENCE = "experience",
+    SECTION = "section",
+    ELEMENT = "element"
+}
+/**
+ * List of property types used by the CMS
+ *
+ * @deprecated Only retained here for compatibility
+ */
+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/enums.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyDataType = exports.ContentBaseType = void 0;
+/**
+ * List of content base types used by the CMS
+ *
+ * @deprecated Only retained here for compatibility
+ */
+var ContentBaseType;
+(function (ContentBaseType) {
+    ContentBaseType["PAGE"] = "page";
+    ContentBaseType["COMPONENT"] = "component";
+    ContentBaseType["MEDIA"] = "media";
+    ContentBaseType["IMAGE"] = "image";
+    ContentBaseType["VIDEO"] = "video";
+    ContentBaseType["FOLDER"] = "folder";
+    ContentBaseType["EXPERIENCE"] = "experience";
+    ContentBaseType["SECTION"] = "section";
+    ContentBaseType["ELEMENT"] = "element";
+})(ContentBaseType || (exports.ContentBaseType = ContentBaseType = {}));
+/**
+ * List of property types used by the CMS
+ *
+ * @deprecated Only retained here for compatibility
+ */
+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/getaccesstoken.js

@@ -9,10 +9,11 @@ function isErrorResponse(response) {
 }
 async function getAccessToken(config) {
     const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-    let authUrl = new URL(`${OpenAPI_1.OpenAPI.BASE}/oauth/token`, options.base).href;
+    let authUrl = options.cmsVersion === types_1.OptiCmsVersion.CMS12 ? (() => {
+        let u = new URL(`${OpenAPI_1.OpenAPI.BASE}/oauth/token`, options.base).href;
+        return u.replace('preview2', 'preview1');
+    })() : new URL('/oauth/token', OpenAPI_1.OpenAPI.BASE).href;
     const headers = new Headers();
-    if (options.cmsVersion == types_1.OptiCmsVersion.CMS12)
-        authUrl = authUrl.replace('preview2', 'preview1');
     headers.append('Authorization', `Basic ${base64Encode(`${options.clientId}:${options.clientSecret}`)}`);
     headers.append('Content-Type', 'application/x-www-form-urlencoded');
     headers.append('Connection', 'close');

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { CmsIntegrationApiClient as CoreClient } from './client';
 export { ApiClient } from './api-client';
 export { ApiClient as CmsIntegrationApiClient } from './api-client';
 export { OptiCmsVersion } from "./types";
+export * from './enums';
 import { type CmsIntegrationApiOptions } from './config';
 import { ApiClient as CmsIntegrationApiClient } from './api-client';
 export type ApiClientInstance = InstanceType<typeof CmsIntegrationApiClient>;

package/dist/index.js

@@ -48,6 +48,7 @@ var api_client_2 = require("./api-client");
 Object.defineProperty(exports, "CmsIntegrationApiClient", { enumerable: true, get: function () { return api_client_2.ApiClient; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "OptiCmsVersion", { enumerable: true, get: function () { return types_1.OptiCmsVersion; } });
+__exportStar(require("./enums"), exports);
 const api_client_3 = require("./api-client");
 function createClient(config) {
     return new api_client_3.ApiClient(config);

package/dist/version.json

@@ -1,5 +1,5 @@
 {
-    "api": "preview2-1.0.0",
-    "service": "2025.03.18.1237",
-    "cms": "2025.03.18.1237"
+    "api": "preview3-1.0.0",
+    "service": "2026.01.06.0826-preview2",
+    "cms": "2026.01.06.0826-preview2"
 }

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": "5.1.7",
+  "version": "5.3.0",
   "type": "commonjs",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -11,18 +11,18 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^22.16.5",
-    "dotenv": "^17.2.0",
-    "glob": "^11.0.3",
+    "@types/node": "^22.19.3",
+    "dotenv": "^17.2.3",
+    "glob": "^11.1.0",
     "openapi-typescript-codegen": "^0.29.0",
     "tslib": "^2.8.1",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "clean": "tsc --build --clean",
     "prepare": "tsc --build",
     "watch": "tsc --watch",
-    "rebuild": "yarn clean && yarn update-client && tsc --build --force",
+    "rebuild": "yarn clean && yarn generate && tsc --build --force",
     "generate": "yarn generate-spec && yarn generate-client",
     "generate-client": "yarn openapi --input ./integrationapi.spec.json --output ./src/client --name CmsIntegrationApiClient",
     "generate-spec": "yarn node scripts/update-spec.js"

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

@@ -1,8 +0,0 @@
-import type { ContentTypeProperty } from './ContentTypeProperty';
-import type { ImageDescriptor } from './ImageDescriptor';
-/**
- * Describes a property that can contain a reference to binary data.
- */
-export type BinaryProperty = (ContentTypeProperty & {
-    imageDescriptor?: ImageDescriptor;
-});

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

@@ -1,5 +0,0 @@
-import type { ContentTypeProperty } from './ContentTypeProperty';
-/**
- * Describes a property that can contain a boolean value.
- */
-export type BooleanProperty = (ContentTypeProperty & Record<string, any>);

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

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

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

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

package/dist/client/models/CompositionBehavior.js

@@ -1,15 +0,0 @@
-"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/ContentBaseType.d.ts

@@ -1,14 +0,0 @@
-/**
- * Represent the base type of a ContentType.
- */
-export declare enum ContentBaseType {
-    PAGE = "page",
-    COMPONENT = "component",
-    MEDIA = "media",
-    IMAGE = "image",
-    VIDEO = "video",
-    FOLDER = "folder",
-    EXPERIENCE = "experience",
-    SECTION = "section",
-    ELEMENT = "element"
-}

package/dist/client/models/ContentBaseType.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentBaseType = void 0;
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Represent the base type of a ContentType.
- */
-var ContentBaseType;
-(function (ContentBaseType) {
-    ContentBaseType["PAGE"] = "page";
-    ContentBaseType["COMPONENT"] = "component";
-    ContentBaseType["MEDIA"] = "media";
-    ContentBaseType["IMAGE"] = "image";
-    ContentBaseType["VIDEO"] = "video";
-    ContentBaseType["FOLDER"] = "folder";
-    ContentBaseType["EXPERIENCE"] = "experience";
-    ContentBaseType["SECTION"] = "section";
-    ContentBaseType["ELEMENT"] = "element";
-})(ContentBaseType || (exports.ContentBaseType = ContentBaseType = {}));

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

@@ -1,27 +0,0 @@
-import type { ContentItem } from './ContentItem';
-import type { ContentType } from './ContentType';
-/**
- * The response object for Page`1 when used ContentType are included.
- */
-export type ContentItemListWithContentTypes = {
-    /**
-     * The content types that are used by the content items in the response.
-     */
-    readonly contentTypes?: Array<ContentType>;
-    /**
-     * The content items in this paged collection.
-     */
-    readonly items?: Array<ContentItem>;
-    /**
-     * 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/ContentItemWithContentTypes.d.ts

@@ -1,12 +0,0 @@
-import type { ContentItem } from './ContentItem';
-import type { ContentType } from './ContentType';
-/**
- * The response object for ContentItem when used ContentType are included.
- */
-export type ContentItemWithContentTypes = {
-    /**
-     * The content types that are used by the content item in the response.
-     */
-    readonly contentTypes?: Array<ContentType>;
-    item?: ContentItem;
-};

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

@@ -1,14 +0,0 @@
-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/ContentProperty.d.ts

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

@@ -1,14 +0,0 @@
-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/ContentReferenceListItem.js

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

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

@@ -1,14 +0,0 @@
-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/ContentReferenceProperty.js

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

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

@@ -1,10 +0,0 @@
-/**
- * Represent different features that a content type can have.
- */
-export declare enum ContentTypeFeature {
-    LOCALIZATION = "localization",
-    VERSIONING = "versioning",
-    PUBLISH_PERIOD = "publishPeriod",
-    ROUTING = "routing",
-    BINARY = "binary"
-}

package/dist/client/models/ContentTypeFeature.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeFeature = void 0;
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Represent different features that a content type can have.
- */
-var ContentTypeFeature;
-(function (ContentTypeFeature) {
-    ContentTypeFeature["LOCALIZATION"] = "localization";
-    ContentTypeFeature["VERSIONING"] = "versioning";
-    ContentTypeFeature["PUBLISH_PERIOD"] = "publishPeriod";
-    ContentTypeFeature["ROUTING"] = "routing";
-    ContentTypeFeature["BINARY"] = "binary";
-})(ContentTypeFeature || (exports.ContentTypeFeature = ContentTypeFeature = {}));

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

@@ -1,7 +0,0 @@
-/**
- * Represent the usage types for a ContentType.
- */
-export declare enum ContentTypeUsage {
-    PROPERTY = "property",
-    INSTANCE = "instance"
-}

package/dist/client/models/ContentTypeUsage.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeUsage = void 0;
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Represent the usage types for a ContentType.
- */
-var ContentTypeUsage;
-(function (ContentTypeUsage) {
-    ContentTypeUsage["PROPERTY"] = "property";
-    ContentTypeUsage["INSTANCE"] = "instance";
-})(ContentTypeUsage || (exports.ContentTypeUsage = ContentTypeUsage = {}));

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

@@ -1,14 +0,0 @@
-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/DateTimeListItem.js

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

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

@@ -1,14 +0,0 @@
-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/DateTimeProperty.js

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

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

@@ -1,10 +0,0 @@
-import type { DoubleEnumerationValue } from './DoubleEnumerationValue';
-/**
- * Enumeration settings for a property or format.
- */
-export type DoubleEnumerationSettings = {
-    /**
-     * Enumeration values for this property or format.
-     */
-    values?: Array<DoubleEnumerationValue>;
-};

package/dist/client/models/DoubleEnumerationSettings.js

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

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

@@ -1,13 +0,0 @@
-/**
- * Describes an enumeration value.
- */
-export type DoubleEnumerationValue = {
-    /**
-     * The display name of the value.
-     */
-    displayName?: string;
-    /**
-     * The underlying enumeration value.
-     */
-    value?: number;
-};

package/dist/client/models/DoubleEnumerationValue.js

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