@remkoj/optimizely-cms-api 4.3.0 → 5.0.0

package/dist/client/CmsIntegrationApiClient.d.ts

@@ -5,7 +5,6 @@ import { ContentService } from './services/ContentService';
 import { ContentTypesService } from './services/ContentTypesService';
 import { DisplayTemplatesService } from './services/DisplayTemplatesService';
 import { OauthService } from './services/OauthService';
-import { PackagesService } from './services/PackagesService';
 import { PropertyFormatsService } from './services/PropertyFormatsService';
 import { PropertyGroupsService } from './services/PropertyGroupsService';
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
@@ -15,7 +14,6 @@ export declare class CmsIntegrationApiClient {
     readonly contentTypes: ContentTypesService;
     readonly displayTemplates: DisplayTemplatesService;
     readonly oauth: OauthService;
-    readonly packages: PackagesService;
     readonly propertyFormats: PropertyFormatsService;
     readonly propertyGroups: PropertyGroupsService;
     readonly request: BaseHttpRequest;

package/dist/client/CmsIntegrationApiClient.js

@@ -7,7 +7,6 @@ const ContentService_1 = require("./services/ContentService");
 const ContentTypesService_1 = require("./services/ContentTypesService");
 const DisplayTemplatesService_1 = require("./services/DisplayTemplatesService");
 const OauthService_1 = require("./services/OauthService");
-const PackagesService_1 = require("./services/PackagesService");
 const PropertyFormatsService_1 = require("./services/PropertyFormatsService");
 const PropertyGroupsService_1 = require("./services/PropertyGroupsService");
 class CmsIntegrationApiClient {
@@ -28,7 +27,6 @@ class CmsIntegrationApiClient {
         this.contentTypes = new ContentTypesService_1.ContentTypesService(this.request);
         this.displayTemplates = new DisplayTemplatesService_1.DisplayTemplatesService(this.request);
         this.oauth = new OauthService_1.OauthService(this.request);
-        this.packages = new PackagesService_1.PackagesService(this.request);
         this.propertyFormats = new PropertyFormatsService_1.PropertyFormatsService(this.request);
         this.propertyGroups = new PropertyGroupsService_1.PropertyGroupsService(this.request);
     }

package/dist/client/index.d.ts

@@ -44,8 +44,6 @@ export type { DoubleEnumerationValue } from './models/DoubleEnumerationValue';
 export type { FloatListItem } from './models/FloatListItem';
 export type { FloatProperty } from './models/FloatProperty';
 export type { ImageDescriptor } from './models/ImageDescriptor';
-export type { ImportPackageMessage } from './models/ImportPackageMessage';
-export type { ImportPackageResult } from './models/ImportPackageResult';
 export { IndexingType } from './models/IndexingType';
 export type { Int32EnumerationSettings } from './models/Int32EnumerationSettings';
 export type { Int32EnumerationValue } from './models/Int32EnumerationValue';
@@ -55,13 +53,9 @@ export type { JsonStringProperty } from './models/JsonStringProperty';
 export type { ListProperty } from './models/ListProperty';
 export type { ListPropertyItem } from './models/ListPropertyItem';
 export { LocaleStatus } from './models/LocaleStatus';
-export type { Manifest } from './models/Manifest';
 export type { OauthToken } from './models/OauthToken';
 export type { OauthTokenError } from './models/OauthTokenError';
 export type { OauthTokenRequest } from './models/OauthTokenRequest';
-export type { PackageJob } from './models/PackageJob';
-export type { PackageJobMessage } from './models/PackageJobMessage';
-export type { PackageJobStatus } from './models/PackageJobStatus';
 export type { ProblemDetails } from './models/ProblemDetails';
 export { PropertyDataType } from './models/PropertyDataType';
 export type { PropertyFormat } from './models/PropertyFormat';
@@ -80,6 +74,5 @@ export { ContentService } from './services/ContentService';
 export { ContentTypesService } from './services/ContentTypesService';
 export { DisplayTemplatesService } from './services/DisplayTemplatesService';
 export { OauthService } from './services/OauthService';
-export { PackagesService } from './services/PackagesService';
 export { PropertyFormatsService } from './services/PropertyFormatsService';
 export { PropertyGroupsService } from './services/PropertyGroupsService';

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.CompositionBehavior = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.BaseHttpRequest = exports.ApiError = exports.CmsIntegrationApiClient = void 0;
+exports.PropertyGroupsService = exports.PropertyFormatsService = 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 */
@@ -42,8 +42,6 @@ var DisplayTemplatesService_1 = require("./services/DisplayTemplatesService");
 Object.defineProperty(exports, "DisplayTemplatesService", { enumerable: true, get: function () { return DisplayTemplatesService_1.DisplayTemplatesService; } });
 var OauthService_1 = require("./services/OauthService");
 Object.defineProperty(exports, "OauthService", { enumerable: true, get: function () { return OauthService_1.OauthService; } });
-var PackagesService_1 = require("./services/PackagesService");
-Object.defineProperty(exports, "PackagesService", { enumerable: true, get: function () { return PackagesService_1.PackagesService; } });
 var PropertyFormatsService_1 = require("./services/PropertyFormatsService");
 Object.defineProperty(exports, "PropertyFormatsService", { enumerable: true, get: function () { return PropertyFormatsService_1.PropertyFormatsService; } });
 var PropertyGroupsService_1 = require("./services/PropertyGroupsService");

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

@@ -21,7 +21,7 @@ export type ContentType = {
     /**
      * The key that identifies this ContentType.
      */
-    readonly key: string;
+    key: string;
     /**
      * The display name of this ContentType.
      */

package/dist/version.json

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

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.3.0",
+  "version": "5.0.0",
   "type": "commonjs",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -11,12 +11,12 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^22.13.5",
-    "dotenv": "^16.4.7",
+    "@types/node": "^22.14.1",
+    "dotenv": "^16.5.0",
     "glob": "^11.0.1",
     "openapi-typescript-codegen": "^0.29.0",
     "tslib": "^2.8.1",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.3"
   },
   "scripts": {
     "clean": "tsc --build --clean",

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

@@ -1,17 +0,0 @@
-/**
- * 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

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

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

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

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

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

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

package/dist/client/models/Manifest.js

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

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

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

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

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

@@ -1,17 +0,0 @@
-/**
- * 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

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

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

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

package/dist/client/models/PackageJobStatus.js

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

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

@@ -1,41 +0,0 @@
-import type { ImportPackageResult } from '../models/ImportPackageResult';
-import type { Manifest } from '../models/Manifest';
-import type { PackageJob } from '../models/PackageJob';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-export declare class PackagesService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * Get job status
-     * Get a package job status.
-     * @param key The key of the package job.
-     * @returns PackageJob OK
-     * @throws ApiError
-     */
-    packagesGet(key: string): CancelablePromise<PackageJob>;
-    /**
-     * Export package
-     * Export a data package.
-     * @param includeReadOnly Indicates if read-only resources should be included in the export data.
-     * @returns Manifest OK
-     * @throws ApiError
-     */
-    packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
-    /**
-     * Import package
-     * Import a data package.
-     * @param container The key of the container content where new content items should be created under.
-     * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
-     * content item with the same key.
-     * If set to `false`, always create new content item under the specified container regardless of the content key.
-     * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
-     * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
-     * then content in all locales are imported.
-     * @param requestBody
-     * @returns ImportPackageResult OK
-     * @returns PackageJob Accepted
-     * @throws ApiError
-     */
-    packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
-}

package/dist/client/services/PackagesService.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackagesService = void 0;
-class PackagesService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * Get job status
-     * Get a package job status.
-     * @param key The key of the package job.
-     * @returns PackageJob OK
-     * @throws ApiError
-     */
-    packagesGet(key) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/packages/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Export package
-     * Export a data package.
-     * @param includeReadOnly Indicates if read-only resources should be included in the export data.
-     * @returns Manifest OK
-     * @throws ApiError
-     */
-    packagesExport(includeReadOnly) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/packages',
-            query: {
-                'includeReadOnly': includeReadOnly,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Import package
-     * Import a data package.
-     * @param container The key of the container content where new content items should be created under.
-     * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
-     * content item with the same key.
-     * If set to `false`, always create new content item under the specified container regardless of the content key.
-     * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
-     * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
-     * then content in all locales are imported.
-     * @param requestBody
-     * @returns ImportPackageResult OK
-     * @returns PackageJob Accepted
-     * @throws ApiError
-     */
-    packagesImport(container, overwriteExistingContentItems = false, ignoreDataLossWarnings = false, locale, requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/packages',
-            query: {
-                'container': container,
-                'overwriteExistingContentItems': overwriteExistingContentItems,
-                'ignoreDataLossWarnings': ignoreDataLossWarnings,
-                'locale': locale,
-            },
-            body: requestBody,
-            mediaType: 'application/vnd.episerver.cms.data',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.PackagesService = PackagesService;