LukeParke/discoursejs
1
0
Fork 0
mirror of https://github.com/LukeHagar/discoursejs.git synced 2025-12-09 20:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.148.0

Browse Source
This commit is contained in:
speakeasybot
2024-01-19 20:24:06 +00:00
parent 54184e1bde
commit 66e4641bb6
41 changed files with 204 additions and 1772 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/sdks/admin/README.md
View File

@@ -25,12 +25,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ActivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 203554;
const res = await sdk.admin.activateUser(id);
@@ -71,12 +66,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { AdminGetUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 386776;
const res = await sdk.admin.adminGetUser(id);
@@ -117,12 +107,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Flag, QueryParamAsc, QueryParamOrder } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.admin.adminListUsers({
flag: Flag.New,
@@ -164,12 +149,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { AnonymizeUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 418778;
const res = await sdk.admin.anonymizeUser(id);
@@ -210,12 +190,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeactivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 143950;
const res = await sdk.admin.deactivateUser(id);
@@ -256,12 +231,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeleteUserRequest, DeleteUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 251343;
const requestBody: DeleteUserRequestBody = {};
@@ -304,12 +274,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { LogOutUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 379568;
const res = await sdk.admin.logOutUser(id);
@@ -350,12 +315,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { RefreshGravatarRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.admin.refreshGravatar(username);
@@ -396,12 +356,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SilenceUserRequest, SilenceUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 606247;
const requestBody: SilenceUserRequestBody = {
postAction: "delete",
@@ -447,12 +402,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SuspendUserRequest, SuspendUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 970832;
const requestBody: SuspendUserRequestBody = {
postAction: "delete",

28
docs/sdks/backups/README.md
View File

@@ -18,12 +18,7 @@ Create backup
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.backups.createBackup({
withUploads: false,
@@ -65,12 +60,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DownloadBackupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const filename: string = "string";
const token: string = "string";
@@ -112,12 +102,7 @@ List backups
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.backups.getBackups();
@@ -156,12 +141,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SendDownloadBackupEmailRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const filename: string = "string";
const res = await sdk.backups.sendDownloadBackupEmail(filename);

35
docs/sdks/badges/README.md
View File

@@ -19,12 +19,7 @@ List badges
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.badges.adminListBadges();
@@ -62,12 +57,7 @@ Create badge
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.badges.createBadge({
badgeTypeId: 190613,
@@ -110,12 +100,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeleteBadgeRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 32345;
const res = await sdk.badges.deleteBadge(id);
@@ -156,12 +141,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListUserBadgesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.badges.listUserBadges(username);
@@ -202,12 +182,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateBadgeRequest, UpdateBadgeRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 280628;
const requestBody: UpdateBadgeRequestBody = {
badgeTypeId: 568845,

42
docs/sdks/categories/README.md
View File

@@ -20,12 +20,7 @@ Creates a category
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.categories.createCategory({
color: "49d9e9",
@@ -75,12 +70,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetCategoryRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 39147;
const res = await sdk.categories.getCategory(id);
@@ -120,12 +110,7 @@ Can be used to fetch all categories and subcategories
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.categories.getSite();
@@ -164,12 +149,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListCategoriesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const includeSubcategories: boolean = false;
const res = await sdk.categories.listCategories(includeSubcategories);
@@ -210,12 +190,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListCategoryTopicsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 394133;
const slug: string = "string";
@@ -258,12 +233,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateCategoryRequest, UpdateCategoryRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 353500;
const requestBody: UpdateCategoryRequestBody = {
color: "49d9e9",

56
docs/sdks/groups/README.md
View File

@@ -23,12 +23,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { AddGroupMembersRequest, AddGroupMembersRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 985975;
const requestBody: AddGroupMembersRequestBody = {
usernames: "username1,username2",
@@ -72,12 +67,7 @@ Create a group
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.groups.createGroup({
group: {
@@ -136,12 +126,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeleteGroupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 21302;
const res = await sdk.groups.deleteGroup(id);
@@ -182,12 +167,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetGroupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const res = await sdk.groups.getGroup(id);
@@ -228,12 +208,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListGroupMembersRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const res = await sdk.groups.listGroupMembers(id);
@@ -273,12 +248,7 @@ List groups
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.groups.listGroups();
@@ -317,12 +287,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { RemoveGroupMembersRequest, RemoveGroupMembersRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 649523;
const requestBody: RemoveGroupMembersRequestBody = {
usernames: "username1,username2",
@@ -367,12 +332,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateGroupGroup, UpdateGroupRequest, UpdateGroupRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 438471;
const requestBody: UpdateGroupRequestBody = {
group: {

14
docs/sdks/invites/README.md
View File

@@ -17,12 +17,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { CreateInviteRequest, CreateInviteRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const requestBody: CreateInviteRequestBody = {
@@ -72,12 +67,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { InviteToTopicRequest, InviteToTopicRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";

14
docs/sdks/notifications/README.md
View File

@@ -16,12 +16,7 @@ Get the notifications that belong to the current user
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.notifications.getNotifications();
@@ -59,12 +54,7 @@ Mark notifications as read
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.notifications.markNotificationsAsRead({});

56
docs/sdks/posts/README.md
View File

@@ -22,12 +22,7 @@ Creates a new topic, a new post, or a private message
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.posts.createTopicPostPM({
archetype: "private_message",
@@ -71,12 +66,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeletePostRequest, DeletePostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 188146;
const requestBody: DeletePostRequestBody = {
forceDestroy: true,
@@ -126,12 +116,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetPostRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const res = await sdk.posts.getPost(id);
@@ -172,12 +157,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListPostsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const before: string = "string";
@@ -222,12 +202,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { LockPostRequest, LockPostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -276,12 +251,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { PerformPostActionRequest, PerformPostActionRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const requestBody: PerformPostActionRequestBody = {
@@ -329,12 +299,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { PostRepliesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const res = await sdk.posts.postReplies(id);
@@ -375,12 +340,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Post, UpdatePostRequest, UpdatePostRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const requestBody: UpdatePostRequestBody = {
post: {

21
docs/sdks/privatemessages/README.md
View File

@@ -17,12 +17,7 @@ Creates a new topic, a new post, or a private message
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.privateMessages.createTopicPostPM({
archetype: "private_message",
@@ -66,12 +61,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetUserSentPrivateMessagesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.privateMessages.getUserSentPrivateMessages(username);
@@ -112,12 +102,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListUserPrivateMessagesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.privateMessages.listUserPrivateMessages(username);

7
docs/sdks/search/README.md
View File

@@ -16,12 +16,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SearchRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const page: number = 307631;
const q: string = "string";

7
docs/sdks/site/README.md
View File

@@ -15,12 +15,7 @@ Can be used to fetch all categories and subcategories
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.site.getSite();

42
docs/sdks/tags/README.md
View File

@@ -20,12 +20,7 @@ Creates a tag group
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.tags.createTagGroup({
name: "string",
@@ -67,12 +62,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetTagRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const name: string = "string";
const res = await sdk.tags.getTag(name);
@@ -113,12 +103,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetTagGroupRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const res = await sdk.tags.getTagGroup(id);
@@ -158,12 +143,7 @@ Get a list of tag groups
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.tags.listTagGroups();
@@ -201,12 +181,7 @@ Get a list of tags
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.tags.listTags();
@@ -245,12 +220,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateTagGroupRequest, UpdateTagGroupRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: string = "string";
const requestBody: UpdateTagGroupRequestBody = {};

91
docs/sdks/topics/README.md
View File

@@ -28,12 +28,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { BookmarkTopicRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -77,12 +72,7 @@ Creates a new topic, a new post, or a private message
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.topics.createTopicPostPM({
archetype: "private_message",
@@ -126,12 +116,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { CreateTopicTimerRequest, CreateTopicTimerRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -180,12 +165,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetTopicRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -230,12 +210,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetTopicByExternalIdRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const externalId: string = "string";
const res = await sdk.topics.getTopicByExternalId(externalId);
@@ -276,12 +251,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { InviteToTopicRequest, InviteToTopicRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -328,12 +298,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListLatestTopicsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const ascending: string = "string";
@@ -380,12 +345,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListTopTopicsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const period: string = "string";
@@ -430,12 +390,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { RemoveTopicRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -480,12 +435,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { NotificationLevel, SetNotificationLevelRequest, SetNotificationLevelRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -534,12 +484,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Topic, UpdateTopicRequest, UpdateTopicRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -588,12 +533,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Enabled, Status, UpdateTopicStatusRequest, UpdateTopicStatusRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";
@@ -644,12 +584,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateTopicTimestampRequest, UpdateTopicTimestampRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const id: string = "string";

49
docs/sdks/uploads/README.md
View File

@@ -33,12 +33,7 @@ be set to true for this endpoint to function.
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.abortMultipart({
externalUploadIdentifier: "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ",
@@ -100,12 +95,7 @@ be set to true for this endpoint to function.
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.batchPresignMultipartParts({
partNumbers: [
@@ -168,12 +158,7 @@ be set to true for this endpoint to function.
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.completeExternalUpload({
forPrivateMessage: "true",
@@ -231,12 +216,7 @@ be set to true for this endpoint to function.
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.completeMultipart({
parts: [
@@ -293,12 +273,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UploadType } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.createMultipartUpload({
fileName: "IMG_2021.jpeg",
@@ -343,12 +318,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { TypeT } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.createUpload({
file: {
@@ -414,12 +384,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GeneratePresignedPutType } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.uploads.generatePresignedPut({
fileName: "IMG_2021.jpeg",

168
docs/sdks/users/README.md
View File

@@ -39,12 +39,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ActivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 203554;
const res = await sdk.users.activateUser(id);
@@ -85,12 +80,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { AdminGetUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 386776;
const res = await sdk.users.adminGetUser(id);
@@ -131,12 +121,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Flag, QueryParamAsc, QueryParamOrder } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.users.adminListUsers({
flag: Flag.New,
@@ -178,12 +163,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { AnonymizeUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 418778;
const res = await sdk.users.anonymizeUser(id);
@@ -224,12 +204,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ChangePasswordRequest, ChangePasswordRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const token: string = "string";
const requestBody: ChangePasswordRequestBody = {
password: "Gm1zHM7WngzsMbv",
@@ -275,12 +250,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { CreateUserRequest, CreateUserRequestBody, ExternalIds } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const requestBody: CreateUserRequestBody = {
@@ -331,12 +301,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeactivateUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 143950;
const res = await sdk.users.deactivateUser(id);
@@ -377,12 +342,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { DeleteUserRequest, DeleteUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 251343;
const requestBody: DeleteUserRequestBody = {};
@@ -425,12 +385,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const username: string = "string";
@@ -475,12 +430,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetUserEmailsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.users.getUserEmails(username);
@@ -521,12 +471,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetUserExternalIdRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const externalId: string = "string";
@@ -571,12 +516,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { GetUserIdentiyProviderExternalIdRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const externalId: string = "string";
@@ -623,12 +563,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListUserActionsRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const filter: string = "string";
const offset: number = 620550;
const username: string = "string";
@@ -673,12 +608,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { ListUserBadgesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.users.listUserBadges(username);
@@ -719,12 +649,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { Asc, ListUsersPublicRequest, Order, Period } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const order: Order = Order.TopicCount;
const period: Period = Period.Monthly;
const asc: Asc = Asc.True;
@@ -771,12 +696,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { LogOutUserRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 379568;
const res = await sdk.users.logOutUser(id);
@@ -817,12 +737,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { RefreshGravatarRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const res = await sdk.users.refreshGravatar(username);
@@ -862,12 +777,7 @@ Send password reset email
import { SDK } from "@lukehagar/discoursejs";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const res = await sdk.users.sendPasswordResetEmail({
login: "string",
@@ -909,12 +819,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SilenceUserRequest, SilenceUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 606247;
const requestBody: SilenceUserRequestBody = {
postAction: "delete",
@@ -960,12 +865,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { SuspendUserRequest, SuspendUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const id: number = 970832;
const requestBody: SuspendUserRequestBody = {
postAction: "delete",
@@ -1012,12 +912,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateAvatarRequest, UpdateAvatarRequestBody, UpdateAvatarType } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const requestBody: UpdateAvatarRequestBody = {
type: UpdateAvatarType.Gravatar,
@@ -1063,12 +958,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateEmailRequest, UpdateEmailRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const requestBody: UpdateEmailRequestBody = {
email: "Jodie.Reichel79@yahoo.com",
@@ -1113,12 +1003,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateUserExternalIds, UpdateUserRequest, UpdateUserRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const apiKey: string = "string";
const apiUsername: string = "string";
const username: string = "string";
@@ -1167,12 +1052,7 @@ import { SDK } from "@lukehagar/discoursejs";
import { UpdateUsernameRequest, UpdateUsernameRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";
async function run() {
const sdk = new SDK({
security: {
key: "<YOUR_API_KEY_HERE>",
username: "<YOUR_API_KEY_HERE>",
},
});
const sdk = new SDK();
const username: string = "string";
const requestBody: UpdateUsernameRequestBody = {
newUsername: "string",