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.134.1
This commit is contained in:
speakeasybot
17
.eslintrc.yml
Normal file
17
.eslintrc.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
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"
|
||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# This allows generated code to be indexed correctly
|
||||
*.ts linguist-generated=false
|
||||
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
dist/
|
||||
node_modules/
|
||||
605
.speakeasy/gen.lock
Executable file
605
.speakeasy/gen.lock
Executable file
@@ -0,0 +1,605 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 599a9576-4665-431e-be1e-44cc13ef28aa
|
||||
management:
|
||||
docChecksum: 172e648f7bfe018e3bb1d9cbe1a74ac8
|
||||
docVersion: latest
|
||||
speakeasyVersion: internal
|
||||
generationVersion: 2.230.3
|
||||
releaseVersion: 0.0.1
|
||||
configChecksum: 34ec4128d780c0452236ce1cce92df9d
|
||||
repoURL: https://github.com/LukeHagar/discoursejs.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/discoursejs
|
||||
published: true
|
||||
features:
|
||||
typescript:
|
||||
core: 3.4.5
|
||||
deprecations: 2.81.1
|
||||
flattening: 2.81.1
|
||||
globalServerURLs: 2.82.1
|
||||
generatedFiles:
|
||||
- src/sdk/backups.ts
|
||||
- src/sdk/badges.ts
|
||||
- src/sdk/groups.ts
|
||||
- src/sdk/users.ts
|
||||
- src/sdk/admin.ts
|
||||
- src/sdk/categories.ts
|
||||
- src/sdk/invites.ts
|
||||
- src/sdk/topics.ts
|
||||
- src/sdk/notifications.ts
|
||||
- src/sdk/posts.ts
|
||||
- src/sdk/privatemessages.ts
|
||||
- src/sdk/search.ts
|
||||
- src/sdk/site.ts
|
||||
- src/sdk/tags.ts
|
||||
- src/sdk/uploads.ts
|
||||
- src/sdk/sdk.ts
|
||||
- .eslintrc.yml
|
||||
- jest.config.js
|
||||
- package-lock.json
|
||||
- package.json
|
||||
- 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/sdk/index.ts
|
||||
- src/sdk/models/errors/sdkerror.ts
|
||||
- src/sdk/types/index.ts
|
||||
- src/sdk/types/rfcdate.ts
|
||||
- tsconfig.json
|
||||
- src/sdk/models/operations/createbackup.ts
|
||||
- src/sdk/models/operations/downloadbackup.ts
|
||||
- src/sdk/models/operations/getbackups.ts
|
||||
- src/sdk/models/operations/senddownloadbackupemail.ts
|
||||
- src/sdk/models/operations/adminlistbadges.ts
|
||||
- src/sdk/models/operations/createbadge.ts
|
||||
- src/sdk/models/operations/deletebadge.ts
|
||||
- src/sdk/models/operations/listuserbadges.ts
|
||||
- src/sdk/models/operations/updatebadge.ts
|
||||
- src/sdk/models/operations/addgroupmembers.ts
|
||||
- src/sdk/models/operations/creategroup.ts
|
||||
- src/sdk/models/operations/deletegroup.ts
|
||||
- src/sdk/models/operations/getgroup.ts
|
||||
- src/sdk/models/operations/listgroupmembers.ts
|
||||
- src/sdk/models/operations/listgroups.ts
|
||||
- src/sdk/models/operations/removegroupmembers.ts
|
||||
- src/sdk/models/operations/updategroup.ts
|
||||
- src/sdk/models/operations/activateuser.ts
|
||||
- src/sdk/models/operations/admingetuser.ts
|
||||
- src/sdk/models/operations/adminlistusers.ts
|
||||
- src/sdk/models/operations/anonymizeuser.ts
|
||||
- src/sdk/models/operations/changepassword.ts
|
||||
- src/sdk/models/operations/createuser.ts
|
||||
- src/sdk/models/operations/deactivateuser.ts
|
||||
- src/sdk/models/operations/deleteuser.ts
|
||||
- src/sdk/models/operations/getuser.ts
|
||||
- src/sdk/models/operations/getuseremails.ts
|
||||
- src/sdk/models/operations/getuserexternalid.ts
|
||||
- src/sdk/models/operations/getuseridentiyproviderexternalid.ts
|
||||
- src/sdk/models/operations/listuseractions.ts
|
||||
- src/sdk/models/operations/listuserspublic.ts
|
||||
- src/sdk/models/operations/logoutuser.ts
|
||||
- src/sdk/models/operations/refreshgravatar.ts
|
||||
- src/sdk/models/operations/sendpasswordresetemail.ts
|
||||
- src/sdk/models/operations/silenceuser.ts
|
||||
- src/sdk/models/operations/suspenduser.ts
|
||||
- src/sdk/models/operations/updateavatar.ts
|
||||
- src/sdk/models/operations/updateemail.ts
|
||||
- src/sdk/models/operations/updateuser.ts
|
||||
- src/sdk/models/operations/updateusername.ts
|
||||
- src/sdk/models/operations/createcategory.ts
|
||||
- src/sdk/models/operations/getcategory.ts
|
||||
- src/sdk/models/operations/getsite.ts
|
||||
- src/sdk/models/operations/listcategories.ts
|
||||
- src/sdk/models/operations/listcategorytopics.ts
|
||||
- src/sdk/models/operations/updatecategory.ts
|
||||
- src/sdk/models/operations/createinvite.ts
|
||||
- src/sdk/models/operations/invitetotopic.ts
|
||||
- src/sdk/models/operations/bookmarktopic.ts
|
||||
- src/sdk/models/operations/createtopicpostpm.ts
|
||||
- src/sdk/models/operations/createtopictimer.ts
|
||||
- src/sdk/models/operations/gettopic.ts
|
||||
- src/sdk/models/operations/gettopicbyexternalid.ts
|
||||
- src/sdk/models/operations/listlatesttopics.ts
|
||||
- src/sdk/models/operations/listtoptopics.ts
|
||||
- src/sdk/models/operations/removetopic.ts
|
||||
- src/sdk/models/operations/setnotificationlevel.ts
|
||||
- src/sdk/models/operations/updatetopic.ts
|
||||
- src/sdk/models/operations/updatetopicstatus.ts
|
||||
- src/sdk/models/operations/updatetopictimestamp.ts
|
||||
- src/sdk/models/operations/getnotifications.ts
|
||||
- src/sdk/models/operations/marknotificationsasread.ts
|
||||
- src/sdk/models/operations/deletepost.ts
|
||||
- src/sdk/models/operations/getpost.ts
|
||||
- src/sdk/models/operations/listposts.ts
|
||||
- src/sdk/models/operations/lockpost.ts
|
||||
- src/sdk/models/operations/performpostaction.ts
|
||||
- src/sdk/models/operations/postreplies.ts
|
||||
- src/sdk/models/operations/updatepost.ts
|
||||
- src/sdk/models/operations/getusersentprivatemessages.ts
|
||||
- src/sdk/models/operations/listuserprivatemessages.ts
|
||||
- src/sdk/models/operations/search.ts
|
||||
- src/sdk/models/operations/createtaggroup.ts
|
||||
- src/sdk/models/operations/gettag.ts
|
||||
- src/sdk/models/operations/gettaggroup.ts
|
||||
- src/sdk/models/operations/listtaggroups.ts
|
||||
- src/sdk/models/operations/listtags.ts
|
||||
- src/sdk/models/operations/updatetaggroup.ts
|
||||
- src/sdk/models/operations/abortmultipart.ts
|
||||
- src/sdk/models/operations/batchpresignmultipartparts.ts
|
||||
- src/sdk/models/operations/completeexternalupload.ts
|
||||
- src/sdk/models/operations/completemultipart.ts
|
||||
- src/sdk/models/operations/createmultipartupload.ts
|
||||
- src/sdk/models/operations/createupload.ts
|
||||
- src/sdk/models/operations/generatepresignedput.ts
|
||||
- src/sdk/models/errors/index.ts
|
||||
- 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
|
||||
- docs/sdk/models/operations/admingetusergroups.md
|
||||
- docs/sdk/models/operations/penaltycounts.md
|
||||
- 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
|
||||
- docs/sdk/models/operations/getusergroups.md
|
||||
- docs/sdk/models/operations/userauthtokens.md
|
||||
- docs/sdk/models/operations/userfields.md
|
||||
- docs/sdk/models/operations/usernotificationschedule.md
|
||||
- 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
|
||||
- docs/sdk/models/operations/getuserexternalidgroups.md
|
||||
- docs/sdk/models/operations/getuserexternaliduserauthtokens.md
|
||||
- docs/sdk/models/operations/getuserexternaliduserfields.md
|
||||
- docs/sdk/models/operations/getuserexternalidusernotificationschedule.md
|
||||
- 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
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidgroups.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternaliduserauthtokens.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternaliduserfields.md
|
||||
- docs/sdk/models/operations/getuseridentiyproviderexternalidusernotificationschedule.md
|
||||
- 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
|
||||
- docs/sdk/models/operations/listuserspublicrequest.md
|
||||
- docs/sdk/models/operations/listuserspublicuser.md
|
||||
- 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/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
|
||||
- docs/sdk/models/operations/censoredregexp.md
|
||||
- docs/sdk/models/operations/customemojitranslation.md
|
||||
- docs/sdk/models/operations/defaultdarkcolorscheme.md
|
||||
- docs/sdk/models/operations/getsitegroups.md
|
||||
- docs/sdk/models/operations/hashtagconfigurations.md
|
||||
- docs/sdk/models/operations/hashtagicons.md
|
||||
- docs/sdk/models/operations/markdownadditionaloptions.md
|
||||
- docs/sdk/models/operations/notificationtypes.md
|
||||
- docs/sdk/models/operations/postactiontypes.md
|
||||
- docs/sdk/models/operations/posttypes.md
|
||||
- docs/sdk/models/operations/topicflagtypes.md
|
||||
- docs/sdk/models/operations/trustlevels.md
|
||||
- docs/sdk/models/operations/usercolorschemes.md
|
||||
- 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/updatecategoryrequestbody.md
|
||||
- docs/sdk/models/operations/updatecategoryrequest.md
|
||||
- docs/sdk/models/operations/updatecategorycustomfields.md
|
||||
- docs/sdk/models/operations/updatecategorygrouppermissions.md
|
||||
- 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
|
||||
- docs/sdk/models/operations/lastposter.md
|
||||
- docs/sdk/models/operations/participants.md
|
||||
- docs/sdk/models/operations/details.md
|
||||
- docs/sdk/models/operations/gettopictopicsactionssummary.md
|
||||
- docs/sdk/models/operations/linkcounts.md
|
||||
- docs/sdk/models/operations/posts.md
|
||||
- docs/sdk/models/operations/poststream.md
|
||||
- docs/sdk/models/operations/gettopicuser.md
|
||||
- docs/sdk/models/operations/posters.md
|
||||
- docs/sdk/models/operations/gettopictagsdescriptions.md
|
||||
- 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/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/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
|
||||
- docs/sdk/models/operations/listuserprivatemessagestopics.md
|
||||
- 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/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
|
||||
- docs/sdk/models/operations/gettagtopics.md
|
||||
- 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/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/sdks/backups/README.md
|
||||
- docs/sdks/badges/README.md
|
||||
- docs/sdks/groups/README.md
|
||||
- docs/sdks/users/README.md
|
||||
- docs/sdks/admin/README.md
|
||||
- docs/sdks/categories/README.md
|
||||
- docs/sdks/invites/README.md
|
||||
- docs/sdks/topics/README.md
|
||||
- docs/sdks/notifications/README.md
|
||||
- docs/sdks/posts/README.md
|
||||
- docs/sdks/privatemessages/README.md
|
||||
- docs/sdks/search/README.md
|
||||
- docs/sdks/site/README.md
|
||||
- docs/sdks/tags/README.md
|
||||
- docs/sdks/uploads/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
346
README.md
Normal file
346
README.md
Normal file
@@ -0,0 +1,346 @@
|
||||
# openapi
|
||||
|
||||
<div align="left">
|
||||
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
||||
<a href="https://opensource.org/licenses/MIT">
|
||||
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
## 🏗 **Welcome to your new SDK!** 🏗
|
||||
|
||||
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
|
||||
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
|
||||
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
|
||||
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
|
||||
- [ ] ✨ When ready to productionize, delete this section from the README
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
npm add openapi
|
||||
```
|
||||
|
||||
### Yarn
|
||||
|
||||
```bash
|
||||
yarn add openapi
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
## SDK Example Usage
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
### [backups](docs/sdks/backups/README.md)
|
||||
|
||||
* [createBackup](docs/sdks/backups/README.md#createbackup) - Create backup
|
||||
* [downloadBackup](docs/sdks/backups/README.md#downloadbackup) - Download backup
|
||||
* [getBackups](docs/sdks/backups/README.md#getbackups) - List backups
|
||||
* [sendDownloadBackupEmail](docs/sdks/backups/README.md#senddownloadbackupemail) - Send download backup email
|
||||
|
||||
### [badges](docs/sdks/badges/README.md)
|
||||
|
||||
* [adminListBadges](docs/sdks/badges/README.md#adminlistbadges) - List badges
|
||||
* [createBadge](docs/sdks/badges/README.md#createbadge) - Create badge
|
||||
* [deleteBadge](docs/sdks/badges/README.md#deletebadge) - Delete badge
|
||||
* [listUserBadges](docs/sdks/badges/README.md#listuserbadges) - List badges for a user
|
||||
* [updateBadge](docs/sdks/badges/README.md#updatebadge) - Update badge
|
||||
|
||||
### [groups](docs/sdks/groups/README.md)
|
||||
|
||||
* [addGroupMembers](docs/sdks/groups/README.md#addgroupmembers) - Add group members
|
||||
* [createGroup](docs/sdks/groups/README.md#creategroup) - Create a group
|
||||
* [deleteGroup](docs/sdks/groups/README.md#deletegroup) - Delete a group
|
||||
* [getGroup](docs/sdks/groups/README.md#getgroup) - Get a group
|
||||
* [listGroupMembers](docs/sdks/groups/README.md#listgroupmembers) - List group members
|
||||
* [listGroups](docs/sdks/groups/README.md#listgroups) - List groups
|
||||
* [removeGroupMembers](docs/sdks/groups/README.md#removegroupmembers) - Remove group members
|
||||
* [updateGroup](docs/sdks/groups/README.md#updategroup) - Update a group
|
||||
|
||||
### [users](docs/sdks/users/README.md)
|
||||
|
||||
* [activateUser](docs/sdks/users/README.md#activateuser) - Activate a user
|
||||
* [adminGetUser](docs/sdks/users/README.md#admingetuser) - Get a user by id
|
||||
* [adminListUsers](docs/sdks/users/README.md#adminlistusers) - Get a list of users
|
||||
* [anonymizeUser](docs/sdks/users/README.md#anonymizeuser) - Anonymize a user
|
||||
* [changePassword](docs/sdks/users/README.md#changepassword) - Change password
|
||||
* [createUser](docs/sdks/users/README.md#createuser) - Creates a user
|
||||
* [deactivateUser](docs/sdks/users/README.md#deactivateuser) - Deactivate a user
|
||||
* [deleteUser](docs/sdks/users/README.md#deleteuser) - Delete a user
|
||||
* [getUser](docs/sdks/users/README.md#getuser) - Get a single user by username
|
||||
* [getUserEmails](docs/sdks/users/README.md#getuseremails) - Get email addresses belonging to a user
|
||||
* [getUserExternalId](docs/sdks/users/README.md#getuserexternalid) - Get a user by external_id
|
||||
* [getUserIdentiyProviderExternalId](docs/sdks/users/README.md#getuseridentiyproviderexternalid) - Get a user by identity provider external ID
|
||||
* [listUserActions](docs/sdks/users/README.md#listuseractions) - Get a list of user actions
|
||||
* [listUserBadges](docs/sdks/users/README.md#listuserbadges) - List badges for a user
|
||||
* [listUsersPublic](docs/sdks/users/README.md#listuserspublic) - Get a public list of users
|
||||
* [logOutUser](docs/sdks/users/README.md#logoutuser) - Log a user out
|
||||
* [refreshGravatar](docs/sdks/users/README.md#refreshgravatar) - Refresh gravatar
|
||||
* [sendPasswordResetEmail](docs/sdks/users/README.md#sendpasswordresetemail) - Send password reset email
|
||||
* [silenceUser](docs/sdks/users/README.md#silenceuser) - Silence a user
|
||||
* [suspendUser](docs/sdks/users/README.md#suspenduser) - Suspend a user
|
||||
* [updateAvatar](docs/sdks/users/README.md#updateavatar) - Update avatar
|
||||
* [updateEmail](docs/sdks/users/README.md#updateemail) - Update email
|
||||
* [updateUser](docs/sdks/users/README.md#updateuser) - Update a user
|
||||
* [updateUsername](docs/sdks/users/README.md#updateusername) - Update username
|
||||
|
||||
### [admin](docs/sdks/admin/README.md)
|
||||
|
||||
* [activateUser](docs/sdks/admin/README.md#activateuser) - Activate a user
|
||||
* [adminGetUser](docs/sdks/admin/README.md#admingetuser) - Get a user by id
|
||||
* [adminListUsers](docs/sdks/admin/README.md#adminlistusers) - Get a list of users
|
||||
* [anonymizeUser](docs/sdks/admin/README.md#anonymizeuser) - Anonymize a user
|
||||
* [deactivateUser](docs/sdks/admin/README.md#deactivateuser) - Deactivate a user
|
||||
* [deleteUser](docs/sdks/admin/README.md#deleteuser) - Delete a user
|
||||
* [logOutUser](docs/sdks/admin/README.md#logoutuser) - Log a user out
|
||||
* [refreshGravatar](docs/sdks/admin/README.md#refreshgravatar) - Refresh gravatar
|
||||
* [silenceUser](docs/sdks/admin/README.md#silenceuser) - Silence a user
|
||||
* [suspendUser](docs/sdks/admin/README.md#suspenduser) - Suspend a user
|
||||
|
||||
### [categories](docs/sdks/categories/README.md)
|
||||
|
||||
* [createCategory](docs/sdks/categories/README.md#createcategory) - Creates a category
|
||||
* [getCategory](docs/sdks/categories/README.md#getcategory) - Show category
|
||||
* [getSite](docs/sdks/categories/README.md#getsite) - Get site info
|
||||
* [listCategories](docs/sdks/categories/README.md#listcategories) - Retrieves a list of categories
|
||||
* [listCategoryTopics](docs/sdks/categories/README.md#listcategorytopics) - List topics
|
||||
* [updateCategory](docs/sdks/categories/README.md#updatecategory) - Updates a category
|
||||
|
||||
### [invites](docs/sdks/invites/README.md)
|
||||
|
||||
* [createInvite](docs/sdks/invites/README.md#createinvite) - Create an invite
|
||||
* [inviteToTopic](docs/sdks/invites/README.md#invitetotopic) - Invite to topic
|
||||
|
||||
### [topics](docs/sdks/topics/README.md)
|
||||
|
||||
* [bookmarkTopic](docs/sdks/topics/README.md#bookmarktopic) - Bookmark topic
|
||||
* [createTopicPostPM](docs/sdks/topics/README.md#createtopicpostpm) - Creates a new topic, a new post, or a private message
|
||||
* [createTopicTimer](docs/sdks/topics/README.md#createtopictimer) - Create topic timer
|
||||
* [getTopic](docs/sdks/topics/README.md#gettopic) - Get a single topic
|
||||
* [getTopicByExternalId](docs/sdks/topics/README.md#gettopicbyexternalid) - Get topic by external_id
|
||||
* [inviteToTopic](docs/sdks/topics/README.md#invitetotopic) - Invite to topic
|
||||
* [listLatestTopics](docs/sdks/topics/README.md#listlatesttopics) - Get the latest topics
|
||||
* [listTopTopics](docs/sdks/topics/README.md#listtoptopics) - Get the top topics filtered by period
|
||||
* [removeTopic](docs/sdks/topics/README.md#removetopic) - Remove a topic
|
||||
* [setNotificationLevel](docs/sdks/topics/README.md#setnotificationlevel) - Set notification level
|
||||
* [updateTopic](docs/sdks/topics/README.md#updatetopic) - Update a topic
|
||||
* [updateTopicStatus](docs/sdks/topics/README.md#updatetopicstatus) - Update the status of a topic
|
||||
* [updateTopicTimestamp](docs/sdks/topics/README.md#updatetopictimestamp) - Update topic timestamp
|
||||
|
||||
### [notifications](docs/sdks/notifications/README.md)
|
||||
|
||||
* [getNotifications](docs/sdks/notifications/README.md#getnotifications) - Get the notifications that belong to the current user
|
||||
* [markNotificationsAsRead](docs/sdks/notifications/README.md#marknotificationsasread) - Mark notifications as read
|
||||
|
||||
### [posts](docs/sdks/posts/README.md)
|
||||
|
||||
* [createTopicPostPM](docs/sdks/posts/README.md#createtopicpostpm) - Creates a new topic, a new post, or a private message
|
||||
* [deletePost](docs/sdks/posts/README.md#deletepost) - delete a single post
|
||||
* [getPost](docs/sdks/posts/README.md#getpost) - Retrieve a single post
|
||||
* [listPosts](docs/sdks/posts/README.md#listposts) - List latest posts across topics
|
||||
* [lockPost](docs/sdks/posts/README.md#lockpost) - Lock a post from being edited
|
||||
* [performPostAction](docs/sdks/posts/README.md#performpostaction) - Like a post and other actions
|
||||
* [postReplies](docs/sdks/posts/README.md#postreplies) - List replies to a post
|
||||
* [updatePost](docs/sdks/posts/README.md#updatepost) - Update a single post
|
||||
|
||||
### [privateMessages](docs/sdks/privatemessages/README.md)
|
||||
|
||||
* [createTopicPostPM](docs/sdks/privatemessages/README.md#createtopicpostpm) - Creates a new topic, a new post, or a private message
|
||||
* [getUserSentPrivateMessages](docs/sdks/privatemessages/README.md#getusersentprivatemessages) - Get a list of private messages sent for a user
|
||||
* [listUserPrivateMessages](docs/sdks/privatemessages/README.md#listuserprivatemessages) - Get a list of private messages for a user
|
||||
|
||||
### [search](docs/sdks/search/README.md)
|
||||
|
||||
* [search](docs/sdks/search/README.md#search) - Search for a term
|
||||
|
||||
### [site](docs/sdks/site/README.md)
|
||||
|
||||
* [getSite](docs/sdks/site/README.md#getsite) - Get site info
|
||||
|
||||
### [tags](docs/sdks/tags/README.md)
|
||||
|
||||
* [createTagGroup](docs/sdks/tags/README.md#createtaggroup) - Creates a tag group
|
||||
* [getTag](docs/sdks/tags/README.md#gettag) - Get a specific tag
|
||||
* [getTagGroup](docs/sdks/tags/README.md#gettaggroup) - Get a single tag group
|
||||
* [listTagGroups](docs/sdks/tags/README.md#listtaggroups) - Get a list of tag groups
|
||||
* [listTags](docs/sdks/tags/README.md#listtags) - Get a list of tags
|
||||
* [updateTagGroup](docs/sdks/tags/README.md#updatetaggroup) - Update tag group
|
||||
|
||||
### [uploads](docs/sdks/uploads/README.md)
|
||||
|
||||
* [abortMultipart](docs/sdks/uploads/README.md#abortmultipart) - Abort multipart upload
|
||||
* [batchPresignMultipartParts](docs/sdks/uploads/README.md#batchpresignmultipartparts) - Generates batches of presigned URLs for multipart parts
|
||||
* [completeExternalUpload](docs/sdks/uploads/README.md#completeexternalupload) - Completes a direct external upload
|
||||
* [completeMultipart](docs/sdks/uploads/README.md#completemultipart) - Complete multipart upload
|
||||
* [createMultipartUpload](docs/sdks/uploads/README.md#createmultipartupload) - Creates a multipart external upload
|
||||
* [createUpload](docs/sdks/uploads/README.md#createupload) - Creates an upload
|
||||
* [generatePresignedPut](docs/sdks/uploads/README.md#generatepresignedput) - Initiates a direct external upload
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- 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.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
Example
|
||||
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
|
||||
let res;
|
||||
try {
|
||||
res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
} catch (err) {
|
||||
if (err instanceof errors.SDKError) {
|
||||
console.error(err); // handle exception
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### 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:
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `https://{defaultHost}` | `defaultHost` (default is `discourse.example.com`) |
|
||||
|
||||
#### Example
|
||||
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK({
|
||||
serverIdx: 0,
|
||||
});
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
||||
* `defaultHost: string`
|
||||
|
||||
### 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:
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK({
|
||||
serverURL: "https://{defaultHost}",
|
||||
});
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- 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.
|
||||
|
||||
For example, you could specify a header for every request that your sdk makes as follows:
|
||||
|
||||
```typescript
|
||||
import { openapi } from "SDK";
|
||||
import axios from "axios";
|
||||
|
||||
const httpClient = axios.create({
|
||||
headers: {'x-custom-header': 'someValue'}
|
||||
})
|
||||
|
||||
const sdk = new SDK({defaultClient: httpClient});
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
## Maturity
|
||||
|
||||
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||
looking for the latest version.
|
||||
|
||||
## Contributions
|
||||
|
||||
While we value open-source contributions to this SDK, this library is generated programmatically.
|
||||
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
|
||||
|
||||
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
|
||||
11
RELEASES.md
Normal file
11
RELEASES.md
Normal file
@@ -0,0 +1,11 @@
|
||||
|
||||
|
||||
## 2024-01-10 15:47:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc latest
|
||||
- Speakeasy CLI 1.134.1 (2.230.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.0.1] .
|
||||
### Releases
|
||||
- [NPM v0.0.1] https://www.npmjs.com/package/openapi/v/0.0.1 - .
|
||||
20
USAGE.md
Normal file
20
USAGE.md
Normal file
@@ -0,0 +1,20 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
|
||||
const res = await sdk.backups.createBackup({
|
||||
withUploads: false,
|
||||
});
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
8
docs/sdk/models/operations/abortmultipartrequestbody.md
Normal file
8
docs/sdk/models/operations/abortmultipartrequestbody.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# AbortMultipartRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `externalUploadIdentifier` | *string* | :heavy_check_mark: | The identifier of the multipart upload in the external storage provider. This is the multipart upload_id in AWS S3. | 84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ |
|
||||
11
docs/sdk/models/operations/abortmultipartresponse.md
Normal file
11
docs/sdk/models/operations/abortmultipartresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/abortmultipartresponsebody.md
Normal file
10
docs/sdk/models/operations/abortmultipartresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AbortMultipartResponseBody
|
||||
|
||||
external upload initialized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `success` | *string* | :heavy_check_mark: | N/A | OK |
|
||||
11
docs/sdk/models/operations/actionssummary.md
Normal file
11
docs/sdk/models/operations/actionssummary.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ActionsSummary
|
||||
|
||||
|
||||
## 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 |
|
||||
8
docs/sdk/models/operations/activateuserrequest.md
Normal file
8
docs/sdk/models/operations/activateuserrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ActivateUserRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/activateuserresponse.md
Normal file
11
docs/sdk/models/operations/activateuserresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/activateuserresponsebody.md
Normal file
10
docs/sdk/models/operations/activateuserresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ActivateUserResponseBody
|
||||
|
||||
response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `success` | *string* | :heavy_check_mark: | N/A | OK |
|
||||
9
docs/sdk/models/operations/addgroupmembersrequest.md
Normal file
9
docs/sdk/models/operations/addgroupmembersrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# AddGroupMembersRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.AddGroupMembersRequestBody](../../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
8
docs/sdk/models/operations/addgroupmembersrequestbody.md
Normal file
8
docs/sdk/models/operations/addgroupmembersrequestbody.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# AddGroupMembersRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `usernames` | *string* | :heavy_minus_sign: | comma separated list | username1,username2 |
|
||||
11
docs/sdk/models/operations/addgroupmembersresponse.md
Normal file
11
docs/sdk/models/operations/addgroupmembersresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
12
docs/sdk/models/operations/addgroupmembersresponsebody.md
Normal file
12
docs/sdk/models/operations/addgroupmembersresponsebody.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AddGroupMembersResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `emails` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `success` | *string* | :heavy_check_mark: | N/A |
|
||||
| `usernames` | *any*[] | :heavy_check_mark: | N/A |
|
||||
12
docs/sdk/models/operations/adminbadges.md
Normal file
12
docs/sdk/models/operations/adminbadges.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AdminBadges
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `badgeGroupingIds` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `badgeIds` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `badgeTypeIds` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `protectedSystemFields` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `triggers` | [operations.Triggers](../../../sdk/models/operations/triggers.md) | :heavy_check_mark: | N/A |
|
||||
7
docs/sdk/models/operations/admingetuserexternalids.md
Normal file
7
docs/sdk/models/operations/admingetuserexternalids.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# AdminGetUserExternalIds
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
37
docs/sdk/models/operations/admingetusergroups.md
Normal file
37
docs/sdk/models/operations/admingetusergroups.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# AdminGetUserGroups
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `allowMembershipRequests` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `automatic` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `bioCooked` | *string* | :heavy_check_mark: | N/A |
|
||||
| `bioExcerpt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `bioRaw` | *string* | :heavy_check_mark: | N/A |
|
||||
| `canAdminGroup` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canSeeMembers` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `defaultNotificationLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `displayName` | *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 |
|
||||
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `fullName` | *string* | :heavy_check_mark: | N/A |
|
||||
| `grantTrustLevel` | *string* | :heavy_check_mark: | N/A |
|
||||
| `hasMessages` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `incomingEmail` | *string* | :heavy_check_mark: | N/A |
|
||||
| `membersVisibilityLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `membershipRequestTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `mentionableLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `messageableLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `primaryGroup` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publicAdmission` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publicExit` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publishReadState` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A |
|
||||
| `userCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `visibilityLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/admingetuserpenaltycounts.md
Normal file
10
docs/sdk/models/operations/admingetuserpenaltycounts.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AdminGetUserPenaltyCounts
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `silenced` | *number* | :heavy_check_mark: | N/A |
|
||||
| `suspended` | *number* | :heavy_check_mark: | N/A |
|
||||
| `total` | *number* | :heavy_check_mark: | N/A |
|
||||
8
docs/sdk/models/operations/admingetuserrequest.md
Normal file
8
docs/sdk/models/operations/admingetuserrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# AdminGetUserRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/admingetuserresponse.md
Normal file
11
docs/sdk/models/operations/admingetuserresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
73
docs/sdk/models/operations/admingetuserresponsebody.md
Normal file
73
docs/sdk/models/operations/admingetuserresponsebody.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# AdminGetUserResponseBody
|
||||
|
||||
response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `admin` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `apiKeyCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `approvedBy` | [operations.ApprovedBy](../../../sdk/models/operations/approvedby.md) | :heavy_check_mark: | N/A |
|
||||
| `associatedAccounts` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `badgeCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `bounceScore` | *number* | :heavy_check_mark: | N/A |
|
||||
| `canActivate` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canBeAnonymized` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canBeDeleted` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canBeMerged` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canDeactivate` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canDeleteAllPosts` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canDeleteSsoRecord` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canDisableSecondFactor` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canGrantAdmin` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canGrantModeration` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canImpersonate` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canRevokeAdmin` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canRevokeModeration` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canSendActivationEmail` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canViewActionLogs` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `createdAtAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `daysVisited` | *number* | :heavy_check_mark: | N/A |
|
||||
| `externalIds` | [operations.AdminGetUserExternalIds](../../../sdk/models/operations/admingetuserexternalids.md) | :heavy_check_mark: | N/A |
|
||||
| `flagsGivenCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `flagsReceivedCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `fullSuspendReason` | *string* | :heavy_check_mark: | N/A |
|
||||
| `groups` | [operations.AdminGetUserGroups](../../../sdk/models/operations/admingetusergroups.md)[] | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `ipAddress` | *string* | :heavy_check_mark: | N/A |
|
||||
| `lastEmailedAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `lastEmailedAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `lastSeenAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `lastSeenAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `likeCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `likeGivenCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `manualLockedTrustLevel` | *string* | :heavy_check_mark: | N/A |
|
||||
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `nextPenalty` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `penaltyCounts` | [operations.PenaltyCounts](../../../sdk/models/operations/penaltycounts.md) | :heavy_minus_sign: | N/A |
|
||||
| `postCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `postEditsCount` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `postsReadCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `primaryGroupId` | *string* | :heavy_check_mark: | N/A |
|
||||
| `privateTopicsCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `registrationIpAddress` | *string* | :heavy_check_mark: | N/A |
|
||||
| `resetBounceScoreAfter` | *string* | :heavy_check_mark: | N/A |
|
||||
| `silenceReason` | *string* | :heavy_check_mark: | N/A |
|
||||
| `silencedBy` | *string* | :heavy_check_mark: | N/A |
|
||||
| `singleSignOnRecord` | *string* | :heavy_check_mark: | N/A |
|
||||
| `staged` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `suspendedBy` | *string* | :heavy_check_mark: | N/A |
|
||||
| `timeRead` | *number* | :heavy_check_mark: | N/A |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A |
|
||||
| `tl3Requirements` | [operations.Tl3Requirements](../../../sdk/models/operations/tl3requirements.md) | :heavy_minus_sign: | N/A |
|
||||
| `topicCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicsEntered` | *number* | :heavy_check_mark: | N/A |
|
||||
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
| `warningsReceivedCount` | *number* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/adminlistbadgesresponse.md
Normal file
11
docs/sdk/models/operations/adminlistbadgesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
13
docs/sdk/models/operations/adminlistbadgesresponsebody.md
Normal file
13
docs/sdk/models/operations/adminlistbadgesresponsebody.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# AdminListBadgesResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `adminBadges` | [operations.AdminBadges](../../../sdk/models/operations/adminbadges.md) | :heavy_check_mark: | N/A |
|
||||
| `badgeGroupings` | [operations.BadgeGroupings](../../../sdk/models/operations/badgegroupings.md)[] | :heavy_check_mark: | N/A |
|
||||
| `badgeTypes` | [operations.BadgeTypes](../../../sdk/models/operations/badgetypes.md)[] | :heavy_check_mark: | N/A |
|
||||
| `badges` | [operations.Badges](../../../sdk/models/operations/badges.md)[] | :heavy_check_mark: | N/A |
|
||||
15
docs/sdk/models/operations/adminlistusersrequest.md
Normal file
15
docs/sdk/models/operations/adminlistusersrequest.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# AdminListUsersRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `asc` | [operations.QueryParamAsc](../../../sdk/models/operations/queryparamasc.md) | :heavy_minus_sign: | N/A |
|
||||
| `email` | *string* | :heavy_minus_sign: | Filter to the user with this email address |
|
||||
| `flag` | [operations.Flag](../../../sdk/models/operations/flag.md) | :heavy_check_mark: | N/A |
|
||||
| `ip` | *string* | :heavy_minus_sign: | Filter to users with this IP address |
|
||||
| `order` | [operations.QueryParamOrder](../../../sdk/models/operations/queryparamorder.md) | :heavy_minus_sign: | N/A |
|
||||
| `page` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `showEmails` | *boolean* | :heavy_minus_sign: | Include user email addresses in response. These requests will be logged in the staff action logs. |
|
||||
| `stats` | *boolean* | :heavy_minus_sign: | Include user stats information |
|
||||
11
docs/sdk/models/operations/adminlistusersresponse.md
Normal file
11
docs/sdk/models/operations/adminlistusersresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
31
docs/sdk/models/operations/adminlistusersresponsebody.md
Normal file
31
docs/sdk/models/operations/adminlistusersresponsebody.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AdminListUsersResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `admin` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `createdAtAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `daysVisited` | *number* | :heavy_check_mark: | N/A |
|
||||
| `email` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `lastEmailedAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `lastEmailedAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `lastSeenAge` | *number* | :heavy_check_mark: | N/A |
|
||||
| `lastSeenAt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `manualLockedTrustLevel` | *string* | :heavy_check_mark: | N/A |
|
||||
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `postCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `postsReadCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `secondaryEmails` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `staged` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `timeRead` | *number* | :heavy_check_mark: | N/A |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicsEntered` | *number* | :heavy_check_mark: | N/A |
|
||||
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
8
docs/sdk/models/operations/anonymizeuserrequest.md
Normal file
8
docs/sdk/models/operations/anonymizeuserrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# AnonymizeUserRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/anonymizeuserresponse.md
Normal file
11
docs/sdk/models/operations/anonymizeuserresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
11
docs/sdk/models/operations/anonymizeuserresponsebody.md
Normal file
11
docs/sdk/models/operations/anonymizeuserresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AnonymizeUserResponseBody
|
||||
|
||||
response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `success` | *string* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/approvedby.md
Normal file
11
docs/sdk/models/operations/approvedby.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ApprovedBy
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/archetypes.md
Normal file
10
docs/sdk/models/operations/archetypes.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Archetypes
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `options` | *any*[] | :heavy_check_mark: | N/A |
|
||||
8
docs/sdk/models/operations/asc.md
Normal file
8
docs/sdk/models/operations/asc.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Asc
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `True` | true |
|
||||
28
docs/sdk/models/operations/badge.md
Normal file
28
docs/sdk/models/operations/badge.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Badge
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `allowTitle` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `autoRevoke` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `badgeGroupingId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `badgeTypeId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `description` | *string* | :heavy_check_mark: | N/A |
|
||||
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `grantCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `icon` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `imageUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `listable` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `longDescription` | *string* | :heavy_check_mark: | N/A |
|
||||
| `manuallyGrantable` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `multipleGrant` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `query` | *string* | :heavy_check_mark: | N/A |
|
||||
| `showPosts` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `slug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `system` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `targetPosts` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `trigger` | *string* | :heavy_check_mark: | N/A |
|
||||
12
docs/sdk/models/operations/badgegroupings.md
Normal file
12
docs/sdk/models/operations/badgegroupings.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# BadgeGroupings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `description` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `position` | *number* | :heavy_check_mark: | N/A |
|
||||
| `system` | *boolean* | :heavy_check_mark: | N/A |
|
||||
29
docs/sdk/models/operations/badges.md
Normal file
29
docs/sdk/models/operations/badges.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Badges
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `allowTitle` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `autoRevoke` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `badgeGroupingId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `badgeTypeId` | *number* | :heavy_check_mark: | N/A |
|
||||
| `description` | *string* | :heavy_check_mark: | N/A |
|
||||
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `grantCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `i18nName` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `icon` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `imageUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `listable` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `longDescription` | *string* | :heavy_check_mark: | N/A |
|
||||
| `manuallyGrantable` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `multipleGrant` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `query` | *string* | :heavy_check_mark: | N/A |
|
||||
| `showPosts` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `slug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `system` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `targetPosts` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `trigger` | *number* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/badgetypes.md
Normal file
10
docs/sdk/models/operations/badgetypes.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# BadgeTypes
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortOrder` | *number* | :heavy_check_mark: | N/A |
|
||||
36
docs/sdk/models/operations/basicgroup.md
Normal file
36
docs/sdk/models/operations/basicgroup.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# BasicGroup
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `allowMembershipRequests` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `automatic` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `bioCooked` | *string* | :heavy_check_mark: | N/A |
|
||||
| `bioExcerpt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `bioRaw` | *string* | :heavy_check_mark: | N/A |
|
||||
| `canAdminGroup` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canEditGroup` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `canSeeMembers` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `defaultNotificationLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `fullName` | *string* | :heavy_check_mark: | N/A |
|
||||
| `grantTrustLevel` | *string* | :heavy_check_mark: | N/A |
|
||||
| `hasMessages` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `incomingEmail` | *string* | :heavy_check_mark: | N/A |
|
||||
| `membersVisibilityLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `membershipRequestTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `mentionableLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `messageableLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `primaryGroup` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publicAdmission` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publicExit` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `publishReadState` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A |
|
||||
| `userCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `visibilityLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
12
docs/sdk/models/operations/basictopic.md
Normal file
12
docs/sdk/models/operations/basictopic.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# BasicTopic
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `fancyTitle` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `postsCount` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `slug` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,9 @@
|
||||
# BatchPresignMultipartPartsRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `partNumbers` | *any*[] | :heavy_check_mark: | The part numbers to generate the presigned URLs for, must be between 1 and 10000. | [1,2,3] |
|
||||
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /create-multipart request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# BatchPresignMultipartPartsResponseBody
|
||||
|
||||
external upload initialized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `presignedUrls` | [operations.PresignedUrls](../../../sdk/models/operations/presignedurls.md) | :heavy_check_mark: | The presigned URLs for each part number, which has the part numbers as keys. |
|
||||
10
docs/sdk/models/operations/bookmarktopicrequest.md
Normal file
10
docs/sdk/models/operations/bookmarktopicrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# BookmarkTopicRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *string* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/bookmarktopicresponse.md
Normal file
10
docs/sdk/models/operations/bookmarktopicresponse.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
47
docs/sdk/models/operations/categories.md
Normal file
47
docs/sdk/models/operations/categories.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Categories
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `color` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultListFilter` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultTopPeriod` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultView` | *string* | :heavy_check_mark: | N/A |
|
||||
| `description` | *string* | :heavy_check_mark: | N/A |
|
||||
| `descriptionExcerpt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `descriptionText` | *string* | :heavy_check_mark: | N/A |
|
||||
| `hasChildren` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `isUncategorized` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `minimumRequiredTags` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `navigateToFirstPostAfterRead` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `notificationLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `numFeaturedTopics` | *number* | :heavy_check_mark: | N/A |
|
||||
| `permission` | *number* | :heavy_check_mark: | N/A |
|
||||
| `position` | *number* | :heavy_check_mark: | N/A |
|
||||
| `postCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `readRestricted` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `showSubcategoryList` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `slug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortAscending` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortOrder` | *string* | :heavy_check_mark: | N/A |
|
||||
| `subcategoryIds` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `subcategoryList` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `subcategoryListStyle` | *string* | :heavy_check_mark: | N/A |
|
||||
| `textColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicsAllTime` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicsDay` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicsMonth` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicsWeek` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicsYear` | *number* | :heavy_check_mark: | N/A |
|
||||
| `uploadedBackground` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedBackgroundDark` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedLogo` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedLogoDark` | *string* | :heavy_check_mark: | N/A |
|
||||
61
docs/sdk/models/operations/category.md
Normal file
61
docs/sdk/models/operations/category.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Category
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `allTopicsWiki` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `allowBadges` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `allowGlobalTags` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `allowUnlimitedOwnerEditsOnFirstPost` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `allowedTagGroups` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `allowedTags` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `autoCloseBasedOnLastPost` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `autoCloseHours` | *string* | :heavy_check_mark: | N/A |
|
||||
| `availableGroups` | *any*[] | :heavy_check_mark: | N/A |
|
||||
| `canDelete` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `categorySetting` | *any* | :heavy_minus_sign: | N/A |
|
||||
| `color` | *string* | :heavy_check_mark: | N/A |
|
||||
| `customFields` | [operations.CustomFields](../../../sdk/models/operations/customfields.md) | :heavy_check_mark: | N/A |
|
||||
| `defaultListFilter` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultSlowModeSeconds` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultTopPeriod` | *string* | :heavy_check_mark: | N/A |
|
||||
| `defaultView` | *string* | :heavy_check_mark: | N/A |
|
||||
| `description` | *string* | :heavy_check_mark: | N/A |
|
||||
| `descriptionExcerpt` | *string* | :heavy_check_mark: | N/A |
|
||||
| `descriptionText` | *string* | :heavy_check_mark: | N/A |
|
||||
| `emailIn` | *string* | :heavy_check_mark: | N/A |
|
||||
| `emailInAllowStrangers` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `formTemplateIds` | *any*[] | :heavy_minus_sign: | N/A |
|
||||
| `groupPermissions` | [operations.GroupPermissions](../../../sdk/models/operations/grouppermissions.md)[] | :heavy_check_mark: | N/A |
|
||||
| `hasChildren` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `mailinglistMirror` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `minimumRequiredTags` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `navigateToFirstPostAfterRead` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `notificationLevel` | *number* | :heavy_check_mark: | N/A |
|
||||
| `numFeaturedTopics` | *number* | :heavy_check_mark: | N/A |
|
||||
| `permission` | *number* | :heavy_check_mark: | N/A |
|
||||
| `position` | *number* | :heavy_check_mark: | N/A |
|
||||
| `postCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `readOnlyBanner` | *string* | :heavy_check_mark: | N/A |
|
||||
| `readRestricted` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `requiredTagGroups` | [operations.RequiredTagGroups](../../../sdk/models/operations/requiredtaggroups.md)[] | :heavy_check_mark: | N/A |
|
||||
| `searchPriority` | *number* | :heavy_check_mark: | N/A |
|
||||
| `showSubcategoryList` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `slug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortAscending` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortOrder` | *string* | :heavy_check_mark: | N/A |
|
||||
| `subcategoryListStyle` | *string* | :heavy_check_mark: | N/A |
|
||||
| `textColor` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicCount` | *number* | :heavy_check_mark: | N/A |
|
||||
| `topicFeaturedLinkAllowed` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `topicTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `topicUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedBackground` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedBackgroundDark` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedLogo` | *string* | :heavy_check_mark: | N/A |
|
||||
| `uploadedLogoDark` | *string* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/categorylist.md
Normal file
10
docs/sdk/models/operations/categorylist.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CategoryList
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `canCreateCategory` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `canCreateTopic` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `categories` | [operations.Categories](../../../sdk/models/operations/categories.md)[] | :heavy_check_mark: | N/A |
|
||||
7
docs/sdk/models/operations/censoredregexp.md
Normal file
7
docs/sdk/models/operations/censoredregexp.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# CensoredRegexp
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
9
docs/sdk/models/operations/changepasswordrequest.md
Normal file
9
docs/sdk/models/operations/changepasswordrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ChangePasswordRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `token` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.ChangePasswordRequestBody](../../../sdk/models/operations/changepasswordrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
9
docs/sdk/models/operations/changepasswordrequestbody.md
Normal file
9
docs/sdk/models/operations/changepasswordrequestbody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ChangePasswordRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `password` | *string* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/changepasswordresponse.md
Normal file
10
docs/sdk/models/operations/changepasswordresponse.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# CompleteExternalUploadRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `forPrivateMessage` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload is for a private message. | true |
|
||||
| `forSiteSetting` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload is for a site setting. | true |
|
||||
| `pasted` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload was pasted into the upload area. This will convert PNG files to JPEG. | true |
|
||||
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /generate-presigned-put request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |
|
||||
11
docs/sdk/models/operations/completeexternaluploadresponse.md
Normal file
11
docs/sdk/models/operations/completeexternaluploadresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,23 @@
|
||||
# CompleteExternalUploadResponseBody
|
||||
|
||||
external upload initialized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `extension` | *string* | :heavy_check_mark: | N/A |
|
||||
| `filesize` | *number* | :heavy_check_mark: | N/A |
|
||||
| `height` | *number* | :heavy_check_mark: | N/A |
|
||||
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
|
||||
| `retainHours` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortPath` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A |
|
||||
| `width` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CompleteMultipartRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `parts` | *any*[] | :heavy_check_mark: | All of the part numbers and their corresponding ETags that have been uploaded must be provided. | [{"etag":"0c376dcfcc2606f4335bbc732de93344","part_number":1},{"etag":"09ert8cfcc2606f4335bbc732de91122","part_number":2}] |
|
||||
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /create-multipart request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |
|
||||
11
docs/sdk/models/operations/completemultipartresponse.md
Normal file
11
docs/sdk/models/operations/completemultipartresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
23
docs/sdk/models/operations/completemultipartresponsebody.md
Normal file
23
docs/sdk/models/operations/completemultipartresponsebody.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CompleteMultipartResponseBody
|
||||
|
||||
external upload initialized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `extension` | *string* | :heavy_check_mark: | N/A |
|
||||
| `filesize` | *number* | :heavy_check_mark: | N/A |
|
||||
| `height` | *number* | :heavy_check_mark: | N/A |
|
||||
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
|
||||
| `retainHours` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortPath` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A |
|
||||
| `width` | *number* | :heavy_check_mark: | N/A |
|
||||
8
docs/sdk/models/operations/createbackuprequestbody.md
Normal file
8
docs/sdk/models/operations/createbackuprequestbody.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CreateBackupRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `withUploads` | *boolean* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/createbackupresponse.md
Normal file
11
docs/sdk/models/operations/createbackupresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/createbackupresponsebody.md
Normal file
10
docs/sdk/models/operations/createbackupresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateBackupResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `success` | *string* | :heavy_check_mark: | N/A | OK |
|
||||
10
docs/sdk/models/operations/createbadgebadgetypes.md
Normal file
10
docs/sdk/models/operations/createbadgebadgetypes.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateBadgeBadgeTypes
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `sortOrder` | *number* | :heavy_check_mark: | N/A |
|
||||
9
docs/sdk/models/operations/createbadgerequestbody.md
Normal file
9
docs/sdk/models/operations/createbadgerequestbody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# CreateBadgeRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `badgeTypeId` | *number* | :heavy_check_mark: | The ID for the badge type. 1 for Gold, 2 for Silver, 3 for Bronze. |
|
||||
| `name` | *string* | :heavy_check_mark: | The name for the new badge. |
|
||||
11
docs/sdk/models/operations/createbadgeresponse.md
Normal file
11
docs/sdk/models/operations/createbadgeresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
11
docs/sdk/models/operations/createbadgeresponsebody.md
Normal file
11
docs/sdk/models/operations/createbadgeresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreateBadgeResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `badge` | [operations.Badge](../../../sdk/models/operations/badge.md) | :heavy_check_mark: | N/A |
|
||||
| `badgeTypes` | [operations.CreateBadgeBadgeTypes](../../../sdk/models/operations/createbadgebadgetypes.md)[] | :heavy_check_mark: | N/A |
|
||||
17
docs/sdk/models/operations/createcategoryrequestbody.md
Normal file
17
docs/sdk/models/operations/createcategoryrequestbody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# CreateCategoryRequestBody
|
||||
|
||||
|
||||
## 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 | |
|
||||
| `searchPriority` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `slug` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `textColor` | *string* | :heavy_minus_sign: | N/A | f0fcfd |
|
||||
| `topicFeaturedLinksAllowed` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
11
docs/sdk/models/operations/createcategoryresponse.md
Normal file
11
docs/sdk/models/operations/createcategoryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/createcategoryresponsebody.md
Normal file
10
docs/sdk/models/operations/createcategoryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateCategoryResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `category` | [operations.Category](../../../sdk/models/operations/category.md) | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/createdby.md
Normal file
11
docs/sdk/models/operations/createdby.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreatedBy
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
8
docs/sdk/models/operations/creategrouprequestbody.md
Normal file
8
docs/sdk/models/operations/creategrouprequestbody.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CreateGroupRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `group` | [operations.Group](../../../sdk/models/operations/group.md) | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/creategroupresponse.md
Normal file
11
docs/sdk/models/operations/creategroupresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/creategroupresponsebody.md
Normal file
10
docs/sdk/models/operations/creategroupresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateGroupResponseBody
|
||||
|
||||
group created
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `basicGroup` | [operations.BasicGroup](../../../sdk/models/operations/basicgroup.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/createinviterequest.md
Normal file
10
docs/sdk/models/operations/createinviterequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateInviteRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.CreateInviteRequestBody](../../../sdk/models/operations/createinviterequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
15
docs/sdk/models/operations/createinviterequestbody.md
Normal file
15
docs/sdk/models/operations/createinviterequestbody.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# CreateInviteRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `customMessage` | *string* | :heavy_minus_sign: | optional, for email invites | |
|
||||
| `email` | *string* | :heavy_minus_sign: | required for email invites only | not-a-user-yet@example.com |
|
||||
| `expiresAt` | *string* | :heavy_minus_sign: | optional, if not supplied, the invite_expiry_days site setting is used | |
|
||||
| `groupIds` | *string* | :heavy_minus_sign: | Optional, either this or `group_names`. Comma separated list for multiple ids. | 42,43 |
|
||||
| `groupNames` | *string* | :heavy_minus_sign: | Optional, either this or `group_ids`. Comma separated list for multiple names. | foo,bar |
|
||||
| `maxRedemptionsAllowed` | *number* | :heavy_minus_sign: | optional, for link invites | 5 |
|
||||
| `skipEmail` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `topicId` | *number* | :heavy_minus_sign: | N/A | |
|
||||
11
docs/sdk/models/operations/createinviteresponse.md
Normal file
11
docs/sdk/models/operations/createinviteresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
20
docs/sdk/models/operations/createinviteresponsebody.md
Normal file
20
docs/sdk/models/operations/createinviteresponsebody.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CreateInviteResponseBody
|
||||
|
||||
success response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A | 2021-01-01T12:00:00.000Z |
|
||||
| `customMessage` | *string* | :heavy_minus_sign: | N/A | Hello world! |
|
||||
| `email` | *string* | :heavy_minus_sign: | N/A | not-a-user-yet@example.com |
|
||||
| `emailed` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `expired` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `expiresAt` | *string* | :heavy_minus_sign: | N/A | 2021-02-01T12:00:00.000Z |
|
||||
| `groups` | *any*[] | :heavy_minus_sign: | N/A | [] |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 42 |
|
||||
| `link` | *string* | :heavy_minus_sign: | N/A | http://example.com/invites/9045fd767efe201ca60c6658bcf14158 |
|
||||
| `topics` | *any*[] | :heavy_minus_sign: | N/A | [] |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | N/A | 2021-01-01T12:00:00.000Z |
|
||||
@@ -0,0 +1,11 @@
|
||||
# CreateMultipartUploadRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `fileName` | *string* | :heavy_check_mark: | N/A | IMG_2021.jpeg |
|
||||
| `fileSize` | *number* | :heavy_check_mark: | File size should be represented in bytes. | 4096 |
|
||||
| `metadata` | [operations.Metadata](../../../sdk/models/operations/metadata.md) | :heavy_minus_sign: | N/A | |
|
||||
| `uploadType` | [operations.UploadType](../../../sdk/models/operations/uploadtype.md) | :heavy_check_mark: | N/A | |
|
||||
11
docs/sdk/models/operations/createmultipartuploadresponse.md
Normal file
11
docs/sdk/models/operations/createmultipartuploadresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,12 @@
|
||||
# CreateMultipartUploadResponseBody
|
||||
|
||||
external upload initialized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `externalUploadIdentifier` | *string* | :heavy_check_mark: | The identifier of the multipart upload in the external storage provider. This is the multipart upload_id in AWS S3. | 84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ |
|
||||
| `key` | *string* | :heavy_check_mark: | The path of the temporary file on the external storage service. | temp/site/uploads/default/12345/67890.jpg |
|
||||
| `uniqueIdentifier` | *string* | :heavy_check_mark: | A unique string that identifies the external upload. This must be stored and then sent in the /complete-multipart and /batch-presign-multipart-parts endpoints. | 66e86218-80d9-4bda-b4d5-2b6def968705 |
|
||||
8
docs/sdk/models/operations/createtaggrouprequestbody.md
Normal file
8
docs/sdk/models/operations/createtaggrouprequestbody.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CreateTagGroupRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/createtaggroupresponse.md
Normal file
11
docs/sdk/models/operations/createtaggroupresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
10
docs/sdk/models/operations/createtaggroupresponsebody.md
Normal file
10
docs/sdk/models/operations/createtaggroupresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateTagGroupResponseBody
|
||||
|
||||
tag group created
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `tagGroup` | [operations.TagGroup](../../../sdk/models/operations/taggroup.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CreateTopicPostPMActionsSummary
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `canAct` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
18
docs/sdk/models/operations/createtopicpostpmrequestbody.md
Normal file
18
docs/sdk/models/operations/createtopicpostpmrequestbody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CreateTopicPostPMRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `archetype` | *string* | :heavy_minus_sign: | Required for new private message. | private_message |
|
||||
| `category` | *number* | :heavy_minus_sign: | Optional if creating a new topic, and ignored if creating a new post. | |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `embedUrl` | *string* | :heavy_minus_sign: | Provide a URL from a remote system to associate a forum topic with that URL, typically for using Discourse as a comments system for an external blog. | |
|
||||
| `externalId` | *string* | :heavy_minus_sign: | Provide an external_id from a remote system to associate a forum topic with that id. | |
|
||||
| `raw` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `replyToPostNumber` | *number* | :heavy_minus_sign: | Optional, the post number to reply to inside a topic. | |
|
||||
| `targetRecipients` | *string* | :heavy_minus_sign: | Required for private message, comma separated. | blake,sam |
|
||||
| ~~`targetUsernames`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated. Use target_recipients instead. | |
|
||||
| `title` | *string* | :heavy_minus_sign: | Required if creating a new topic or new private message. | |
|
||||
| `topicId` | *number* | :heavy_minus_sign: | Required if creating a new post. | |
|
||||
11
docs/sdk/models/operations/createtopicpostpmresponse.md
Normal file
11
docs/sdk/models/operations/createtopicpostpmresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
61
docs/sdk/models/operations/createtopicpostpmresponsebody.md
Normal file
61
docs/sdk/models/operations/createtopicpostpmresponsebody.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# CreateTopicPostPMResponseBody
|
||||
|
||||
post created
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `actionsSummary` | [operations.CreateTopicPostPMActionsSummary](../../../sdk/models/operations/createtopicpostpmactionssummary.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_check_mark: | N/A |
|
||||
| `draftSequence` | *number* | :heavy_check_mark: | 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_check_mark: | 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_minus_sign: | 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 |
|
||||
11
docs/sdk/models/operations/createtopictimerrequest.md
Normal file
11
docs/sdk/models/operations/createtopictimerrequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreateTopicTimerRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
11
docs/sdk/models/operations/createtopictimerrequestbody.md
Normal file
11
docs/sdk/models/operations/createtopictimerrequestbody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreateTopicTimerRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `basedOnLastPost` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `categoryId` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `statusType` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `time` | *string* | :heavy_minus_sign: | N/A | |
|
||||
11
docs/sdk/models/operations/createtopictimerresponse.md
Normal file
11
docs/sdk/models/operations/createtopictimerresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
15
docs/sdk/models/operations/createtopictimerresponsebody.md
Normal file
15
docs/sdk/models/operations/createtopictimerresponsebody.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# CreateTopicTimerResponseBody
|
||||
|
||||
topic updated
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `basedOnLastPost` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `categoryId` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `closed` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `duration` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `executeAt` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `success` | *string* | :heavy_minus_sign: | N/A | OK |
|
||||
11
docs/sdk/models/operations/createuploadrequestbody.md
Normal file
11
docs/sdk/models/operations/createuploadrequestbody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreateUploadRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `file` | [operations.File](../../../sdk/models/operations/file.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 |
|
||||
11
docs/sdk/models/operations/createuploadresponse.md
Normal file
11
docs/sdk/models/operations/createuploadresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
23
docs/sdk/models/operations/createuploadresponsebody.md
Normal file
23
docs/sdk/models/operations/createuploadresponsebody.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CreateUploadResponseBody
|
||||
|
||||
file uploaded
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `extension` | *string* | :heavy_check_mark: | N/A |
|
||||
| `filesize` | *number* | :heavy_check_mark: | N/A |
|
||||
| `height` | *number* | :heavy_check_mark: | N/A |
|
||||
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
|
||||
| `retainHours` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortPath` | *string* | :heavy_check_mark: | N/A |
|
||||
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
|
||||
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A |
|
||||
| `width` | *number* | :heavy_check_mark: | N/A |
|
||||
10
docs/sdk/models/operations/createuserrequest.md
Normal file
10
docs/sdk/models/operations/createuserrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateUserRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `apiKey` | *string* | :heavy_check_mark: | N/A |
|
||||
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
|
||||
| `requestBody` | [operations.CreateUserRequestBody](../../../sdk/models/operations/createuserrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
15
docs/sdk/models/operations/createuserrequestbody.md
Normal file
15
docs/sdk/models/operations/createuserrequestbody.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# CreateUserRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | This param requires an api key in the request header or it will be ignored |
|
||||
| `approved` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `email` | *string* | :heavy_check_mark: | N/A |
|
||||
| `externalIds` | [operations.ExternalIds](../../../sdk/models/operations/externalids.md) | :heavy_minus_sign: | N/A |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `password` | *string* | :heavy_check_mark: | N/A |
|
||||
| `userFields1` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `username` | *string* | :heavy_check_mark: | N/A |
|
||||
11
docs/sdk/models/operations/createuserresponse.md
Normal file
11
docs/sdk/models/operations/createuserresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
13
docs/sdk/models/operations/createuserresponsebody.md
Normal file
13
docs/sdk/models/operations/createuserresponsebody.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# CreateUserResponseBody
|
||||
|
||||
user created
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `message` | *string* | :heavy_check_mark: | N/A |
|
||||
| `success` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `userId` | *number* | :heavy_minus_sign: | N/A |
|
||||
7
docs/sdk/models/operations/customemojitranslation.md
Normal file
7
docs/sdk/models/operations/customemojitranslation.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# CustomEmojiTranslation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user