@halo-dev/api-client 2.15.0 → 2.17.0

package/dist/src/models/single-page-spec.d.ts

@@ -0,0 +1,119 @@
+import { Excerpt } from './excerpt';
+
+/**
+ *
+ * @export
+ * @interface SinglePageSpec
+ */
+export interface SinglePageSpec {
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageSpec
+     */
+    'allowComment': boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'baseSnapshot'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'cover'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageSpec
+     */
+    'deleted': boolean;
+    /**
+     *
+     * @type {Excerpt}
+     * @memberof SinglePageSpec
+     */
+    'excerpt': Excerpt;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'headSnapshot'?: string;
+    /**
+     *
+     * @type {Array<{ [key: string]: string; }>}
+     * @memberof SinglePageSpec
+     */
+    'htmlMetas'?: Array<{
+        [key: string]: string;
+    }>;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'owner'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageSpec
+     */
+    'pinned': boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof SinglePageSpec
+     */
+    'priority': number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageSpec
+     */
+    'publish': boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'publishTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'releaseSnapshot'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'slug': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'template'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageSpec
+     */
+    'visible': SinglePageSpecVisibleEnum;
+}
+export declare const SinglePageSpecVisibleEnum: {
+    readonly Public: "PUBLIC";
+    readonly Internal: "INTERNAL";
+    readonly Private: "PRIVATE";
+};
+export type SinglePageSpecVisibleEnum = typeof SinglePageSpecVisibleEnum[keyof typeof SinglePageSpecVisibleEnum];

package/dist/src/models/single-page-status.d.ts

@@ -0,0 +1,69 @@
+import { Condition } from './condition';
+
+/**
+ *
+ * @export
+ * @interface SinglePageStatus
+ */
+export interface SinglePageStatus {
+    /**
+     *
+     * @type {number}
+     * @memberof SinglePageStatus
+     */
+    'commentsCount'?: number;
+    /**
+     *
+     * @type {Array<Condition>}
+     * @memberof SinglePageStatus
+     */
+    'conditions'?: Array<Condition>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof SinglePageStatus
+     */
+    'contributors'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageStatus
+     */
+    'excerpt'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageStatus
+     */
+    'hideFromList'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SinglePageStatus
+     */
+    'inProgress'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageStatus
+     */
+    'lastModifyTime'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof SinglePageStatus
+     */
+    'observedVersion'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageStatus
+     */
+    'permalink'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePageStatus
+     */
+    'phase': string;
+}

package/dist/src/models/single-page-vo.d.ts

@@ -0,0 +1,56 @@
+import { ContentVo } from './content-vo';
+import { ContributorVo } from './contributor-vo';
+import { Metadata } from './metadata';
+import { SinglePageSpec } from './single-page-spec';
+import { SinglePageStatus } from './single-page-status';
+import { StatsVo } from './stats-vo';
+
+/**
+ *
+ * @export
+ * @interface SinglePageVo
+ */
+export interface SinglePageVo {
+    /**
+     *
+     * @type {ContentVo}
+     * @memberof SinglePageVo
+     */
+    'content'?: ContentVo;
+    /**
+     *
+     * @type {Array<ContributorVo>}
+     * @memberof SinglePageVo
+     */
+    'contributors'?: Array<ContributorVo>;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof SinglePageVo
+     */
+    'metadata': Metadata;
+    /**
+     *
+     * @type {ContributorVo}
+     * @memberof SinglePageVo
+     */
+    'owner'?: ContributorVo;
+    /**
+     *
+     * @type {SinglePageSpec}
+     * @memberof SinglePageVo
+     */
+    'spec'?: SinglePageSpec;
+    /**
+     *
+     * @type {StatsVo}
+     * @memberof SinglePageVo
+     */
+    'stats'?: StatsVo;
+    /**
+     *
+     * @type {SinglePageStatus}
+     * @memberof SinglePageVo
+     */
+    'status'?: SinglePageStatus;
+}

package/dist/src/models/single-page.d.ts

@@ -0,0 +1,41 @@
+import { Metadata } from './metadata';
+import { SinglePageSpec } from './single-page-spec';
+import { SinglePageStatus } from './single-page-status';
+
+/**
+ *
+ * @export
+ * @interface SinglePage
+ */
+export interface SinglePage {
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePage
+     */
+    'apiVersion': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SinglePage
+     */
+    'kind': string;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof SinglePage
+     */
+    'metadata': Metadata;
+    /**
+     *
+     * @type {SinglePageSpec}
+     * @memberof SinglePage
+     */
+    'spec': SinglePageSpec;
+    /**
+     *
+     * @type {SinglePageStatus}
+     * @memberof SinglePage
+     */
+    'status'?: SinglePageStatus;
+}

package/dist/src/models/site-stats-vo.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.17.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SiteStatsVo
+ */
+export interface SiteStatsVo {
+    /**
+     *
+     * @type {number}
+     * @memberof SiteStatsVo
+     */
+    'category'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SiteStatsVo
+     */
+    'comment'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SiteStatsVo
+     */
+    'post'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SiteStatsVo
+     */
+    'upvote'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SiteStatsVo
+     */
+    'visit'?: number;
+}

package/dist/src/models/snap-shot-spec.d.ts

@@ -0,0 +1,57 @@
+import { Ref } from './ref';
+
+/**
+ *
+ * @export
+ * @interface SnapShotSpec
+ */
+export interface SnapShotSpec {
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'contentPatch'?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof SnapShotSpec
+     */
+    'contributors'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'lastModifyTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'owner': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'parentSnapshotName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'rawPatch'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SnapShotSpec
+     */
+    'rawType': string;
+    /**
+     *
+     * @type {Ref}
+     * @memberof SnapShotSpec
+     */
+    'subjectRef': Ref;
+}

package/dist/src/models/snapshot-list.d.ts

@@ -0,0 +1,63 @@
+import { Snapshot } from './snapshot';
+
+/**
+ *
+ * @export
+ * @interface SnapshotList
+ */
+export interface SnapshotList {
+    /**
+     * Indicates whether current page is the first page.
+     * @type {boolean}
+     * @memberof SnapshotList
+     */
+    'first': boolean;
+    /**
+     * Indicates whether current page has previous page.
+     * @type {boolean}
+     * @memberof SnapshotList
+     */
+    'hasNext': boolean;
+    /**
+     * Indicates whether current page has previous page.
+     * @type {boolean}
+     * @memberof SnapshotList
+     */
+    'hasPrevious': boolean;
+    /**
+     * A chunk of items.
+     * @type {Array<Snapshot>}
+     * @memberof SnapshotList
+     */
+    'items': Array<Snapshot>;
+    /**
+     * Indicates whether current page is the last page.
+     * @type {boolean}
+     * @memberof SnapshotList
+     */
+    'last': boolean;
+    /**
+     * Page number, starts from 1. If not set or equal to 0, it means no pagination.
+     * @type {number}
+     * @memberof SnapshotList
+     */
+    'page': number;
+    /**
+     * Size of each page. If not set or equal to 0, it means no pagination.
+     * @type {number}
+     * @memberof SnapshotList
+     */
+    'size': number;
+    /**
+     * Total elements.
+     * @type {number}
+     * @memberof SnapshotList
+     */
+    'total': number;
+    /**
+     * Indicates total pages.
+     * @type {number}
+     * @memberof SnapshotList
+     */
+    'totalPages': number;
+}

package/dist/src/models/snapshot.d.ts

@@ -0,0 +1,34 @@
+import { Metadata } from './metadata';
+import { SnapShotSpec } from './snap-shot-spec';
+
+/**
+ *
+ * @export
+ * @interface Snapshot
+ */
+export interface Snapshot {
+    /**
+     *
+     * @type {string}
+     * @memberof Snapshot
+     */
+    'apiVersion': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Snapshot
+     */
+    'kind': string;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof Snapshot
+     */
+    'metadata': Metadata;
+    /**
+     *
+     * @type {SnapShotSpec}
+     * @memberof Snapshot
+     */
+    'spec': SnapShotSpec;
+}

