mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 04:19:37 +00:00
ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.368.0
This commit is contained in:
speakeasybot
@@ -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
|
||||
|
||||
102
FUNCTIONS.md
Normal file
102
FUNCTIONS.md
Normal file
@@ -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<Value, Error>` 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 "<sdk-package-name>";
|
||||
import { fetchSomething } from "<sdk-package-name>/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).
|
||||
120
README.md
120
README.md
@@ -475,6 +475,126 @@ const sdk = new SDK({ debugLogger: console });
|
||||
```
|
||||
<!-- End Debugging [debug] -->
|
||||
|
||||
<!-- Start Standalone functions [standalone-funcs] -->
|
||||
## 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).
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Available standalone functions</summary>
|
||||
|
||||
- [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)
|
||||
|
||||
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
12
RELEASES.md
12
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 - .
|
||||
- [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 - .
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
external upload initialized
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AbortMultipartResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AbortMultipartResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# ActionsSummary
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ActionsSummary = {
|
||||
id: 63553,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# ActivateUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActivateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ActivateUserRequest = {
|
||||
id: 881736,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActivateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ActivateUserResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# AddGroupMembersRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddGroupMembersRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AddGroupMembersRequestBody = {
|
||||
usernames: "username1,username2",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,17 @@
|
||||
|
||||
success response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddGroupMembersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AddGroupMembersResponseBody = {
|
||||
emails: ["<value>"],
|
||||
success: "<value>",
|
||||
usernames: ["<value>"],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,24 @@
|
||||
# AdminBadges
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminBadges } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminBadges = {
|
||||
badgeGroupingIds: ["<value>"],
|
||||
badgeIds: ["<value>"],
|
||||
badgeTypeIds: ["<value>"],
|
||||
protectedSystemFields: ["<value>"],
|
||||
triggers: {
|
||||
none: 544883,
|
||||
postAction: 847252,
|
||||
postRevision: 423655,
|
||||
trustLevelChange: 623564,
|
||||
userChange: 645894,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# AdminGetUserExternalIds
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminGetUserExternalIds } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminGetUserExternalIds = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# AdminGetUserGroups
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminGetUserGroups } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminGetUserGroups = {
|
||||
allowMembershipRequests: false,
|
||||
automatic: false,
|
||||
bioCooked: "<value>",
|
||||
bioExcerpt: "<value>",
|
||||
bioRaw: "<value>",
|
||||
canAdminGroup: false,
|
||||
canSeeMembers: false,
|
||||
defaultNotificationLevel: 533206,
|
||||
displayName: "Verlie.Feeney",
|
||||
flairBgColor: "<value>",
|
||||
flairColor: "<value>",
|
||||
flairUrl: "<value>",
|
||||
fullName: "Ada Moen IV",
|
||||
grantTrustLevel: "<value>",
|
||||
hasMessages: false,
|
||||
id: 301575,
|
||||
incomingEmail: "<value>",
|
||||
membersVisibilityLevel: 716075,
|
||||
membershipRequestTemplate: "<value>",
|
||||
mentionableLevel: 660174,
|
||||
messageableLevel: 287991,
|
||||
name: "<value>",
|
||||
primaryGroup: false,
|
||||
publicAdmission: false,
|
||||
publicExit: false,
|
||||
publishReadState: false,
|
||||
title: "<value>",
|
||||
userCount: 290077,
|
||||
visibilityLevel: 383462,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# AdminGetUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminGetUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminGetUserRequest = {
|
||||
id: 965417,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 919483,
|
||||
name: "<value>",
|
||||
username: "Felix_Ratke",
|
||||
},
|
||||
avatarTemplate: "<value>",
|
||||
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: "<value>",
|
||||
createdAtAge: 9046.48,
|
||||
daysVisited: 868126,
|
||||
externalIds: {},
|
||||
flagsGivenCount: 37559,
|
||||
flagsReceivedCount: 162493,
|
||||
fullSuspendReason: "<value>",
|
||||
groups: [
|
||||
{
|
||||
allowMembershipRequests: false,
|
||||
automatic: false,
|
||||
bioCooked: "<value>",
|
||||
bioExcerpt: "<value>",
|
||||
bioRaw: "<value>",
|
||||
canAdminGroup: false,
|
||||
canSeeMembers: false,
|
||||
defaultNotificationLevel: 508315,
|
||||
displayName: "Levi77",
|
||||
flairBgColor: "<value>",
|
||||
flairColor: "<value>",
|
||||
flairUrl: "<value>",
|
||||
fullName: "Ervin Schoen",
|
||||
grantTrustLevel: "<value>",
|
||||
hasMessages: false,
|
||||
id: 139972,
|
||||
incomingEmail: "<value>",
|
||||
membersVisibilityLevel: 407183,
|
||||
membershipRequestTemplate: "<value>",
|
||||
mentionableLevel: 33222,
|
||||
messageableLevel: 69167,
|
||||
name: "<value>",
|
||||
primaryGroup: false,
|
||||
publicAdmission: false,
|
||||
publicExit: false,
|
||||
publishReadState: false,
|
||||
title: "<value>",
|
||||
userCount: 982575,
|
||||
visibilityLevel: 697429,
|
||||
},
|
||||
],
|
||||
id: 373291,
|
||||
ipAddress: "116.107.184.12",
|
||||
lastEmailedAge: 8663.83,
|
||||
lastEmailedAt: "<value>",
|
||||
lastSeenAge: 3654.96,
|
||||
lastSeenAt: "<value>",
|
||||
likeCount: 975522,
|
||||
likeGivenCount: 16627,
|
||||
manualLockedTrustLevel: "<value>",
|
||||
moderator: false,
|
||||
name: "<value>",
|
||||
postCount: 855804,
|
||||
postsReadCount: 230742,
|
||||
primaryGroupId: "<value>",
|
||||
privateTopicsCount: 11714,
|
||||
registrationIpAddress: "<value>",
|
||||
resetBounceScoreAfter: "<value>",
|
||||
silenceReason: "<value>",
|
||||
silencedBy: "<value>",
|
||||
singleSignOnRecord: "<value>",
|
||||
staged: false,
|
||||
suspendedBy: "<value>",
|
||||
timeRead: 764912,
|
||||
title: "<value>",
|
||||
topicCount: 359978,
|
||||
topicsEntered: 944124,
|
||||
trustLevel: 729991,
|
||||
username: "Nelson_DAmore",
|
||||
warningsReceivedCount: 489549,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,68 @@
|
||||
|
||||
success response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminListBadgesResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminListBadgesResponseBody = {
|
||||
adminBadges: {
|
||||
badgeGroupingIds: ["<value>"],
|
||||
badgeIds: ["<value>"],
|
||||
badgeTypeIds: ["<value>"],
|
||||
protectedSystemFields: ["<value>"],
|
||||
triggers: {
|
||||
none: 925597,
|
||||
postAction: 836079,
|
||||
postRevision: 71036,
|
||||
trustLevelChange: 337396,
|
||||
userChange: 87129,
|
||||
},
|
||||
},
|
||||
badgeGroupings: [
|
||||
{
|
||||
description: "Profit-focused 3rd generation framework",
|
||||
id: 832620,
|
||||
name: "<value>",
|
||||
position: 957156,
|
||||
system: false,
|
||||
},
|
||||
],
|
||||
badgeTypes: [
|
||||
{
|
||||
id: 778157,
|
||||
name: "<value>",
|
||||
sortOrder: 140350,
|
||||
},
|
||||
],
|
||||
badges: [
|
||||
{
|
||||
allowTitle: false,
|
||||
autoRevoke: false,
|
||||
badgeGroupingId: 870013,
|
||||
badgeTypeId: 870088,
|
||||
description: "Virtual holistic projection",
|
||||
enabled: false,
|
||||
grantCount: 800911,
|
||||
icon: "<value>",
|
||||
id: 461479,
|
||||
imageUrl: "<value>",
|
||||
listable: false,
|
||||
longDescription: "<value>",
|
||||
manuallyGrantable: false,
|
||||
multipleGrant: false,
|
||||
name: "<value>",
|
||||
query: "<value>",
|
||||
showPosts: false,
|
||||
slug: "<value>",
|
||||
system: false,
|
||||
targetPosts: false,
|
||||
trigger: 520478,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# AdminListUsersRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminListUsersRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminListUsersRequest = {
|
||||
flag: "new",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,35 @@
|
||||
# AdminListUsersResponseBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdminListUsersResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AdminListUsersResponseBody = {
|
||||
active: false,
|
||||
admin: false,
|
||||
avatarTemplate: "<value>",
|
||||
createdAt: "<value>",
|
||||
createdAtAge: 1794.9,
|
||||
daysVisited: 18521,
|
||||
id: 170986,
|
||||
lastEmailedAge: 7936.98,
|
||||
lastEmailedAt: "<value>",
|
||||
lastSeenAge: 4634.51,
|
||||
lastSeenAt: "<value>",
|
||||
manualLockedTrustLevel: "<value>",
|
||||
moderator: false,
|
||||
name: "<value>",
|
||||
postCount: 223924,
|
||||
postsReadCount: 874573,
|
||||
staged: false,
|
||||
timeRead: 345352,
|
||||
title: "<value>",
|
||||
topicsEntered: 944120,
|
||||
trustLevel: 928082,
|
||||
username: "Leo.Purdy",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# AnonymizeUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AnonymizeUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AnonymizeUserRequest = {
|
||||
id: 783645,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,16 @@
|
||||
|
||||
response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AnonymizeUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: AnonymizeUserResponseBody = {
|
||||
success: "<value>",
|
||||
username: "Casimer.Kutch",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,17 @@
|
||||
# ApprovedBy
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApprovedBy } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ApprovedBy = {
|
||||
avatarTemplate: "<value>",
|
||||
id: 692532,
|
||||
name: "<value>",
|
||||
username: "Lafayette_Reinger",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# Archetypes
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Archetypes } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: Archetypes = {
|
||||
id: "<id>",
|
||||
name: "<value>",
|
||||
options: ["<value>"],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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 |
|
||||
```typescript
|
||||
"true"
|
||||
```
|
||||
@@ -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: "<value>",
|
||||
id: 537373,
|
||||
imageUrl: "<value>",
|
||||
listable: false,
|
||||
longDescription: "<value>",
|
||||
manuallyGrantable: false,
|
||||
multipleGrant: false,
|
||||
name: "<value>",
|
||||
query: "<value>",
|
||||
showPosts: false,
|
||||
slug: "<value>",
|
||||
system: false,
|
||||
targetPosts: false,
|
||||
trigger: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
position: 56713,
|
||||
system: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 568045,
|
||||
imageUrl: "<value>",
|
||||
listable: false,
|
||||
longDescription: "<value>",
|
||||
manuallyGrantable: false,
|
||||
multipleGrant: false,
|
||||
name: "<value>",
|
||||
query: "<value>",
|
||||
showPosts: false,
|
||||
slug: "<value>",
|
||||
system: false,
|
||||
targetPosts: false,
|
||||
trigger: 392785,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# BadgeTypes
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: BadgeTypes = {
|
||||
id: 963663,
|
||||
name: "<value>",
|
||||
sortOrder: 272656,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,41 @@
|
||||
# BasicGroup
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BasicGroup } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: BasicGroup = {
|
||||
allowMembershipRequests: false,
|
||||
automatic: false,
|
||||
bioCooked: "<value>",
|
||||
bioExcerpt: "<value>",
|
||||
bioRaw: "<value>",
|
||||
canAdminGroup: false,
|
||||
canSeeMembers: false,
|
||||
defaultNotificationLevel: 414369,
|
||||
flairBgColor: "<value>",
|
||||
flairColor: "<value>",
|
||||
flairUrl: "<value>",
|
||||
fullName: "Nellie Frami",
|
||||
grantTrustLevel: "<value>",
|
||||
hasMessages: false,
|
||||
id: 338007,
|
||||
incomingEmail: "<value>",
|
||||
membersVisibilityLevel: 110375,
|
||||
membershipRequestTemplate: "<value>",
|
||||
mentionableLevel: 674752,
|
||||
messageableLevel: 656330,
|
||||
name: "<value>",
|
||||
primaryGroup: false,
|
||||
publicAdmission: false,
|
||||
publicExit: false,
|
||||
publishReadState: false,
|
||||
title: "<value>",
|
||||
userCount: 317202,
|
||||
visibilityLevel: 138183,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# BasicTopic
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BasicTopic } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: BasicTopic = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
external upload initialized
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BatchPresignMultipartPartsResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: BatchPresignMultipartPartsResponseBody = {
|
||||
presignedUrls: {},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# BookmarkTopicRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BookmarkTopicRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: BookmarkTopicRequest = {
|
||||
apiKey: "<value>",
|
||||
apiUsername: "<value>",
|
||||
id: "<id>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,51 @@
|
||||
# Categories
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Categories } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: Categories = {
|
||||
canEdit: false,
|
||||
color: "olive",
|
||||
defaultListFilter: "<value>",
|
||||
defaultTopPeriod: "<value>",
|
||||
defaultView: "<value>",
|
||||
description: "Total systemic ability",
|
||||
descriptionExcerpt: "<value>",
|
||||
descriptionText: "<value>",
|
||||
hasChildren: false,
|
||||
id: 97258,
|
||||
minimumRequiredTags: 90233,
|
||||
name: "<value>",
|
||||
navigateToFirstPostAfterRead: false,
|
||||
notificationLevel: 497777,
|
||||
numFeaturedTopics: 619183,
|
||||
permission: 581082,
|
||||
position: 382440,
|
||||
postCount: 241557,
|
||||
readRestricted: false,
|
||||
showSubcategoryList: false,
|
||||
slug: "<value>",
|
||||
sortAscending: "<value>",
|
||||
sortOrder: "<value>",
|
||||
subcategoryIds: ["<value>"],
|
||||
subcategoryListStyle: "<value>",
|
||||
textColor: "<value>",
|
||||
topicCount: 96562,
|
||||
topicTemplate: "<value>",
|
||||
topicUrl: "<value>",
|
||||
topicsAllTime: 169025,
|
||||
topicsDay: 984934,
|
||||
topicsMonth: 859581,
|
||||
topicsWeek: 896582,
|
||||
topicsYear: 58534,
|
||||
uploadedBackground: "<value>",
|
||||
uploadedBackgroundDark: "<value>",
|
||||
uploadedLogo: "<value>",
|
||||
uploadedLogoDark: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
availableGroups: ["<value>"],
|
||||
canDelete: false,
|
||||
canEdit: false,
|
||||
color: "gold",
|
||||
customFields: {},
|
||||
defaultListFilter: "<value>",
|
||||
defaultSlowModeSeconds: "<value>",
|
||||
defaultTopPeriod: "<value>",
|
||||
defaultView: "<value>",
|
||||
description: "Public-key impactful moderator",
|
||||
descriptionExcerpt: "<value>",
|
||||
descriptionText: "<value>",
|
||||
emailIn: "<value>",
|
||||
emailInAllowStrangers: false,
|
||||
groupPermissions: [
|
||||
{
|
||||
groupName: "<value>",
|
||||
permissionType: 333965,
|
||||
},
|
||||
],
|
||||
hasChildren: false,
|
||||
id: 29100,
|
||||
mailinglistMirror: false,
|
||||
minimumRequiredTags: 790840,
|
||||
name: "<value>",
|
||||
navigateToFirstPostAfterRead: false,
|
||||
notificationLevel: 919532,
|
||||
numFeaturedTopics: 97243,
|
||||
permission: 542457,
|
||||
position: 442036,
|
||||
postCount: 991142,
|
||||
readOnlyBanner: "<value>",
|
||||
readRestricted: false,
|
||||
requiredTagGroups: [
|
||||
{
|
||||
minCount: 519952,
|
||||
name: "<value>",
|
||||
},
|
||||
],
|
||||
searchPriority: 383103,
|
||||
showSubcategoryList: false,
|
||||
slug: "<value>",
|
||||
sortAscending: "<value>",
|
||||
sortOrder: "<value>",
|
||||
subcategoryListStyle: "<value>",
|
||||
textColor: "<value>",
|
||||
topicCount: 693957,
|
||||
topicFeaturedLinkAllowed: false,
|
||||
topicTemplate: "<value>",
|
||||
topicUrl: "<value>",
|
||||
uploadedBackground: "<value>",
|
||||
uploadedBackgroundDark: "<value>",
|
||||
uploadedLogo: "<value>",
|
||||
uploadedLogoDark: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
defaultTopPeriod: "<value>",
|
||||
defaultView: "<value>",
|
||||
description: "Multi-layered holistic attitude",
|
||||
descriptionExcerpt: "<value>",
|
||||
descriptionText: "<value>",
|
||||
hasChildren: false,
|
||||
id: 479754,
|
||||
minimumRequiredTags: 457059,
|
||||
name: "<value>",
|
||||
navigateToFirstPostAfterRead: false,
|
||||
notificationLevel: 508390,
|
||||
numFeaturedTopics: 979963,
|
||||
permission: 967260,
|
||||
position: 423706,
|
||||
postCount: 99958,
|
||||
readRestricted: false,
|
||||
showSubcategoryList: false,
|
||||
slug: "<value>",
|
||||
sortAscending: "<value>",
|
||||
sortOrder: "<value>",
|
||||
subcategoryIds: ["<value>"],
|
||||
subcategoryListStyle: "<value>",
|
||||
textColor: "<value>",
|
||||
topicCount: 857125,
|
||||
topicTemplate: "<value>",
|
||||
topicUrl: "<value>",
|
||||
topicsAllTime: 39650,
|
||||
topicsDay: 117315,
|
||||
topicsMonth: 483706,
|
||||
topicsWeek: 271252,
|
||||
topicsYear: 458259,
|
||||
uploadedBackground: "<value>",
|
||||
uploadedBackgroundDark: "<value>",
|
||||
uploadedLogo: "<value>",
|
||||
uploadedLogoDark: "<value>",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# CensoredRegexp
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CensoredRegexp } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CensoredRegexp = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# ChangePasswordRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ChangePasswordRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ChangePasswordRequest = {
|
||||
token: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 289913,
|
||||
originalFilename: "<value>",
|
||||
retainHours: "<value>",
|
||||
shortPath: "<value>",
|
||||
shortUrl: "<value>",
|
||||
thumbnailHeight: 520875,
|
||||
thumbnailWidth: 577709,
|
||||
url: "http://sore-death.net",
|
||||
width: 684553,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 963741,
|
||||
originalFilename: "<value>",
|
||||
retainHours: "<value>",
|
||||
shortPath: "<value>",
|
||||
shortUrl: "<value>",
|
||||
thumbnailHeight: 735894,
|
||||
thumbnailWidth: 878601,
|
||||
url: "http://zany-subsidy.info",
|
||||
width: 441321,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# CreateBackupRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateBackupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateBackupRequestBody = {
|
||||
withUploads: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
success response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateBackupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateBackupResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# CreateBadgeBadgeTypes
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateBadgeBadgeTypes } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateBadgeBadgeTypes = {
|
||||
id: 944669,
|
||||
name: "<value>",
|
||||
sortOrder: 758616,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,15 @@
|
||||
# CreateBadgeRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateBadgeRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateBadgeRequestBody = {
|
||||
badgeTypeId: 780529,
|
||||
name: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 774234,
|
||||
imageUrl: "<value>",
|
||||
listable: false,
|
||||
longDescription: "<value>",
|
||||
manuallyGrantable: false,
|
||||
multipleGrant: false,
|
||||
name: "<value>",
|
||||
query: "<value>",
|
||||
showPosts: false,
|
||||
slug: "<value>",
|
||||
system: false,
|
||||
targetPosts: false,
|
||||
trigger: "<value>",
|
||||
},
|
||||
badgeTypes: [
|
||||
{
|
||||
id: 736918,
|
||||
name: "<value>",
|
||||
sortOrder: 456150,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,19 @@
|
||||
# CreateCategoryRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateCategoryRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateCategoryRequestBody = {
|
||||
color: "49d9e9",
|
||||
name: "<value>",
|
||||
permissions: {
|
||||
everyone: 1,
|
||||
},
|
||||
textColor: "f0fcfd",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
availableGroups: ["<value>"],
|
||||
canDelete: false,
|
||||
canEdit: false,
|
||||
color: "gold",
|
||||
customFields: {},
|
||||
defaultListFilter: "<value>",
|
||||
defaultSlowModeSeconds: "<value>",
|
||||
defaultTopPeriod: "<value>",
|
||||
defaultView: "<value>",
|
||||
description: "Compatible high-level contingency",
|
||||
descriptionExcerpt: "<value>",
|
||||
descriptionText: "<value>",
|
||||
emailIn: "<value>",
|
||||
emailInAllowStrangers: false,
|
||||
groupPermissions: [
|
||||
{
|
||||
groupName: "<value>",
|
||||
permissionType: 826825,
|
||||
},
|
||||
],
|
||||
hasChildren: false,
|
||||
id: 410301,
|
||||
mailinglistMirror: false,
|
||||
minimumRequiredTags: 539118,
|
||||
name: "<value>",
|
||||
navigateToFirstPostAfterRead: false,
|
||||
notificationLevel: 623295,
|
||||
numFeaturedTopics: 887265,
|
||||
permission: 886961,
|
||||
position: 880107,
|
||||
postCount: 618826,
|
||||
readOnlyBanner: "<value>",
|
||||
readRestricted: false,
|
||||
requiredTagGroups: [
|
||||
{
|
||||
minCount: 328303,
|
||||
name: "<value>",
|
||||
},
|
||||
],
|
||||
searchPriority: 133461,
|
||||
showSubcategoryList: false,
|
||||
slug: "<value>",
|
||||
sortAscending: "<value>",
|
||||
sortOrder: "<value>",
|
||||
subcategoryListStyle: "<value>",
|
||||
textColor: "<value>",
|
||||
topicCount: 404425,
|
||||
topicFeaturedLinkAllowed: false,
|
||||
topicTemplate: "<value>",
|
||||
topicUrl: "<value>",
|
||||
uploadedBackground: "<value>",
|
||||
uploadedBackgroundDark: "<value>",
|
||||
uploadedLogo: "<value>",
|
||||
uploadedLogoDark: "<value>",
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,17 @@
|
||||
# CreatedBy
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatedBy } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreatedBy = {
|
||||
avatarTemplate: "<value>",
|
||||
id: 392569,
|
||||
name: "<value>",
|
||||
username: "Sasha_Thiel19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# CreateGroupRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateGroupRequestBody = {
|
||||
group: {
|
||||
name: "<value>",
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
bioExcerpt: "<value>",
|
||||
bioRaw: "<value>",
|
||||
canAdminGroup: false,
|
||||
canSeeMembers: false,
|
||||
defaultNotificationLevel: 778346,
|
||||
flairBgColor: "<value>",
|
||||
flairColor: "<value>",
|
||||
flairUrl: "<value>",
|
||||
fullName: "Mandy Hills",
|
||||
grantTrustLevel: "<value>",
|
||||
hasMessages: false,
|
||||
id: 13571,
|
||||
incomingEmail: "<value>",
|
||||
membersVisibilityLevel: 97101,
|
||||
membershipRequestTemplate: "<value>",
|
||||
mentionableLevel: 622846,
|
||||
messageableLevel: 837945,
|
||||
name: "<value>",
|
||||
primaryGroup: false,
|
||||
publicAdmission: false,
|
||||
publicExit: false,
|
||||
publishReadState: false,
|
||||
title: "<value>",
|
||||
userCount: 673660,
|
||||
visibilityLevel: 96098,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,21 @@
|
||||
# CreateInviteRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateInviteRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateInviteRequest = {
|
||||
apiKey: "<value>",
|
||||
apiUsername: "<value>",
|
||||
requestBody: {
|
||||
email: "not-a-user-yet@example.com",
|
||||
groupIds: "42,43",
|
||||
groupNames: "foo,bar",
|
||||
maxRedemptionsAllowed: 5,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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: ["<value>"],
|
||||
id: 42,
|
||||
link: "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
|
||||
topics: ["<value>"],
|
||||
updatedAt: "2021-01-01T12:00:00.000Z",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# CreateTagGroupPermissions
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTagGroupPermissions } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTagGroupPermissions = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# CreateTagGroupRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTagGroupRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTagGroupRequestBody = {
|
||||
name: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
onePerTopic: false,
|
||||
parentTagName: ["<value>"],
|
||||
permissions: {},
|
||||
tagNames: ["<value>"],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,15 @@
|
||||
# CreateTopicPostPMActionsSummary
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTopicPostPMActionsSummary } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTopicPostPMActionsSummary = {
|
||||
canAct: false,
|
||||
id: 773456,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
# CreateTopicPostPMRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTopicPostPMRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTopicPostPMRequestBody = {
|
||||
archetype: "private_message",
|
||||
raw: "<value>",
|
||||
targetRecipients: "blake,sam",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
bookmarked: false,
|
||||
canDelete: false,
|
||||
canEdit: false,
|
||||
canRecover: false,
|
||||
canViewEditHistory: false,
|
||||
canWiki: false,
|
||||
cooked: "<value>",
|
||||
createdAt: "<value>",
|
||||
deletedAt: "<value>",
|
||||
displayUsername: "<value>",
|
||||
draftSequence: 456410,
|
||||
editReason: "<value>",
|
||||
flairBgColor: "<value>",
|
||||
flairColor: "<value>",
|
||||
flairName: "<value>",
|
||||
flairUrl: "<value>",
|
||||
hidden: false,
|
||||
id: 897277,
|
||||
incomingLinkCount: 153369,
|
||||
moderator: false,
|
||||
name: "<value>",
|
||||
postNumber: 332191,
|
||||
postType: 199596,
|
||||
primaryGroupName: "<value>",
|
||||
quoteCount: 712927,
|
||||
readersCount: 432984,
|
||||
reads: 426943,
|
||||
replyCount: 528234,
|
||||
replyToPostNumber: "<value>",
|
||||
reviewableId: "<value>",
|
||||
reviewableScoreCount: 301692,
|
||||
reviewableScorePendingCount: 349440,
|
||||
score: 70410,
|
||||
staff: false,
|
||||
topicId: 781480,
|
||||
topicSlug: "<value>",
|
||||
trustLevel: 421844,
|
||||
updatedAt: "<value>",
|
||||
userDeleted: false,
|
||||
userId: 751022,
|
||||
userTitle: "<value>",
|
||||
username: "Gilberto2",
|
||||
version: 350207,
|
||||
wiki: false,
|
||||
yours: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,19 @@
|
||||
# CreateTopicTimerRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTopicTimerRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTopicTimerRequest = {
|
||||
apiKey: "<value>",
|
||||
apiUsername: "<value>",
|
||||
requestBody: {
|
||||
time: "",
|
||||
},
|
||||
id: "<id>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# CreateTopicTimerRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTopicTimerRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTopicTimerRequestBody = {
|
||||
time: "",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
topic updated
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateTopicTimerResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateTopicTimerResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# CreateUploadRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateUploadRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateUploadRequestBody = {
|
||||
type: "custom_emoji",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 888616,
|
||||
originalFilename: "<value>",
|
||||
retainHours: "<value>",
|
||||
shortPath: "<value>",
|
||||
shortUrl: "<value>",
|
||||
thumbnailHeight: 810839,
|
||||
thumbnailWidth: 697274,
|
||||
url: "http://juvenile-cougar.biz",
|
||||
width: 59383,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,15 @@
|
||||
# CreateUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateUserRequest = {
|
||||
apiKey: "<value>",
|
||||
apiUsername: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,17 @@
|
||||
# CreateUserRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateUserRequestBody = {
|
||||
email: "Jennifer68@yahoo.com",
|
||||
name: "<value>",
|
||||
password: "9JOtcD2TrgaNLaS",
|
||||
username: "Lenny_Treutel46",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,17 @@
|
||||
|
||||
user created
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CreateUserResponseBody = {
|
||||
active: false,
|
||||
message: "<value>",
|
||||
success: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# CustomEmojiTranslation
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CustomEmojiTranslation } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CustomEmojiTranslation = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# CustomFields
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CustomFields } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: CustomFields = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# Data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Data } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: Data = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# DeactivateUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeactivateUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeactivateUserRequest = {
|
||||
id: 216897,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeactivateUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeactivateUserResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# DefaultDarkColorScheme
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DefaultDarkColorScheme } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DefaultDarkColorScheme = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# DeleteBadgeRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteBadgeRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteBadgeRequest = {
|
||||
id: 216550,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# DeleteGroupRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteGroupRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteGroupRequest = {
|
||||
id: 971945,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteGroupResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteGroupResponseBody = {
|
||||
success: "OK",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# DeletePostRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePostRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeletePostRequestBody = {
|
||||
forceDestroy: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# DeleteUserRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteUserRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteUserRequest = {
|
||||
id: 456015,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
# DeleteUserRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteUserRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteUserRequestBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
response
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteUserResponseBody } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DeleteUserResponseBody = {
|
||||
deleted: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 131903,
|
||||
name: "<value>",
|
||||
username: "Jerrell_Dooley27",
|
||||
},
|
||||
lastPoster: {
|
||||
avatarTemplate: "<value>",
|
||||
id: 97493,
|
||||
name: "<value>",
|
||||
username: "Judge39",
|
||||
},
|
||||
notificationLevel: 159845,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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: "<value>",
|
||||
id: 310381,
|
||||
name: "<value>",
|
||||
title: "<value>",
|
||||
username: "Drew_Hintz2",
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,15 @@
|
||||
# DownloadBackupRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DownloadBackupRequest } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: DownloadBackupRequest = {
|
||||
filename: "your_file_here",
|
||||
token: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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 |
|
||||
```typescript
|
||||
"true" | "false"
|
||||
```
|
||||
@@ -1,5 +1,12 @@
|
||||
# ExternalIds
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ExternalIds } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: ExternalIds = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# Extras
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Extras } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: Extras = {
|
||||
visibleGroupNames: ["<value>"],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 |
|
||||
```typescript
|
||||
"active" | "new" | "staff" | "suspended" | "blocked" | "suspect"
|
||||
```
|
||||
@@ -1,5 +1,12 @@
|
||||
# GeneratePresignedPutMetadata
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GeneratePresignedPutMetadata } from "@lukehagar/discoursejs/sdk/models/operations";
|
||||
|
||||
let value: GeneratePresignedPutMetadata = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 |
|
||||
```typescript
|
||||
"avatar" | "profile_background" | "card_background" | "custom_emoji" | "composer"
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user