@libretexts/cxone-expert-node 1.0.0 → 1.1.0

package/dist/types/pages.d.ts

@@ -0,0 +1,735 @@
+import { BaseQueryParams, PaginationQueryParams, RequestModeQueryParam } from "./requests";
+import { ExpertUser, PageSecurity } from "./security";
+export declare type GetPagesParams = {
+    startpage?: boolean;
+    format?: "html" | "xml" | "google";
+    authenticate?: boolean;
+};
+export declare type GetPagesResponse = {
+    "@id"?: string;
+    "@guid"?: string;
+    "@draft.state"?: string;
+    "@href"?: string;
+    "@deleted"?: string;
+    "date.created"?: string;
+    language?: string;
+    namespace?: string;
+    path?: Partial<PagePath> | "";
+    subpages?: Partial<Subpages> | "";
+    title?: string;
+    "uri.ui"?: string;
+};
+export declare type GetPageParams = {
+    format?: "html" | "xhtml";
+    revision?: string;
+    include?: "contents" | "prevnext";
+    includeDeleted?: boolean;
+    mode?: RequestModeQueryParam;
+    exclude?: string;
+} & BaseQueryParams;
+export declare type GetPageResponse = Partial<PageBase> & Partial<PageExtended>;
+export declare type GetPageContentsParams = {
+    overview?: boolean;
+    include?: boolean;
+    reltopath?: string;
+    relto?: number;
+    pageid?: number;
+    includes?: "overview" | "tags" | "overview,tags";
+    format?: "html" | "xhtml" | "text" | "dekicode";
+    highlight?: string;
+    revision?: string;
+    mode: RequestModeQueryParam;
+    section?: string;
+} & BaseQueryParams;
+export declare type GetPageContentsResponse = {
+    "@revision"?: string;
+    "@type"?: string;
+    "@title"?: string;
+    body?: string[] | "";
+    head?: string;
+    tail?: string;
+};
+export declare type GetPageContentsExplainParams = {
+    overview?: boolean;
+    include?: string;
+    reltopath?: string;
+    relto?: number;
+    pageid?: number;
+    includes?: "overview" | "tags" | "overview,tags";
+    format?: "html" | "xhtml" | "text" | "dekicode";
+    highlight?: string;
+    revision?: string;
+    mode: RequestModeQueryParam;
+    section?: string;
+} & BaseQueryParams;
+export declare type GetPageContentsExplainResponse = {
+    "@elapsed"?: string;
+    "@id"?: string;
+    "@Path"?: string;
+    "@version"?: string;
+    calls?: {
+        "@elapsed"?: string;
+        "@count-total"?: string;
+        "@count-unique"?: string;
+        expr?: exprCall | exprCall[] | "";
+        import?: importCall | importCall[] | "";
+        page?: pageCall | pageCall[] | "";
+        property?: propertyCall | propertyCall[] | "";
+        template?: templateCall | templateCall[] | "";
+    };
+    "data-stats"?: {
+        entry?: Entry | Entry[] | "";
+    };
+    "db-summary"?: {
+        "@elapsed"?: string;
+        "@count"?: string;
+        query?: Query | Query[] | "";
+    };
+    "hs-summary"?: {
+        "@elapsed"?: string;
+        "@count"?: string;
+        query?: Query | Query[] | "";
+    };
+    "redis-summary"?: {
+        "@elapsed"?: string;
+        "@count"?: string;
+        query?: Query | Query[] | "";
+    };
+};
+export declare type GetPageDiffParams = {
+    diff?: "combined" | "all";
+    previous?: string;
+    format?: "html" | "xhtml";
+    mode?: RequestModeQueryParam;
+    revision?: string;
+} & BaseQueryParams;
+export declare type GetPageDiffResponse = {
+    "@type"?: string;
+    "#text"?: string;
+};
+export declare type GetPageExplainParams = GetPageParams;
+export declare type GetPageExplainResponse = GetPageResponse;
+export declare type GetPageExportTokenParams = {
+    recursive?: boolean;
+    token?: string;
+    pageid?: number;
+    reltopath?: string;
+    relto?: number;
+    dryrun?: boolean;
+};
+export declare type GetPageExportTokenFilenameParams = GetPageExportTokenParams;
+export declare type GetPageFilesSubPagesParams = BaseQueryParams;
+export declare type GetPageFilesSubPagesResponse = {
+    "@id"?: string;
+    "@guid"?: string;
+    "@draft.state"?: string;
+    "@href"?: string;
+    "@deleted"?: string;
+    "date.created"?: string;
+    files?: {
+        "@count?": string;
+        "@href?": string;
+        file?: Partial<PageFile> | Partial<PageFile>[] | "";
+    } | "";
+    language?: string;
+    namespace?: string;
+    path?: Partial<PagePath> | "";
+    subpages?: Partial<page_subpage> | "";
+    title?: string;
+    "uri.ui"?: string;
+};
+export declare type GetPageFilesParams = BaseQueryParams & PaginationQueryParams;
+export declare type GetPageFilesResponse = {
+    "@count": string;
+    "@offset": string;
+    "@totalcount": string;
+    "@href": string;
+    file?: Partial<PageFile> | Partial<PageFile>[] | "";
+};
+export declare type GetPageFileParams = {
+    includeDeleted?: boolean;
+    revision?: string;
+    size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
+    format?: "jpg" | "png" | "bmp" | "gif";
+    ratio?: "fixed" | "var";
+    width?: number;
+    height?: number;
+} & BaseQueryParams;
+export declare type GetPageFileDescriptionParams = {
+    revision?: string;
+} & BaseQueryParams;
+export declare type GetPageFileInfoParams = {
+    includeDeleted?: boolean;
+    revision?: string;
+} & BaseQueryParams;
+export declare type GetPageFileInfoResponse = Partial<PageFile>;
+export declare type GetPageFileRevisionsParams = {
+    changefilter?: "CONTENT" | "NAME" | "LANGUAGE" | "META" | "DELETEFLAG" | "PARENT";
+} & BaseQueryParams;
+export declare type GetPageFileRevisionsResponse = {
+    "@count"?: string;
+    "@totalcount"?: string;
+    "@href"?: string;
+    file?: Partial<PageFile> | Partial<PageFile>[] | "";
+};
+export declare type GetPageFindParams = {
+    tags?: string;
+    missingclarifications?: string;
+    since?: string;
+    upto?: string;
+    include?: string;
+};
+export declare type GetPageFindResponse = {
+    "@count"?: string;
+    "@totalcount"?: string;
+    page?: "" | (Partial<PageBase> & Partial<Tags>) | (Partial<PageBase> & Partial<Tags>)[];
+};
+export declare type GetPageInfoParams = {
+    exclude?: string;
+} & BaseQueryParams;
+export declare type GetPageInfoResponse = Partial<PageBase>;
+export declare type GetPageLinksParams = {
+    dir: "from" | "to";
+} & BaseQueryParams;
+export declare type GetPageLinksResponse = {
+    "@count"?: string;
+    page?: Partial<PageBase> | Partial<PageBase>[] | "";
+};
+export declare type GetPagePdfParams = {
+    showtoc?: boolean;
+    format?: "pdf" | "html";
+    authenticate?: boolean;
+    stylesheet?: string;
+};
+export declare type GetPagePdfFilenameParams = GetPagePdfParams;
+export declare type GetPagePropertiesParams = {
+    depth?: number;
+    name?: string;
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetPagePropertiesResponse = {
+    "@count"?: string;
+    "@href"?: string;
+    property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
+};
+export declare type GetPagePropertiesKeyParams = BaseQueryParams;
+export declare type GetPagePropertiesKeyInfoParams = {
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetPagePropertiesKeyInfoResponse = Partial<PageProperty> | Partial<PageProperty>[] | "";
+export declare type GetPageRatingsParams = BaseQueryParams;
+export declare type GetPageRatingsResponse = PageRating;
+export declare type GetPageRevisionsParams = {
+    revision?: string;
+    deleted?: boolean;
+} & BaseQueryParams & PaginationQueryParams;
+export declare type GetPageRevisionsResponse = {
+    page?: (Partial<PageBase> & Partial<PageExtended>) | (Partial<PageBase> & Partial<PageExtended>)[] | "";
+};
+export declare type GetPageSecurityParams = BaseQueryParams & {
+    export?: boolean;
+};
+export declare type GetPageSecurityResponse = Partial<PageSecurity>;
+export declare type GetPageSubPagesParams = BaseQueryParams & PaginationQueryParams;
+export declare type GetPageSubPagesResponse = Partial<page_subpage>;
+export declare type GetPageTagsParams = {
+    exports?: boolean;
+} & BaseQueryParams;
+export declare type GetPageTagsResponse = Partial<Tags>;
+export declare type GetPageTreeParams = {
+    startpage?: boolean;
+    format?: "html" | "xml" | "google";
+    include?: string;
+    authenticate?: boolean;
+};
+export declare type GetPageTreeResponse = Partial<GetPagesResponse>;
+export declare type GetPageBookParams = {
+    format?: "html" | "pdf";
+    title?: string;
+    showtoc?: boolean;
+    authenticate?: boolean;
+    stylesheet?: string;
+    pageids: number;
+    filename?: string;
+};
+export declare type GetPageBookFilenameParams = GetPageBookParams;
+export declare type GetPagesCsvParams = {
+    filename?: string;
+    pageids: string;
+};
+export declare type GetPagesPopularParams = BaseQueryParams & PaginationQueryParams;
+export declare type GetPagesPopularResponse = {
+    "@count"?: string;
+    "@href"?: string;
+    page?: (Partial<PageBase> & Partial<PageExtended>) | (Partial<PageBase> & Partial<PageExtended>)[] | "";
+};
+export declare type PostPageContentsParams = {
+    ordered?: boolean;
+    restriction?: string;
+    importtime?: string;
+    overwrite?: boolean;
+    reltopath?: string;
+    relto?: number;
+    abort?: "never" | "modified" | "exists";
+    xpath?: string;
+    section?: number;
+    title?: string;
+    comment?: string;
+    edittime: string;
+    authenticate?: boolean;
+    redirects?: number;
+    tidy?: "remove" | "convert";
+};
+export declare type PostPageContentsResponse = {
+    edit: {
+        "@status": "success" | "conflict";
+        page: {
+            "@id": number;
+            "@href": string;
+            title: string;
+            path: string;
+        };
+        "page.base": {
+            "@id": number;
+            "@revision": number;
+            "@href": string;
+            title: string;
+            path: string;
+            "date.edited": string;
+            "user.author": {
+                "@id": number;
+                "@href": string;
+                nick: string;
+                username: string;
+                email: string;
+            };
+            description: string;
+            contents: {
+                "@type": string;
+                "@href": string;
+            };
+        };
+        "page.overwritten"?: {
+            "@id": number;
+            "@revision": number;
+            "@href": string;
+            title: string;
+            path: string;
+            "date.edited": string;
+            "user.author": {
+                "@id": number;
+                "@href": string;
+                nick: string;
+                username: string;
+                email: string;
+            };
+            description: string;
+            contents: {
+                "@type": string;
+                "@href": string;
+            };
+        };
+    };
+};
+export declare type DeletePageParams = {
+    recursive?: boolean;
+} & BaseQueryParams;
+export declare type DeletePageResponse = {
+    deletedPages?: {
+        "@count"?: number;
+        page?: Partial<DeletedPage> | Partial<DeletedPage>[] | "";
+    };
+};
+export declare type PostPageAllowedParams = {
+    permissions?: string;
+};
+export declare type PostPageAllowedResponse = {
+    users?: {
+        user: Partial<Allowed> | Partial<Allowed>[] | "";
+    };
+};
+export declare type PostCopyPageParams = {
+    to: string;
+    title?: string;
+    abort?: 'never' | 'exists';
+    recursive?: boolean;
+    tags?: boolean;
+    attachments?: boolean;
+} & BaseQueryParams;
+export declare type PostCopyPageResponse = {
+    'pages.copied?': {
+        "@count"?: string;
+        page?: Partial<PageBase> | Partial<PageBase>[] | "";
+    } | "";
+};
+export declare type DeletePageFileNameParams = BaseQueryParams;
+export declare type HeadPageFileNameParams = {
+    includeDeleted?: boolean;
+    revision?: string;
+    size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
+    format?: "jpg" | "png" | "bmp" | "gif";
+    ratio?: "fixed" | "var";
+    width?: number;
+    height?: number;
+} & BaseQueryParams;
+export declare type PutPageFileNameParams = {
+    description?: string;
+} & BaseQueryParams;
+export declare type PutPageFileNameResponse = Partial<PageFile>;
+export declare type DeletePageFileNameDescriptionParams = BaseQueryParams;
+export declare type DeletePageFileNameDescriptionResponse = Partial<PageFile> & {
+    properties?: {
+        "@count"?: string;
+        "@href"?: string;
+        property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
+    };
+};
+export declare type PutPageFileNameDescriptionParams = BaseQueryParams;
+export declare type PutPageFileNameDescriptionResponse = Partial<PageFile> & {
+    properties?: {
+        "@count"?: string;
+        "@href"?: string;
+        property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
+    };
+};
+export declare type PutPageFileNamePropertiesKeyParams = {
+    description?: string;
+    etag?: string;
+    abort?: "never" | "modified" | "exists";
+} & BaseQueryParams;
+export declare type PutPageFileNamePropertiesKeyResponse = PageProperty;
+export declare type PutPageImportParams = {
+    behavior?: "sync" | "async";
+    filename?: string;
+    pageid?: number;
+};
+export declare type PutPageMoveParams = {
+    parentid?: number;
+    name?: string;
+    title?: string;
+    to?: string;
+} & BaseQueryParams;
+export declare type PutPageMoveResponse = {
+    "page.moved?": {
+        "@count"?: string;
+        page?: Partial<PageBase> | Partial<PageBase>[] | "";
+    } | "";
+};
+export declare type PutPageOrderParams = {
+    afterid?: number;
+};
+export declare type PostPagePropertiesParams = {
+    abort?: "never" | "modified" | "exists";
+    description?: string;
+} & BaseQueryParams;
+export declare type PostPagePropertiesResponse = PageProperty;
+export declare type PutPagePropertiesParams = BaseQueryParams;
+export declare type PutPagePropertiesResponse = {
+    properties?: {
+        "@count"?: string;
+        "@href"?: string;
+        property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
+    };
+};
+export declare type DeletePagePropertiesKeyParams = BaseQueryParams;
+export declare type PutPagePropertiesKeyParams = {
+    abort?: "never" | "modified" | "exists";
+    description?: string;
+    etag?: string;
+} & BaseQueryParams;
+export declare type PutPagePropertiesKeyResponse = PageProperty;
+export declare type PostPageRatingsParams = {
+    score: number;
+} & BaseQueryParams;
+export declare type PostPageRevertParams = {
+    verbose?: boolean;
+    abort?: "never" | "conflict";
+    fromrevision?: string;
+} & BaseQueryParams;
+export declare type DeletePageSecurityParams = BaseQueryParams;
+export declare type PostPageSecurityParams = {
+    cascade?: "none" | "delta";
+} & BaseQueryParams;
+export declare type PostPageSecurityResponse = Partial<PageSecurity>;
+export declare type PutPageSecurityParams = {
+    cascade?: "none" | "delta" | "absolute";
+} & BaseQueryParams;
+export declare type PutPageSecurityResponse = Partial<PageSecurity>;
+export declare type PutPageTagsParams = BaseQueryParams;
+export declare type PutPageTagsResponse = Partial<Tags>;
+export declare type PagePath = {
+    "@seo": string;
+    "@type": string;
+    "#text": string;
+};
+export declare type Subpages = {
+    page: Partial<Subpage>[] | Partial<Subpage>;
+};
+export declare type Subpage = {
+    "@id": string;
+    "@guid": string;
+    "@draft.state": string;
+    "@href": string;
+    "@deleted": string;
+    "date.created": string;
+    language: string;
+    namespace: string;
+    path: Partial<PagePath> | "";
+    subpages: Subpages | "";
+    title: string;
+    "uri.ui": string;
+};
+export declare type PageBase = {
+    "@id": string;
+    "@guid": string;
+    "@draft.state": string;
+    "@href": string;
+    "@deleted": string;
+    "@revision": string;
+    "@terminal": string;
+    "@subpages": string;
+    "@files": string;
+    article: string;
+    "date.created": string;
+    "date.modified": string;
+    language: string;
+    namespace: string;
+    path: Partial<PagePath> | "";
+    restriction: string;
+    security: Partial<PageSecurity> | "";
+    title: string;
+    "uri.ui": string;
+};
+export declare type PageExtended = {
+    "@unpublish": string;
+    aliases: {
+        [key: string]: string;
+    } | "";
+    comments: {
+        "@count"?: string;
+        "@href"?: string;
+    } | "";
+    contents: Partial<Contents> | "";
+    "contents.alt": {
+        "@type": string;
+        "@href": string;
+    } | "";
+    "date.edited": string;
+    description: string;
+    files: {
+        "@count?": string;
+        "@href?": string;
+        file?: Partial<PageFile> | Partial<PageFile>[] | "";
+    } | "";
+    inbound: {
+        "@count"?: string;
+        page?: Partial<PageBase> | Partial<PageBase>[] | "";
+    } | "";
+    "language.effective": string;
+    metrics: {
+        "metric.charcount"?: string;
+        "metric.views"?: string;
+    } | "";
+    outbound: {
+        "@count"?: string;
+        page?: Partial<PageBase> | Partial<PageBase>[] | "";
+    } | "";
+    "page.parent": Partial<PageBase> | "";
+    "page.redirectedfrom": string;
+    properties: {
+        "@count"?: string;
+        "@href"?: string;
+        property?: Record<string, string>[];
+    } | "";
+    rating: Partial<PageRating> | "";
+    revisions: Partial<PageRevision> | "";
+    "revisions.archive": Partial<PageRevision> | "";
+    subpages: {
+        "@href"?: string;
+    } | "";
+    summary: string;
+    tags: Partial<Tags> | "";
+    timeuuid: string;
+    "user.author": Partial<ExpertUser> | "";
+    "user.createdby": Partial<ExpertUser> | "";
+};
+export declare type PageRating = {
+    "@score": string;
+    "@count": string;
+    "@seated.score": string;
+    "@seated.count": string;
+    "@unseated.score": string;
+    "@unseated.count": string;
+    "@anonymous.score": string;
+    "@anonymous.count": string;
+};
+export declare type PageRevision = {
+    "@count": string;
+    "@deprecated": string;
+    "@totalcount": string;
+    "@href": string;
+};
+export declare type PageFile = {
+    "@id": string;
+    "@revision": string;
+    "@res-id": string;
+    "@href": string;
+    "@res-is-head": string;
+    "@res-is-deleted": string;
+    "@res-rev-is-deleted": string;
+    "@res-contents-id": string;
+    "alt-text": string;
+    contents: Partial<Contents> | "";
+    "contents.preview": Partial<ContentsPreview> | Partial<ContentsPreview>[] | "";
+    "date.created": string;
+    "date.last-modified": string;
+    description: string;
+    filename: string;
+    "page.parent": Partial<PageBase> | "";
+    revisions: Partial<PageRevision> | "";
+    "user-action": {
+        "@type"?: string;
+    } | "";
+    "user.createdBy": Partial<ExpertUser> | "";
+};
+export declare type PageTag = {
+    "@value": string;
+    "@id": string;
+    "@href": string;
+    title: string;
+    type: string;
+    uri: string;
+    related: {
+        "@count"?: string;
+        page?: Partial<PageBase> | Partial<PageBase>[] | "";
+    } | "";
+};
+export declare type Contents = {
+    "@type": string;
+    "@size": string;
+    "@width": string;
+    "@height": string;
+    "@href": string;
+    "#text": string;
+    properties: {
+        property: Partial<PageProperty> | Partial<PageProperty>[] | "";
+    } | "";
+};
+export declare type ContentsPreview = {
+    "@rel": string;
+    "@type": string;
+    "@maxwidth": string;
+    "@maxheight": string;
+    "@href": string;
+    "@etag": string;
+};
+export declare type Tags = {
+    "@count"?: string;
+    "@href"?: string;
+    tag?: Partial<PageTag> | Partial<PageTag>[] | "";
+};
+export declare type PageProperty = {
+    "@revision": string;
+    "@resid": string;
+    "@name": string;
+    "@href": string;
+    "@etag": string;
+    "@resource-is-deleted": string;
+    "@resource-rev-is-deleted": string;
+    "change-description": string;
+    contents: Partial<Contents> | "";
+    "date.modified": string;
+    "user.modified": Partial<ExpertUser> | "";
+};
+export declare type page_subpage = {
+    "@totalcount": string;
+    "@count": string;
+    "@href": string;
+    "page.subpage": Partial<PageBase> | Partial<PageBase>[] | "";
+};
+export declare type exprCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+    function: functionCall | functionCall[] | "";
+};
+export declare type functionCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+    "@location": string;
+    expr: exprCall | exprCall[] | "";
+};
+export declare type importCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+    "@recursive": string;
+    "@location": string;
+    import: importCall | importCall[] | "";
+};
+export declare type pageCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+    import: importCall | importCall[] | "";
+    template: templateCall | templateCall[] | "";
+};
+export declare type propertyCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+};
+export declare type templateCall = {
+    "@name": string;
+    "@elapsed": string;
+    "@avg": string;
+    "@max": string;
+    "@percent": string;
+    "@count": string;
+    "@mode": string;
+    "@location": string;
+    function: functionCall | functionCall[] | "";
+    property: propertyCall | propertyCall[] | "";
+    template: templateCall | templateCall[] | "";
+};
+export declare type Entry = {
+    "@name": string;
+    "@value": string;
+};
+export declare type Query = {
+    "@name": string;
+    "@elapsed": string;
+    "@average": string;
+    "@max": string;
+    "@count": string;
+};
+export declare type DeletedPage = {
+    "@id": number;
+    "@href": string;
+    title: string;
+    path: string;
+};
+export declare type Allowed = {
+    "@id": string;
+};