@remkoj/optimizely-cms-api 5.1.5 → 6.0.0-pre10

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

@@ -1,105 +0,0 @@
-import type { Changeset } from '../models/Changeset';
-import type { ChangesetItem } from '../models/ChangesetItem';
-import type { ChangesetItemPage } from '../models/ChangesetItemPage';
-import type { ChangesetPage } from '../models/ChangesetPage';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-export declare class ChangesetsService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * List changeset
-     * Lists all changeset using the provided options.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ChangesetPage OK
-     * @throws ApiError
-     */
-    changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
-    /**
-     * Create changeset
-     * Creates a new changeset.
-     * @param requestBody The changeset that should be created.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
-    /**
-     * Get changeset
-     * Gets the changeset with the provided key.
-     * @param key The key of the changeset to retrieve.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsGet(key: string): CancelablePromise<Changeset>;
-    /**
-     * Delete changeset
-     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
-     * @param key The key of the changeset to delete.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsDelete(key: string): CancelablePromise<Changeset>;
-    /**
-     * Create or replace changeset
-     * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
-     * Otherwise a new changeset is created.
-     * @param key The key of the changeset to update or create.
-     * @param requestBody The values of the created or replaced changeset.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
-    /**
-     * Get changeset item
-     * Gets the changeset item for the specified content reference.
-     * @param changeset The changeset key
-     * @param key The content key
-     * @param version The content version
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
-    /**
-     * Delete changeset item
-     * Deletes the specified changeset item from the changeset.
-     * @param changeset The changeset key
-     * @param key The content key
-     * @param version The content version
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsDeleteItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
-    /**
-     * List changeset items
-     * Lists the available changeset items for the specified changeset using
-     * the provided options.
-     * @param changeset The changeset key
-     * @param pageIndex
-     * @param pageSize
-     * @returns ChangesetItemPage OK
-     * @throws ApiError
-     */
-    changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
-    /**
-     * Create changeset item
-     * Creates the given changeset item.
-     * @param changeset The changeset key
-     * @param requestBody The changeset item
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
-    /**
-     * Update changeset item
-     * Updates the given changeset item.
-     * @param changeset The changeset key
-     * @param contentKey The content key
-     * @param contentVersion The content version
-     * @param requestBody The changeset item
-     * @param allowCreate Indicates if a new changeset item should be created if it does not exist
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
-}

package/dist/client/services/ChangesetsService.js

@@ -1,239 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChangesetsService = void 0;
-class ChangesetsService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * List changeset
-     * Lists all changeset using the provided options.
-     * @param pageIndex
-     * @param pageSize
-     * @returns ChangesetPage OK
-     * @throws ApiError
-     */
-    changesetsList(pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/changesets',
-            query: {
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create changeset
-     * Creates a new changeset.
-     * @param requestBody The changeset that should be created.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsCreate(requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/changesets',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get changeset
-     * Gets the changeset with the provided key.
-     * @param key The key of the changeset to retrieve.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsGet(key) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/changesets/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete changeset
-     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
-     * @param key The key of the changeset to delete.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsDelete(key) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/changesets/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create or replace changeset
-     * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
-     * Otherwise a new changeset is created.
-     * @param key The key of the changeset to update or create.
-     * @param requestBody The values of the created or replaced changeset.
-     * @returns Changeset OK
-     * @throws ApiError
-     */
-    changesetsPut(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/changesets/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get changeset item
-     * Gets the changeset item for the specified content reference.
-     * @param changeset The changeset key
-     * @param key The content key
-     * @param version The content version
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsGetItem(changeset, key, version) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/changesets/{changeset}/items/{key}/versions/{version}',
-            path: {
-                'changeset': changeset,
-                'key': key,
-                'version': version,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete changeset item
-     * Deletes the specified changeset item from the changeset.
-     * @param changeset The changeset key
-     * @param key The content key
-     * @param version The content version
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsDeleteItem(changeset, key, version) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/changesets/{changeset}/items/{key}/versions/{version}',
-            path: {
-                'changeset': changeset,
-                'key': key,
-                'version': version,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * List changeset items
-     * Lists the available changeset items for the specified changeset using
-     * the provided options.
-     * @param changeset The changeset key
-     * @param pageIndex
-     * @param pageSize
-     * @returns ChangesetItemPage OK
-     * @throws ApiError
-     */
-    changesetsListItems(changeset, pageIndex, pageSize) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/changesets/{changeset}/items',
-            path: {
-                'changeset': changeset,
-            },
-            query: {
-                'pageIndex': pageIndex,
-                'pageSize': pageSize,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create changeset item
-     * Creates the given changeset item.
-     * @param changeset The changeset key
-     * @param requestBody The changeset item
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsCreateItem(changeset, requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/changesets/{changeset}/items',
-            path: {
-                'changeset': changeset,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update changeset item
-     * Updates the given changeset item.
-     * @param changeset The changeset key
-     * @param contentKey The content key
-     * @param contentVersion The content version
-     * @param requestBody The changeset item
-     * @param allowCreate Indicates if a new changeset item should be created if it does not exist
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsUpdateItem(changeset, contentKey, contentVersion, requestBody, allowCreate) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/changesets/{changeset}/items/{contentKey}/versions/{contentVersion}',
-            path: {
-                'changeset': changeset,
-                'contentKey': contentKey,
-                'contentVersion': contentVersion,
-            },
-            query: {
-                'allowCreate': allowCreate,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.ChangesetsService = ChangesetsService;

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

@@ -1,172 +0,0 @@
-import type { ContentItem } from '../models/ContentItem';
-import type { ContentItemPage } from '../models/ContentItemPage';
-import type { ContentMetadata } from '../models/ContentMetadata';
-import type { ContentMetadataPage } from '../models/ContentMetadataPage';
-import type { CopyContentOptions } from '../models/CopyContentOptions';
-import type { VersionStatus } from '../models/VersionStatus';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-export declare class ContentService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * 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: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
-    /**
-     * 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: string, allowDeleted?: boolean): CancelablePromise<ContentMetadata>;
-    /**
-     * 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: string, requestBody: ContentMetadata): CancelablePromise<ContentMetadata>;
-    /**
-     * 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: string, permanent?: boolean): CancelablePromise<ContentMetadata>;
-    /**
-     * 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: string, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
-    /**
-     * 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: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
-    /**
-     * 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: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
-    /**
-     * 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: string, requestBody?: CopyContentOptions): CancelablePromise<ContentMetadata>;
-    /**
-     * 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: string): CancelablePromise<ContentMetadata>;
-    /**
-     * 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?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
-    /**
-     * 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: string, locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
-    /**
-     * 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: string, requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
-    /**
-     * 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: string, locale?: string): CancelablePromise<ContentItem>;
-    /**
-     * 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: string, version: string, locale?: string): CancelablePromise<ContentItem>;
-    /**
-     * 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: string, version: string, requestBody: ContentItem, locale?: string, skipValidation?: boolean): CancelablePromise<ContentItem>;
-    /**
-     * 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: string, version: string): CancelablePromise<ContentItem>;
-}