@revenexx/sdk 0.0.2 → 0.0.4

package/types/services/pages.d.ts

@@ -0,0 +1,703 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Pages {
+    client: Client;
+    constructor(client: Client);
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DeliveryPage>}
+     */
+    pagesDeliveryPage(): Promise<Models.DeliveryPage>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesDeliveryPages(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.token -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DeliveryPage>}
+     */
+    pagesDeliveryPreview(params: {
+        token: string;
+    }): Promise<Models.DeliveryPage>;
+    /**
+     *
+     * @param {string} token -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DeliveryPage>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesDeliveryPreview(token: string): Promise<Models.DeliveryPage>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorEditStates(): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorNotificationsList(): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorNotificationsMarkAllRead(): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorNotificationsUnreadCount(): Promise<{}>;
+    /**
+     *
+     * @param {object[]} params.items -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorTranslate(params?: {
+        items?: object[];
+    }): Promise<{}>;
+    /**
+     *
+     * @param {object[]} items -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorTranslate(items?: object[]): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorUserSettingsGet(): Promise<{}>;
+    /**
+     *
+     * @param {object} params.settings -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorUserSettingsPut(params?: {
+        settings?: object;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {object} settings -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorUserSettingsPut(settings?: object): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorUsers(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsList(params: {
+        pageId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsList(pageId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.body -
+     * @param {string[]} params.blockUuids -
+     * @param {string} params.parentUuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsCreate(params: {
+        pageId: string;
+        body: string;
+        blockUuids?: string[];
+        parentUuid?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} body -
+     * @param {string[]} blockUuids -
+     * @param {string} parentUuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsCreate(pageId: string, body: string, blockUuids?: string[], parentUuid?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsDelete(params: {
+        pageId: string;
+        uuid: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsDelete(pageId: string, uuid: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.uuid -
+     * @param {string} params.body -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsUpdate(params: {
+        pageId: string;
+        uuid: string;
+        body: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} uuid -
+     * @param {string} body -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsUpdate(pageId: string, uuid: string, body: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsResolve(params: {
+        pageId: string;
+        uuid: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsResolve(pageId: string, uuid: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.uuid -
+     * @param {number} params.taskIndex -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Comment>}
+     */
+    pagesEditorCommentsToggleTask(params: {
+        pageId: string;
+        uuid: string;
+        taskIndex: number;
+    }): Promise<Models.Comment>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} uuid -
+     * @param {number} taskIndex -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Comment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsToggleTask(pageId: string, uuid: string, taskIndex: number): Promise<Models.Comment>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorCommentsUnresolve(params: {
+        pageId: string;
+        uuid: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} uuid -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorCommentsUnresolve(pageId: string, uuid: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {number} params.index -
+     * @param {string} params.langcode -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorHistory(params: {
+        pageId: string;
+        index: number;
+        langcode?: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {number} index -
+     * @param {string} langcode -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorHistory(pageId: string, index: number, langcode?: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorLastChanged(params: {
+        pageId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorLastChanged(pageId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {boolean} params.enabled -
+     * @param {number} params.index -
+     * @param {string} params.langcode -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorMutationStatus(params: {
+        pageId: string;
+        enabled: boolean;
+        index: number;
+        langcode?: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {boolean} enabled -
+     * @param {number} index -
+     * @param {string} langcode -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorMutationStatus(pageId: string, enabled: boolean, index: number, langcode?: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorMutate(params: {
+        pageId: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorMutate(pageId: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {number} params.ttlHours -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorPreviewGrant(params: {
+        pageId: string;
+        ttlHours?: number;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {number} ttlHours -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorPreviewGrant(pageId: string, ttlHours?: number): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {boolean} params.force - Publish despite violations.
+     * @param {string} params.label -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorPublish(params: {
+        pageId: string;
+        force?: boolean;
+        label?: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {boolean} force - Publish despite violations.
+     * @param {string} label -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorPublish(pageId: string, force?: boolean, label?: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorRevert(params: {
+        pageId: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorRevert(pageId: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.scheduledAt -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorSchedule(params: {
+        pageId: string;
+        scheduledAt: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} scheduledAt -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorSchedule(pageId: string, scheduledAt: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.EditorState>}
+     */
+    pagesEditorState(params: {
+        pageId: string;
+    }): Promise<Models.EditorState>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.EditorState>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorState(pageId: string): Promise<Models.EditorState>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     */
+    pagesEditorTakeOwnership(params: {
+        pageId: string;
+    }): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.MutationResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorTakeOwnership(pageId: string): Promise<Models.MutationResponse>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @param {string} params.label -
+     * @param {string[]} params.uuids -
+     * @param {string} params.description -
+     * @param {string} params.fieldName -
+     * @param {boolean} params.isDefault -
+     * @param {string} params.pageBundle -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     */
+    pagesEditorTemplatesCreate(params: {
+        pageId: string;
+        label: string;
+        uuids: string[];
+        description?: string;
+        fieldName?: string;
+        isDefault?: boolean;
+        pageBundle?: string;
+    }): Promise<Models.Template>;
+    /**
+     *
+     * @param {string} pageId -
+     * @param {string} label -
+     * @param {string[]} uuids -
+     * @param {string} description -
+     * @param {string} fieldName -
+     * @param {boolean} isDefault -
+     * @param {string} pageBundle -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorTemplatesCreate(pageId: string, label: string, uuids: string[], description?: string, fieldName?: string, isDefault?: boolean, pageBundle?: string): Promise<Models.Template>;
+    /**
+     *
+     * @param {string} params.pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesEditorUnschedule(params: {
+        pageId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} pageId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesEditorUnschedule(pageId: string): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesLibraryList(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesLibraryDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesLibraryDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.LibraryItem>}
+     */
+    pagesLibraryGet(params: {
+        id: string;
+    }): Promise<Models.LibraryItem>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.LibraryItem>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesLibraryGet(id: string): Promise<Models.LibraryItem>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.LibraryItem>}
+     */
+    pagesLibraryUpdate(params: {
+        id: string;
+    }): Promise<Models.LibraryItem>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.LibraryItem>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesLibraryUpdate(id: string): Promise<Models.LibraryItem>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesPagesList(): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     */
+    pagesPagesCreate(): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesPagesDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesPagesDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     */
+    pagesPagesGet(params: {
+        id: string;
+    }): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesPagesGet(id: string): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     */
+    pagesPagesUpdate(params: {
+        id: string;
+    }): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Page>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesPagesUpdate(id: string): Promise<Models.Page>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesPagesRevisions(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesPagesRevisions(id: string): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesSeed(): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesTemplatesList(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesTemplatesDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesTemplatesDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     */
+    pagesTemplatesGet(params: {
+        id: string;
+    }): Promise<Models.Template>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesTemplatesGet(id: string): Promise<Models.Template>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     */
+    pagesTemplatesUpdate(params: {
+        id: string;
+    }): Promise<Models.Template>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Template>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesTemplatesUpdate(id: string): Promise<Models.Template>;
+}