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

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

@@ -1,172 +1,172 @@
-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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @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 Success
-     * @throws ApiError
-     */
-    contentDeleteVersion(key: string, version: string): CancelablePromise<ContentItem>;
-}
+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>;
+}