@remkoj/optimizely-cms-api 5.0.2 → 6.0.0-pre1

package/dist/client/services/ContentService.js

@@ -1,409 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentService = void 0;
-class ContentService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * Create content
-     * Create a new content item.
-     * @param requestBody The content item that should be created.
-     * @param skipValidation Indicates that the content validation should be ignored.
-     * @returns ContentItem Created
-     * @throws ApiError
-     */
-    contentCreate(requestBody, skipValidation) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/content',
-            query: {
-                'skipValidation': skipValidation,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get content
-     * Get shared metadata about the content instance with the provided key.
-     * @param key The key of the content to retrieve metadata for.
-     * @param allowDeleted Indicates that metadata for a deleted content may be returned.
-     * @returns ContentMetadata OK
-     * @throws ApiError
-     */
-    contentGetMetadata(key, allowDeleted) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'allowDeleted': allowDeleted,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update content
-     * Update an existing content item. If a content item with the provided key does not exist an error is returned.
-     * @param key The key of the content item to patch.
-     * @param requestBody The values of the content item that should be updated.
-     * @returns ContentMetadata OK
-     * @throws ApiError
-     */
-    contentPatchMetadata(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PATCH',
-            url: '/content/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/merge-patch+json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete content
-     * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
-     * @param key The key of the content item to delete.
-     * @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
-     * @returns ContentMetadata OK
-     * @throws ApiError
-     */
-    contentDelete(key, permanent) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/content/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'permanent': permanent,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get content path
-     * Get the content path with the provided key.
-     * @param key The key of the content path to retrieve.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentMetadataPage OK
-     * @throws ApiError
-     */
-    contentGetPath(key, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}/path',
-            path: {
-                'key': key,
-            },
-            query: {
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * List content in container
-     * List the content items located in a specific container.
-     * @param key The key of the content to retrieve items for.
-     * @param contentTypes Indicates which content types or base types to include in the list.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentMetadataPage OK
-     * @throws ApiError
-     */
-    contentListItems(key, contentTypes, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}/items',
-            path: {
-                'key': key,
-            },
-            query: {
-                'contentTypes': contentTypes,
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * List assets
-     * List the assets that belongs to a content instance.
-     * @param key The key of the content to retrieve assets for.
-     * @param contentTypes Indicates which content types or base types to include in the list.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentMetadataPage OK
-     * @throws ApiError
-     */
-    contentListAssets(key, contentTypes, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}/assets',
-            path: {
-                'key': key,
-            },
-            query: {
-                'contentTypes': contentTypes,
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Copy content
-     * Create a copy of the content item with the provided key.
-     * @param key The key of the content item to copy.
-     * @param requestBody Optional instructions for how to copy content.
-     * @returns ContentMetadata OK
-     * @throws ApiError
-     */
-    contentCopy(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/content/{key}:copy',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Restore content
-     * Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
-     * @param key The key of the content item to undelete.
-     * @returns ContentMetadata OK
-     * @throws ApiError
-     */
-    contentUndelete(key) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/content/{key}:undelete',
-            path: {
-                'key': key,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Query versions
-     * List content versions based on the provided query options.
-     * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
-     * Locale must be a valid IETF BCP-47 language tag.
-     * @param statuses Indicates which status content versions must have to be listed.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentItemPage OK
-     * @throws ApiError
-     */
-    contentListAllVersions(locales, statuses, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/versions',
-            query: {
-                'locales': locales,
-                'statuses': statuses,
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * List versions
-     * List versions of the content item with the provided key and the provided options.
-     * @param key
-     * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
-     * Locale must be a valid IETF BCP-47 language tag.
-     * @param statuses Indicates which status content versions must have to be listed.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentItemPage OK
-     * @throws ApiError
-     */
-    contentListVersions(key, locales, statuses, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}/versions',
-            path: {
-                'key': key,
-            },
-            query: {
-                'locales': locales,
-                'statuses': statuses,
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create version
-     * Create a new version of a content item.
-     * @param key The key of the content item for which a new content version should be created.
-     * @param requestBody The content version that should be created.
-     * @param skipValidation Indicates that the content validation should be ignored.
-     * @returns ContentItem Created
-     * @throws ApiError
-     */
-    contentCreateVersion(key, requestBody, skipValidation) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/content/{key}/versions',
-            path: {
-                'key': key,
-            },
-            query: {
-                'skipValidation': skipValidation,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete locale
-     * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
-     * @param key
-     * @param locale
-     * @returns ContentItem OK
-     * @throws ApiError
-     */
-    contentDeleteLocale(key, locale) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/content/{key}/versions',
-            path: {
-                'key': key,
-            },
-            query: {
-                'locale': locale,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get version
-     * Get the content item with the provided key and version.
-     * @param key
-     * @param version
-     * @param locale
-     * @returns ContentItem OK
-     * @throws ApiError
-     */
-    contentGetVersion(key, version, locale) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/content/{key}/versions/{version}',
-            path: {
-                'key': key,
-                'version': version,
-            },
-            query: {
-                'locale': locale,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update version
-     * Update an existing content item. If a content item with the provided key does not exist an error is returned.
-     * @param key The key of the content item that should be updated.
-     * @param version The version of the content that should be updated.
-     * @param requestBody The content information that should be updated.
-     * @param locale The locale of the content that should be updated.
-     * @param skipValidation Indicates that the content validation should be ignored.
-     * @returns ContentItem OK
-     * @throws ApiError
-     */
-    contentPatchVersion(key, version, requestBody, locale, skipValidation) {
-        return this.httpRequest.request({
-            method: 'PATCH',
-            url: '/content/{key}/versions/{version}',
-            path: {
-                'key': key,
-                'version': version,
-            },
-            query: {
-                'locale': locale,
-                'skipValidation': skipValidation,
-            },
-            body: requestBody,
-            mediaType: 'application/merge-patch+json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete version
-     * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
-     * @param key
-     * @param version
-     * @returns ContentItem OK
-     * @throws ApiError
-     */
-    contentDeleteVersion(key, version) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/content/{key}/versions/{version}',
-            path: {
-                'key': key,
-                'version': version,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.ContentService = ContentService;

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

@@ -1,66 +0,0 @@
-import type { ContentType } from '../models/ContentType';
-import type { ContentTypePage } from '../models/ContentTypePage';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-export declare class ContentTypesService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * List content types
-     * List content types using the provided options.
-     * @param forContainerType Only include types that are available for creation under the provided container type
-     * @param sources Indicates which sources should be included when listing content types.
-     * Use All to include content types from all sources or
-     * Default to include content types without a specific sources.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentTypePage OK
-     * @throws ApiError
-     */
-    contentTypesList(forContainerType?: string, sources?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentTypePage>;
-    /**
-     * Create content type
-     * Create a new content type.
-     * @param requestBody The content type that should be created.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesCreate(requestBody: ContentType): CancelablePromise<ContentType>;
-    /**
-     * Get content type
-     * Get the content type with the provided key.
-     * @param key The key of the content type to retrieve.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesGet(key: string): CancelablePromise<ContentType>;
-    /**
-     * Create or replace content type
-     * Create or replace a content type. If a content type with the provided key exist it is replaced.
-     * Otherwise a new content type is created.
-     * @param key The key of the content type to update or create.
-     * @param requestBody The values of the created or replaced content type.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPut(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
-    /**
-     * Update content type
-     * Update an existing content type. If a content type with the provided key does not exist an error is returned.
-     * @param key The key of the content type to patch.
-     * @param requestBody The values of the content type that should be updated.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPatch(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
-    /**
-     * Delete content type
-     * Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
-     * @param key The key of the content type to delete.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesDelete(key: string): CancelablePromise<ContentType>;
-}

package/dist/client/services/ContentTypesService.js

@@ -1,149 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypesService = void 0;
-class ContentTypesService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * List content types
-     * List content types using the provided options.
-     * @param forContainerType Only include types that are available for creation under the provided container type
-     * @param sources Indicates which sources should be included when listing content types.
-     * Use All to include content types from all sources or
-     * Default to include content types without a specific sources.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ContentTypePage OK
-     * @throws ApiError
-     */
-    contentTypesList(forContainerType, sources, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/contenttypes',
-            query: {
-                'forContainerType': forContainerType,
-                'sources': sources,
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create content type
-     * Create a new content type.
-     * @param requestBody The content type that should be created.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesCreate(requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/contenttypes',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get content type
-     * Get the content type with the provided key.
-     * @param key The key of the content type to retrieve.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesGet(key) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/contenttypes/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create or replace content type
-     * Create or replace a content type. If a content type with the provided key exist it is replaced.
-     * Otherwise a new content type is created.
-     * @param key The key of the content type to update or create.
-     * @param requestBody The values of the created or replaced content type.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPut(key, requestBody, ignoreDataLossWarnings) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/contenttypes/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'ignoreDataLossWarnings': ignoreDataLossWarnings,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update content type
-     * Update an existing content type. If a content type with the provided key does not exist an error is returned.
-     * @param key The key of the content type to patch.
-     * @param requestBody The values of the content type that should be updated.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPatch(key, requestBody, ignoreDataLossWarnings) {
-        return this.httpRequest.request({
-            method: 'PATCH',
-            url: '/contenttypes/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'ignoreDataLossWarnings': ignoreDataLossWarnings,
-            },
-            body: requestBody,
-            mediaType: 'application/merge-patch+json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete content type
-     * Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
-     * @param key The key of the content type to delete.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesDelete(key) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/contenttypes/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.ContentTypesService = ContentTypesService;

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

@@ -1,60 +0,0 @@
-import type { DisplayTemplate } from '../models/DisplayTemplate';
-import type { DisplayTemplatePage } from '../models/DisplayTemplatePage';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-export declare class DisplayTemplatesService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * List display templates
-     * List display templates using the provided options.
-     * @param pageIndex
-     * @param pageSize
-     * @returns DisplayTemplatePage OK
-     * @throws ApiError
-     */
-    displayTemplatesList(pageIndex?: number, pageSize?: number): CancelablePromise<DisplayTemplatePage>;
-    /**
-     * Create display template
-     * Create a new display template.
-     * @param requestBody The display template that should be created.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesCreate(requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
-    /**
-     * Get display template
-     * Get the display template with the provided key.
-     * @param key The key of the display template to retrieve.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesGet(key: string): CancelablePromise<DisplayTemplate>;
-    /**
-     * Create or replace a display template
-     * Create or replace a display template. If a display template with the provided key exist it is replaced.
-     * Otherwise a new display template is created.
-     * @param key The key of the display template to update or create.
-     * @param requestBody The values of the created or replaced display template.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesPut(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
-    /**
-     * Update display template
-     * Update an existing display template.
-     * @param key The key of the display template to patch.
-     * @param requestBody The values of the display template that should be updated.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesPatch(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
-    /**
-     * Delete display template
-     * Deletes the display template with the provided key.
-     * @param key The key of the display template to delete.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesDelete(key: string): CancelablePromise<DisplayTemplate>;
-}