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

package/dist/client/services/PackagesService.js

@@ -1,80 +1,80 @@
-"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 Success
-     * @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 Success
-     * @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 Success
-     * @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;
+"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 Success
+     * @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 Success
+     * @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 Success
+     * @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;

package/dist/client/services/PropertyFormatsService.js

@@ -1,53 +1,53 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyFormatsService = void 0;
-class PropertyFormatsService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * List property formats
-     * List all property formats using the provided options.
-     * @param pageIndex
-     * @param pageSize
-     * @returns PropertyFormatPage Success
-     * @throws ApiError
-     */
-    propertyFormatsList(pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertyformats',
-            query: {
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get property format
-     * Get the property format with the provided key.
-     * @param key The key of the property format to retrieve.
-     * @param allowDeleted Indicates that a deleted property format may be returned.
-     * @returns PropertyFormat Success
-     * @throws ApiError
-     */
-    propertyFormatsGet(key, allowDeleted) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertyformats/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'allowDeleted': allowDeleted,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.PropertyFormatsService = PropertyFormatsService;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyFormatsService = void 0;
+class PropertyFormatsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * List property formats
+     * List all property formats using the provided options.
+     * @param pageIndex
+     * @param pageSize
+     * @returns PropertyFormatPage Success
+     * @throws ApiError
+     */
+    propertyFormatsList(pageIndex, pageSize) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertyformats',
+            query: {
+                'pageIndex': pageIndex,
+                'pageSize': pageSize,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Get property format
+     * Get the property format with the provided key.
+     * @param key The key of the property format to retrieve.
+     * @param allowDeleted Indicates that a deleted property format may be returned.
+     * @returns PropertyFormat Success
+     * @throws ApiError
+     */
+    propertyFormatsGet(key, allowDeleted) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertyformats/{key}',
+            path: {
+                'key': key,
+            },
+            query: {
+                'allowDeleted': allowDeleted,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.PropertyFormatsService = PropertyFormatsService;

package/dist/client/services/PropertyGroupsService.js

@@ -1,135 +1,135 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyGroupsService = void 0;
-class PropertyGroupsService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * 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.
-     * @returns PropertyGroupPage Success
-     * @throws ApiError
-     */
-    propertyGroupsList(sources) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertygroups',
-            query: {
-                'sources': sources,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create property group
-     * Create a new property group.
-     * @param requestBody The property group that should be created.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsCreate(requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/propertygroups',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get property group
-     * Get the property group with the provided key.
-     * @param key The key of the property group to retrieve.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsGet(key) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * 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 Success
-     * @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`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update property group
-     * Update 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.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsPatch(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PATCH',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/merge-patch+json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete property group
-     * Deletes the property group with the provided key.
-     * @param key The key of the property group to delete.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsDelete(key) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.PropertyGroupsService = PropertyGroupsService;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyGroupsService = void 0;
+class PropertyGroupsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * 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.
+     * @returns PropertyGroupPage Success
+     * @throws ApiError
+     */
+    propertyGroupsList(sources) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertygroups',
+            query: {
+                'sources': sources,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Create property group
+     * Create a new property group.
+     * @param requestBody The property group that should be created.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsCreate(requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/propertygroups',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Get property group
+     * Get the property group with the provided key.
+     * @param key The key of the property group to retrieve.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsGet(key) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * 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 Success
+     * @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`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Update property group
+     * Update 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.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsPatch(key, requestBody) {
+        return this.httpRequest.request({
+            method: 'PATCH',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            body: requestBody,
+            mediaType: 'application/merge-patch+json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Delete property group
+     * Deletes the property group with the provided key.
+     * @param key The key of the property group to delete.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsDelete(key) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.PropertyGroupsService = PropertyGroupsService;

package/dist/config.d.ts

@@ -3,5 +3,6 @@ export type CmsIntegrationApiOptions = {
     clientId?: string;
     clientSecret?: string;
     actAs?: string;
+    debug?: boolean;
 };
 export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;

package/dist/config.js

@@ -1,39 +1,40 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCmsIntegrationApiConfigFromEnvironment = void 0;
-const OpenAPI_1 = require("./client/core/OpenAPI");
-function getCmsIntegrationApiConfigFromEnvironment() {
-    const cmsUrl = getMandatory('OPTIMIZELY_CMS_URL');
-    const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
-    const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
-    const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');
-    const debug = getOptional('OPTIMIZELY_DEBUG', "0") == "1";
-    let baseUrl;
-    try {
-        baseUrl = new URL(OpenAPI_1.OpenAPI.BASE, cmsUrl);
-    }
-    catch {
-        throw new Error("Invalid URL provided");
-    }
-    if (debug)
-        console.log(`[Optimizely CMS API] Connecting to ${baseUrl} as ${clientId}`);
-    return {
-        base: baseUrl,
-        clientId,
-        clientSecret,
-        actAs
-    };
-}
-exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
-function getOptional(variable, defaultValue) {
-    const envValue = process.env[variable];
-    if (!envValue || envValue == "")
-        return defaultValue;
-    return envValue;
-}
-function getMandatory(variable) {
-    const envValue = process.env[variable];
-    if (!envValue)
-        throw new Error(`The environment variable ${variable} is missing or empty`);
-    return envValue;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCmsIntegrationApiConfigFromEnvironment = void 0;
+const OpenAPI_1 = require("./client/core/OpenAPI");
+function getCmsIntegrationApiConfigFromEnvironment() {
+    const cmsUrl = getMandatory('OPTIMIZELY_CMS_URL');
+    const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
+    const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
+    const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');
+    const debug = getOptional('OPTIMIZELY_DEBUG', "0") == "1";
+    let baseUrl;
+    try {
+        baseUrl = new URL(OpenAPI_1.OpenAPI.BASE, cmsUrl);
+    }
+    catch {
+        throw new Error("Invalid URL provided");
+    }
+    if (debug)
+        console.log(`[Optimizely CMS API] Connecting to ${baseUrl} as ${clientId}`);
+    return {
+        base: baseUrl,
+        clientId,
+        clientSecret,
+        actAs,
+        debug
+    };
+}
+exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
+function getOptional(variable, defaultValue) {
+    const envValue = process.env[variable];
+    if (!envValue || envValue == "")
+        return defaultValue;
+    return envValue;
+}
+function getMandatory(variable) {
+    const envValue = process.env[variable];
+    if (!envValue)
+        throw new Error(`The environment variable ${variable} is missing or empty`);
+    return envValue;
+}