From 0e9264154dbf0e086d60c6acf36a7371bad19937 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 15 Aug 2024 00:23:25 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.368.0 --- .speakeasy/gen.lock | 13 +- FUNCTIONS.md | 102 +++ README.md | 120 +++ RELEASES.md | 12 +- .../operations/abortmultipartrequestbody.md | 10 + .../operations/abortmultipartresponsebody.md | 9 + docs/sdk/models/operations/actionssummary.md | 9 + .../models/operations/activateuserrequest.md | 9 + .../operations/activateuserresponsebody.md | 9 + .../operations/addgroupmembersrequest.md | 12 + .../operations/addgroupmembersrequestbody.md | 9 + .../operations/addgroupmembersresponsebody.md | 11 + docs/sdk/models/operations/adminbadges.md | 19 + .../operations/admingetuserexternalids.md | 7 + .../models/operations/admingetusergroups.md | 37 + .../operations/admingetuserpenaltycounts.md | 11 + .../models/operations/admingetuserrequest.md | 9 + .../operations/admingetuserresponsebody.md | 104 +++ .../operations/adminlistbadgesresponsebody.md | 62 ++ .../operations/adminlistusersrequest.md | 9 + .../operations/adminlistusersresponsebody.md | 30 + .../models/operations/anonymizeuserrequest.md | 9 + .../operations/anonymizeuserresponsebody.md | 10 + docs/sdk/models/operations/approvedby.md | 12 + docs/sdk/models/operations/archetypes.md | 11 + docs/sdk/models/operations/asc.md | 13 +- docs/sdk/models/operations/badge.md | 29 + docs/sdk/models/operations/badgegroupings.md | 13 + docs/sdk/models/operations/badges.md | 29 + docs/sdk/models/operations/badgetypes.md | 11 + docs/sdk/models/operations/basicgroup.md | 36 + docs/sdk/models/operations/basictopic.md | 7 + .../batchpresignmultipartpartsrequestbody.md | 10 + .../batchpresignmultipartpartsresponsebody.md | 9 + .../models/operations/bookmarktopicrequest.md | 11 + docs/sdk/models/operations/categories.md | 46 ++ docs/sdk/models/operations/category.md | 67 ++ docs/sdk/models/operations/categorylist.md | 52 ++ docs/sdk/models/operations/censoredregexp.md | 7 + .../operations/changepasswordrequest.md | 9 + .../operations/changepasswordrequestbody.md | 10 + .../completeexternaluploadrequestbody.md | 12 + .../completeexternaluploadresponsebody.md | 21 + .../completemultipartrequestbody.md | 19 + .../completemultipartresponsebody.md | 21 + .../operations/createbackuprequestbody.md | 9 + .../operations/createbackupresponsebody.md | 9 + .../operations/createbadgebadgetypes.md | 11 + .../operations/createbadgerequestbody.md | 10 + .../operations/createbadgeresponsebody.md | 38 + .../operations/createcategoryrequestbody.md | 14 + .../operations/createcategoryresponsebody.md | 69 ++ docs/sdk/models/operations/createdby.md | 12 + .../operations/creategrouprequestbody.md | 11 + .../operations/creategroupresponsebody.md | 38 + .../models/operations/createinviterequest.md | 16 + .../operations/createinviterequestbody.md | 12 + .../operations/createinviteresponsebody.md | 19 + .../createmultipartuploadrequestbody.md | 11 + .../createmultipartuploadresponsebody.md | 12 + .../operations/createtaggrouppermissions.md | 7 + .../operations/createtaggrouprequestbody.md | 9 + .../operations/createtaggroupresponsebody.md | 16 + .../createtopicpostpmactionssummary.md | 10 + .../createtopicpostpmrequestbody.md | 11 + .../createtopicpostpmresponsebody.md | 61 ++ .../operations/createtopictimerrequest.md | 14 + .../operations/createtopictimerrequestbody.md | 9 + .../createtopictimerresponsebody.md | 9 + .../operations/createuploadrequestbody.md | 9 + .../operations/createuploadresponsebody.md | 21 + .../models/operations/createuserrequest.md | 10 + .../operations/createuserrequestbody.md | 12 + .../operations/createuserresponsebody.md | 11 + .../operations/customemojitranslation.md | 7 + docs/sdk/models/operations/customfields.md | 7 + docs/sdk/models/operations/data.md | 7 + .../operations/deactivateuserrequest.md | 9 + .../operations/deactivateuserresponsebody.md | 9 + .../operations/defaultdarkcolorscheme.md | 7 + .../models/operations/deletebadgerequest.md | 9 + .../models/operations/deletegrouprequest.md | 9 + .../operations/deletegroupresponsebody.md | 9 + .../models/operations/deletepostrequest.md | 12 + .../operations/deletepostrequestbody.md | 9 + .../models/operations/deleteuserrequest.md | 9 + .../operations/deleteuserrequestbody.md | 7 + .../operations/deleteuserresponsebody.md | 9 + docs/sdk/models/operations/details.md | 37 + docs/sdk/models/operations/directoryitems.md | 23 + .../operations/downloadbackuprequest.md | 10 + docs/sdk/models/operations/enabled.md | 14 +- docs/sdk/models/operations/externalids.md | 7 + docs/sdk/models/operations/extras.md | 9 + docs/sdk/models/operations/filet.md | 10 + docs/sdk/models/operations/flag.md | 18 +- .../generatepresignedputmetadata.md | 7 + .../generatepresignedputrequestbody.md | 11 + .../generatepresignedputresponsebody.md | 12 + .../operations/generatepresignedputtype.md | 17 +- .../models/operations/getcategorycategory.md | 67 ++ .../operations/getcategorycustomfields.md | 7 + .../operations/getcategorygrouppermissions.md | 10 + .../models/operations/getcategoryrequest.md | 9 + .../getcategoryrequiredtaggroups.md | 10 + .../operations/getcategoryresponsebody.md | 69 ++ docs/sdk/models/operations/getgroupgroup.md | 61 ++ docs/sdk/models/operations/getgrouprequest.md | 9 + .../models/operations/getgroupresponsebody.md | 66 ++ .../getnotificationsresponsebody.md | 7 + docs/sdk/models/operations/getpostrequest.md | 9 + .../models/operations/getpostresponsebody.md | 58 ++ .../models/operations/getsitecategories.md | 47 ++ docs/sdk/models/operations/getsitegroups.md | 13 + .../operations/getsiterequiredtaggroups.md | 10 + .../models/operations/getsiteresponsebody.md | 172 +++++ .../operations/gettaggrouppermissions.md | 7 + .../models/operations/gettaggrouprequest.md | 9 + .../operations/gettaggroupresponsebody.md | 7 + .../models/operations/gettaggrouptaggroup.md | 7 + docs/sdk/models/operations/gettagposters.md | 7 + docs/sdk/models/operations/gettagrequest.md | 9 + .../models/operations/gettagresponsebody.md | 7 + docs/sdk/models/operations/gettagtags.md | 7 + docs/sdk/models/operations/gettagtopiclist.md | 7 + docs/sdk/models/operations/gettagtopics.md | 7 + docs/sdk/models/operations/gettagusers.md | 7 + .../operations/gettopicactionssummary.md | 12 + .../operations/gettopicbyexternalidrequest.md | 9 + docs/sdk/models/operations/gettopicrequest.md | 11 + .../models/operations/gettopicresponsebody.md | 206 +++++ .../operations/gettopictagsdescriptions.md | 7 + .../gettopictopicsactionssummary.md | 10 + docs/sdk/models/operations/gettopicuser.md | 12 + .../models/operations/getusercustomfields.md | 7 + .../models/operations/getuseremailsrequest.md | 9 + .../operations/getuseremailsresponsebody.md | 12 + .../getuserexternalidcustomfields.md | 7 + .../operations/getuserexternalidgroups.md | 37 + .../operations/getuserexternalidgroupusers.md | 11 + .../operations/getuserexternalidrequest.md | 11 + .../getuserexternalidresponsebody.md | 184 +++++ .../operations/getuserexternaliduser.md | 181 +++++ .../getuserexternaliduserauthtokens.md | 18 + .../operations/getuserexternaliduserfields.md | 10 + ...tuserexternalidusernotificationschedule.md | 23 + .../operations/getuserexternaliduseroption.md | 40 + docs/sdk/models/operations/getusergroups.md | 37 + ...eridentiyproviderexternalidcustomfields.md | 7 + .../getuseridentiyproviderexternalidgroups.md | 37 + ...useridentiyproviderexternalidgroupusers.md | 11 + ...getuseridentiyproviderexternalidrequest.md | 12 + ...eridentiyproviderexternalidresponsebody.md | 184 +++++ .../getuseridentiyproviderexternaliduser.md | 181 +++++ ...identiyproviderexternaliduserauthtokens.md | 18 + ...useridentiyproviderexternaliduserfields.md | 10 + ...viderexternalidusernotificationschedule.md | 23 + ...useridentiyproviderexternaliduseroption.md | 40 + docs/sdk/models/operations/getuserrequest.md | 11 + .../models/operations/getuserresponsebody.md | 184 +++++ .../getusersentprivatemessagesposters.md | 7 + .../getusersentprivatemessagesrequest.md | 9 + .../getusersentprivatemessagesresponsebody.md | 7 + .../getusersentprivatemessagestopiclist.md | 7 + .../getusersentprivatemessagestopics.md | 7 + .../getusersentprivatemessagesusers.md | 7 + docs/sdk/models/operations/grantedbies.md | 16 + docs/sdk/models/operations/group.md | 9 + .../models/operations/groupedsearchresult.md | 21 + .../sdk/models/operations/grouppermissions.md | 10 + docs/sdk/models/operations/groups.md | 37 + docs/sdk/models/operations/groupusers.md | 11 + .../operations/hashtagconfigurations.md | 7 + docs/sdk/models/operations/hashtagicons.md | 7 + docs/sdk/models/operations/imapupdatedby.md | 7 + .../models/operations/invitetotopicrequest.md | 11 + .../operations/invitetotopicrequestbody.md | 7 + .../operations/invitetotopicresponsebody.md | 7 + .../models/operations/invitetotopicuser.md | 7 + docs/sdk/models/operations/lastposter.md | 12 + docs/sdk/models/operations/latestposts.md | 7 + docs/sdk/models/operations/linkcounts.md | 13 + .../operations/listcategoriesrequest.md | 7 + .../operations/listcategoriesresponsebody.md | 54 ++ .../operations/listcategorytopicsposters.md | 12 + .../operations/listcategorytopicsrequest.md | 10 + .../listcategorytopicsresponsebody.md | 53 ++ .../operations/listgroupmembersrequest.md | 9 + .../listgroupmembersresponsebody.md | 39 + .../sdk/models/operations/listgroupsextras.md | 9 + .../operations/listgroupsresponsebody.md | 46 ++ .../operations/listlatesttopicsposters.md | 7 + .../operations/listlatesttopicsrequest.md | 10 + .../listlatesttopicsresponsebody.md | 7 + .../operations/listlatesttopicstopiclist.md | 7 + .../operations/listlatesttopicstopics.md | 7 + .../operations/listlatesttopicsusers.md | 7 + .../operations/listpostsactionssummary.md | 7 + .../sdk/models/operations/listpostsrequest.md | 10 + .../operations/listpostsresponsebody.md | 7 + .../operations/listtaggroupspermissions.md | 7 + .../operations/listtaggroupsresponsebody.md | 7 + docs/sdk/models/operations/listtagsextras.md | 7 + .../models/operations/listtagsresponsebody.md | 7 + .../models/operations/listtoptopicsposters.md | 7 + .../models/operations/listtoptopicsrequest.md | 10 + .../operations/listtoptopicsresponsebody.md | 7 + .../operations/listtoptopicstopiclist.md | 7 + .../models/operations/listtoptopicstopics.md | 7 + .../models/operations/listtoptopicsusers.md | 7 + .../operations/listuseractionsrequest.md | 11 + .../operations/listuseractionsresponsebody.md | 38 + .../models/operations/listuserbadgesbadges.md | 23 + .../operations/listuserbadgesbadgetypes.md | 11 + .../operations/listuserbadgesrequest.md | 9 + .../operations/listuserbadgesresponsebody.md | 19 + .../listuserprivatemessagesparticipants.md | 7 + .../listuserprivatemessagesposters.md | 7 + .../listuserprivatemessagesrequest.md | 9 + .../listuserprivatemessagesresponsebody.md | 7 + .../listuserprivatemessagestopiclist.md | 7 + .../listuserprivatemessagestopics.md | 7 + .../listuserprivatemessagesusers.md | 7 + .../models/operations/listuserspublicmeta.md | 11 + .../operations/listuserspublicrequest.md | 10 + .../operations/listuserspublicresponsebody.md | 32 + .../models/operations/listuserspublicuser.md | 13 + docs/sdk/models/operations/lockpostrequest.md | 11 + .../models/operations/lockpostrequestbody.md | 9 + .../models/operations/lockpostresponsebody.md | 7 + .../models/operations/logoutuserrequest.md | 9 + .../operations/logoutuserresponsebody.md | 9 + .../operations/markdownadditionaloptions.md | 7 + .../marknotificationsasreadrequestbody.md | 7 + .../marknotificationsasreadresponsebody.md | 7 + docs/sdk/models/operations/members.md | 17 + docs/sdk/models/operations/meta.md | 11 + docs/sdk/models/operations/metadata.md | 7 + docs/sdk/models/operations/notice.md | 7 + .../models/operations/notificationlevel.md | 16 +- docs/sdk/models/operations/notifications.md | 7 + .../models/operations/notificationtypes.md | 41 + docs/sdk/models/operations/order.md | 19 +- docs/sdk/models/operations/owners.md | 17 + docs/sdk/models/operations/participants.md | 21 + docs/sdk/models/operations/penaltycounts.md | 10 + .../performpostactionactionssummary.md | 7 + .../operations/performpostactionrequest.md | 10 + .../performpostactionrequestbody.md | 10 + .../performpostactionresponsebody.md | 7 + docs/sdk/models/operations/period.md | 18 +- docs/sdk/models/operations/permissions.md | 9 + docs/sdk/models/operations/post.md | 9 + docs/sdk/models/operations/postactiontypes.md | 15 + docs/sdk/models/operations/posters.md | 16 + .../operations/postrepliesactionssummary.md | 10 + .../models/operations/postrepliesrequest.md | 9 + .../operations/postrepliesresponsebody.md | 65 ++ docs/sdk/models/operations/posts.md | 70 ++ docs/sdk/models/operations/poststream.md | 75 ++ docs/sdk/models/operations/posttypes.md | 12 + docs/sdk/models/operations/presignedurls.md | 7 + docs/sdk/models/operations/queryparamasc.md | 13 +- docs/sdk/models/operations/queryparamorder.md | 23 +- .../operations/refreshgravatarrequest.md | 9 + .../operations/refreshgravatarresponsebody.md | 10 + .../operations/removegroupmembersrequest.md | 12 + .../removegroupmembersrequestbody.md | 9 + .../removegroupmembersresponsebody.md | 11 + .../models/operations/removetopicrequest.md | 11 + docs/sdk/models/operations/replytouser.md | 10 + .../models/operations/requiredtaggroups.md | 10 + docs/sdk/models/operations/responsebody.md | 11 + docs/sdk/models/operations/searchrequest.md | 10 + .../models/operations/searchresponsebody.md | 28 + .../senddownloadbackupemailrequest.md | 9 + .../sendpasswordresetemailrequestbody.md | 9 + .../sendpasswordresetemailresponsebody.md | 10 + .../operations/setnotificationlevelrequest.md | 11 + .../setnotificationlevelrequestbody.md | 9 + .../setnotificationlevelresponsebody.md | 9 + docs/sdk/models/operations/signedheaders.md | 7 + docs/sdk/models/operations/silence.md | 18 + docs/sdk/models/operations/silencedby.md | 12 + .../models/operations/silenceuserrequest.md | 13 + .../operations/silenceuserrequestbody.md | 10 + .../operations/silenceuserresponsebody.md | 20 + docs/sdk/models/operations/smtpupdatedby.md | 7 + docs/sdk/models/operations/status.md | 17 +- docs/sdk/models/operations/suggestedtopics.md | 48 ++ docs/sdk/models/operations/suspendedby.md | 12 + .../models/operations/suspenduserrequest.md | 14 + .../operations/suspenduserrequestbody.md | 11 + .../operations/suspenduserresponsebody.md | 20 + docs/sdk/models/operations/suspension.md | 18 + docs/sdk/models/operations/taggroup.md | 14 + docs/sdk/models/operations/taggroups.md | 7 + docs/sdk/models/operations/tags.md | 7 + .../sdk/models/operations/tagsdescriptions.md | 7 + docs/sdk/models/operations/tl3requirements.md | 42 ++ docs/sdk/models/operations/topic.md | 7 + docs/sdk/models/operations/topicflagtypes.md | 15 + docs/sdk/models/operations/topiclist.md | 51 ++ docs/sdk/models/operations/topics.md | 45 ++ docs/sdk/models/operations/triggers.md | 13 + docs/sdk/models/operations/trustlevels.md | 13 + docs/sdk/models/operations/type.md | 17 +- .../models/operations/updateavatarrequest.md | 9 + .../operations/updateavatarrequestbody.md | 10 + .../operations/updateavatarresponsebody.md | 9 + .../sdk/models/operations/updateavatartype.md | 16 +- .../sdk/models/operations/updatebadgebadge.md | 29 + .../operations/updatebadgebadgetypes.md | 11 + .../models/operations/updatebadgerequest.md | 9 + .../operations/updatebadgerequestbody.md | 10 + .../operations/updatebadgeresponsebody.md | 38 + .../operations/updatecategorycategory.md | 68 ++ .../operations/updatecategorycustomfields.md | 7 + .../updatecategorygrouppermissions.md | 10 + .../operations/updatecategorypermissions.md | 9 + .../operations/updatecategoryrequest.md | 17 + .../operations/updatecategoryrequestbody.md | 14 + .../updatecategoryrequiredtaggroups.md | 10 + .../operations/updatecategoryresponsebody.md | 71 ++ .../models/operations/updateemailrequest.md | 9 + .../operations/updateemailrequestbody.md | 9 + .../sdk/models/operations/updategroupgroup.md | 9 + .../models/operations/updategrouprequest.md | 9 + .../operations/updategrouprequestbody.md | 11 + .../operations/updategroupresponsebody.md | 9 + .../operations/updatepostactionssummary.md | 10 + docs/sdk/models/operations/updatepostpost.md | 60 ++ .../models/operations/updatepostrequest.md | 9 + .../operations/updatepostrequestbody.md | 7 + .../operations/updatepostresponsebody.md | 62 ++ .../operations/updatetaggrouppermissions.md | 7 + .../operations/updatetaggrouprequest.md | 9 + .../operations/updatetaggrouprequestbody.md | 7 + .../operations/updatetaggroupresponsebody.md | 7 + .../operations/updatetaggrouptaggroup.md | 7 + .../models/operations/updatetopicrequest.md | 11 + .../operations/updatetopicrequestbody.md | 7 + .../operations/updatetopicresponsebody.md | 7 + .../operations/updatetopicstatusrequest.md | 16 + .../updatetopicstatusrequestbody.md | 11 + .../updatetopicstatusresponsebody.md | 9 + .../operations/updatetopictimestamprequest.md | 14 + .../updatetopictimestamprequestbody.md | 9 + .../updatetopictimestampresponsebody.md | 9 + .../operations/updateuserexternalids.md | 7 + .../operations/updateusernamerequest.md | 9 + .../operations/updateusernamerequestbody.md | 9 + .../models/operations/updateuserrequest.md | 11 + .../operations/updateuserrequestbody.md | 7 + .../operations/updateuserresponsebody.md | 10 + docs/sdk/models/operations/updateuseruser.md | 7 + docs/sdk/models/operations/uploadtype.md | 17 +- docs/sdk/models/operations/user.md | 181 +++++ docs/sdk/models/operations/useractions.md | 34 + docs/sdk/models/operations/userauthtokens.md | 18 + docs/sdk/models/operations/userbadges.md | 15 + .../sdk/models/operations/usercolorschemes.md | 11 + docs/sdk/models/operations/userfields.md | 10 + .../operations/usernotificationschedule.md | 23 + docs/sdk/models/operations/useroption.md | 40 + docs/sdk/models/operations/users.md | 12 + docs/sdk/models/operations/userthemes.md | 12 + docs/sdk/models/operations/usertips.md | 14 + docs/sdks/admin/README.md | 299 ++++++++ docs/sdks/backups/README.md | 114 +++ docs/sdks/badges/README.md | 144 ++++ docs/sdks/categories/README.md | 188 +++++ docs/sdks/groups/README.md | 236 ++++++ docs/sdks/invites/README.md | 63 ++ docs/sdks/notifications/README.md | 58 ++ docs/sdks/posts/README.md | 237 ++++++ docs/sdks/privatemessages/README.md | 91 +++ docs/sdks/search/README.md | 29 + docs/sdks/site/README.md | 29 + docs/sdks/tags/README.md | 174 +++++ docs/sdks/topics/README.md | 386 ++++++++++ docs/sdks/uploads/README.md | 237 ++++++ docs/sdks/users/README.md | 702 ++++++++++++++++++ gen.yaml | 2 +- jsr.json | 2 +- package.json | 2 +- src/lib/config.ts | 6 +- 387 files changed, 10303 insertions(+), 101 deletions(-) create mode 100644 FUNCTIONS.md diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 1ccc4fb..70cb8bc 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -3,10 +3,10 @@ id: 599a9576-4665-431e-be1e-44cc13ef28aa management: docChecksum: dd4d04e62622de8f631720b5be68964d docVersion: latest - speakeasyVersion: 1.361.1 - generationVersion: 2.393.4 - releaseVersion: 0.6.1 - configChecksum: 5e1692e0168fde15bf2cb519ffb5cdcd + speakeasyVersion: 1.368.0 + generationVersion: 2.399.0 + releaseVersion: 0.6.2 + configChecksum: 82a4fbe32e82b8286d089db9cf92d6d3 repoURL: https://github.com/LukeHagar/discoursejs.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/discoursejs @@ -15,8 +15,8 @@ features: typescript: additionalDependencies: 0.1.0 additionalProperties: 0.1.1 - constsAndDefaults: 0.1.7 - core: 3.13.1 + constsAndDefaults: 0.1.8 + core: 3.13.2 defaultEnabledRetries: 0.1.0 deprecations: 2.81.1 envVarSecurityUsage: 0.1.1 @@ -146,6 +146,7 @@ generatedFiles: - src/sdk/sdk.ts - .eslintrc.cjs - .npmignore + - FUNCTIONS.md - RUNTIMES.md - jsr.json - package.json diff --git a/FUNCTIONS.md b/FUNCTIONS.md new file mode 100644 index 0000000..8072684 --- /dev/null +++ b/FUNCTIONS.md @@ -0,0 +1,102 @@ +# Standalone Functions + +> [!NOTE] +> This section is useful if you are using a bundler and targetting browsers and +> runtimes where the size of an application affects performance and load times. + +Every method in this SDK is also available as a standalone function. This +alternative API is suitable when targetting the browser or serverless runtimes +and using a bundler to build your application since all unused functionality +will be tree-shaken away. This includes code for unused methods, Zod schemas, +encoding helpers and response handlers. The result is dramatically smaller +impact on the application's final bundle size which grows very slowly as you use +more and more functionality from this SDK. + +Calling methods through the main SDK class remains a valid and generally more +more ergonomic option. Standalone functions represent an optimisation for a +specific category of applications. + +## Example + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { backupsCreateBackup } from "@lukehagar/discoursejs/funcs/backupsCreateBackup.js"; +import { SDKValidationError } from "@lukehagar/discoursejs/sdk/models/errors/sdkvalidationerror.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await backupsCreateBackup(sdk); + + switch (true) { + case res.ok: + // The success case will be handled outside of the switch block + break; + case res.error instanceof SDKValidationError: + // Pretty-print validation errors. + return console.log(res.error.pretty()); + case res.error instanceof Error: + return console.log(res.error); + default: + // TypeScript's type checking will fail on the following line if the above + // cases were not exhaustive. + res.error satisfies never; + throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error); + } + + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + +## Result types + +Standalone functions differ from SDK methods in that they return a +`Result` type to capture _known errors_ and document them using +the type system. By avoiding throwing errors, application code maintains clear +control flow and error-handling become part of the regular flow of application +code. + +> We use the term "known errors" because standalone functions, and JavaScript +> code in general, can still throw unexpected errors such as `TypeError`s, +> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be +> something this SDK addresses in the future. Nevertheless, there is still a lot +> of benefit from capturing most errors and turning them into values. + +The second reason for this style of programming is because these functions will +typically be used in front-end applications where exception throwing is +sometimes discouraged or considered unidiomatic. React and similar ecosystems +and libraries tend to promote this style of programming so that components +render useful content under all states (loading, success, error and so on). + +The general pattern when calling standalone functions looks like this: + +```typescript +import { Core } from ""; +import { fetchSomething } from "/funcs/fetchSomething.js"; + +const client = new Core(); + +async function run() { + const result = await fetchSomething(client, { id: "123" }); + if (!result.ok) { + // You can throw the error or handle it. It's your choice now. + throw result.error; + } + + console.log(result.value); +} + +run(); +``` + +Notably, `result.error` above will have an explicit type compared to a try-catch +variation where the error in the catch block can only be of type `unknown` (or +`any` depending on your TypeScript settings). \ No newline at end of file diff --git a/README.md b/README.md index 68f40cc..2eee7c9 100644 --- a/README.md +++ b/README.md @@ -475,6 +475,126 @@ const sdk = new SDK({ debugLogger: console }); ``` + +## Standalone functions + +All the methods listed above are available as standalone functions. These +functions are ideal for use in applications running in the browser, serverless +runtimes or other environments where application bundle size is a primary +concern. When using a bundler to build your application, all unused +functionality will be either excluded from the final bundle or tree-shaken away. + +To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). + +
+ +Available standalone functions + +- [adminActivateUser](docs/sdks/admin/README.md#activateuser) +- [adminAdminGetUser](docs/sdks/admin/README.md#admingetuser) +- [adminAdminListUsers](docs/sdks/admin/README.md#adminlistusers) +- [adminAnonymizeUser](docs/sdks/admin/README.md#anonymizeuser) +- [adminDeactivateUser](docs/sdks/admin/README.md#deactivateuser) +- [adminDeleteUser](docs/sdks/admin/README.md#deleteuser) +- [adminLogOutUser](docs/sdks/admin/README.md#logoutuser) +- [adminRefreshGravatar](docs/sdks/admin/README.md#refreshgravatar) +- [adminSilenceUser](docs/sdks/admin/README.md#silenceuser) +- [adminSuspendUser](docs/sdks/admin/README.md#suspenduser) +- [backupsCreateBackup](docs/sdks/backups/README.md#createbackup) +- [backupsDownloadBackup](docs/sdks/backups/README.md#downloadbackup) +- [backupsGetBackups](docs/sdks/backups/README.md#getbackups) +- [backupsSendDownloadBackupEmail](docs/sdks/backups/README.md#senddownloadbackupemail) +- [badgesAdminListBadges](docs/sdks/badges/README.md#adminlistbadges) +- [badgesCreateBadge](docs/sdks/badges/README.md#createbadge) +- [badgesDeleteBadge](docs/sdks/badges/README.md#deletebadge) +- [badgesListUserBadges](docs/sdks/badges/README.md#listuserbadges) +- [badgesUpdateBadge](docs/sdks/badges/README.md#updatebadge) +- [categoriesCreateCategory](docs/sdks/categories/README.md#createcategory) +- [categoriesGetCategory](docs/sdks/categories/README.md#getcategory) +- [categoriesGetSite](docs/sdks/categories/README.md#getsite) +- [categoriesListCategories](docs/sdks/categories/README.md#listcategories) +- [categoriesListCategoryTopics](docs/sdks/categories/README.md#listcategorytopics) +- [categoriesUpdateCategory](docs/sdks/categories/README.md#updatecategory) +- [groupsAddGroupMembers](docs/sdks/groups/README.md#addgroupmembers) +- [groupsCreateGroup](docs/sdks/groups/README.md#creategroup) +- [groupsDeleteGroup](docs/sdks/groups/README.md#deletegroup) +- [groupsGetGroup](docs/sdks/groups/README.md#getgroup) +- [groupsListGroupMembers](docs/sdks/groups/README.md#listgroupmembers) +- [groupsListGroups](docs/sdks/groups/README.md#listgroups) +- [groupsRemoveGroupMembers](docs/sdks/groups/README.md#removegroupmembers) +- [groupsUpdateGroup](docs/sdks/groups/README.md#updategroup) +- [invitesCreateInvite](docs/sdks/invites/README.md#createinvite) +- [invitesInviteToTopic](docs/sdks/invites/README.md#invitetotopic) +- [notificationsGetNotifications](docs/sdks/notifications/README.md#getnotifications) +- [notificationsMarkNotificationsAsRead](docs/sdks/notifications/README.md#marknotificationsasread) +- [postsCreateTopicPostPM](docs/sdks/posts/README.md#createtopicpostpm) +- [postsDeletePost](docs/sdks/posts/README.md#deletepost) +- [postsGetPost](docs/sdks/posts/README.md#getpost) +- [postsListPosts](docs/sdks/posts/README.md#listposts) +- [postsLockPost](docs/sdks/posts/README.md#lockpost) +- [postsPerformPostAction](docs/sdks/posts/README.md#performpostaction) +- [postsPostReplies](docs/sdks/posts/README.md#postreplies) +- [postsUpdatePost](docs/sdks/posts/README.md#updatepost) +- [privateMessagesCreateTopicPostPM](docs/sdks/privatemessages/README.md#createtopicpostpm) +- [privateMessagesGetUserSentPrivateMessages](docs/sdks/privatemessages/README.md#getusersentprivatemessages) +- [privateMessagesListUserPrivateMessages](docs/sdks/privatemessages/README.md#listuserprivatemessages) +- [searchSearch](docs/sdks/search/README.md#search) +- [siteGetSite](docs/sdks/site/README.md#getsite) +- [tagsCreateTagGroup](docs/sdks/tags/README.md#createtaggroup) +- [tagsGetTagGroup](docs/sdks/tags/README.md#gettaggroup) +- [tagsGetTag](docs/sdks/tags/README.md#gettag) +- [tagsListTagGroups](docs/sdks/tags/README.md#listtaggroups) +- [tagsListTags](docs/sdks/tags/README.md#listtags) +- [tagsUpdateTagGroup](docs/sdks/tags/README.md#updatetaggroup) +- [topicsBookmarkTopic](docs/sdks/topics/README.md#bookmarktopic) +- [topicsCreateTopicPostPM](docs/sdks/topics/README.md#createtopicpostpm) +- [topicsCreateTopicTimer](docs/sdks/topics/README.md#createtopictimer) +- [topicsGetTopicByExternalId](docs/sdks/topics/README.md#gettopicbyexternalid) +- [topicsGetTopic](docs/sdks/topics/README.md#gettopic) +- [topicsInviteToTopic](docs/sdks/topics/README.md#invitetotopic) +- [topicsListLatestTopics](docs/sdks/topics/README.md#listlatesttopics) +- [topicsListTopTopics](docs/sdks/topics/README.md#listtoptopics) +- [topicsRemoveTopic](docs/sdks/topics/README.md#removetopic) +- [topicsSetNotificationLevel](docs/sdks/topics/README.md#setnotificationlevel) +- [topicsUpdateTopicStatus](docs/sdks/topics/README.md#updatetopicstatus) +- [topicsUpdateTopicTimestamp](docs/sdks/topics/README.md#updatetopictimestamp) +- [topicsUpdateTopic](docs/sdks/topics/README.md#updatetopic) +- [uploadsAbortMultipart](docs/sdks/uploads/README.md#abortmultipart) +- [uploadsBatchPresignMultipartParts](docs/sdks/uploads/README.md#batchpresignmultipartparts) +- [uploadsCompleteExternalUpload](docs/sdks/uploads/README.md#completeexternalupload) +- [uploadsCompleteMultipart](docs/sdks/uploads/README.md#completemultipart) +- [uploadsCreateMultipartUpload](docs/sdks/uploads/README.md#createmultipartupload) +- [uploadsCreateUpload](docs/sdks/uploads/README.md#createupload) +- [uploadsGeneratePresignedPut](docs/sdks/uploads/README.md#generatepresignedput) +- [usersActivateUser](docs/sdks/users/README.md#activateuser) +- [usersAdminGetUser](docs/sdks/users/README.md#admingetuser) +- [usersAdminListUsers](docs/sdks/users/README.md#adminlistusers) +- [usersAnonymizeUser](docs/sdks/users/README.md#anonymizeuser) +- [usersChangePassword](docs/sdks/users/README.md#changepassword) +- [usersCreateUser](docs/sdks/users/README.md#createuser) +- [usersDeactivateUser](docs/sdks/users/README.md#deactivateuser) +- [usersDeleteUser](docs/sdks/users/README.md#deleteuser) +- [usersGetUserEmails](docs/sdks/users/README.md#getuseremails) +- [usersGetUserExternalId](docs/sdks/users/README.md#getuserexternalid) +- [usersGetUserIdentiyProviderExternalId](docs/sdks/users/README.md#getuseridentiyproviderexternalid) +- [usersGetUser](docs/sdks/users/README.md#getuser) +- [usersListUserActions](docs/sdks/users/README.md#listuseractions) +- [usersListUserBadges](docs/sdks/users/README.md#listuserbadges) +- [usersListUsersPublic](docs/sdks/users/README.md#listuserspublic) +- [usersLogOutUser](docs/sdks/users/README.md#logoutuser) +- [usersRefreshGravatar](docs/sdks/users/README.md#refreshgravatar) +- [usersSendPasswordResetEmail](docs/sdks/users/README.md#sendpasswordresetemail) +- [usersSilenceUser](docs/sdks/users/README.md#silenceuser) +- [usersSuspendUser](docs/sdks/users/README.md#suspenduser) +- [usersUpdateAvatar](docs/sdks/users/README.md#updateavatar) +- [usersUpdateEmail](docs/sdks/users/README.md#updateemail) +- [usersUpdateUser](docs/sdks/users/README.md#updateuser) +- [usersUpdateUsername](docs/sdks/users/README.md#updateusername) + + +
+ + # Development diff --git a/RELEASES.md b/RELEASES.md index 0882db3..79a4dce 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -198,4 +198,14 @@ Based on: ### Generated - [typescript v0.6.1] . ### Releases -- [NPM v0.6.1] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.6.1 - . \ No newline at end of file +- [NPM v0.6.1] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.6.1 - . + +## 2024-08-15 00:21:58 +### Changes +Based on: +- OpenAPI Doc latest +- Speakeasy CLI 1.368.0 (2.399.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.6.2] . +### Releases +- [NPM v0.6.2] https://www.npmjs.com/package/@lukehagar/discoursejs/v/0.6.2 - . \ No newline at end of file diff --git a/docs/sdk/models/operations/abortmultipartrequestbody.md b/docs/sdk/models/operations/abortmultipartrequestbody.md index 2378bae..3943074 100644 --- a/docs/sdk/models/operations/abortmultipartrequestbody.md +++ b/docs/sdk/models/operations/abortmultipartrequestbody.md @@ -1,5 +1,15 @@ # AbortMultipartRequestBody +## Example Usage + +```typescript +import { AbortMultipartRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AbortMultipartRequestBody = { + externalUploadIdentifier: + "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/abortmultipartresponsebody.md b/docs/sdk/models/operations/abortmultipartresponsebody.md index 4cb656f..4a99499 100644 --- a/docs/sdk/models/operations/abortmultipartresponsebody.md +++ b/docs/sdk/models/operations/abortmultipartresponsebody.md @@ -2,6 +2,15 @@ external upload initialized +## Example Usage + +```typescript +import { AbortMultipartResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AbortMultipartResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/actionssummary.md b/docs/sdk/models/operations/actionssummary.md index 156d29b..64e53d3 100644 --- a/docs/sdk/models/operations/actionssummary.md +++ b/docs/sdk/models/operations/actionssummary.md @@ -1,5 +1,14 @@ # ActionsSummary +## Example Usage + +```typescript +import { ActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ActionsSummary = { + id: 63553, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/activateuserrequest.md b/docs/sdk/models/operations/activateuserrequest.md index 21ab348..9b8cf00 100644 --- a/docs/sdk/models/operations/activateuserrequest.md +++ b/docs/sdk/models/operations/activateuserrequest.md @@ -1,5 +1,14 @@ # ActivateUserRequest +## Example Usage + +```typescript +import { ActivateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ActivateUserRequest = { + id: 881736, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/activateuserresponsebody.md b/docs/sdk/models/operations/activateuserresponsebody.md index 3ee8056..f4cd189 100644 --- a/docs/sdk/models/operations/activateuserresponsebody.md +++ b/docs/sdk/models/operations/activateuserresponsebody.md @@ -2,6 +2,15 @@ response +## Example Usage + +```typescript +import { ActivateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ActivateUserResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/addgroupmembersrequest.md b/docs/sdk/models/operations/addgroupmembersrequest.md index 716992a..292067d 100644 --- a/docs/sdk/models/operations/addgroupmembersrequest.md +++ b/docs/sdk/models/operations/addgroupmembersrequest.md @@ -1,5 +1,17 @@ # AddGroupMembersRequest +## Example Usage + +```typescript +import { AddGroupMembersRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AddGroupMembersRequest = { + requestBody: { + usernames: "username1,username2", + }, + id: 253291, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/addgroupmembersrequestbody.md b/docs/sdk/models/operations/addgroupmembersrequestbody.md index 904cd3c..fadd150 100644 --- a/docs/sdk/models/operations/addgroupmembersrequestbody.md +++ b/docs/sdk/models/operations/addgroupmembersrequestbody.md @@ -1,5 +1,14 @@ # AddGroupMembersRequestBody +## Example Usage + +```typescript +import { AddGroupMembersRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AddGroupMembersRequestBody = { + usernames: "username1,username2", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/addgroupmembersresponsebody.md b/docs/sdk/models/operations/addgroupmembersresponsebody.md index 291e3b5..e2ce877 100644 --- a/docs/sdk/models/operations/addgroupmembersresponsebody.md +++ b/docs/sdk/models/operations/addgroupmembersresponsebody.md @@ -2,6 +2,17 @@ success response +## Example Usage + +```typescript +import { AddGroupMembersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AddGroupMembersResponseBody = { + emails: [""], + success: "", + usernames: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/adminbadges.md b/docs/sdk/models/operations/adminbadges.md index 3b4fe73..4556349 100644 --- a/docs/sdk/models/operations/adminbadges.md +++ b/docs/sdk/models/operations/adminbadges.md @@ -1,5 +1,24 @@ # AdminBadges +## Example Usage + +```typescript +import { AdminBadges } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminBadges = { + badgeGroupingIds: [""], + badgeIds: [""], + badgeTypeIds: [""], + protectedSystemFields: [""], + triggers: { + none: 544883, + postAction: 847252, + postRevision: 423655, + trustLevelChange: 623564, + userChange: 645894, + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/admingetuserexternalids.md b/docs/sdk/models/operations/admingetuserexternalids.md index 81aac00..6aab6c8 100644 --- a/docs/sdk/models/operations/admingetuserexternalids.md +++ b/docs/sdk/models/operations/admingetuserexternalids.md @@ -1,5 +1,12 @@ # AdminGetUserExternalIds +## Example Usage + +```typescript +import { AdminGetUserExternalIds } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminGetUserExternalIds = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/admingetusergroups.md b/docs/sdk/models/operations/admingetusergroups.md index f330ac2..162af65 100644 --- a/docs/sdk/models/operations/admingetusergroups.md +++ b/docs/sdk/models/operations/admingetusergroups.md @@ -1,5 +1,42 @@ # AdminGetUserGroups +## Example Usage + +```typescript +import { AdminGetUserGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminGetUserGroups = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 533206, + displayName: "Verlie.Feeney", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Ada Moen IV", + grantTrustLevel: "", + hasMessages: false, + id: 301575, + incomingEmail: "", + membersVisibilityLevel: 716075, + membershipRequestTemplate: "", + mentionableLevel: 660174, + messageableLevel: 287991, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 290077, + visibilityLevel: 383462, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/admingetuserpenaltycounts.md b/docs/sdk/models/operations/admingetuserpenaltycounts.md index ec48e69..4f937c2 100644 --- a/docs/sdk/models/operations/admingetuserpenaltycounts.md +++ b/docs/sdk/models/operations/admingetuserpenaltycounts.md @@ -1,5 +1,16 @@ # AdminGetUserPenaltyCounts +## Example Usage + +```typescript +import { AdminGetUserPenaltyCounts } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminGetUserPenaltyCounts = { + silenced: 428769, + suspended: 878453, + total: 135474, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/admingetuserrequest.md b/docs/sdk/models/operations/admingetuserrequest.md index db9ca57..4120a88 100644 --- a/docs/sdk/models/operations/admingetuserrequest.md +++ b/docs/sdk/models/operations/admingetuserrequest.md @@ -1,5 +1,14 @@ # AdminGetUserRequest +## Example Usage + +```typescript +import { AdminGetUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminGetUserRequest = { + id: 965417, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/admingetuserresponsebody.md b/docs/sdk/models/operations/admingetuserresponsebody.md index 6585d90..bc3ffe0 100644 --- a/docs/sdk/models/operations/admingetuserresponsebody.md +++ b/docs/sdk/models/operations/admingetuserresponsebody.md @@ -2,6 +2,110 @@ response +## Example Usage + +```typescript +import { AdminGetUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminGetUserResponseBody = { + active: false, + admin: false, + apiKeyCount: 99569, + approvedBy: { + avatarTemplate: "", + id: 919483, + name: "", + username: "Felix_Ratke", + }, + avatarTemplate: "", + badgeCount: 841140, + bounceScore: 149448, + canActivate: false, + canBeAnonymized: false, + canBeDeleted: false, + canBeMerged: false, + canDeactivate: false, + canDeleteAllPosts: false, + canDeleteSsoRecord: false, + canDisableSecondFactor: false, + canGrantAdmin: false, + canGrantModeration: false, + canImpersonate: false, + canRevokeAdmin: false, + canRevokeModeration: false, + canSendActivationEmail: false, + canViewActionLogs: false, + createdAt: "", + createdAtAge: 9046.48, + daysVisited: 868126, + externalIds: {}, + flagsGivenCount: 37559, + flagsReceivedCount: 162493, + fullSuspendReason: "", + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 508315, + displayName: "Levi77", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Ervin Schoen", + grantTrustLevel: "", + hasMessages: false, + id: 139972, + incomingEmail: "", + membersVisibilityLevel: 407183, + membershipRequestTemplate: "", + mentionableLevel: 33222, + messageableLevel: 69167, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 982575, + visibilityLevel: 697429, + }, + ], + id: 373291, + ipAddress: "116.107.184.12", + lastEmailedAge: 8663.83, + lastEmailedAt: "", + lastSeenAge: 3654.96, + lastSeenAt: "", + likeCount: 975522, + likeGivenCount: 16627, + manualLockedTrustLevel: "", + moderator: false, + name: "", + postCount: 855804, + postsReadCount: 230742, + primaryGroupId: "", + privateTopicsCount: 11714, + registrationIpAddress: "", + resetBounceScoreAfter: "", + silenceReason: "", + silencedBy: "", + singleSignOnRecord: "", + staged: false, + suspendedBy: "", + timeRead: 764912, + title: "", + topicCount: 359978, + topicsEntered: 944124, + trustLevel: 729991, + username: "Nelson_DAmore", + warningsReceivedCount: 489549, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/adminlistbadgesresponsebody.md b/docs/sdk/models/operations/adminlistbadgesresponsebody.md index 263e0b3..c13fc71 100644 --- a/docs/sdk/models/operations/adminlistbadgesresponsebody.md +++ b/docs/sdk/models/operations/adminlistbadgesresponsebody.md @@ -2,6 +2,68 @@ success response +## Example Usage + +```typescript +import { AdminListBadgesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminListBadgesResponseBody = { + adminBadges: { + badgeGroupingIds: [""], + badgeIds: [""], + badgeTypeIds: [""], + protectedSystemFields: [""], + triggers: { + none: 925597, + postAction: 836079, + postRevision: 71036, + trustLevelChange: 337396, + userChange: 87129, + }, + }, + badgeGroupings: [ + { + description: "Profit-focused 3rd generation framework", + id: 832620, + name: "", + position: 957156, + system: false, + }, + ], + badgeTypes: [ + { + id: 778157, + name: "", + sortOrder: 140350, + }, + ], + badges: [ + { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 870013, + badgeTypeId: 870088, + description: "Virtual holistic projection", + enabled: false, + grantCount: 800911, + icon: "", + id: 461479, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: 520478, + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/adminlistusersrequest.md b/docs/sdk/models/operations/adminlistusersrequest.md index 4e4f263..cec8960 100644 --- a/docs/sdk/models/operations/adminlistusersrequest.md +++ b/docs/sdk/models/operations/adminlistusersrequest.md @@ -1,5 +1,14 @@ # AdminListUsersRequest +## Example Usage + +```typescript +import { AdminListUsersRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminListUsersRequest = { + flag: "new", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/adminlistusersresponsebody.md b/docs/sdk/models/operations/adminlistusersresponsebody.md index e53e79a..c52901f 100644 --- a/docs/sdk/models/operations/adminlistusersresponsebody.md +++ b/docs/sdk/models/operations/adminlistusersresponsebody.md @@ -1,5 +1,35 @@ # AdminListUsersResponseBody +## Example Usage + +```typescript +import { AdminListUsersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AdminListUsersResponseBody = { + active: false, + admin: false, + avatarTemplate: "", + createdAt: "", + createdAtAge: 1794.9, + daysVisited: 18521, + id: 170986, + lastEmailedAge: 7936.98, + lastEmailedAt: "", + lastSeenAge: 4634.51, + lastSeenAt: "", + manualLockedTrustLevel: "", + moderator: false, + name: "", + postCount: 223924, + postsReadCount: 874573, + staged: false, + timeRead: 345352, + title: "", + topicsEntered: 944120, + trustLevel: 928082, + username: "Leo.Purdy", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/anonymizeuserrequest.md b/docs/sdk/models/operations/anonymizeuserrequest.md index 38964f6..6d6b6bd 100644 --- a/docs/sdk/models/operations/anonymizeuserrequest.md +++ b/docs/sdk/models/operations/anonymizeuserrequest.md @@ -1,5 +1,14 @@ # AnonymizeUserRequest +## Example Usage + +```typescript +import { AnonymizeUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AnonymizeUserRequest = { + id: 783645, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/anonymizeuserresponsebody.md b/docs/sdk/models/operations/anonymizeuserresponsebody.md index 8c65bc0..a71b282 100644 --- a/docs/sdk/models/operations/anonymizeuserresponsebody.md +++ b/docs/sdk/models/operations/anonymizeuserresponsebody.md @@ -2,6 +2,16 @@ response +## Example Usage + +```typescript +import { AnonymizeUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: AnonymizeUserResponseBody = { + success: "", + username: "Casimer.Kutch", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/approvedby.md b/docs/sdk/models/operations/approvedby.md index ddf1e50..3d89efc 100644 --- a/docs/sdk/models/operations/approvedby.md +++ b/docs/sdk/models/operations/approvedby.md @@ -1,5 +1,17 @@ # ApprovedBy +## Example Usage + +```typescript +import { ApprovedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ApprovedBy = { + avatarTemplate: "", + id: 692532, + name: "", + username: "Lafayette_Reinger", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/archetypes.md b/docs/sdk/models/operations/archetypes.md index 4b352f3..8a873e9 100644 --- a/docs/sdk/models/operations/archetypes.md +++ b/docs/sdk/models/operations/archetypes.md @@ -1,5 +1,16 @@ # Archetypes +## Example Usage + +```typescript +import { Archetypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Archetypes = { + id: "", + name: "", + options: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/asc.md b/docs/sdk/models/operations/asc.md index f163d4c..de8b074 100644 --- a/docs/sdk/models/operations/asc.md +++ b/docs/sdk/models/operations/asc.md @@ -1,8 +1,15 @@ # Asc +## Example Usage + +```typescript +import { Asc } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Asc = "true"; +``` ## Values -| Name | Value | -| ------ | ------ | -| `True` | true | \ No newline at end of file +```typescript +"true" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/badge.md b/docs/sdk/models/operations/badge.md index 4bb5bc6..b111d79 100644 --- a/docs/sdk/models/operations/badge.md +++ b/docs/sdk/models/operations/badge.md @@ -1,5 +1,34 @@ # Badge +## Example Usage + +```typescript +import { Badge } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Badge = { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 678880, + badgeTypeId: 118274, + description: "Re-contextualized motivating leverage", + enabled: false, + grantCount: 143353, + icon: "", + id: 537373, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/badgegroupings.md b/docs/sdk/models/operations/badgegroupings.md index d030176..3ef62aa 100644 --- a/docs/sdk/models/operations/badgegroupings.md +++ b/docs/sdk/models/operations/badgegroupings.md @@ -1,5 +1,18 @@ # BadgeGroupings +## Example Usage + +```typescript +import { BadgeGroupings } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BadgeGroupings = { + description: "Innovative grid-enabled encoding", + id: 891773, + name: "", + position: 56713, + system: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/badges.md b/docs/sdk/models/operations/badges.md index af35f24..ae6538e 100644 --- a/docs/sdk/models/operations/badges.md +++ b/docs/sdk/models/operations/badges.md @@ -1,5 +1,34 @@ # Badges +## Example Usage + +```typescript +import { Badges } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Badges = { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 383441, + badgeTypeId: 477665, + description: "Secured secondary internet solution", + enabled: false, + grantCount: 479977, + icon: "", + id: 568045, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: 392785, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/badgetypes.md b/docs/sdk/models/operations/badgetypes.md index a59ff54..7007e66 100644 --- a/docs/sdk/models/operations/badgetypes.md +++ b/docs/sdk/models/operations/badgetypes.md @@ -1,5 +1,16 @@ # BadgeTypes +## Example Usage + +```typescript +import { BadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BadgeTypes = { + id: 963663, + name: "", + sortOrder: 272656, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/basicgroup.md b/docs/sdk/models/operations/basicgroup.md index 3a45a99..3f099c5 100644 --- a/docs/sdk/models/operations/basicgroup.md +++ b/docs/sdk/models/operations/basicgroup.md @@ -1,5 +1,41 @@ # BasicGroup +## Example Usage + +```typescript +import { BasicGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BasicGroup = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 414369, + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Nellie Frami", + grantTrustLevel: "", + hasMessages: false, + id: 338007, + incomingEmail: "", + membersVisibilityLevel: 110375, + membershipRequestTemplate: "", + mentionableLevel: 674752, + messageableLevel: 656330, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 317202, + visibilityLevel: 138183, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/basictopic.md b/docs/sdk/models/operations/basictopic.md index b527935..dd0732e 100644 --- a/docs/sdk/models/operations/basictopic.md +++ b/docs/sdk/models/operations/basictopic.md @@ -1,5 +1,12 @@ # BasicTopic +## Example Usage + +```typescript +import { BasicTopic } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BasicTopic = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md b/docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md index fe55beb..360c756 100644 --- a/docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md +++ b/docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md @@ -1,5 +1,15 @@ # BatchPresignMultipartPartsRequestBody +## Example Usage + +```typescript +import { BatchPresignMultipartPartsRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BatchPresignMultipartPartsRequestBody = { + partNumbers: [1, 2, 3], + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md b/docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md index 3477a02..a10569c 100644 --- a/docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md +++ b/docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md @@ -2,6 +2,15 @@ external upload initialized +## Example Usage + +```typescript +import { BatchPresignMultipartPartsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BatchPresignMultipartPartsResponseBody = { + presignedUrls: {}, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/bookmarktopicrequest.md b/docs/sdk/models/operations/bookmarktopicrequest.md index d84a496..0fbbf15 100644 --- a/docs/sdk/models/operations/bookmarktopicrequest.md +++ b/docs/sdk/models/operations/bookmarktopicrequest.md @@ -1,5 +1,16 @@ # BookmarkTopicRequest +## Example Usage + +```typescript +import { BookmarkTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: BookmarkTopicRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/categories.md b/docs/sdk/models/operations/categories.md index 34c8165..33fb420 100644 --- a/docs/sdk/models/operations/categories.md +++ b/docs/sdk/models/operations/categories.md @@ -1,5 +1,51 @@ # Categories +## Example Usage + +```typescript +import { Categories } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Categories = { + canEdit: false, + color: "olive", + defaultListFilter: "", + defaultTopPeriod: "", + defaultView: "", + description: "Total systemic ability", + descriptionExcerpt: "", + descriptionText: "", + hasChildren: false, + id: 97258, + minimumRequiredTags: 90233, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 497777, + numFeaturedTopics: 619183, + permission: 581082, + position: 382440, + postCount: 241557, + readRestricted: false, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryIds: [""], + subcategoryListStyle: "", + textColor: "", + topicCount: 96562, + topicTemplate: "", + topicUrl: "", + topicsAllTime: 169025, + topicsDay: 984934, + topicsMonth: 859581, + topicsWeek: 896582, + topicsYear: 58534, + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/category.md b/docs/sdk/models/operations/category.md index dd48700..8b6b34a 100644 --- a/docs/sdk/models/operations/category.md +++ b/docs/sdk/models/operations/category.md @@ -1,5 +1,72 @@ # Category +## Example Usage + +```typescript +import { Category } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Category = { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "gold", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Public-key impactful moderator", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + groupPermissions: [ + { + groupName: "", + permissionType: 333965, + }, + ], + hasChildren: false, + id: 29100, + mailinglistMirror: false, + minimumRequiredTags: 790840, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 919532, + numFeaturedTopics: 97243, + permission: 542457, + position: 442036, + postCount: 991142, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 519952, + name: "", + }, + ], + searchPriority: 383103, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 693957, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/categorylist.md b/docs/sdk/models/operations/categorylist.md index 17d38e9..1dbcfd1 100644 --- a/docs/sdk/models/operations/categorylist.md +++ b/docs/sdk/models/operations/categorylist.md @@ -1,5 +1,57 @@ # CategoryList +## Example Usage + +```typescript +import { CategoryList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CategoryList = { + canCreateCategory: false, + canCreateTopic: false, + categories: [ + { + canEdit: false, + color: "black", + defaultListFilter: "", + defaultTopPeriod: "", + defaultView: "", + description: "Multi-layered holistic attitude", + descriptionExcerpt: "", + descriptionText: "", + hasChildren: false, + id: 479754, + minimumRequiredTags: 457059, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 508390, + numFeaturedTopics: 979963, + permission: 967260, + position: 423706, + postCount: 99958, + readRestricted: false, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryIds: [""], + subcategoryListStyle: "", + textColor: "", + topicCount: 857125, + topicTemplate: "", + topicUrl: "", + topicsAllTime: 39650, + topicsDay: 117315, + topicsMonth: 483706, + topicsWeek: 271252, + topicsYear: 458259, + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/censoredregexp.md b/docs/sdk/models/operations/censoredregexp.md index 5902dc8..a06222a 100644 --- a/docs/sdk/models/operations/censoredregexp.md +++ b/docs/sdk/models/operations/censoredregexp.md @@ -1,5 +1,12 @@ # CensoredRegexp +## Example Usage + +```typescript +import { CensoredRegexp } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CensoredRegexp = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/changepasswordrequest.md b/docs/sdk/models/operations/changepasswordrequest.md index b12d333..5ca354b 100644 --- a/docs/sdk/models/operations/changepasswordrequest.md +++ b/docs/sdk/models/operations/changepasswordrequest.md @@ -1,5 +1,14 @@ # ChangePasswordRequest +## Example Usage + +```typescript +import { ChangePasswordRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ChangePasswordRequest = { + token: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/changepasswordrequestbody.md b/docs/sdk/models/operations/changepasswordrequestbody.md index 8700652..e0dbe3e 100644 --- a/docs/sdk/models/operations/changepasswordrequestbody.md +++ b/docs/sdk/models/operations/changepasswordrequestbody.md @@ -1,5 +1,15 @@ # ChangePasswordRequestBody +## Example Usage + +```typescript +import { ChangePasswordRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ChangePasswordRequestBody = { + password: "Wc7yaSsYhfUF546", + username: "Christy_Erdman73", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/completeexternaluploadrequestbody.md b/docs/sdk/models/operations/completeexternaluploadrequestbody.md index 1f74d80..c5d8f70 100644 --- a/docs/sdk/models/operations/completeexternaluploadrequestbody.md +++ b/docs/sdk/models/operations/completeexternaluploadrequestbody.md @@ -1,5 +1,17 @@ # CompleteExternalUploadRequestBody +## Example Usage + +```typescript +import { CompleteExternalUploadRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CompleteExternalUploadRequestBody = { + forPrivateMessage: "true", + forSiteSetting: "true", + pasted: "true", + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/completeexternaluploadresponsebody.md b/docs/sdk/models/operations/completeexternaluploadresponsebody.md index cd88097..03e548a 100644 --- a/docs/sdk/models/operations/completeexternaluploadresponsebody.md +++ b/docs/sdk/models/operations/completeexternaluploadresponsebody.md @@ -2,6 +2,27 @@ external upload initialized +## Example Usage + +```typescript +import { CompleteExternalUploadResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CompleteExternalUploadResponseBody = { + extension: "mp4", + filesize: 727547, + height: 189753, + humanFilesize: "", + id: 289913, + originalFilename: "", + retainHours: "", + shortPath: "", + shortUrl: "", + thumbnailHeight: 520875, + thumbnailWidth: 577709, + url: "http://sore-death.net", + width: 684553, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/completemultipartrequestbody.md b/docs/sdk/models/operations/completemultipartrequestbody.md index 5ffcbe2..3ec9cd3 100644 --- a/docs/sdk/models/operations/completemultipartrequestbody.md +++ b/docs/sdk/models/operations/completemultipartrequestbody.md @@ -1,5 +1,24 @@ # CompleteMultipartRequestBody +## Example Usage + +```typescript +import { CompleteMultipartRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CompleteMultipartRequestBody = { + parts: [ + { + part_number: 1, + etag: "0c376dcfcc2606f4335bbc732de93344", + }, + { + part_number: 2, + etag: "09ert8cfcc2606f4335bbc732de91122", + }, + ], + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/completemultipartresponsebody.md b/docs/sdk/models/operations/completemultipartresponsebody.md index 530f03a..4887701 100644 --- a/docs/sdk/models/operations/completemultipartresponsebody.md +++ b/docs/sdk/models/operations/completemultipartresponsebody.md @@ -2,6 +2,27 @@ external upload initialized +## Example Usage + +```typescript +import { CompleteMultipartResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CompleteMultipartResponseBody = { + extension: "png", + filesize: 669237, + height: 770873, + humanFilesize: "", + id: 963741, + originalFilename: "", + retainHours: "", + shortPath: "", + shortUrl: "", + thumbnailHeight: 735894, + thumbnailWidth: 878601, + url: "http://zany-subsidy.info", + width: 441321, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createbackuprequestbody.md b/docs/sdk/models/operations/createbackuprequestbody.md index 6881c32..6a57347 100644 --- a/docs/sdk/models/operations/createbackuprequestbody.md +++ b/docs/sdk/models/operations/createbackuprequestbody.md @@ -1,5 +1,14 @@ # CreateBackupRequestBody +## Example Usage + +```typescript +import { CreateBackupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateBackupRequestBody = { + withUploads: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createbackupresponsebody.md b/docs/sdk/models/operations/createbackupresponsebody.md index caeb17d..8b95f64 100644 --- a/docs/sdk/models/operations/createbackupresponsebody.md +++ b/docs/sdk/models/operations/createbackupresponsebody.md @@ -2,6 +2,15 @@ success response +## Example Usage + +```typescript +import { CreateBackupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateBackupResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createbadgebadgetypes.md b/docs/sdk/models/operations/createbadgebadgetypes.md index 5b46c8f..3153c89 100644 --- a/docs/sdk/models/operations/createbadgebadgetypes.md +++ b/docs/sdk/models/operations/createbadgebadgetypes.md @@ -1,5 +1,16 @@ # CreateBadgeBadgeTypes +## Example Usage + +```typescript +import { CreateBadgeBadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateBadgeBadgeTypes = { + id: 944669, + name: "", + sortOrder: 758616, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createbadgerequestbody.md b/docs/sdk/models/operations/createbadgerequestbody.md index 68bb532..2c1bb4a 100644 --- a/docs/sdk/models/operations/createbadgerequestbody.md +++ b/docs/sdk/models/operations/createbadgerequestbody.md @@ -1,5 +1,15 @@ # CreateBadgeRequestBody +## Example Usage + +```typescript +import { CreateBadgeRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateBadgeRequestBody = { + badgeTypeId: 780529, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createbadgeresponsebody.md b/docs/sdk/models/operations/createbadgeresponsebody.md index 1c7822b..cbd4e5d 100644 --- a/docs/sdk/models/operations/createbadgeresponsebody.md +++ b/docs/sdk/models/operations/createbadgeresponsebody.md @@ -2,6 +2,44 @@ success response +## Example Usage + +```typescript +import { CreateBadgeResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateBadgeResponseBody = { + badge: { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 521848, + badgeTypeId: 105907, + description: "Inverse holistic data-warehouse", + enabled: false, + grantCount: 186332, + icon: "", + id: 774234, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: "", + }, + badgeTypes: [ + { + id: 736918, + name: "", + sortOrder: 456150, + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createcategoryrequestbody.md b/docs/sdk/models/operations/createcategoryrequestbody.md index b4d4917..1ca3748 100644 --- a/docs/sdk/models/operations/createcategoryrequestbody.md +++ b/docs/sdk/models/operations/createcategoryrequestbody.md @@ -1,5 +1,19 @@ # CreateCategoryRequestBody +## Example Usage + +```typescript +import { CreateCategoryRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateCategoryRequestBody = { + color: "49d9e9", + name: "", + permissions: { + everyone: 1, + }, + textColor: "f0fcfd", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createcategoryresponsebody.md b/docs/sdk/models/operations/createcategoryresponsebody.md index d1ecc5f..77e0650 100644 --- a/docs/sdk/models/operations/createcategoryresponsebody.md +++ b/docs/sdk/models/operations/createcategoryresponsebody.md @@ -2,6 +2,75 @@ success response +## Example Usage + +```typescript +import { CreateCategoryResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateCategoryResponseBody = { + category: { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "gold", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Compatible high-level contingency", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + groupPermissions: [ + { + groupName: "", + permissionType: 826825, + }, + ], + hasChildren: false, + id: 410301, + mailinglistMirror: false, + minimumRequiredTags: 539118, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 623295, + numFeaturedTopics: 887265, + permission: 886961, + position: 880107, + postCount: 618826, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 328303, + name: "", + }, + ], + searchPriority: 133461, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 404425, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createdby.md b/docs/sdk/models/operations/createdby.md index ab0ad77..ef57fe1 100644 --- a/docs/sdk/models/operations/createdby.md +++ b/docs/sdk/models/operations/createdby.md @@ -1,5 +1,17 @@ # CreatedBy +## Example Usage + +```typescript +import { CreatedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreatedBy = { + avatarTemplate: "", + id: 392569, + name: "", + username: "Sasha_Thiel19", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/creategrouprequestbody.md b/docs/sdk/models/operations/creategrouprequestbody.md index 2945456..6f80bc6 100644 --- a/docs/sdk/models/operations/creategrouprequestbody.md +++ b/docs/sdk/models/operations/creategrouprequestbody.md @@ -1,5 +1,16 @@ # CreateGroupRequestBody +## Example Usage + +```typescript +import { CreateGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateGroupRequestBody = { + group: { + name: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/creategroupresponsebody.md b/docs/sdk/models/operations/creategroupresponsebody.md index 28fd8b7..4223118 100644 --- a/docs/sdk/models/operations/creategroupresponsebody.md +++ b/docs/sdk/models/operations/creategroupresponsebody.md @@ -2,6 +2,44 @@ group created +## Example Usage + +```typescript +import { CreateGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateGroupResponseBody = { + basicGroup: { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 778346, + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Mandy Hills", + grantTrustLevel: "", + hasMessages: false, + id: 13571, + incomingEmail: "", + membersVisibilityLevel: 97101, + membershipRequestTemplate: "", + mentionableLevel: 622846, + messageableLevel: 837945, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 673660, + visibilityLevel: 96098, + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createinviterequest.md b/docs/sdk/models/operations/createinviterequest.md index c8e5ab4..3766e45 100644 --- a/docs/sdk/models/operations/createinviterequest.md +++ b/docs/sdk/models/operations/createinviterequest.md @@ -1,5 +1,21 @@ # CreateInviteRequest +## Example Usage + +```typescript +import { CreateInviteRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateInviteRequest = { + apiKey: "", + apiUsername: "", + requestBody: { + email: "not-a-user-yet@example.com", + groupIds: "42,43", + groupNames: "foo,bar", + maxRedemptionsAllowed: 5, + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createinviterequestbody.md b/docs/sdk/models/operations/createinviterequestbody.md index 46c9635..2977470 100644 --- a/docs/sdk/models/operations/createinviterequestbody.md +++ b/docs/sdk/models/operations/createinviterequestbody.md @@ -1,5 +1,17 @@ # CreateInviteRequestBody +## Example Usage + +```typescript +import { CreateInviteRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateInviteRequestBody = { + email: "not-a-user-yet@example.com", + groupIds: "42,43", + groupNames: "foo,bar", + maxRedemptionsAllowed: 5, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createinviteresponsebody.md b/docs/sdk/models/operations/createinviteresponsebody.md index b176ac8..cf96ed3 100644 --- a/docs/sdk/models/operations/createinviteresponsebody.md +++ b/docs/sdk/models/operations/createinviteresponsebody.md @@ -2,6 +2,25 @@ success response +## Example Usage + +```typescript +import { CreateInviteResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateInviteResponseBody = { + createdAt: "2021-01-01T12:00:00.000Z", + customMessage: "Hello world!", + email: "not-a-user-yet@example.com", + emailed: false, + expired: false, + expiresAt: "2021-02-01T12:00:00.000Z", + groups: [""], + id: 42, + link: "http://example.com/invites/9045fd767efe201ca60c6658bcf14158", + topics: [""], + updatedAt: "2021-01-01T12:00:00.000Z", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createmultipartuploadrequestbody.md b/docs/sdk/models/operations/createmultipartuploadrequestbody.md index b4a020b..52e17b6 100644 --- a/docs/sdk/models/operations/createmultipartuploadrequestbody.md +++ b/docs/sdk/models/operations/createmultipartuploadrequestbody.md @@ -1,5 +1,16 @@ # CreateMultipartUploadRequestBody +## Example Usage + +```typescript +import { CreateMultipartUploadRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateMultipartUploadRequestBody = { + fileName: "IMG_2021.jpeg", + fileSize: 4096, + uploadType: "card_background", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createmultipartuploadresponsebody.md b/docs/sdk/models/operations/createmultipartuploadresponsebody.md index 3b27081..78b4506 100644 --- a/docs/sdk/models/operations/createmultipartuploadresponsebody.md +++ b/docs/sdk/models/operations/createmultipartuploadresponsebody.md @@ -2,6 +2,18 @@ external upload initialized +## Example Usage + +```typescript +import { CreateMultipartUploadResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateMultipartUploadResponseBody = { + externalUploadIdentifier: + "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ", + key: "temp/site/uploads/default/12345/67890.jpg", + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtaggrouppermissions.md b/docs/sdk/models/operations/createtaggrouppermissions.md index 712e530..4811c15 100644 --- a/docs/sdk/models/operations/createtaggrouppermissions.md +++ b/docs/sdk/models/operations/createtaggrouppermissions.md @@ -1,5 +1,12 @@ # CreateTagGroupPermissions +## Example Usage + +```typescript +import { CreateTagGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTagGroupPermissions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtaggrouprequestbody.md b/docs/sdk/models/operations/createtaggrouprequestbody.md index 658e047..ead8417 100644 --- a/docs/sdk/models/operations/createtaggrouprequestbody.md +++ b/docs/sdk/models/operations/createtaggrouprequestbody.md @@ -1,5 +1,14 @@ # CreateTagGroupRequestBody +## Example Usage + +```typescript +import { CreateTagGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTagGroupRequestBody = { + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtaggroupresponsebody.md b/docs/sdk/models/operations/createtaggroupresponsebody.md index f0004a9..779c9f9 100644 --- a/docs/sdk/models/operations/createtaggroupresponsebody.md +++ b/docs/sdk/models/operations/createtaggroupresponsebody.md @@ -2,6 +2,22 @@ tag group created +## Example Usage + +```typescript +import { CreateTagGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTagGroupResponseBody = { + tagGroup: { + id: 978173, + name: "", + onePerTopic: false, + parentTagName: [""], + permissions: {}, + tagNames: [""], + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopicpostpmactionssummary.md b/docs/sdk/models/operations/createtopicpostpmactionssummary.md index 4603ffb..70e289b 100644 --- a/docs/sdk/models/operations/createtopicpostpmactionssummary.md +++ b/docs/sdk/models/operations/createtopicpostpmactionssummary.md @@ -1,5 +1,15 @@ # CreateTopicPostPMActionsSummary +## Example Usage + +```typescript +import { CreateTopicPostPMActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicPostPMActionsSummary = { + canAct: false, + id: 773456, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopicpostpmrequestbody.md b/docs/sdk/models/operations/createtopicpostpmrequestbody.md index 984ffa3..25a1871 100644 --- a/docs/sdk/models/operations/createtopicpostpmrequestbody.md +++ b/docs/sdk/models/operations/createtopicpostpmrequestbody.md @@ -1,5 +1,16 @@ # CreateTopicPostPMRequestBody +## Example Usage + +```typescript +import { CreateTopicPostPMRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicPostPMRequestBody = { + archetype: "private_message", + raw: "", + targetRecipients: "blake,sam", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopicpostpmresponsebody.md b/docs/sdk/models/operations/createtopicpostpmresponsebody.md index acc7130..59b234a 100644 --- a/docs/sdk/models/operations/createtopicpostpmresponsebody.md +++ b/docs/sdk/models/operations/createtopicpostpmresponsebody.md @@ -2,6 +2,67 @@ post created +## Example Usage + +```typescript +import { CreateTopicPostPMResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicPostPMResponseBody = { + actionsSummary: [ + { + canAct: false, + id: 884952, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + displayUsername: "", + draftSequence: 456410, + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 897277, + incomingLinkCount: 153369, + moderator: false, + name: "", + postNumber: 332191, + postType: 199596, + primaryGroupName: "", + quoteCount: 712927, + readersCount: 432984, + reads: 426943, + replyCount: 528234, + replyToPostNumber: "", + reviewableId: "", + reviewableScoreCount: 301692, + reviewableScorePendingCount: 349440, + score: 70410, + staff: false, + topicId: 781480, + topicSlug: "", + trustLevel: 421844, + updatedAt: "", + userDeleted: false, + userId: 751022, + userTitle: "", + username: "Gilberto2", + version: 350207, + wiki: false, + yours: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopictimerrequest.md b/docs/sdk/models/operations/createtopictimerrequest.md index d08d010..d2c5f24 100644 --- a/docs/sdk/models/operations/createtopictimerrequest.md +++ b/docs/sdk/models/operations/createtopictimerrequest.md @@ -1,5 +1,19 @@ # CreateTopicTimerRequest +## Example Usage + +```typescript +import { CreateTopicTimerRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicTimerRequest = { + apiKey: "", + apiUsername: "", + requestBody: { + time: "", + }, + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopictimerrequestbody.md b/docs/sdk/models/operations/createtopictimerrequestbody.md index 8240cae..79f3c83 100644 --- a/docs/sdk/models/operations/createtopictimerrequestbody.md +++ b/docs/sdk/models/operations/createtopictimerrequestbody.md @@ -1,5 +1,14 @@ # CreateTopicTimerRequestBody +## Example Usage + +```typescript +import { CreateTopicTimerRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicTimerRequestBody = { + time: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createtopictimerresponsebody.md b/docs/sdk/models/operations/createtopictimerresponsebody.md index 7b26b6b..d0d9400 100644 --- a/docs/sdk/models/operations/createtopictimerresponsebody.md +++ b/docs/sdk/models/operations/createtopictimerresponsebody.md @@ -2,6 +2,15 @@ topic updated +## Example Usage + +```typescript +import { CreateTopicTimerResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateTopicTimerResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createuploadrequestbody.md b/docs/sdk/models/operations/createuploadrequestbody.md index 4b7c46f..dc1c81d 100644 --- a/docs/sdk/models/operations/createuploadrequestbody.md +++ b/docs/sdk/models/operations/createuploadrequestbody.md @@ -1,5 +1,14 @@ # CreateUploadRequestBody +## Example Usage + +```typescript +import { CreateUploadRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateUploadRequestBody = { + type: "custom_emoji", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createuploadresponsebody.md b/docs/sdk/models/operations/createuploadresponsebody.md index 6af25ba..518facb 100644 --- a/docs/sdk/models/operations/createuploadresponsebody.md +++ b/docs/sdk/models/operations/createuploadresponsebody.md @@ -2,6 +2,27 @@ file uploaded +## Example Usage + +```typescript +import { CreateUploadResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateUploadResponseBody = { + extension: "mp4v", + filesize: 311486, + height: 416692, + humanFilesize: "", + id: 888616, + originalFilename: "", + retainHours: "", + shortPath: "", + shortUrl: "", + thumbnailHeight: 810839, + thumbnailWidth: 697274, + url: "http://juvenile-cougar.biz", + width: 59383, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createuserrequest.md b/docs/sdk/models/operations/createuserrequest.md index bb531b2..c02bc8a 100644 --- a/docs/sdk/models/operations/createuserrequest.md +++ b/docs/sdk/models/operations/createuserrequest.md @@ -1,5 +1,15 @@ # CreateUserRequest +## Example Usage + +```typescript +import { CreateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateUserRequest = { + apiKey: "", + apiUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createuserrequestbody.md b/docs/sdk/models/operations/createuserrequestbody.md index 96dc73e..7599023 100644 --- a/docs/sdk/models/operations/createuserrequestbody.md +++ b/docs/sdk/models/operations/createuserrequestbody.md @@ -1,5 +1,17 @@ # CreateUserRequestBody +## Example Usage + +```typescript +import { CreateUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateUserRequestBody = { + email: "Jennifer68@yahoo.com", + name: "", + password: "9JOtcD2TrgaNLaS", + username: "Lenny_Treutel46", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/createuserresponsebody.md b/docs/sdk/models/operations/createuserresponsebody.md index 2c34247..8e887fe 100644 --- a/docs/sdk/models/operations/createuserresponsebody.md +++ b/docs/sdk/models/operations/createuserresponsebody.md @@ -2,6 +2,17 @@ user created +## Example Usage + +```typescript +import { CreateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CreateUserResponseBody = { + active: false, + message: "", + success: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/customemojitranslation.md b/docs/sdk/models/operations/customemojitranslation.md index 901f944..91ad783 100644 --- a/docs/sdk/models/operations/customemojitranslation.md +++ b/docs/sdk/models/operations/customemojitranslation.md @@ -1,5 +1,12 @@ # CustomEmojiTranslation +## Example Usage + +```typescript +import { CustomEmojiTranslation } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CustomEmojiTranslation = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/customfields.md b/docs/sdk/models/operations/customfields.md index 0fe8108..e2e24ab 100644 --- a/docs/sdk/models/operations/customfields.md +++ b/docs/sdk/models/operations/customfields.md @@ -1,5 +1,12 @@ # CustomFields +## Example Usage + +```typescript +import { CustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: CustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/data.md b/docs/sdk/models/operations/data.md index d570f36..91297d9 100644 --- a/docs/sdk/models/operations/data.md +++ b/docs/sdk/models/operations/data.md @@ -1,5 +1,12 @@ # Data +## Example Usage + +```typescript +import { Data } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Data = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/deactivateuserrequest.md b/docs/sdk/models/operations/deactivateuserrequest.md index c7e96ac..3167884 100644 --- a/docs/sdk/models/operations/deactivateuserrequest.md +++ b/docs/sdk/models/operations/deactivateuserrequest.md @@ -1,5 +1,14 @@ # DeactivateUserRequest +## Example Usage + +```typescript +import { DeactivateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeactivateUserRequest = { + id: 216897, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deactivateuserresponsebody.md b/docs/sdk/models/operations/deactivateuserresponsebody.md index 6cd533a..4f0c971 100644 --- a/docs/sdk/models/operations/deactivateuserresponsebody.md +++ b/docs/sdk/models/operations/deactivateuserresponsebody.md @@ -2,6 +2,15 @@ response +## Example Usage + +```typescript +import { DeactivateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeactivateUserResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/defaultdarkcolorscheme.md b/docs/sdk/models/operations/defaultdarkcolorscheme.md index 663abf4..843d17d 100644 --- a/docs/sdk/models/operations/defaultdarkcolorscheme.md +++ b/docs/sdk/models/operations/defaultdarkcolorscheme.md @@ -1,5 +1,12 @@ # DefaultDarkColorScheme +## Example Usage + +```typescript +import { DefaultDarkColorScheme } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DefaultDarkColorScheme = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/deletebadgerequest.md b/docs/sdk/models/operations/deletebadgerequest.md index c379cd2..f36e770 100644 --- a/docs/sdk/models/operations/deletebadgerequest.md +++ b/docs/sdk/models/operations/deletebadgerequest.md @@ -1,5 +1,14 @@ # DeleteBadgeRequest +## Example Usage + +```typescript +import { DeleteBadgeRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteBadgeRequest = { + id: 216550, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deletegrouprequest.md b/docs/sdk/models/operations/deletegrouprequest.md index bce357a..e06acab 100644 --- a/docs/sdk/models/operations/deletegrouprequest.md +++ b/docs/sdk/models/operations/deletegrouprequest.md @@ -1,5 +1,14 @@ # DeleteGroupRequest +## Example Usage + +```typescript +import { DeleteGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteGroupRequest = { + id: 971945, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deletegroupresponsebody.md b/docs/sdk/models/operations/deletegroupresponsebody.md index 923b77b..8f75d34 100644 --- a/docs/sdk/models/operations/deletegroupresponsebody.md +++ b/docs/sdk/models/operations/deletegroupresponsebody.md @@ -2,6 +2,15 @@ response +## Example Usage + +```typescript +import { DeleteGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteGroupResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deletepostrequest.md b/docs/sdk/models/operations/deletepostrequest.md index 025d0e2..0553786 100644 --- a/docs/sdk/models/operations/deletepostrequest.md +++ b/docs/sdk/models/operations/deletepostrequest.md @@ -1,5 +1,17 @@ # DeletePostRequest +## Example Usage + +```typescript +import { DeletePostRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeletePostRequest = { + requestBody: { + forceDestroy: true, + }, + id: 64435, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deletepostrequestbody.md b/docs/sdk/models/operations/deletepostrequestbody.md index 78687d0..4860e67 100644 --- a/docs/sdk/models/operations/deletepostrequestbody.md +++ b/docs/sdk/models/operations/deletepostrequestbody.md @@ -1,5 +1,14 @@ # DeletePostRequestBody +## Example Usage + +```typescript +import { DeletePostRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeletePostRequestBody = { + forceDestroy: true, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deleteuserrequest.md b/docs/sdk/models/operations/deleteuserrequest.md index 17a918c..e95e379 100644 --- a/docs/sdk/models/operations/deleteuserrequest.md +++ b/docs/sdk/models/operations/deleteuserrequest.md @@ -1,5 +1,14 @@ # DeleteUserRequest +## Example Usage + +```typescript +import { DeleteUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteUserRequest = { + id: 456015, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/deleteuserrequestbody.md b/docs/sdk/models/operations/deleteuserrequestbody.md index 7e15f21..f7bc0a9 100644 --- a/docs/sdk/models/operations/deleteuserrequestbody.md +++ b/docs/sdk/models/operations/deleteuserrequestbody.md @@ -1,5 +1,12 @@ # DeleteUserRequestBody +## Example Usage + +```typescript +import { DeleteUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteUserRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/deleteuserresponsebody.md b/docs/sdk/models/operations/deleteuserresponsebody.md index 2f5fdcf..29c188c 100644 --- a/docs/sdk/models/operations/deleteuserresponsebody.md +++ b/docs/sdk/models/operations/deleteuserresponsebody.md @@ -2,6 +2,15 @@ response +## Example Usage + +```typescript +import { DeleteUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DeleteUserResponseBody = { + deleted: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/details.md b/docs/sdk/models/operations/details.md index 1aa7a09..04a95d2 100644 --- a/docs/sdk/models/operations/details.md +++ b/docs/sdk/models/operations/details.md @@ -1,5 +1,42 @@ # Details +## Example Usage + +```typescript +import { Details } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Details = { + canArchiveTopic: false, + canCloseTopic: false, + canConvertTopic: false, + canCreatePost: false, + canDelete: false, + canEdit: false, + canEditStaffNotes: false, + canModerateCategory: false, + canMovePosts: false, + canPinUnpinTopic: false, + canRemoveAllowedUsers: false, + canRemoveSelfId: 260904, + canReplyAsNewTopic: false, + canReviewTopic: false, + canSplitMergeTopic: false, + canToggleTopicVisibility: false, + createdBy: { + avatarTemplate: "", + id: 131903, + name: "", + username: "Jerrell_Dooley27", + }, + lastPoster: { + avatarTemplate: "", + id: 97493, + name: "", + username: "Judge39", + }, + notificationLevel: 159845, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/directoryitems.md b/docs/sdk/models/operations/directoryitems.md index 17e47a1..6675523 100644 --- a/docs/sdk/models/operations/directoryitems.md +++ b/docs/sdk/models/operations/directoryitems.md @@ -1,5 +1,28 @@ # DirectoryItems +## Example Usage + +```typescript +import { DirectoryItems } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DirectoryItems = { + daysVisited: 455444, + id: 970076, + likesGiven: 401713, + likesReceived: 25497, + postCount: 248413, + postsRead: 888044, + topicCount: 505866, + topicsEntered: 708609, + user: { + avatarTemplate: "", + id: 310381, + name: "", + title: "", + username: "Drew_Hintz2", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/downloadbackuprequest.md b/docs/sdk/models/operations/downloadbackuprequest.md index 580e5af..2323831 100644 --- a/docs/sdk/models/operations/downloadbackuprequest.md +++ b/docs/sdk/models/operations/downloadbackuprequest.md @@ -1,5 +1,15 @@ # DownloadBackupRequest +## Example Usage + +```typescript +import { DownloadBackupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: DownloadBackupRequest = { + filename: "your_file_here", + token: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/enabled.md b/docs/sdk/models/operations/enabled.md index a28b88b..780b43d 100644 --- a/docs/sdk/models/operations/enabled.md +++ b/docs/sdk/models/operations/enabled.md @@ -1,9 +1,15 @@ # Enabled +## Example Usage + +```typescript +import { Enabled } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Enabled = "false"; +``` ## Values -| Name | Value | -| ------- | ------- | -| `True` | true | -| `False` | false | \ No newline at end of file +```typescript +"true" | "false" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/externalids.md b/docs/sdk/models/operations/externalids.md index 5b9d858..f4bcee4 100644 --- a/docs/sdk/models/operations/externalids.md +++ b/docs/sdk/models/operations/externalids.md @@ -1,5 +1,12 @@ # ExternalIds +## Example Usage + +```typescript +import { ExternalIds } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ExternalIds = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/extras.md b/docs/sdk/models/operations/extras.md index d5f4d29..ed8156d 100644 --- a/docs/sdk/models/operations/extras.md +++ b/docs/sdk/models/operations/extras.md @@ -1,5 +1,14 @@ # Extras +## Example Usage + +```typescript +import { Extras } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Extras = { + visibleGroupNames: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/filet.md b/docs/sdk/models/operations/filet.md index 5cbbe63..d19776d 100644 --- a/docs/sdk/models/operations/filet.md +++ b/docs/sdk/models/operations/filet.md @@ -1,5 +1,15 @@ # FileT +## Example Usage + +```typescript +import { FileT } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: FileT = { + content: new TextEncoder().encode("0x79ac3d1a9D"), + fileName: "your_file_here", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/flag.md b/docs/sdk/models/operations/flag.md index 0ce9b9e..8a3f074 100644 --- a/docs/sdk/models/operations/flag.md +++ b/docs/sdk/models/operations/flag.md @@ -1,13 +1,15 @@ # Flag +## Example Usage + +```typescript +import { Flag } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Flag = "active"; +``` ## Values -| Name | Value | -| ----------- | ----------- | -| `Active` | active | -| `New` | new | -| `Staff` | staff | -| `Suspended` | suspended | -| `Blocked` | blocked | -| `Suspect` | suspect | \ No newline at end of file +```typescript +"active" | "new" | "staff" | "suspended" | "blocked" | "suspect" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/generatepresignedputmetadata.md b/docs/sdk/models/operations/generatepresignedputmetadata.md index 94bf99d..cbc0337 100644 --- a/docs/sdk/models/operations/generatepresignedputmetadata.md +++ b/docs/sdk/models/operations/generatepresignedputmetadata.md @@ -1,5 +1,12 @@ # GeneratePresignedPutMetadata +## Example Usage + +```typescript +import { GeneratePresignedPutMetadata } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GeneratePresignedPutMetadata = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/generatepresignedputrequestbody.md b/docs/sdk/models/operations/generatepresignedputrequestbody.md index 0e1b6c7..af9c29e 100644 --- a/docs/sdk/models/operations/generatepresignedputrequestbody.md +++ b/docs/sdk/models/operations/generatepresignedputrequestbody.md @@ -1,5 +1,16 @@ # GeneratePresignedPutRequestBody +## Example Usage + +```typescript +import { GeneratePresignedPutRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GeneratePresignedPutRequestBody = { + fileName: "IMG_2021.jpeg", + fileSize: 4096, + type: "composer", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/generatepresignedputresponsebody.md b/docs/sdk/models/operations/generatepresignedputresponsebody.md index 49a4ec7..6009ac1 100644 --- a/docs/sdk/models/operations/generatepresignedputresponsebody.md +++ b/docs/sdk/models/operations/generatepresignedputresponsebody.md @@ -2,6 +2,18 @@ external upload initialized +## Example Usage + +```typescript +import { GeneratePresignedPutResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GeneratePresignedPutResponseBody = { + key: "temp/site/uploads/default/12345/67890.jpg", + signedHeaders: {}, + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", + url: "https://file-uploads.s3.us-west-2.amazonaws.com/temp/site/uploads/default/123/456.jpg?x-amz-acl=private&x-amz-meta-sha1-checksum=sha1&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AAAAus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20211221T011246Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=12345678", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/generatepresignedputtype.md b/docs/sdk/models/operations/generatepresignedputtype.md index 1b3c8d2..47187a1 100644 --- a/docs/sdk/models/operations/generatepresignedputtype.md +++ b/docs/sdk/models/operations/generatepresignedputtype.md @@ -1,12 +1,15 @@ # GeneratePresignedPutType +## Example Usage + +```typescript +import { GeneratePresignedPutType } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GeneratePresignedPutType = "card_background"; +``` ## Values -| Name | Value | -| ------------------- | ------------------- | -| `Avatar` | avatar | -| `ProfileBackground` | profile_background | -| `CardBackground` | card_background | -| `CustomEmoji` | custom_emoji | -| `Composer` | composer | \ No newline at end of file +```typescript +"avatar" | "profile_background" | "card_background" | "custom_emoji" | "composer" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/getcategorycategory.md b/docs/sdk/models/operations/getcategorycategory.md index 3177127..e707903 100644 --- a/docs/sdk/models/operations/getcategorycategory.md +++ b/docs/sdk/models/operations/getcategorycategory.md @@ -1,5 +1,72 @@ # GetCategoryCategory +## Example Usage + +```typescript +import { GetCategoryCategory } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryCategory = { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "orchid", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Object-based exuding synergy", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + groupPermissions: [ + { + groupName: "", + permissionType: 542129, + }, + ], + hasChildren: false, + id: 541381, + mailinglistMirror: false, + minimumRequiredTags: 120919, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 923306, + numFeaturedTopics: 680697, + permission: 829898, + position: 287119, + postCount: 968287, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 42976, + name: "", + }, + ], + searchPriority: 919783, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 116098, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getcategorycustomfields.md b/docs/sdk/models/operations/getcategorycustomfields.md index cda8fe0..ef1da14 100644 --- a/docs/sdk/models/operations/getcategorycustomfields.md +++ b/docs/sdk/models/operations/getcategorycustomfields.md @@ -1,5 +1,12 @@ # GetCategoryCustomFields +## Example Usage + +```typescript +import { GetCategoryCustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryCustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getcategorygrouppermissions.md b/docs/sdk/models/operations/getcategorygrouppermissions.md index 1d0107f..4806adf 100644 --- a/docs/sdk/models/operations/getcategorygrouppermissions.md +++ b/docs/sdk/models/operations/getcategorygrouppermissions.md @@ -1,5 +1,15 @@ # GetCategoryGroupPermissions +## Example Usage + +```typescript +import { GetCategoryGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryGroupPermissions = { + groupName: "", + permissionType: 544647, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getcategoryrequest.md b/docs/sdk/models/operations/getcategoryrequest.md index 2f81f28..3999266 100644 --- a/docs/sdk/models/operations/getcategoryrequest.md +++ b/docs/sdk/models/operations/getcategoryrequest.md @@ -1,5 +1,14 @@ # GetCategoryRequest +## Example Usage + +```typescript +import { GetCategoryRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryRequest = { + id: 980581, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getcategoryrequiredtaggroups.md b/docs/sdk/models/operations/getcategoryrequiredtaggroups.md index b48bed7..d1fb9ec 100644 --- a/docs/sdk/models/operations/getcategoryrequiredtaggroups.md +++ b/docs/sdk/models/operations/getcategoryrequiredtaggroups.md @@ -1,5 +1,15 @@ # GetCategoryRequiredTagGroups +## Example Usage + +```typescript +import { GetCategoryRequiredTagGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryRequiredTagGroups = { + minCount: 871786, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getcategoryresponsebody.md b/docs/sdk/models/operations/getcategoryresponsebody.md index 39751d9..e31fba2 100644 --- a/docs/sdk/models/operations/getcategoryresponsebody.md +++ b/docs/sdk/models/operations/getcategoryresponsebody.md @@ -2,6 +2,75 @@ response +## Example Usage + +```typescript +import { GetCategoryResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetCategoryResponseBody = { + category: { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "green", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Configurable client-driven extranet", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + groupPermissions: [ + { + groupName: "", + permissionType: 389135, + }, + ], + hasChildren: false, + id: 246535, + mailinglistMirror: false, + minimumRequiredTags: 952143, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 562783, + numFeaturedTopics: 300029, + permission: 906355, + position: 160467, + postCount: 580107, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 886305, + name: "", + }, + ], + searchPriority: 597937, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 446394, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getgroupgroup.md b/docs/sdk/models/operations/getgroupgroup.md index f0a92d1..7c52215 100644 --- a/docs/sdk/models/operations/getgroupgroup.md +++ b/docs/sdk/models/operations/getgroupgroup.md @@ -1,5 +1,66 @@ # GetGroupGroup +## Example Usage + +```typescript +import { GetGroupGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetGroupGroup = { + allowMembershipRequests: false, + allowUnknownSenderTopicReplies: false, + automatic: false, + automaticMembershipEmailDomains: "", + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 976460, + emailPassword: "", + emailUsername: "", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Jessie Langosh V", + grantTrustLevel: "", + hasMessages: false, + id: 451159, + imapLastError: "", + imapMailboxName: "", + imapMailboxes: [""], + imapNewEmails: "", + imapOldEmails: "", + imapPort: "", + imapServer: "", + imapSsl: "", + incomingEmail: "", + isGroupOwnerDisplay: false, + isGroupUser: false, + membersVisibilityLevel: 739264, + membershipRequestTemplate: "", + mentionable: false, + mentionableLevel: 19987, + messageCount: 39187, + messageable: false, + messageableLevel: 441711, + mutedCategoryIds: [""], + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + regularCategoryIds: [""], + smtpPort: "", + smtpServer: "", + smtpSsl: "", + title: "", + trackingCategoryIds: [""], + userCount: 282807, + visibilityLevel: 979587, + watchingCategoryIds: [""], + watchingFirstPostCategoryIds: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getgrouprequest.md b/docs/sdk/models/operations/getgrouprequest.md index df3a8b8..3ed8d52 100644 --- a/docs/sdk/models/operations/getgrouprequest.md +++ b/docs/sdk/models/operations/getgrouprequest.md @@ -1,5 +1,14 @@ # GetGroupRequest +## Example Usage + +```typescript +import { GetGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetGroupRequest = { + id: "name", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getgroupresponsebody.md b/docs/sdk/models/operations/getgroupresponsebody.md index 2ce3433..f731460 100644 --- a/docs/sdk/models/operations/getgroupresponsebody.md +++ b/docs/sdk/models/operations/getgroupresponsebody.md @@ -2,6 +2,72 @@ success response +## Example Usage + +```typescript +import { GetGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetGroupResponseBody = { + extras: { + visibleGroupNames: [""], + }, + group: { + allowMembershipRequests: false, + allowUnknownSenderTopicReplies: false, + automatic: false, + automaticMembershipEmailDomains: "", + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 120196, + emailPassword: "", + emailUsername: "", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Miss Valerie Kshlerin", + grantTrustLevel: "", + hasMessages: false, + id: 880476, + imapLastError: "", + imapMailboxName: "", + imapMailboxes: [""], + imapNewEmails: "", + imapOldEmails: "", + imapPort: "", + imapServer: "", + imapSsl: "", + incomingEmail: "", + isGroupOwnerDisplay: false, + isGroupUser: false, + membersVisibilityLevel: 414263, + membershipRequestTemplate: "", + mentionable: false, + mentionableLevel: 918236, + messageCount: 64147, + messageable: false, + messageableLevel: 216822, + mutedCategoryIds: [""], + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + regularCategoryIds: [""], + smtpPort: "", + smtpServer: "", + smtpSsl: "", + title: "", + trackingCategoryIds: [""], + userCount: 692472, + visibilityLevel: 565189, + watchingCategoryIds: [""], + watchingFirstPostCategoryIds: [""], + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getnotificationsresponsebody.md b/docs/sdk/models/operations/getnotificationsresponsebody.md index d662e1e..534800c 100644 --- a/docs/sdk/models/operations/getnotificationsresponsebody.md +++ b/docs/sdk/models/operations/getnotificationsresponsebody.md @@ -2,6 +2,13 @@ notifications +## Example Usage + +```typescript +import { GetNotificationsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetNotificationsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getpostrequest.md b/docs/sdk/models/operations/getpostrequest.md index ac05ef9..ae1de31 100644 --- a/docs/sdk/models/operations/getpostrequest.md +++ b/docs/sdk/models/operations/getpostrequest.md @@ -1,5 +1,14 @@ # GetPostRequest +## Example Usage + +```typescript +import { GetPostRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetPostRequest = { + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getpostresponsebody.md b/docs/sdk/models/operations/getpostresponsebody.md index 9aef84e..630ad84 100644 --- a/docs/sdk/models/operations/getpostresponsebody.md +++ b/docs/sdk/models/operations/getpostresponsebody.md @@ -2,6 +2,64 @@ single post +## Example Usage + +```typescript +import { GetPostResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetPostResponseBody = { + actionsSummary: [ + { + id: 264333, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 208253, + incomingLinkCount: 348357, + moderator: false, + postNumber: 932394, + postType: 88248, + primaryGroupName: "", + quoteCount: 215398, + raw: "", + readersCount: 602229, + reads: 858338, + replyCount: 714376, + replyToPostNumber: "", + reviewableId: "", + reviewableScoreCount: 802894, + reviewableScorePendingCount: 157222, + score: 159146, + staff: false, + topicId: 342137, + topicSlug: "", + trustLevel: 605712, + updatedAt: "", + userDeleted: false, + userId: 727250, + userTitle: "", + username: "Bettie_Ondricka63", + version: 554603, + wiki: false, + yours: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getsitecategories.md b/docs/sdk/models/operations/getsitecategories.md index 7f01b56..bae3aca 100644 --- a/docs/sdk/models/operations/getsitecategories.md +++ b/docs/sdk/models/operations/getsitecategories.md @@ -1,5 +1,52 @@ # GetSiteCategories +## Example Usage + +```typescript +import { GetSiteCategories } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetSiteCategories = { + allowGlobalTags: false, + allowedTagGroups: [""], + allowedTags: [""], + canEdit: false, + color: "azure", + defaultListFilter: "", + defaultTopPeriod: "", + defaultView: "", + hasChildren: false, + id: 580887, + minimumRequiredTags: 160230, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 145870, + numFeaturedTopics: 661118, + permission: 335631, + position: 440264, + postCount: 625528, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 76486, + name: "", + }, + ], + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 361306, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getsitegroups.md b/docs/sdk/models/operations/getsitegroups.md index 5b558f1..32570b3 100644 --- a/docs/sdk/models/operations/getsitegroups.md +++ b/docs/sdk/models/operations/getsitegroups.md @@ -1,5 +1,18 @@ # GetSiteGroups +## Example Usage + +```typescript +import { GetSiteGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetSiteGroups = { + flairBgColor: "", + flairColor: "", + flairUrl: "", + id: 696463, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getsiterequiredtaggroups.md b/docs/sdk/models/operations/getsiterequiredtaggroups.md index 5b2eb0c..89f7a14 100644 --- a/docs/sdk/models/operations/getsiterequiredtaggroups.md +++ b/docs/sdk/models/operations/getsiterequiredtaggroups.md @@ -1,5 +1,15 @@ # GetSiteRequiredTagGroups +## Example Usage + +```typescript +import { GetSiteRequiredTagGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetSiteRequiredTagGroups = { + minCount: 238043, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getsiteresponsebody.md b/docs/sdk/models/operations/getsiteresponsebody.md index ae7c706..c1c547f 100644 --- a/docs/sdk/models/operations/getsiteresponsebody.md +++ b/docs/sdk/models/operations/getsiteresponsebody.md @@ -2,6 +2,178 @@ success response +## Example Usage + +```typescript +import { GetSiteResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetSiteResponseBody = { + anonymousTopMenuItems: [""], + archetypes: [ + { + id: "", + name: "", + options: [""], + }, + ], + authProviders: [""], + canCreateTag: false, + canTagPms: false, + canTagTopics: false, + categories: [ + { + allowGlobalTags: false, + allowedTagGroups: [""], + allowedTags: [""], + canEdit: false, + color: "yellow", + defaultListFilter: "", + defaultTopPeriod: "", + defaultView: "", + hasChildren: false, + id: 657020, + minimumRequiredTags: 343392, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 652309, + numFeaturedTopics: 591027, + permission: 821719, + position: 659177, + postCount: 402767, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 397257, + name: "", + }, + ], + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 37565, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, + ], + censoredRegexp: [{}], + customEmojiTranslation: {}, + defaultArchetype: "", + defaultDarkColorScheme: {}, + filters: [""], + groups: [ + { + flairBgColor: "", + flairColor: "", + flairUrl: "", + id: 999278, + name: "", + }, + ], + notificationTypes: { + bookmarkReminder: 984632, + chatGroupMention: 351893, + chatInvitation: 448143, + chatMention: 721407, + chatMessage: 937636, + codeReviewCommitApproved: 637583, + custom: 672041, + edited: 813054, + eventInvitation: 266697, + eventReminder: 976226, + grantedBadge: 564064, + groupMentioned: 889794, + groupMessageSummary: 956933, + invitedToPrivateMessage: 764562, + invitedToTopic: 113486, + inviteeAccepted: 698249, + liked: 272229, + likedConsolidated: 335498, + linked: 82057, + membershipRequestAccepted: 147685, + membershipRequestConsolidated: 765271, + mentioned: 62636, + movedPost: 21688, + postApproved: 241901, + posted: 137251, + privateMessage: 432281, + quoted: 260628, + reaction: 521996, + replied: 871083, + topicReminder: 773084, + votesReleased: 179410, + watchingCategoryOrTag: 958741, + watchingFirstPost: 433279, + }, + periods: [""], + postActionTypes: [ + { + description: "Cross-group eco-centric array", + id: 583404, + isCustomFlag: false, + isFlag: false, + name: "", + nameKey: "", + shortDescription: "", + }, + ], + postTypes: { + moderatorAction: 589695, + regular: 936469, + smallAction: 745398, + whisper: 940782, + }, + tagsFilterRegexp: "", + topMenuItems: [""], + topTags: [""], + topicFeaturedLinkAllowedCategoryIds: [""], + topicFlagTypes: [ + { + description: "Switchable 6th generation task-force", + id: 596211, + isCustomFlag: false, + isFlag: false, + name: "", + nameKey: "", + shortDescription: "", + }, + ], + trustLevels: { + basic: 983427, + leader: 891801, + member: 399802, + newuser: 780931, + regular: 380335, + }, + uncategorizedCategoryId: 211534, + userColorSchemes: [ + { + id: 147808, + isDark: false, + name: "", + }, + ], + userFieldMaxLength: 764995, + userFields: [""], + userThemes: [ + { + colorSchemeId: 684935, + default: false, + name: "", + themeId: 189062, + }, + ], + watchedWordsLink: "", + watchedWordsReplace: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettaggrouppermissions.md b/docs/sdk/models/operations/gettaggrouppermissions.md index 1ec59db..623e7a7 100644 --- a/docs/sdk/models/operations/gettaggrouppermissions.md +++ b/docs/sdk/models/operations/gettaggrouppermissions.md @@ -1,5 +1,12 @@ # GetTagGroupPermissions +## Example Usage + +```typescript +import { GetTagGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagGroupPermissions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettaggrouprequest.md b/docs/sdk/models/operations/gettaggrouprequest.md index 5b6badc..5cd68f7 100644 --- a/docs/sdk/models/operations/gettaggrouprequest.md +++ b/docs/sdk/models/operations/gettaggrouprequest.md @@ -1,5 +1,14 @@ # GetTagGroupRequest +## Example Usage + +```typescript +import { GetTagGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagGroupRequest = { + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettaggroupresponsebody.md b/docs/sdk/models/operations/gettaggroupresponsebody.md index 4349a58..215e149 100644 --- a/docs/sdk/models/operations/gettaggroupresponsebody.md +++ b/docs/sdk/models/operations/gettaggroupresponsebody.md @@ -2,6 +2,13 @@ notifications +## Example Usage + +```typescript +import { GetTagGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagGroupResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettaggrouptaggroup.md b/docs/sdk/models/operations/gettaggrouptaggroup.md index 4541ed2..475cbbf 100644 --- a/docs/sdk/models/operations/gettaggrouptaggroup.md +++ b/docs/sdk/models/operations/gettaggrouptaggroup.md @@ -1,5 +1,12 @@ # GetTagGroupTagGroup +## Example Usage + +```typescript +import { GetTagGroupTagGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagGroupTagGroup = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagposters.md b/docs/sdk/models/operations/gettagposters.md index e8ee6c9..5f4a27a 100644 --- a/docs/sdk/models/operations/gettagposters.md +++ b/docs/sdk/models/operations/gettagposters.md @@ -1,5 +1,12 @@ # GetTagPosters +## Example Usage + +```typescript +import { GetTagPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagPosters = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagrequest.md b/docs/sdk/models/operations/gettagrequest.md index 244c2cc..e6f4426 100644 --- a/docs/sdk/models/operations/gettagrequest.md +++ b/docs/sdk/models/operations/gettagrequest.md @@ -1,5 +1,14 @@ # GetTagRequest +## Example Usage + +```typescript +import { GetTagRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagRequest = { + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagresponsebody.md b/docs/sdk/models/operations/gettagresponsebody.md index c64099b..2b196a1 100644 --- a/docs/sdk/models/operations/gettagresponsebody.md +++ b/docs/sdk/models/operations/gettagresponsebody.md @@ -2,6 +2,13 @@ notifications +## Example Usage + +```typescript +import { GetTagResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagtags.md b/docs/sdk/models/operations/gettagtags.md index 08e3304..f6679c6 100644 --- a/docs/sdk/models/operations/gettagtags.md +++ b/docs/sdk/models/operations/gettagtags.md @@ -1,5 +1,12 @@ # GetTagTags +## Example Usage + +```typescript +import { GetTagTags } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagTags = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagtopiclist.md b/docs/sdk/models/operations/gettagtopiclist.md index 7b6d52f..4438042 100644 --- a/docs/sdk/models/operations/gettagtopiclist.md +++ b/docs/sdk/models/operations/gettagtopiclist.md @@ -1,5 +1,12 @@ # GetTagTopicList +## Example Usage + +```typescript +import { GetTagTopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagTopicList = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagtopics.md b/docs/sdk/models/operations/gettagtopics.md index 79cc68e..22bd0b0 100644 --- a/docs/sdk/models/operations/gettagtopics.md +++ b/docs/sdk/models/operations/gettagtopics.md @@ -1,5 +1,12 @@ # GetTagTopics +## Example Usage + +```typescript +import { GetTagTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagTopics = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettagusers.md b/docs/sdk/models/operations/gettagusers.md index 2faafac..bf86582 100644 --- a/docs/sdk/models/operations/gettagusers.md +++ b/docs/sdk/models/operations/gettagusers.md @@ -1,5 +1,12 @@ # GetTagUsers +## Example Usage + +```typescript +import { GetTagUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTagUsers = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopicactionssummary.md b/docs/sdk/models/operations/gettopicactionssummary.md index 72394de..422a8d5 100644 --- a/docs/sdk/models/operations/gettopicactionssummary.md +++ b/docs/sdk/models/operations/gettopicactionssummary.md @@ -1,5 +1,17 @@ # GetTopicActionsSummary +## Example Usage + +```typescript +import { GetTopicActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicActionsSummary = { + canAct: false, + count: 895692, + hidden: false, + id: 95619, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopicbyexternalidrequest.md b/docs/sdk/models/operations/gettopicbyexternalidrequest.md index b7b22f0..40fcf94 100644 --- a/docs/sdk/models/operations/gettopicbyexternalidrequest.md +++ b/docs/sdk/models/operations/gettopicbyexternalidrequest.md @@ -1,5 +1,14 @@ # GetTopicByExternalIdRequest +## Example Usage + +```typescript +import { GetTopicByExternalIdRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicByExternalIdRequest = { + externalId: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopicrequest.md b/docs/sdk/models/operations/gettopicrequest.md index 4517c19..d0ff9dd 100644 --- a/docs/sdk/models/operations/gettopicrequest.md +++ b/docs/sdk/models/operations/gettopicrequest.md @@ -1,5 +1,16 @@ # GetTopicRequest +## Example Usage + +```typescript +import { GetTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopicresponsebody.md b/docs/sdk/models/operations/gettopicresponsebody.md index 4046b39..0c2fe41 100644 --- a/docs/sdk/models/operations/gettopicresponsebody.md +++ b/docs/sdk/models/operations/gettopicresponsebody.md @@ -2,6 +2,212 @@ specific posts +## Example Usage + +```typescript +import { GetTopicResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicResponseBody = { + actionsSummary: [ + { + canAct: false, + count: 726878, + hidden: false, + id: 102413, + }, + ], + archetype: "", + archived: false, + bookmarked: false, + bookmarks: [""], + categoryId: 975425, + chunkSize: 156383, + closed: false, + createdAt: "", + deletedAt: "", + deletedBy: "", + details: { + canArchiveTopic: false, + canCloseTopic: false, + canConvertTopic: false, + canCreatePost: false, + canDelete: false, + canEdit: false, + canEditStaffNotes: false, + canModerateCategory: false, + canMovePosts: false, + canPinUnpinTopic: false, + canRemoveAllowedUsers: false, + canRemoveSelfId: 782090, + canReplyAsNewTopic: false, + canReviewTopic: false, + canSplitMergeTopic: false, + canToggleTopicVisibility: false, + createdBy: { + avatarTemplate: "", + id: 304198, + name: "", + username: "Delia42", + }, + lastPoster: { + avatarTemplate: "", + id: 406922, + name: "", + username: "Berenice.Thiel", + }, + notificationLevel: 246557, + }, + draft: "", + draftKey: "", + draftSequence: 284086, + fancyTitle: "", + featuredLink: "", + hasDeleted: false, + hasSummary: false, + highestPostNumber: 596433, + id: 935302, + imageUrl: "", + lastPostedAt: "", + likeCount: 117525, + messageBusLastId: 772266, + participantCount: 975884, + pinned: false, + pinnedAt: "", + pinnedGlobally: false, + pinnedUntil: "", + postStream: { + posts: [ + { + actionsSummary: [ + { + canAct: false, + id: 610987, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + displayUsername: "", + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 932562, + incomingLinkCount: 2677, + linkCounts: [ + { + clicks: 391797, + internal: false, + reflection: false, + title: "", + url: "https://esteemed-poet.biz", + }, + ], + moderator: false, + name: "", + postNumber: 224467, + postType: 483394, + primaryGroupName: "", + quoteCount: 24753, + read: false, + readersCount: 39992, + reads: 7468, + replyCount: 639705, + replyToPostNumber: "", + reviewableId: 927403, + reviewableScoreCount: 408303, + reviewableScorePendingCount: 693153, + score: 377406, + staff: false, + topicId: 705148, + topicSlug: "", + trustLevel: 809365, + updatedAt: "", + userDeleted: false, + userId: 596065, + userTitle: "", + username: "Melvin.Lind35", + version: 600193, + wiki: false, + yours: false, + }, + ], + stream: [""], + }, + postsCount: 897543, + replyCount: 654082, + showReadIndicator: false, + slowModeEnabledUntil: "", + slowModeSeconds: 769967, + slug: "", + suggestedTopics: [ + { + archetype: "", + archived: false, + bookmarked: "", + bumped: false, + bumpedAt: "", + categoryId: 373040, + closed: false, + createdAt: "", + excerpt: "", + fancyTitle: "", + featuredLink: "", + highestPostNumber: 357425, + id: 668234, + imageUrl: "", + lastPostedAt: "", + likeCount: 621666, + liked: "", + pinned: false, + posters: [ + { + description: "Multi-channelled discrete architecture", + extras: "", + user: { + avatarTemplate: "", + id: 874400, + name: "", + username: "Daron21", + }, + }, + ], + postsCount: 322017, + replyCount: 183033, + slug: "", + tags: [""], + tagsDescriptions: {}, + title: "", + unpinned: "", + unseen: false, + views: 611328, + visible: false, + }, + ], + summarizable: false, + tags: [""], + tagsDescriptions: {}, + thumbnails: "", + timelineLookup: [""], + title: "", + topicTimer: "", + unpinned: "", + userId: 403026, + views: 367626, + visible: false, + wordCount: 745233, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopictagsdescriptions.md b/docs/sdk/models/operations/gettopictagsdescriptions.md index 6cb3b56..60c12ec 100644 --- a/docs/sdk/models/operations/gettopictagsdescriptions.md +++ b/docs/sdk/models/operations/gettopictagsdescriptions.md @@ -1,5 +1,12 @@ # GetTopicTagsDescriptions +## Example Usage + +```typescript +import { GetTopicTagsDescriptions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicTagsDescriptions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopictopicsactionssummary.md b/docs/sdk/models/operations/gettopictopicsactionssummary.md index 237ea1c..7af710f 100644 --- a/docs/sdk/models/operations/gettopictopicsactionssummary.md +++ b/docs/sdk/models/operations/gettopictopicsactionssummary.md @@ -1,5 +1,15 @@ # GetTopicTopicsActionsSummary +## Example Usage + +```typescript +import { GetTopicTopicsActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicTopicsActionsSummary = { + canAct: false, + id: 233078, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/gettopicuser.md b/docs/sdk/models/operations/gettopicuser.md index 97b793c..698db79 100644 --- a/docs/sdk/models/operations/gettopicuser.md +++ b/docs/sdk/models/operations/gettopicuser.md @@ -1,5 +1,17 @@ # GetTopicUser +## Example Usage + +```typescript +import { GetTopicUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetTopicUser = { + avatarTemplate: "", + id: 65082, + name: "", + username: "Paxton.Pfannerstill24", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusercustomfields.md b/docs/sdk/models/operations/getusercustomfields.md index 85fbfad..dbdee16 100644 --- a/docs/sdk/models/operations/getusercustomfields.md +++ b/docs/sdk/models/operations/getusercustomfields.md @@ -1,5 +1,12 @@ # GetUserCustomFields +## Example Usage + +```typescript +import { GetUserCustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserCustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseremailsrequest.md b/docs/sdk/models/operations/getuseremailsrequest.md index 4e0b868..99d36e0 100644 --- a/docs/sdk/models/operations/getuseremailsrequest.md +++ b/docs/sdk/models/operations/getuseremailsrequest.md @@ -1,5 +1,14 @@ # GetUserEmailsRequest +## Example Usage + +```typescript +import { GetUserEmailsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserEmailsRequest = { + username: "Everett_Willms41", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseremailsresponsebody.md b/docs/sdk/models/operations/getuseremailsresponsebody.md index d60ea6b..da3d980 100644 --- a/docs/sdk/models/operations/getuseremailsresponsebody.md +++ b/docs/sdk/models/operations/getuseremailsresponsebody.md @@ -2,6 +2,18 @@ success response +## Example Usage + +```typescript +import { GetUserEmailsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserEmailsResponseBody = { + associatedAccounts: [""], + email: "Flossie.Hartmann@hotmail.com", + secondaryEmails: [""], + unconfirmedEmails: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidcustomfields.md b/docs/sdk/models/operations/getuserexternalidcustomfields.md index 0b497f6..939e8ba 100644 --- a/docs/sdk/models/operations/getuserexternalidcustomfields.md +++ b/docs/sdk/models/operations/getuserexternalidcustomfields.md @@ -1,5 +1,12 @@ # GetUserExternalIdCustomFields +## Example Usage + +```typescript +import { GetUserExternalIdCustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdCustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidgroups.md b/docs/sdk/models/operations/getuserexternalidgroups.md index 23b73e5..4044444 100644 --- a/docs/sdk/models/operations/getuserexternalidgroups.md +++ b/docs/sdk/models/operations/getuserexternalidgroups.md @@ -1,5 +1,42 @@ # GetUserExternalIdGroups +## Example Usage + +```typescript +import { GetUserExternalIdGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdGroups = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 232234, + displayName: "Tierra5", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Ms. Marco Ankunding", + grantTrustLevel: "", + hasMessages: false, + id: 304582, + incomingEmail: "", + membersVisibilityLevel: 146946, + membershipRequestTemplate: "", + mentionableLevel: 882860, + messageableLevel: 79522, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 250622, + visibilityLevel: 89603, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidgroupusers.md b/docs/sdk/models/operations/getuserexternalidgroupusers.md index 6389573..a4b7879 100644 --- a/docs/sdk/models/operations/getuserexternalidgroupusers.md +++ b/docs/sdk/models/operations/getuserexternalidgroupusers.md @@ -1,5 +1,16 @@ # GetUserExternalIdGroupUsers +## Example Usage + +```typescript +import { GetUserExternalIdGroupUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdGroupUsers = { + groupId: 301831, + notificationLevel: 407241, + userId: 775220, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidrequest.md b/docs/sdk/models/operations/getuserexternalidrequest.md index 0a6f5aa..9cc011a 100644 --- a/docs/sdk/models/operations/getuserexternalidrequest.md +++ b/docs/sdk/models/operations/getuserexternalidrequest.md @@ -1,5 +1,16 @@ # GetUserExternalIdRequest +## Example Usage + +```typescript +import { GetUserExternalIdRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdRequest = { + apiKey: "", + apiUsername: "", + externalId: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidresponsebody.md b/docs/sdk/models/operations/getuserexternalidresponsebody.md index 22fb1bf..f7128f6 100644 --- a/docs/sdk/models/operations/getuserexternalidresponsebody.md +++ b/docs/sdk/models/operations/getuserexternalidresponsebody.md @@ -2,6 +2,190 @@ user response +## Example Usage + +```typescript +import { GetUserExternalIdResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdResponseBody = { + user: { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 147014, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 956406, + notificationLevel: 159870, + userId: 187131, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 129412, + displayName: "Stuart.Mayert", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Ms. Olive Tillman", + grantTrustLevel: "", + hasMessages: false, + id: 724168, + incomingEmail: "", + membersVisibilityLevel: 877131, + membershipRequestTemplate: "", + mentionableLevel: 399025, + messageableLevel: 93459, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 904045, + visibilityLevel: 426306, + }, + ], + hasTitleBadges: false, + id: 690025, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "fr_CA", + mailingListPostsPerDay: 699622, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 580197, + postCount: 327720, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 716244, + recentTimeRead: 756779, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 27069, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 636061, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 731398, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 240020, + day0StartTime: 766964, + day1EndTime: 160538, + day1StartTime: 9766, + day2EndTime: 796392, + day2StartTime: 308286, + day3EndTime: 959167, + day3StartTime: 232865, + day4EndTime: 458139, + day4StartTime: 503427, + day5EndTime: 590984, + day5StartTime: 953722, + day6EndTime: 857723, + day6StartTime: 557811, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 457223, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 97468, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 951875, + emailMessagesLevel: 621679, + emailPreviousReplies: 575751, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 863023, + mailingListMode: false, + mailingListModeFrequency: 820767, + newTopicDurationMinutes: 157632, + notificationLevelWhenReplying: 908844, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 992430, + themeIds: [""], + themeKeySeq: 815524, + timezone: "America/Chicago", + titleCountMode: "", + userId: 159414, + }, + username: "Aurelie.Murphy", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], + }, + userBadges: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternaliduser.md b/docs/sdk/models/operations/getuserexternaliduser.md index 27c218e..ea91ae5 100644 --- a/docs/sdk/models/operations/getuserexternaliduser.md +++ b/docs/sdk/models/operations/getuserexternaliduser.md @@ -1,5 +1,186 @@ # GetUserExternalIdUser +## Example Usage + +```typescript +import { GetUserExternalIdUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdUser = { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 852635, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 283519, + notificationLevel: 433439, + userId: 379927, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 826871, + displayName: "Chet.Lang5", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Rickey DuBuque", + grantTrustLevel: "", + hasMessages: false, + id: 777408, + incomingEmail: "", + membersVisibilityLevel: 681359, + membershipRequestTemplate: "", + mentionableLevel: 259422, + messageableLevel: 178367, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 373813, + visibilityLevel: 69859, + }, + ], + hasTitleBadges: false, + id: 587600, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "af_ZA", + mailingListPostsPerDay: 272822, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 892050, + postCount: 370853, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 133465, + recentTimeRead: 197054, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 779192, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 459856, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 925164, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 44612, + day0StartTime: 715179, + day1EndTime: 799796, + day1StartTime: 490819, + day2EndTime: 76956, + day2StartTime: 469498, + day3EndTime: 518835, + day3StartTime: 882710, + day4EndTime: 306810, + day4StartTime: 488410, + day5EndTime: 577543, + day5StartTime: 414567, + day6EndTime: 959434, + day6StartTime: 174112, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 645570, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 475289, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 35362, + emailMessagesLevel: 783648, + emailPreviousReplies: 430402, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 556429, + mailingListMode: false, + mailingListModeFrequency: 510017, + newTopicDurationMinutes: 159867, + notificationLevelWhenReplying: 536178, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 143829, + themeIds: [""], + themeKeySeq: 681393, + timezone: "Asia/Yekaterinburg", + titleCountMode: "", + userId: 277596, + }, + username: "Kameron39", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternaliduserauthtokens.md b/docs/sdk/models/operations/getuserexternaliduserauthtokens.md index 14ee597..43a33c8 100644 --- a/docs/sdk/models/operations/getuserexternaliduserauthtokens.md +++ b/docs/sdk/models/operations/getuserexternaliduserauthtokens.md @@ -1,5 +1,23 @@ # GetUserExternalIdUserAuthTokens +## Example Usage + +```typescript +import { GetUserExternalIdUserAuthTokens } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdUserAuthTokens = { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 677412, + isActive: false, + location: "", + os: "", + seenAt: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternaliduserfields.md b/docs/sdk/models/operations/getuserexternaliduserfields.md index 7659964..e74a790 100644 --- a/docs/sdk/models/operations/getuserexternaliduserfields.md +++ b/docs/sdk/models/operations/getuserexternaliduserfields.md @@ -1,5 +1,15 @@ # GetUserExternalIdUserFields +## Example Usage + +```typescript +import { GetUserExternalIdUserFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdUserFields = { + one: "", + two: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternalidusernotificationschedule.md b/docs/sdk/models/operations/getuserexternalidusernotificationschedule.md index ed242d3..41928e1 100644 --- a/docs/sdk/models/operations/getuserexternalidusernotificationschedule.md +++ b/docs/sdk/models/operations/getuserexternalidusernotificationschedule.md @@ -1,5 +1,28 @@ # GetUserExternalIdUserNotificationSchedule +## Example Usage + +```typescript +import { GetUserExternalIdUserNotificationSchedule } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdUserNotificationSchedule = { + day0EndTime: 672048, + day0StartTime: 810424, + day1EndTime: 245367, + day1StartTime: 432148, + day2EndTime: 420539, + day2StartTime: 752135, + day3EndTime: 557369, + day3StartTime: 829603, + day4EndTime: 860552, + day4StartTime: 379034, + day5EndTime: 727044, + day5StartTime: 96549, + day6EndTime: 270328, + day6StartTime: 256139, + enabled: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserexternaliduseroption.md b/docs/sdk/models/operations/getuserexternaliduseroption.md index 14c6076..9f7de1e 100644 --- a/docs/sdk/models/operations/getuserexternaliduseroption.md +++ b/docs/sdk/models/operations/getuserexternaliduseroption.md @@ -1,5 +1,45 @@ # GetUserExternalIdUserOption +## Example Usage + +```typescript +import { GetUserExternalIdUserOption } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserExternalIdUserOption = { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 131482, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 591935, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 55374, + emailMessagesLevel: 476477, + emailPreviousReplies: 301598, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 487935, + mailingListMode: false, + mailingListModeFrequency: 262118, + newTopicDurationMinutes: 458515, + notificationLevelWhenReplying: 456141, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 524593, + themeIds: [""], + themeKeySeq: 683282, + timezone: "Africa/Algiers", + titleCountMode: "", + userId: 695626, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusergroups.md b/docs/sdk/models/operations/getusergroups.md index 32c4e07..8e92c8d 100644 --- a/docs/sdk/models/operations/getusergroups.md +++ b/docs/sdk/models/operations/getusergroups.md @@ -1,5 +1,42 @@ # GetUserGroups +## Example Usage + +```typescript +import { GetUserGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserGroups = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 881586, + displayName: "Emmanuelle_Turner", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Derek Sipes", + grantTrustLevel: "", + hasMessages: false, + id: 55, + incomingEmail: "", + membersVisibilityLevel: 872651, + membershipRequestTemplate: "", + mentionableLevel: 311860, + messageableLevel: 273542, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 425451, + visibilityLevel: 798047, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md index e0d0cea..b72fd4e 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidcustomfields.md @@ -1,5 +1,12 @@ # GetUserIdentiyProviderExternalIdCustomFields +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdCustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdCustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidgroups.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidgroups.md index f175329..983e9ca 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidgroups.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidgroups.md @@ -1,5 +1,42 @@ # GetUserIdentiyProviderExternalIdGroups +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdGroups = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 424032, + displayName: "Isai_Gerlach74", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Mrs. Michele Williamson", + grantTrustLevel: "", + hasMessages: false, + id: 356707, + incomingEmail: "", + membersVisibilityLevel: 391774, + membershipRequestTemplate: "", + mentionableLevel: 16328, + messageableLevel: 531849, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 185232, + visibilityLevel: 845358, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md index 6a39429..b652d54 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidgroupusers.md @@ -1,5 +1,16 @@ # GetUserIdentiyProviderExternalIdGroupUsers +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdGroupUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdGroupUsers = { + groupId: 949298, + notificationLevel: 62713, + userId: 936747, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md index 304aa1d..7610883 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidrequest.md @@ -1,5 +1,17 @@ # GetUserIdentiyProviderExternalIdRequest +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdRequest = { + apiKey: "", + apiUsername: "", + externalId: "", + provider: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md index f522b7c..12b9c2b 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidresponsebody.md @@ -2,6 +2,190 @@ user response +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdResponseBody = { + user: { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 348519, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 937285, + notificationLevel: 814967, + userId: 257233, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 985492, + displayName: "Georgianna_Wisozk89", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Katherine Zemlak", + grantTrustLevel: "", + hasMessages: false, + id: 228263, + incomingEmail: "", + membersVisibilityLevel: 105906, + membershipRequestTemplate: "", + mentionableLevel: 489509, + messageableLevel: 950953, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 891523, + visibilityLevel: 233420, + }, + ], + hasTitleBadges: false, + id: 358107, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "nb_NO", + mailingListPostsPerDay: 385237, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 58356, + postCount: 916727, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 730709, + recentTimeRead: 113816, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 881721, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 631126, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 272437, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 132815, + day0StartTime: 379057, + day1EndTime: 374244, + day1StartTime: 374296, + day2EndTime: 324405, + day2StartTime: 748789, + day3EndTime: 680116, + day3StartTime: 237807, + day4EndTime: 795535, + day4StartTime: 171853, + day5EndTime: 503934, + day5StartTime: 449292, + day6EndTime: 296242, + day6StartTime: 304468, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 885963, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 839189, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 351870, + emailMessagesLevel: 237742, + emailPreviousReplies: 738391, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 502389, + mailingListMode: false, + mailingListModeFrequency: 555361, + newTopicDurationMinutes: 942584, + notificationLevelWhenReplying: 201517, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 633998, + themeIds: [""], + themeKeySeq: 548519, + timezone: "Australia/Adelaide", + titleCountMode: "", + userId: 519643, + }, + username: "Tristian.Heidenreich69", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], + }, + userBadges: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md b/docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md index bcf5671..a941cd5 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternaliduser.md @@ -1,5 +1,186 @@ # GetUserIdentiyProviderExternalIdUser +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdUser = { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 221161, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 580152, + notificationLevel: 253191, + userId: 771089, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 131055, + displayName: "Garrison.Anderson", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Wendell Frami", + grantTrustLevel: "", + hasMessages: false, + id: 990345, + incomingEmail: "", + membersVisibilityLevel: 45659, + membershipRequestTemplate: "", + mentionableLevel: 409054, + messageableLevel: 310067, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 162954, + visibilityLevel: 831520, + }, + ], + hasTitleBadges: false, + id: 638762, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "ro", + mailingListPostsPerDay: 490305, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 640024, + postCount: 989410, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 368102, + recentTimeRead: 65304, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 312753, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 783235, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 801836, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 288398, + day0StartTime: 70447, + day1EndTime: 241418, + day1StartTime: 683573, + day2EndTime: 662505, + day2StartTime: 380729, + day3EndTime: 246063, + day3StartTime: 633931, + day4EndTime: 665859, + day4StartTime: 926880, + day5EndTime: 517309, + day5StartTime: 853940, + day6EndTime: 424089, + day6StartTime: 497678, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 554688, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 427834, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 287051, + emailMessagesLevel: 822560, + emailPreviousReplies: 706575, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 738227, + mailingListMode: false, + mailingListModeFrequency: 414857, + newTopicDurationMinutes: 447144, + notificationLevelWhenReplying: 360545, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 968904, + themeIds: [""], + themeKeySeq: 828657, + timezone: "Europe/Zagreb", + titleCountMode: "", + userId: 924967, + }, + username: "Graham.Bayer44", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternaliduserauthtokens.md b/docs/sdk/models/operations/getuseridentiyproviderexternaliduserauthtokens.md index cbed9c9..8bb2b0a 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternaliduserauthtokens.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternaliduserauthtokens.md @@ -1,5 +1,23 @@ # GetUserIdentiyProviderExternalIdUserAuthTokens +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdUserAuthTokens } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdUserAuthTokens = { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 401259, + isActive: false, + location: "", + os: "", + seenAt: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternaliduserfields.md b/docs/sdk/models/operations/getuseridentiyproviderexternaliduserfields.md index 7595c88..2ab5486 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternaliduserfields.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternaliduserfields.md @@ -1,5 +1,15 @@ # GetUserIdentiyProviderExternalIdUserFields +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdUserFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdUserFields = { + one: "", + two: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternalidusernotificationschedule.md b/docs/sdk/models/operations/getuseridentiyproviderexternalidusernotificationschedule.md index bfe745f..e2fd65d 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternalidusernotificationschedule.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternalidusernotificationschedule.md @@ -1,5 +1,28 @@ # GetUserIdentiyProviderExternalIdUserNotificationSchedule +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdUserNotificationSchedule } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdUserNotificationSchedule = { + day0EndTime: 536275, + day0StartTime: 929292, + day1EndTime: 680270, + day1StartTime: 99615, + day2EndTime: 609178, + day2StartTime: 945302, + day3EndTime: 98478, + day3StartTime: 869489, + day4EndTime: 92027, + day4StartTime: 454162, + day5EndTime: 55965, + day5StartTime: 326701, + day6EndTime: 86532, + day6StartTime: 232744, + enabled: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md b/docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md index 15d251a..282bd51 100644 --- a/docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md +++ b/docs/sdk/models/operations/getuseridentiyproviderexternaliduseroption.md @@ -1,5 +1,45 @@ # GetUserIdentiyProviderExternalIdUserOption +## Example Usage + +```typescript +import { GetUserIdentiyProviderExternalIdUserOption } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserIdentiyProviderExternalIdUserOption = { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 237173, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 614465, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 839513, + emailMessagesLevel: 33074, + emailPreviousReplies: 522371, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 15606, + mailingListMode: false, + mailingListModeFrequency: 513075, + newTopicDurationMinutes: 428796, + notificationLevelWhenReplying: 649832, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 68074, + themeIds: [""], + themeKeySeq: 544591, + timezone: "Europe/Dublin", + titleCountMode: "", + userId: 32465, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserrequest.md b/docs/sdk/models/operations/getuserrequest.md index 2bb31f3..6be8da9 100644 --- a/docs/sdk/models/operations/getuserrequest.md +++ b/docs/sdk/models/operations/getuserrequest.md @@ -1,5 +1,16 @@ # GetUserRequest +## Example Usage + +```typescript +import { GetUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserRequest = { + apiKey: "", + apiUsername: "", + username: "Makenzie13", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getuserresponsebody.md b/docs/sdk/models/operations/getuserresponsebody.md index dac046e..3544cc9 100644 --- a/docs/sdk/models/operations/getuserresponsebody.md +++ b/docs/sdk/models/operations/getuserresponsebody.md @@ -2,6 +2,190 @@ user response +## Example Usage + +```typescript +import { GetUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserResponseBody = { + user: { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 63955, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 512393, + notificationLevel: 485628, + userId: 580447, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 977496, + displayName: "Paris.Terry", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Dixie Klocko", + grantTrustLevel: "", + hasMessages: false, + id: 949319, + incomingEmail: "", + membersVisibilityLevel: 492268, + membershipRequestTemplate: "", + mentionableLevel: 941378, + messageableLevel: 715561, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 799203, + visibilityLevel: 486160, + }, + ], + hasTitleBadges: false, + id: 630448, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "ne", + mailingListPostsPerDay: 874288, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 498140, + postCount: 293020, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 844550, + recentTimeRead: 848944, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 194342, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 617877, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 773326, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 13236, + day0StartTime: 974259, + day1EndTime: 347233, + day1StartTime: 862310, + day2EndTime: 148141, + day2StartTime: 780427, + day3EndTime: 981830, + day3StartTime: 985033, + day4EndTime: 478370, + day4StartTime: 753570, + day5EndTime: 497391, + day5StartTime: 4048, + day6EndTime: 639473, + day6StartTime: 269479, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 368584, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 410492, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 136900, + emailMessagesLevel: 428224, + emailPreviousReplies: 822118, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 297842, + mailingListMode: false, + mailingListModeFrequency: 189848, + newTopicDurationMinutes: 401132, + notificationLevelWhenReplying: 511319, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 120657, + themeIds: [""], + themeKeySeq: 224317, + timezone: "Pacific/Tongatapu", + titleCountMode: "", + userId: 97844, + }, + username: "Gustave_Stoltenberg", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], + }, + userBadges: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagesposters.md b/docs/sdk/models/operations/getusersentprivatemessagesposters.md index d92714e..dc27573 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagesposters.md +++ b/docs/sdk/models/operations/getusersentprivatemessagesposters.md @@ -1,5 +1,12 @@ # GetUserSentPrivateMessagesPosters +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesPosters = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagesrequest.md b/docs/sdk/models/operations/getusersentprivatemessagesrequest.md index b05840d..082a7aa 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagesrequest.md +++ b/docs/sdk/models/operations/getusersentprivatemessagesrequest.md @@ -1,5 +1,14 @@ # GetUserSentPrivateMessagesRequest +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesRequest = { + username: "Lacey.Hansen20", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md b/docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md index 74ab829..bbbbe9f 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md +++ b/docs/sdk/models/operations/getusersentprivatemessagesresponsebody.md @@ -2,6 +2,13 @@ private messages +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagestopiclist.md b/docs/sdk/models/operations/getusersentprivatemessagestopiclist.md index 5083b66..131ba42 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagestopiclist.md +++ b/docs/sdk/models/operations/getusersentprivatemessagestopiclist.md @@ -1,5 +1,12 @@ # GetUserSentPrivateMessagesTopicList +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesTopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesTopicList = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagestopics.md b/docs/sdk/models/operations/getusersentprivatemessagestopics.md index 64a71cf..30cb534 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagestopics.md +++ b/docs/sdk/models/operations/getusersentprivatemessagestopics.md @@ -1,5 +1,12 @@ # GetUserSentPrivateMessagesTopics +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesTopics = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/getusersentprivatemessagesusers.md b/docs/sdk/models/operations/getusersentprivatemessagesusers.md index c6a3b75..21d22ef 100644 --- a/docs/sdk/models/operations/getusersentprivatemessagesusers.md +++ b/docs/sdk/models/operations/getusersentprivatemessagesusers.md @@ -1,5 +1,12 @@ # GetUserSentPrivateMessagesUsers +## Example Usage + +```typescript +import { GetUserSentPrivateMessagesUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GetUserSentPrivateMessagesUsers = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/grantedbies.md b/docs/sdk/models/operations/grantedbies.md index b5208e4..7111421 100644 --- a/docs/sdk/models/operations/grantedbies.md +++ b/docs/sdk/models/operations/grantedbies.md @@ -1,5 +1,21 @@ # GrantedBies +## Example Usage + +```typescript +import { GrantedBies } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GrantedBies = { + admin: false, + avatarTemplate: "", + flairName: "", + id: 449950, + moderator: false, + name: "", + trustLevel: 359508, + username: "Leslie_Kertzmann9", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/group.md b/docs/sdk/models/operations/group.md index 293dc7b..2208cca 100644 --- a/docs/sdk/models/operations/group.md +++ b/docs/sdk/models/operations/group.md @@ -1,5 +1,14 @@ # Group +## Example Usage + +```typescript +import { Group } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Group = { + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/groupedsearchresult.md b/docs/sdk/models/operations/groupedsearchresult.md index fd127c6..4e211ae 100644 --- a/docs/sdk/models/operations/groupedsearchresult.md +++ b/docs/sdk/models/operations/groupedsearchresult.md @@ -1,5 +1,26 @@ # GroupedSearchResult +## Example Usage + +```typescript +import { GroupedSearchResult } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GroupedSearchResult = { + canCreateTopic: false, + categoryIds: [""], + error: "", + groupIds: [""], + moreCategories: "", + moreFullPageResults: "", + morePosts: "", + moreUsers: "", + postIds: [""], + searchLogId: 357347, + tagIds: [""], + term: "", + userIds: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/grouppermissions.md b/docs/sdk/models/operations/grouppermissions.md index bc47f26..49093db 100644 --- a/docs/sdk/models/operations/grouppermissions.md +++ b/docs/sdk/models/operations/grouppermissions.md @@ -1,5 +1,15 @@ # GroupPermissions +## Example Usage + +```typescript +import { GroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GroupPermissions = { + groupName: "", + permissionType: 696483, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/groups.md b/docs/sdk/models/operations/groups.md index 540f097..221449c 100644 --- a/docs/sdk/models/operations/groups.md +++ b/docs/sdk/models/operations/groups.md @@ -1,5 +1,42 @@ # Groups +## Example Usage + +```typescript +import { Groups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Groups = { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 146441, + displayName: "Mariano70", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Francisco Windler", + grantTrustLevel: "", + hasMessages: false, + id: 756107, + incomingEmail: "", + membersVisibilityLevel: 576157, + membershipRequestTemplate: "", + mentionableLevel: 396098, + messageableLevel: 592042, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 896039, + visibilityLevel: 572252, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/groupusers.md b/docs/sdk/models/operations/groupusers.md index 7e08670..5f004eb 100644 --- a/docs/sdk/models/operations/groupusers.md +++ b/docs/sdk/models/operations/groupusers.md @@ -1,5 +1,16 @@ # GroupUsers +## Example Usage + +```typescript +import { GroupUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: GroupUsers = { + groupId: 20651, + notificationLevel: 229219, + userId: 758379, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/hashtagconfigurations.md b/docs/sdk/models/operations/hashtagconfigurations.md index 4872fb2..ae71e56 100644 --- a/docs/sdk/models/operations/hashtagconfigurations.md +++ b/docs/sdk/models/operations/hashtagconfigurations.md @@ -1,5 +1,12 @@ # HashtagConfigurations +## Example Usage + +```typescript +import { HashtagConfigurations } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: HashtagConfigurations = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/hashtagicons.md b/docs/sdk/models/operations/hashtagicons.md index ecc3727..a02b06b 100644 --- a/docs/sdk/models/operations/hashtagicons.md +++ b/docs/sdk/models/operations/hashtagicons.md @@ -1,5 +1,12 @@ # HashtagIcons +## Example Usage + +```typescript +import { HashtagIcons } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: HashtagIcons = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/imapupdatedby.md b/docs/sdk/models/operations/imapupdatedby.md index e40d523..69a57e9 100644 --- a/docs/sdk/models/operations/imapupdatedby.md +++ b/docs/sdk/models/operations/imapupdatedby.md @@ -1,5 +1,12 @@ # ImapUpdatedBy +## Example Usage + +```typescript +import { ImapUpdatedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ImapUpdatedBy = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/invitetotopicrequest.md b/docs/sdk/models/operations/invitetotopicrequest.md index a4240cb..58d1a66 100644 --- a/docs/sdk/models/operations/invitetotopicrequest.md +++ b/docs/sdk/models/operations/invitetotopicrequest.md @@ -1,5 +1,16 @@ # InviteToTopicRequest +## Example Usage + +```typescript +import { InviteToTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: InviteToTopicRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/invitetotopicrequestbody.md b/docs/sdk/models/operations/invitetotopicrequestbody.md index 4605fc1..0cb8b84 100644 --- a/docs/sdk/models/operations/invitetotopicrequestbody.md +++ b/docs/sdk/models/operations/invitetotopicrequestbody.md @@ -1,5 +1,12 @@ # InviteToTopicRequestBody +## Example Usage + +```typescript +import { InviteToTopicRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: InviteToTopicRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/invitetotopicresponsebody.md b/docs/sdk/models/operations/invitetotopicresponsebody.md index c75cddc..cc66865 100644 --- a/docs/sdk/models/operations/invitetotopicresponsebody.md +++ b/docs/sdk/models/operations/invitetotopicresponsebody.md @@ -2,6 +2,13 @@ topic updated +## Example Usage + +```typescript +import { InviteToTopicResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: InviteToTopicResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/invitetotopicuser.md b/docs/sdk/models/operations/invitetotopicuser.md index 76bf24f..0023cb0 100644 --- a/docs/sdk/models/operations/invitetotopicuser.md +++ b/docs/sdk/models/operations/invitetotopicuser.md @@ -1,5 +1,12 @@ # InviteToTopicUser +## Example Usage + +```typescript +import { InviteToTopicUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: InviteToTopicUser = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/lastposter.md b/docs/sdk/models/operations/lastposter.md index 5b72dba..731cfea 100644 --- a/docs/sdk/models/operations/lastposter.md +++ b/docs/sdk/models/operations/lastposter.md @@ -1,5 +1,17 @@ # LastPoster +## Example Usage + +```typescript +import { LastPoster } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LastPoster = { + avatarTemplate: "", + id: 987349, + name: "", + username: "Terrence.Rowe", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/latestposts.md b/docs/sdk/models/operations/latestposts.md index 6ec68ef..47c6f40 100644 --- a/docs/sdk/models/operations/latestposts.md +++ b/docs/sdk/models/operations/latestposts.md @@ -1,5 +1,12 @@ # LatestPosts +## Example Usage + +```typescript +import { LatestPosts } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LatestPosts = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/linkcounts.md b/docs/sdk/models/operations/linkcounts.md index 70300a2..64eaeae 100644 --- a/docs/sdk/models/operations/linkcounts.md +++ b/docs/sdk/models/operations/linkcounts.md @@ -1,5 +1,18 @@ # LinkCounts +## Example Usage + +```typescript +import { LinkCounts } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LinkCounts = { + clicks: 46806, + internal: false, + reflection: false, + title: "", + url: "https://wild-retrospectivity.com", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listcategoriesrequest.md b/docs/sdk/models/operations/listcategoriesrequest.md index 5d76299..a3429de 100644 --- a/docs/sdk/models/operations/listcategoriesrequest.md +++ b/docs/sdk/models/operations/listcategoriesrequest.md @@ -1,5 +1,12 @@ # ListCategoriesRequest +## Example Usage + +```typescript +import { ListCategoriesRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListCategoriesRequest = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listcategoriesresponsebody.md b/docs/sdk/models/operations/listcategoriesresponsebody.md index bcfc25c..c93739d 100644 --- a/docs/sdk/models/operations/listcategoriesresponsebody.md +++ b/docs/sdk/models/operations/listcategoriesresponsebody.md @@ -2,6 +2,60 @@ success response +## Example Usage + +```typescript +import { ListCategoriesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListCategoriesResponseBody = { + categoryList: { + canCreateCategory: false, + canCreateTopic: false, + categories: [ + { + canEdit: false, + color: "maroon", + defaultListFilter: "", + defaultTopPeriod: "", + defaultView: "", + description: "Enterprise-wide foreground application", + descriptionExcerpt: "", + descriptionText: "", + hasChildren: false, + id: 671384, + minimumRequiredTags: 123844, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 344718, + numFeaturedTopics: 856756, + permission: 713767, + position: 399667, + postCount: 639187, + readRestricted: false, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryIds: [""], + subcategoryListStyle: "", + textColor: "", + topicCount: 381397, + topicTemplate: "", + topicUrl: "", + topicsAllTime: 399161, + topicsDay: 21973, + topicsMonth: 431760, + topicsWeek: 374753, + topicsYear: 614528, + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, + ], + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listcategorytopicsposters.md b/docs/sdk/models/operations/listcategorytopicsposters.md index 494c506..c2297ff 100644 --- a/docs/sdk/models/operations/listcategorytopicsposters.md +++ b/docs/sdk/models/operations/listcategorytopicsposters.md @@ -1,5 +1,17 @@ # ListCategoryTopicsPosters +## Example Usage + +```typescript +import { ListCategoryTopicsPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListCategoryTopicsPosters = { + description: "Centralized modular secured line", + extras: "", + primaryGroupId: "", + userId: 913992, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listcategorytopicsrequest.md b/docs/sdk/models/operations/listcategorytopicsrequest.md index 7735695..d693294 100644 --- a/docs/sdk/models/operations/listcategorytopicsrequest.md +++ b/docs/sdk/models/operations/listcategorytopicsrequest.md @@ -1,5 +1,15 @@ # ListCategoryTopicsRequest +## Example Usage + +```typescript +import { ListCategoryTopicsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListCategoryTopicsRequest = { + id: 661607, + slug: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listcategorytopicsresponsebody.md b/docs/sdk/models/operations/listcategorytopicsresponsebody.md index 7df6564..e108abf 100644 --- a/docs/sdk/models/operations/listcategorytopicsresponsebody.md +++ b/docs/sdk/models/operations/listcategorytopicsresponsebody.md @@ -2,6 +2,59 @@ success response +## Example Usage + +```typescript +import { ListCategoryTopicsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListCategoryTopicsResponseBody = { + topicList: { + canCreateTopic: false, + perPage: 682119, + topics: [ + { + archetype: "", + archived: false, + bookmarked: "", + bumped: false, + bumpedAt: "", + categoryId: 867168, + closed: false, + createdAt: "", + excerpt: "", + fancyTitle: "", + featuredLink: "", + hasSummary: false, + highestPostNumber: 891315, + id: 29190, + imageUrl: "", + lastPostedAt: "", + lastPosterUsername: "", + likeCount: 1207, + liked: "", + pinned: false, + pinnedGlobally: false, + posters: [ + { + description: "Operative user-facing groupware", + extras: "", + primaryGroupId: "", + userId: 958308, + }, + ], + postsCount: 524184, + replyCount: 796320, + slug: "", + title: "", + unpinned: "", + unseen: false, + views: 365100, + visible: false, + }, + ], + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listgroupmembersrequest.md b/docs/sdk/models/operations/listgroupmembersrequest.md index 9ff1a6b..8e00d2d 100644 --- a/docs/sdk/models/operations/listgroupmembersrequest.md +++ b/docs/sdk/models/operations/listgroupmembersrequest.md @@ -1,5 +1,14 @@ # ListGroupMembersRequest +## Example Usage + +```typescript +import { ListGroupMembersRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListGroupMembersRequest = { + id: "name", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listgroupmembersresponsebody.md b/docs/sdk/models/operations/listgroupmembersresponsebody.md index 2702848..4d1167c 100644 --- a/docs/sdk/models/operations/listgroupmembersresponsebody.md +++ b/docs/sdk/models/operations/listgroupmembersresponsebody.md @@ -2,6 +2,45 @@ success response +## Example Usage + +```typescript +import { ListGroupMembersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListGroupMembersResponseBody = { + members: [ + { + addedAt: "", + avatarTemplate: "", + id: 842342, + lastPostedAt: "", + lastSeenAt: "", + name: "", + timezone: "America/Indiana/Indianapolis", + title: "", + username: "Luther.Rau26", + }, + ], + meta: { + limit: 183191, + offset: 397821, + total: 586513, + }, + owners: [ + { + addedAt: "", + avatarTemplate: "", + id: 552822, + lastPostedAt: "", + lastSeenAt: "", + name: "", + timezone: "Pacific/Honolulu", + title: "", + username: "Casimir.Simonis", + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listgroupsextras.md b/docs/sdk/models/operations/listgroupsextras.md index ba7e988..db1ff6d 100644 --- a/docs/sdk/models/operations/listgroupsextras.md +++ b/docs/sdk/models/operations/listgroupsextras.md @@ -1,5 +1,14 @@ # ListGroupsExtras +## Example Usage + +```typescript +import { ListGroupsExtras } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListGroupsExtras = { + typeFilters: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listgroupsresponsebody.md b/docs/sdk/models/operations/listgroupsresponsebody.md index ae5af94..a84331f 100644 --- a/docs/sdk/models/operations/listgroupsresponsebody.md +++ b/docs/sdk/models/operations/listgroupsresponsebody.md @@ -2,6 +2,52 @@ response +## Example Usage + +```typescript +import { ListGroupsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListGroupsResponseBody = { + extras: { + typeFilters: [""], + }, + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 638921, + displayName: "Damien_Toy44", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Angel Wolff II", + grantTrustLevel: "", + hasMessages: false, + id: 767024, + incomingEmail: "", + membersVisibilityLevel: 813798, + membershipRequestTemplate: "", + mentionableLevel: 411820, + messageableLevel: 396506, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 675439, + visibilityLevel: 881104, + }, + ], + loadMoreGroups: "", + totalRowsGroups: 249796, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicsposters.md b/docs/sdk/models/operations/listlatesttopicsposters.md index 6918e89..e47ba53 100644 --- a/docs/sdk/models/operations/listlatesttopicsposters.md +++ b/docs/sdk/models/operations/listlatesttopicsposters.md @@ -1,5 +1,12 @@ # ListLatestTopicsPosters +## Example Usage + +```typescript +import { ListLatestTopicsPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsPosters = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicsrequest.md b/docs/sdk/models/operations/listlatesttopicsrequest.md index 47b0577..0fe2240 100644 --- a/docs/sdk/models/operations/listlatesttopicsrequest.md +++ b/docs/sdk/models/operations/listlatesttopicsrequest.md @@ -1,5 +1,15 @@ # ListLatestTopicsRequest +## Example Usage + +```typescript +import { ListLatestTopicsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsRequest = { + apiKey: "", + apiUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicsresponsebody.md b/docs/sdk/models/operations/listlatesttopicsresponsebody.md index a7cb735..776abd7 100644 --- a/docs/sdk/models/operations/listlatesttopicsresponsebody.md +++ b/docs/sdk/models/operations/listlatesttopicsresponsebody.md @@ -2,6 +2,13 @@ topic updated +## Example Usage + +```typescript +import { ListLatestTopicsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicstopiclist.md b/docs/sdk/models/operations/listlatesttopicstopiclist.md index 0983394..81e4c6b 100644 --- a/docs/sdk/models/operations/listlatesttopicstopiclist.md +++ b/docs/sdk/models/operations/listlatesttopicstopiclist.md @@ -1,5 +1,12 @@ # ListLatestTopicsTopicList +## Example Usage + +```typescript +import { ListLatestTopicsTopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsTopicList = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicstopics.md b/docs/sdk/models/operations/listlatesttopicstopics.md index 6b43985..da40344 100644 --- a/docs/sdk/models/operations/listlatesttopicstopics.md +++ b/docs/sdk/models/operations/listlatesttopicstopics.md @@ -1,5 +1,12 @@ # ListLatestTopicsTopics +## Example Usage + +```typescript +import { ListLatestTopicsTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsTopics = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listlatesttopicsusers.md b/docs/sdk/models/operations/listlatesttopicsusers.md index 62750fc..09f1a2b 100644 --- a/docs/sdk/models/operations/listlatesttopicsusers.md +++ b/docs/sdk/models/operations/listlatesttopicsusers.md @@ -1,5 +1,12 @@ # ListLatestTopicsUsers +## Example Usage + +```typescript +import { ListLatestTopicsUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListLatestTopicsUsers = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listpostsactionssummary.md b/docs/sdk/models/operations/listpostsactionssummary.md index 2ed2ad9..81610b3 100644 --- a/docs/sdk/models/operations/listpostsactionssummary.md +++ b/docs/sdk/models/operations/listpostsactionssummary.md @@ -1,5 +1,12 @@ # ListPostsActionsSummary +## Example Usage + +```typescript +import { ListPostsActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListPostsActionsSummary = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listpostsrequest.md b/docs/sdk/models/operations/listpostsrequest.md index 26b1589..d23a345 100644 --- a/docs/sdk/models/operations/listpostsrequest.md +++ b/docs/sdk/models/operations/listpostsrequest.md @@ -1,5 +1,15 @@ # ListPostsRequest +## Example Usage + +```typescript +import { ListPostsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListPostsRequest = { + apiKey: "", + apiUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listpostsresponsebody.md b/docs/sdk/models/operations/listpostsresponsebody.md index 4d50dd8..306391e 100644 --- a/docs/sdk/models/operations/listpostsresponsebody.md +++ b/docs/sdk/models/operations/listpostsresponsebody.md @@ -2,6 +2,13 @@ latest posts +## Example Usage + +```typescript +import { ListPostsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListPostsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtaggroupspermissions.md b/docs/sdk/models/operations/listtaggroupspermissions.md index e05195b..d3ede6b 100644 --- a/docs/sdk/models/operations/listtaggroupspermissions.md +++ b/docs/sdk/models/operations/listtaggroupspermissions.md @@ -1,5 +1,12 @@ # ListTagGroupsPermissions +## Example Usage + +```typescript +import { ListTagGroupsPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTagGroupsPermissions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtaggroupsresponsebody.md b/docs/sdk/models/operations/listtaggroupsresponsebody.md index 8ceaef5..635e85e 100644 --- a/docs/sdk/models/operations/listtaggroupsresponsebody.md +++ b/docs/sdk/models/operations/listtaggroupsresponsebody.md @@ -2,6 +2,13 @@ tags +## Example Usage + +```typescript +import { ListTagGroupsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTagGroupsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtagsextras.md b/docs/sdk/models/operations/listtagsextras.md index cba49c8..d4904ff 100644 --- a/docs/sdk/models/operations/listtagsextras.md +++ b/docs/sdk/models/operations/listtagsextras.md @@ -1,5 +1,12 @@ # ListTagsExtras +## Example Usage + +```typescript +import { ListTagsExtras } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTagsExtras = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtagsresponsebody.md b/docs/sdk/models/operations/listtagsresponsebody.md index 604bb71..0b547ff 100644 --- a/docs/sdk/models/operations/listtagsresponsebody.md +++ b/docs/sdk/models/operations/listtagsresponsebody.md @@ -2,6 +2,13 @@ notifications +## Example Usage + +```typescript +import { ListTagsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTagsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicsposters.md b/docs/sdk/models/operations/listtoptopicsposters.md index c335b48..2425247 100644 --- a/docs/sdk/models/operations/listtoptopicsposters.md +++ b/docs/sdk/models/operations/listtoptopicsposters.md @@ -1,5 +1,12 @@ # ListTopTopicsPosters +## Example Usage + +```typescript +import { ListTopTopicsPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsPosters = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicsrequest.md b/docs/sdk/models/operations/listtoptopicsrequest.md index ce4f5a1..15d1f4b 100644 --- a/docs/sdk/models/operations/listtoptopicsrequest.md +++ b/docs/sdk/models/operations/listtoptopicsrequest.md @@ -1,5 +1,15 @@ # ListTopTopicsRequest +## Example Usage + +```typescript +import { ListTopTopicsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsRequest = { + apiKey: "", + apiUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicsresponsebody.md b/docs/sdk/models/operations/listtoptopicsresponsebody.md index 92cc705..7277fe9 100644 --- a/docs/sdk/models/operations/listtoptopicsresponsebody.md +++ b/docs/sdk/models/operations/listtoptopicsresponsebody.md @@ -2,6 +2,13 @@ response +## Example Usage + +```typescript +import { ListTopTopicsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicstopiclist.md b/docs/sdk/models/operations/listtoptopicstopiclist.md index 78c484b..b130b11 100644 --- a/docs/sdk/models/operations/listtoptopicstopiclist.md +++ b/docs/sdk/models/operations/listtoptopicstopiclist.md @@ -1,5 +1,12 @@ # ListTopTopicsTopicList +## Example Usage + +```typescript +import { ListTopTopicsTopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsTopicList = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicstopics.md b/docs/sdk/models/operations/listtoptopicstopics.md index 940b5f4..9b00dfe 100644 --- a/docs/sdk/models/operations/listtoptopicstopics.md +++ b/docs/sdk/models/operations/listtoptopicstopics.md @@ -1,5 +1,12 @@ # ListTopTopicsTopics +## Example Usage + +```typescript +import { ListTopTopicsTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsTopics = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listtoptopicsusers.md b/docs/sdk/models/operations/listtoptopicsusers.md index b90c4f7..b109425 100644 --- a/docs/sdk/models/operations/listtoptopicsusers.md +++ b/docs/sdk/models/operations/listtoptopicsusers.md @@ -1,5 +1,12 @@ # ListTopTopicsUsers +## Example Usage + +```typescript +import { ListTopTopicsUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListTopTopicsUsers = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuseractionsrequest.md b/docs/sdk/models/operations/listuseractionsrequest.md index 8fe74d5..0949a78 100644 --- a/docs/sdk/models/operations/listuseractionsrequest.md +++ b/docs/sdk/models/operations/listuseractionsrequest.md @@ -1,5 +1,16 @@ # ListUserActionsRequest +## Example Usage + +```typescript +import { ListUserActionsRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserActionsRequest = { + filter: "", + offset: 148829, + username: "Viviane_Cole45", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuseractionsresponsebody.md b/docs/sdk/models/operations/listuseractionsresponsebody.md index 4ca4c7b..003e2f5 100644 --- a/docs/sdk/models/operations/listuseractionsresponsebody.md +++ b/docs/sdk/models/operations/listuseractionsresponsebody.md @@ -2,6 +2,44 @@ response +## Example Usage + +```typescript +import { ListUserActionsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserActionsResponseBody = { + userActions: [ + { + actingAvatarTemplate: "", + actingName: "", + actingUserId: 604118, + actingUsername: "", + actionCode: "", + actionType: 100032, + archived: false, + avatarTemplate: "", + categoryId: 382808, + closed: false, + createdAt: "", + deleted: false, + excerpt: "", + hidden: "", + name: "", + postId: "", + postNumber: 960257, + postType: "", + slug: "", + targetName: "", + targetUserId: 895386, + targetUsername: "", + title: "", + topicId: 72434, + userId: 967795, + username: "Aileen.Lockman14", + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserbadgesbadges.md b/docs/sdk/models/operations/listuserbadgesbadges.md index 8a783df..beef5d9 100644 --- a/docs/sdk/models/operations/listuserbadgesbadges.md +++ b/docs/sdk/models/operations/listuserbadgesbadges.md @@ -1,5 +1,28 @@ # ListUserBadgesBadges +## Example Usage + +```typescript +import { ListUserBadgesBadges } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserBadgesBadges = { + allowTitle: false, + badgeGroupingId: 612096, + badgeTypeId: 222321, + description: "Polarised fault-tolerant throughput", + enabled: false, + grantCount: 902599, + icon: "", + id: 681820, + imageUrl: "", + listable: false, + manuallyGrantable: false, + multipleGrant: false, + name: "", + slug: "", + system: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserbadgesbadgetypes.md b/docs/sdk/models/operations/listuserbadgesbadgetypes.md index b20cb32..a872450 100644 --- a/docs/sdk/models/operations/listuserbadgesbadgetypes.md +++ b/docs/sdk/models/operations/listuserbadgesbadgetypes.md @@ -1,5 +1,16 @@ # ListUserBadgesBadgeTypes +## Example Usage + +```typescript +import { ListUserBadgesBadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserBadgesBadgeTypes = { + id: 617636, + name: "", + sortOrder: 149675, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserbadgesrequest.md b/docs/sdk/models/operations/listuserbadgesrequest.md index 8fdb406..065a835 100644 --- a/docs/sdk/models/operations/listuserbadgesrequest.md +++ b/docs/sdk/models/operations/listuserbadgesrequest.md @@ -1,5 +1,14 @@ # ListUserBadgesRequest +## Example Usage + +```typescript +import { ListUserBadgesRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserBadgesRequest = { + username: "Keshaun32", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserbadgesresponsebody.md b/docs/sdk/models/operations/listuserbadgesresponsebody.md index 2b2f590..4043b42 100644 --- a/docs/sdk/models/operations/listuserbadgesresponsebody.md +++ b/docs/sdk/models/operations/listuserbadgesresponsebody.md @@ -2,6 +2,25 @@ success response +## Example Usage + +```typescript +import { ListUserBadgesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserBadgesResponseBody = { + userBadges: [ + { + badgeId: 670638, + canFavorite: false, + grantedAt: "", + grantedById: 170909, + groupingPosition: 210382, + id: 358152, + isFavorite: "", + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagesparticipants.md b/docs/sdk/models/operations/listuserprivatemessagesparticipants.md index c93a7f0..1d3d9b4 100644 --- a/docs/sdk/models/operations/listuserprivatemessagesparticipants.md +++ b/docs/sdk/models/operations/listuserprivatemessagesparticipants.md @@ -1,5 +1,12 @@ # ListUserPrivateMessagesParticipants +## Example Usage + +```typescript +import { ListUserPrivateMessagesParticipants } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesParticipants = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagesposters.md b/docs/sdk/models/operations/listuserprivatemessagesposters.md index 2889900..d6c93ad 100644 --- a/docs/sdk/models/operations/listuserprivatemessagesposters.md +++ b/docs/sdk/models/operations/listuserprivatemessagesposters.md @@ -1,5 +1,12 @@ # ListUserPrivateMessagesPosters +## Example Usage + +```typescript +import { ListUserPrivateMessagesPosters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesPosters = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagesrequest.md b/docs/sdk/models/operations/listuserprivatemessagesrequest.md index 8d961ab..66db506 100644 --- a/docs/sdk/models/operations/listuserprivatemessagesrequest.md +++ b/docs/sdk/models/operations/listuserprivatemessagesrequest.md @@ -1,5 +1,14 @@ # ListUserPrivateMessagesRequest +## Example Usage + +```typescript +import { ListUserPrivateMessagesRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesRequest = { + username: "Isac.Schinner", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagesresponsebody.md b/docs/sdk/models/operations/listuserprivatemessagesresponsebody.md index 23c94df..b92af79 100644 --- a/docs/sdk/models/operations/listuserprivatemessagesresponsebody.md +++ b/docs/sdk/models/operations/listuserprivatemessagesresponsebody.md @@ -2,6 +2,13 @@ private messages +## Example Usage + +```typescript +import { ListUserPrivateMessagesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagestopiclist.md b/docs/sdk/models/operations/listuserprivatemessagestopiclist.md index eb6fdb7..68efb8f 100644 --- a/docs/sdk/models/operations/listuserprivatemessagestopiclist.md +++ b/docs/sdk/models/operations/listuserprivatemessagestopiclist.md @@ -1,5 +1,12 @@ # ListUserPrivateMessagesTopicList +## Example Usage + +```typescript +import { ListUserPrivateMessagesTopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesTopicList = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagestopics.md b/docs/sdk/models/operations/listuserprivatemessagestopics.md index 062ce7f..9f11e7d 100644 --- a/docs/sdk/models/operations/listuserprivatemessagestopics.md +++ b/docs/sdk/models/operations/listuserprivatemessagestopics.md @@ -1,5 +1,12 @@ # ListUserPrivateMessagesTopics +## Example Usage + +```typescript +import { ListUserPrivateMessagesTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesTopics = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserprivatemessagesusers.md b/docs/sdk/models/operations/listuserprivatemessagesusers.md index 9fd8aad..421bd5f 100644 --- a/docs/sdk/models/operations/listuserprivatemessagesusers.md +++ b/docs/sdk/models/operations/listuserprivatemessagesusers.md @@ -1,5 +1,12 @@ # ListUserPrivateMessagesUsers +## Example Usage + +```typescript +import { ListUserPrivateMessagesUsers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUserPrivateMessagesUsers = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserspublicmeta.md b/docs/sdk/models/operations/listuserspublicmeta.md index 994c3b8..25e52b0 100644 --- a/docs/sdk/models/operations/listuserspublicmeta.md +++ b/docs/sdk/models/operations/listuserspublicmeta.md @@ -1,5 +1,16 @@ # ListUsersPublicMeta +## Example Usage + +```typescript +import { ListUsersPublicMeta } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUsersPublicMeta = { + lastUpdatedAt: "", + loadMoreDirectoryItems: "", + totalRowsDirectoryItems: 750595, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserspublicrequest.md b/docs/sdk/models/operations/listuserspublicrequest.md index 3871a5f..ba1ca6a 100644 --- a/docs/sdk/models/operations/listuserspublicrequest.md +++ b/docs/sdk/models/operations/listuserspublicrequest.md @@ -1,5 +1,15 @@ # ListUsersPublicRequest +## Example Usage + +```typescript +import { ListUsersPublicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUsersPublicRequest = { + order: "days_visited", + period: "weekly", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserspublicresponsebody.md b/docs/sdk/models/operations/listuserspublicresponsebody.md index c328c6b..4020c94 100644 --- a/docs/sdk/models/operations/listuserspublicresponsebody.md +++ b/docs/sdk/models/operations/listuserspublicresponsebody.md @@ -2,6 +2,38 @@ directory items response +## Example Usage + +```typescript +import { ListUsersPublicResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUsersPublicResponseBody = { + directoryItems: [ + { + daysVisited: 625637, + id: 333507, + likesGiven: 329543, + likesReceived: 924159, + postCount: 967122, + postsRead: 862319, + topicCount: 168576, + topicsEntered: 48690, + user: { + avatarTemplate: "", + id: 901483, + name: "", + title: "", + username: "Deondre_Harris", + }, + }, + ], + meta: { + lastUpdatedAt: "", + loadMoreDirectoryItems: "", + totalRowsDirectoryItems: 104627, + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/listuserspublicuser.md b/docs/sdk/models/operations/listuserspublicuser.md index 37dda7f..b8722b0 100644 --- a/docs/sdk/models/operations/listuserspublicuser.md +++ b/docs/sdk/models/operations/listuserspublicuser.md @@ -1,5 +1,18 @@ # ListUsersPublicUser +## Example Usage + +```typescript +import { ListUsersPublicUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ListUsersPublicUser = { + avatarTemplate: "", + id: 406733, + name: "", + title: "", + username: "Kory.Lueilwitz27", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/lockpostrequest.md b/docs/sdk/models/operations/lockpostrequest.md index d278992..a653f50 100644 --- a/docs/sdk/models/operations/lockpostrequest.md +++ b/docs/sdk/models/operations/lockpostrequest.md @@ -1,5 +1,16 @@ # LockPostRequest +## Example Usage + +```typescript +import { LockPostRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LockPostRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/lockpostrequestbody.md b/docs/sdk/models/operations/lockpostrequestbody.md index 3e85779..7bb9eb3 100644 --- a/docs/sdk/models/operations/lockpostrequestbody.md +++ b/docs/sdk/models/operations/lockpostrequestbody.md @@ -1,5 +1,14 @@ # LockPostRequestBody +## Example Usage + +```typescript +import { LockPostRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LockPostRequestBody = { + locked: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/lockpostresponsebody.md b/docs/sdk/models/operations/lockpostresponsebody.md index 21c7595..0066b13 100644 --- a/docs/sdk/models/operations/lockpostresponsebody.md +++ b/docs/sdk/models/operations/lockpostresponsebody.md @@ -2,6 +2,13 @@ post updated +## Example Usage + +```typescript +import { LockPostResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LockPostResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/logoutuserrequest.md b/docs/sdk/models/operations/logoutuserrequest.md index d825e9d..5d3b8c9 100644 --- a/docs/sdk/models/operations/logoutuserrequest.md +++ b/docs/sdk/models/operations/logoutuserrequest.md @@ -1,5 +1,14 @@ # LogOutUserRequest +## Example Usage + +```typescript +import { LogOutUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LogOutUserRequest = { + id: 512452, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/logoutuserresponsebody.md b/docs/sdk/models/operations/logoutuserresponsebody.md index 77da1ee..67db142 100644 --- a/docs/sdk/models/operations/logoutuserresponsebody.md +++ b/docs/sdk/models/operations/logoutuserresponsebody.md @@ -2,6 +2,15 @@ response +## Example Usage + +```typescript +import { LogOutUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: LogOutUserResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/markdownadditionaloptions.md b/docs/sdk/models/operations/markdownadditionaloptions.md index fd2703c..17c7e87 100644 --- a/docs/sdk/models/operations/markdownadditionaloptions.md +++ b/docs/sdk/models/operations/markdownadditionaloptions.md @@ -1,5 +1,12 @@ # MarkdownAdditionalOptions +## Example Usage + +```typescript +import { MarkdownAdditionalOptions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: MarkdownAdditionalOptions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/marknotificationsasreadrequestbody.md b/docs/sdk/models/operations/marknotificationsasreadrequestbody.md index fa69e3c..2e0a310 100644 --- a/docs/sdk/models/operations/marknotificationsasreadrequestbody.md +++ b/docs/sdk/models/operations/marknotificationsasreadrequestbody.md @@ -1,5 +1,12 @@ # MarkNotificationsAsReadRequestBody +## Example Usage + +```typescript +import { MarkNotificationsAsReadRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: MarkNotificationsAsReadRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/marknotificationsasreadresponsebody.md b/docs/sdk/models/operations/marknotificationsasreadresponsebody.md index 5989782..6f0400d 100644 --- a/docs/sdk/models/operations/marknotificationsasreadresponsebody.md +++ b/docs/sdk/models/operations/marknotificationsasreadresponsebody.md @@ -2,6 +2,13 @@ notifications marked read +## Example Usage + +```typescript +import { MarkNotificationsAsReadResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: MarkNotificationsAsReadResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/members.md b/docs/sdk/models/operations/members.md index 848da83..bcfc0da 100644 --- a/docs/sdk/models/operations/members.md +++ b/docs/sdk/models/operations/members.md @@ -1,5 +1,22 @@ # Members +## Example Usage + +```typescript +import { Members } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Members = { + addedAt: "", + avatarTemplate: "", + id: 566602, + lastPostedAt: "", + lastSeenAt: "", + name: "", + timezone: "Australia/Adelaide", + title: "", + username: "Dimitri_Lang", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/meta.md b/docs/sdk/models/operations/meta.md index 6168a03..3cd6699 100644 --- a/docs/sdk/models/operations/meta.md +++ b/docs/sdk/models/operations/meta.md @@ -1,5 +1,16 @@ # Meta +## Example Usage + +```typescript +import { Meta } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Meta = { + limit: 93940, + offset: 921158, + total: 575947, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/metadata.md b/docs/sdk/models/operations/metadata.md index 2994f55..9bddeb3 100644 --- a/docs/sdk/models/operations/metadata.md +++ b/docs/sdk/models/operations/metadata.md @@ -1,5 +1,12 @@ # Metadata +## Example Usage + +```typescript +import { Metadata } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Metadata = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/notice.md b/docs/sdk/models/operations/notice.md index 34911fd..da25bbd 100644 --- a/docs/sdk/models/operations/notice.md +++ b/docs/sdk/models/operations/notice.md @@ -1,5 +1,12 @@ # Notice +## Example Usage + +```typescript +import { Notice } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Notice = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/notificationlevel.md b/docs/sdk/models/operations/notificationlevel.md index 40f85a9..be9e9b1 100644 --- a/docs/sdk/models/operations/notificationlevel.md +++ b/docs/sdk/models/operations/notificationlevel.md @@ -1,11 +1,15 @@ # NotificationLevel +## Example Usage + +```typescript +import { NotificationLevel } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: NotificationLevel = "2"; +``` ## Values -| Name | Value | -| ------- | ------- | -| `Zero` | 0 | -| `One` | 1 | -| `Two` | 2 | -| `Three` | 3 | \ No newline at end of file +```typescript +"0" | "1" | "2" | "3" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/notifications.md b/docs/sdk/models/operations/notifications.md index 646c1ec..6113190 100644 --- a/docs/sdk/models/operations/notifications.md +++ b/docs/sdk/models/operations/notifications.md @@ -1,5 +1,12 @@ # Notifications +## Example Usage + +```typescript +import { Notifications } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Notifications = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/notificationtypes.md b/docs/sdk/models/operations/notificationtypes.md index 8287c59..824988b 100644 --- a/docs/sdk/models/operations/notificationtypes.md +++ b/docs/sdk/models/operations/notificationtypes.md @@ -1,5 +1,46 @@ # NotificationTypes +## Example Usage + +```typescript +import { NotificationTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: NotificationTypes = { + bookmarkReminder: 910994, + chatGroupMention: 247399, + chatInvitation: 878493, + chatMention: 39615, + chatMessage: 434156, + codeReviewCommitApproved: 59944, + custom: 517612, + edited: 61078, + eventInvitation: 474668, + eventReminder: 907733, + grantedBadge: 184362, + groupMentioned: 739884, + groupMessageSummary: 434761, + invitedToPrivateMessage: 898063, + invitedToTopic: 187552, + inviteeAccepted: 672582, + liked: 715208, + likedConsolidated: 528940, + linked: 523006, + membershipRequestAccepted: 304446, + membershipRequestConsolidated: 320565, + mentioned: 997963, + movedPost: 3099, + postApproved: 362189, + posted: 597303, + privateMessage: 470649, + quoted: 649078, + reaction: 378245, + replied: 5189, + topicReminder: 979527, + votesReleased: 970222, + watchingCategoryOrTag: 174658, + watchingFirstPost: 663866, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/order.md b/docs/sdk/models/operations/order.md index 377141a..cbefb77 100644 --- a/docs/sdk/models/operations/order.md +++ b/docs/sdk/models/operations/order.md @@ -1,14 +1,15 @@ # Order +## Example Usage + +```typescript +import { Order } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Order = "topics_entered"; +``` ## Values -| Name | Value | -| --------------- | --------------- | -| `LikesReceived` | likes_received | -| `LikesGiven` | likes_given | -| `TopicCount` | topic_count | -| `PostCount` | post_count | -| `TopicsEntered` | topics_entered | -| `PostsRead` | posts_read | -| `DaysVisited` | days_visited | \ No newline at end of file +```typescript +"likes_received" | "likes_given" | "topic_count" | "post_count" | "topics_entered" | "posts_read" | "days_visited" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/owners.md b/docs/sdk/models/operations/owners.md index d10c064..4d859b7 100644 --- a/docs/sdk/models/operations/owners.md +++ b/docs/sdk/models/operations/owners.md @@ -1,5 +1,22 @@ # Owners +## Example Usage + +```typescript +import { Owners } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Owners = { + addedAt: "", + avatarTemplate: "", + id: 83112, + lastPostedAt: "", + lastSeenAt: "", + name: "", + timezone: "Asia/Magadan", + title: "", + username: "Drew66", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/participants.md b/docs/sdk/models/operations/participants.md index 078c62f..de2f03c 100644 --- a/docs/sdk/models/operations/participants.md +++ b/docs/sdk/models/operations/participants.md @@ -1,5 +1,26 @@ # Participants +## Example Usage + +```typescript +import { Participants } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Participants = { + admin: false, + avatarTemplate: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + id: 455898, + moderator: false, + name: "", + postCount: 501063, + primaryGroupName: "", + trustLevel: 642352, + username: "Garry_Funk", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/penaltycounts.md b/docs/sdk/models/operations/penaltycounts.md index db354e9..7457ecc 100644 --- a/docs/sdk/models/operations/penaltycounts.md +++ b/docs/sdk/models/operations/penaltycounts.md @@ -1,5 +1,15 @@ # PenaltyCounts +## Example Usage + +```typescript +import { PenaltyCounts } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PenaltyCounts = { + silenced: 618016, + suspended: 749170, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/performpostactionactionssummary.md b/docs/sdk/models/operations/performpostactionactionssummary.md index 2f0d89c..f5e37f8 100644 --- a/docs/sdk/models/operations/performpostactionactionssummary.md +++ b/docs/sdk/models/operations/performpostactionactionssummary.md @@ -1,5 +1,12 @@ # PerformPostActionActionsSummary +## Example Usage + +```typescript +import { PerformPostActionActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PerformPostActionActionsSummary = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/performpostactionrequest.md b/docs/sdk/models/operations/performpostactionrequest.md index 1a3cd4a..6e6d2f1 100644 --- a/docs/sdk/models/operations/performpostactionrequest.md +++ b/docs/sdk/models/operations/performpostactionrequest.md @@ -1,5 +1,15 @@ # PerformPostActionRequest +## Example Usage + +```typescript +import { PerformPostActionRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PerformPostActionRequest = { + apiKey: "", + apiUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/performpostactionrequestbody.md b/docs/sdk/models/operations/performpostactionrequestbody.md index b148f14..b351b9d 100644 --- a/docs/sdk/models/operations/performpostactionrequestbody.md +++ b/docs/sdk/models/operations/performpostactionrequestbody.md @@ -1,5 +1,15 @@ # PerformPostActionRequestBody +## Example Usage + +```typescript +import { PerformPostActionRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PerformPostActionRequestBody = { + id: 811939, + postActionTypeId: 25756, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/performpostactionresponsebody.md b/docs/sdk/models/operations/performpostactionresponsebody.md index a906861..a3931f4 100644 --- a/docs/sdk/models/operations/performpostactionresponsebody.md +++ b/docs/sdk/models/operations/performpostactionresponsebody.md @@ -2,6 +2,13 @@ post updated +## Example Usage + +```typescript +import { PerformPostActionResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PerformPostActionResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/period.md b/docs/sdk/models/operations/period.md index ada8c33..41732a2 100644 --- a/docs/sdk/models/operations/period.md +++ b/docs/sdk/models/operations/period.md @@ -1,13 +1,15 @@ # Period +## Example Usage + +```typescript +import { Period } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Period = "weekly"; +``` ## Values -| Name | Value | -| ----------- | ----------- | -| `Daily` | daily | -| `Weekly` | weekly | -| `Monthly` | monthly | -| `Quarterly` | quarterly | -| `Yearly` | yearly | -| `All` | all | \ No newline at end of file +```typescript +"daily" | "weekly" | "monthly" | "quarterly" | "yearly" | "all" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/permissions.md b/docs/sdk/models/operations/permissions.md index da73706..7f3ee62 100644 --- a/docs/sdk/models/operations/permissions.md +++ b/docs/sdk/models/operations/permissions.md @@ -1,5 +1,14 @@ # Permissions +## Example Usage + +```typescript +import { Permissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Permissions = { + everyone: 1, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/post.md b/docs/sdk/models/operations/post.md index e536232..f17b767 100644 --- a/docs/sdk/models/operations/post.md +++ b/docs/sdk/models/operations/post.md @@ -1,5 +1,14 @@ # Post +## Example Usage + +```typescript +import { Post } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Post = { + raw: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/postactiontypes.md b/docs/sdk/models/operations/postactiontypes.md index b7eb8a7..fb295c9 100644 --- a/docs/sdk/models/operations/postactiontypes.md +++ b/docs/sdk/models/operations/postactiontypes.md @@ -1,5 +1,20 @@ # PostActionTypes +## Example Usage + +```typescript +import { PostActionTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostActionTypes = { + description: "Function-based discrete neural-net", + id: 200364, + isCustomFlag: false, + isFlag: false, + name: "", + nameKey: "", + shortDescription: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/posters.md b/docs/sdk/models/operations/posters.md index deee125..63ab995 100644 --- a/docs/sdk/models/operations/posters.md +++ b/docs/sdk/models/operations/posters.md @@ -1,5 +1,21 @@ # Posters +## Example Usage + +```typescript +import { Posters } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Posters = { + description: "Operative composite product", + extras: "", + user: { + avatarTemplate: "", + id: 166047, + name: "", + username: "Neal.Walker48", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/postrepliesactionssummary.md b/docs/sdk/models/operations/postrepliesactionssummary.md index 8727da6..0ff3508 100644 --- a/docs/sdk/models/operations/postrepliesactionssummary.md +++ b/docs/sdk/models/operations/postrepliesactionssummary.md @@ -1,5 +1,15 @@ # PostRepliesActionsSummary +## Example Usage + +```typescript +import { PostRepliesActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostRepliesActionsSummary = { + canAct: false, + id: 479385, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/postrepliesrequest.md b/docs/sdk/models/operations/postrepliesrequest.md index 203e53b..2bc9dd8 100644 --- a/docs/sdk/models/operations/postrepliesrequest.md +++ b/docs/sdk/models/operations/postrepliesrequest.md @@ -1,5 +1,14 @@ # PostRepliesRequest +## Example Usage + +```typescript +import { PostRepliesRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostRepliesRequest = { + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/postrepliesresponsebody.md b/docs/sdk/models/operations/postrepliesresponsebody.md index 83f9747..8f9aca7 100644 --- a/docs/sdk/models/operations/postrepliesresponsebody.md +++ b/docs/sdk/models/operations/postrepliesresponsebody.md @@ -1,5 +1,70 @@ # PostRepliesResponseBody +## Example Usage + +```typescript +import { PostRepliesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostRepliesResponseBody = { + actionsSummary: [ + { + canAct: false, + id: 517137, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canSeeHiddenPost: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + displayUsername: "", + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 292888, + incomingLinkCount: 755106, + moderator: false, + name: "", + postNumber: 715053, + postType: 32273, + primaryGroupName: "", + quoteCount: 418109, + readersCount: 456688, + reads: 172951, + replyCount: 824798, + replyToPostNumber: 107210, + replyToUser: { + avatarTemplate: "", + username: "Marcella.Schumm", + }, + reviewableId: "", + reviewableScoreCount: 588812, + reviewableScorePendingCount: 882284, + score: 896480, + staff: false, + topicId: 733289, + topicSlug: "", + trustLevel: 575078, + updatedAt: "", + userDeleted: false, + userId: 409726, + userTitle: "", + username: "Hellen_Hintz35", + version: 889060, + wiki: false, + yours: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/posts.md b/docs/sdk/models/operations/posts.md index 80e3782..960deda 100644 --- a/docs/sdk/models/operations/posts.md +++ b/docs/sdk/models/operations/posts.md @@ -1,5 +1,75 @@ # Posts +## Example Usage + +```typescript +import { Posts } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Posts = { + actionsSummary: [ + { + canAct: false, + id: 608989, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + displayUsername: "", + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 178580, + incomingLinkCount: 579011, + linkCounts: [ + { + clicks: 612867, + internal: false, + reflection: false, + title: "", + url: "http://bogus-prefix.org", + }, + ], + moderator: false, + name: "", + postNumber: 976802, + postType: 719620, + primaryGroupName: "", + quoteCount: 608593, + read: false, + readersCount: 966390, + reads: 328379, + replyCount: 507636, + replyToPostNumber: "", + reviewableId: 802692, + reviewableScoreCount: 300403, + reviewableScorePendingCount: 836364, + score: 549501, + staff: false, + topicId: 415280, + topicSlug: "", + trustLevel: 930819, + updatedAt: "", + userDeleted: false, + userId: 415608, + userTitle: "", + username: "Jovan72", + version: 877399, + wiki: false, + yours: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/poststream.md b/docs/sdk/models/operations/poststream.md index af337f7..a42ea14 100644 --- a/docs/sdk/models/operations/poststream.md +++ b/docs/sdk/models/operations/poststream.md @@ -1,5 +1,80 @@ # PostStream +## Example Usage + +```typescript +import { PostStream } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostStream = { + posts: [ + { + actionsSummary: [ + { + canAct: false, + id: 32901, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + displayUsername: "", + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 371919, + incomingLinkCount: 425946, + linkCounts: [ + { + clicks: 1383, + internal: false, + reflection: false, + title: "", + url: "http://evil-wheat.biz", + }, + ], + moderator: false, + name: "", + postNumber: 575213, + postType: 858778, + primaryGroupName: "", + quoteCount: 643678, + read: false, + readersCount: 458503, + reads: 364463, + replyCount: 444587, + replyToPostNumber: "", + reviewableId: 667715, + reviewableScoreCount: 336102, + reviewableScorePendingCount: 571844, + score: 880679, + staff: false, + topicId: 774684, + topicSlug: "", + trustLevel: 945027, + updatedAt: "", + userDeleted: false, + userId: 900103, + userTitle: "", + username: "Zachariah_Jakubowski", + version: 966148, + wiki: false, + yours: false, + }, + ], + stream: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/posttypes.md b/docs/sdk/models/operations/posttypes.md index 6febaa6..5ae3168 100644 --- a/docs/sdk/models/operations/posttypes.md +++ b/docs/sdk/models/operations/posttypes.md @@ -1,5 +1,17 @@ # PostTypes +## Example Usage + +```typescript +import { PostTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PostTypes = { + moderatorAction: 63207, + regular: 925703, + smallAction: 607249, + whisper: 309251, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/presignedurls.md b/docs/sdk/models/operations/presignedurls.md index dd40e22..590bc12 100644 --- a/docs/sdk/models/operations/presignedurls.md +++ b/docs/sdk/models/operations/presignedurls.md @@ -2,6 +2,13 @@ The presigned URLs for each part number, which has the part numbers as keys. +## Example Usage + +```typescript +import { PresignedUrls } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: PresignedUrls = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/queryparamasc.md b/docs/sdk/models/operations/queryparamasc.md index 940f305..af97aa4 100644 --- a/docs/sdk/models/operations/queryparamasc.md +++ b/docs/sdk/models/operations/queryparamasc.md @@ -1,8 +1,15 @@ # QueryParamAsc +## Example Usage + +```typescript +import { QueryParamAsc } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: QueryParamAsc = "true"; +``` ## Values -| Name | Value | -| ------ | ------ | -| `True` | true | \ No newline at end of file +```typescript +"true" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/queryparamorder.md b/docs/sdk/models/operations/queryparamorder.md index b1211be..a19d490 100644 --- a/docs/sdk/models/operations/queryparamorder.md +++ b/docs/sdk/models/operations/queryparamorder.md @@ -1,18 +1,15 @@ # QueryParamOrder +## Example Usage + +```typescript +import { QueryParamOrder } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: QueryParamOrder = "username"; +``` ## Values -| Name | Value | -| -------------- | -------------- | -| `Created` | created | -| `LastEmailed` | last_emailed | -| `Seen` | seen | -| `Username` | username | -| `Email` | email | -| `TrustLevel` | trust_level | -| `DaysVisited` | days_visited | -| `PostsRead` | posts_read | -| `TopicsViewed` | topics_viewed | -| `Posts` | posts | -| `ReadTime` | read_time | \ No newline at end of file +```typescript +"created" | "last_emailed" | "seen" | "username" | "email" | "trust_level" | "days_visited" | "posts_read" | "topics_viewed" | "posts" | "read_time" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/refreshgravatarrequest.md b/docs/sdk/models/operations/refreshgravatarrequest.md index b0e6ee8..f02142b 100644 --- a/docs/sdk/models/operations/refreshgravatarrequest.md +++ b/docs/sdk/models/operations/refreshgravatarrequest.md @@ -1,5 +1,14 @@ # RefreshGravatarRequest +## Example Usage + +```typescript +import { RefreshGravatarRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RefreshGravatarRequest = { + username: "Faustino.Langosh68", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/refreshgravatarresponsebody.md b/docs/sdk/models/operations/refreshgravatarresponsebody.md index 85eca06..32144f7 100644 --- a/docs/sdk/models/operations/refreshgravatarresponsebody.md +++ b/docs/sdk/models/operations/refreshgravatarresponsebody.md @@ -2,6 +2,16 @@ response +## Example Usage + +```typescript +import { RefreshGravatarResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RefreshGravatarResponseBody = { + gravatarAvatarTemplate: "", + gravatarUploadId: 530089, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/removegroupmembersrequest.md b/docs/sdk/models/operations/removegroupmembersrequest.md index 9bea709..b2f289f 100644 --- a/docs/sdk/models/operations/removegroupmembersrequest.md +++ b/docs/sdk/models/operations/removegroupmembersrequest.md @@ -1,5 +1,17 @@ # RemoveGroupMembersRequest +## Example Usage + +```typescript +import { RemoveGroupMembersRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RemoveGroupMembersRequest = { + requestBody: { + usernames: "username1,username2", + }, + id: 581273, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/removegroupmembersrequestbody.md b/docs/sdk/models/operations/removegroupmembersrequestbody.md index b9d3084..0d56619 100644 --- a/docs/sdk/models/operations/removegroupmembersrequestbody.md +++ b/docs/sdk/models/operations/removegroupmembersrequestbody.md @@ -1,5 +1,14 @@ # RemoveGroupMembersRequestBody +## Example Usage + +```typescript +import { RemoveGroupMembersRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RemoveGroupMembersRequestBody = { + usernames: "username1,username2", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/removegroupmembersresponsebody.md b/docs/sdk/models/operations/removegroupmembersresponsebody.md index abe10e9..aa03405 100644 --- a/docs/sdk/models/operations/removegroupmembersresponsebody.md +++ b/docs/sdk/models/operations/removegroupmembersresponsebody.md @@ -2,6 +2,17 @@ success response +## Example Usage + +```typescript +import { RemoveGroupMembersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RemoveGroupMembersResponseBody = { + skippedUsernames: [""], + success: "", + usernames: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/removetopicrequest.md b/docs/sdk/models/operations/removetopicrequest.md index 5491508..2bf3365 100644 --- a/docs/sdk/models/operations/removetopicrequest.md +++ b/docs/sdk/models/operations/removetopicrequest.md @@ -1,5 +1,16 @@ # RemoveTopicRequest +## Example Usage + +```typescript +import { RemoveTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RemoveTopicRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/replytouser.md b/docs/sdk/models/operations/replytouser.md index a669c8f..84a46c8 100644 --- a/docs/sdk/models/operations/replytouser.md +++ b/docs/sdk/models/operations/replytouser.md @@ -1,5 +1,15 @@ # ReplyToUser +## Example Usage + +```typescript +import { ReplyToUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ReplyToUser = { + avatarTemplate: "", + username: "Anastacio4", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/requiredtaggroups.md b/docs/sdk/models/operations/requiredtaggroups.md index 2e36fc2..a8a1131 100644 --- a/docs/sdk/models/operations/requiredtaggroups.md +++ b/docs/sdk/models/operations/requiredtaggroups.md @@ -1,5 +1,15 @@ # RequiredTagGroups +## Example Usage + +```typescript +import { RequiredTagGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: RequiredTagGroups = { + minCount: 440666, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/responsebody.md b/docs/sdk/models/operations/responsebody.md index dd8498c..b1f63e5 100644 --- a/docs/sdk/models/operations/responsebody.md +++ b/docs/sdk/models/operations/responsebody.md @@ -1,5 +1,16 @@ # ResponseBody +## Example Usage + +```typescript +import { ResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: ResponseBody = { + filename: "your_file_here", + lastModified: "", + size: 548814, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/searchrequest.md b/docs/sdk/models/operations/searchrequest.md index 8b8fc63..8cce783 100644 --- a/docs/sdk/models/operations/searchrequest.md +++ b/docs/sdk/models/operations/searchrequest.md @@ -1,5 +1,15 @@ # SearchRequest +## Example Usage + +```typescript +import { SearchRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SearchRequest = { + page: 1, + q: "api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/searchresponsebody.md b/docs/sdk/models/operations/searchresponsebody.md index 0bdbed4..58cdf41 100644 --- a/docs/sdk/models/operations/searchresponsebody.md +++ b/docs/sdk/models/operations/searchresponsebody.md @@ -2,6 +2,34 @@ success response +## Example Usage + +```typescript +import { SearchResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SearchResponseBody = { + categories: [""], + groupedSearchResult: { + canCreateTopic: false, + categoryIds: [""], + error: "", + groupIds: [""], + moreCategories: "", + moreFullPageResults: "", + morePosts: "", + moreUsers: "", + postIds: [""], + searchLogId: 298264, + tagIds: [""], + term: "", + userIds: [""], + }, + groups: [""], + posts: [""], + tags: [""], + users: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/senddownloadbackupemailrequest.md b/docs/sdk/models/operations/senddownloadbackupemailrequest.md index 2f91977..9199a5a 100644 --- a/docs/sdk/models/operations/senddownloadbackupemailrequest.md +++ b/docs/sdk/models/operations/senddownloadbackupemailrequest.md @@ -1,5 +1,14 @@ # SendDownloadBackupEmailRequest +## Example Usage + +```typescript +import { SendDownloadBackupEmailRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SendDownloadBackupEmailRequest = { + filename: "your_file_here", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/sendpasswordresetemailrequestbody.md b/docs/sdk/models/operations/sendpasswordresetemailrequestbody.md index 99585dc..5bd1625 100644 --- a/docs/sdk/models/operations/sendpasswordresetemailrequestbody.md +++ b/docs/sdk/models/operations/sendpasswordresetemailrequestbody.md @@ -1,5 +1,14 @@ # SendPasswordResetEmailRequestBody +## Example Usage + +```typescript +import { SendPasswordResetEmailRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SendPasswordResetEmailRequestBody = { + login: "Lilyan_Welch20", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/sendpasswordresetemailresponsebody.md b/docs/sdk/models/operations/sendpasswordresetemailresponsebody.md index bebeb1d..851a998 100644 --- a/docs/sdk/models/operations/sendpasswordresetemailresponsebody.md +++ b/docs/sdk/models/operations/sendpasswordresetemailresponsebody.md @@ -2,6 +2,16 @@ success response +## Example Usage + +```typescript +import { SendPasswordResetEmailResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SendPasswordResetEmailResponseBody = { + success: "", + userFound: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/setnotificationlevelrequest.md b/docs/sdk/models/operations/setnotificationlevelrequest.md index 589b26a..f879093 100644 --- a/docs/sdk/models/operations/setnotificationlevelrequest.md +++ b/docs/sdk/models/operations/setnotificationlevelrequest.md @@ -1,5 +1,16 @@ # SetNotificationLevelRequest +## Example Usage + +```typescript +import { SetNotificationLevelRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SetNotificationLevelRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/setnotificationlevelrequestbody.md b/docs/sdk/models/operations/setnotificationlevelrequestbody.md index b9ad863..89ea56f 100644 --- a/docs/sdk/models/operations/setnotificationlevelrequestbody.md +++ b/docs/sdk/models/operations/setnotificationlevelrequestbody.md @@ -1,5 +1,14 @@ # SetNotificationLevelRequestBody +## Example Usage + +```typescript +import { SetNotificationLevelRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SetNotificationLevelRequestBody = { + notificationLevel: "2", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/setnotificationlevelresponsebody.md b/docs/sdk/models/operations/setnotificationlevelresponsebody.md index 8fc5de8..8f8cf49 100644 --- a/docs/sdk/models/operations/setnotificationlevelresponsebody.md +++ b/docs/sdk/models/operations/setnotificationlevelresponsebody.md @@ -2,6 +2,15 @@ topic updated +## Example Usage + +```typescript +import { SetNotificationLevelResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SetNotificationLevelResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/signedheaders.md b/docs/sdk/models/operations/signedheaders.md index 11406ad..b6ed053 100644 --- a/docs/sdk/models/operations/signedheaders.md +++ b/docs/sdk/models/operations/signedheaders.md @@ -2,6 +2,13 @@ A map of headers that must be sent with the PUT request. +## Example Usage + +```typescript +import { SignedHeaders } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SignedHeaders = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/silence.md b/docs/sdk/models/operations/silence.md index ddb0df3..7642ce8 100644 --- a/docs/sdk/models/operations/silence.md +++ b/docs/sdk/models/operations/silence.md @@ -1,5 +1,23 @@ # Silence +## Example Usage + +```typescript +import { Silence } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Silence = { + silenceReason: "", + silenced: false, + silencedAt: "", + silencedBy: { + avatarTemplate: "", + id: 272683, + name: "", + username: "Karina85", + }, + silencedTill: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/silencedby.md b/docs/sdk/models/operations/silencedby.md index 568d6e3..3ca73bd 100644 --- a/docs/sdk/models/operations/silencedby.md +++ b/docs/sdk/models/operations/silencedby.md @@ -1,5 +1,17 @@ # SilencedBy +## Example Usage + +```typescript +import { SilencedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SilencedBy = { + avatarTemplate: "", + id: 341698, + name: "", + username: "Lucas_Padberg", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/silenceuserrequest.md b/docs/sdk/models/operations/silenceuserrequest.md index 31c67d5..e2b1462 100644 --- a/docs/sdk/models/operations/silenceuserrequest.md +++ b/docs/sdk/models/operations/silenceuserrequest.md @@ -1,5 +1,18 @@ # SilenceUserRequest +## Example Usage + +```typescript +import { SilenceUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SilenceUserRequest = { + requestBody: { + postAction: "delete", + silencedTill: "2022-06-01T08:00:00.000Z", + }, + id: 677115, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/silenceuserrequestbody.md b/docs/sdk/models/operations/silenceuserrequestbody.md index 53df4d9..b8d414a 100644 --- a/docs/sdk/models/operations/silenceuserrequestbody.md +++ b/docs/sdk/models/operations/silenceuserrequestbody.md @@ -1,5 +1,15 @@ # SilenceUserRequestBody +## Example Usage + +```typescript +import { SilenceUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SilenceUserRequestBody = { + postAction: "delete", + silencedTill: "2022-06-01T08:00:00.000Z", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/silenceuserresponsebody.md b/docs/sdk/models/operations/silenceuserresponsebody.md index 8b6b10f..86c29ba 100644 --- a/docs/sdk/models/operations/silenceuserresponsebody.md +++ b/docs/sdk/models/operations/silenceuserresponsebody.md @@ -2,6 +2,26 @@ response +## Example Usage + +```typescript +import { SilenceUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SilenceUserResponseBody = { + silence: { + silenceReason: "", + silenced: false, + silencedAt: "", + silencedBy: { + avatarTemplate: "", + id: 30235, + name: "", + username: "Lorine0", + }, + silencedTill: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/smtpupdatedby.md b/docs/sdk/models/operations/smtpupdatedby.md index 637f9ba..5f170b6 100644 --- a/docs/sdk/models/operations/smtpupdatedby.md +++ b/docs/sdk/models/operations/smtpupdatedby.md @@ -1,5 +1,12 @@ # SmtpUpdatedBy +## Example Usage + +```typescript +import { SmtpUpdatedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SmtpUpdatedBy = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/status.md b/docs/sdk/models/operations/status.md index 463c0ba..53fe662 100644 --- a/docs/sdk/models/operations/status.md +++ b/docs/sdk/models/operations/status.md @@ -1,12 +1,15 @@ # Status +## Example Usage + +```typescript +import { Status } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Status = "pinned_globally"; +``` ## Values -| Name | Value | -| ---------------- | ---------------- | -| `Closed` | closed | -| `Pinned` | pinned | -| `PinnedGlobally` | pinned_globally | -| `Archived` | archived | -| `Visible` | visible | \ No newline at end of file +```typescript +"closed" | "pinned" | "pinned_globally" | "archived" | "visible" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/suggestedtopics.md b/docs/sdk/models/operations/suggestedtopics.md index a4c4beb..2e78a70 100644 --- a/docs/sdk/models/operations/suggestedtopics.md +++ b/docs/sdk/models/operations/suggestedtopics.md @@ -1,5 +1,53 @@ # SuggestedTopics +## Example Usage + +```typescript +import { SuggestedTopics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SuggestedTopics = { + archetype: "", + archived: false, + bookmarked: "", + bumped: false, + bumpedAt: "", + categoryId: 453094, + closed: false, + createdAt: "", + excerpt: "", + fancyTitle: "", + featuredLink: "", + highestPostNumber: 194023, + id: 493958, + imageUrl: "", + lastPostedAt: "", + likeCount: 205566, + liked: "", + pinned: false, + posters: [ + { + description: "Robust interactive software", + extras: "", + user: { + avatarTemplate: "", + id: 437814, + name: "", + username: "Brock.Wolf", + }, + }, + ], + postsCount: 842855, + replyCount: 78969, + slug: "", + tags: [""], + tagsDescriptions: {}, + title: "", + unpinned: "", + unseen: false, + views: 818034, + visible: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/suspendedby.md b/docs/sdk/models/operations/suspendedby.md index 6d4c035..46c93f6 100644 --- a/docs/sdk/models/operations/suspendedby.md +++ b/docs/sdk/models/operations/suspendedby.md @@ -1,5 +1,17 @@ # SuspendedBy +## Example Usage + +```typescript +import { SuspendedBy } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SuspendedBy = { + avatarTemplate: "", + id: 372679, + name: "", + username: "Alberto_Lehner", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/suspenduserrequest.md b/docs/sdk/models/operations/suspenduserrequest.md index 4eaab76..9e1c74d 100644 --- a/docs/sdk/models/operations/suspenduserrequest.md +++ b/docs/sdk/models/operations/suspenduserrequest.md @@ -1,5 +1,19 @@ # SuspendUserRequest +## Example Usage + +```typescript +import { SuspendUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SuspendUserRequest = { + requestBody: { + postAction: "delete", + reason: "", + suspendUntil: "2121-02-22", + }, + id: 460220, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/suspenduserrequestbody.md b/docs/sdk/models/operations/suspenduserrequestbody.md index bbeffaa..67524ab 100644 --- a/docs/sdk/models/operations/suspenduserrequestbody.md +++ b/docs/sdk/models/operations/suspenduserrequestbody.md @@ -1,5 +1,16 @@ # SuspendUserRequestBody +## Example Usage + +```typescript +import { SuspendUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SuspendUserRequestBody = { + postAction: "delete", + reason: "", + suspendUntil: "2121-02-22", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/suspenduserresponsebody.md b/docs/sdk/models/operations/suspenduserresponsebody.md index 281d434..1f6ba4f 100644 --- a/docs/sdk/models/operations/suspenduserresponsebody.md +++ b/docs/sdk/models/operations/suspenduserresponsebody.md @@ -2,6 +2,26 @@ response +## Example Usage + +```typescript +import { SuspendUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: SuspendUserResponseBody = { + suspension: { + fullSuspendReason: "", + suspendReason: "", + suspendedAt: "", + suspendedBy: { + avatarTemplate: "", + id: 24313, + name: "", + username: "Herminia_Heathcote0", + }, + suspendedTill: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/suspension.md b/docs/sdk/models/operations/suspension.md index 812206f..f537b4e 100644 --- a/docs/sdk/models/operations/suspension.md +++ b/docs/sdk/models/operations/suspension.md @@ -1,5 +1,23 @@ # Suspension +## Example Usage + +```typescript +import { Suspension } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Suspension = { + fullSuspendReason: "", + suspendReason: "", + suspendedAt: "", + suspendedBy: { + avatarTemplate: "", + id: 361151, + name: "", + username: "Asia.Kuvalis", + }, + suspendedTill: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/taggroup.md b/docs/sdk/models/operations/taggroup.md index 87ad23e..d7f00ef 100644 --- a/docs/sdk/models/operations/taggroup.md +++ b/docs/sdk/models/operations/taggroup.md @@ -1,5 +1,19 @@ # TagGroup +## Example Usage + +```typescript +import { TagGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TagGroup = { + id: 914971, + name: "", + onePerTopic: false, + parentTagName: [""], + permissions: {}, + tagNames: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/taggroups.md b/docs/sdk/models/operations/taggroups.md index b37113e..c19c946 100644 --- a/docs/sdk/models/operations/taggroups.md +++ b/docs/sdk/models/operations/taggroups.md @@ -1,5 +1,12 @@ # TagGroups +## Example Usage + +```typescript +import { TagGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TagGroups = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/tags.md b/docs/sdk/models/operations/tags.md index 99466da..f09da97 100644 --- a/docs/sdk/models/operations/tags.md +++ b/docs/sdk/models/operations/tags.md @@ -1,5 +1,12 @@ # Tags +## Example Usage + +```typescript +import { Tags } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Tags = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/tagsdescriptions.md b/docs/sdk/models/operations/tagsdescriptions.md index 9cd3c2a..84bce2e 100644 --- a/docs/sdk/models/operations/tagsdescriptions.md +++ b/docs/sdk/models/operations/tagsdescriptions.md @@ -1,5 +1,12 @@ # TagsDescriptions +## Example Usage + +```typescript +import { TagsDescriptions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TagsDescriptions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/tl3requirements.md b/docs/sdk/models/operations/tl3requirements.md index c12224f..6c9f7d9 100644 --- a/docs/sdk/models/operations/tl3requirements.md +++ b/docs/sdk/models/operations/tl3requirements.md @@ -1,5 +1,47 @@ # Tl3Requirements +## Example Usage + +```typescript +import { Tl3Requirements } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Tl3Requirements = { + daysVisited: 102863, + maxFlaggedByUsers: 298282, + maxFlaggedPosts: 92373, + minDaysVisited: 569965, + minLikesGiven: 354047, + minLikesReceived: 590873, + minLikesReceivedDays: 551816, + minLikesReceivedUsers: 574325, + minPostsRead: 33625, + minPostsReadAllTime: 653201, + minTopicsRepliedTo: 968962, + minTopicsViewed: 652103, + minTopicsViewedAllTime: 320997, + numFlaggedByUsers: 431418, + numFlaggedPosts: 221262, + numLikesGiven: 896547, + numLikesReceived: 141264, + numLikesReceivedDays: 367562, + numLikesReceivedUsers: 97260, + numTopicsRepliedTo: 435865, + onGracePeriod: false, + penaltyCounts: { + silenced: 984043, + suspended: 891924, + total: 260341, + }, + postsRead: 806194, + postsReadAllTime: 537023, + requirementsLost: false, + requirementsMet: false, + timePeriod: 703889, + topicsViewed: 447926, + topicsViewedAllTime: 100226, + trustLevelLocked: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/topic.md b/docs/sdk/models/operations/topic.md index 103349b..f1a2ab2 100644 --- a/docs/sdk/models/operations/topic.md +++ b/docs/sdk/models/operations/topic.md @@ -1,5 +1,12 @@ # Topic +## Example Usage + +```typescript +import { Topic } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Topic = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/topicflagtypes.md b/docs/sdk/models/operations/topicflagtypes.md index a200409..f1eb348 100644 --- a/docs/sdk/models/operations/topicflagtypes.md +++ b/docs/sdk/models/operations/topicflagtypes.md @@ -1,5 +1,20 @@ # TopicFlagTypes +## Example Usage + +```typescript +import { TopicFlagTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TopicFlagTypes = { + description: "Multi-layered foreground emulation", + id: 633062, + isCustomFlag: false, + isFlag: false, + name: "", + nameKey: "", + shortDescription: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/topiclist.md b/docs/sdk/models/operations/topiclist.md index 5fce017..ceb3e24 100644 --- a/docs/sdk/models/operations/topiclist.md +++ b/docs/sdk/models/operations/topiclist.md @@ -1,5 +1,56 @@ # TopicList +## Example Usage + +```typescript +import { TopicList } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TopicList = { + canCreateTopic: false, + perPage: 281153, + topics: [ + { + archetype: "", + archived: false, + bookmarked: "", + bumped: false, + bumpedAt: "", + categoryId: 321043, + closed: false, + createdAt: "", + excerpt: "", + fancyTitle: "", + featuredLink: "", + hasSummary: false, + highestPostNumber: 713927, + id: 29950, + imageUrl: "", + lastPostedAt: "", + lastPosterUsername: "", + likeCount: 561577, + liked: "", + pinned: false, + pinnedGlobally: false, + posters: [ + { + description: "Re-engineered foreground array", + extras: "", + primaryGroupId: "", + userId: 530860, + }, + ], + postsCount: 606308, + replyCount: 85233, + slug: "", + title: "", + unpinned: "", + unseen: false, + views: 703218, + visible: false, + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/topics.md b/docs/sdk/models/operations/topics.md index 846fc8f..296f8e4 100644 --- a/docs/sdk/models/operations/topics.md +++ b/docs/sdk/models/operations/topics.md @@ -1,5 +1,50 @@ # Topics +## Example Usage + +```typescript +import { Topics } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Topics = { + archetype: "", + archived: false, + bookmarked: "", + bumped: false, + bumpedAt: "", + categoryId: 653421, + closed: false, + createdAt: "", + excerpt: "", + fancyTitle: "", + featuredLink: "", + hasSummary: false, + highestPostNumber: 671794, + id: 726343, + imageUrl: "", + lastPostedAt: "", + lastPosterUsername: "", + likeCount: 324083, + liked: "", + pinned: false, + pinnedGlobally: false, + posters: [ + { + description: "Operative dynamic array", + extras: "", + primaryGroupId: "", + userId: 833316, + }, + ], + postsCount: 405036, + replyCount: 775803, + slug: "", + title: "", + unpinned: "", + unseen: false, + views: 405373, + visible: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/triggers.md b/docs/sdk/models/operations/triggers.md index 4eaabe3..b872a1e 100644 --- a/docs/sdk/models/operations/triggers.md +++ b/docs/sdk/models/operations/triggers.md @@ -1,5 +1,18 @@ # Triggers +## Example Usage + +```typescript +import { Triggers } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Triggers = { + none: 592845, + postAction: 715190, + postRevision: 844266, + trustLevelChange: 602763, + userChange: 857946, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/trustlevels.md b/docs/sdk/models/operations/trustlevels.md index 9fbf094..593f639 100644 --- a/docs/sdk/models/operations/trustlevels.md +++ b/docs/sdk/models/operations/trustlevels.md @@ -1,5 +1,18 @@ # TrustLevels +## Example Usage + +```typescript +import { TrustLevels } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: TrustLevels = { + basic: 238413, + leader: 890653, + member: 514513, + newuser: 432606, + regular: 367927, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/type.md b/docs/sdk/models/operations/type.md index b3702c0..f9a08b2 100644 --- a/docs/sdk/models/operations/type.md +++ b/docs/sdk/models/operations/type.md @@ -1,12 +1,15 @@ # Type +## Example Usage + +```typescript +import { Type } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Type = "composer"; +``` ## Values -| Name | Value | -| ------------------- | ------------------- | -| `Avatar` | avatar | -| `ProfileBackground` | profile_background | -| `CardBackground` | card_background | -| `CustomEmoji` | custom_emoji | -| `Composer` | composer | \ No newline at end of file +```typescript +"avatar" | "profile_background" | "card_background" | "custom_emoji" | "composer" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/updateavatarrequest.md b/docs/sdk/models/operations/updateavatarrequest.md index 71f58fb..ea2c164 100644 --- a/docs/sdk/models/operations/updateavatarrequest.md +++ b/docs/sdk/models/operations/updateavatarrequest.md @@ -1,5 +1,14 @@ # UpdateAvatarRequest +## Example Usage + +```typescript +import { UpdateAvatarRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateAvatarRequest = { + username: "Mason57", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateavatarrequestbody.md b/docs/sdk/models/operations/updateavatarrequestbody.md index 4faa5d7..2e18b7a 100644 --- a/docs/sdk/models/operations/updateavatarrequestbody.md +++ b/docs/sdk/models/operations/updateavatarrequestbody.md @@ -1,5 +1,15 @@ # UpdateAvatarRequestBody +## Example Usage + +```typescript +import { UpdateAvatarRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateAvatarRequestBody = { + type: "system", + uploadId: 209750, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateavatarresponsebody.md b/docs/sdk/models/operations/updateavatarresponsebody.md index 1b21cbd..691dff9 100644 --- a/docs/sdk/models/operations/updateavatarresponsebody.md +++ b/docs/sdk/models/operations/updateavatarresponsebody.md @@ -2,6 +2,15 @@ avatar updated +## Example Usage + +```typescript +import { UpdateAvatarResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateAvatarResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateavatartype.md b/docs/sdk/models/operations/updateavatartype.md index dad0230..6762f64 100644 --- a/docs/sdk/models/operations/updateavatartype.md +++ b/docs/sdk/models/operations/updateavatartype.md @@ -1,11 +1,15 @@ # UpdateAvatarType +## Example Usage + +```typescript +import { UpdateAvatarType } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateAvatarType = "custom"; +``` ## Values -| Name | Value | -| ---------- | ---------- | -| `Uploaded` | uploaded | -| `Custom` | custom | -| `Gravatar` | gravatar | -| `System` | system | \ No newline at end of file +```typescript +"uploaded" | "custom" | "gravatar" | "system" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/updatebadgebadge.md b/docs/sdk/models/operations/updatebadgebadge.md index b519619..c7c6365 100644 --- a/docs/sdk/models/operations/updatebadgebadge.md +++ b/docs/sdk/models/operations/updatebadgebadge.md @@ -1,5 +1,34 @@ # UpdateBadgeBadge +## Example Usage + +```typescript +import { UpdateBadgeBadge } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateBadgeBadge = { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 315428, + badgeTypeId: 607831, + description: "Horizontal eco-centric local area network", + enabled: false, + grantCount: 38425, + icon: "", + id: 438601, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatebadgebadgetypes.md b/docs/sdk/models/operations/updatebadgebadgetypes.md index 4f540c9..d3501a8 100644 --- a/docs/sdk/models/operations/updatebadgebadgetypes.md +++ b/docs/sdk/models/operations/updatebadgebadgetypes.md @@ -1,5 +1,16 @@ # UpdateBadgeBadgeTypes +## Example Usage + +```typescript +import { UpdateBadgeBadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateBadgeBadgeTypes = { + id: 634274, + name: "", + sortOrder: 988374, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatebadgerequest.md b/docs/sdk/models/operations/updatebadgerequest.md index c0b3b5b..d6c2055 100644 --- a/docs/sdk/models/operations/updatebadgerequest.md +++ b/docs/sdk/models/operations/updatebadgerequest.md @@ -1,5 +1,14 @@ # UpdateBadgeRequest +## Example Usage + +```typescript +import { UpdateBadgeRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateBadgeRequest = { + id: 750686, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatebadgerequestbody.md b/docs/sdk/models/operations/updatebadgerequestbody.md index c34d1f9..3921cd8 100644 --- a/docs/sdk/models/operations/updatebadgerequestbody.md +++ b/docs/sdk/models/operations/updatebadgerequestbody.md @@ -1,5 +1,15 @@ # UpdateBadgeRequestBody +## Example Usage + +```typescript +import { UpdateBadgeRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateBadgeRequestBody = { + badgeTypeId: 128926, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatebadgeresponsebody.md b/docs/sdk/models/operations/updatebadgeresponsebody.md index 606ac37..75ce69f 100644 --- a/docs/sdk/models/operations/updatebadgeresponsebody.md +++ b/docs/sdk/models/operations/updatebadgeresponsebody.md @@ -2,6 +2,44 @@ success response +## Example Usage + +```typescript +import { UpdateBadgeResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateBadgeResponseBody = { + badge: { + allowTitle: false, + autoRevoke: false, + badgeGroupingId: 958950, + badgeTypeId: 102044, + description: "Profound composite model", + enabled: false, + grantCount: 161309, + icon: "", + id: 995300, + imageUrl: "", + listable: false, + longDescription: "", + manuallyGrantable: false, + multipleGrant: false, + name: "", + query: "", + showPosts: false, + slug: "", + system: false, + targetPosts: false, + trigger: "", + }, + badgeTypes: [ + { + id: 653108, + name: "", + sortOrder: 581850, + }, + ], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategorycategory.md b/docs/sdk/models/operations/updatecategorycategory.md index 4cdb3dc..d22765c 100644 --- a/docs/sdk/models/operations/updatecategorycategory.md +++ b/docs/sdk/models/operations/updatecategorycategory.md @@ -1,5 +1,73 @@ # UpdateCategoryCategory +## Example Usage + +```typescript +import { UpdateCategoryCategory } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryCategory = { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "red", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Switchable incremental product", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + formTemplateIds: [""], + groupPermissions: [ + { + groupName: "", + permissionType: 842777, + }, + ], + hasChildren: false, + id: 720528, + mailinglistMirror: false, + minimumRequiredTags: 373216, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 633415, + numFeaturedTopics: 222864, + permission: 307376, + position: 80532, + postCount: 537279, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 85311, + name: "", + }, + ], + searchPriority: 274575, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 221396, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategorycustomfields.md b/docs/sdk/models/operations/updatecategorycustomfields.md index 710dca0..871d2fc 100644 --- a/docs/sdk/models/operations/updatecategorycustomfields.md +++ b/docs/sdk/models/operations/updatecategorycustomfields.md @@ -1,5 +1,12 @@ # UpdateCategoryCustomFields +## Example Usage + +```typescript +import { UpdateCategoryCustomFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryCustomFields = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategorygrouppermissions.md b/docs/sdk/models/operations/updatecategorygrouppermissions.md index 008235c..0d3d000 100644 --- a/docs/sdk/models/operations/updatecategorygrouppermissions.md +++ b/docs/sdk/models/operations/updatecategorygrouppermissions.md @@ -1,5 +1,15 @@ # UpdateCategoryGroupPermissions +## Example Usage + +```typescript +import { UpdateCategoryGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryGroupPermissions = { + groupName: "", + permissionType: 190567, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategorypermissions.md b/docs/sdk/models/operations/updatecategorypermissions.md index 4515ec6..1ae6133 100644 --- a/docs/sdk/models/operations/updatecategorypermissions.md +++ b/docs/sdk/models/operations/updatecategorypermissions.md @@ -1,5 +1,14 @@ # UpdateCategoryPermissions +## Example Usage + +```typescript +import { UpdateCategoryPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryPermissions = { + everyone: 1, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategoryrequest.md b/docs/sdk/models/operations/updatecategoryrequest.md index 37a2944..acc4003 100644 --- a/docs/sdk/models/operations/updatecategoryrequest.md +++ b/docs/sdk/models/operations/updatecategoryrequest.md @@ -1,5 +1,22 @@ # UpdateCategoryRequest +## Example Usage + +```typescript +import { UpdateCategoryRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryRequest = { + requestBody: { + color: "49d9e9", + name: "", + permissions: { + everyone: 1, + }, + textColor: "f0fcfd", + }, + id: 992074, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategoryrequestbody.md b/docs/sdk/models/operations/updatecategoryrequestbody.md index 39c48f7..25cb912 100644 --- a/docs/sdk/models/operations/updatecategoryrequestbody.md +++ b/docs/sdk/models/operations/updatecategoryrequestbody.md @@ -1,5 +1,19 @@ # UpdateCategoryRequestBody +## Example Usage + +```typescript +import { UpdateCategoryRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryRequestBody = { + color: "49d9e9", + name: "", + permissions: { + everyone: 1, + }, + textColor: "f0fcfd", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategoryrequiredtaggroups.md b/docs/sdk/models/operations/updatecategoryrequiredtaggroups.md index 86bc353..e805caf 100644 --- a/docs/sdk/models/operations/updatecategoryrequiredtaggroups.md +++ b/docs/sdk/models/operations/updatecategoryrequiredtaggroups.md @@ -1,5 +1,15 @@ # UpdateCategoryRequiredTagGroups +## Example Usage + +```typescript +import { UpdateCategoryRequiredTagGroups } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryRequiredTagGroups = { + minCount: 355225, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatecategoryresponsebody.md b/docs/sdk/models/operations/updatecategoryresponsebody.md index 8bf64f8..5317307 100644 --- a/docs/sdk/models/operations/updatecategoryresponsebody.md +++ b/docs/sdk/models/operations/updatecategoryresponsebody.md @@ -2,6 +2,77 @@ success response +## Example Usage + +```typescript +import { UpdateCategoryResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateCategoryResponseBody = { + category: { + allTopicsWiki: false, + allowBadges: false, + allowUnlimitedOwnerEditsOnFirstPost: false, + autoCloseBasedOnLastPost: false, + autoCloseHours: "", + availableGroups: [""], + canDelete: false, + canEdit: false, + color: "red", + customFields: {}, + defaultListFilter: "", + defaultSlowModeSeconds: "", + defaultTopPeriod: "", + defaultView: "", + description: "Configurable 3rd generation data-warehouse", + descriptionExcerpt: "", + descriptionText: "", + emailIn: "", + emailInAllowStrangers: false, + formTemplateIds: [""], + groupPermissions: [ + { + groupName: "", + permissionType: 144286, + }, + ], + hasChildren: false, + id: 66149, + mailinglistMirror: false, + minimumRequiredTags: 513760, + name: "", + navigateToFirstPostAfterRead: false, + notificationLevel: 65604, + numFeaturedTopics: 222658, + permission: 856277, + position: 369490, + postCount: 162120, + readOnlyBanner: "", + readRestricted: false, + requiredTagGroups: [ + { + minCount: 55107, + name: "", + }, + ], + searchPriority: 559682, + showSubcategoryList: false, + slug: "", + sortAscending: "", + sortOrder: "", + subcategoryListStyle: "", + textColor: "", + topicCount: 911198, + topicFeaturedLinkAllowed: false, + topicTemplate: "", + topicUrl: "", + uploadedBackground: "", + uploadedBackgroundDark: "", + uploadedLogo: "", + uploadedLogoDark: "", + }, + success: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateemailrequest.md b/docs/sdk/models/operations/updateemailrequest.md index 8b5a70e..e138757 100644 --- a/docs/sdk/models/operations/updateemailrequest.md +++ b/docs/sdk/models/operations/updateemailrequest.md @@ -1,5 +1,14 @@ # UpdateEmailRequest +## Example Usage + +```typescript +import { UpdateEmailRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateEmailRequest = { + username: "Giles64", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateemailrequestbody.md b/docs/sdk/models/operations/updateemailrequestbody.md index 1b4fa3f..a27e907 100644 --- a/docs/sdk/models/operations/updateemailrequestbody.md +++ b/docs/sdk/models/operations/updateemailrequestbody.md @@ -1,5 +1,14 @@ # UpdateEmailRequestBody +## Example Usage + +```typescript +import { UpdateEmailRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateEmailRequestBody = { + email: "Maureen_Lind94@gmail.com", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updategroupgroup.md b/docs/sdk/models/operations/updategroupgroup.md index 0771e9b..f151a6a 100644 --- a/docs/sdk/models/operations/updategroupgroup.md +++ b/docs/sdk/models/operations/updategroupgroup.md @@ -1,5 +1,14 @@ # UpdateGroupGroup +## Example Usage + +```typescript +import { UpdateGroupGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateGroupGroup = { + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updategrouprequest.md b/docs/sdk/models/operations/updategrouprequest.md index 9139f72..20e26e5 100644 --- a/docs/sdk/models/operations/updategrouprequest.md +++ b/docs/sdk/models/operations/updategrouprequest.md @@ -1,5 +1,14 @@ # UpdateGroupRequest +## Example Usage + +```typescript +import { UpdateGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateGroupRequest = { + id: 313218, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updategrouprequestbody.md b/docs/sdk/models/operations/updategrouprequestbody.md index 3a2fbde..0c3cf85 100644 --- a/docs/sdk/models/operations/updategrouprequestbody.md +++ b/docs/sdk/models/operations/updategrouprequestbody.md @@ -1,5 +1,16 @@ # UpdateGroupRequestBody +## Example Usage + +```typescript +import { UpdateGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateGroupRequestBody = { + group: { + name: "", + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updategroupresponsebody.md b/docs/sdk/models/operations/updategroupresponsebody.md index 2e98ff9..5668c2e 100644 --- a/docs/sdk/models/operations/updategroupresponsebody.md +++ b/docs/sdk/models/operations/updategroupresponsebody.md @@ -2,6 +2,15 @@ success response +## Example Usage + +```typescript +import { UpdateGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateGroupResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatepostactionssummary.md b/docs/sdk/models/operations/updatepostactionssummary.md index 5b5cf1b..e5fb751 100644 --- a/docs/sdk/models/operations/updatepostactionssummary.md +++ b/docs/sdk/models/operations/updatepostactionssummary.md @@ -1,5 +1,15 @@ # UpdatePostActionsSummary +## Example Usage + +```typescript +import { UpdatePostActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdatePostActionsSummary = { + canAct: false, + id: 972912, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatepostpost.md b/docs/sdk/models/operations/updatepostpost.md index a202438..96cc417 100644 --- a/docs/sdk/models/operations/updatepostpost.md +++ b/docs/sdk/models/operations/updatepostpost.md @@ -1,5 +1,65 @@ # UpdatePostPost +## Example Usage + +```typescript +import { UpdatePostPost } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdatePostPost = { + actionsSummary: [ + { + canAct: false, + id: 737279, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + draftSequence: 872303, + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 5152, + incomingLinkCount: 156653, + moderator: false, + postNumber: 694158, + postType: 684126, + primaryGroupName: "", + quoteCount: 919508, + raw: "", + readersCount: 34070, + reads: 710456, + replyCount: 885208, + replyToPostNumber: "", + reviewableId: "", + reviewableScoreCount: 177005, + reviewableScorePendingCount: 844854, + score: 483518, + staff: false, + topicId: 510128, + topicSlug: "", + trustLevel: 140316, + updatedAt: "", + userDeleted: false, + userId: 127688, + userTitle: "", + username: "Florine.Mraz92", + version: 630871, + wiki: false, + yours: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatepostrequest.md b/docs/sdk/models/operations/updatepostrequest.md index 0d5dded..e2cc122 100644 --- a/docs/sdk/models/operations/updatepostrequest.md +++ b/docs/sdk/models/operations/updatepostrequest.md @@ -1,5 +1,14 @@ # UpdatePostRequest +## Example Usage + +```typescript +import { UpdatePostRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdatePostRequest = { + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatepostrequestbody.md b/docs/sdk/models/operations/updatepostrequestbody.md index 85248a7..8739b91 100644 --- a/docs/sdk/models/operations/updatepostrequestbody.md +++ b/docs/sdk/models/operations/updatepostrequestbody.md @@ -1,5 +1,12 @@ # UpdatePostRequestBody +## Example Usage + +```typescript +import { UpdatePostRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdatePostRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatepostresponsebody.md b/docs/sdk/models/operations/updatepostresponsebody.md index 878c9f0..2896bb2 100644 --- a/docs/sdk/models/operations/updatepostresponsebody.md +++ b/docs/sdk/models/operations/updatepostresponsebody.md @@ -2,6 +2,68 @@ post updated +## Example Usage + +```typescript +import { UpdatePostResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdatePostResponseBody = { + post: { + actionsSummary: [ + { + canAct: false, + id: 282837, + }, + ], + admin: false, + avatarTemplate: "", + bookmarked: false, + canDelete: false, + canEdit: false, + canRecover: false, + canViewEditHistory: false, + canWiki: false, + cooked: "", + createdAt: "", + deletedAt: "", + draftSequence: 693746, + editReason: "", + flairBgColor: "", + flairColor: "", + flairName: "", + flairUrl: "", + hidden: false, + id: 339631, + incomingLinkCount: 106255, + moderator: false, + postNumber: 600213, + postType: 476946, + primaryGroupName: "", + quoteCount: 963198, + raw: "", + readersCount: 585593, + reads: 147801, + replyCount: 253625, + replyToPostNumber: "", + reviewableId: "", + reviewableScoreCount: 256916, + reviewableScorePendingCount: 201010, + score: 873557, + staff: false, + topicId: 637856, + topicSlug: "", + trustLevel: 491892, + updatedAt: "", + userDeleted: false, + userId: 760744, + userTitle: "", + username: "Stanton70", + version: 532669, + wiki: false, + yours: false, + }, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetaggrouppermissions.md b/docs/sdk/models/operations/updatetaggrouppermissions.md index 29065f5..d07d531 100644 --- a/docs/sdk/models/operations/updatetaggrouppermissions.md +++ b/docs/sdk/models/operations/updatetaggrouppermissions.md @@ -1,5 +1,12 @@ # UpdateTagGroupPermissions +## Example Usage + +```typescript +import { UpdateTagGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTagGroupPermissions = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetaggrouprequest.md b/docs/sdk/models/operations/updatetaggrouprequest.md index 4c7898f..8cb06bc 100644 --- a/docs/sdk/models/operations/updatetaggrouprequest.md +++ b/docs/sdk/models/operations/updatetaggrouprequest.md @@ -1,5 +1,14 @@ # UpdateTagGroupRequest +## Example Usage + +```typescript +import { UpdateTagGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTagGroupRequest = { + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetaggrouprequestbody.md b/docs/sdk/models/operations/updatetaggrouprequestbody.md index e2a6875..957ebbf 100644 --- a/docs/sdk/models/operations/updatetaggrouprequestbody.md +++ b/docs/sdk/models/operations/updatetaggrouprequestbody.md @@ -1,5 +1,12 @@ # UpdateTagGroupRequestBody +## Example Usage + +```typescript +import { UpdateTagGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTagGroupRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetaggroupresponsebody.md b/docs/sdk/models/operations/updatetaggroupresponsebody.md index 2ee5764..adaf46d 100644 --- a/docs/sdk/models/operations/updatetaggroupresponsebody.md +++ b/docs/sdk/models/operations/updatetaggroupresponsebody.md @@ -2,6 +2,13 @@ Tag group updated +## Example Usage + +```typescript +import { UpdateTagGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTagGroupResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetaggrouptaggroup.md b/docs/sdk/models/operations/updatetaggrouptaggroup.md index e29343a..acd10d4 100644 --- a/docs/sdk/models/operations/updatetaggrouptaggroup.md +++ b/docs/sdk/models/operations/updatetaggrouptaggroup.md @@ -1,5 +1,12 @@ # UpdateTagGroupTagGroup +## Example Usage + +```typescript +import { UpdateTagGroupTagGroup } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTagGroupTagGroup = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicrequest.md b/docs/sdk/models/operations/updatetopicrequest.md index 97e63ee..11a71aa 100644 --- a/docs/sdk/models/operations/updatetopicrequest.md +++ b/docs/sdk/models/operations/updatetopicrequest.md @@ -1,5 +1,16 @@ # UpdateTopicRequest +## Example Usage + +```typescript +import { UpdateTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicRequest = { + apiKey: "", + apiUsername: "", + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicrequestbody.md b/docs/sdk/models/operations/updatetopicrequestbody.md index a513537..1b3b1a6 100644 --- a/docs/sdk/models/operations/updatetopicrequestbody.md +++ b/docs/sdk/models/operations/updatetopicrequestbody.md @@ -1,5 +1,12 @@ # UpdateTopicRequestBody +## Example Usage + +```typescript +import { UpdateTopicRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicresponsebody.md b/docs/sdk/models/operations/updatetopicresponsebody.md index 0d70227..925e5c4 100644 --- a/docs/sdk/models/operations/updatetopicresponsebody.md +++ b/docs/sdk/models/operations/updatetopicresponsebody.md @@ -2,6 +2,13 @@ topic updated +## Example Usage + +```typescript +import { UpdateTopicResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicResponseBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicstatusrequest.md b/docs/sdk/models/operations/updatetopicstatusrequest.md index 55f1b26..94dc7cc 100644 --- a/docs/sdk/models/operations/updatetopicstatusrequest.md +++ b/docs/sdk/models/operations/updatetopicstatusrequest.md @@ -1,5 +1,21 @@ # UpdateTopicStatusRequest +## Example Usage + +```typescript +import { UpdateTopicStatusRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicStatusRequest = { + apiKey: "", + apiUsername: "", + requestBody: { + enabled: "true", + status: "pinned_globally", + until: "2030-12-31", + }, + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicstatusrequestbody.md b/docs/sdk/models/operations/updatetopicstatusrequestbody.md index 955cbef..d0c45e8 100644 --- a/docs/sdk/models/operations/updatetopicstatusrequestbody.md +++ b/docs/sdk/models/operations/updatetopicstatusrequestbody.md @@ -1,5 +1,16 @@ # UpdateTopicStatusRequestBody +## Example Usage + +```typescript +import { UpdateTopicStatusRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicStatusRequestBody = { + enabled: "true", + status: "closed", + until: "2030-12-31", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopicstatusresponsebody.md b/docs/sdk/models/operations/updatetopicstatusresponsebody.md index 306892b..2944f90 100644 --- a/docs/sdk/models/operations/updatetopicstatusresponsebody.md +++ b/docs/sdk/models/operations/updatetopicstatusresponsebody.md @@ -2,6 +2,15 @@ topic updated +## Example Usage + +```typescript +import { UpdateTopicStatusResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicStatusResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopictimestamprequest.md b/docs/sdk/models/operations/updatetopictimestamprequest.md index ac17a3d..733b327 100644 --- a/docs/sdk/models/operations/updatetopictimestamprequest.md +++ b/docs/sdk/models/operations/updatetopictimestamprequest.md @@ -1,5 +1,19 @@ # UpdateTopicTimestampRequest +## Example Usage + +```typescript +import { UpdateTopicTimestampRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicTimestampRequest = { + apiKey: "", + apiUsername: "", + requestBody: { + timestamp: "1594291380", + }, + id: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopictimestamprequestbody.md b/docs/sdk/models/operations/updatetopictimestamprequestbody.md index 8221ed0..3efbe5d 100644 --- a/docs/sdk/models/operations/updatetopictimestamprequestbody.md +++ b/docs/sdk/models/operations/updatetopictimestamprequestbody.md @@ -1,5 +1,14 @@ # UpdateTopicTimestampRequestBody +## Example Usage + +```typescript +import { UpdateTopicTimestampRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicTimestampRequestBody = { + timestamp: "1594291380", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updatetopictimestampresponsebody.md b/docs/sdk/models/operations/updatetopictimestampresponsebody.md index d894a9e..c9cd8b7 100644 --- a/docs/sdk/models/operations/updatetopictimestampresponsebody.md +++ b/docs/sdk/models/operations/updatetopictimestampresponsebody.md @@ -2,6 +2,15 @@ topic updated +## Example Usage + +```typescript +import { UpdateTopicTimestampResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateTopicTimestampResponseBody = { + success: "OK", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateuserexternalids.md b/docs/sdk/models/operations/updateuserexternalids.md index 08de97e..dfecb2b 100644 --- a/docs/sdk/models/operations/updateuserexternalids.md +++ b/docs/sdk/models/operations/updateuserexternalids.md @@ -1,5 +1,12 @@ # UpdateUserExternalIds +## Example Usage + +```typescript +import { UpdateUserExternalIds } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUserExternalIds = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateusernamerequest.md b/docs/sdk/models/operations/updateusernamerequest.md index 2e5dc69..8ab292a 100644 --- a/docs/sdk/models/operations/updateusernamerequest.md +++ b/docs/sdk/models/operations/updateusernamerequest.md @@ -1,5 +1,14 @@ # UpdateUsernameRequest +## Example Usage + +```typescript +import { UpdateUsernameRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUsernameRequest = { + username: "Vincent66", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateusernamerequestbody.md b/docs/sdk/models/operations/updateusernamerequestbody.md index 1730039..491c82f 100644 --- a/docs/sdk/models/operations/updateusernamerequestbody.md +++ b/docs/sdk/models/operations/updateusernamerequestbody.md @@ -1,5 +1,14 @@ # UpdateUsernameRequestBody +## Example Usage + +```typescript +import { UpdateUsernameRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUsernameRequestBody = { + newUsername: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateuserrequest.md b/docs/sdk/models/operations/updateuserrequest.md index ead8cae..05e6095 100644 --- a/docs/sdk/models/operations/updateuserrequest.md +++ b/docs/sdk/models/operations/updateuserrequest.md @@ -1,5 +1,16 @@ # UpdateUserRequest +## Example Usage + +```typescript +import { UpdateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUserRequest = { + apiKey: "", + apiUsername: "", + username: "Jackeline_Miller83", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateuserrequestbody.md b/docs/sdk/models/operations/updateuserrequestbody.md index 0ba99e9..4bf62f1 100644 --- a/docs/sdk/models/operations/updateuserrequestbody.md +++ b/docs/sdk/models/operations/updateuserrequestbody.md @@ -1,5 +1,12 @@ # UpdateUserRequestBody +## Example Usage + +```typescript +import { UpdateUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUserRequestBody = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateuserresponsebody.md b/docs/sdk/models/operations/updateuserresponsebody.md index 62a52f5..8f90d46 100644 --- a/docs/sdk/models/operations/updateuserresponsebody.md +++ b/docs/sdk/models/operations/updateuserresponsebody.md @@ -2,6 +2,16 @@ user updated +## Example Usage + +```typescript +import { UpdateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUserResponseBody = { + success: "", + user: {}, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/updateuseruser.md b/docs/sdk/models/operations/updateuseruser.md index 4ceaa5d..a93198c 100644 --- a/docs/sdk/models/operations/updateuseruser.md +++ b/docs/sdk/models/operations/updateuseruser.md @@ -1,5 +1,12 @@ # UpdateUserUser +## Example Usage + +```typescript +import { UpdateUserUser } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UpdateUserUser = {}; +``` ## Fields diff --git a/docs/sdk/models/operations/uploadtype.md b/docs/sdk/models/operations/uploadtype.md index 913f971..7a3883d 100644 --- a/docs/sdk/models/operations/uploadtype.md +++ b/docs/sdk/models/operations/uploadtype.md @@ -1,12 +1,15 @@ # UploadType +## Example Usage + +```typescript +import { UploadType } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UploadType = "avatar"; +``` ## Values -| Name | Value | -| ------------------- | ------------------- | -| `Avatar` | avatar | -| `ProfileBackground` | profile_background | -| `CardBackground` | card_background | -| `CustomEmoji` | custom_emoji | -| `Composer` | composer | \ No newline at end of file +```typescript +"avatar" | "profile_background" | "card_background" | "custom_emoji" | "composer" +``` \ No newline at end of file diff --git a/docs/sdk/models/operations/user.md b/docs/sdk/models/operations/user.md index 5fd2047..0fd5afe 100644 --- a/docs/sdk/models/operations/user.md +++ b/docs/sdk/models/operations/user.md @@ -1,5 +1,186 @@ # User +## Example Usage + +```typescript +import { User } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: User = { + admin: false, + allowedPmUsernames: [""], + avatarTemplate: "", + badgeCount: 214880, + canBeDeleted: false, + canChangeBio: false, + canChangeLocation: false, + canChangeTrackingPreferences: false, + canChangeWebsite: false, + canDeleteAllPosts: false, + canEdit: false, + canEditEmail: false, + canEditName: false, + canEditUsername: false, + canIgnoreUser: false, + canMuteUser: false, + canSendPrivateMessageToUser: false, + canSendPrivateMessages: false, + canUploadProfileHeader: false, + canUploadUserCardBackground: false, + createdAt: "", + customFields: {}, + featuredTopic: "", + featuredUserBadgeIds: [""], + flairBgColor: "", + flairColor: "", + flairGroupId: "", + flairName: "", + flairUrl: "", + groupUsers: [ + { + groupId: 277628, + notificationLevel: 186458, + userId: 586784, + }, + ], + groups: [ + { + allowMembershipRequests: false, + automatic: false, + bioCooked: "", + bioExcerpt: "", + bioRaw: "", + canAdminGroup: false, + canSeeMembers: false, + defaultNotificationLevel: 807581, + displayName: "Salvador67", + flairBgColor: "", + flairColor: "", + flairUrl: "", + fullName: "Randall Cole", + grantTrustLevel: "", + hasMessages: false, + id: 704474, + incomingEmail: "", + membersVisibilityLevel: 396060, + membershipRequestTemplate: "", + mentionableLevel: 463150, + messageableLevel: 565421, + name: "", + primaryGroup: false, + publicAdmission: false, + publicExit: false, + publishReadState: false, + title: "", + userCount: 840429, + visibilityLevel: 183280, + }, + ], + hasTitleBadges: false, + id: 204865, + ignored: false, + ignoredUsernames: [""], + invitedBy: "", + lastPostedAt: "", + lastSeenAt: "", + locale: "en", + mailingListPostsPerDay: 164959, + moderator: false, + muted: false, + mutedCategoryIds: [""], + mutedTags: [""], + mutedUsernames: [""], + name: "", + pendingCount: 488056, + postCount: 124833, + primaryGroupId: "", + primaryGroupName: "", + profileViewCount: 355613, + recentTimeRead: 722081, + regularCategoryIds: [""], + secondFactorEnabled: false, + staged: false, + systemAvatarTemplate: "", + systemAvatarUploadId: "", + timeRead: 940432, + title: "", + trackedCategoryIds: [""], + trackedTags: [""], + trustLevel: 30452, + uploadedAvatarId: "", + useLogoSmallAsAvatar: false, + userApiKeys: "", + userAuthTokens: [ + { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 765326, + isActive: false, + location: "", + os: "", + seenAt: "", + }, + ], + userNotificationSchedule: { + day0EndTime: 746994, + day0StartTime: 748664, + day1EndTime: 92596, + day1StartTime: 903720, + day2EndTime: 217450, + day2StartTime: 83422, + day3EndTime: 749255, + day3StartTime: 552193, + day4EndTime: 731694, + day4StartTime: 584476, + day5EndTime: 45614, + day5StartTime: 961937, + day6EndTime: 209157, + day6StartTime: 292147, + enabled: false, + }, + userOption: { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 286915, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 240829, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 677263, + emailMessagesLevel: 100294, + emailPreviousReplies: 63038, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 16429, + mailingListMode: false, + mailingListModeFrequency: 555649, + newTopicDurationMinutes: 929530, + notificationLevelWhenReplying: 9240, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 669917, + themeIds: [""], + themeKeySeq: 833038, + timezone: "Asia/Kuala_Lumpur", + titleCountMode: "", + userId: 984330, + }, + username: "Earline.Prosacco", + watchedCategoryIds: [""], + watchedFirstPostCategoryIds: [""], + watchedTags: [""], + watchingFirstPostTags: [""], +}; +``` ## Fields diff --git a/docs/sdk/models/operations/useractions.md b/docs/sdk/models/operations/useractions.md index 7445280..cc899f6 100644 --- a/docs/sdk/models/operations/useractions.md +++ b/docs/sdk/models/operations/useractions.md @@ -1,5 +1,39 @@ # UserActions +## Example Usage + +```typescript +import { UserActions } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserActions = { + actingAvatarTemplate: "", + actingName: "", + actingUserId: 709072, + actingUsername: "", + actionCode: "", + actionType: 70869, + archived: false, + avatarTemplate: "", + categoryId: 611749, + closed: false, + createdAt: "", + deleted: false, + excerpt: "", + hidden: "", + name: "", + postId: "", + postNumber: 292794, + postType: "", + slug: "", + targetName: "", + targetUserId: 671907, + targetUsername: "", + title: "", + topicId: 152354, + userId: 447516, + username: "Haylie37", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/userauthtokens.md b/docs/sdk/models/operations/userauthtokens.md index 562e5e1..6b6f779 100644 --- a/docs/sdk/models/operations/userauthtokens.md +++ b/docs/sdk/models/operations/userauthtokens.md @@ -1,5 +1,23 @@ # UserAuthTokens +## Example Usage + +```typescript +import { UserAuthTokens } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserAuthTokens = { + browser: "", + clientIp: "", + createdAt: "", + device: "", + icon: "", + id: 885338, + isActive: false, + location: "", + os: "", + seenAt: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/userbadges.md b/docs/sdk/models/operations/userbadges.md index 9bd73e9..4662254 100644 --- a/docs/sdk/models/operations/userbadges.md +++ b/docs/sdk/models/operations/userbadges.md @@ -1,5 +1,20 @@ # UserBadges +## Example Usage + +```typescript +import { UserBadges } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserBadges = { + badgeId: 60225, + canFavorite: false, + grantedAt: "", + grantedById: 969810, + groupingPosition: 666767, + id: 653140, + isFavorite: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/usercolorschemes.md b/docs/sdk/models/operations/usercolorschemes.md index dd96826..00c799c 100644 --- a/docs/sdk/models/operations/usercolorschemes.md +++ b/docs/sdk/models/operations/usercolorschemes.md @@ -1,5 +1,16 @@ # UserColorSchemes +## Example Usage + +```typescript +import { UserColorSchemes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserColorSchemes = { + id: 928219, + isDark: false, + name: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/userfields.md b/docs/sdk/models/operations/userfields.md index 87999f5..89c9b5a 100644 --- a/docs/sdk/models/operations/userfields.md +++ b/docs/sdk/models/operations/userfields.md @@ -1,5 +1,15 @@ # UserFields +## Example Usage + +```typescript +import { UserFields } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserFields = { + one: "", + two: "", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/usernotificationschedule.md b/docs/sdk/models/operations/usernotificationschedule.md index 5152699..2ad3a75 100644 --- a/docs/sdk/models/operations/usernotificationschedule.md +++ b/docs/sdk/models/operations/usernotificationschedule.md @@ -1,5 +1,28 @@ # UserNotificationSchedule +## Example Usage + +```typescript +import { UserNotificationSchedule } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserNotificationSchedule = { + day0EndTime: 185636, + day0StartTime: 679880, + day1EndTime: 952792, + day1StartTime: 456130, + day2EndTime: 687488, + day2StartTime: 483409, + day3EndTime: 215507, + day3StartTime: 788740, + day4EndTime: 947371, + day4StartTime: 229442, + day5EndTime: 730856, + day5StartTime: 880298, + day6EndTime: 253941, + day6StartTime: 313692, + enabled: false, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/useroption.md b/docs/sdk/models/operations/useroption.md index eb53c61..71fff85 100644 --- a/docs/sdk/models/operations/useroption.md +++ b/docs/sdk/models/operations/useroption.md @@ -1,5 +1,45 @@ # UserOption +## Example Usage + +```typescript +import { UserOption } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserOption = { + allowPrivateMessages: false, + autoTrackTopicsAfterMsecs: 213312, + automaticallyUnpinTopics: false, + colorSchemeId: "", + darkSchemeId: "", + digestAfterMinutes: 957451, + dynamicFavicon: false, + emailDigests: false, + emailInReplyTo: false, + emailLevel: 518201, + emailMessagesLevel: 471752, + emailPreviousReplies: 25662, + enableAllowedPmUsers: false, + enableDefer: false, + enableQuoting: false, + externalLinksInNewTab: false, + hideProfileAndPresence: false, + homepageId: "", + includeTl0InDigests: false, + likeNotificationFrequency: 711584, + mailingListMode: false, + mailingListModeFrequency: 207470, + newTopicDurationMinutes: 153694, + notificationLevelWhenReplying: 424685, + skipNewUserTips: false, + textSize: "", + textSizeSeq: 730442, + themeIds: [""], + themeKeySeq: 374170, + timezone: "Asia/Kabul", + titleCountMode: "", + userId: 463575, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/users.md b/docs/sdk/models/operations/users.md index a0d5925..fe5c46b 100644 --- a/docs/sdk/models/operations/users.md +++ b/docs/sdk/models/operations/users.md @@ -1,5 +1,17 @@ # Users +## Example Usage + +```typescript +import { Users } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: Users = { + avatarTemplate: "", + id: 665678, + name: "", + username: "Lori_Bartell10", +}; +``` ## Fields diff --git a/docs/sdk/models/operations/userthemes.md b/docs/sdk/models/operations/userthemes.md index b9fa987..7a0886a 100644 --- a/docs/sdk/models/operations/userthemes.md +++ b/docs/sdk/models/operations/userthemes.md @@ -1,5 +1,17 @@ # UserThemes +## Example Usage + +```typescript +import { UserThemes } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserThemes = { + colorSchemeId: 456520, + default: false, + name: "", + themeId: 592081, +}; +``` ## Fields diff --git a/docs/sdk/models/operations/usertips.md b/docs/sdk/models/operations/usertips.md index ea588f4..164642d 100644 --- a/docs/sdk/models/operations/usertips.md +++ b/docs/sdk/models/operations/usertips.md @@ -1,5 +1,19 @@ # UserTips +## Example Usage + +```typescript +import { UserTips } from "@lukehagar/discoursejs/sdk/models/operations"; + +let value: UserTips = { + adminGuide: 337477, + firstNotification: 431785, + postMenu: 970494, + suggestedTopics: 592780, + topicNotificationLevels: 133439, + topicTimeline: 354506, +}; +``` ## Fields diff --git a/docs/sdks/admin/README.md b/docs/sdks/admin/README.md index 0091ef1..3a01896 100644 --- a/docs/sdks/admin/README.md +++ b/docs/sdks/admin/README.md @@ -35,6 +35,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminActivateUser } from "@lukehagar/discoursejs/funcs/adminActivateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminActivateUser(sdk, 458565); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -75,6 +104,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminAdminGetUser } from "@lukehagar/discoursejs/funcs/adminAdminGetUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminAdminGetUser(sdk, 641278); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -117,6 +175,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminAdminListUsers } from "@lukehagar/discoursejs/funcs/adminAdminListUsers.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminAdminListUsers(sdk, { + flag: "blocked", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -157,6 +246,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminAnonymizeUser } from "@lukehagar/discoursejs/funcs/adminAnonymizeUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminAnonymizeUser(sdk, 976366); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -197,6 +315,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminDeactivateUser } from "@lukehagar/discoursejs/funcs/adminDeactivateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminDeactivateUser(sdk, 495555); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -237,6 +384,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminDeleteUser } from "@lukehagar/discoursejs/funcs/adminDeleteUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminDeleteUser(sdk, 335223); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -278,6 +454,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminLogOutUser } from "@lukehagar/discoursejs/funcs/adminLogOutUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminLogOutUser(sdk, 141178); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -318,6 +523,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminRefreshGravatar } from "@lukehagar/discoursejs/funcs/adminRefreshGravatar.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminRefreshGravatar(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -361,6 +595,38 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminSilenceUser } from "@lukehagar/discoursejs/funcs/adminSilenceUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminSilenceUser(sdk, 212223, { + postAction: "delete", + silencedTill: "2022-06-01T08:00:00.000Z", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -406,6 +672,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { adminSuspendUser } from "@lukehagar/discoursejs/funcs/adminSuspendUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await adminSuspendUser(sdk, 192215, { + postAction: "delete", + reason: "", + suspendUntil: "2121-02-22", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/backups/README.md b/docs/sdks/backups/README.md index cb671fb..45965d8 100644 --- a/docs/sdks/backups/README.md +++ b/docs/sdks/backups/README.md @@ -29,6 +29,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { backupsCreateBackup } from "@lukehagar/discoursejs/funcs/backupsCreateBackup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await backupsCreateBackup(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -63,6 +92,34 @@ async function run() { await sdk.backups.downloadBackup("", ""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { backupsDownloadBackup } from "@lukehagar/discoursejs/funcs/backupsDownloadBackup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await backupsDownloadBackup(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -109,6 +166,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { backupsGetBackups } from "@lukehagar/discoursejs/funcs/backupsGetBackups.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await backupsGetBackups(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -142,6 +228,34 @@ async function run() { await sdk.backups.sendDownloadBackupEmail(""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { backupsSendDownloadBackupEmail } from "@lukehagar/discoursejs/funcs/backupsSendDownloadBackupEmail.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await backupsSendDownloadBackupEmail(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); diff --git a/docs/sdks/badges/README.md b/docs/sdks/badges/README.md index f57d608..a52bcbf 100644 --- a/docs/sdks/badges/README.md +++ b/docs/sdks/badges/README.md @@ -30,6 +30,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { badgesAdminListBadges } from "@lukehagar/discoursejs/funcs/badgesAdminListBadges.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await badgesAdminListBadges(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -69,6 +98,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { badgesCreateBadge } from "@lukehagar/discoursejs/funcs/badgesCreateBadge.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await badgesCreateBadge(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -103,6 +161,34 @@ async function run() { await sdk.badges.deleteBadge(32345); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { badgesDeleteBadge } from "@lukehagar/discoursejs/funcs/badgesDeleteBadge.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await badgesDeleteBadge(sdk, 402816); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -148,6 +234,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { badgesListUserBadges } from "@lukehagar/discoursejs/funcs/badgesListUserBadges.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await badgesListUserBadges(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -188,6 +303,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { badgesUpdateBadge } from "@lukehagar/discoursejs/funcs/badgesUpdateBadge.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await badgesUpdateBadge(sdk, 569102); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/categories/README.md b/docs/sdks/categories/README.md index d62b2ce..a99583f 100644 --- a/docs/sdks/categories/README.md +++ b/docs/sdks/categories/README.md @@ -38,6 +38,42 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesCreateCategory } from "@lukehagar/discoursejs/funcs/categoriesCreateCategory.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesCreateCategory(sdk, { + color: "49d9e9", + name: "", + permissions: { + everyone: 1, + }, + textColor: "f0fcfd", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -78,6 +114,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesGetCategory } from "@lukehagar/discoursejs/funcs/categoriesGetCategory.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesGetCategory(sdk, 687295); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -118,6 +183,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesGetSite } from "@lukehagar/discoursejs/funcs/categoriesGetSite.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesGetSite(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -157,6 +251,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesListCategories } from "@lukehagar/discoursejs/funcs/categoriesListCategories.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesListCategories(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -197,6 +320,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesListCategoryTopics } from "@lukehagar/discoursejs/funcs/categoriesListCategoryTopics.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesListCategoryTopics(sdk, 671891, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -245,6 +397,42 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { categoriesUpdateCategory } from "@lukehagar/discoursejs/funcs/categoriesUpdateCategory.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await categoriesUpdateCategory(sdk, 999337, { + color: "49d9e9", + name: "", + permissions: { + everyone: 1, + }, + textColor: "f0fcfd", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/groups/README.md b/docs/sdks/groups/README.md index 41f1996..a62a7ba 100644 --- a/docs/sdks/groups/README.md +++ b/docs/sdks/groups/README.md @@ -35,6 +35,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsAddGroupMembers } from "@lukehagar/discoursejs/funcs/groupsAddGroupMembers.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsAddGroupMembers(sdk, 946323, { + usernames: "username1,username2", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -76,6 +107,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsCreateGroup } from "@lukehagar/discoursejs/funcs/groupsCreateGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsCreateGroup(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -116,6 +176,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsDeleteGroup } from "@lukehagar/discoursejs/funcs/groupsDeleteGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsDeleteGroup(sdk, 114822); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -156,6 +245,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsGetGroup } from "@lukehagar/discoursejs/funcs/groupsGetGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsGetGroup(sdk, "name"); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | Example | @@ -196,6 +314,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsListGroupMembers } from "@lukehagar/discoursejs/funcs/groupsListGroupMembers.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsListGroupMembers(sdk, "name"); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | Example | @@ -236,6 +383,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsListGroups } from "@lukehagar/discoursejs/funcs/groupsListGroups.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsListGroups(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -277,6 +453,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsRemoveGroupMembers } from "@lukehagar/discoursejs/funcs/groupsRemoveGroupMembers.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsRemoveGroupMembers(sdk, 699656, { + usernames: "username1,username2", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -318,6 +525,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { groupsUpdateGroup } from "@lukehagar/discoursejs/funcs/groupsUpdateGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await groupsUpdateGroup(sdk, 750192); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/invites/README.md b/docs/sdks/invites/README.md index 74b5f94..e62532c 100644 --- a/docs/sdks/invites/README.md +++ b/docs/sdks/invites/README.md @@ -32,6 +32,40 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { invitesCreateInvite } from "@lukehagar/discoursejs/funcs/invitesCreateInvite.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await invitesCreateInvite(sdk, "", "", { + email: "not-a-user-yet@example.com", + groupIds: "42,43", + groupNames: "foo,bar", + maxRedemptionsAllowed: 5, + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -74,6 +108,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { invitesInviteToTopic } from "@lukehagar/discoursejs/funcs/invitesInviteToTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await invitesInviteToTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/notifications/README.md b/docs/sdks/notifications/README.md index 1d6bf2d..6fe081c 100644 --- a/docs/sdks/notifications/README.md +++ b/docs/sdks/notifications/README.md @@ -27,6 +27,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { notificationsGetNotifications } from "@lukehagar/discoursejs/funcs/notificationsGetNotifications.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await notificationsGetNotifications(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -66,6 +95,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { notificationsMarkNotificationsAsRead } from "@lukehagar/discoursejs/funcs/notificationsMarkNotificationsAsRead.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await notificationsMarkNotificationsAsRead(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/posts/README.md b/docs/sdks/posts/README.md index 2bdc7a6..27ff1de 100644 --- a/docs/sdks/posts/README.md +++ b/docs/sdks/posts/README.md @@ -37,6 +37,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsCreateTopicPostPM } from "@lukehagar/discoursejs/funcs/postsCreateTopicPostPM.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsCreateTopicPostPM(sdk, { + archetype: "private_message", + raw: "", + targetRecipients: "blake,sam", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -73,6 +106,36 @@ async function run() { }); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsDeletePost } from "@lukehagar/discoursejs/funcs/postsDeletePost.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsDeletePost(sdk, 928159, { + forceDestroy: true, + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -124,6 +187,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsGetPost } from "@lukehagar/discoursejs/funcs/postsGetPost.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsGetPost(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -164,6 +256,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsListPosts } from "@lukehagar/discoursejs/funcs/postsListPosts.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsListPosts(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -206,6 +327,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsLockPost } from "@lukehagar/discoursejs/funcs/postsLockPost.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsLockPost(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -249,6 +399,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsPerformPostAction } from "@lukehagar/discoursejs/funcs/postsPerformPostAction.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsPerformPostAction(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -291,6 +470,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsPostReplies } from "@lukehagar/discoursejs/funcs/postsPostReplies.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsPostReplies(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -331,6 +539,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { postsUpdatePost } from "@lukehagar/discoursejs/funcs/postsUpdatePost.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await postsUpdatePost(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/privatemessages/README.md b/docs/sdks/privatemessages/README.md index 321ae8d..c8e15eb 100644 --- a/docs/sdks/privatemessages/README.md +++ b/docs/sdks/privatemessages/README.md @@ -32,6 +32,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { privateMessagesCreateTopicPostPM } from "@lukehagar/discoursejs/funcs/privateMessagesCreateTopicPostPM.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await privateMessagesCreateTopicPostPM(sdk, { + archetype: "private_message", + raw: "", + targetRecipients: "blake,sam", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -72,6 +105,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { privateMessagesGetUserSentPrivateMessages } from "@lukehagar/discoursejs/funcs/privateMessagesGetUserSentPrivateMessages.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await privateMessagesGetUserSentPrivateMessages(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -112,6 +174,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { privateMessagesListUserPrivateMessages } from "@lukehagar/discoursejs/funcs/privateMessagesListUserPrivateMessages.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await privateMessagesListUserPrivateMessages(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index dc20db1..b7a0ca7 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -26,6 +26,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { searchSearch } from "@lukehagar/discoursejs/funcs/searchSearch.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await searchSearch(sdk, 1, "api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic"); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | Example | diff --git a/docs/sdks/site/README.md b/docs/sdks/site/README.md index 2b575ab..498dd30 100644 --- a/docs/sdks/site/README.md +++ b/docs/sdks/site/README.md @@ -26,6 +26,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { siteGetSite } from "@lukehagar/discoursejs/funcs/siteGetSite.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await siteGetSite(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/tags/README.md b/docs/sdks/tags/README.md index c0dc0cf..60de52e 100644 --- a/docs/sdks/tags/README.md +++ b/docs/sdks/tags/README.md @@ -31,6 +31,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsCreateTagGroup } from "@lukehagar/discoursejs/funcs/tagsCreateTagGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsCreateTagGroup(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -71,6 +100,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsGetTag } from "@lukehagar/discoursejs/funcs/tagsGetTag.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsGetTag(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -111,6 +169,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsGetTagGroup } from "@lukehagar/discoursejs/funcs/tagsGetTagGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsGetTagGroup(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -151,6 +238,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsListTagGroups } from "@lukehagar/discoursejs/funcs/tagsListTagGroups.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsListTagGroups(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -190,6 +306,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsListTags } from "@lukehagar/discoursejs/funcs/tagsListTags.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsListTags(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -229,6 +374,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { tagsUpdateTagGroup } from "@lukehagar/discoursejs/funcs/tagsUpdateTagGroup.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await tagsUpdateTagGroup(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/topics/README.md b/docs/sdks/topics/README.md index add4faf..9eb4f55 100644 --- a/docs/sdks/topics/README.md +++ b/docs/sdks/topics/README.md @@ -32,6 +32,34 @@ async function run() { await sdk.topics.bookmarkTopic("", "", ""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsBookmarkTopic } from "@lukehagar/discoursejs/funcs/topicsBookmarkTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsBookmarkTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -83,6 +111,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsCreateTopicPostPM } from "@lukehagar/discoursejs/funcs/topicsCreateTopicPostPM.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsCreateTopicPostPM(sdk, { + archetype: "private_message", + raw: "", + targetRecipients: "blake,sam", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -125,6 +186,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsCreateTopicTimer } from "@lukehagar/discoursejs/funcs/topicsCreateTopicTimer.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsCreateTopicTimer(sdk, "", "", "", { + time: "", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -168,6 +260,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsGetTopic } from "@lukehagar/discoursejs/funcs/topicsGetTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsGetTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -204,6 +325,34 @@ async function run() { await sdk.topics.getTopicByExternalId(""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsGetTopicByExternalId } from "@lukehagar/discoursejs/funcs/topicsGetTopicByExternalId.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsGetTopicByExternalId(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -249,6 +398,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsInviteToTopic } from "@lukehagar/discoursejs/funcs/topicsInviteToTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsInviteToTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -292,6 +470,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsListLatestTopics } from "@lukehagar/discoursejs/funcs/topicsListLatestTopics.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsListLatestTopics(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -335,6 +542,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsListTopTopics } from "@lukehagar/discoursejs/funcs/topicsListTopTopics.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsListTopTopics(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -371,6 +607,34 @@ async function run() { await sdk.topics.removeTopic("", "", ""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsRemoveTopic } from "@lukehagar/discoursejs/funcs/topicsRemoveTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsRemoveTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -418,6 +682,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsSetNotificationLevel } from "@lukehagar/discoursejs/funcs/topicsSetNotificationLevel.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsSetNotificationLevel(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -461,6 +754,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsUpdateTopic } from "@lukehagar/discoursejs/funcs/topicsUpdateTopic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsUpdateTopic(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -508,6 +830,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsUpdateTopicStatus } from "@lukehagar/discoursejs/funcs/topicsUpdateTopicStatus.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsUpdateTopicStatus(sdk, "", "", "", { + enabled: "true", + status: "visible", + until: "2030-12-31", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -553,6 +908,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { topicsUpdateTopicTimestamp } from "@lukehagar/discoursejs/funcs/topicsUpdateTopicTimestamp.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await topicsUpdateTopicTimestamp(sdk, "", "", "", { + timestamp: "1594291380", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/uploads/README.md b/docs/sdks/uploads/README.md index 2b5d97c..ab88696 100644 --- a/docs/sdks/uploads/README.md +++ b/docs/sdks/uploads/README.md @@ -46,6 +46,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsAbortMultipart } from "@lukehagar/discoursejs/funcs/uploadsAbortMultipart.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsAbortMultipart(sdk, { + externalUploadIdentifier: "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -114,6 +145,42 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsBatchPresignMultipartParts } from "@lukehagar/discoursejs/funcs/uploadsBatchPresignMultipartParts.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsBatchPresignMultipartParts(sdk, { + partNumbers: [ + 1, + 2, + 3, + ], + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -176,6 +243,40 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsCompleteExternalUpload } from "@lukehagar/discoursejs/funcs/uploadsCompleteExternalUpload.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsCompleteExternalUpload(sdk, { + forPrivateMessage: "true", + forSiteSetting: "true", + pasted: "true", + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -242,6 +343,47 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsCompleteMultipart } from "@lukehagar/discoursejs/funcs/uploadsCompleteMultipart.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsCompleteMultipart(sdk, { + parts: [ + { + "part_number": 1, + "etag": "0c376dcfcc2606f4335bbc732de93344", + }, + { + "part_number": 2, + "etag": "09ert8cfcc2606f4335bbc732de91122", + }, + ], + uniqueIdentifier: "66e86218-80d9-4bda-b4d5-2b6def968705", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -297,6 +439,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsCreateMultipartUpload } from "@lukehagar/discoursejs/funcs/uploadsCreateMultipartUpload.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsCreateMultipartUpload(sdk, { + fileName: "IMG_2021.jpeg", + fileSize: 4096, + uploadType: "card_background", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -337,6 +512,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsCreateUpload } from "@lukehagar/discoursejs/funcs/uploadsCreateUpload.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsCreateUpload(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -401,6 +605,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { uploadsGeneratePresignedPut } from "@lukehagar/discoursejs/funcs/uploadsGeneratePresignedPut.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await uploadsGeneratePresignedPut(sdk, { + fileName: "IMG_2021.jpeg", + fileSize: 4096, + type: "avatar", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index cb84ec0..ef11420 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -49,6 +49,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersActivateUser } from "@lukehagar/discoursejs/funcs/usersActivateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersActivateUser(sdk, 458565); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -89,6 +118,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersAdminGetUser } from "@lukehagar/discoursejs/funcs/usersAdminGetUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersAdminGetUser(sdk, 641278); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -131,6 +189,37 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersAdminListUsers } from "@lukehagar/discoursejs/funcs/usersAdminListUsers.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersAdminListUsers(sdk, { + flag: "blocked", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -171,6 +260,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersAnonymizeUser } from "@lukehagar/discoursejs/funcs/usersAnonymizeUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersAnonymizeUser(sdk, 976366); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -205,6 +323,34 @@ async function run() { await sdk.users.changePassword(""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersChangePassword } from "@lukehagar/discoursejs/funcs/usersChangePassword.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersChangePassword(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -251,6 +397,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersCreateUser } from "@lukehagar/discoursejs/funcs/usersCreateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersCreateUser(sdk, "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -293,6 +468,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersDeactivateUser } from "@lukehagar/discoursejs/funcs/usersDeactivateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersDeactivateUser(sdk, 495555); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -333,6 +537,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersDeleteUser } from "@lukehagar/discoursejs/funcs/usersDeleteUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersDeleteUser(sdk, 335223); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -374,6 +607,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersGetUser } from "@lukehagar/discoursejs/funcs/usersGetUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersGetUser(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -416,6 +678,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersGetUserEmails } from "@lukehagar/discoursejs/funcs/usersGetUserEmails.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersGetUserEmails(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -456,6 +747,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersGetUserExternalId } from "@lukehagar/discoursejs/funcs/usersGetUserExternalId.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersGetUserExternalId(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -498,6 +818,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersGetUserIdentiyProviderExternalId } from "@lukehagar/discoursejs/funcs/usersGetUserIdentiyProviderExternalId.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersGetUserIdentiyProviderExternalId(sdk, "", "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -541,6 +890,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersListUserActions } from "@lukehagar/discoursejs/funcs/usersListUserActions.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersListUserActions(sdk, "", 257087, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -583,6 +961,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersListUserBadges } from "@lukehagar/discoursejs/funcs/usersListUserBadges.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersListUserBadges(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -623,6 +1030,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersListUsersPublic } from "@lukehagar/discoursejs/funcs/usersListUsersPublic.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersListUsersPublic(sdk, "likes_given", "quarterly"); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -666,6 +1102,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersLogOutUser } from "@lukehagar/discoursejs/funcs/usersLogOutUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersLogOutUser(sdk, 141178); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -706,6 +1171,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersRefreshGravatar } from "@lukehagar/discoursejs/funcs/usersRefreshGravatar.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersRefreshGravatar(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -746,6 +1240,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersSendPasswordResetEmail } from "@lukehagar/discoursejs/funcs/usersSendPasswordResetEmail.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersSendPasswordResetEmail(sdk); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -789,6 +1312,38 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersSilenceUser } from "@lukehagar/discoursejs/funcs/usersSilenceUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersSilenceUser(sdk, 212223, { + postAction: "delete", + silencedTill: "2022-06-01T08:00:00.000Z", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -834,6 +1389,39 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersSuspendUser } from "@lukehagar/discoursejs/funcs/usersSuspendUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersSuspendUser(sdk, 192215, { + postAction: "delete", + reason: "", + suspendUntil: "2121-02-22", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -875,6 +1463,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersUpdateAvatar } from "@lukehagar/discoursejs/funcs/usersUpdateAvatar.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersUpdateAvatar(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -910,6 +1527,34 @@ async function run() { await sdk.users.updateEmail(""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersUpdateEmail } from "@lukehagar/discoursejs/funcs/usersUpdateEmail.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersUpdateEmail(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); @@ -956,6 +1601,35 @@ async function run() { run(); ``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersUpdateUser } from "@lukehagar/discoursejs/funcs/usersUpdateUser.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersUpdateUser(sdk, "", "", ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result) +} + +run(); +``` + ### Parameters | Parameter | Type | Required | Description | @@ -993,6 +1667,34 @@ async function run() { await sdk.users.updateUsername(""); +} + +run(); +``` + + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@lukehagar/discoursejs/core.js"; +import { usersUpdateUsername } from "@lukehagar/discoursejs/funcs/usersUpdateUsername.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore(); + +async function run() { + const res = await usersUpdateUsername(sdk, ""); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + } run(); diff --git a/gen.yaml b/gen.yaml index 979df33..6044c2d 100644 --- a/gen.yaml +++ b/gen.yaml @@ -11,7 +11,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.6.1 + version: 0.6.2 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/jsr.json b/jsr.json index 38928e0..082e482 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@lukehagar/discoursejs", - "version": "0.6.1", + "version": "0.6.2", "exports": { ".": "./src/index.ts", "./sdk/models/errors": "./src/sdk/models/errors/index.ts", diff --git a/package.json b/package.json index 178e3f8..2e46b5f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@lukehagar/discoursejs", - "version": "0.6.1", + "version": "0.6.2", "author": "LukeHagar", "main": "./index.js", "sideEffects": false, diff --git a/src/lib/config.ts b/src/lib/config.ts index 6cfb37e..2517e6d 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "latest", - sdkVersion: "0.6.1", - genVersion: "2.393.4", - userAgent: "speakeasy-sdk/typescript 0.6.1 2.393.4 latest @lukehagar/discoursejs", + sdkVersion: "0.6.2", + genVersion: "2.399.0", + userAgent: "speakeasy-sdk/typescript 0.6.2 2.399.0 latest @lukehagar/discoursejs", } as const;