package/dist/src/models/stats-vo.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.17.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface StatsVo
+ */
+export interface StatsVo {
+    /**
+     *
+     * @type {number}
+     * @memberof StatsVo
+     */
+    'comment'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof StatsVo
+     */
+    'upvote'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof StatsVo
+     */
+    'visit'?: number;
+}

package/dist/src/models/stats.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.17.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Stats
+ */
+export interface Stats {
+    /**
+     *
+     * @type {number}
+     * @memberof Stats
+     */
+    'approvedComment'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Stats
+     */
+    'totalComment'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Stats
+     */
+    'upvote'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Stats
+     */
+    'visit'?: number;
+}

package/dist/src/models/subject.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.17.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Subject
+ */
+export interface Subject {
+    /**
+     *
+     * @type {string}
+     * @memberof Subject
+     */
+    'apiGroup'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subject
+     */
+    'kind'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Subject
+     */
+    'name'?: string;
+}

package/dist/src/models/subscription-list.d.ts

@@ -0,0 +1,63 @@
+import { Subscription } from './subscription';
+
+/**
+ *
+ * @export
+ * @interface SubscriptionList
+ */
+export interface SubscriptionList {
+    /**
+     * Indicates whether current page is the first page.
+     * @type {boolean}
+     * @memberof SubscriptionList
+     */
+    'first': boolean;
+    /**
+     * Indicates whether current page has previous page.
+     * @type {boolean}
+     * @memberof SubscriptionList
+     */
+    'hasNext': boolean;
+    /**
+     * Indicates whether current page has previous page.
+     * @type {boolean}
+     * @memberof SubscriptionList
+     */
+    'hasPrevious': boolean;
+    /**
+     * A chunk of items.
+     * @type {Array<Subscription>}
+     * @memberof SubscriptionList
+     */
+    'items': Array<Subscription>;
+    /**
+     * Indicates whether current page is the last page.
+     * @type {boolean}
+     * @memberof SubscriptionList
+     */
+    'last': boolean;
+    /**
+     * Page number, starts from 1. If not set or equal to 0, it means no pagination.
+     * @type {number}
+     * @memberof SubscriptionList
+     */
+    'page': number;
+    /**
+     * Size of each page. If not set or equal to 0, it means no pagination.
+     * @type {number}
+     * @memberof SubscriptionList
+     */
+    'size': number;
+    /**
+     * Total elements.
+     * @type {number}
+     * @memberof SubscriptionList
+     */
+    'total': number;
+    /**
+     * Indicates total pages.
+     * @type {number}
+     * @memberof SubscriptionList
+     */
+    'totalPages': number;
+}

package/dist/src/models/subscription-spec.d.ts

@@ -0,0 +1,34 @@
+import { InterestReason } from './interest-reason';
+import { SubscriptionSubscriber } from './subscription-subscriber';
+
+/**
+ *
+ * @export
+ * @interface SubscriptionSpec
+ */
+export interface SubscriptionSpec {
+    /**
+     * Perhaps users need to unsubscribe and interact without receiving notifications again
+     * @type {boolean}
+     * @memberof SubscriptionSpec
+     */
+    'disabled'?: boolean;
+    /**
+     *
+     * @type {InterestReason}
+     * @memberof SubscriptionSpec
+     */
+    'reason': InterestReason;
+    /**
+     *
+     * @type {SubscriptionSubscriber}
+     * @memberof SubscriptionSpec
+     */
+    'subscriber': SubscriptionSubscriber;
+    /**
+     * The token to unsubscribe
+     * @type {string}
+     * @memberof SubscriptionSpec
+     */
+    'unsubscribeToken': string;
+}