mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 04:19:37 +00:00
ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.358.0
This commit is contained in:
speakeasybot
28
.eslintrc.cjs
Normal file
28
.eslintrc.cjs
Normal file
@@ -0,0 +1,28 @@
|
||||
/* eslint-env node */
|
||||
module.exports = {
|
||||
root: true,
|
||||
extends: [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"plugin:import/recommended",
|
||||
"plugin:import/typescript",
|
||||
],
|
||||
parser: "@typescript-eslint/parser",
|
||||
plugins: ["@typescript-eslint"],
|
||||
settings: {
|
||||
"import/resolver": {
|
||||
typescript: true,
|
||||
node: true,
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
// Handled by typescript compiler
|
||||
"@typescript-eslint/no-unused-vars": "off",
|
||||
"@typescript-eslint/ban-types": "off",
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/no-explicit-any": "off",
|
||||
"import/no-named-as-default-member": "off",
|
||||
|
||||
"import/no-default-export": "error",
|
||||
},
|
||||
};
|
||||
@@ -1,17 +0,0 @@
|
||||
env:
|
||||
browser: true
|
||||
es2021: true
|
||||
node: true
|
||||
extends:
|
||||
- eslint:recommended
|
||||
- plugin:@typescript-eslint/recommended
|
||||
overrides: []
|
||||
parser: "@typescript-eslint/parser"
|
||||
parserOptions:
|
||||
ecmaVersion: latest
|
||||
sourceType: module
|
||||
plugins:
|
||||
- "@typescript-eslint"
|
||||
rules:
|
||||
"@typescript-eslint/no-explicit-any": "off"
|
||||
"no-prototype-builtins": "off"
|
||||
16
.gitignore
vendored
16
.gitignore
vendored
@@ -1,2 +1,18 @@
|
||||
/models
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
/node_modules
|
||||
/lib
|
||||
/sdk
|
||||
/funcs
|
||||
/hooks
|
||||
/index.*
|
||||
/core.*
|
||||
/cjs
|
||||
/esm
|
||||
/dist
|
||||
/.tsbuildinfo
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
dist/
|
||||
node_modules/
|
||||
|
||||
9
.npmignore
Normal file
9
.npmignore
Normal file
@@ -0,0 +1,9 @@
|
||||
**/*
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
@@ -3,21 +3,131 @@ id: 599a9576-4665-431e-be1e-44cc13ef28aa
|
||||
management:
|
||||
docChecksum: dd4d04e62622de8f631720b5be68964d
|
||||
docVersion: latest
|
||||
speakeasyVersion: 1.346.0
|
||||
generationVersion: 2.379.3
|
||||
releaseVersion: 0.4.10
|
||||
configChecksum: 240e038948a2a629d8d91a2085f29d6b
|
||||
speakeasyVersion: 1.358.0
|
||||
generationVersion: 2.390.6
|
||||
releaseVersion: 0.5.0
|
||||
configChecksum: 76366dee2b6c919409101b279e0d2575
|
||||
repoURL: https://github.com/LukeHagar/discoursejs.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/discoursejs
|
||||
published: true
|
||||
features:
|
||||
typescript:
|
||||
core: 3.4.14
|
||||
additionalDependencies: 0.1.0
|
||||
additionalProperties: 0.1.1
|
||||
constsAndDefaults: 0.1.6
|
||||
core: 3.12.3
|
||||
defaultEnabledRetries: 0.1.0
|
||||
deprecations: 2.81.1
|
||||
envVarSecurityUsage: 0.1.1
|
||||
flattening: 2.81.1
|
||||
globalServerURLs: 2.82.2
|
||||
globalSecurityCallbacks: 0.1.0
|
||||
globalServerURLs: 2.82.4
|
||||
nullables: 0.1.0
|
||||
responseFormat: 0.2.3
|
||||
retries: 2.83.0
|
||||
sdkHooks: 0.1.0
|
||||
generatedFiles:
|
||||
- src/funcs/backupsCreateBackup.ts
|
||||
- src/funcs/backupsDownloadBackup.ts
|
||||
- src/funcs/backupsGetBackups.ts
|
||||
- src/funcs/backupsSendDownloadBackupEmail.ts
|
||||
- src/funcs/badgesAdminListBadges.ts
|
||||
- src/funcs/badgesCreateBadge.ts
|
||||
- src/funcs/badgesDeleteBadge.ts
|
||||
- src/funcs/badgesListUserBadges.ts
|
||||
- src/funcs/badgesUpdateBadge.ts
|
||||
- src/funcs/groupsAddGroupMembers.ts
|
||||
- src/funcs/groupsCreateGroup.ts
|
||||
- src/funcs/groupsDeleteGroup.ts
|
||||
- src/funcs/groupsGetGroup.ts
|
||||
- src/funcs/groupsListGroupMembers.ts
|
||||
- src/funcs/groupsListGroups.ts
|
||||
- src/funcs/groupsRemoveGroupMembers.ts
|
||||
- src/funcs/groupsUpdateGroup.ts
|
||||
- src/funcs/usersActivateUser.ts
|
||||
- src/funcs/usersAdminGetUser.ts
|
||||
- src/funcs/usersAdminListUsers.ts
|
||||
- src/funcs/usersAnonymizeUser.ts
|
||||
- src/funcs/usersChangePassword.ts
|
||||
- src/funcs/usersCreateUser.ts
|
||||
- src/funcs/usersDeactivateUser.ts
|
||||
- src/funcs/usersDeleteUser.ts
|
||||
- src/funcs/usersGetUser.ts
|
||||
- src/funcs/usersGetUserEmails.ts
|
||||
- src/funcs/usersGetUserExternalId.ts
|
||||
- src/funcs/usersGetUserIdentiyProviderExternalId.ts
|
||||
- src/funcs/usersListUserActions.ts
|
||||
- src/funcs/usersListUserBadges.ts
|
||||
- src/funcs/usersListUsersPublic.ts
|
||||
- src/funcs/usersLogOutUser.ts
|
||||
- src/funcs/usersRefreshGravatar.ts
|
||||
- src/funcs/usersSendPasswordResetEmail.ts
|
||||
- src/funcs/usersSilenceUser.ts
|
||||
- src/funcs/usersSuspendUser.ts
|
||||
- src/funcs/usersUpdateAvatar.ts
|
||||
- src/funcs/usersUpdateEmail.ts
|
||||
- src/funcs/usersUpdateUser.ts
|
||||
- src/funcs/usersUpdateUsername.ts
|
||||
- src/funcs/adminActivateUser.ts
|
||||
- src/funcs/adminAdminGetUser.ts
|
||||
- src/funcs/adminAdminListUsers.ts
|
||||
- src/funcs/adminAnonymizeUser.ts
|
||||
- src/funcs/adminDeactivateUser.ts
|
||||
- src/funcs/adminDeleteUser.ts
|
||||
- src/funcs/adminLogOutUser.ts
|
||||
- src/funcs/adminRefreshGravatar.ts
|
||||
- src/funcs/adminSilenceUser.ts
|
||||
- src/funcs/adminSuspendUser.ts
|
||||
- src/funcs/categoriesCreateCategory.ts
|
||||
- src/funcs/categoriesGetCategory.ts
|
||||
- src/funcs/categoriesGetSite.ts
|
||||
- src/funcs/categoriesListCategories.ts
|
||||
- src/funcs/categoriesListCategoryTopics.ts
|
||||
- src/funcs/categoriesUpdateCategory.ts
|
||||
- src/funcs/invitesCreateInvite.ts
|
||||
- src/funcs/invitesInviteToTopic.ts
|
||||
- src/funcs/topicsBookmarkTopic.ts
|
||||
- src/funcs/topicsCreateTopicPostPM.ts
|
||||
- src/funcs/topicsCreateTopicTimer.ts
|
||||
- src/funcs/topicsGetTopic.ts
|
||||
- src/funcs/topicsGetTopicByExternalId.ts
|
||||
- src/funcs/topicsInviteToTopic.ts
|
||||
- src/funcs/topicsListLatestTopics.ts
|
||||
- src/funcs/topicsListTopTopics.ts
|
||||
- src/funcs/topicsRemoveTopic.ts
|
||||
- src/funcs/topicsSetNotificationLevel.ts
|
||||
- src/funcs/topicsUpdateTopic.ts
|
||||
- src/funcs/topicsUpdateTopicStatus.ts
|
||||
- src/funcs/topicsUpdateTopicTimestamp.ts
|
||||
- src/funcs/notificationsGetNotifications.ts
|
||||
- src/funcs/notificationsMarkNotificationsAsRead.ts
|
||||
- src/funcs/postsCreateTopicPostPM.ts
|
||||
- src/funcs/postsDeletePost.ts
|
||||
- src/funcs/postsGetPost.ts
|
||||
- src/funcs/postsListPosts.ts
|
||||
- src/funcs/postsLockPost.ts
|
||||
- src/funcs/postsPerformPostAction.ts
|
||||
- src/funcs/postsPostReplies.ts
|
||||
- src/funcs/postsUpdatePost.ts
|
||||
- src/funcs/privateMessagesCreateTopicPostPM.ts
|
||||
- src/funcs/privateMessagesGetUserSentPrivateMessages.ts
|
||||
- src/funcs/privateMessagesListUserPrivateMessages.ts
|
||||
- src/funcs/searchSearch.ts
|
||||
- src/funcs/siteGetSite.ts
|
||||
- src/funcs/tagsCreateTagGroup.ts
|
||||
- src/funcs/tagsGetTag.ts
|
||||
- src/funcs/tagsGetTagGroup.ts
|
||||
- src/funcs/tagsListTagGroups.ts
|
||||
- src/funcs/tagsListTags.ts
|
||||
- src/funcs/tagsUpdateTagGroup.ts
|
||||
- src/funcs/uploadsAbortMultipart.ts
|
||||
- src/funcs/uploadsBatchPresignMultipartParts.ts
|
||||
- src/funcs/uploadsCompleteExternalUpload.ts
|
||||
- src/funcs/uploadsCompleteMultipart.ts
|
||||
- src/funcs/uploadsCreateMultipartUpload.ts
|
||||
- src/funcs/uploadsCreateUpload.ts
|
||||
- src/funcs/uploadsGeneratePresignedPut.ts
|
||||
- src/sdk/backups.ts
|
||||
- src/sdk/badges.ts
|
||||
- src/sdk/groups.ts
|
||||
@@ -34,23 +144,35 @@ generatedFiles:
|
||||
- src/sdk/tags.ts
|
||||
- src/sdk/uploads.ts
|
||||
- src/sdk/sdk.ts
|
||||
- .eslintrc.yml
|
||||
- jest.config.js
|
||||
- package-lock.json
|
||||
- .eslintrc.cjs
|
||||
- .npmignore
|
||||
- RUNTIMES.md
|
||||
- jsr.json
|
||||
- package.json
|
||||
- src/core.ts
|
||||
- src/index.ts
|
||||
- src/internal/utils/contenttype.ts
|
||||
- src/internal/utils/headers.ts
|
||||
- src/internal/utils/index.ts
|
||||
- src/internal/utils/pathparams.ts
|
||||
- src/internal/utils/queryparams.ts
|
||||
- src/internal/utils/requestbody.ts
|
||||
- src/internal/utils/retries.ts
|
||||
- src/internal/utils/security.ts
|
||||
- src/internal/utils/utils.ts
|
||||
- src/lib/base64.ts
|
||||
- src/lib/config.ts
|
||||
- src/lib/dlv.ts
|
||||
- src/lib/encodings.ts
|
||||
- src/lib/http.ts
|
||||
- src/lib/is-plain-object.ts
|
||||
- src/lib/matchers.ts
|
||||
- src/lib/primitives.ts
|
||||
- src/lib/retries.ts
|
||||
- src/lib/schemas.ts
|
||||
- src/lib/sdks.ts
|
||||
- src/lib/security.ts
|
||||
- src/lib/url.ts
|
||||
- src/sdk/index.ts
|
||||
- src/sdk/models/errors/httpclienterrors.ts
|
||||
- src/sdk/models/errors/sdkerror.ts
|
||||
- src/sdk/models/errors/sdkvalidationerror.ts
|
||||
- src/sdk/types/blobs.ts
|
||||
- src/sdk/types/enums.ts
|
||||
- src/sdk/types/fp.ts
|
||||
- src/sdk/types/index.ts
|
||||
- src/sdk/types/operations.ts
|
||||
- src/sdk/types/rfcdate.ts
|
||||
- tsconfig.json
|
||||
- src/sdk/models/operations/createbackup.ts
|
||||
@@ -142,81 +264,63 @@ generatedFiles:
|
||||
- src/sdk/models/operations/index.ts
|
||||
- docs/sdk/models/operations/createbackuprequestbody.md
|
||||
- docs/sdk/models/operations/createbackupresponsebody.md
|
||||
- docs/sdk/models/operations/createbackupresponse.md
|
||||
- docs/sdk/models/operations/downloadbackuprequest.md
|
||||
- docs/sdk/models/operations/downloadbackupresponse.md
|
||||
- docs/sdk/models/operations/responsebody.md
|
||||
- docs/sdk/models/operations/getbackupsresponse.md
|
||||
- docs/sdk/models/operations/senddownloadbackupemailrequest.md
|
||||
- docs/sdk/models/operations/senddownloadbackupemailresponse.md
|
||||
- docs/sdk/models/operations/triggers.md
|
||||
- docs/sdk/models/operations/adminbadges.md
|
||||
- docs/sdk/models/operations/badgegroupings.md
|
||||
- docs/sdk/models/operations/badgetypes.md
|
||||
- docs/sdk/models/operations/badges.md
|
||||
- docs/sdk/models/operations/adminlistbadgesresponsebody.md
|
||||
- docs/sdk/models/operations/adminlistbadgesresponse.md
|
||||
- docs/sdk/models/operations/createbadgerequestbody.md
|
||||
- docs/sdk/models/operations/badge.md
|
||||
- docs/sdk/models/operations/createbadgebadgetypes.md
|
||||
- docs/sdk/models/operations/createbadgeresponsebody.md
|
||||
- docs/sdk/models/operations/createbadgeresponse.md
|
||||
- docs/sdk/models/operations/deletebadgerequest.md
|
||||
- docs/sdk/models/operations/deletebadgeresponse.md
|
||||
- docs/sdk/models/operations/listuserbadgesrequest.md
|
||||
- docs/sdk/models/operations/listuserbadgesbadgetypes.md
|
||||
- docs/sdk/models/operations/listuserbadgesbadges.md
|
||||
- docs/sdk/models/operations/grantedbies.md
|
||||
- docs/sdk/models/operations/userbadges.md
|
||||
- docs/sdk/models/operations/listuserbadgesresponsebody.md
|
||||
- docs/sdk/models/operations/listuserbadgesresponse.md
|
||||
- docs/sdk/models/operations/updatebadgerequestbody.md
|
||||
- docs/sdk/models/operations/updatebadgerequest.md
|
||||
- docs/sdk/models/operations/updatebadgebadge.md
|
||||
- docs/sdk/models/operations/updatebadgebadgetypes.md
|
||||
- docs/sdk/models/operations/updatebadgeresponsebody.md
|
||||
- docs/sdk/models/operations/updatebadgeresponse.md
|
||||
- docs/sdk/models/operations/addgroupmembersrequestbody.md
|
||||
- docs/sdk/models/operations/addgroupmembersrequest.md
|
||||
- docs/sdk/models/operations/addgroupmembersresponsebody.md
|
||||
- docs/sdk/models/operations/addgroupmembersresponse.md
|
||||
- docs/sdk/models/operations/group.md
|
||||
- docs/sdk/models/operations/creategrouprequestbody.md
|
||||
- docs/sdk/models/operations/basicgroup.md
|
||||
- docs/sdk/models/operations/creategroupresponsebody.md
|
||||
- docs/sdk/models/operations/creategroupresponse.md
|
||||
- docs/sdk/models/operations/deletegrouprequest.md
|
||||
- docs/sdk/models/operations/deletegroupresponsebody.md
|
||||
- docs/sdk/models/operations/deletegroupresponse.md
|
||||
- docs/sdk/models/operations/getgrouprequest.md
|
||||
- docs/sdk/models/operations/extras.md
|
||||
- docs/sdk/models/operations/imapupdatedby.md
|
||||
- docs/sdk/models/operations/smtpupdatedby.md
|
||||
- docs/sdk/models/operations/getgroupgroup.md
|
||||
- docs/sdk/models/operations/getgroupresponsebody.md
|
||||
- docs/sdk/models/operations/getgroupresponse.md
|
||||
- docs/sdk/models/operations/listgroupmembersrequest.md
|
||||
- docs/sdk/models/operations/members.md
|
||||
- docs/sdk/models/operations/meta.md
|
||||
- docs/sdk/models/operations/owners.md
|
||||
- docs/sdk/models/operations/listgroupmembersresponsebody.md
|
||||
- docs/sdk/models/operations/listgroupmembersresponse.md
|
||||
- docs/sdk/models/operations/listgroupsextras.md
|
||||
- docs/sdk/models/operations/groups.md
|
||||
- docs/sdk/models/operations/listgroupsresponsebody.md
|
||||
- docs/sdk/models/operations/listgroupsresponse.md
|
||||
- docs/sdk/models/operations/removegroupmembersrequestbody.md
|
||||
- docs/sdk/models/operations/removegroupmembersrequest.md
|
||||
- docs/sdk/models/operations/removegroupmembersresponsebody.md
|
||||
- docs/sdk/models/operations/removegroupmembersresponse.md
|
||||
- docs/sdk/models/operations/updategroupgroup.md
|
||||
- docs/sdk/models/operations/updategrouprequestbody.md
|
||||
- docs/sdk/models/operations/updategrouprequest.md
|
||||
- docs/sdk/models/operations/updategroupresponsebody.md
|
||||
- docs/sdk/models/operations/updategroupresponse.md
|
||||
- docs/sdk/models/operations/activateuserrequest.md
|
||||
- docs/sdk/models/operations/activateuserresponsebody.md
|
||||
- docs/sdk/models/operations/activateuserresponse.md
|
||||
- docs/sdk/models/operations/admingetuserrequest.md
|
||||
- docs/sdk/models/operations/approvedby.md
|
||||
- docs/sdk/models/operations/admingetuserexternalids.md
|
||||
@@ -225,31 +329,24 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/admingetuserpenaltycounts.md
|
||||
- docs/sdk/models/operations/tl3requirements.md
|
||||
- docs/sdk/models/operations/admingetuserresponsebody.md
|
||||
- docs/sdk/models/operations/admingetuserresponse.md
|
||||
- docs/sdk/models/operations/queryparamasc.md
|
||||
- docs/sdk/models/operations/flag.md
|
||||
- docs/sdk/models/operations/queryparamorder.md
|
||||
- docs/sdk/models/operations/adminlistusersrequest.md
|
||||
- docs/sdk/models/operations/adminlistusersresponsebody.md
|
||||
- docs/sdk/models/operations/adminlistusersresponse.md
|
||||
- docs/sdk/models/operations/anonymizeuserrequest.md
|
||||
- docs/sdk/models/operations/anonymizeuserresponsebody.md
|
||||
- docs/sdk/models/operations/anonymizeuserresponse.md
|
||||
- docs/sdk/models/operations/changepasswordrequestbody.md
|
||||
- docs/sdk/models/operations/changepasswordrequest.md
|
||||
- docs/sdk/models/operations/changepasswordresponse.md
|
||||
- docs/sdk/models/operations/externalids.md
|
||||
- docs/sdk/models/operations/createuserrequestbody.md
|
||||
- docs/sdk/models/operations/createuserrequest.md
|
||||
- docs/sdk/models/operations/createuserresponsebody.md
|
||||
- docs/sdk/models/operations/createuserresponse.md
|
||||
- docs/sdk/models/operations/deactivateuserrequest.md
|
||||
- docs/sdk/models/operations/deactivateuserresponsebody.md
|
||||
- docs/sdk/models/operations/deactivateuserresponse.md
|
||||
- docs/sdk/models/operations/deleteuserrequestbody.md
|
||||
- docs/sdk/models/operations/deleteuserrequest.md
|
||||
- docs/sdk/models/operations/deleteuserresponsebody.md
|
||||
- docs/sdk/models/operations/deleteuserresponse.md
|
||||
- docs/sdk/models/operations/getuserrequest.md
|
||||
- docs/sdk/models/operations/getusercustomfields.md
|
||||
- docs/sdk/models/operations/groupusers.md
|
||||
@@ -260,10 +357,8 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/useroption.md
|
||||
- docs/sdk/models/operations/user.md
|
||||
- docs/sdk/models/operations/getuserresponsebody.md
|
||||
- docs/sdk/models/operations/getuserresponse.md
|
||||
- docs/sdk/models/operations/getuseremailsrequest.md
|
||||
- docs/sdk/models/operations/getuseremailsresponsebody.md
|
||||
- docs/sdk/models/operations/getuseremailsresponse.md
|
||||
- docs/sdk/models/operations/getuserexternalidrequest.md
|
||||
- docs/sdk/models/operations/getuserexternalidcustomfields.md
|
||||
- docs/sdk/models/operations/getuserexternalidgroupusers.md
|
||||
@@ -274,7 +369,6 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/getuserexternaliduseroption.md
|
||||
- docs/sdk/models/operations/getuserexternaliduser.md
|
||||
- docs/sdk/models/operations/getuserexternalidresponsebody.md
|
||||
- docs/sdk/models/operations/getuserexternalidresponse.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md
|
||||
@@ -285,11 +379,9 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidresponse.md
|
||||
- docs/sdk/models/operations/listuseractionsrequest.md
|
||||
- docs/sdk/models/operations/useractions.md
|
||||
- docs/sdk/models/operations/listuseractionsresponsebody.md
|
||||
- docs/sdk/models/operations/listuseractionsresponse.md
|
||||
- docs/sdk/models/operations/asc.md
|
||||
- docs/sdk/models/operations/order.md
|
||||
- docs/sdk/models/operations/period.md
|
||||
@@ -298,59 +390,48 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/directoryitems.md
|
||||
- docs/sdk/models/operations/listuserspublicmeta.md
|
||||
- docs/sdk/models/operations/listuserspublicresponsebody.md
|
||||
- docs/sdk/models/operations/listuserspublicresponse.md
|
||||
- docs/sdk/models/operations/logoutuserrequest.md
|
||||
- docs/sdk/models/operations/logoutuserresponsebody.md
|
||||
- docs/sdk/models/operations/logoutuserresponse.md
|
||||
- docs/sdk/models/operations/refreshgravatarrequest.md
|
||||
- docs/sdk/models/operations/refreshgravatarresponsebody.md
|
||||
- docs/sdk/models/operations/refreshgravatarresponse.md
|
||||
- docs/sdk/models/operations/sendpasswordresetemailrequestbody.md
|
||||
- docs/sdk/models/operations/sendpasswordresetemailresponsebody.md
|
||||
- docs/sdk/models/operations/sendpasswordresetemailresponse.md
|
||||
- docs/sdk/models/operations/silenceuserrequestbody.md
|
||||
- docs/sdk/models/operations/silenceuserrequest.md
|
||||
- docs/sdk/models/operations/silencedby.md
|
||||
- docs/sdk/models/operations/silence.md
|
||||
- docs/sdk/models/operations/silenceuserresponsebody.md
|
||||
- docs/sdk/models/operations/silenceuserresponse.md
|
||||
- docs/sdk/models/operations/suspenduserrequestbody.md
|
||||
- docs/sdk/models/operations/suspenduserrequest.md
|
||||
- docs/sdk/models/operations/suspendedby.md
|
||||
- docs/sdk/models/operations/suspension.md
|
||||
- docs/sdk/models/operations/suspenduserresponsebody.md
|
||||
- docs/sdk/models/operations/suspenduserresponse.md
|
||||
- docs/sdk/models/operations/updateavatartype.md
|
||||
- docs/sdk/models/operations/updateavatarrequestbody.md
|
||||
- docs/sdk/models/operations/updateavatarrequest.md
|
||||
- docs/sdk/models/operations/updateavatarresponsebody.md
|
||||
- docs/sdk/models/operations/updateavatarresponse.md
|
||||
- docs/sdk/models/operations/updateemailrequestbody.md
|
||||
- docs/sdk/models/operations/updateemailrequest.md
|
||||
- docs/sdk/models/operations/updateemailresponse.md
|
||||
- docs/sdk/models/operations/updateuserexternalids.md
|
||||
- docs/sdk/models/operations/updateuserrequestbody.md
|
||||
- docs/sdk/models/operations/updateuserrequest.md
|
||||
- docs/sdk/models/operations/updateuseruser.md
|
||||
- docs/sdk/models/operations/updateuserresponsebody.md
|
||||
- docs/sdk/models/operations/updateuserresponse.md
|
||||
- docs/sdk/models/operations/updateusernamerequestbody.md
|
||||
- docs/sdk/models/operations/updateusernamerequest.md
|
||||
- docs/sdk/models/operations/updateusernameresponse.md
|
||||
- docs/sdk/models/operations/permissions.md
|
||||
- docs/sdk/models/operations/createcategoryrequestbody.md
|
||||
- docs/sdk/models/operations/customfields.md
|
||||
- docs/sdk/models/operations/grouppermissions.md
|
||||
- docs/sdk/models/operations/requiredtaggroups.md
|
||||
- docs/sdk/models/operations/category.md
|
||||
- docs/sdk/models/operations/createcategoryresponsebody.md
|
||||
- docs/sdk/models/operations/createcategoryresponse.md
|
||||
- docs/sdk/models/operations/getcategoryrequest.md
|
||||
- docs/sdk/models/operations/getcategorycustomfields.md
|
||||
- docs/sdk/models/operations/getcategorygrouppermissions.md
|
||||
- docs/sdk/models/operations/getcategoryrequiredtaggroups.md
|
||||
- docs/sdk/models/operations/getcategorycategory.md
|
||||
- docs/sdk/models/operations/getcategoryresponsebody.md
|
||||
- docs/sdk/models/operations/getcategoryresponse.md
|
||||
- docs/sdk/models/operations/archetypes.md
|
||||
- docs/sdk/models/operations/getsiterequiredtaggroups.md
|
||||
- docs/sdk/models/operations/getsitecategories.md
|
||||
@@ -370,19 +451,17 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/userthemes.md
|
||||
- docs/sdk/models/operations/usertips.md
|
||||
- docs/sdk/models/operations/getsiteresponsebody.md
|
||||
- docs/sdk/models/operations/getsiteresponse.md
|
||||
- docs/sdk/models/operations/listcategoriesrequest.md
|
||||
- docs/sdk/models/operations/categories.md
|
||||
- docs/sdk/models/operations/categorylist.md
|
||||
- docs/sdk/models/operations/listcategoriesresponsebody.md
|
||||
- docs/sdk/models/operations/listcategoriesresponse.md
|
||||
- docs/sdk/models/operations/listcategorytopicsrequest.md
|
||||
- docs/sdk/models/operations/listcategorytopicsposters.md
|
||||
- docs/sdk/models/operations/topics.md
|
||||
- docs/sdk/models/operations/topiclist.md
|
||||
- docs/sdk/models/operations/users.md
|
||||
- docs/sdk/models/operations/listcategorytopicsresponsebody.md
|
||||
- docs/sdk/models/operations/listcategorytopicsresponse.md
|
||||
- docs/sdk/models/operations/updatecategorypermissions.md
|
||||
- docs/sdk/models/operations/updatecategoryrequestbody.md
|
||||
- docs/sdk/models/operations/updatecategoryrequest.md
|
||||
- docs/sdk/models/operations/updatecategorycustomfields.md
|
||||
@@ -390,26 +469,20 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/updatecategoryrequiredtaggroups.md
|
||||
- docs/sdk/models/operations/updatecategorycategory.md
|
||||
- docs/sdk/models/operations/updatecategoryresponsebody.md
|
||||
- docs/sdk/models/operations/updatecategoryresponse.md
|
||||
- docs/sdk/models/operations/createinviterequestbody.md
|
||||
- docs/sdk/models/operations/createinviterequest.md
|
||||
- docs/sdk/models/operations/createinviteresponsebody.md
|
||||
- docs/sdk/models/operations/createinviteresponse.md
|
||||
- docs/sdk/models/operations/invitetotopicrequestbody.md
|
||||
- docs/sdk/models/operations/invitetotopicrequest.md
|
||||
- docs/sdk/models/operations/invitetotopicuser.md
|
||||
- docs/sdk/models/operations/invitetotopicresponsebody.md
|
||||
- docs/sdk/models/operations/invitetotopicresponse.md
|
||||
- docs/sdk/models/operations/bookmarktopicrequest.md
|
||||
- docs/sdk/models/operations/bookmarktopicresponse.md
|
||||
- docs/sdk/models/operations/createtopicpostpmrequestbody.md
|
||||
- docs/sdk/models/operations/createtopicpostpmactionssummary.md
|
||||
- docs/sdk/models/operations/createtopicpostpmresponsebody.md
|
||||
- docs/sdk/models/operations/createtopicpostpmresponse.md
|
||||
- docs/sdk/models/operations/createtopictimerrequestbody.md
|
||||
- docs/sdk/models/operations/createtopictimerrequest.md
|
||||
- docs/sdk/models/operations/createtopictimerresponsebody.md
|
||||
- docs/sdk/models/operations/createtopictimerresponse.md
|
||||
- docs/sdk/models/operations/gettopicrequest.md
|
||||
- docs/sdk/models/operations/gettopicactionssummary.md
|
||||
- docs/sdk/models/operations/createdby.md
|
||||
@@ -426,92 +499,75 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/suggestedtopics.md
|
||||
- docs/sdk/models/operations/tagsdescriptions.md
|
||||
- docs/sdk/models/operations/gettopicresponsebody.md
|
||||
- docs/sdk/models/operations/gettopicresponse.md
|
||||
- docs/sdk/models/operations/gettopicbyexternalidrequest.md
|
||||
- docs/sdk/models/operations/gettopicbyexternalidresponse.md
|
||||
- docs/sdk/models/operations/listlatesttopicsrequest.md
|
||||
- docs/sdk/models/operations/listlatesttopicsposters.md
|
||||
- docs/sdk/models/operations/listlatesttopicstopics.md
|
||||
- docs/sdk/models/operations/listlatesttopicstopiclist.md
|
||||
- docs/sdk/models/operations/listlatesttopicsusers.md
|
||||
- docs/sdk/models/operations/listlatesttopicsresponsebody.md
|
||||
- docs/sdk/models/operations/listlatesttopicsresponse.md
|
||||
- docs/sdk/models/operations/listtoptopicsrequest.md
|
||||
- docs/sdk/models/operations/listtoptopicsposters.md
|
||||
- docs/sdk/models/operations/listtoptopicstopics.md
|
||||
- docs/sdk/models/operations/listtoptopicstopiclist.md
|
||||
- docs/sdk/models/operations/listtoptopicsusers.md
|
||||
- docs/sdk/models/operations/listtoptopicsresponsebody.md
|
||||
- docs/sdk/models/operations/listtoptopicsresponse.md
|
||||
- docs/sdk/models/operations/removetopicrequest.md
|
||||
- docs/sdk/models/operations/removetopicresponse.md
|
||||
- docs/sdk/models/operations/notificationlevel.md
|
||||
- docs/sdk/models/operations/setnotificationlevelrequestbody.md
|
||||
- docs/sdk/models/operations/setnotificationlevelrequest.md
|
||||
- docs/sdk/models/operations/setnotificationlevelresponsebody.md
|
||||
- docs/sdk/models/operations/setnotificationlevelresponse.md
|
||||
- docs/sdk/models/operations/topic.md
|
||||
- docs/sdk/models/operations/updatetopicrequestbody.md
|
||||
- docs/sdk/models/operations/updatetopicrequest.md
|
||||
- docs/sdk/models/operations/basictopic.md
|
||||
- docs/sdk/models/operations/updatetopicresponsebody.md
|
||||
- docs/sdk/models/operations/updatetopicresponse.md
|
||||
- docs/sdk/models/operations/enabled.md
|
||||
- docs/sdk/models/operations/status.md
|
||||
- docs/sdk/models/operations/updatetopicstatusrequestbody.md
|
||||
- docs/sdk/models/operations/updatetopicstatusrequest.md
|
||||
- docs/sdk/models/operations/updatetopicstatusresponsebody.md
|
||||
- docs/sdk/models/operations/updatetopicstatusresponse.md
|
||||
- docs/sdk/models/operations/updatetopictimestamprequestbody.md
|
||||
- docs/sdk/models/operations/updatetopictimestamprequest.md
|
||||
- docs/sdk/models/operations/updatetopictimestampresponsebody.md
|
||||
- docs/sdk/models/operations/updatetopictimestampresponse.md
|
||||
- docs/sdk/models/operations/data.md
|
||||
- docs/sdk/models/operations/notifications.md
|
||||
- docs/sdk/models/operations/getnotificationsresponsebody.md
|
||||
- docs/sdk/models/operations/getnotificationsresponse.md
|
||||
- docs/sdk/models/operations/marknotificationsasreadrequestbody.md
|
||||
- docs/sdk/models/operations/marknotificationsasreadresponsebody.md
|
||||
- docs/sdk/models/operations/marknotificationsasreadresponse.md
|
||||
- docs/sdk/models/operations/deletepostrequestbody.md
|
||||
- docs/sdk/models/operations/deletepostrequest.md
|
||||
- docs/sdk/models/operations/deletepostresponse.md
|
||||
- docs/sdk/models/operations/getpostrequest.md
|
||||
- docs/sdk/models/operations/getpostresponse.md
|
||||
- docs/sdk/models/operations/actionssummary.md
|
||||
- docs/sdk/models/operations/getpostresponsebody.md
|
||||
- docs/sdk/models/operations/listpostsrequest.md
|
||||
- docs/sdk/models/operations/listpostsactionssummary.md
|
||||
- docs/sdk/models/operations/latestposts.md
|
||||
- docs/sdk/models/operations/listpostsresponsebody.md
|
||||
- docs/sdk/models/operations/listpostsresponse.md
|
||||
- docs/sdk/models/operations/lockpostrequestbody.md
|
||||
- docs/sdk/models/operations/lockpostrequest.md
|
||||
- docs/sdk/models/operations/lockpostresponsebody.md
|
||||
- docs/sdk/models/operations/lockpostresponse.md
|
||||
- docs/sdk/models/operations/performpostactionrequestbody.md
|
||||
- docs/sdk/models/operations/performpostactionrequest.md
|
||||
- docs/sdk/models/operations/actionssummary.md
|
||||
- docs/sdk/models/operations/performpostactionactionssummary.md
|
||||
- docs/sdk/models/operations/notice.md
|
||||
- docs/sdk/models/operations/performpostactionresponsebody.md
|
||||
- docs/sdk/models/operations/performpostactionresponse.md
|
||||
- docs/sdk/models/operations/postrepliesrequest.md
|
||||
- docs/sdk/models/operations/postrepliesactionssummary.md
|
||||
- docs/sdk/models/operations/replytouser.md
|
||||
- docs/sdk/models/operations/postrepliesresponsebody.md
|
||||
- docs/sdk/models/operations/postrepliesresponse.md
|
||||
- docs/sdk/models/operations/post.md
|
||||
- docs/sdk/models/operations/updatepostrequestbody.md
|
||||
- docs/sdk/models/operations/updatepostrequest.md
|
||||
- docs/sdk/models/operations/updatepostactionssummary.md
|
||||
- docs/sdk/models/operations/updatepostpost.md
|
||||
- docs/sdk/models/operations/updatepostresponsebody.md
|
||||
- docs/sdk/models/operations/updatepostresponse.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagesrequest.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagesposters.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagestopics.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagestopiclist.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagesusers.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md
|
||||
- docs/sdk/models/operations/getusersentprivatemessagesresponse.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesrequest.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesparticipants.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesposters.md
|
||||
@@ -519,16 +575,13 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/listuserprivatemessagestopiclist.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesusers.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesresponsebody.md
|
||||
- docs/sdk/models/operations/listuserprivatemessagesresponse.md
|
||||
- docs/sdk/models/operations/searchrequest.md
|
||||
- docs/sdk/models/operations/groupedsearchresult.md
|
||||
- docs/sdk/models/operations/searchresponsebody.md
|
||||
- docs/sdk/models/operations/searchresponse.md
|
||||
- docs/sdk/models/operations/createtaggrouprequestbody.md
|
||||
- docs/sdk/models/operations/permissions.md
|
||||
- docs/sdk/models/operations/createtaggrouppermissions.md
|
||||
- docs/sdk/models/operations/taggroup.md
|
||||
- docs/sdk/models/operations/createtaggroupresponsebody.md
|
||||
- docs/sdk/models/operations/createtaggroupresponse.md
|
||||
- docs/sdk/models/operations/gettagrequest.md
|
||||
- docs/sdk/models/operations/gettagtags.md
|
||||
- docs/sdk/models/operations/gettagposters.md
|
||||
@@ -536,56 +589,45 @@ generatedFiles:
|
||||
- docs/sdk/models/operations/gettagtopiclist.md
|
||||
- docs/sdk/models/operations/gettagusers.md
|
||||
- docs/sdk/models/operations/gettagresponsebody.md
|
||||
- docs/sdk/models/operations/gettagresponse.md
|
||||
- docs/sdk/models/operations/gettaggrouprequest.md
|
||||
- docs/sdk/models/operations/gettaggrouppermissions.md
|
||||
- docs/sdk/models/operations/gettaggrouptaggroup.md
|
||||
- docs/sdk/models/operations/gettaggroupresponsebody.md
|
||||
- docs/sdk/models/operations/gettaggroupresponse.md
|
||||
- docs/sdk/models/operations/listtaggroupspermissions.md
|
||||
- docs/sdk/models/operations/taggroups.md
|
||||
- docs/sdk/models/operations/listtaggroupsresponsebody.md
|
||||
- docs/sdk/models/operations/listtaggroupsresponse.md
|
||||
- docs/sdk/models/operations/listtagsextras.md
|
||||
- docs/sdk/models/operations/tags.md
|
||||
- docs/sdk/models/operations/listtagsresponsebody.md
|
||||
- docs/sdk/models/operations/listtagsresponse.md
|
||||
- docs/sdk/models/operations/updatetaggrouprequestbody.md
|
||||
- docs/sdk/models/operations/updatetaggrouprequest.md
|
||||
- docs/sdk/models/operations/updatetaggrouppermissions.md
|
||||
- docs/sdk/models/operations/updatetaggrouptaggroup.md
|
||||
- docs/sdk/models/operations/updatetaggroupresponsebody.md
|
||||
- docs/sdk/models/operations/updatetaggroupresponse.md
|
||||
- docs/sdk/models/operations/abortmultipartrequestbody.md
|
||||
- docs/sdk/models/operations/abortmultipartresponsebody.md
|
||||
- docs/sdk/models/operations/abortmultipartresponse.md
|
||||
- docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md
|
||||
- docs/sdk/models/operations/presignedurls.md
|
||||
- docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md
|
||||
- docs/sdk/models/operations/batchpresignmultipartpartsresponse.md
|
||||
- docs/sdk/models/operations/completeexternaluploadrequestbody.md
|
||||
- docs/sdk/models/operations/completeexternaluploadresponsebody.md
|
||||
- docs/sdk/models/operations/completeexternaluploadresponse.md
|
||||
- docs/sdk/models/operations/completemultipartrequestbody.md
|
||||
- docs/sdk/models/operations/completemultipartresponsebody.md
|
||||
- docs/sdk/models/operations/completemultipartresponse.md
|
||||
- docs/sdk/models/operations/metadata.md
|
||||
- docs/sdk/models/operations/uploadtype.md
|
||||
- docs/sdk/models/operations/createmultipartuploadrequestbody.md
|
||||
- docs/sdk/models/operations/createmultipartuploadresponsebody.md
|
||||
- docs/sdk/models/operations/createmultipartuploadresponse.md
|
||||
- docs/sdk/models/operations/file.md
|
||||
- docs/sdk/models/operations/typet.md
|
||||
- docs/sdk/models/operations/filet.md
|
||||
- docs/sdk/models/operations/type.md
|
||||
- docs/sdk/models/operations/createuploadrequestbody.md
|
||||
- docs/sdk/models/operations/createuploadresponsebody.md
|
||||
- docs/sdk/models/operations/createuploadresponse.md
|
||||
- docs/sdk/models/operations/generatepresignedputmetadata.md
|
||||
- docs/sdk/models/operations/generatepresignedputtype.md
|
||||
- docs/sdk/models/operations/generatepresignedputrequestbody.md
|
||||
- docs/sdk/models/operations/signedheaders.md
|
||||
- docs/sdk/models/operations/generatepresignedputresponsebody.md
|
||||
- docs/sdk/models/operations/generatepresignedputresponse.md
|
||||
- docs/sdks/sdk/README.md
|
||||
- docs/lib/utils/retryconfig.md
|
||||
- docs/sdks/backups/README.md
|
||||
- docs/sdks/badges/README.md
|
||||
- docs/sdks/groups/README.md
|
||||
@@ -603,3 +645,7 @@ generatedFiles:
|
||||
- docs/sdks/uploads/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
- src/hooks/hooks.ts
|
||||
- src/hooks/types.ts
|
||||
- src/hooks/index.ts
|
||||
- CONTRIBUTING.md
|
||||
|
||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Contributing to This Repository
|
||||
|
||||
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||
|
||||
## How to Report Issues
|
||||
|
||||
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||
|
||||
- A clear and descriptive title
|
||||
- Steps to reproduce the issue
|
||||
- Expected and actual behavior
|
||||
- Any relevant logs, screenshots, or error messages
|
||||
- Information about your environment (e.g., operating system, software versions)
|
||||
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||
|
||||
## Issue Triage and Upstream Fixes
|
||||
|
||||
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||
|
||||
## Contact
|
||||
|
||||
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||
|
||||
Thank you for your understanding and cooperation!
|
||||
|
||||
The Maintainers
|
||||
245
README.md
245
README.md
@@ -16,10 +16,25 @@
|
||||
npm add @lukehagar/discoursejs
|
||||
```
|
||||
|
||||
### PNPM
|
||||
|
||||
```bash
|
||||
pnpm add @lukehagar/discoursejs
|
||||
```
|
||||
|
||||
### Bun
|
||||
|
||||
```bash
|
||||
bun add @lukehagar/discoursejs
|
||||
```
|
||||
|
||||
### Yarn
|
||||
|
||||
```bash
|
||||
yarn add @lukehagar/discoursejs
|
||||
yarn add @lukehagar/discoursejs zod
|
||||
|
||||
# Note that Yarn does not install peer dependencies automatically. You will need
|
||||
# to install zod as shown above.
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
@@ -31,16 +46,13 @@ yarn add @lukehagar/discoursejs
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
const sdk = new SDK();
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
const result = await sdk.backups.createBackup();
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -200,35 +212,42 @@ run();
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
||||
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
Example
|
||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||
|
||||
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
import { SDKValidationError } from "@lukehagar/discoursejs/sdk/models/errors";
|
||||
|
||||
const sdk = new SDK();
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
|
||||
let res;
|
||||
let result;
|
||||
try {
|
||||
res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
result = await sdk.backups.createBackup();
|
||||
} catch (err) {
|
||||
if (err instanceof errors.SDKError) {
|
||||
console.error(err); // handle exception
|
||||
switch (true) {
|
||||
case err instanceof SDKValidationError: {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -241,29 +260,24 @@ run();
|
||||
|
||||
### Select Server by Index
|
||||
|
||||
You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `https://{defaultHost}` | `defaultHost` (default is `discourse.example.com`) |
|
||||
|
||||
#### Example
|
||||
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK({
|
||||
const sdk = new SDK({
|
||||
serverIdx: 0,
|
||||
});
|
||||
});
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
async function run() {
|
||||
const result = await sdk.backups.createBackup();
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -277,22 +291,20 @@ Some of the server options above contain variables. If you want to set the value
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
||||
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK({
|
||||
const sdk = new SDK({
|
||||
serverURL: "https://{defaultHost}",
|
||||
});
|
||||
});
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
async function run() {
|
||||
const result = await sdk.backups.createBackup();
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -303,22 +315,151 @@ run();
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
|
||||
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
||||
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
||||
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
||||
around the request lifecycle that can be used to modify the request or handle
|
||||
errors and response.
|
||||
|
||||
For example, you could specify a header for every request that your sdk makes as follows:
|
||||
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
||||
used to integrate a third-party HTTP client or when writing tests to mock out
|
||||
the HTTP client and feed in fixtures.
|
||||
|
||||
The following example shows how to use the `"beforeRequest"` hook to to add a
|
||||
custom header and a timeout to requests and how to use the `"requestError"` hook
|
||||
to log errors:
|
||||
|
||||
```typescript
|
||||
import { @lukehagar/discoursejs } from "SDK";
|
||||
import axios from "axios";
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
import { HTTPClient } from "@lukehagar/discoursejs/lib/http";
|
||||
|
||||
const httpClient = axios.create({
|
||||
headers: {'x-custom-header': 'someValue'}
|
||||
})
|
||||
const httpClient = new HTTPClient({
|
||||
// fetcher takes a function that has the same signature as native `fetch`.
|
||||
fetcher: (request) => {
|
||||
return fetch(request);
|
||||
}
|
||||
});
|
||||
|
||||
const sdk = new SDK({defaultClient: httpClient});
|
||||
httpClient.addHook("beforeRequest", (request) => {
|
||||
const nextRequest = new Request(request, {
|
||||
signal: request.signal || AbortSignal.timeout(5000)
|
||||
});
|
||||
|
||||
nextRequest.headers.set("x-custom-header", "custom value");
|
||||
|
||||
return nextRequest;
|
||||
});
|
||||
|
||||
httpClient.addHook("requestError", (error, request) => {
|
||||
console.group("Request Error");
|
||||
console.log("Reason:", `${error}`);
|
||||
console.log("Endpoint:", `${request.method} ${request.url}`);
|
||||
console.groupEnd();
|
||||
});
|
||||
|
||||
const sdk = new SDK({ httpClient });
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Start Requirements [requirements] -->
|
||||
## Requirements
|
||||
|
||||
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||
<!-- End Requirements [requirements] -->
|
||||
|
||||
<!-- Start File uploads [file-upload] -->
|
||||
## File uploads
|
||||
|
||||
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
|
||||
>
|
||||
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
|
||||
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
|
||||
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
|
||||
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
|
||||
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
const sdk = new SDK();
|
||||
|
||||
async function run() {
|
||||
const result = await sdk.uploads.createUpload();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End File uploads [file-upload] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
||||
|
||||
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
const sdk = new SDK();
|
||||
|
||||
async function run() {
|
||||
const result = await sdk.backups.createBackup({
|
||||
retries: {
|
||||
strategy: "backoff",
|
||||
backoff: {
|
||||
initialInterval: 1,
|
||||
maxInterval: 50,
|
||||
exponent: 1.1,
|
||||
maxElapsedTime: 100,
|
||||
},
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
const sdk = new SDK({
|
||||
retryConfig: {
|
||||
strategy: "backoff",
|
||||
backoff: {
|
||||
initialInterval: 1,
|
||||
maxInterval: 50,
|
||||
exponent: 1.1,
|
||||
maxElapsedTime: 100,
|
||||
},
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await sdk.backups.createBackup();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Retries [retries] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
10
RELEASES.md
10
RELEASES.md
@@ -169,3 +169,13 @@ Based on:
|
||||
- [typescript v0.4.10] .
|
||||
### Releases
|
||||
- [NPM v0.4.10] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.4.10 - .
|
||||
|
||||
## 2024-08-09 00:22:32
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc latest
|
||||
- Speakeasy CLI 1.358.0 (2.390.6) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.5.0] .
|
||||
### Releases
|
||||
- [NPM v0.5.0] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.5.0 - .
|
||||
22
RUNTIMES.md
Normal file
22
RUNTIMES.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Supported JavaScript runtimes
|
||||
|
||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
||||
|
||||
* [Web Fetch API][web-fetch]
|
||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||
|
||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||
|
||||
Runtime environments that are explicitly supported are:
|
||||
|
||||
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||
- Node.js active and maintenance LTS releases
|
||||
- Currently, this is v18 and v20
|
||||
- Bun v1 and above
|
||||
- Deno v1.39
|
||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||
|
||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||
13
USAGE.md
13
USAGE.md
@@ -2,16 +2,13 @@
|
||||
```typescript
|
||||
import { SDK } from "@lukehagar/discoursejs";
|
||||
|
||||
const sdk = new SDK();
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
const result = await sdk.backups.createBackup();
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
24
docs/lib/utils/retryconfig.md
Normal file
24
docs/lib/utils/retryconfig.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# RetryConfig
|
||||
|
||||
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Description | Example |
|
||||
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
||||
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
||||
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
||||
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
||||
|
||||
## BackoffStrategy
|
||||
|
||||
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
||||
|
||||
### Fields
|
||||
|
||||
| Name | Type | Description | Example |
|
||||
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
||||
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
||||
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
||||
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
||||
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AbortMultipartResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AbortMultipartResponseBody](../../../sdk/models/operations/abortmultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
@@ -4,8 +4,9 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `acted` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `canAct` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `canUndo` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `count` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | `2`: like, `3`, `4`, `6`, `7`, `8`: flag |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ActivateUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ActivateUserResponseBody](../../../sdk/models/operations/activateuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.AddGroupMembersRequestBody](../../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddGroupMembersResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AddGroupMembersResponseBody](../../../sdk/models/operations/addgroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AdminGetUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AdminGetUserResponseBody](../../../sdk/models/operations/admingetuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AdminListBadgesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AdminListBadgesResponseBody](../../../sdk/models/operations/adminlistbadgesresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AdminListUsersResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `responseBodies` | [operations.AdminListUsersResponseBody](../../../sdk/models/operations/adminlistusersresponsebody.md)[] | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AnonymizeUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AnonymizeUserResponseBody](../../../sdk/models/operations/anonymizeuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# BatchPresignMultipartPartsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.BatchPresignMultipartPartsResponseBody](../../../sdk/models/operations/batchpresignmultipartpartsresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
@@ -1,10 +0,0 @@
|
||||
# BookmarkTopicResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `token` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.ChangePasswordRequestBody](../../../sdk/models/operations/changepasswordrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `token` | *string* | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ChangePasswordResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CompleteExternalUploadResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CompleteExternalUploadResponseBody](../../../sdk/models/operations/completeexternaluploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CompleteMultipartResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CompleteMultipartResponseBody](../../../sdk/models/operations/completemultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateBackupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateBackupResponseBody](../../../sdk/models/operations/createbackupresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateBadgeResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateBadgeResponseBody](../../../sdk/models/operations/createbadgeresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -4,13 +4,13 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `allowBadges` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `color` | *string* | :heavy_minus_sign: | N/A | 49d9e9 |
|
||||
| `formTemplateIds` | *any*[] | :heavy_minus_sign: | N/A | |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `parentCategoryId` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `permissions` | Record<string, *any*> | :heavy_minus_sign: | N/A | |
|
||||
| `permissions` | [operations.Permissions](../../../sdk/models/operations/permissions.md) | :heavy_minus_sign: | N/A | |
|
||||
| `searchPriority` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `slug` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `textColor` | *string* | :heavy_minus_sign: | N/A | f0fcfd |
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateCategoryResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateCategoryResponseBody](../../../sdk/models/operations/createcategoryresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateGroupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateGroupResponseBody](../../../sdk/models/operations/creategroupresponsebody.md) | :heavy_minus_sign: | group created |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateInviteResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateInviteResponseBody](../../../sdk/models/operations/createinviteresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateMultipartUploadResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateMultipartUploadResponseBody](../../../sdk/models/operations/createmultipartuploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
7
docs/sdk/models/operations/createtaggrouppermissions.md
Normal file
7
docs/sdk/models/operations/createtaggrouppermissions.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# CreateTagGroupPermissions
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateTagGroupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateTagGroupResponseBody](../../../sdk/models/operations/createtaggroupresponsebody.md) | :heavy_minus_sign: | tag group created |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateTopicPostPMResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateTopicPostPMResponseBody](../../../sdk/models/operations/createtopicpostpmresponsebody.md) | :heavy_minus_sign: | post created |
|
||||
@@ -7,5 +7,5 @@
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.CreateTopicTimerRequestBody](../../../sdk/models/operations/createtopictimerrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateTopicTimerResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateTopicTimerResponseBody](../../../sdk/models/operations/createtopictimerresponsebody.md) | :heavy_minus_sign: | topic updated |
|
||||
@@ -4,8 +4,8 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `file` | [operations.File](../../../sdk/models/operations/file.md) | :heavy_minus_sign: | N/A |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.Type](../../../sdk/models/operations/type.md) | :heavy_check_mark: | N/A |
|
||||
| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.FileT](../../../sdk/models/operations/filet.md) | :heavy_minus_sign: | N/A |
|
||||
| `synchronous` | *boolean* | :heavy_minus_sign: | Use this flag to return an id and url |
|
||||
| `type` | [operations.TypeT](../../../sdk/models/operations/typet.md) | :heavy_check_mark: | N/A |
|
||||
| `userId` | *number* | :heavy_minus_sign: | required if uploading an avatar |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateUploadResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateUploadResponseBody](../../../sdk/models/operations/createuploadresponsebody.md) | :heavy_minus_sign: | file uploaded |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreateUserResponseBody](../../../sdk/models/operations/createuserresponsebody.md) | :heavy_minus_sign: | user created |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeactivateUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.DeactivateUserResponseBody](../../../sdk/models/operations/deactivateuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeleteBadgeResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeleteGroupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.DeleteGroupResponseBody](../../../sdk/models/operations/deletegroupresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.DeletePostRequestBody](../../../sdk/models/operations/deletepostrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeletePostResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.DeleteUserRequestBody](../../../sdk/models/operations/deleteuserrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeleteUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.DeleteUserResponseBody](../../../sdk/models/operations/deleteuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DownloadBackupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,4 +1,4 @@
|
||||
# File
|
||||
# FileT
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,11 +0,0 @@
|
||||
# GeneratePresignedPutResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GeneratePresignedPutResponseBody](../../../sdk/models/operations/generatepresignedputresponsebody.md) | :heavy_minus_sign: | external upload initialized |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBackupsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `responseBodies` | [operations.ResponseBody](../../../sdk/models/operations/responsebody.md)[] | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetCategoryResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetCategoryResponseBody](../../../sdk/models/operations/getcategoryresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGroupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetGroupResponseBody](../../../sdk/models/operations/getgroupresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetNotificationsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetNotificationsResponseBody](../../../sdk/models/operations/getnotificationsresponsebody.md) | :heavy_minus_sign: | notifications |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetPostResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | Record<string, *any*> | :heavy_minus_sign: | single post |
|
||||
61
docs/sdk/models/operations/getpostresponsebody.md
Normal file
61
docs/sdk/models/operations/getpostresponsebody.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# GetPostResponseBody
|
||||
|
||||
single post
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
||||
| `actionsSummary` | [operations.ActionsSummary](../../../sdk/models/operations/actionssummary.md)[] | :heavy_check_mark: | N/A |
|
||||
| `admin` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `bookmarked` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canDelete` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canRecover` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canSeeHiddenPost` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `canViewEditHistory` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canWiki` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `cooked` | *string* | :heavy_check_mark: | N/A |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `deletedAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `displayUsername` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `editReason` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairGroupId` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `flairName` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `hidden` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `incomingLinkCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `mentionedUsers` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `postNumber` | *number* | :heavy_check_mark: | N/A |
|
||||
| `postType` | *number* | :heavy_check_mark: | N/A |
|
||||
| `primaryGroupName` | *string* | :heavy_check_mark: | N/A |
|
||||
| `quoteCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `raw` | *string* | :heavy_check_mark: | N/A |
|
||||
| `readersCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `reads` | *number* | :heavy_check_mark: | N/A |
|
||||
| `replyCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `replyToPostNumber` | *string* | :heavy_check_mark: | N/A |
|
||||
| `reviewableId` | *string* | :heavy_check_mark: | N/A |
|
||||
| `reviewableScoreCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `reviewableScorePendingCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `score` | *number* | :heavy_check_mark: | N/A |
|
||||
| `staff` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `topicId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicSlug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `updatedAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `userDeleted` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `userId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `userTitle` | *string* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
| `version` | *number* | :heavy_check_mark: | N/A |
|
||||
| `wiki` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `yours` | *boolean* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetSiteResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetSiteResponseBody](../../../sdk/models/operations/getsiteresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetTagGroupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetTagGroupResponseBody](../../../sdk/models/operations/gettaggroupresponsebody.md) | :heavy_minus_sign: | notifications |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetTagResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetTagResponseBody](../../../sdk/models/operations/gettagresponsebody.md) | :heavy_minus_sign: | notifications |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetTopicByExternalIdResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetTopicResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetTopicResponseBody](../../../sdk/models/operations/gettopicresponsebody.md) | :heavy_minus_sign: | specific posts |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserEmailsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetUserEmailsResponseBody](../../../sdk/models/operations/getuseremailsresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserExternalIdResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetUserExternalIdResponseBody](../../../sdk/models/operations/getuserexternalidresponsebody.md) | :heavy_minus_sign: | user response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserIdentiyProviderExternalIdResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetUserIdentiyProviderExternalIdResponseBody](../../../sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md) | :heavy_minus_sign: | user response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetUserResponseBody](../../../sdk/models/operations/getuserresponsebody.md) | :heavy_minus_sign: | user response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserSentPrivateMessagesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetUserSentPrivateMessagesResponseBody](../../../sdk/models/operations/getusersentprivatemessagesresponsebody.md) | :heavy_minus_sign: | private messages |
|
||||
@@ -7,5 +7,5 @@
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.InviteToTopicRequestBody](../../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# InviteToTopicResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.InviteToTopicResponseBody](../../../sdk/models/operations/invitetotopicresponsebody.md) | :heavy_minus_sign: | topic updated |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListCategoriesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListCategoriesResponseBody](../../../sdk/models/operations/listcategoriesresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListCategoryTopicsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListCategoryTopicsResponseBody](../../../sdk/models/operations/listcategorytopicsresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListGroupMembersResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListGroupMembersResponseBody](../../../sdk/models/operations/listgroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListGroupsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListGroupsResponseBody](../../../sdk/models/operations/listgroupsresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListLatestTopicsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListLatestTopicsResponseBody](../../../sdk/models/operations/listlatesttopicsresponsebody.md) | :heavy_minus_sign: | topic updated |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListPostsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListPostsResponseBody](../../../sdk/models/operations/listpostsresponsebody.md) | :heavy_minus_sign: | latest posts |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListTagGroupsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListTagGroupsResponseBody](../../../sdk/models/operations/listtaggroupsresponsebody.md) | :heavy_minus_sign: | tags |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListTagsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListTagsResponseBody](../../../sdk/models/operations/listtagsresponsebody.md) | :heavy_minus_sign: | notifications |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListTopTopicsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListTopTopicsResponseBody](../../../sdk/models/operations/listtoptopicsresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListUserActionsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListUserActionsResponseBody](../../../sdk/models/operations/listuseractionsresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListUserBadgesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListUserBadgesResponseBody](../../../sdk/models/operations/listuserbadgesresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListUserPrivateMessagesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListUserPrivateMessagesResponseBody](../../../sdk/models/operations/listuserprivatemessagesresponsebody.md) | :heavy_minus_sign: | private messages |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `order` | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_check_mark: | N/A |
|
||||
| `period` | [operations.Period](../../../sdk/models/operations/period.md) | :heavy_check_mark: | N/A |
|
||||
| `asc` | [operations.Asc](../../../sdk/models/operations/asc.md) | :heavy_minus_sign: | N/A |
|
||||
| `order` | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_check_mark: | N/A |
|
||||
| `page` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `period` | [operations.Period](../../../sdk/models/operations/period.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ListUsersPublicResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.ListUsersPublicResponseBody](../../../sdk/models/operations/listuserspublicresponsebody.md) | :heavy_minus_sign: | directory items response |
|
||||
@@ -7,5 +7,5 @@
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.LockPostRequestBody](../../../sdk/models/operations/lockpostrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# LockPostResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.LockPostResponseBody](../../../sdk/models/operations/lockpostresponsebody.md) | :heavy_minus_sign: | post updated |
|
||||
@@ -1,11 +0,0 @@
|
||||
# LogOutUserResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.LogOutUserResponseBody](../../../sdk/models/operations/logoutuserresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -1,11 +0,0 @@
|
||||
# MarkNotificationsAsReadResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.MarkNotificationsAsReadResponseBody](../../../sdk/models/operations/marknotificationsasreadresponsebody.md) | :heavy_minus_sign: | notifications marked read |
|
||||
@@ -0,0 +1,11 @@
|
||||
# PerformPostActionActionsSummary
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `acted` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `canUndo` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `count` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# PerformPostActionResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.PerformPostActionResponseBody](../../../sdk/models/operations/performpostactionresponsebody.md) | :heavy_minus_sign: | post updated |
|
||||
@@ -6,8 +6,8 @@ post updated
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `actionsSummary` | [operations.ActionsSummary](../../../sdk/models/operations/actionssummary.md)[] | :heavy_minus_sign: | N/A |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `actionsSummary` | [operations.PerformPostActionActionsSummary](../../../sdk/models/operations/performpostactionactionssummary.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `admin` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `avatarTemplate` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `canDelete` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
|
||||
@@ -3,5 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A | |
|
||||
| `everyone` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `staff` | *number* | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# PostRepliesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `responseBodies` | [operations.PostRepliesResponseBody](../../../sdk/models/operations/postrepliesresponsebody.md)[] | :heavy_minus_sign: | post replies |
|
||||
@@ -1,11 +0,0 @@
|
||||
# RefreshGravatarResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.RefreshGravatarResponseBody](../../../sdk/models/operations/refreshgravatarresponsebody.md) | :heavy_minus_sign: | response |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.RemoveGroupMembersRequestBody](../../../sdk/models/operations/removegroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# RemoveGroupMembersResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.RemoveGroupMembersResponseBody](../../../sdk/models/operations/removegroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,10 +0,0 @@
|
||||
# RemoveTopicResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# SearchResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.SearchResponseBody](../../../sdk/models/operations/searchresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -1,10 +0,0 @@
|
||||
# SendDownloadBackupEmailResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# SendPasswordResetEmailResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.SendPasswordResetEmailResponseBody](../../../sdk/models/operations/sendpasswordresetemailresponsebody.md) | :heavy_minus_sign: | success response |
|
||||
@@ -7,5 +7,5 @@
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.SetNotificationLevelRequestBody](../../../sdk/models/operations/setnotificationlevelrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user