Files
discoursejs/docs/sdk/models/operations/getsiteresponsebody.md

22 KiB
Raw Blame History

GetSiteResponseBody

success response

Example Usage

import { GetSiteResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";

let value: GetSiteResponseBody = {
    anonymousTopMenuItems: ["<value>"],
    archetypes: [
        {
            id: "<id>",
            name: "<value>",
            options: ["<value>"],
        },
    ],
    authProviders: ["<value>"],
    canCreateTag: false,
    canTagPms: false,
    canTagTopics: false,
    categories: [
        {
            allowGlobalTags: false,
            allowedTagGroups: ["<value>"],
            allowedTags: ["<value>"],
            canEdit: false,
            color: "yellow",
            defaultListFilter: "<value>",
            defaultTopPeriod: "<value>",
            defaultView: "<value>",
            hasChildren: false,
            id: 657020,
            minimumRequiredTags: 343392,
            name: "<value>",
            navigateToFirstPostAfterRead: false,
            notificationLevel: 652309,
            numFeaturedTopics: 591027,
            permission: 821719,
            position: 659177,
            postCount: 402767,
            readOnlyBanner: "<value>",
            readRestricted: false,
            requiredTagGroups: [
                {
                    minCount: 397257,
                    name: "<value>",
                },
            ],
            showSubcategoryList: false,
            slug: "<value>",
            sortAscending: "<value>",
            sortOrder: "<value>",
            subcategoryListStyle: "<value>",
            textColor: "<value>",
            topicCount: 37565,
            topicTemplate: "<value>",
            topicUrl: "<value>",
            uploadedBackground: "<value>",
            uploadedBackgroundDark: "<value>",
            uploadedLogo: "<value>",
            uploadedLogoDark: "<value>",
        },
    ],
    censoredRegexp: [{}],
    customEmojiTranslation: {},
    defaultArchetype: "<value>",
    defaultDarkColorScheme: {},
    filters: ["<value>"],
    groups: [
        {
            flairBgColor: "<value>",
            flairColor: "<value>",
            flairUrl: "<value>",
            id: 999278,
            name: "<value>",
        },
    ],
    notificationTypes: {
        bookmarkReminder: 984632,
        chatGroupMention: 351893,
        chatInvitation: 448143,
        chatMention: 721407,
        chatMessage: 937636,
        codeReviewCommitApproved: 637583,
        custom: 672041,
        edited: 813054,
        eventInvitation: 266697,
        eventReminder: 976226,
        grantedBadge: 564064,
        groupMentioned: 889794,
        groupMessageSummary: 956933,
        invitedToPrivateMessage: 764562,
        invitedToTopic: 113486,
        inviteeAccepted: 698249,
        liked: 272229,
        likedConsolidated: 335498,
        linked: 82057,
        membershipRequestAccepted: 147685,
        membershipRequestConsolidated: 765271,
        mentioned: 62636,
        movedPost: 21688,
        postApproved: 241901,
        posted: 137251,
        privateMessage: 432281,
        quoted: 260628,
        reaction: 521996,
        replied: 871083,
        topicReminder: 773084,
        votesReleased: 179410,
        watchingCategoryOrTag: 958741,
        watchingFirstPost: 433279,
    },
    periods: ["<value>"],
    postActionTypes: [
        {
            description: "Cross-group eco-centric array",
            id: 583404,
            isCustomFlag: false,
            isFlag: false,
            name: "<value>",
            nameKey: "<value>",
            shortDescription: "<value>",
        },
    ],
    postTypes: {
        moderatorAction: 589695,
        regular: 936469,
        smallAction: 745398,
        whisper: 940782,
    },
    tagsFilterRegexp: "<value>",
    topMenuItems: ["<value>"],
    topTags: ["<value>"],
    topicFeaturedLinkAllowedCategoryIds: ["<value>"],
    topicFlagTypes: [
        {
            description: "Switchable 6th generation task-force",
            id: 596211,
            isCustomFlag: false,
            isFlag: false,
            name: "<value>",
            nameKey: "<value>",
            shortDescription: "<value>",
        },
    ],
    trustLevels: {
        basic: 983427,
        leader: 891801,
        member: 399802,
        newuser: 780931,
        regular: 380335,
    },
    uncategorizedCategoryId: 211534,
    userColorSchemes: [
        {
            id: 147808,
            isDark: false,
            name: "<value>",
        },
    ],
    userFieldMaxLength: 764995,
    userFields: ["<value>"],
    userThemes: [
        {
            colorSchemeId: 684935,
            default: false,
            name: "<value>",
            themeId: 189062,
        },
    ],
    watchedWordsLink: "<value>",
    watchedWordsReplace: "<value>",
};

Fields

Field Type Required Description
anonymousTopMenuItems any[] ✔️ N/A
archetypes operations.Archetypes[] ✔️ N/A
authProviders any[] ✔️ N/A
canAssociateGroups boolean N/A
canCreateTag boolean ✔️ N/A
canTagPms boolean ✔️ N/A
canTagTopics boolean ✔️ N/A
categories operations.GetSiteCategories[] ✔️ N/A
censoredRegexp operations.CensoredRegexp[] ✔️ N/A
customEmojiTranslation operations.CustomEmojiTranslation ✔️ N/A
defaultArchetype string ✔️ N/A
defaultDarkColorScheme operations.DefaultDarkColorScheme ✔️ N/A
deniedEmojis any[] N/A
displayedAboutPluginStatGroups any[] N/A
filters any[] ✔️ N/A
groups operations.GetSiteGroups[] ✔️ N/A
hashtagConfigurations operations.HashtagConfigurations N/A
hashtagIcons operations.HashtagIcons N/A
markdownAdditionalOptions operations.MarkdownAdditionalOptions N/A
navigationMenuSiteTopTags any[] N/A
notificationTypes operations.NotificationTypes ✔️ N/A
periods any[] ✔️ N/A
postActionTypes operations.PostActionTypes[] ✔️ N/A
postTypes operations.PostTypes ✔️ N/A
tagsFilterRegexp string ✔️ N/A
topMenuItems any[] ✔️ N/A
topTags any[] ✔️ N/A
topicFeaturedLinkAllowedCategoryIds any[] ✔️ N/A
topicFlagTypes operations.TopicFlagTypes[] ✔️ N/A
trustLevels operations.TrustLevels ✔️ N/A
uncategorizedCategoryId number ✔️ N/A
userColorSchemes operations.UserColorSchemes[] ✔️ N/A
userFieldMaxLength number ✔️ N/A
userFields any[] ✔️ N/A
userThemes operations.UserThemes[] ✔️ N/A
userTips operations.UserTips N/A
watchedWordsLink string ✔️ N/A
watchedWordsReplace string ✔️ N/A
whispersAllowedGroupsNames any[] N/A
wizardRequired boolean N/A