diff --git a/.eslintrc.cjs b/.eslintrc.cjs
new file mode 100644
index 0000000..4d160bd
--- /dev/null
+++ b/.eslintrc.cjs
@@ -0,0 +1,28 @@
+/* eslint-env node */
+module.exports = {
+ root: true,
+ extends: [
+ "eslint:recommended",
+ "plugin:@typescript-eslint/recommended",
+ "plugin:import/recommended",
+ "plugin:import/typescript",
+ ],
+ parser: "@typescript-eslint/parser",
+ plugins: ["@typescript-eslint"],
+ settings: {
+ "import/resolver": {
+ typescript: true,
+ node: true,
+ },
+ },
+ rules: {
+ // Handled by typescript compiler
+ "@typescript-eslint/no-unused-vars": "off",
+ "@typescript-eslint/ban-types": "off",
+ "@typescript-eslint/no-namespace": "off",
+ "@typescript-eslint/no-explicit-any": "off",
+ "import/no-named-as-default-member": "off",
+
+ "import/no-default-export": "error",
+ },
+};
diff --git a/.eslintrc.yml b/.eslintrc.yml
deleted file mode 100644
index 565e624..0000000
--- a/.eslintrc.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-env:
- browser: true
- es2021: true
- node: true
-extends:
- - eslint:recommended
- - plugin:@typescript-eslint/recommended
-overrides: []
-parser: "@typescript-eslint/parser"
-parserOptions:
- ecmaVersion: latest
- sourceType: module
-plugins:
- - "@typescript-eslint"
-rules:
- "@typescript-eslint/no-explicit-any": "off"
- "no-prototype-builtins": "off"
diff --git a/.gitignore b/.gitignore
index 1eae0cf..06cb118 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,18 @@
+/models
+/sdk/models/errors
+/sdk/types
+/node_modules
+/lib
+/sdk
+/funcs
+/hooks
+/index.*
+/core.*
+/cjs
+/esm
+/dist
+/.tsbuildinfo
+/.tshy
+/.tshy-*
dist/
node_modules/
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..3ef05d1
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,9 @@
+**/*
+!/**/*.ts
+!/**/*.js
+!/**/*.map
+
+/.eslintrc.js
+/cjs
+/.tshy
+/.tshy-*
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
index 0b2e085..2e71a3a 100755
--- a/.speakeasy/gen.lock
+++ b/.speakeasy/gen.lock
@@ -3,21 +3,131 @@ id: 599a9576-4665-431e-be1e-44cc13ef28aa
management:
docChecksum: dd4d04e62622de8f631720b5be68964d
docVersion: latest
- speakeasyVersion: 1.346.0
- generationVersion: 2.379.3
- releaseVersion: 0.4.10
- configChecksum: 240e038948a2a629d8d91a2085f29d6b
+ speakeasyVersion: 1.358.0
+ generationVersion: 2.390.6
+ releaseVersion: 0.5.0
+ configChecksum: 76366dee2b6c919409101b279e0d2575
repoURL: https://github.com/LukeHagar/discoursejs.git
repoSubDirectory: .
installationURL: https://github.com/LukeHagar/discoursejs
published: true
features:
typescript:
- core: 3.4.14
+ additionalDependencies: 0.1.0
+ additionalProperties: 0.1.1
+ constsAndDefaults: 0.1.6
+ core: 3.12.3
+ defaultEnabledRetries: 0.1.0
deprecations: 2.81.1
+ envVarSecurityUsage: 0.1.1
flattening: 2.81.1
- globalServerURLs: 2.82.2
+ globalSecurityCallbacks: 0.1.0
+ globalServerURLs: 2.82.4
+ nullables: 0.1.0
+ responseFormat: 0.2.3
+ retries: 2.83.0
+ sdkHooks: 0.1.0
generatedFiles:
+ - src/funcs/backupsCreateBackup.ts
+ - src/funcs/backupsDownloadBackup.ts
+ - src/funcs/backupsGetBackups.ts
+ - src/funcs/backupsSendDownloadBackupEmail.ts
+ - src/funcs/badgesAdminListBadges.ts
+ - src/funcs/badgesCreateBadge.ts
+ - src/funcs/badgesDeleteBadge.ts
+ - src/funcs/badgesListUserBadges.ts
+ - src/funcs/badgesUpdateBadge.ts
+ - src/funcs/groupsAddGroupMembers.ts
+ - src/funcs/groupsCreateGroup.ts
+ - src/funcs/groupsDeleteGroup.ts
+ - src/funcs/groupsGetGroup.ts
+ - src/funcs/groupsListGroupMembers.ts
+ - src/funcs/groupsListGroups.ts
+ - src/funcs/groupsRemoveGroupMembers.ts
+ - src/funcs/groupsUpdateGroup.ts
+ - src/funcs/usersActivateUser.ts
+ - src/funcs/usersAdminGetUser.ts
+ - src/funcs/usersAdminListUsers.ts
+ - src/funcs/usersAnonymizeUser.ts
+ - src/funcs/usersChangePassword.ts
+ - src/funcs/usersCreateUser.ts
+ - src/funcs/usersDeactivateUser.ts
+ - src/funcs/usersDeleteUser.ts
+ - src/funcs/usersGetUser.ts
+ - src/funcs/usersGetUserEmails.ts
+ - src/funcs/usersGetUserExternalId.ts
+ - src/funcs/usersGetUserIdentiyProviderExternalId.ts
+ - src/funcs/usersListUserActions.ts
+ - src/funcs/usersListUserBadges.ts
+ - src/funcs/usersListUsersPublic.ts
+ - src/funcs/usersLogOutUser.ts
+ - src/funcs/usersRefreshGravatar.ts
+ - src/funcs/usersSendPasswordResetEmail.ts
+ - src/funcs/usersSilenceUser.ts
+ - src/funcs/usersSuspendUser.ts
+ - src/funcs/usersUpdateAvatar.ts
+ - src/funcs/usersUpdateEmail.ts
+ - src/funcs/usersUpdateUser.ts
+ - src/funcs/usersUpdateUsername.ts
+ - src/funcs/adminActivateUser.ts
+ - src/funcs/adminAdminGetUser.ts
+ - src/funcs/adminAdminListUsers.ts
+ - src/funcs/adminAnonymizeUser.ts
+ - src/funcs/adminDeactivateUser.ts
+ - src/funcs/adminDeleteUser.ts
+ - src/funcs/adminLogOutUser.ts
+ - src/funcs/adminRefreshGravatar.ts
+ - src/funcs/adminSilenceUser.ts
+ - src/funcs/adminSuspendUser.ts
+ - src/funcs/categoriesCreateCategory.ts
+ - src/funcs/categoriesGetCategory.ts
+ - src/funcs/categoriesGetSite.ts
+ - src/funcs/categoriesListCategories.ts
+ - src/funcs/categoriesListCategoryTopics.ts
+ - src/funcs/categoriesUpdateCategory.ts
+ - src/funcs/invitesCreateInvite.ts
+ - src/funcs/invitesInviteToTopic.ts
+ - src/funcs/topicsBookmarkTopic.ts
+ - src/funcs/topicsCreateTopicPostPM.ts
+ - src/funcs/topicsCreateTopicTimer.ts
+ - src/funcs/topicsGetTopic.ts
+ - src/funcs/topicsGetTopicByExternalId.ts
+ - src/funcs/topicsInviteToTopic.ts
+ - src/funcs/topicsListLatestTopics.ts
+ - src/funcs/topicsListTopTopics.ts
+ - src/funcs/topicsRemoveTopic.ts
+ - src/funcs/topicsSetNotificationLevel.ts
+ - src/funcs/topicsUpdateTopic.ts
+ - src/funcs/topicsUpdateTopicStatus.ts
+ - src/funcs/topicsUpdateTopicTimestamp.ts
+ - src/funcs/notificationsGetNotifications.ts
+ - src/funcs/notificationsMarkNotificationsAsRead.ts
+ - src/funcs/postsCreateTopicPostPM.ts
+ - src/funcs/postsDeletePost.ts
+ - src/funcs/postsGetPost.ts
+ - src/funcs/postsListPosts.ts
+ - src/funcs/postsLockPost.ts
+ - src/funcs/postsPerformPostAction.ts
+ - src/funcs/postsPostReplies.ts
+ - src/funcs/postsUpdatePost.ts
+ - src/funcs/privateMessagesCreateTopicPostPM.ts
+ - src/funcs/privateMessagesGetUserSentPrivateMessages.ts
+ - src/funcs/privateMessagesListUserPrivateMessages.ts
+ - src/funcs/searchSearch.ts
+ - src/funcs/siteGetSite.ts
+ - src/funcs/tagsCreateTagGroup.ts
+ - src/funcs/tagsGetTag.ts
+ - src/funcs/tagsGetTagGroup.ts
+ - src/funcs/tagsListTagGroups.ts
+ - src/funcs/tagsListTags.ts
+ - src/funcs/tagsUpdateTagGroup.ts
+ - src/funcs/uploadsAbortMultipart.ts
+ - src/funcs/uploadsBatchPresignMultipartParts.ts
+ - src/funcs/uploadsCompleteExternalUpload.ts
+ - src/funcs/uploadsCompleteMultipart.ts
+ - src/funcs/uploadsCreateMultipartUpload.ts
+ - src/funcs/uploadsCreateUpload.ts
+ - src/funcs/uploadsGeneratePresignedPut.ts
- src/sdk/backups.ts
- src/sdk/badges.ts
- src/sdk/groups.ts
@@ -34,23 +144,35 @@ generatedFiles:
- src/sdk/tags.ts
- src/sdk/uploads.ts
- src/sdk/sdk.ts
- - .eslintrc.yml
- - jest.config.js
- - package-lock.json
+ - .eslintrc.cjs
+ - .npmignore
+ - RUNTIMES.md
+ - jsr.json
- package.json
+ - src/core.ts
- src/index.ts
- - src/internal/utils/contenttype.ts
- - src/internal/utils/headers.ts
- - src/internal/utils/index.ts
- - src/internal/utils/pathparams.ts
- - src/internal/utils/queryparams.ts
- - src/internal/utils/requestbody.ts
- - src/internal/utils/retries.ts
- - src/internal/utils/security.ts
- - src/internal/utils/utils.ts
+ - src/lib/base64.ts
+ - src/lib/config.ts
+ - src/lib/dlv.ts
+ - src/lib/encodings.ts
+ - src/lib/http.ts
+ - src/lib/is-plain-object.ts
+ - src/lib/matchers.ts
+ - src/lib/primitives.ts
+ - src/lib/retries.ts
+ - src/lib/schemas.ts
+ - src/lib/sdks.ts
+ - src/lib/security.ts
+ - src/lib/url.ts
- src/sdk/index.ts
+ - src/sdk/models/errors/httpclienterrors.ts
- src/sdk/models/errors/sdkerror.ts
+ - src/sdk/models/errors/sdkvalidationerror.ts
+ - src/sdk/types/blobs.ts
+ - src/sdk/types/enums.ts
+ - src/sdk/types/fp.ts
- src/sdk/types/index.ts
+ - src/sdk/types/operations.ts
- src/sdk/types/rfcdate.ts
- tsconfig.json
- src/sdk/models/operations/createbackup.ts
@@ -142,81 +264,63 @@ generatedFiles:
- src/sdk/models/operations/index.ts
- docs/sdk/models/operations/createbackuprequestbody.md
- docs/sdk/models/operations/createbackupresponsebody.md
- - docs/sdk/models/operations/createbackupresponse.md
- docs/sdk/models/operations/downloadbackuprequest.md
- - docs/sdk/models/operations/downloadbackupresponse.md
- docs/sdk/models/operations/responsebody.md
- - docs/sdk/models/operations/getbackupsresponse.md
- docs/sdk/models/operations/senddownloadbackupemailrequest.md
- - docs/sdk/models/operations/senddownloadbackupemailresponse.md
- docs/sdk/models/operations/triggers.md
- docs/sdk/models/operations/adminbadges.md
- docs/sdk/models/operations/badgegroupings.md
- docs/sdk/models/operations/badgetypes.md
- docs/sdk/models/operations/badges.md
- docs/sdk/models/operations/adminlistbadgesresponsebody.md
- - docs/sdk/models/operations/adminlistbadgesresponse.md
- docs/sdk/models/operations/createbadgerequestbody.md
- docs/sdk/models/operations/badge.md
- docs/sdk/models/operations/createbadgebadgetypes.md
- docs/sdk/models/operations/createbadgeresponsebody.md
- - docs/sdk/models/operations/createbadgeresponse.md
- docs/sdk/models/operations/deletebadgerequest.md
- - docs/sdk/models/operations/deletebadgeresponse.md
- docs/sdk/models/operations/listuserbadgesrequest.md
- docs/sdk/models/operations/listuserbadgesbadgetypes.md
- docs/sdk/models/operations/listuserbadgesbadges.md
- docs/sdk/models/operations/grantedbies.md
- docs/sdk/models/operations/userbadges.md
- docs/sdk/models/operations/listuserbadgesresponsebody.md
- - docs/sdk/models/operations/listuserbadgesresponse.md
- docs/sdk/models/operations/updatebadgerequestbody.md
- docs/sdk/models/operations/updatebadgerequest.md
- docs/sdk/models/operations/updatebadgebadge.md
- docs/sdk/models/operations/updatebadgebadgetypes.md
- docs/sdk/models/operations/updatebadgeresponsebody.md
- - docs/sdk/models/operations/updatebadgeresponse.md
- docs/sdk/models/operations/addgroupmembersrequestbody.md
- docs/sdk/models/operations/addgroupmembersrequest.md
- docs/sdk/models/operations/addgroupmembersresponsebody.md
- - docs/sdk/models/operations/addgroupmembersresponse.md
- docs/sdk/models/operations/group.md
- docs/sdk/models/operations/creategrouprequestbody.md
- docs/sdk/models/operations/basicgroup.md
- docs/sdk/models/operations/creategroupresponsebody.md
- - docs/sdk/models/operations/creategroupresponse.md
- docs/sdk/models/operations/deletegrouprequest.md
- docs/sdk/models/operations/deletegroupresponsebody.md
- - docs/sdk/models/operations/deletegroupresponse.md
- docs/sdk/models/operations/getgrouprequest.md
- docs/sdk/models/operations/extras.md
- docs/sdk/models/operations/imapupdatedby.md
- docs/sdk/models/operations/smtpupdatedby.md
- docs/sdk/models/operations/getgroupgroup.md
- docs/sdk/models/operations/getgroupresponsebody.md
- - docs/sdk/models/operations/getgroupresponse.md
- docs/sdk/models/operations/listgroupmembersrequest.md
- docs/sdk/models/operations/members.md
- docs/sdk/models/operations/meta.md
- docs/sdk/models/operations/owners.md
- docs/sdk/models/operations/listgroupmembersresponsebody.md
- - docs/sdk/models/operations/listgroupmembersresponse.md
- docs/sdk/models/operations/listgroupsextras.md
- docs/sdk/models/operations/groups.md
- docs/sdk/models/operations/listgroupsresponsebody.md
- - docs/sdk/models/operations/listgroupsresponse.md
- docs/sdk/models/operations/removegroupmembersrequestbody.md
- docs/sdk/models/operations/removegroupmembersrequest.md
- docs/sdk/models/operations/removegroupmembersresponsebody.md
- - docs/sdk/models/operations/removegroupmembersresponse.md
- docs/sdk/models/operations/updategroupgroup.md
- docs/sdk/models/operations/updategrouprequestbody.md
- docs/sdk/models/operations/updategrouprequest.md
- docs/sdk/models/operations/updategroupresponsebody.md
- - docs/sdk/models/operations/updategroupresponse.md
- docs/sdk/models/operations/activateuserrequest.md
- docs/sdk/models/operations/activateuserresponsebody.md
- - docs/sdk/models/operations/activateuserresponse.md
- docs/sdk/models/operations/admingetuserrequest.md
- docs/sdk/models/operations/approvedby.md
- docs/sdk/models/operations/admingetuserexternalids.md
@@ -225,31 +329,24 @@ generatedFiles:
- docs/sdk/models/operations/admingetuserpenaltycounts.md
- docs/sdk/models/operations/tl3requirements.md
- docs/sdk/models/operations/admingetuserresponsebody.md
- - docs/sdk/models/operations/admingetuserresponse.md
- docs/sdk/models/operations/queryparamasc.md
- docs/sdk/models/operations/flag.md
- docs/sdk/models/operations/queryparamorder.md
- docs/sdk/models/operations/adminlistusersrequest.md
- docs/sdk/models/operations/adminlistusersresponsebody.md
- - docs/sdk/models/operations/adminlistusersresponse.md
- docs/sdk/models/operations/anonymizeuserrequest.md
- docs/sdk/models/operations/anonymizeuserresponsebody.md
- - docs/sdk/models/operations/anonymizeuserresponse.md
- docs/sdk/models/operations/changepasswordrequestbody.md
- docs/sdk/models/operations/changepasswordrequest.md
- - docs/sdk/models/operations/changepasswordresponse.md
- docs/sdk/models/operations/externalids.md
- docs/sdk/models/operations/createuserrequestbody.md
- docs/sdk/models/operations/createuserrequest.md
- docs/sdk/models/operations/createuserresponsebody.md
- - docs/sdk/models/operations/createuserresponse.md
- docs/sdk/models/operations/deactivateuserrequest.md
- docs/sdk/models/operations/deactivateuserresponsebody.md
- - docs/sdk/models/operations/deactivateuserresponse.md
- docs/sdk/models/operations/deleteuserrequestbody.md
- docs/sdk/models/operations/deleteuserrequest.md
- docs/sdk/models/operations/deleteuserresponsebody.md
- - docs/sdk/models/operations/deleteuserresponse.md
- docs/sdk/models/operations/getuserrequest.md
- docs/sdk/models/operations/getusercustomfields.md
- docs/sdk/models/operations/groupusers.md
@@ -260,10 +357,8 @@ generatedFiles:
- docs/sdk/models/operations/useroption.md
- docs/sdk/models/operations/user.md
- docs/sdk/models/operations/getuserresponsebody.md
- - docs/sdk/models/operations/getuserresponse.md
- docs/sdk/models/operations/getuseremailsrequest.md
- docs/sdk/models/operations/getuseremailsresponsebody.md
- - docs/sdk/models/operations/getuseremailsresponse.md
- docs/sdk/models/operations/getuserexternalidrequest.md
- docs/sdk/models/operations/getuserexternalidcustomfields.md
- docs/sdk/models/operations/getuserexternalidgroupusers.md
@@ -274,7 +369,6 @@ generatedFiles:
- docs/sdk/models/operations/getuserexternaliduseroption.md
- docs/sdk/models/operations/getuserexternaliduser.md
- docs/sdk/models/operations/getuserexternalidresponsebody.md
- - docs/sdk/models/operations/getuserexternalidresponse.md
- docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md
- docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md
- docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md
@@ -285,11 +379,9 @@ generatedFiles:
- docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md
- docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md
- docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md
- - docs/sdk/models/operations/getuseridentiyproviderexternalidresponse.md
- docs/sdk/models/operations/listuseractionsrequest.md
- docs/sdk/models/operations/useractions.md
- docs/sdk/models/operations/listuseractionsresponsebody.md
- - docs/sdk/models/operations/listuseractionsresponse.md
- docs/sdk/models/operations/asc.md
- docs/sdk/models/operations/order.md
- docs/sdk/models/operations/period.md
@@ -298,59 +390,48 @@ generatedFiles:
- docs/sdk/models/operations/directoryitems.md
- docs/sdk/models/operations/listuserspublicmeta.md
- docs/sdk/models/operations/listuserspublicresponsebody.md
- - docs/sdk/models/operations/listuserspublicresponse.md
- docs/sdk/models/operations/logoutuserrequest.md
- docs/sdk/models/operations/logoutuserresponsebody.md
- - docs/sdk/models/operations/logoutuserresponse.md
- docs/sdk/models/operations/refreshgravatarrequest.md
- docs/sdk/models/operations/refreshgravatarresponsebody.md
- - docs/sdk/models/operations/refreshgravatarresponse.md
- docs/sdk/models/operations/sendpasswordresetemailrequestbody.md
- docs/sdk/models/operations/sendpasswordresetemailresponsebody.md
- - docs/sdk/models/operations/sendpasswordresetemailresponse.md
- docs/sdk/models/operations/silenceuserrequestbody.md
- docs/sdk/models/operations/silenceuserrequest.md
- docs/sdk/models/operations/silencedby.md
- docs/sdk/models/operations/silence.md
- docs/sdk/models/operations/silenceuserresponsebody.md
- - docs/sdk/models/operations/silenceuserresponse.md
- docs/sdk/models/operations/suspenduserrequestbody.md
- docs/sdk/models/operations/suspenduserrequest.md
- docs/sdk/models/operations/suspendedby.md
- docs/sdk/models/operations/suspension.md
- docs/sdk/models/operations/suspenduserresponsebody.md
- - docs/sdk/models/operations/suspenduserresponse.md
- docs/sdk/models/operations/updateavatartype.md
- docs/sdk/models/operations/updateavatarrequestbody.md
- docs/sdk/models/operations/updateavatarrequest.md
- docs/sdk/models/operations/updateavatarresponsebody.md
- - docs/sdk/models/operations/updateavatarresponse.md
- docs/sdk/models/operations/updateemailrequestbody.md
- docs/sdk/models/operations/updateemailrequest.md
- - docs/sdk/models/operations/updateemailresponse.md
- docs/sdk/models/operations/updateuserexternalids.md
- docs/sdk/models/operations/updateuserrequestbody.md
- docs/sdk/models/operations/updateuserrequest.md
- docs/sdk/models/operations/updateuseruser.md
- docs/sdk/models/operations/updateuserresponsebody.md
- - docs/sdk/models/operations/updateuserresponse.md
- docs/sdk/models/operations/updateusernamerequestbody.md
- docs/sdk/models/operations/updateusernamerequest.md
- - docs/sdk/models/operations/updateusernameresponse.md
+ - docs/sdk/models/operations/permissions.md
- docs/sdk/models/operations/createcategoryrequestbody.md
- docs/sdk/models/operations/customfields.md
- docs/sdk/models/operations/grouppermissions.md
- docs/sdk/models/operations/requiredtaggroups.md
- docs/sdk/models/operations/category.md
- docs/sdk/models/operations/createcategoryresponsebody.md
- - docs/sdk/models/operations/createcategoryresponse.md
- docs/sdk/models/operations/getcategoryrequest.md
- docs/sdk/models/operations/getcategorycustomfields.md
- docs/sdk/models/operations/getcategorygrouppermissions.md
- docs/sdk/models/operations/getcategoryrequiredtaggroups.md
- docs/sdk/models/operations/getcategorycategory.md
- docs/sdk/models/operations/getcategoryresponsebody.md
- - docs/sdk/models/operations/getcategoryresponse.md
- docs/sdk/models/operations/archetypes.md
- docs/sdk/models/operations/getsiterequiredtaggroups.md
- docs/sdk/models/operations/getsitecategories.md
@@ -370,19 +451,17 @@ generatedFiles:
- docs/sdk/models/operations/userthemes.md
- docs/sdk/models/operations/usertips.md
- docs/sdk/models/operations/getsiteresponsebody.md
- - docs/sdk/models/operations/getsiteresponse.md
- docs/sdk/models/operations/listcategoriesrequest.md
- docs/sdk/models/operations/categories.md
- docs/sdk/models/operations/categorylist.md
- docs/sdk/models/operations/listcategoriesresponsebody.md
- - docs/sdk/models/operations/listcategoriesresponse.md
- docs/sdk/models/operations/listcategorytopicsrequest.md
- docs/sdk/models/operations/listcategorytopicsposters.md
- docs/sdk/models/operations/topics.md
- docs/sdk/models/operations/topiclist.md
- docs/sdk/models/operations/users.md
- docs/sdk/models/operations/listcategorytopicsresponsebody.md
- - docs/sdk/models/operations/listcategorytopicsresponse.md
+ - docs/sdk/models/operations/updatecategorypermissions.md
- docs/sdk/models/operations/updatecategoryrequestbody.md
- docs/sdk/models/operations/updatecategoryrequest.md
- docs/sdk/models/operations/updatecategorycustomfields.md
@@ -390,26 +469,20 @@ generatedFiles:
- docs/sdk/models/operations/updatecategoryrequiredtaggroups.md
- docs/sdk/models/operations/updatecategorycategory.md
- docs/sdk/models/operations/updatecategoryresponsebody.md
- - docs/sdk/models/operations/updatecategoryresponse.md
- docs/sdk/models/operations/createinviterequestbody.md
- docs/sdk/models/operations/createinviterequest.md
- docs/sdk/models/operations/createinviteresponsebody.md
- - docs/sdk/models/operations/createinviteresponse.md
- docs/sdk/models/operations/invitetotopicrequestbody.md
- docs/sdk/models/operations/invitetotopicrequest.md
- docs/sdk/models/operations/invitetotopicuser.md
- docs/sdk/models/operations/invitetotopicresponsebody.md
- - docs/sdk/models/operations/invitetotopicresponse.md
- docs/sdk/models/operations/bookmarktopicrequest.md
- - docs/sdk/models/operations/bookmarktopicresponse.md
- docs/sdk/models/operations/createtopicpostpmrequestbody.md
- docs/sdk/models/operations/createtopicpostpmactionssummary.md
- docs/sdk/models/operations/createtopicpostpmresponsebody.md
- - docs/sdk/models/operations/createtopicpostpmresponse.md
- docs/sdk/models/operations/createtopictimerrequestbody.md
- docs/sdk/models/operations/createtopictimerrequest.md
- docs/sdk/models/operations/createtopictimerresponsebody.md
- - docs/sdk/models/operations/createtopictimerresponse.md
- docs/sdk/models/operations/gettopicrequest.md
- docs/sdk/models/operations/gettopicactionssummary.md
- docs/sdk/models/operations/createdby.md
@@ -426,92 +499,75 @@ generatedFiles:
- docs/sdk/models/operations/suggestedtopics.md
- docs/sdk/models/operations/tagsdescriptions.md
- docs/sdk/models/operations/gettopicresponsebody.md
- - docs/sdk/models/operations/gettopicresponse.md
- docs/sdk/models/operations/gettopicbyexternalidrequest.md
- - docs/sdk/models/operations/gettopicbyexternalidresponse.md
- docs/sdk/models/operations/listlatesttopicsrequest.md
- docs/sdk/models/operations/listlatesttopicsposters.md
- docs/sdk/models/operations/listlatesttopicstopics.md
- docs/sdk/models/operations/listlatesttopicstopiclist.md
- docs/sdk/models/operations/listlatesttopicsusers.md
- docs/sdk/models/operations/listlatesttopicsresponsebody.md
- - docs/sdk/models/operations/listlatesttopicsresponse.md
- docs/sdk/models/operations/listtoptopicsrequest.md
- docs/sdk/models/operations/listtoptopicsposters.md
- docs/sdk/models/operations/listtoptopicstopics.md
- docs/sdk/models/operations/listtoptopicstopiclist.md
- docs/sdk/models/operations/listtoptopicsusers.md
- docs/sdk/models/operations/listtoptopicsresponsebody.md
- - docs/sdk/models/operations/listtoptopicsresponse.md
- docs/sdk/models/operations/removetopicrequest.md
- - docs/sdk/models/operations/removetopicresponse.md
- docs/sdk/models/operations/notificationlevel.md
- docs/sdk/models/operations/setnotificationlevelrequestbody.md
- docs/sdk/models/operations/setnotificationlevelrequest.md
- docs/sdk/models/operations/setnotificationlevelresponsebody.md
- - docs/sdk/models/operations/setnotificationlevelresponse.md
- docs/sdk/models/operations/topic.md
- docs/sdk/models/operations/updatetopicrequestbody.md
- docs/sdk/models/operations/updatetopicrequest.md
- docs/sdk/models/operations/basictopic.md
- docs/sdk/models/operations/updatetopicresponsebody.md
- - docs/sdk/models/operations/updatetopicresponse.md
- docs/sdk/models/operations/enabled.md
- docs/sdk/models/operations/status.md
- docs/sdk/models/operations/updatetopicstatusrequestbody.md
- docs/sdk/models/operations/updatetopicstatusrequest.md
- docs/sdk/models/operations/updatetopicstatusresponsebody.md
- - docs/sdk/models/operations/updatetopicstatusresponse.md
- docs/sdk/models/operations/updatetopictimestamprequestbody.md
- docs/sdk/models/operations/updatetopictimestamprequest.md
- docs/sdk/models/operations/updatetopictimestampresponsebody.md
- - docs/sdk/models/operations/updatetopictimestampresponse.md
- docs/sdk/models/operations/data.md
- docs/sdk/models/operations/notifications.md
- docs/sdk/models/operations/getnotificationsresponsebody.md
- - docs/sdk/models/operations/getnotificationsresponse.md
- docs/sdk/models/operations/marknotificationsasreadrequestbody.md
- docs/sdk/models/operations/marknotificationsasreadresponsebody.md
- - docs/sdk/models/operations/marknotificationsasreadresponse.md
- docs/sdk/models/operations/deletepostrequestbody.md
- docs/sdk/models/operations/deletepostrequest.md
- - docs/sdk/models/operations/deletepostresponse.md
- docs/sdk/models/operations/getpostrequest.md
- - docs/sdk/models/operations/getpostresponse.md
+ - docs/sdk/models/operations/actionssummary.md
+ - docs/sdk/models/operations/getpostresponsebody.md
- docs/sdk/models/operations/listpostsrequest.md
- docs/sdk/models/operations/listpostsactionssummary.md
- docs/sdk/models/operations/latestposts.md
- docs/sdk/models/operations/listpostsresponsebody.md
- - docs/sdk/models/operations/listpostsresponse.md
- docs/sdk/models/operations/lockpostrequestbody.md
- docs/sdk/models/operations/lockpostrequest.md
- docs/sdk/models/operations/lockpostresponsebody.md
- - docs/sdk/models/operations/lockpostresponse.md
- docs/sdk/models/operations/performpostactionrequestbody.md
- docs/sdk/models/operations/performpostactionrequest.md
- - docs/sdk/models/operations/actionssummary.md
+ - docs/sdk/models/operations/performpostactionactionssummary.md
- docs/sdk/models/operations/notice.md
- docs/sdk/models/operations/performpostactionresponsebody.md
- - docs/sdk/models/operations/performpostactionresponse.md
- docs/sdk/models/operations/postrepliesrequest.md
- docs/sdk/models/operations/postrepliesactionssummary.md
- docs/sdk/models/operations/replytouser.md
- docs/sdk/models/operations/postrepliesresponsebody.md
- - docs/sdk/models/operations/postrepliesresponse.md
- docs/sdk/models/operations/post.md
- docs/sdk/models/operations/updatepostrequestbody.md
- docs/sdk/models/operations/updatepostrequest.md
- docs/sdk/models/operations/updatepostactionssummary.md
- docs/sdk/models/operations/updatepostpost.md
- docs/sdk/models/operations/updatepostresponsebody.md
- - docs/sdk/models/operations/updatepostresponse.md
- docs/sdk/models/operations/getusersentprivatemessagesrequest.md
- docs/sdk/models/operations/getusersentprivatemessagesposters.md
- docs/sdk/models/operations/getusersentprivatemessagestopics.md
- docs/sdk/models/operations/getusersentprivatemessagestopiclist.md
- docs/sdk/models/operations/getusersentprivatemessagesusers.md
- docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md
- - docs/sdk/models/operations/getusersentprivatemessagesresponse.md
- docs/sdk/models/operations/listuserprivatemessagesrequest.md
- docs/sdk/models/operations/listuserprivatemessagesparticipants.md
- docs/sdk/models/operations/listuserprivatemessagesposters.md
@@ -519,16 +575,13 @@ generatedFiles:
- docs/sdk/models/operations/listuserprivatemessagestopiclist.md
- docs/sdk/models/operations/listuserprivatemessagesusers.md
- docs/sdk/models/operations/listuserprivatemessagesresponsebody.md
- - docs/sdk/models/operations/listuserprivatemessagesresponse.md
- docs/sdk/models/operations/searchrequest.md
- docs/sdk/models/operations/groupedsearchresult.md
- docs/sdk/models/operations/searchresponsebody.md
- - docs/sdk/models/operations/searchresponse.md
- docs/sdk/models/operations/createtaggrouprequestbody.md
- - docs/sdk/models/operations/permissions.md
+ - docs/sdk/models/operations/createtaggrouppermissions.md
- docs/sdk/models/operations/taggroup.md
- docs/sdk/models/operations/createtaggroupresponsebody.md
- - docs/sdk/models/operations/createtaggroupresponse.md
- docs/sdk/models/operations/gettagrequest.md
- docs/sdk/models/operations/gettagtags.md
- docs/sdk/models/operations/gettagposters.md
@@ -536,56 +589,45 @@ generatedFiles:
- docs/sdk/models/operations/gettagtopiclist.md
- docs/sdk/models/operations/gettagusers.md
- docs/sdk/models/operations/gettagresponsebody.md
- - docs/sdk/models/operations/gettagresponse.md
- docs/sdk/models/operations/gettaggrouprequest.md
- docs/sdk/models/operations/gettaggrouppermissions.md
- docs/sdk/models/operations/gettaggrouptaggroup.md
- docs/sdk/models/operations/gettaggroupresponsebody.md
- - docs/sdk/models/operations/gettaggroupresponse.md
- docs/sdk/models/operations/listtaggroupspermissions.md
- docs/sdk/models/operations/taggroups.md
- docs/sdk/models/operations/listtaggroupsresponsebody.md
- - docs/sdk/models/operations/listtaggroupsresponse.md
- docs/sdk/models/operations/listtagsextras.md
- docs/sdk/models/operations/tags.md
- docs/sdk/models/operations/listtagsresponsebody.md
- - docs/sdk/models/operations/listtagsresponse.md
- docs/sdk/models/operations/updatetaggrouprequestbody.md
- docs/sdk/models/operations/updatetaggrouprequest.md
- docs/sdk/models/operations/updatetaggrouppermissions.md
- docs/sdk/models/operations/updatetaggrouptaggroup.md
- docs/sdk/models/operations/updatetaggroupresponsebody.md
- - docs/sdk/models/operations/updatetaggroupresponse.md
- docs/sdk/models/operations/abortmultipartrequestbody.md
- docs/sdk/models/operations/abortmultipartresponsebody.md
- - docs/sdk/models/operations/abortmultipartresponse.md
- docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md
- docs/sdk/models/operations/presignedurls.md
- docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md
- - docs/sdk/models/operations/batchpresignmultipartpartsresponse.md
- docs/sdk/models/operations/completeexternaluploadrequestbody.md
- docs/sdk/models/operations/completeexternaluploadresponsebody.md
- - docs/sdk/models/operations/completeexternaluploadresponse.md
- docs/sdk/models/operations/completemultipartrequestbody.md
- docs/sdk/models/operations/completemultipartresponsebody.md
- - docs/sdk/models/operations/completemultipartresponse.md
- docs/sdk/models/operations/metadata.md
- docs/sdk/models/operations/uploadtype.md
- docs/sdk/models/operations/createmultipartuploadrequestbody.md
- docs/sdk/models/operations/createmultipartuploadresponsebody.md
- - docs/sdk/models/operations/createmultipartuploadresponse.md
- - docs/sdk/models/operations/file.md
- - docs/sdk/models/operations/typet.md
+ - docs/sdk/models/operations/filet.md
+ - docs/sdk/models/operations/type.md
- docs/sdk/models/operations/createuploadrequestbody.md
- docs/sdk/models/operations/createuploadresponsebody.md
- - docs/sdk/models/operations/createuploadresponse.md
- docs/sdk/models/operations/generatepresignedputmetadata.md
- docs/sdk/models/operations/generatepresignedputtype.md
- docs/sdk/models/operations/generatepresignedputrequestbody.md
- docs/sdk/models/operations/signedheaders.md
- docs/sdk/models/operations/generatepresignedputresponsebody.md
- - docs/sdk/models/operations/generatepresignedputresponse.md
- docs/sdks/sdk/README.md
+ - docs/lib/utils/retryconfig.md
- docs/sdks/backups/README.md
- docs/sdks/badges/README.md
- docs/sdks/groups/README.md
@@ -603,3 +645,7 @@ generatedFiles:
- docs/sdks/uploads/README.md
- USAGE.md
- .gitattributes
+ - src/hooks/hooks.ts
+ - src/hooks/types.ts
+ - src/hooks/index.ts
+ - CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d585717
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
+
+## How to Report Issues
+
+If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+ - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers
diff --git a/README.md b/README.md
index a313002..4cff033 100644
--- a/README.md
+++ b/README.md
@@ -16,10 +16,25 @@
npm add @lukehagar/discoursejs
```
+### PNPM
+
+```bash
+pnpm add @lukehagar/discoursejs
+```
+
+### Bun
+
+```bash
+bun add @lukehagar/discoursejs
+```
+
### Yarn
```bash
-yarn add @lukehagar/discoursejs
+yarn add @lukehagar/discoursejs zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
```
@@ -31,16 +46,13 @@ yarn add @lukehagar/discoursejs
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.backups.createBackup();
- const res = await sdk.backups.createBackup({
- withUploads: false,
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result);
}
run();
@@ -200,35 +212,42 @@ run();
## Error Handling
-Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
-Example
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+
```typescript
import { SDK } from "@lukehagar/discoursejs";
+import { SDKValidationError } from "@lukehagar/discoursejs/sdk/models/errors";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-
- let res;
+ let result;
try {
- res = await sdk.backups.createBackup({
- withUploads: false,
- });
+ result = await sdk.backups.createBackup();
} catch (err) {
- if (err instanceof errors.SDKError) {
- console.error(err); // handle exception
- throw err;
+ switch (true) {
+ case err instanceof SDKValidationError: {
+ // Validation errors can be pretty-printed
+ console.error(err.pretty());
+ // Raw value may also be inspected
+ console.error(err.rawValue);
+ return;
+ }
+ default: {
+ throw err;
+ }
}
}
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result);
}
run();
@@ -241,29 +260,24 @@ run();
### Select Server by Index
-You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://{defaultHost}` | `defaultHost` (default is `discourse.example.com`) |
-#### Example
-
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK({
+ serverIdx: 0,
+});
+
async function run() {
- const sdk = new SDK({
- serverIdx: 0,
- });
+ const result = await sdk.backups.createBackup();
- const res = await sdk.backups.createBackup({
- withUploads: false,
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result);
}
run();
@@ -277,22 +291,20 @@ Some of the server options above contain variables. If you want to set the value
### Override Server URL Per-Client
-The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
+The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
+
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK({
+ serverURL: "https://{defaultHost}",
+});
+
async function run() {
- const sdk = new SDK({
- serverURL: "https://{defaultHost}",
- });
+ const result = await sdk.backups.createBackup();
- const res = await sdk.backups.createBackup({
- withUploads: false,
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result);
}
run();
@@ -303,22 +315,151 @@ run();
## Custom HTTP Client
-The Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
-For example, you could specify a header for every request that your sdk makes as follows:
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
```typescript
-import { @lukehagar/discoursejs } from "SDK";
-import axios from "axios";
+import { SDK } from "@lukehagar/discoursejs";
+import { HTTPClient } from "@lukehagar/discoursejs/lib/http";
-const httpClient = axios.create({
- headers: {'x-custom-header': 'someValue'}
-})
+const httpClient = new HTTPClient({
+ // fetcher takes a function that has the same signature as native `fetch`.
+ fetcher: (request) => {
+ return fetch(request);
+ }
+});
-const sdk = new SDK({defaultClient: httpClient});
+httpClient.addHook("beforeRequest", (request) => {
+ const nextRequest = new Request(request, {
+ signal: request.signal || AbortSignal.timeout(5000)
+ });
+
+ nextRequest.headers.set("x-custom-header", "custom value");
+
+ return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+ console.group("Request Error");
+ console.log("Reason:", `${error}`);
+ console.log("Endpoint:", `${request.method} ${request.url}`);
+ console.groupEnd();
+});
+
+const sdk = new SDK({ httpClient });
```
+
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+
+
+
+## File uploads
+
+Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
+
+> [!TIP]
+>
+> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
+>
+> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
+> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
+> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.
+> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
+
+```typescript
+import { SDK } from "@lukehagar/discoursejs";
+
+const sdk = new SDK();
+
+async function run() {
+ const result = await sdk.uploads.createUpload();
+
+ // Handle the result
+ console.log(result);
+}
+
+run();
+
+```
+
+
+
+## Retries
+
+Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { SDK } from "@lukehagar/discoursejs";
+
+const sdk = new SDK();
+
+async function run() {
+ const result = await sdk.backups.createBackup({
+ retries: {
+ strategy: "backoff",
+ backoff: {
+ initialInterval: 1,
+ maxInterval: 50,
+ exponent: 1.1,
+ maxElapsedTime: 100,
+ },
+ retryConnectionErrors: false,
+ },
+ });
+
+ // Handle the result
+ console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { SDK } from "@lukehagar/discoursejs";
+
+const sdk = new SDK({
+ retryConfig: {
+ strategy: "backoff",
+ backoff: {
+ initialInterval: 1,
+ maxInterval: 50,
+ exponent: 1.1,
+ maxElapsedTime: 100,
+ },
+ retryConnectionErrors: false,
+ },
+});
+
+async function run() {
+ const result = await sdk.backups.createBackup();
+
+ // Handle the result
+ console.log(result);
+}
+
+run();
+
+```
+
+
# Development
diff --git a/RELEASES.md b/RELEASES.md
index f8972c7..69cf3bb 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -168,4 +168,14 @@ Based on:
### Generated
- [typescript v0.4.10] .
### Releases
-- [NPM v0.4.10] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.4.10 - .
\ No newline at end of file
+- [NPM v0.4.10] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.4.10 - .
+
+## 2024-08-09 00:22:32
+### Changes
+Based on:
+- OpenAPI Doc latest
+- Speakeasy CLI 1.358.0 (2.390.6) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.5.0] .
+### Releases
+- [NPM v0.5.0] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.5.0 - .
\ No newline at end of file
diff --git a/RUNTIMES.md b/RUNTIMES.md
new file mode 100644
index 0000000..d08a0c0
--- /dev/null
+++ b/RUNTIMES.md
@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+ - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+ - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
diff --git a/USAGE.md b/USAGE.md
index acb239a..5e7d16e 100644
--- a/USAGE.md
+++ b/USAGE.md
@@ -2,16 +2,13 @@
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.backups.createBackup();
- const res = await sdk.backups.createBackup({
- withUploads: false,
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result);
}
run();
diff --git a/docs/lib/utils/retryconfig.md b/docs/lib/utils/retryconfig.md
new file mode 100644
index 0000000..08f95f4
--- /dev/null
+++ b/docs/lib/utils/retryconfig.md
@@ -0,0 +1,24 @@
+# RetryConfig
+
+Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
+
+## Fields
+
+| Name | Type | Description | Example |
+| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
+| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
+| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
+| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name | Type | Description | Example |
+| ------------------ | ------------ | ----------------------------------------- | -------- |
+| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
+| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
+| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
+| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/abortmultipartresponse.md b/docs/sdk/models/operations/abortmultipartresponse.md
deleted file mode 100644
index 07ed722..0000000
--- a/docs/sdk/models/operations/abortmultipartresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AbortMultipartResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.AbortMultipartResponseBody](../../../sdk/models/operations/abortmultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/actionssummary.md b/docs/sdk/models/operations/actionssummary.md
index 4f643dc..156d29b 100644
--- a/docs/sdk/models/operations/actionssummary.md
+++ b/docs/sdk/models/operations/actionssummary.md
@@ -3,9 +3,10 @@
## 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 |
\ No newline at end of file
+| Field | Type | Required | Description |
+| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
+| `acted` | *boolean* | :heavy_minus_sign: | N/A |
+| `canAct` | *boolean* | :heavy_minus_sign: | N/A |
+| `canUndo` | *boolean* | :heavy_minus_sign: | N/A |
+| `count` | *number* | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | `2`: like, `3`, `4`, `6`, `7`, `8`: flag |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/activateuserresponse.md b/docs/sdk/models/operations/activateuserresponse.md
deleted file mode 100644
index 1d06e5c..0000000
--- a/docs/sdk/models/operations/activateuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ActivateUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ActivateUserResponseBody](../../../sdk/models/operations/activateuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/addgroupmembersrequest.md b/docs/sdk/models/operations/addgroupmembersrequest.md
index 54e8ec2..716992a 100644
--- a/docs/sdk/models/operations/addgroupmembersrequest.md
+++ b/docs/sdk/models/operations/addgroupmembersrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.AddGroupMembersRequestBody](../../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.AddGroupMembersRequestBody](../../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/addgroupmembersresponse.md b/docs/sdk/models/operations/addgroupmembersresponse.md
deleted file mode 100644
index f2deae5..0000000
--- a/docs/sdk/models/operations/addgroupmembersresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AddGroupMembersResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.AddGroupMembersResponseBody](../../../sdk/models/operations/addgroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/admingetuserresponse.md b/docs/sdk/models/operations/admingetuserresponse.md
deleted file mode 100644
index 37b8ba8..0000000
--- a/docs/sdk/models/operations/admingetuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AdminGetUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.AdminGetUserResponseBody](../../../sdk/models/operations/admingetuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/adminlistbadgesresponse.md b/docs/sdk/models/operations/adminlistbadgesresponse.md
deleted file mode 100644
index a127881..0000000
--- a/docs/sdk/models/operations/adminlistbadgesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AdminListBadgesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.AdminListBadgesResponseBody](../../../sdk/models/operations/adminlistbadgesresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/adminlistusersresponse.md b/docs/sdk/models/operations/adminlistusersresponse.md
deleted file mode 100644
index 021275b..0000000
--- a/docs/sdk/models/operations/adminlistusersresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AdminListUsersResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `responseBodies` | [operations.AdminListUsersResponseBody](../../../sdk/models/operations/adminlistusersresponsebody.md)[] | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/anonymizeuserresponse.md b/docs/sdk/models/operations/anonymizeuserresponse.md
deleted file mode 100644
index 8230e22..0000000
--- a/docs/sdk/models/operations/anonymizeuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# AnonymizeUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.AnonymizeUserResponseBody](../../../sdk/models/operations/anonymizeuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/batchpresignmultipartpartsresponse.md b/docs/sdk/models/operations/batchpresignmultipartpartsresponse.md
deleted file mode 100644
index a9ca20e..0000000
--- a/docs/sdk/models/operations/batchpresignmultipartpartsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# BatchPresignMultipartPartsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.BatchPresignMultipartPartsResponseBody](../../../sdk/models/operations/batchpresignmultipartpartsresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/bookmarktopicresponse.md b/docs/sdk/models/operations/bookmarktopicresponse.md
deleted file mode 100644
index 1ce4a92..0000000
--- a/docs/sdk/models/operations/bookmarktopicresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# BookmarkTopicResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/changepasswordrequest.md b/docs/sdk/models/operations/changepasswordrequest.md
index 79749b0..b12d333 100644
--- a/docs/sdk/models/operations/changepasswordrequest.md
+++ b/docs/sdk/models/operations/changepasswordrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `token` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.ChangePasswordRequestBody](../../../sdk/models/operations/changepasswordrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.ChangePasswordRequestBody](../../../sdk/models/operations/changepasswordrequestbody.md) | :heavy_minus_sign: | N/A |
+| `token` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/changepasswordresponse.md b/docs/sdk/models/operations/changepasswordresponse.md
deleted file mode 100644
index 6056773..0000000
--- a/docs/sdk/models/operations/changepasswordresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# ChangePasswordResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/completeexternaluploadresponse.md b/docs/sdk/models/operations/completeexternaluploadresponse.md
deleted file mode 100644
index d73ec93..0000000
--- a/docs/sdk/models/operations/completeexternaluploadresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CompleteExternalUploadResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CompleteExternalUploadResponseBody](../../../sdk/models/operations/completeexternaluploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/completemultipartresponse.md b/docs/sdk/models/operations/completemultipartresponse.md
deleted file mode 100644
index 13be7e2..0000000
--- a/docs/sdk/models/operations/completemultipartresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CompleteMultipartResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CompleteMultipartResponseBody](../../../sdk/models/operations/completemultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createbackupresponse.md b/docs/sdk/models/operations/createbackupresponse.md
deleted file mode 100644
index f422d86..0000000
--- a/docs/sdk/models/operations/createbackupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateBackupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateBackupResponseBody](../../../sdk/models/operations/createbackupresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createbadgeresponse.md b/docs/sdk/models/operations/createbadgeresponse.md
deleted file mode 100644
index 50eca0f..0000000
--- a/docs/sdk/models/operations/createbadgeresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateBadgeResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateBadgeResponseBody](../../../sdk/models/operations/createbadgeresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createcategoryrequestbody.md b/docs/sdk/models/operations/createcategoryrequestbody.md
index da7aceb..b4d4917 100644
--- a/docs/sdk/models/operations/createcategoryrequestbody.md
+++ b/docs/sdk/models/operations/createcategoryrequestbody.md
@@ -3,15 +3,15 @@
## 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 | :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 | |
\ No newline at end of file
+| 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` | [operations.Permissions](../../../sdk/models/operations/permissions.md) | :heavy_minus_sign: | N/A | |
+| `searchPriority` | *number* | :heavy_minus_sign: | N/A | |
+| `slug` | *string* | :heavy_minus_sign: | N/A | |
+| `textColor` | *string* | :heavy_minus_sign: | N/A | f0fcfd |
+| `topicFeaturedLinksAllowed` | *boolean* | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createcategoryresponse.md b/docs/sdk/models/operations/createcategoryresponse.md
deleted file mode 100644
index dc71f27..0000000
--- a/docs/sdk/models/operations/createcategoryresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateCategoryResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateCategoryResponseBody](../../../sdk/models/operations/createcategoryresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/creategroupresponse.md b/docs/sdk/models/operations/creategroupresponse.md
deleted file mode 100644
index cbedf5d..0000000
--- a/docs/sdk/models/operations/creategroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateGroupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateGroupResponseBody](../../../sdk/models/operations/creategroupresponsebody.md) | :heavy_minus_sign: | group created |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createinviteresponse.md b/docs/sdk/models/operations/createinviteresponse.md
deleted file mode 100644
index 17c1b7a..0000000
--- a/docs/sdk/models/operations/createinviteresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateInviteResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateInviteResponseBody](../../../sdk/models/operations/createinviteresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createmultipartuploadresponse.md b/docs/sdk/models/operations/createmultipartuploadresponse.md
deleted file mode 100644
index 227f405..0000000
--- a/docs/sdk/models/operations/createmultipartuploadresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateMultipartUploadResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateMultipartUploadResponseBody](../../../sdk/models/operations/createmultipartuploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createtaggrouppermissions.md b/docs/sdk/models/operations/createtaggrouppermissions.md
new file mode 100644
index 0000000..712e530
--- /dev/null
+++ b/docs/sdk/models/operations/createtaggrouppermissions.md
@@ -0,0 +1,7 @@
+# CreateTagGroupPermissions
+
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------- | ----------- | ----------- | ----------- |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createtaggroupresponse.md b/docs/sdk/models/operations/createtaggroupresponse.md
deleted file mode 100644
index 52f2968..0000000
--- a/docs/sdk/models/operations/createtaggroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateTagGroupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateTagGroupResponseBody](../../../sdk/models/operations/createtaggroupresponsebody.md) | :heavy_minus_sign: | tag group created |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createtopicpostpmresponse.md b/docs/sdk/models/operations/createtopicpostpmresponse.md
deleted file mode 100644
index c6e5818..0000000
--- a/docs/sdk/models/operations/createtopicpostpmresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateTopicPostPMResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateTopicPostPMResponseBody](../../../sdk/models/operations/createtopicpostpmresponsebody.md) | :heavy_minus_sign: | post created |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createtopictimerrequest.md b/docs/sdk/models/operations/createtopictimerrequest.md
index 6863876..d08d010 100644
--- a/docs/sdk/models/operations/createtopictimerrequest.md
+++ b/docs/sdk/models/operations/createtopictimerrequest.md
@@ -7,5 +7,5 @@
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.CreateTopicTimerRequestBody](../../../sdk/models/operations/createtopictimerrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.CreateTopicTimerRequestBody](../../../sdk/models/operations/createtopictimerrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createtopictimerresponse.md b/docs/sdk/models/operations/createtopictimerresponse.md
deleted file mode 100644
index f0a9adb..0000000
--- a/docs/sdk/models/operations/createtopictimerresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateTopicTimerResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateTopicTimerResponseBody](../../../sdk/models/operations/createtopictimerresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createuploadrequestbody.md b/docs/sdk/models/operations/createuploadrequestbody.md
index a0dfbfd..4b7c46f 100644
--- a/docs/sdk/models/operations/createuploadrequestbody.md
+++ b/docs/sdk/models/operations/createuploadrequestbody.md
@@ -3,9 +3,9 @@
## 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 |
\ No newline at end of file
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `type` | [operations.Type](../../../sdk/models/operations/type.md) | :heavy_check_mark: | N/A |
+| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.FileT](../../../sdk/models/operations/filet.md) | :heavy_minus_sign: | N/A |
+| `synchronous` | *boolean* | :heavy_minus_sign: | Use this flag to return an id and url |
+| `userId` | *number* | :heavy_minus_sign: | required if uploading an avatar |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createuploadresponse.md b/docs/sdk/models/operations/createuploadresponse.md
deleted file mode 100644
index 574dfe7..0000000
--- a/docs/sdk/models/operations/createuploadresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateUploadResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateUploadResponseBody](../../../sdk/models/operations/createuploadresponsebody.md) | :heavy_minus_sign: | file uploaded |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/createuserresponse.md b/docs/sdk/models/operations/createuserresponse.md
deleted file mode 100644
index 5df68ad..0000000
--- a/docs/sdk/models/operations/createuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# CreateUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.CreateUserResponseBody](../../../sdk/models/operations/createuserresponsebody.md) | :heavy_minus_sign: | user created |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deactivateuserresponse.md b/docs/sdk/models/operations/deactivateuserresponse.md
deleted file mode 100644
index 6fa70e4..0000000
--- a/docs/sdk/models/operations/deactivateuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# DeactivateUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.DeactivateUserResponseBody](../../../sdk/models/operations/deactivateuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deletebadgeresponse.md b/docs/sdk/models/operations/deletebadgeresponse.md
deleted file mode 100644
index b04e7ce..0000000
--- a/docs/sdk/models/operations/deletebadgeresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# DeleteBadgeResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deletegroupresponse.md b/docs/sdk/models/operations/deletegroupresponse.md
deleted file mode 100644
index 8489218..0000000
--- a/docs/sdk/models/operations/deletegroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# DeleteGroupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.DeleteGroupResponseBody](../../../sdk/models/operations/deletegroupresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deletepostrequest.md b/docs/sdk/models/operations/deletepostrequest.md
index 98f5c2f..025d0e2 100644
--- a/docs/sdk/models/operations/deletepostrequest.md
+++ b/docs/sdk/models/operations/deletepostrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.DeletePostRequestBody](../../../sdk/models/operations/deletepostrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.DeletePostRequestBody](../../../sdk/models/operations/deletepostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deletepostresponse.md b/docs/sdk/models/operations/deletepostresponse.md
deleted file mode 100644
index 6289c23..0000000
--- a/docs/sdk/models/operations/deletepostresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# DeletePostResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deleteuserrequest.md b/docs/sdk/models/operations/deleteuserrequest.md
index 54e5527..17a918c 100644
--- a/docs/sdk/models/operations/deleteuserrequest.md
+++ b/docs/sdk/models/operations/deleteuserrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.DeleteUserRequestBody](../../../sdk/models/operations/deleteuserrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.DeleteUserRequestBody](../../../sdk/models/operations/deleteuserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/deleteuserresponse.md b/docs/sdk/models/operations/deleteuserresponse.md
deleted file mode 100644
index 071fdb4..0000000
--- a/docs/sdk/models/operations/deleteuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# DeleteUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.DeleteUserResponseBody](../../../sdk/models/operations/deleteuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/downloadbackupresponse.md b/docs/sdk/models/operations/downloadbackupresponse.md
deleted file mode 100644
index 5bc0df9..0000000
--- a/docs/sdk/models/operations/downloadbackupresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# DownloadBackupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/file.md b/docs/sdk/models/operations/filet.md
similarity index 97%
rename from docs/sdk/models/operations/file.md
rename to docs/sdk/models/operations/filet.md
index 89a9dac..5cbbe63 100644
--- a/docs/sdk/models/operations/file.md
+++ b/docs/sdk/models/operations/filet.md
@@ -1,4 +1,4 @@
-# File
+# FileT
## Fields
diff --git a/docs/sdk/models/operations/generatepresignedputresponse.md b/docs/sdk/models/operations/generatepresignedputresponse.md
deleted file mode 100644
index e6eb2df..0000000
--- a/docs/sdk/models/operations/generatepresignedputresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GeneratePresignedPutResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GeneratePresignedPutResponseBody](../../../sdk/models/operations/generatepresignedputresponsebody.md) | :heavy_minus_sign: | external upload initialized |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getbackupsresponse.md b/docs/sdk/models/operations/getbackupsresponse.md
deleted file mode 100644
index bd5fc92..0000000
--- a/docs/sdk/models/operations/getbackupsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetBackupsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `responseBodies` | [operations.ResponseBody](../../../sdk/models/operations/responsebody.md)[] | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getcategoryresponse.md b/docs/sdk/models/operations/getcategoryresponse.md
deleted file mode 100644
index 805c0e2..0000000
--- a/docs/sdk/models/operations/getcategoryresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetCategoryResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetCategoryResponseBody](../../../sdk/models/operations/getcategoryresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getgroupresponse.md b/docs/sdk/models/operations/getgroupresponse.md
deleted file mode 100644
index 33b3e09..0000000
--- a/docs/sdk/models/operations/getgroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetGroupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetGroupResponseBody](../../../sdk/models/operations/getgroupresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getnotificationsresponse.md b/docs/sdk/models/operations/getnotificationsresponse.md
deleted file mode 100644
index f32879a..0000000
--- a/docs/sdk/models/operations/getnotificationsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetNotificationsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetNotificationsResponseBody](../../../sdk/models/operations/getnotificationsresponsebody.md) | :heavy_minus_sign: | notifications |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getpostresponse.md b/docs/sdk/models/operations/getpostresponse.md
deleted file mode 100644
index 2bc86f6..0000000
--- a/docs/sdk/models/operations/getpostresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetPostResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | Record | :heavy_minus_sign: | single post |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getpostresponsebody.md b/docs/sdk/models/operations/getpostresponsebody.md
new file mode 100644
index 0000000..9aef84e
--- /dev/null
+++ b/docs/sdk/models/operations/getpostresponsebody.md
@@ -0,0 +1,61 @@
+# GetPostResponseBody
+
+single post
+
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `additionalProperties` | Record | :heavy_minus_sign: | N/A |
+| `actionsSummary` | [operations.ActionsSummary](../../../sdk/models/operations/actionssummary.md)[] | :heavy_check_mark: | N/A |
+| `admin` | *boolean* | :heavy_check_mark: | N/A |
+| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
+| `bookmarked` | *boolean* | :heavy_check_mark: | N/A |
+| `canDelete` | *boolean* | :heavy_check_mark: | N/A |
+| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
+| `canRecover` | *boolean* | :heavy_check_mark: | N/A |
+| `canSeeHiddenPost` | *boolean* | :heavy_minus_sign: | N/A |
+| `canViewEditHistory` | *boolean* | :heavy_check_mark: | N/A |
+| `canWiki` | *boolean* | :heavy_check_mark: | N/A |
+| `cooked` | *string* | :heavy_check_mark: | N/A |
+| `createdAt` | *string* | :heavy_check_mark: | N/A |
+| `deletedAt` | *string* | :heavy_check_mark: | N/A |
+| `displayUsername` | *string* | :heavy_minus_sign: | N/A |
+| `editReason` | *string* | :heavy_check_mark: | N/A |
+| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
+| `flairColor` | *string* | :heavy_check_mark: | N/A |
+| `flairGroupId` | *string* | :heavy_minus_sign: | N/A |
+| `flairName` | *string* | :heavy_check_mark: | N/A |
+| `flairUrl` | *string* | :heavy_check_mark: | N/A |
+| `hidden` | *boolean* | :heavy_check_mark: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `incomingLinkCount` | *number* | :heavy_check_mark: | N/A |
+| `mentionedUsers` | *any*[] | :heavy_minus_sign: | N/A |
+| `moderator` | *boolean* | :heavy_check_mark: | N/A |
+| `name` | *string* | :heavy_minus_sign: | N/A |
+| `postNumber` | *number* | :heavy_check_mark: | N/A |
+| `postType` | *number* | :heavy_check_mark: | N/A |
+| `primaryGroupName` | *string* | :heavy_check_mark: | N/A |
+| `quoteCount` | *number* | :heavy_check_mark: | N/A |
+| `raw` | *string* | :heavy_check_mark: | N/A |
+| `readersCount` | *number* | :heavy_check_mark: | N/A |
+| `reads` | *number* | :heavy_check_mark: | N/A |
+| `replyCount` | *number* | :heavy_check_mark: | N/A |
+| `replyToPostNumber` | *string* | :heavy_check_mark: | N/A |
+| `reviewableId` | *string* | :heavy_check_mark: | N/A |
+| `reviewableScoreCount` | *number* | :heavy_check_mark: | N/A |
+| `reviewableScorePendingCount` | *number* | :heavy_check_mark: | N/A |
+| `score` | *number* | :heavy_check_mark: | N/A |
+| `staff` | *boolean* | :heavy_check_mark: | N/A |
+| `topicId` | *number* | :heavy_check_mark: | N/A |
+| `topicSlug` | *string* | :heavy_check_mark: | N/A |
+| `trustLevel` | *number* | :heavy_check_mark: | N/A |
+| `updatedAt` | *string* | :heavy_check_mark: | N/A |
+| `userDeleted` | *boolean* | :heavy_check_mark: | N/A |
+| `userId` | *number* | :heavy_check_mark: | N/A |
+| `userTitle` | *string* | :heavy_check_mark: | N/A |
+| `username` | *string* | :heavy_check_mark: | N/A |
+| `version` | *number* | :heavy_check_mark: | N/A |
+| `wiki` | *boolean* | :heavy_check_mark: | N/A |
+| `yours` | *boolean* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getsiteresponse.md b/docs/sdk/models/operations/getsiteresponse.md
deleted file mode 100644
index c8b1d15..0000000
--- a/docs/sdk/models/operations/getsiteresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetSiteResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetSiteResponseBody](../../../sdk/models/operations/getsiteresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/gettaggroupresponse.md b/docs/sdk/models/operations/gettaggroupresponse.md
deleted file mode 100644
index cb06084..0000000
--- a/docs/sdk/models/operations/gettaggroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetTagGroupResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetTagGroupResponseBody](../../../sdk/models/operations/gettaggroupresponsebody.md) | :heavy_minus_sign: | notifications |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/gettagresponse.md b/docs/sdk/models/operations/gettagresponse.md
deleted file mode 100644
index b54e54a..0000000
--- a/docs/sdk/models/operations/gettagresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetTagResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetTagResponseBody](../../../sdk/models/operations/gettagresponsebody.md) | :heavy_minus_sign: | notifications |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/gettopicbyexternalidresponse.md b/docs/sdk/models/operations/gettopicbyexternalidresponse.md
deleted file mode 100644
index c07c9a9..0000000
--- a/docs/sdk/models/operations/gettopicbyexternalidresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# GetTopicByExternalIdResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/gettopicresponse.md b/docs/sdk/models/operations/gettopicresponse.md
deleted file mode 100644
index 4334a73..0000000
--- a/docs/sdk/models/operations/gettopicresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetTopicResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetTopicResponseBody](../../../sdk/models/operations/gettopicresponsebody.md) | :heavy_minus_sign: | specific posts |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getuseremailsresponse.md b/docs/sdk/models/operations/getuseremailsresponse.md
deleted file mode 100644
index 7937233..0000000
--- a/docs/sdk/models/operations/getuseremailsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetUserEmailsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetUserEmailsResponseBody](../../../sdk/models/operations/getuseremailsresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getuserexternalidresponse.md b/docs/sdk/models/operations/getuserexternalidresponse.md
deleted file mode 100644
index f7817b9..0000000
--- a/docs/sdk/models/operations/getuserexternalidresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetUserExternalIdResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetUserExternalIdResponseBody](../../../sdk/models/operations/getuserexternalidresponsebody.md) | :heavy_minus_sign: | user response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidresponse.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidresponse.md
deleted file mode 100644
index dfec60b..0000000
--- a/docs/sdk/models/operations/getuseridentiyproviderexternalidresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetUserIdentiyProviderExternalIdResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetUserIdentiyProviderExternalIdResponseBody](../../../sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md) | :heavy_minus_sign: | user response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getuserresponse.md b/docs/sdk/models/operations/getuserresponse.md
deleted file mode 100644
index 1ca7f7c..0000000
--- a/docs/sdk/models/operations/getuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetUserResponseBody](../../../sdk/models/operations/getuserresponsebody.md) | :heavy_minus_sign: | user response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/getusersentprivatemessagesresponse.md b/docs/sdk/models/operations/getusersentprivatemessagesresponse.md
deleted file mode 100644
index 6cdf145..0000000
--- a/docs/sdk/models/operations/getusersentprivatemessagesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# GetUserSentPrivateMessagesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.GetUserSentPrivateMessagesResponseBody](../../../sdk/models/operations/getusersentprivatemessagesresponsebody.md) | :heavy_minus_sign: | private messages |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/invitetotopicrequest.md b/docs/sdk/models/operations/invitetotopicrequest.md
index c68ca51..a4240cb 100644
--- a/docs/sdk/models/operations/invitetotopicrequest.md
+++ b/docs/sdk/models/operations/invitetotopicrequest.md
@@ -7,5 +7,5 @@
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.InviteToTopicRequestBody](../../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.InviteToTopicRequestBody](../../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/invitetotopicresponse.md b/docs/sdk/models/operations/invitetotopicresponse.md
deleted file mode 100644
index df0f9f6..0000000
--- a/docs/sdk/models/operations/invitetotopicresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# InviteToTopicResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.InviteToTopicResponseBody](../../../sdk/models/operations/invitetotopicresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listcategoriesresponse.md b/docs/sdk/models/operations/listcategoriesresponse.md
deleted file mode 100644
index 34211cb..0000000
--- a/docs/sdk/models/operations/listcategoriesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListCategoriesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListCategoriesResponseBody](../../../sdk/models/operations/listcategoriesresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listcategorytopicsresponse.md b/docs/sdk/models/operations/listcategorytopicsresponse.md
deleted file mode 100644
index be95896..0000000
--- a/docs/sdk/models/operations/listcategorytopicsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListCategoryTopicsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListCategoryTopicsResponseBody](../../../sdk/models/operations/listcategorytopicsresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listgroupmembersresponse.md b/docs/sdk/models/operations/listgroupmembersresponse.md
deleted file mode 100644
index 641c366..0000000
--- a/docs/sdk/models/operations/listgroupmembersresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListGroupMembersResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListGroupMembersResponseBody](../../../sdk/models/operations/listgroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listgroupsresponse.md b/docs/sdk/models/operations/listgroupsresponse.md
deleted file mode 100644
index 67c18ba..0000000
--- a/docs/sdk/models/operations/listgroupsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListGroupsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListGroupsResponseBody](../../../sdk/models/operations/listgroupsresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listlatesttopicsresponse.md b/docs/sdk/models/operations/listlatesttopicsresponse.md
deleted file mode 100644
index 8956175..0000000
--- a/docs/sdk/models/operations/listlatesttopicsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListLatestTopicsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListLatestTopicsResponseBody](../../../sdk/models/operations/listlatesttopicsresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listpostsresponse.md b/docs/sdk/models/operations/listpostsresponse.md
deleted file mode 100644
index 560047a..0000000
--- a/docs/sdk/models/operations/listpostsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListPostsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListPostsResponseBody](../../../sdk/models/operations/listpostsresponsebody.md) | :heavy_minus_sign: | latest posts |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listtaggroupsresponse.md b/docs/sdk/models/operations/listtaggroupsresponse.md
deleted file mode 100644
index 130ba20..0000000
--- a/docs/sdk/models/operations/listtaggroupsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListTagGroupsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListTagGroupsResponseBody](../../../sdk/models/operations/listtaggroupsresponsebody.md) | :heavy_minus_sign: | tags |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listtagsresponse.md b/docs/sdk/models/operations/listtagsresponse.md
deleted file mode 100644
index 6e6aadf..0000000
--- a/docs/sdk/models/operations/listtagsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListTagsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListTagsResponseBody](../../../sdk/models/operations/listtagsresponsebody.md) | :heavy_minus_sign: | notifications |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listtoptopicsresponse.md b/docs/sdk/models/operations/listtoptopicsresponse.md
deleted file mode 100644
index f853567..0000000
--- a/docs/sdk/models/operations/listtoptopicsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListTopTopicsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListTopTopicsResponseBody](../../../sdk/models/operations/listtoptopicsresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listuseractionsresponse.md b/docs/sdk/models/operations/listuseractionsresponse.md
deleted file mode 100644
index 4ad6b3a..0000000
--- a/docs/sdk/models/operations/listuseractionsresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListUserActionsResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListUserActionsResponseBody](../../../sdk/models/operations/listuseractionsresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listuserbadgesresponse.md b/docs/sdk/models/operations/listuserbadgesresponse.md
deleted file mode 100644
index a927d45..0000000
--- a/docs/sdk/models/operations/listuserbadgesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListUserBadgesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListUserBadgesResponseBody](../../../sdk/models/operations/listuserbadgesresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listuserprivatemessagesresponse.md b/docs/sdk/models/operations/listuserprivatemessagesresponse.md
deleted file mode 100644
index ed11680..0000000
--- a/docs/sdk/models/operations/listuserprivatemessagesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListUserPrivateMessagesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListUserPrivateMessagesResponseBody](../../../sdk/models/operations/listuserprivatemessagesresponsebody.md) | :heavy_minus_sign: | private messages |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listuserspublicrequest.md b/docs/sdk/models/operations/listuserspublicrequest.md
index 458445c..3871a5f 100644
--- a/docs/sdk/models/operations/listuserspublicrequest.md
+++ b/docs/sdk/models/operations/listuserspublicrequest.md
@@ -5,7 +5,7 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
-| `order` | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_check_mark: | N/A |
-| `period` | [operations.Period](../../../sdk/models/operations/period.md) | :heavy_check_mark: | N/A |
| `asc` | [operations.Asc](../../../sdk/models/operations/asc.md) | :heavy_minus_sign: | N/A |
-| `page` | *number* | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `order` | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_check_mark: | N/A |
+| `page` | *number* | :heavy_minus_sign: | N/A |
+| `period` | [operations.Period](../../../sdk/models/operations/period.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/listuserspublicresponse.md b/docs/sdk/models/operations/listuserspublicresponse.md
deleted file mode 100644
index 134a55f..0000000
--- a/docs/sdk/models/operations/listuserspublicresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# ListUsersPublicResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.ListUsersPublicResponseBody](../../../sdk/models/operations/listuserspublicresponsebody.md) | :heavy_minus_sign: | directory items response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/lockpostrequest.md b/docs/sdk/models/operations/lockpostrequest.md
index d5cf0d9..d278992 100644
--- a/docs/sdk/models/operations/lockpostrequest.md
+++ b/docs/sdk/models/operations/lockpostrequest.md
@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.LockPostRequestBody](../../../sdk/models/operations/lockpostrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.LockPostRequestBody](../../../sdk/models/operations/lockpostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/lockpostresponse.md b/docs/sdk/models/operations/lockpostresponse.md
deleted file mode 100644
index 1a9b093..0000000
--- a/docs/sdk/models/operations/lockpostresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# LockPostResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.LockPostResponseBody](../../../sdk/models/operations/lockpostresponsebody.md) | :heavy_minus_sign: | post updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/logoutuserresponse.md b/docs/sdk/models/operations/logoutuserresponse.md
deleted file mode 100644
index 9a85258..0000000
--- a/docs/sdk/models/operations/logoutuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# LogOutUserResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.LogOutUserResponseBody](../../../sdk/models/operations/logoutuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/marknotificationsasreadresponse.md b/docs/sdk/models/operations/marknotificationsasreadresponse.md
deleted file mode 100644
index 673d31c..0000000
--- a/docs/sdk/models/operations/marknotificationsasreadresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# MarkNotificationsAsReadResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.MarkNotificationsAsReadResponseBody](../../../sdk/models/operations/marknotificationsasreadresponsebody.md) | :heavy_minus_sign: | notifications marked read |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/performpostactionactionssummary.md b/docs/sdk/models/operations/performpostactionactionssummary.md
new file mode 100644
index 0000000..2f0d89c
--- /dev/null
+++ b/docs/sdk/models/operations/performpostactionactionssummary.md
@@ -0,0 +1,11 @@
+# PerformPostActionActionsSummary
+
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `acted` | *boolean* | :heavy_minus_sign: | N/A |
+| `canUndo` | *boolean* | :heavy_minus_sign: | N/A |
+| `count` | *number* | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/performpostactionresponse.md b/docs/sdk/models/operations/performpostactionresponse.md
deleted file mode 100644
index 6666812..0000000
--- a/docs/sdk/models/operations/performpostactionresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# PerformPostActionResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.PerformPostActionResponseBody](../../../sdk/models/operations/performpostactionresponsebody.md) | :heavy_minus_sign: | post updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/performpostactionresponsebody.md b/docs/sdk/models/operations/performpostactionresponsebody.md
index ff40ab5..a906861 100644
--- a/docs/sdk/models/operations/performpostactionresponsebody.md
+++ b/docs/sdk/models/operations/performpostactionresponsebody.md
@@ -5,52 +5,52 @@ post updated
## Fields
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `actionsSummary` | [operations.ActionsSummary](../../../sdk/models/operations/actionssummary.md)[] | :heavy_minus_sign: | N/A |
-| `admin` | *boolean* | :heavy_minus_sign: | N/A |
-| `avatarTemplate` | *string* | :heavy_minus_sign: | N/A |
-| `canDelete` | *boolean* | :heavy_minus_sign: | N/A |
-| `canEdit` | *boolean* | :heavy_minus_sign: | N/A |
-| `canRecover` | *boolean* | :heavy_minus_sign: | N/A |
-| `canViewEditHistory` | *boolean* | :heavy_minus_sign: | N/A |
-| `canWiki` | *boolean* | :heavy_minus_sign: | N/A |
-| `cooked` | *string* | :heavy_minus_sign: | N/A |
-| `createdAt` | *string* | :heavy_minus_sign: | N/A |
-| `deletedAt` | *string* | :heavy_minus_sign: | N/A |
-| `displayUsername` | *string* | :heavy_minus_sign: | N/A |
-| `editReason` | *string* | :heavy_minus_sign: | N/A |
-| `flairBgColor` | *string* | :heavy_minus_sign: | N/A |
-| `flairColor` | *string* | :heavy_minus_sign: | N/A |
-| `flairName` | *string* | :heavy_minus_sign: | N/A |
-| `flairUrl` | *string* | :heavy_minus_sign: | N/A |
-| `hidden` | *boolean* | :heavy_minus_sign: | N/A |
-| `id` | *number* | :heavy_minus_sign: | N/A |
-| `incomingLinkCount` | *number* | :heavy_minus_sign: | N/A |
-| `moderator` | *boolean* | :heavy_minus_sign: | N/A |
-| `name` | *string* | :heavy_minus_sign: | N/A |
-| `notice` | [operations.Notice](../../../sdk/models/operations/notice.md) | :heavy_minus_sign: | N/A |
-| `postNumber` | *number* | :heavy_minus_sign: | N/A |
-| `postType` | *number* | :heavy_minus_sign: | N/A |
-| `primaryGroupName` | *string* | :heavy_minus_sign: | N/A |
-| `quoteCount` | *number* | :heavy_minus_sign: | N/A |
-| `readersCount` | *number* | :heavy_minus_sign: | N/A |
-| `reads` | *number* | :heavy_minus_sign: | N/A |
-| `replyCount` | *number* | :heavy_minus_sign: | N/A |
-| `replyToPostNumber` | *string* | :heavy_minus_sign: | N/A |
-| `reviewableId` | *string* | :heavy_minus_sign: | N/A |
-| `reviewableScoreCount` | *number* | :heavy_minus_sign: | N/A |
-| `reviewableScorePendingCount` | *number* | :heavy_minus_sign: | N/A |
-| `score` | *number* | :heavy_minus_sign: | N/A |
-| `staff` | *boolean* | :heavy_minus_sign: | N/A |
-| `topicId` | *number* | :heavy_minus_sign: | N/A |
-| `topicSlug` | *string* | :heavy_minus_sign: | N/A |
-| `trustLevel` | *number* | :heavy_minus_sign: | N/A |
-| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
-| `userDeleted` | *boolean* | :heavy_minus_sign: | N/A |
-| `userId` | *number* | :heavy_minus_sign: | N/A |
-| `userTitle` | *string* | :heavy_minus_sign: | N/A |
-| `username` | *string* | :heavy_minus_sign: | N/A |
-| `version` | *number* | :heavy_minus_sign: | N/A |
-| `wiki` | *boolean* | :heavy_minus_sign: | N/A |
-| `yours` | *boolean* | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `actionsSummary` | [operations.PerformPostActionActionsSummary](../../../sdk/models/operations/performpostactionactionssummary.md)[] | :heavy_minus_sign: | N/A |
+| `admin` | *boolean* | :heavy_minus_sign: | N/A |
+| `avatarTemplate` | *string* | :heavy_minus_sign: | N/A |
+| `canDelete` | *boolean* | :heavy_minus_sign: | N/A |
+| `canEdit` | *boolean* | :heavy_minus_sign: | N/A |
+| `canRecover` | *boolean* | :heavy_minus_sign: | N/A |
+| `canViewEditHistory` | *boolean* | :heavy_minus_sign: | N/A |
+| `canWiki` | *boolean* | :heavy_minus_sign: | N/A |
+| `cooked` | *string* | :heavy_minus_sign: | N/A |
+| `createdAt` | *string* | :heavy_minus_sign: | N/A |
+| `deletedAt` | *string* | :heavy_minus_sign: | N/A |
+| `displayUsername` | *string* | :heavy_minus_sign: | N/A |
+| `editReason` | *string* | :heavy_minus_sign: | N/A |
+| `flairBgColor` | *string* | :heavy_minus_sign: | N/A |
+| `flairColor` | *string* | :heavy_minus_sign: | N/A |
+| `flairName` | *string* | :heavy_minus_sign: | N/A |
+| `flairUrl` | *string* | :heavy_minus_sign: | N/A |
+| `hidden` | *boolean* | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_minus_sign: | N/A |
+| `incomingLinkCount` | *number* | :heavy_minus_sign: | N/A |
+| `moderator` | *boolean* | :heavy_minus_sign: | N/A |
+| `name` | *string* | :heavy_minus_sign: | N/A |
+| `notice` | [operations.Notice](../../../sdk/models/operations/notice.md) | :heavy_minus_sign: | N/A |
+| `postNumber` | *number* | :heavy_minus_sign: | N/A |
+| `postType` | *number* | :heavy_minus_sign: | N/A |
+| `primaryGroupName` | *string* | :heavy_minus_sign: | N/A |
+| `quoteCount` | *number* | :heavy_minus_sign: | N/A |
+| `readersCount` | *number* | :heavy_minus_sign: | N/A |
+| `reads` | *number* | :heavy_minus_sign: | N/A |
+| `replyCount` | *number* | :heavy_minus_sign: | N/A |
+| `replyToPostNumber` | *string* | :heavy_minus_sign: | N/A |
+| `reviewableId` | *string* | :heavy_minus_sign: | N/A |
+| `reviewableScoreCount` | *number* | :heavy_minus_sign: | N/A |
+| `reviewableScorePendingCount` | *number* | :heavy_minus_sign: | N/A |
+| `score` | *number* | :heavy_minus_sign: | N/A |
+| `staff` | *boolean* | :heavy_minus_sign: | N/A |
+| `topicId` | *number* | :heavy_minus_sign: | N/A |
+| `topicSlug` | *string* | :heavy_minus_sign: | N/A |
+| `trustLevel` | *number* | :heavy_minus_sign: | N/A |
+| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
+| `userDeleted` | *boolean* | :heavy_minus_sign: | N/A |
+| `userId` | *number* | :heavy_minus_sign: | N/A |
+| `userTitle` | *string* | :heavy_minus_sign: | N/A |
+| `username` | *string* | :heavy_minus_sign: | N/A |
+| `version` | *number* | :heavy_minus_sign: | N/A |
+| `wiki` | *boolean* | :heavy_minus_sign: | N/A |
+| `yours` | *boolean* | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/permissions.md b/docs/sdk/models/operations/permissions.md
index 819e052..da73706 100644
--- a/docs/sdk/models/operations/permissions.md
+++ b/docs/sdk/models/operations/permissions.md
@@ -3,5 +3,8 @@
## Fields
-| Field | Type | Required | Description |
-| ----------- | ----------- | ----------- | ----------- |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
+| `additionalProperties` | Record | :heavy_minus_sign: | N/A | |
+| `everyone` | *number* | :heavy_minus_sign: | N/A | 1 |
+| `staff` | *number* | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/postrepliesresponse.md b/docs/sdk/models/operations/postrepliesresponse.md
deleted file mode 100644
index 550a255..0000000
--- a/docs/sdk/models/operations/postrepliesresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# PostRepliesResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `responseBodies` | [operations.PostRepliesResponseBody](../../../sdk/models/operations/postrepliesresponsebody.md)[] | :heavy_minus_sign: | post replies |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/refreshgravatarresponse.md b/docs/sdk/models/operations/refreshgravatarresponse.md
deleted file mode 100644
index 2b5f2eb..0000000
--- a/docs/sdk/models/operations/refreshgravatarresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# RefreshGravatarResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.RefreshGravatarResponseBody](../../../sdk/models/operations/refreshgravatarresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/removegroupmembersrequest.md b/docs/sdk/models/operations/removegroupmembersrequest.md
index 7693ba5..9bea709 100644
--- a/docs/sdk/models/operations/removegroupmembersrequest.md
+++ b/docs/sdk/models/operations/removegroupmembersrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.RemoveGroupMembersRequestBody](../../../sdk/models/operations/removegroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.RemoveGroupMembersRequestBody](../../../sdk/models/operations/removegroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/removegroupmembersresponse.md b/docs/sdk/models/operations/removegroupmembersresponse.md
deleted file mode 100644
index 91d7b4a..0000000
--- a/docs/sdk/models/operations/removegroupmembersresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# RemoveGroupMembersResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.RemoveGroupMembersResponseBody](../../../sdk/models/operations/removegroupmembersresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/removetopicresponse.md b/docs/sdk/models/operations/removetopicresponse.md
deleted file mode 100644
index 6920832..0000000
--- a/docs/sdk/models/operations/removetopicresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# RemoveTopicResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/searchresponse.md b/docs/sdk/models/operations/searchresponse.md
deleted file mode 100644
index acf47a7..0000000
--- a/docs/sdk/models/operations/searchresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# SearchResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.SearchResponseBody](../../../sdk/models/operations/searchresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/senddownloadbackupemailresponse.md b/docs/sdk/models/operations/senddownloadbackupemailresponse.md
deleted file mode 100644
index 8929e40..0000000
--- a/docs/sdk/models/operations/senddownloadbackupemailresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# SendDownloadBackupEmailResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/sendpasswordresetemailresponse.md b/docs/sdk/models/operations/sendpasswordresetemailresponse.md
deleted file mode 100644
index 02b1b98..0000000
--- a/docs/sdk/models/operations/sendpasswordresetemailresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# SendPasswordResetEmailResponse
-
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
-| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
-| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
-| `object` | [operations.SendPasswordResetEmailResponseBody](../../../sdk/models/operations/sendpasswordresetemailresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/setnotificationlevelrequest.md b/docs/sdk/models/operations/setnotificationlevelrequest.md
index 9dd0e2b..589b26a 100644
--- a/docs/sdk/models/operations/setnotificationlevelrequest.md
+++ b/docs/sdk/models/operations/setnotificationlevelrequest.md
@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.SetNotificationLevelRequestBody](../../../sdk/models/operations/setnotificationlevelrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.SetNotificationLevelRequestBody](../../../sdk/models/operations/setnotificationlevelrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/setnotificationlevelresponse.md b/docs/sdk/models/operations/setnotificationlevelresponse.md
deleted file mode 100644
index b759155..0000000
--- a/docs/sdk/models/operations/setnotificationlevelresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# SetNotificationLevelResponse
-
-
-## 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.SetNotificationLevelResponseBody](../../../sdk/models/operations/setnotificationlevelresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/silenceuserrequest.md b/docs/sdk/models/operations/silenceuserrequest.md
index d2a51e3..31c67d5 100644
--- a/docs/sdk/models/operations/silenceuserrequest.md
+++ b/docs/sdk/models/operations/silenceuserrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.SilenceUserRequestBody](../../../sdk/models/operations/silenceuserrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.SilenceUserRequestBody](../../../sdk/models/operations/silenceuserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/silenceuserresponse.md b/docs/sdk/models/operations/silenceuserresponse.md
deleted file mode 100644
index a2f59ed..0000000
--- a/docs/sdk/models/operations/silenceuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# SilenceUserResponse
-
-
-## 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.SilenceUserResponseBody](../../../sdk/models/operations/silenceuserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/suspenduserrequest.md b/docs/sdk/models/operations/suspenduserrequest.md
index 05381d8..4eaab76 100644
--- a/docs/sdk/models/operations/suspenduserrequest.md
+++ b/docs/sdk/models/operations/suspenduserrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.SuspendUserRequestBody](../../../sdk/models/operations/suspenduserrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.SuspendUserRequestBody](../../../sdk/models/operations/suspenduserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/suspenduserresponse.md b/docs/sdk/models/operations/suspenduserresponse.md
deleted file mode 100644
index 2820ac1..0000000
--- a/docs/sdk/models/operations/suspenduserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# SuspendUserResponse
-
-
-## 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.SuspendUserResponseBody](../../../sdk/models/operations/suspenduserresponsebody.md) | :heavy_minus_sign: | response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/taggroup.md b/docs/sdk/models/operations/taggroup.md
index dca414f..87ad23e 100644
--- a/docs/sdk/models/operations/taggroup.md
+++ b/docs/sdk/models/operations/taggroup.md
@@ -3,11 +3,11 @@
## Fields
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `name` | *string* | :heavy_check_mark: | N/A |
-| `onePerTopic` | *boolean* | :heavy_check_mark: | N/A |
-| `parentTagName` | *any*[] | :heavy_check_mark: | N/A |
-| `permissions` | [operations.Permissions](../../../sdk/models/operations/permissions.md) | :heavy_check_mark: | N/A |
-| `tagNames` | *any*[] | :heavy_check_mark: | N/A |
\ No newline at end of file
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `name` | *string* | :heavy_check_mark: | N/A |
+| `onePerTopic` | *boolean* | :heavy_check_mark: | N/A |
+| `parentTagName` | *any*[] | :heavy_check_mark: | N/A |
+| `permissions` | [operations.CreateTagGroupPermissions](../../../sdk/models/operations/createtaggrouppermissions.md) | :heavy_check_mark: | N/A |
+| `tagNames` | *any*[] | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/typet.md b/docs/sdk/models/operations/type.md
similarity index 97%
rename from docs/sdk/models/operations/typet.md
rename to docs/sdk/models/operations/type.md
index cd1900d..b3702c0 100644
--- a/docs/sdk/models/operations/typet.md
+++ b/docs/sdk/models/operations/type.md
@@ -1,4 +1,4 @@
-# TypeT
+# Type
## Values
diff --git a/docs/sdk/models/operations/updateavatarrequest.md b/docs/sdk/models/operations/updateavatarrequest.md
index 69a0ae0..71f58fb 100644
--- a/docs/sdk/models/operations/updateavatarrequest.md
+++ b/docs/sdk/models/operations/updateavatarrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateAvatarRequestBody](../../../sdk/models/operations/updateavatarrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateAvatarRequestBody](../../../sdk/models/operations/updateavatarrequestbody.md) | :heavy_minus_sign: | N/A |
+| `username` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateavatarresponse.md b/docs/sdk/models/operations/updateavatarresponse.md
deleted file mode 100644
index 784083e..0000000
--- a/docs/sdk/models/operations/updateavatarresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateAvatarResponse
-
-
-## 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.UpdateAvatarResponseBody](../../../sdk/models/operations/updateavatarresponsebody.md) | :heavy_minus_sign: | avatar updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatebadgerequest.md b/docs/sdk/models/operations/updatebadgerequest.md
index 0bf7776..c0b3b5b 100644
--- a/docs/sdk/models/operations/updatebadgerequest.md
+++ b/docs/sdk/models/operations/updatebadgerequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateBadgeRequestBody](../../../sdk/models/operations/updatebadgerequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateBadgeRequestBody](../../../sdk/models/operations/updatebadgerequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatebadgeresponse.md b/docs/sdk/models/operations/updatebadgeresponse.md
deleted file mode 100644
index a8bef5e..0000000
--- a/docs/sdk/models/operations/updatebadgeresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateBadgeResponse
-
-
-## 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.UpdateBadgeResponseBody](../../../sdk/models/operations/updatebadgeresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatecategorypermissions.md b/docs/sdk/models/operations/updatecategorypermissions.md
new file mode 100644
index 0000000..4515ec6
--- /dev/null
+++ b/docs/sdk/models/operations/updatecategorypermissions.md
@@ -0,0 +1,10 @@
+# UpdateCategoryPermissions
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
+| `additionalProperties` | Record | :heavy_minus_sign: | N/A | |
+| `everyone` | *number* | :heavy_minus_sign: | N/A | 1 |
+| `staff` | *number* | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatecategoryrequest.md b/docs/sdk/models/operations/updatecategoryrequest.md
index 68b6307..37a2944 100644
--- a/docs/sdk/models/operations/updatecategoryrequest.md
+++ b/docs/sdk/models/operations/updatecategoryrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateCategoryRequestBody](../../../sdk/models/operations/updatecategoryrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateCategoryRequestBody](../../../sdk/models/operations/updatecategoryrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatecategoryrequestbody.md b/docs/sdk/models/operations/updatecategoryrequestbody.md
index 594e70b..39c48f7 100644
--- a/docs/sdk/models/operations/updatecategoryrequestbody.md
+++ b/docs/sdk/models/operations/updatecategoryrequestbody.md
@@ -3,15 +3,15 @@
## 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 | :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 | |
\ No newline at end of file
+| 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` | [operations.UpdateCategoryPermissions](../../../sdk/models/operations/updatecategorypermissions.md) | :heavy_minus_sign: | N/A | |
+| `searchPriority` | *number* | :heavy_minus_sign: | N/A | |
+| `slug` | *string* | :heavy_minus_sign: | N/A | |
+| `textColor` | *string* | :heavy_minus_sign: | N/A | f0fcfd |
+| `topicFeaturedLinksAllowed` | *boolean* | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatecategoryresponse.md b/docs/sdk/models/operations/updatecategoryresponse.md
deleted file mode 100644
index 460d3fb..0000000
--- a/docs/sdk/models/operations/updatecategoryresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateCategoryResponse
-
-
-## 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.UpdateCategoryResponseBody](../../../sdk/models/operations/updatecategoryresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateemailrequest.md b/docs/sdk/models/operations/updateemailrequest.md
index b0d533f..8b5a70e 100644
--- a/docs/sdk/models/operations/updateemailrequest.md
+++ b/docs/sdk/models/operations/updateemailrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateEmailRequestBody](../../../sdk/models/operations/updateemailrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateEmailRequestBody](../../../sdk/models/operations/updateemailrequestbody.md) | :heavy_minus_sign: | N/A |
+| `username` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateemailresponse.md b/docs/sdk/models/operations/updateemailresponse.md
deleted file mode 100644
index 3d89ae0..0000000
--- a/docs/sdk/models/operations/updateemailresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# UpdateEmailResponse
-
-
-## 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 |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updategrouprequest.md b/docs/sdk/models/operations/updategrouprequest.md
index 0098087..9139f72 100644
--- a/docs/sdk/models/operations/updategrouprequest.md
+++ b/docs/sdk/models/operations/updategrouprequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateGroupRequestBody](../../../sdk/models/operations/updategrouprequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateGroupRequestBody](../../../sdk/models/operations/updategrouprequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *number* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updategroupresponse.md b/docs/sdk/models/operations/updategroupresponse.md
deleted file mode 100644
index 25f357c..0000000
--- a/docs/sdk/models/operations/updategroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateGroupResponse
-
-
-## 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.UpdateGroupResponseBody](../../../sdk/models/operations/updategroupresponsebody.md) | :heavy_minus_sign: | success response |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatepostrequest.md b/docs/sdk/models/operations/updatepostrequest.md
index 7e250f2..0d5dded 100644
--- a/docs/sdk/models/operations/updatepostrequest.md
+++ b/docs/sdk/models/operations/updatepostrequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdatePostRequestBody](../../../sdk/models/operations/updatepostrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdatePostRequestBody](../../../sdk/models/operations/updatepostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatepostresponse.md b/docs/sdk/models/operations/updatepostresponse.md
deleted file mode 100644
index 2daad6f..0000000
--- a/docs/sdk/models/operations/updatepostresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdatePostResponse
-
-
-## 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.UpdatePostResponseBody](../../../sdk/models/operations/updatepostresponsebody.md) | :heavy_minus_sign: | post updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetaggrouprequest.md b/docs/sdk/models/operations/updatetaggrouprequest.md
index a8be61d..4c7898f 100644
--- a/docs/sdk/models/operations/updatetaggrouprequest.md
+++ b/docs/sdk/models/operations/updatetaggrouprequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateTagGroupRequestBody](../../../sdk/models/operations/updatetaggrouprequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateTagGroupRequestBody](../../../sdk/models/operations/updatetaggrouprequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetaggroupresponse.md b/docs/sdk/models/operations/updatetaggroupresponse.md
deleted file mode 100644
index 1a837ad..0000000
--- a/docs/sdk/models/operations/updatetaggroupresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateTagGroupResponse
-
-
-## 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.UpdateTagGroupResponseBody](../../../sdk/models/operations/updatetaggroupresponsebody.md) | :heavy_minus_sign: | Tag group updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopicrequest.md b/docs/sdk/models/operations/updatetopicrequest.md
index 1639c9b..97e63ee 100644
--- a/docs/sdk/models/operations/updatetopicrequest.md
+++ b/docs/sdk/models/operations/updatetopicrequest.md
@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateTopicRequestBody](../../../sdk/models/operations/updatetopicrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateTopicRequestBody](../../../sdk/models/operations/updatetopicrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopicresponse.md b/docs/sdk/models/operations/updatetopicresponse.md
deleted file mode 100644
index d94b788..0000000
--- a/docs/sdk/models/operations/updatetopicresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateTopicResponse
-
-
-## 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.UpdateTopicResponseBody](../../../sdk/models/operations/updatetopicresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopicstatusrequest.md b/docs/sdk/models/operations/updatetopicstatusrequest.md
index c97f982..55f1b26 100644
--- a/docs/sdk/models/operations/updatetopicstatusrequest.md
+++ b/docs/sdk/models/operations/updatetopicstatusrequest.md
@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateTopicStatusRequestBody](../../../sdk/models/operations/updatetopicstatusrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateTopicStatusRequestBody](../../../sdk/models/operations/updatetopicstatusrequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopicstatusresponse.md b/docs/sdk/models/operations/updatetopicstatusresponse.md
deleted file mode 100644
index d0cf3f3..0000000
--- a/docs/sdk/models/operations/updatetopicstatusresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateTopicStatusResponse
-
-
-## 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.UpdateTopicStatusResponseBody](../../../sdk/models/operations/updatetopicstatusresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopictimestamprequest.md b/docs/sdk/models/operations/updatetopictimestamprequest.md
index 4d19312..ac17a3d 100644
--- a/docs/sdk/models/operations/updatetopictimestamprequest.md
+++ b/docs/sdk/models/operations/updatetopictimestamprequest.md
@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateTopicTimestampRequestBody](../../../sdk/models/operations/updatetopictimestamprequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateTopicTimestampRequestBody](../../../sdk/models/operations/updatetopictimestamprequestbody.md) | :heavy_minus_sign: | N/A |
+| `id` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updatetopictimestampresponse.md b/docs/sdk/models/operations/updatetopictimestampresponse.md
deleted file mode 100644
index c6239df..0000000
--- a/docs/sdk/models/operations/updatetopictimestampresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateTopicTimestampResponse
-
-
-## 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.UpdateTopicTimestampResponseBody](../../../sdk/models/operations/updatetopictimestampresponsebody.md) | :heavy_minus_sign: | topic updated |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateusernamerequest.md b/docs/sdk/models/operations/updateusernamerequest.md
index 1296f9c..2e5dc69 100644
--- a/docs/sdk/models/operations/updateusernamerequest.md
+++ b/docs/sdk/models/operations/updateusernamerequest.md
@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateUsernameRequestBody](../../../sdk/models/operations/updateusernamerequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateUsernameRequestBody](../../../sdk/models/operations/updateusernamerequestbody.md) | :heavy_minus_sign: | N/A |
+| `username` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateusernameresponse.md b/docs/sdk/models/operations/updateusernameresponse.md
deleted file mode 100644
index 9582808..0000000
--- a/docs/sdk/models/operations/updateusernameresponse.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# UpdateUsernameResponse
-
-
-## 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 |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateuserrequest.md b/docs/sdk/models/operations/updateuserrequest.md
index 31febd8..ead8cae 100644
--- a/docs/sdk/models/operations/updateuserrequest.md
+++ b/docs/sdk/models/operations/updateuserrequest.md
@@ -7,5 +7,5 @@
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateUserRequestBody](../../../sdk/models/operations/updateuserrequestbody.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| `requestBody` | [operations.UpdateUserRequestBody](../../../sdk/models/operations/updateuserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `username` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/sdk/models/operations/updateuserresponse.md b/docs/sdk/models/operations/updateuserresponse.md
deleted file mode 100644
index 36f079b..0000000
--- a/docs/sdk/models/operations/updateuserresponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# UpdateUserResponse
-
-
-## 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.UpdateUserResponseBody](../../../sdk/models/operations/updateuserresponsebody.md) | :heavy_minus_sign: | user updated |
\ No newline at end of file
diff --git a/docs/sdks/admin/README.md b/docs/sdks/admin/README.md
index 49ffa19..0091ef1 100644
--- a/docs/sdks/admin/README.md
+++ b/docs/sdks/admin/README.md
@@ -22,17 +22,14 @@ Activate a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ActivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 203554;
+ const result = await sdk.admin.activateUser(203554);
- const res = await sdk.admin.activateUser(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -40,15 +37,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ActivateUserResponse](../../sdk/models/operations/activateuserresponse.md)>**
+**Promise\<[operations.ActivateUserResponseBody](../../sdk/models/operations/activateuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -63,17 +62,14 @@ Get a user by id
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { AdminGetUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 386776;
+ const result = await sdk.admin.adminGetUser(386776);
- const res = await sdk.admin.adminGetUser(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -81,15 +77,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.AdminGetUserResponse](../../sdk/models/operations/admingetuserresponse.md)>**
+**Promise\<[operations.AdminGetUserResponseBody](../../sdk/models/operations/admingetuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -104,18 +102,16 @@ Get a list of users
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { Flag, QueryParamAsc, QueryParamOrder } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-
- const res = await sdk.admin.adminListUsers({
- flag: Flag.New,
+ const result = await sdk.admin.adminListUsers({
+ flag: "new",
});
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -123,15 +119,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `request` | [operations.AdminListUsersRequest](../../sdk/models/operations/adminlistusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.AdminListUsersRequest](../../sdk/models/operations/adminlistusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.AdminListUsersResponse](../../sdk/models/operations/adminlistusersresponse.md)>**
+**Promise\<[operations.AdminListUsersResponseBody[]](../../models/.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -146,17 +144,14 @@ Anonymize a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { AnonymizeUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 418778;
+ const result = await sdk.admin.anonymizeUser(418778);
- const res = await sdk.admin.anonymizeUser(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -164,15 +159,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.AnonymizeUserResponse](../../sdk/models/operations/anonymizeuserresponse.md)>**
+**Promise\<[operations.AnonymizeUserResponseBody](../../sdk/models/operations/anonymizeuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -187,17 +184,14 @@ Deactivate a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DeactivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 143950;
+ const result = await sdk.admin.deactivateUser(143950);
- const res = await sdk.admin.deactivateUser(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -205,15 +199,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DeactivateUserResponse](../../sdk/models/operations/deactivateuserresponse.md)>**
+**Promise\<[operations.DeactivateUserResponseBody](../../sdk/models/operations/deactivateuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -228,18 +224,14 @@ Delete a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DeleteUserRequest, DeleteUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 251343;
-const requestBody: DeleteUserRequestBody = {};
+ const result = await sdk.admin.deleteUser(251343);
- const res = await sdk.admin.deleteUser(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -247,16 +239,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.DeleteUserRequestBody](../../sdk/models/operations/deleteuserrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.DeleteUserRequestBody](../../sdk/models/operations/deleteuserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DeleteUserResponse](../../sdk/models/operations/deleteuserresponse.md)>**
+**Promise\<[operations.DeleteUserResponseBody](../../sdk/models/operations/deleteuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -271,17 +265,14 @@ Log a user out
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { LogOutUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 379568;
+ const result = await sdk.admin.logOutUser(379568);
- const res = await sdk.admin.logOutUser(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -289,15 +280,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.LogOutUserResponse](../../sdk/models/operations/logoutuserresponse.md)>**
+**Promise\<[operations.LogOutUserResponseBody](../../sdk/models/operations/logoutuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -312,17 +305,14 @@ Refresh gravatar
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { RefreshGravatarRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const username: string = "";
+ const result = await sdk.admin.refreshGravatar("");
- const res = await sdk.admin.refreshGravatar(username);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -330,15 +320,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `username` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.RefreshGravatarResponse](../../sdk/models/operations/refreshgravatarresponse.md)>**
+**Promise\<[operations.RefreshGravatarResponseBody](../../sdk/models/operations/refreshgravatarresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -353,21 +345,17 @@ Silence a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { SilenceUserRequest, SilenceUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 606247;
-const requestBody: SilenceUserRequestBody = {
- postAction: "delete",
- silencedTill: "2022-06-01T08:00:00.000Z",
-};
+ const result = await sdk.admin.silenceUser(606247, {
+ postAction: "delete",
+ silencedTill: "2022-06-01T08:00:00.000Z",
+ });
- const res = await sdk.admin.silenceUser(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -375,16 +363,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.SilenceUserRequestBody](../../sdk/models/operations/silenceuserrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.SilenceUserRequestBody](../../sdk/models/operations/silenceuserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.SilenceUserResponse](../../sdk/models/operations/silenceuserresponse.md)>**
+**Promise\<[operations.SilenceUserResponseBody](../../sdk/models/operations/silenceuserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -399,22 +389,18 @@ Suspend a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { SuspendUserRequest, SuspendUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 970832;
-const requestBody: SuspendUserRequestBody = {
- postAction: "delete",
- reason: "",
- suspendUntil: "2121-02-22",
-};
+ const result = await sdk.admin.suspendUser(970832, {
+ postAction: "delete",
+ reason: "",
+ suspendUntil: "2121-02-22",
+ });
- const res = await sdk.admin.suspendUser(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -422,16 +408,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.SuspendUserRequestBody](../../sdk/models/operations/suspenduserrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.SuspendUserRequestBody](../../sdk/models/operations/suspenduserrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.SuspendUserResponse](../../sdk/models/operations/suspenduserresponse.md)>**
+**Promise\<[operations.SuspendUserResponseBody](../../sdk/models/operations/suspenduserresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/backups/README.md b/docs/sdks/backups/README.md
index c10ec1b..cb671fb 100644
--- a/docs/sdks/backups/README.md
+++ b/docs/sdks/backups/README.md
@@ -17,16 +17,13 @@ Create backup
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.backups.createBackup();
- const res = await sdk.backups.createBackup({
- withUploads: false,
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -34,15 +31,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request` | [operations.CreateBackupRequestBody](../../sdk/models/operations/createbackuprequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateBackupRequestBody](../../sdk/models/operations/createbackuprequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateBackupResponse](../../sdk/models/operations/createbackupresponse.md)>**
+**Promise\<[operations.CreateBackupResponseBody](../../sdk/models/operations/createbackupresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -57,18 +56,13 @@ Download backup
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DownloadBackupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const filename: string = "";
-const token: string = "";
+ await sdk.backups.downloadBackup("", "");
- const res = await sdk.backups.downloadBackup(filename, token);
-
- if (res.statusCode == 200) {
- // handle response
- }
+
}
run();
@@ -76,16 +70,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `filename` | *string* | :heavy_check_mark: | N/A |
-| `token` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `filename` | *string* | :heavy_check_mark: | N/A |
+| `token` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DownloadBackupResponse](../../sdk/models/operations/downloadbackupresponse.md)>**
+**Promise\**
### Errors
| Error Object | Status Code | Content Type |
@@ -101,14 +97,13 @@ List backups
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.backups.getBackups();
- const res = await sdk.backups.getBackups();
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -116,14 +111,16 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetBackupsResponse](../../sdk/models/operations/getbackupsresponse.md)>**
+**Promise\<[operations.ResponseBody[]](../../models/.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -138,17 +135,13 @@ Send download backup email
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { SendDownloadBackupEmailRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const filename: string = "";
+ await sdk.backups.sendDownloadBackupEmail("");
- const res = await sdk.backups.sendDownloadBackupEmail(filename);
-
- if (res.statusCode == 200) {
- // handle response
- }
+
}
run();
@@ -156,15 +149,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `filename` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `filename` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.SendDownloadBackupEmailResponse](../../sdk/models/operations/senddownloadbackupemailresponse.md)>**
+**Promise\**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/badges/README.md b/docs/sdks/badges/README.md
index b631f51..f57d608 100644
--- a/docs/sdks/badges/README.md
+++ b/docs/sdks/badges/README.md
@@ -18,14 +18,13 @@ List badges
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.badges.adminListBadges();
- const res = await sdk.badges.adminListBadges();
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -33,14 +32,16 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.AdminListBadgesResponse](../../sdk/models/operations/adminlistbadgesresponse.md)>**
+**Promise\<[operations.AdminListBadgesResponseBody](../../sdk/models/operations/adminlistbadgesresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -56,17 +57,13 @@ Create badge
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.badges.createBadge();
- const res = await sdk.badges.createBadge({
- badgeTypeId: 190613,
- name: "",
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -74,15 +71,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateBadgeRequestBody](../../sdk/models/operations/createbadgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateBadgeRequestBody](../../sdk/models/operations/createbadgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateBadgeResponse](../../sdk/models/operations/createbadgeresponse.md)>**
+**Promise\<[operations.CreateBadgeResponseBody](../../sdk/models/operations/createbadgeresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -97,17 +96,13 @@ Delete badge
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DeleteBadgeRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 32345;
+ await sdk.badges.deleteBadge(32345);
- const res = await sdk.badges.deleteBadge(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+
}
run();
@@ -115,15 +110,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DeleteBadgeResponse](../../sdk/models/operations/deletebadgeresponse.md)>**
+**Promise\**
### Errors
| Error Object | Status Code | Content Type |
@@ -138,17 +135,14 @@ List badges for a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListUserBadgesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const username: string = "";
+ const result = await sdk.badges.listUserBadges("");
- const res = await sdk.badges.listUserBadges(username);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -156,15 +150,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `username` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListUserBadgesResponse](../../sdk/models/operations/listuserbadgesresponse.md)>**
+**Promise\<[operations.ListUserBadgesResponseBody](../../sdk/models/operations/listuserbadgesresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -179,21 +175,14 @@ Update badge
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { UpdateBadgeRequest, UpdateBadgeRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 280628;
-const requestBody: UpdateBadgeRequestBody = {
- badgeTypeId: 568845,
- name: "",
-};
+ const result = await sdk.badges.updateBadge(280628);
- const res = await sdk.badges.updateBadge(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -201,16 +190,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateBadgeRequestBody](../../sdk/models/operations/updatebadgerequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.UpdateBadgeRequestBody](../../sdk/models/operations/updatebadgerequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.UpdateBadgeResponse](../../sdk/models/operations/updatebadgeresponse.md)>**
+**Promise\<[operations.UpdateBadgeResponseBody](../../sdk/models/operations/updatebadgeresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/categories/README.md b/docs/sdks/categories/README.md
index fdbc481..d62b2ce 100644
--- a/docs/sdks/categories/README.md
+++ b/docs/sdks/categories/README.md
@@ -19,24 +19,20 @@ Creates a category
```typescript
import { SDK } from "@lukehagar/discoursejs";
-async function run() {
- const sdk = new SDK();
+const sdk = new SDK();
- const res = await sdk.categories.createCategory({
+async function run() {
+ const result = await sdk.categories.createCategory({
color: "49d9e9",
- formTemplateIds: [
- "",
- ],
name: "",
permissions: {
- "key": "",
+ everyone: 1,
},
textColor: "f0fcfd",
});
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -44,15 +40,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateCategoryRequestBody](../../sdk/models/operations/createcategoryrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateCategoryRequestBody](../../sdk/models/operations/createcategoryrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateCategoryResponse](../../sdk/models/operations/createcategoryresponse.md)>**
+**Promise\<[operations.CreateCategoryResponseBody](../../sdk/models/operations/createcategoryresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -67,17 +65,14 @@ Show category
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { GetCategoryRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 39147;
+ const result = await sdk.categories.getCategory(39147);
- const res = await sdk.categories.getCategory(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -85,15 +80,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetCategoryResponse](../../sdk/models/operations/getcategoryresponse.md)>**
+**Promise\<[operations.GetCategoryResponseBody](../../sdk/models/operations/getcategoryresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -109,14 +106,13 @@ Can be used to fetch all categories and subcategories
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.categories.getSite();
- const res = await sdk.categories.getSite();
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -124,14 +120,16 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetSiteResponse](../../sdk/models/operations/getsiteresponse.md)>**
+**Promise\<[operations.GetSiteResponseBody](../../sdk/models/operations/getsiteresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -146,17 +144,14 @@ Retrieves a list of categories
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListCategoriesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const includeSubcategories: boolean = false;
+ const result = await sdk.categories.listCategories();
- const res = await sdk.categories.listCategories(includeSubcategories);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -164,15 +159,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `includeSubcategories` | *boolean* | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `includeSubcategories` | *boolean* | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListCategoriesResponse](../../sdk/models/operations/listcategoriesresponse.md)>**
+**Promise\<[operations.ListCategoriesResponseBody](../../sdk/models/operations/listcategoriesresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -187,18 +184,14 @@ List topics
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListCategoryTopicsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 394133;
-const slug: string = "";
+ const result = await sdk.categories.listCategoryTopics(394133, "");
- const res = await sdk.categories.listCategoryTopics(id, slug);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -206,16 +199,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `slug` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `slug` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListCategoryTopicsResponse](../../sdk/models/operations/listcategorytopicsresponse.md)>**
+**Promise\<[operations.ListCategoryTopicsResponseBody](../../sdk/models/operations/listcategorytopicsresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -230,28 +225,21 @@ Updates a category
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { UpdateCategoryRequest, UpdateCategoryRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 353500;
-const requestBody: UpdateCategoryRequestBody = {
- color: "49d9e9",
- formTemplateIds: [
- "",
- ],
- name: "",
- permissions: {
- "key": "",
- },
- textColor: "f0fcfd",
-};
+ const result = await sdk.categories.updateCategory(353500, {
+ color: "49d9e9",
+ name: "",
+ permissions: {
+ everyone: 1,
+ },
+ textColor: "f0fcfd",
+ });
- const res = await sdk.categories.updateCategory(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -259,16 +247,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateCategoryRequestBody](../../sdk/models/operations/updatecategoryrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.UpdateCategoryRequestBody](../../sdk/models/operations/updatecategoryrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.UpdateCategoryResponse](../../sdk/models/operations/updatecategoryresponse.md)>**
+**Promise\<[operations.UpdateCategoryResponseBody](../../sdk/models/operations/updatecategoryresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/groups/README.md b/docs/sdks/groups/README.md
index 1ad388a..41f1996 100644
--- a/docs/sdks/groups/README.md
+++ b/docs/sdks/groups/README.md
@@ -20,20 +20,16 @@ Add group members
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { AddGroupMembersRequest, AddGroupMembersRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 985975;
-const requestBody: AddGroupMembersRequestBody = {
- usernames: "username1,username2",
-};
+ const result = await sdk.groups.addGroupMembers(985975, {
+ usernames: "username1,username2",
+ });
- const res = await sdk.groups.addGroupMembers(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -41,16 +37,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.AddGroupMembersRequestBody](../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.AddGroupMembersRequestBody](../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.AddGroupMembersResponse](../../sdk/models/operations/addgroupmembersresponse.md)>**
+**Promise\<[operations.AddGroupMembersResponseBody](../../sdk/models/operations/addgroupmembersresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -66,33 +64,13 @@ Create a group
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.groups.createGroup();
- const res = await sdk.groups.createGroup({
- group: {
- mutedCategoryIds: [
- 385163,
- ],
- name: "",
- regularCategoryIds: [
- 723588,
- ],
- trackingCategoryIds: [
- 835377,
- ],
- watchingCategoryIds: [
- 370420,
- ],
- watchingFirstPostCategoryIds: [
- 831661,
- ],
- },
- });
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -100,15 +78,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateGroupRequestBody](../../sdk/models/operations/creategrouprequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateGroupRequestBody](../../sdk/models/operations/creategrouprequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateGroupResponse](../../sdk/models/operations/creategroupresponse.md)>**
+**Promise\<[operations.CreateGroupResponseBody](../../sdk/models/operations/creategroupresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -123,17 +103,14 @@ Delete a group
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DeleteGroupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 21302;
+ const result = await sdk.groups.deleteGroup(21302);
- const res = await sdk.groups.deleteGroup(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -141,15 +118,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DeleteGroupResponse](../../sdk/models/operations/deletegroupresponse.md)>**
+**Promise\<[operations.DeleteGroupResponseBody](../../sdk/models/operations/deletegroupresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -164,17 +143,14 @@ Get a group
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { GetGroupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: string = "name";
+ const result = await sdk.groups.getGroup("name");
- const res = await sdk.groups.getGroup(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -182,15 +158,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description | Example |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *string* | :heavy_check_mark: | Use group name instead of id | name |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *string* | :heavy_check_mark: | Use group name instead of id | [object Object] |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
-**Promise<[operations.GetGroupResponse](../../sdk/models/operations/getgroupresponse.md)>**
+**Promise\<[operations.GetGroupResponseBody](../../sdk/models/operations/getgroupresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -205,17 +183,14 @@ List group members
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListGroupMembersRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: string = "name";
+ const result = await sdk.groups.listGroupMembers("name");
- const res = await sdk.groups.listGroupMembers(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -223,15 +198,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description | Example |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *string* | :heavy_check_mark: | Use group name instead of id | name |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *string* | :heavy_check_mark: | Use group name instead of id | [object Object] |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
-**Promise<[operations.ListGroupMembersResponse](../../sdk/models/operations/listgroupmembersresponse.md)>**
+**Promise\<[operations.ListGroupMembersResponseBody](../../sdk/models/operations/listgroupmembersresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -247,14 +224,13 @@ List groups
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.groups.listGroups();
- const res = await sdk.groups.listGroups();
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -262,14 +238,16 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListGroupsResponse](../../sdk/models/operations/listgroupsresponse.md)>**
+**Promise\<[operations.ListGroupsResponseBody](../../sdk/models/operations/listgroupsresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -284,20 +262,16 @@ Remove group members
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { RemoveGroupMembersRequest, RemoveGroupMembersRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 649523;
-const requestBody: RemoveGroupMembersRequestBody = {
- usernames: "username1,username2",
-};
+ const result = await sdk.groups.removeGroupMembers(649523, {
+ usernames: "username1,username2",
+ });
- const res = await sdk.groups.removeGroupMembers(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -305,16 +279,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.RemoveGroupMembersRequestBody](../../sdk/models/operations/removegroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.RemoveGroupMembersRequestBody](../../sdk/models/operations/removegroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.RemoveGroupMembersResponse](../../sdk/models/operations/removegroupmembersresponse.md)>**
+**Promise\<[operations.RemoveGroupMembersResponseBody](../../sdk/models/operations/removegroupmembersresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -329,37 +305,14 @@ Update a group
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { UpdateGroupGroup, UpdateGroupRequest, UpdateGroupRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 438471;
-const requestBody: UpdateGroupRequestBody = {
- group: {
- mutedCategoryIds: [
- 244551,
- ],
- name: "",
- regularCategoryIds: [
- 750192,
- ],
- trackingCategoryIds: [
- 733973,
- ],
- watchingCategoryIds: [
- 485153,
- ],
- watchingFirstPostCategoryIds: [
- 710652,
- ],
- },
-};
+ const result = await sdk.groups.updateGroup(438471);
- const res = await sdk.groups.updateGroup(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -367,16 +320,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdateGroupRequestBody](../../sdk/models/operations/updategrouprequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.UpdateGroupRequestBody](../../sdk/models/operations/updategrouprequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.UpdateGroupResponse](../../sdk/models/operations/updategroupresponse.md)>**
+**Promise\<[operations.UpdateGroupResponseBody](../../sdk/models/operations/updategroupresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/invites/README.md b/docs/sdks/invites/README.md
index a59c541..74b5f94 100644
--- a/docs/sdks/invites/README.md
+++ b/docs/sdks/invites/README.md
@@ -14,24 +14,19 @@ Create an invite
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { CreateInviteRequest, CreateInviteRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const apiKey: string = "";
-const apiUsername: string = "";
-const requestBody: CreateInviteRequestBody = {
- email: "not-a-user-yet@example.com",
- groupIds: "42,43",
- groupNames: "foo,bar",
- maxRedemptionsAllowed: 5,
-};
+ const result = await sdk.invites.createInvite("", "", {
+ email: "not-a-user-yet@example.com",
+ groupIds: "42,43",
+ groupNames: "foo,bar",
+ maxRedemptionsAllowed: 5,
+ });
- const res = await sdk.invites.createInvite(apiKey, apiUsername, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -39,17 +34,19 @@ run();
### Parameters
-| Parameter | 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 |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | 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 |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateInviteResponse](../../sdk/models/operations/createinviteresponse.md)>**
+**Promise\<[operations.CreateInviteResponseBody](../../sdk/models/operations/createinviteresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -64,20 +61,14 @@ Invite to topic
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { InviteToTopicRequest, InviteToTopicRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const apiKey: string = "";
-const apiUsername: string = "";
-const id: string = "";
-const requestBody: InviteToTopicRequestBody = {};
+ const result = await sdk.invites.inviteToTopic("", "", "");
- const res = await sdk.invites.inviteToTopic(apiKey, apiUsername, id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -85,18 +76,20 @@ run();
### Parameters
-| Parameter | 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.InviteToTopicRequestBody](../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | 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.InviteToTopicRequestBody](../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.InviteToTopicResponse](../../sdk/models/operations/invitetotopicresponse.md)>**
+**Promise\<[operations.InviteToTopicResponseBody](../../sdk/models/operations/invitetotopicresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/notifications/README.md b/docs/sdks/notifications/README.md
index 9a2a39c..1d6bf2d 100644
--- a/docs/sdks/notifications/README.md
+++ b/docs/sdks/notifications/README.md
@@ -15,14 +15,13 @@ Get the notifications that belong to the current user
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.notifications.getNotifications();
- const res = await sdk.notifications.getNotifications();
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -30,14 +29,16 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetNotificationsResponse](../../sdk/models/operations/getnotificationsresponse.md)>**
+**Promise\<[operations.GetNotificationsResponseBody](../../sdk/models/operations/getnotificationsresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -53,14 +54,13 @@ Mark notifications as read
```typescript
import { SDK } from "@lukehagar/discoursejs";
+const sdk = new SDK();
+
async function run() {
- const sdk = new SDK();
+ const result = await sdk.notifications.markNotificationsAsRead();
- const res = await sdk.notifications.markNotificationsAsRead({});
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -68,15 +68,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.MarkNotificationsAsReadRequestBody](../../sdk/models/operations/marknotificationsasreadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.MarkNotificationsAsReadRequestBody](../../sdk/models/operations/marknotificationsasreadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.MarkNotificationsAsReadResponse](../../sdk/models/operations/marknotificationsasreadresponse.md)>**
+**Promise\<[operations.MarkNotificationsAsReadResponseBody](../../sdk/models/operations/marknotificationsasreadresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/posts/README.md b/docs/sdks/posts/README.md
index 02b3197..2bdc7a6 100644
--- a/docs/sdks/posts/README.md
+++ b/docs/sdks/posts/README.md
@@ -21,18 +21,17 @@ Creates a new topic, a new post, or a private message
```typescript
import { SDK } from "@lukehagar/discoursejs";
-async function run() {
- const sdk = new SDK();
+const sdk = new SDK();
- const res = await sdk.posts.createTopicPostPM({
+async function run() {
+ const result = await sdk.posts.createTopicPostPM({
archetype: "private_message",
raw: "",
targetRecipients: "blake,sam",
});
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -40,15 +39,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateTopicPostPMRequestBody](../../sdk/models/operations/createtopicpostpmrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateTopicPostPMRequestBody](../../sdk/models/operations/createtopicpostpmrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateTopicPostPMResponse](../../sdk/models/operations/createtopicpostpmresponse.md)>**
+**Promise\<[operations.CreateTopicPostPMResponseBody](../../sdk/models/operations/createtopicpostpmresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -63,20 +64,15 @@ delete a single post
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { DeletePostRequest, DeletePostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: number = 188146;
-const requestBody: DeletePostRequestBody = {
- forceDestroy: true,
-};
+ await sdk.posts.deletePost(188146, {
+ forceDestroy: true,
+ });
- const res = await sdk.posts.deletePost(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+
}
run();
@@ -84,16 +80,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `id` | *number* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.DeletePostRequestBody](../../sdk/models/operations/deletepostrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *number* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.DeletePostRequestBody](../../sdk/models/operations/deletepostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.DeletePostResponse](../../sdk/models/operations/deletepostresponse.md)>**
+**Promise\**
### Errors
| Error Object | Status Code | Content Type |
@@ -113,17 +111,14 @@ refer to various different flag types.
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { GetPostRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: string = "";
+ const result = await sdk.posts.getPost("");
- const res = await sdk.posts.getPost(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -131,15 +126,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetPostResponse](../../sdk/models/operations/getpostresponse.md)>**
+**Promise\<[operations.GetPostResponseBody](../../sdk/models/operations/getpostresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -154,19 +151,14 @@ List latest posts across topics
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListPostsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const apiKey: string = "";
-const apiUsername: string = "";
-const before: string = "";
+ const result = await sdk.posts.listPosts("", "");
- const res = await sdk.posts.listPosts(apiKey, apiUsername, before);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -174,17 +166,19 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `apiKey` | *string* | :heavy_check_mark: | N/A |
-| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `before` | *string* | :heavy_minus_sign: | Load posts with an id lower than this value. Useful for pagination. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `apiKey` | *string* | :heavy_check_mark: | N/A |
+| `apiUsername` | *string* | :heavy_check_mark: | N/A |
+| `before` | *string* | :heavy_minus_sign: | Load posts with an id lower than this value. Useful for pagination. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListPostsResponse](../../sdk/models/operations/listpostsresponse.md)>**
+**Promise\<[operations.ListPostsResponseBody](../../sdk/models/operations/listpostsresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -199,22 +193,14 @@ Lock a post from being edited
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { LockPostRequest, LockPostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const apiKey: string = "";
-const apiUsername: string = "";
-const id: string = "";
-const requestBody: LockPostRequestBody = {
- locked: "",
-};
+ const result = await sdk.posts.lockPost("", "", "");
- const res = await sdk.posts.lockPost(apiKey, apiUsername, id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -222,18 +208,20 @@ run();
### Parameters
-| Parameter | 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.LockPostRequestBody](../../sdk/models/operations/lockpostrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | 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.LockPostRequestBody](../../sdk/models/operations/lockpostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.LockPostResponse](../../sdk/models/operations/lockpostresponse.md)>**
+**Promise\<[operations.LockPostResponseBody](../../sdk/models/operations/lockpostresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -248,22 +236,14 @@ Like a post and other actions
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { PerformPostActionRequest, PerformPostActionRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const apiKey: string = "";
-const apiUsername: string = "";
-const requestBody: PerformPostActionRequestBody = {
- id: 315075,
- postActionTypeId: 159481,
-};
+ const result = await sdk.posts.performPostAction("", "");
- const res = await sdk.posts.performPostAction(apiKey, apiUsername, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -271,17 +251,19 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `apiKey` | *string* | :heavy_check_mark: | N/A |
-| `apiUsername` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.PerformPostActionRequestBody](../../sdk/models/operations/performpostactionrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `apiKey` | *string* | :heavy_check_mark: | N/A |
+| `apiUsername` | *string* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.PerformPostActionRequestBody](../../sdk/models/operations/performpostactionrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.PerformPostActionResponse](../../sdk/models/operations/performpostactionresponse.md)>**
+**Promise\<[operations.PerformPostActionResponseBody](../../sdk/models/operations/performpostactionresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -296,17 +278,14 @@ List replies to a post
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { PostRepliesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: string = "";
+ const result = await sdk.posts.postReplies("");
- const res = await sdk.posts.postReplies(id);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -314,15 +293,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.PostRepliesResponse](../../sdk/models/operations/postrepliesresponse.md)>**
+**Promise\<[operations.PostRepliesResponseBody[]](../../models/.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -337,22 +318,14 @@ Update a single post
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { Post, UpdatePostRequest, UpdatePostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const id: string = "";
-const requestBody: UpdatePostRequestBody = {
- post: {
- raw: "",
- },
-};
+ const result = await sdk.posts.updatePost("");
- const res = await sdk.posts.updatePost(id, requestBody);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -360,16 +333,18 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | N/A |
-| `requestBody` | [operations.UpdatePostRequestBody](../../sdk/models/operations/updatepostrequestbody.md) | :heavy_minus_sign: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id` | *string* | :heavy_check_mark: | N/A |
+| `requestBody` | [operations.UpdatePostRequestBody](../../sdk/models/operations/updatepostrequestbody.md) | :heavy_minus_sign: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.UpdatePostResponse](../../sdk/models/operations/updatepostresponse.md)>**
+**Promise\<[operations.UpdatePostResponseBody](../../sdk/models/operations/updatepostresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/privatemessages/README.md b/docs/sdks/privatemessages/README.md
index b44cd8b..321ae8d 100644
--- a/docs/sdks/privatemessages/README.md
+++ b/docs/sdks/privatemessages/README.md
@@ -16,18 +16,17 @@ Creates a new topic, a new post, or a private message
```typescript
import { SDK } from "@lukehagar/discoursejs";
-async function run() {
- const sdk = new SDK();
+const sdk = new SDK();
- const res = await sdk.privateMessages.createTopicPostPM({
+async function run() {
+ const result = await sdk.privateMessages.createTopicPostPM({
archetype: "private_message",
raw: "",
targetRecipients: "blake,sam",
});
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -35,15 +34,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateTopicPostPMRequestBody](../../sdk/models/operations/createtopicpostpmrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateTopicPostPMRequestBody](../../sdk/models/operations/createtopicpostpmrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.CreateTopicPostPMResponse](../../sdk/models/operations/createtopicpostpmresponse.md)>**
+**Promise\<[operations.CreateTopicPostPMResponseBody](../../sdk/models/operations/createtopicpostpmresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -58,17 +59,14 @@ Get a list of private messages sent for a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { GetUserSentPrivateMessagesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const username: string = "";
+ const result = await sdk.privateMessages.getUserSentPrivateMessages("");
- const res = await sdk.privateMessages.getUserSentPrivateMessages(username);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -76,15 +74,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `username` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.GetUserSentPrivateMessagesResponse](../../sdk/models/operations/getusersentprivatemessagesresponse.md)>**
+**Promise\<[operations.GetUserSentPrivateMessagesResponseBody](../../sdk/models/operations/getusersentprivatemessagesresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -99,17 +99,14 @@ Get a list of private messages for a user
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { ListUserPrivateMessagesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const username: string = "";
+ const result = await sdk.privateMessages.listUserPrivateMessages("");
- const res = await sdk.privateMessages.listUserPrivateMessages(username);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -117,15 +114,17 @@ run();
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `username` | *string* | :heavy_check_mark: | N/A |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `username` | *string* | :heavy_check_mark: | N/A |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
-**Promise<[operations.ListUserPrivateMessagesResponse](../../sdk/models/operations/listuserprivatemessagesresponse.md)>**
+**Promise\<[operations.ListUserPrivateMessagesResponseBody](../../sdk/models/operations/listuserprivatemessagesresponsebody.md)\>**
### Errors
| Error Object | Status Code | Content Type |
diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md
index 7a3c267..dc20db1 100644
--- a/docs/sdks/search/README.md
+++ b/docs/sdks/search/README.md
@@ -13,18 +13,14 @@ Search for a term
```typescript
import { SDK } from "@lukehagar/discoursejs";
-import { SearchRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
+
+const sdk = new SDK();
async function run() {
- const sdk = new SDK();
-const page: number = 1;
-const q: string = "api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic";
+ const result = await sdk.search.search(1, "api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic");
- const res = await sdk.search.search(page, q);
-
- if (res.statusCode == 200) {
- // handle response
- }
+ // Handle the result
+ console.log(result)
}
run();
@@ -34,14 +30,16 @@ run();
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `page` | *number* | :heavy_minus_sign: | N/A | 1 |
-| `q` | *string* | :heavy_minus_sign: | The query string needs to be url encoded and is made up of the following options: - Search term. This is just a string. Usually it would be the first item in the query. - `@`: Use the `@` followed by the username to specify posts by this user. - `#`: Use the `#` followed by the category slug to search within this category. - `tags:`: `api,solved` or for posts that have all the specified tags `api+solved`. - `before:`: `yyyy-mm-dd` - `after:`: `yyyy-mm-dd` - `order:`: `latest`, `likes`, `views`, `latest_topic` - `assigned:`: username (without `@`) - `in:`: `title`, `likes`, `personal`, `messages`, `seen`, `unseen`, `posted`, `created`, `watching`, `tracking`, `bookmarks`, `assigned`, `unassigned`, `first`, `pinned`, `wiki` - `with:`: `images` - `status:`: `open`, `closed`, `public`, `archived`, `noreplies`, `single_user`, `solved`, `unsolved` - `group:`: group_name or group_id - `group_messages:`: group_name or group_id - `min_posts:`: 1 - `max_posts:`: 10 - `min_views:`: 1 - `max_views:`: 10
If you are using cURL you can use the `-G` and the `--data-urlencode` flags to encode the query:
``` curl -i -sS -X GET -G "http://localhost:4200/search.json" \ --data-urlencode 'q=wordpress @scossar #fun after:2020-01-01' ``` | api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic |
-| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
+| `page` | *number* | :heavy_minus_sign: | N/A | [object Object] |
+| `q` | *string* | :heavy_minus_sign: | The query string needs to be url encoded and is made up of the following options: - Search term. This is just a string. Usually it would be the first item in the query. - `@`: Use the `@` followed by the username to specify posts by this user. - `#`: Use the `#` followed by the category slug to search within this category. - `tags:`: `api,solved` or for posts that have all the specified tags `api+solved`. - `before:`: `yyyy-mm-dd` - `after:`: `yyyy-mm-dd` - `order:`: `latest`, `likes`, `views`, `latest_topic` - `assigned:`: username (without `@`) - `in:`: `title`, `likes`, `personal`, `messages`, `seen`, `unseen`, `posted`, `created`, `watching`, `tracking`, `bookmarks`, `assigned`, `unassigned`, `first`, `pinned`, `wiki` - `with:`: `images` - `status:`: `open`, `closed`, `public`, `archived`, `noreplies`, `single_user`, `solved`, `unsolved` - `group:`: group_name or group_id - `group_messages:`: group_name or group_id - `min_posts:`: 1 - `max_posts:`: 10 - `min_views:`: 1 - `max_views:`: 10
If you are using cURL you can use the `-G` and the `--data-urlencode` flags to encode the query: