UNPKG

fastcomments-sdk

Version:

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

574 lines 13.5 kB
/** * 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 { TOSConfig } from './TOSConfig'; import type { MentionAutoCompleteMode } from './MentionAutoCompleteMode'; import type { CommentQuestionResultsRenderingType } from './CommentQuestionResultsRenderingType'; import type { CommenterNameFormats } from './CommenterNameFormats'; import type { SSOSecurityLevel } from './SSOSecurityLevel'; import type { QuestionWhenSave } from './QuestionWhenSave'; import type { UsersListLocation } from './UsersListLocation'; import type { GifRating } from './GifRating'; import type { SpamRule } from './SpamRule'; import type { ImageContentProfanityLevel } from './ImageContentProfanityLevel'; import type { CommentQuestionsRequired } from './CommentQuestionsRequired'; import type { VoteStyle } from './VoteStyle'; import type { CommentThreadDeletionMode } from './CommentThreadDeletionMode'; import type { SortDirections } from './SortDirections'; import type { QuestionSubQuestionVisibility } from './QuestionSubQuestionVisibility'; import type { QuestionRenderingType } from './QuestionRenderingType'; import type { CommentHTMLRenderingMode } from './CommentHTMLRenderingMode'; /** * * @export * @interface CustomConfigParameters */ export interface CustomConfigParameters { /** * * @type {boolean} * @memberof CustomConfigParameters */ absoluteAndRelativeDates?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ absoluteDates?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ allowAnon?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ allowAnonFlag?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ allowAnonVotes?: boolean; /** * * @type {Array<string>} * @memberof CustomConfigParameters */ allowedLanguages?: Array<string> | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ collapseReplies?: boolean; /** * * @type {string} * @memberof CustomConfigParameters */ commentCountFormat?: string | null; /** * * @type {CommentHTMLRenderingMode} * @memberof CustomConfigParameters */ commentHTMLRenderingMode?: CommentHTMLRenderingMode; /** * * @type {CommentThreadDeletionMode} * @memberof CustomConfigParameters */ commentThreadDeleteMode?: CommentThreadDeletionMode | null; /** * * @type {CommenterNameFormats} * @memberof CustomConfigParameters */ commenterNameFormat?: CommenterNameFormats | null; /** * * @type {number} * @memberof CustomConfigParameters */ countAboveToggle?: number; /** * * @type {string} * @memberof CustomConfigParameters */ customCSS?: string | null; /** * * @type {string} * @memberof CustomConfigParameters */ defaultAvatarSrc?: string | null; /** * * @type {SortDirections} * @memberof CustomConfigParameters */ defaultSortDirection?: SortDirections | null; /** * * @type {string} * @memberof CustomConfigParameters */ defaultUsername?: string | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableAutoAdminMigration?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableAutoHashTagCreation?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableBlocking?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableCommenterCommentDelete?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableCommenterCommentEdit?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableEmailInputs?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableLiveCommenting?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableNotificationBell?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableProfileComments?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableProfileDirectMessages?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableProfiles?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableSuccessMessage?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableToolbar?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableUnverifiedLabel?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ disableVoting?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableCommenterLinks?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableSearch?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableSpoilers?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableThirdPartyCookieBypass?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableViewCounts?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableVoteList?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableWYSIWYG?: boolean; /** * * @type {GifRating} * @memberof CustomConfigParameters */ gifRating?: GifRating; /** * * @type {boolean} * @memberof CustomConfigParameters */ hasDarkBackground?: boolean; /** * * @type {string} * @memberof CustomConfigParameters */ headerHTML?: string | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ hideAvatars?: boolean; /** * * @type {string} * @memberof CustomConfigParameters */ hideCommentsUnderCountTextFormat?: string | null; /** * * @type {ImageContentProfanityLevel} * @memberof CustomConfigParameters */ imageContentProfanityLevel?: ImageContentProfanityLevel; /** * * @type {boolean} * @memberof CustomConfigParameters */ inputAfterComments?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ limitCommentsByGroups?: boolean; /** * * @type {string} * @memberof CustomConfigParameters */ locale?: string | null; /** * * @type {number} * @memberof CustomConfigParameters */ maxCommentCharacterLength?: number | null; /** * * @type {number} * @memberof CustomConfigParameters */ maxCommentCreatedCountPUPM?: number | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ noCustomConfig?: boolean; /** * * @type {MentionAutoCompleteMode} * @memberof CustomConfigParameters */ mentionAutoCompleteMode?: MentionAutoCompleteMode | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ noImageUploads?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ allowEmbeds?: boolean; /** * * @type {Array<string>} * @memberof CustomConfigParameters */ allowedEmbedDomains?: Array<string> | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ noStyles?: boolean; /** * * @type {number} * @memberof CustomConfigParameters */ pageSize?: number | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ readonly?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ noNewRootComments?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ requireSSO?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableFChat?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ enableResizeHandle?: boolean; /** * * @type {Array<string>} * @memberof CustomConfigParameters */ restrictedLinkDomains?: Array<string> | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ showBadgesInTopBar?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ showCommentSaveSuccess?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ showLiveRightAway?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ showQuestion?: boolean; /** * * @type {Array<SpamRule>} * @memberof CustomConfigParameters */ spamRules?: Array<SpamRule>; /** * * @type {SSOSecurityLevel} * @memberof CustomConfigParameters */ ssoSecLvl?: SSOSecurityLevel; /** * Construct a type with a set of properties K of type T * @type {{ [key: string]: string; }} * @memberof CustomConfigParameters */ translations?: { [key: string]: string; } | null; /** * * @type {boolean} * @memberof CustomConfigParameters */ useShowCommentsToggle?: boolean; /** * * @type {boolean} * @memberof CustomConfigParameters */ useSingleLineCommentInput?: boolean; /** * * @type {VoteStyle} * @memberof CustomConfigParameters */ voteStyle?: VoteStyle; /** * * @type {string} * @memberof CustomConfigParameters */ widgetQuestionId?: string; /** * * @type {CommentQuestionResultsRenderingType} * @memberof CustomConfigParameters */ widgetQuestionResultsStyle?: CommentQuestionResultsRenderingType; /** * * @type {boolean} * @memberof CustomConfigParameters */ widgetQuestionShowBreakdown?: boolean; /** * * @type {QuestionRenderingType} * @memberof CustomConfigParameters */ widgetQuestionStyle?: QuestionRenderingType; /** * * @type {QuestionWhenSave} * @memberof CustomConfigParameters */ widgetQuestionWhenToSave?: QuestionWhenSave; /** * * @type {CommentQuestionsRequired} * @memberof CustomConfigParameters */ widgetQuestionsRequired?: CommentQuestionsRequired; /** * * @type {QuestionSubQuestionVisibility} * @memberof CustomConfigParameters */ widgetSubQuestionVisibility?: QuestionSubQuestionVisibility; /** * * @type {boolean} * @memberof CustomConfigParameters */ wrap?: boolean; /** * * @type {UsersListLocation} * @memberof CustomConfigParameters */ usersListLocation?: UsersListLocation; /** * * @type {boolean} * @memberof CustomConfigParameters */ usersListIncludeOffline?: boolean; /** * * @type {string} * @memberof CustomConfigParameters */ ticketBaseUrl?: string; /** * * @type {string} * @memberof CustomConfigParameters */ ticketKBSearchEndpoint?: string; /** * * @type {boolean} * @memberof CustomConfigParameters */ ticketFileUploadsEnabled?: boolean; /** * * @type {number} * @memberof CustomConfigParameters */ ticketMaxFileSize?: number; /** * * @type {Array<string>} * @memberof CustomConfigParameters */ ticketAutoAssignUserIds?: Array<string>; /** * * @type {TOSConfig} * @memberof CustomConfigParameters */ tos?: TOSConfig; } /** * Check if a given object implements the CustomConfigParameters interface. */ export declare function instanceOfCustomConfigParameters(value: object): value is CustomConfigParameters; export declare function CustomConfigParametersFromJSON(json: any): CustomConfigParameters; export declare function CustomConfigParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomConfigParameters; export declare function CustomConfigParametersToJSON(json: any): CustomConfigParameters; export declare function CustomConfigParametersToJSONTyped(value?: CustomConfigParameters | null, ignoreDiscriminator?: boolean): any; //# sourceMappingURL=CustomConfigParameters.d.ts.map