fastcomments-sdk/dist/generated/src/models/PublicComment.d.ts

FastComments API Client - A SDK for interacting with the FastComments API

/**
 * fastcomments
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 0.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { CommentUserBadgeInfo } from './CommentUserBadgeInfo';
/**
 *
 * @export
 * @interface PublicComment
 */
export interface PublicComment {
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    id: string;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    userId?: string | null;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    commenterName: string;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    commenterLink?: string | null;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    commentHTML: string;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    parentId?: string | null;
    /**
     *
     * @type {Date}
     * @memberof PublicComment
     */
    date: Date | null;
    /**
     *
     * @type {number}
     * @memberof PublicComment
     */
    votes?: number | null;
    /**
     *
     * @type {number}
     * @memberof PublicComment
     */
    votesUp?: number | null;
    /**
     *
     * @type {number}
     * @memberof PublicComment
     */
    votesDown?: number | null;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    verified: boolean;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    avatarSrc?: string | null;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    hasImages?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isByAdmin?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isByModerator?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isPinned?: boolean | null;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isLocked?: boolean | null;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    displayLabel?: string | null;
    /**
     *
     * @type {number}
     * @memberof PublicComment
     */
    rating?: number | null;
    /**
     *
     * @type {Array<CommentUserBadgeInfo>}
     * @memberof PublicComment
     */
    badges?: Array<CommentUserBadgeInfo> | null;
    /**
     *
     * @type {number}
     * @memberof PublicComment
     */
    viewCount?: number | null;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isDeleted?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isDeletedUser?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isSpam?: boolean;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    anonUserId?: string | null;
    /**
     *
     * @type {Array<string>}
     * @memberof PublicComment
     */
    feedbackIds?: Array<string>;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    requiresVerification?: boolean;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    editKey?: string;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    approved?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isUnread?: boolean;
    /**
     *
     * @type {string}
     * @memberof PublicComment
     */
    myVoteId?: string;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isVotedDown?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isVotedUp?: boolean;
    /**
     * This is always set when asTree=true
     * @type {boolean}
     * @memberof PublicComment
     */
    hasChildren?: boolean;
    /**
     * The total nested child count included in this response (may be more available w/ pagination) Only set with asTree=true, otherwise this will be null.
     * @type {number}
     * @memberof PublicComment
     */
    nestedChildrenCount?: number;
    /**
     * You must ask the API to count children (with asTree=true&countChildren=true), otherwise this will be null. This will be the complete direct child count, whereas children may only contain a subset based on pagination.
     * @type {number}
     * @memberof PublicComment
     */
    childCount?: number;
    /**
     *
     * @type {Array<PublicComment>}
     * @memberof PublicComment
     */
    children?: Array<PublicComment>;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isFlagged?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof PublicComment
     */
    isBlocked?: boolean;
}
/**
 * Check if a given object implements the PublicComment interface.
 */
export declare function instanceOfPublicComment(value: object): value is PublicComment;
export declare function PublicCommentFromJSON(json: any): PublicComment;
export declare function PublicCommentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicComment;
export declare function PublicCommentToJSON(json: any): PublicComment;
export declare function PublicCommentToJSONTyped(value?: PublicComment | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=PublicComment.d.ts.map