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

ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.134.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-10 15:48:00 +00:00
parent 0231c2a428
commit 2af51a7827
589 changed files with 45363 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sdk/models/operations/abortmultipartrequestbody.md Normal file
View File

@@ -0,0 +1,8 @@
# AbortMultipartRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `externalUploadIdentifier` | *string* | :heavy_check_mark: | The identifier of the multipart upload in the external storage provider. This is the multipart upload_id in AWS S3. | 84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ |

11
docs/sdk/models/operations/abortmultipartresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AbortMultipartResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.AbortMultipartResponseBody](../../../sdk/models/operations/abortmultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |

10
docs/sdk/models/operations/abortmultipartresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# AbortMultipartResponseBody
external upload initialized
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `success` | *string* | :heavy_check_mark: | N/A | OK |

11
docs/sdk/models/operations/actionssummary.md Normal file
View File

@@ -0,0 +1,11 @@
# ActionsSummary
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `acted` | *boolean* | :heavy_minus_sign: | N/A |
| `canUndo` | *boolean* | :heavy_minus_sign: | N/A |
| `count` | *number* | :heavy_minus_sign: | N/A |
| `id` | *number* | :heavy_minus_sign: | N/A |

8
docs/sdk/models/operations/activateuserrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# ActivateUserRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/activateuserresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# ActivateUserResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.ActivateUserResponseBody](../../../sdk/models/operations/activateuserresponsebody.md) | :heavy_minus_sign: | response |

10
docs/sdk/models/operations/activateuserresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# ActivateUserResponseBody
response
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `success` | *string* | :heavy_check_mark: | N/A | OK |

9
docs/sdk/models/operations/addgroupmembersrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# AddGroupMembersRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | N/A |
| `requestBody` | [operations.AddGroupMembersRequestBody](../../../sdk/models/operations/addgroupmembersrequestbody.md) | :heavy_minus_sign: | N/A |

8
docs/sdk/models/operations/addgroupmembersrequestbody.md Normal file
View File

@@ -0,0 +1,8 @@
# AddGroupMembersRequestBody
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `usernames` | *string* | :heavy_minus_sign: | comma separated list | username1,username2 |

11
docs/sdk/models/operations/addgroupmembersresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AddGroupMembersResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.AddGroupMembersResponseBody](../../../sdk/models/operations/addgroupmembersresponsebody.md) | :heavy_minus_sign: | success response |

12
docs/sdk/models/operations/addgroupmembersresponsebody.md Normal file
View File

@@ -0,0 +1,12 @@
# AddGroupMembersResponseBody
success response
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `emails` | *any*[] | :heavy_check_mark: | N/A |
| `success` | *string* | :heavy_check_mark: | N/A |
| `usernames` | *any*[] | :heavy_check_mark: | N/A |

12
docs/sdk/models/operations/adminbadges.md Normal file
View File

@@ -0,0 +1,12 @@
# AdminBadges
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `badgeGroupingIds` | *any*[] | :heavy_check_mark: | N/A |
| `badgeIds` | *any*[] | :heavy_check_mark: | N/A |
| `badgeTypeIds` | *any*[] | :heavy_check_mark: | N/A |
| `protectedSystemFields` | *any*[] | :heavy_check_mark: | N/A |
| `triggers` | [operations.Triggers](../../../sdk/models/operations/triggers.md) | :heavy_check_mark: | N/A |

7
docs/sdk/models/operations/admingetuserexternalids.md Normal file
View File

@@ -0,0 +1,7 @@
# AdminGetUserExternalIds
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

37
docs/sdk/models/operations/admingetusergroups.md Normal file
View File

@@ -0,0 +1,37 @@
# AdminGetUserGroups
## Fields
| Field | Type | Required | Description |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `allowMembershipRequests` | *boolean* | :heavy_check_mark: | N/A |
| `automatic` | *boolean* | :heavy_check_mark: | N/A |
| `bioCooked` | *string* | :heavy_check_mark: | N/A |
| `bioExcerpt` | *string* | :heavy_check_mark: | N/A |
| `bioRaw` | *string* | :heavy_check_mark: | N/A |
| `canAdminGroup` | *boolean* | :heavy_check_mark: | N/A |
| `canSeeMembers` | *boolean* | :heavy_check_mark: | N/A |
| `defaultNotificationLevel` | *number* | :heavy_check_mark: | N/A |
| `displayName` | *string* | :heavy_check_mark: | N/A |
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
| `flairColor` | *string* | :heavy_check_mark: | N/A |
| `flairGroupId` | *string* | :heavy_minus_sign: | N/A |
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
| `fullName` | *string* | :heavy_check_mark: | N/A |
| `grantTrustLevel` | *string* | :heavy_check_mark: | N/A |
| `hasMessages` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `incomingEmail` | *string* | :heavy_check_mark: | N/A |
| `membersVisibilityLevel` | *number* | :heavy_check_mark: | N/A |
| `membershipRequestTemplate` | *string* | :heavy_check_mark: | N/A |
| `mentionableLevel` | *number* | :heavy_check_mark: | N/A |
| `messageableLevel` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `primaryGroup` | *boolean* | :heavy_check_mark: | N/A |
| `publicAdmission` | *boolean* | :heavy_check_mark: | N/A |
| `publicExit` | *boolean* | :heavy_check_mark: | N/A |
| `publishReadState` | *boolean* | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `userCount` | *number* | :heavy_check_mark: | N/A |
| `visibilityLevel` | *number* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/admingetuserpenaltycounts.md Normal file
View File

@@ -0,0 +1,10 @@
# AdminGetUserPenaltyCounts
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `silenced` | *number* | :heavy_check_mark: | N/A |
| `suspended` | *number* | :heavy_check_mark: | N/A |
| `total` | *number* | :heavy_check_mark: | N/A |

8
docs/sdk/models/operations/admingetuserrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminGetUserRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/admingetuserresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AdminGetUserResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.AdminGetUserResponseBody](../../../sdk/models/operations/admingetuserresponsebody.md) | :heavy_minus_sign: | response |

73
docs/sdk/models/operations/admingetuserresponsebody.md Normal file
View File

@@ -0,0 +1,73 @@
# AdminGetUserResponseBody
response
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `active` | *boolean* | :heavy_check_mark: | N/A |
| `admin` | *boolean* | :heavy_check_mark: | N/A |
| `apiKeyCount` | *number* | :heavy_check_mark: | N/A |
| `approvedBy` | [operations.ApprovedBy](../../../sdk/models/operations/approvedby.md) | :heavy_check_mark: | N/A |
| `associatedAccounts` | *any*[] | :heavy_minus_sign: | N/A |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `badgeCount` | *number* | :heavy_check_mark: | N/A |
| `bounceScore` | *number* | :heavy_check_mark: | N/A |
| `canActivate` | *boolean* | :heavy_check_mark: | N/A |
| `canBeAnonymized` | *boolean* | :heavy_check_mark: | N/A |
| `canBeDeleted` | *boolean* | :heavy_check_mark: | N/A |
| `canBeMerged` | *boolean* | :heavy_check_mark: | N/A |
| `canDeactivate` | *boolean* | :heavy_check_mark: | N/A |
| `canDeleteAllPosts` | *boolean* | :heavy_check_mark: | N/A |
| `canDeleteSsoRecord` | *boolean* | :heavy_check_mark: | N/A |
| `canDisableSecondFactor` | *boolean* | :heavy_check_mark: | N/A |
| `canGrantAdmin` | *boolean* | :heavy_check_mark: | N/A |
| `canGrantModeration` | *boolean* | :heavy_check_mark: | N/A |
| `canImpersonate` | *boolean* | :heavy_check_mark: | N/A |
| `canRevokeAdmin` | *boolean* | :heavy_check_mark: | N/A |
| `canRevokeModeration` | *boolean* | :heavy_check_mark: | N/A |
| `canSendActivationEmail` | *boolean* | :heavy_check_mark: | N/A |
| `canViewActionLogs` | *boolean* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_check_mark: | N/A |
| `createdAtAge` | *number* | :heavy_check_mark: | N/A |
| `daysVisited` | *number* | :heavy_check_mark: | N/A |
| `externalIds` | [operations.AdminGetUserExternalIds](../../../sdk/models/operations/admingetuserexternalids.md) | :heavy_check_mark: | N/A |
| `flagsGivenCount` | *number* | :heavy_check_mark: | N/A |
| `flagsReceivedCount` | *number* | :heavy_check_mark: | N/A |
| `fullSuspendReason` | *string* | :heavy_check_mark: | N/A |
| `groups` | [operations.AdminGetUserGroups](../../../sdk/models/operations/admingetusergroups.md)[] | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `ipAddress` | *string* | :heavy_check_mark: | N/A |
| `lastEmailedAge` | *number* | :heavy_check_mark: | N/A |
| `lastEmailedAt` | *string* | :heavy_check_mark: | N/A |
| `lastSeenAge` | *number* | :heavy_check_mark: | N/A |
| `lastSeenAt` | *string* | :heavy_check_mark: | N/A |
| `likeCount` | *number* | :heavy_check_mark: | N/A |
| `likeGivenCount` | *number* | :heavy_check_mark: | N/A |
| `manualLockedTrustLevel` | *string* | :heavy_check_mark: | N/A |
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `nextPenalty` | *string* | :heavy_minus_sign: | N/A |
| `penaltyCounts` | [operations.PenaltyCounts](../../../sdk/models/operations/penaltycounts.md) | :heavy_minus_sign: | N/A |
| `postCount` | *number* | :heavy_check_mark: | N/A |
| `postEditsCount` | *number* | :heavy_minus_sign: | N/A |
| `postsReadCount` | *number* | :heavy_check_mark: | N/A |
| `primaryGroupId` | *string* | :heavy_check_mark: | N/A |
| `privateTopicsCount` | *number* | :heavy_check_mark: | N/A |
| `registrationIpAddress` | *string* | :heavy_check_mark: | N/A |
| `resetBounceScoreAfter` | *string* | :heavy_check_mark: | N/A |
| `silenceReason` | *string* | :heavy_check_mark: | N/A |
| `silencedBy` | *string* | :heavy_check_mark: | N/A |
| `singleSignOnRecord` | *string* | :heavy_check_mark: | N/A |
| `staged` | *boolean* | :heavy_check_mark: | N/A |
| `suspendedBy` | *string* | :heavy_check_mark: | N/A |
| `timeRead` | *number* | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `tl3Requirements` | [operations.Tl3Requirements](../../../sdk/models/operations/tl3requirements.md) | :heavy_minus_sign: | N/A |
| `topicCount` | *number* | :heavy_check_mark: | N/A |
| `topicsEntered` | *number* | :heavy_check_mark: | N/A |
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |
| `warningsReceivedCount` | *number* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/adminlistbadgesresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AdminListBadgesResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.AdminListBadgesResponseBody](../../../sdk/models/operations/adminlistbadgesresponsebody.md) | :heavy_minus_sign: | success response |

13
docs/sdk/models/operations/adminlistbadgesresponsebody.md Normal file
View File

@@ -0,0 +1,13 @@
# AdminListBadgesResponseBody
success response
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `adminBadges` | [operations.AdminBadges](../../../sdk/models/operations/adminbadges.md) | :heavy_check_mark: | N/A |
| `badgeGroupings` | [operations.BadgeGroupings](../../../sdk/models/operations/badgegroupings.md)[] | :heavy_check_mark: | N/A |
| `badgeTypes` | [operations.BadgeTypes](../../../sdk/models/operations/badgetypes.md)[] | :heavy_check_mark: | N/A |
| `badges` | [operations.Badges](../../../sdk/models/operations/badges.md)[] | :heavy_check_mark: | N/A |

15
docs/sdk/models/operations/adminlistusersrequest.md Normal file
View File

@@ -0,0 +1,15 @@
# AdminListUsersRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `asc` | [operations.QueryParamAsc](../../../sdk/models/operations/queryparamasc.md) | :heavy_minus_sign: | N/A |
| `email` | *string* | :heavy_minus_sign: | Filter to the user with this email address |
| `flag` | [operations.Flag](../../../sdk/models/operations/flag.md) | :heavy_check_mark: | N/A |
| `ip` | *string* | :heavy_minus_sign: | Filter to users with this IP address |
| `order` | [operations.QueryParamOrder](../../../sdk/models/operations/queryparamorder.md) | :heavy_minus_sign: | N/A |
| `page` | *number* | :heavy_minus_sign: | N/A |
| `showEmails` | *boolean* | :heavy_minus_sign: | Include user email addresses in response. These requests will be logged in the staff action logs. |
| `stats` | *boolean* | :heavy_minus_sign: | Include user stats information |

11
docs/sdk/models/operations/adminlistusersresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AdminListUsersResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `responseBodies` | [operations.AdminListUsersResponseBody](../../../sdk/models/operations/adminlistusersresponsebody.md)[] | :heavy_minus_sign: | response |

31
docs/sdk/models/operations/adminlistusersresponsebody.md Normal file
View File

@@ -0,0 +1,31 @@
# AdminListUsersResponseBody
## Fields
| Field | Type | Required | Description |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `active` | *boolean* | :heavy_check_mark: | N/A |
| `admin` | *boolean* | :heavy_check_mark: | N/A |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_check_mark: | N/A |
| `createdAtAge` | *number* | :heavy_check_mark: | N/A |
| `daysVisited` | *number* | :heavy_check_mark: | N/A |
| `email` | *string* | :heavy_minus_sign: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `lastEmailedAge` | *number* | :heavy_check_mark: | N/A |
| `lastEmailedAt` | *string* | :heavy_check_mark: | N/A |
| `lastSeenAge` | *number* | :heavy_check_mark: | N/A |
| `lastSeenAt` | *string* | :heavy_check_mark: | N/A |
| `manualLockedTrustLevel` | *string* | :heavy_check_mark: | N/A |
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `postCount` | *number* | :heavy_check_mark: | N/A |
| `postsReadCount` | *number* | :heavy_check_mark: | N/A |
| `secondaryEmails` | *any*[] | :heavy_minus_sign: | N/A |
| `staged` | *boolean* | :heavy_check_mark: | N/A |
| `timeRead` | *number* | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `topicsEntered` | *number* | :heavy_check_mark: | N/A |
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

8
docs/sdk/models/operations/anonymizeuserrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# AnonymizeUserRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/anonymizeuserresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AnonymizeUserResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.AnonymizeUserResponseBody](../../../sdk/models/operations/anonymizeuserresponsebody.md) | :heavy_minus_sign: | response |

11
docs/sdk/models/operations/anonymizeuserresponsebody.md Normal file
View File

@@ -0,0 +1,11 @@
# AnonymizeUserResponseBody
response
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `success` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/approvedby.md Normal file
View File

@@ -0,0 +1,11 @@
# ApprovedBy
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/archetypes.md Normal file
View File

@@ -0,0 +1,10 @@
# Archetypes
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `options` | *any*[] | :heavy_check_mark: | N/A |

8
docs/sdk/models/operations/asc.md Normal file
View File

@@ -0,0 +1,8 @@
# Asc
## Values
| Name | Value |
| ------ | ------ |
| `True` | true |

28
docs/sdk/models/operations/badge.md Normal file
View File

@@ -0,0 +1,28 @@
# Badge
## Fields
| Field | Type | Required | Description |
| ------------------- | ------------------- | ------------------- | ------------------- |
| `allowTitle` | *boolean* | :heavy_check_mark: | N/A |
| `autoRevoke` | *boolean* | :heavy_check_mark: | N/A |
| `badgeGroupingId` | *number* | :heavy_check_mark: | N/A |
| `badgeTypeId` | *number* | :heavy_check_mark: | N/A |
| `description` | *string* | :heavy_check_mark: | N/A |
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
| `grantCount` | *number* | :heavy_check_mark: | N/A |
| `icon` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `imageUrl` | *string* | :heavy_check_mark: | N/A |
| `listable` | *boolean* | :heavy_check_mark: | N/A |
| `longDescription` | *string* | :heavy_check_mark: | N/A |
| `manuallyGrantable` | *boolean* | :heavy_check_mark: | N/A |
| `multipleGrant` | *boolean* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `query` | *string* | :heavy_check_mark: | N/A |
| `showPosts` | *boolean* | :heavy_check_mark: | N/A |
| `slug` | *string* | :heavy_check_mark: | N/A |
| `system` | *boolean* | :heavy_check_mark: | N/A |
| `targetPosts` | *boolean* | :heavy_check_mark: | N/A |
| `trigger` | *string* | :heavy_check_mark: | N/A |

12
docs/sdk/models/operations/badgegroupings.md Normal file
View File

@@ -0,0 +1,12 @@
# BadgeGroupings
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `description` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `position` | *number* | :heavy_check_mark: | N/A |
| `system` | *boolean* | :heavy_check_mark: | N/A |

29
docs/sdk/models/operations/badges.md Normal file
View File

@@ -0,0 +1,29 @@
# Badges
## Fields
| Field | Type | Required | Description |
| ------------------- | ------------------- | ------------------- | ------------------- |
| `allowTitle` | *boolean* | :heavy_check_mark: | N/A |
| `autoRevoke` | *boolean* | :heavy_check_mark: | N/A |
| `badgeGroupingId` | *number* | :heavy_check_mark: | N/A |
| `badgeTypeId` | *number* | :heavy_check_mark: | N/A |
| `description` | *string* | :heavy_check_mark: | N/A |
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
| `grantCount` | *number* | :heavy_check_mark: | N/A |
| `i18nName` | *string* | :heavy_minus_sign: | N/A |
| `icon` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `imageUrl` | *string* | :heavy_check_mark: | N/A |
| `listable` | *boolean* | :heavy_check_mark: | N/A |
| `longDescription` | *string* | :heavy_check_mark: | N/A |
| `manuallyGrantable` | *boolean* | :heavy_check_mark: | N/A |
| `multipleGrant` | *boolean* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `query` | *string* | :heavy_check_mark: | N/A |
| `showPosts` | *boolean* | :heavy_check_mark: | N/A |
| `slug` | *string* | :heavy_check_mark: | N/A |
| `system` | *boolean* | :heavy_check_mark: | N/A |
| `targetPosts` | *boolean* | :heavy_check_mark: | N/A |
| `trigger` | *number* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/badgetypes.md Normal file
View File

@@ -0,0 +1,10 @@
# BadgeTypes
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `sortOrder` | *number* | :heavy_check_mark: | N/A |

36
docs/sdk/models/operations/basicgroup.md Normal file
View File

@@ -0,0 +1,36 @@
# BasicGroup
## Fields
| Field | Type | Required | Description |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `allowMembershipRequests` | *boolean* | :heavy_check_mark: | N/A |
| `automatic` | *boolean* | :heavy_check_mark: | N/A |
| `bioCooked` | *string* | :heavy_check_mark: | N/A |
| `bioExcerpt` | *string* | :heavy_check_mark: | N/A |
| `bioRaw` | *string* | :heavy_check_mark: | N/A |
| `canAdminGroup` | *boolean* | :heavy_check_mark: | N/A |
| `canEditGroup` | *boolean* | :heavy_minus_sign: | N/A |
| `canSeeMembers` | *boolean* | :heavy_check_mark: | N/A |
| `defaultNotificationLevel` | *number* | :heavy_check_mark: | N/A |
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
| `flairColor` | *string* | :heavy_check_mark: | N/A |
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
| `fullName` | *string* | :heavy_check_mark: | N/A |
| `grantTrustLevel` | *string* | :heavy_check_mark: | N/A |
| `hasMessages` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `incomingEmail` | *string* | :heavy_check_mark: | N/A |
| `membersVisibilityLevel` | *number* | :heavy_check_mark: | N/A |
| `membershipRequestTemplate` | *string* | :heavy_check_mark: | N/A |
| `mentionableLevel` | *number* | :heavy_check_mark: | N/A |
| `messageableLevel` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `primaryGroup` | *boolean* | :heavy_check_mark: | N/A |
| `publicAdmission` | *boolean* | :heavy_check_mark: | N/A |
| `publicExit` | *boolean* | :heavy_check_mark: | N/A |
| `publishReadState` | *boolean* | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `userCount` | *number* | :heavy_check_mark: | N/A |
| `visibilityLevel` | *number* | :heavy_check_mark: | N/A |

12
docs/sdk/models/operations/basictopic.md Normal file
View File

@@ -0,0 +1,12 @@
# BasicTopic
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `fancyTitle` | *string* | :heavy_minus_sign: | N/A |
| `id` | *number* | :heavy_minus_sign: | N/A |
| `postsCount` | *number* | :heavy_minus_sign: | N/A |
| `slug` | *string* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |

9
docs/sdk/models/operations/batchpresignmultipartpartsrequestbody.md Normal file
View File

@@ -0,0 +1,9 @@
# BatchPresignMultipartPartsRequestBody
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `partNumbers` | *any*[] | :heavy_check_mark: | The part numbers to generate the presigned URLs for, must be between 1 and 10000. | [1,2,3] |
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /create-multipart request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |

11
docs/sdk/models/operations/batchpresignmultipartpartsresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# BatchPresignMultipartPartsResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.BatchPresignMultipartPartsResponseBody](../../../sdk/models/operations/batchpresignmultipartpartsresponsebody.md) | :heavy_minus_sign: | external upload initialized |

10
docs/sdk/models/operations/batchpresignmultipartpartsresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# BatchPresignMultipartPartsResponseBody
external upload initialized
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `presignedUrls` | [operations.PresignedUrls](../../../sdk/models/operations/presignedurls.md) | :heavy_check_mark: | The presigned URLs for each part number, which has the part numbers as keys. |

10
docs/sdk/models/operations/bookmarktopicrequest.md Normal file
View File

@@ -0,0 +1,10 @@
# BookmarkTopicRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/bookmarktopicresponse.md Normal file
View File

@@ -0,0 +1,10 @@
# BookmarkTopicResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

47
docs/sdk/models/operations/categories.md Normal file
View File

@@ -0,0 +1,47 @@
# Categories
## Fields
| Field | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
| `color` | *string* | :heavy_check_mark: | N/A |
| `defaultListFilter` | *string* | :heavy_check_mark: | N/A |
| `defaultTopPeriod` | *string* | :heavy_check_mark: | N/A |
| `defaultView` | *string* | :heavy_check_mark: | N/A |
| `description` | *string* | :heavy_check_mark: | N/A |
| `descriptionExcerpt` | *string* | :heavy_check_mark: | N/A |
| `descriptionText` | *string* | :heavy_check_mark: | N/A |
| `hasChildren` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `isUncategorized` | *boolean* | :heavy_minus_sign: | N/A |
| `minimumRequiredTags` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `navigateToFirstPostAfterRead` | *boolean* | :heavy_check_mark: | N/A |
| `notificationLevel` | *number* | :heavy_check_mark: | N/A |
| `numFeaturedTopics` | *number* | :heavy_check_mark: | N/A |
| `permission` | *number* | :heavy_check_mark: | N/A |
| `position` | *number* | :heavy_check_mark: | N/A |
| `postCount` | *number* | :heavy_check_mark: | N/A |
| `readRestricted` | *boolean* | :heavy_check_mark: | N/A |
| `showSubcategoryList` | *boolean* | :heavy_check_mark: | N/A |
| `slug` | *string* | :heavy_check_mark: | N/A |
| `sortAscending` | *string* | :heavy_check_mark: | N/A |
| `sortOrder` | *string* | :heavy_check_mark: | N/A |
| `subcategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `subcategoryList` | *any*[] | :heavy_minus_sign: | N/A |
| `subcategoryListStyle` | *string* | :heavy_check_mark: | N/A |
| `textColor` | *string* | :heavy_check_mark: | N/A |
| `topicCount` | *number* | :heavy_check_mark: | N/A |
| `topicTemplate` | *string* | :heavy_check_mark: | N/A |
| `topicUrl` | *string* | :heavy_check_mark: | N/A |
| `topicsAllTime` | *number* | :heavy_check_mark: | N/A |
| `topicsDay` | *number* | :heavy_check_mark: | N/A |
| `topicsMonth` | *number* | :heavy_check_mark: | N/A |
| `topicsWeek` | *number* | :heavy_check_mark: | N/A |
| `topicsYear` | *number* | :heavy_check_mark: | N/A |
| `uploadedBackground` | *string* | :heavy_check_mark: | N/A |
| `uploadedBackgroundDark` | *string* | :heavy_check_mark: | N/A |
| `uploadedLogo` | *string* | :heavy_check_mark: | N/A |
| `uploadedLogoDark` | *string* | :heavy_check_mark: | N/A |

61
docs/sdk/models/operations/category.md Normal file
View File

@@ -0,0 +1,61 @@
# Category
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `allTopicsWiki` | *boolean* | :heavy_check_mark: | N/A |
| `allowBadges` | *boolean* | :heavy_check_mark: | N/A |
| `allowGlobalTags` | *boolean* | :heavy_minus_sign: | N/A |
| `allowUnlimitedOwnerEditsOnFirstPost` | *boolean* | :heavy_check_mark: | N/A |
| `allowedTagGroups` | *any*[] | :heavy_minus_sign: | N/A |
| `allowedTags` | *any*[] | :heavy_minus_sign: | N/A |
| `autoCloseBasedOnLastPost` | *boolean* | :heavy_check_mark: | N/A |
| `autoCloseHours` | *string* | :heavy_check_mark: | N/A |
| `availableGroups` | *any*[] | :heavy_check_mark: | N/A |
| `canDelete` | *boolean* | :heavy_check_mark: | N/A |
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
| `categorySetting` | *any* | :heavy_minus_sign: | N/A |
| `color` | *string* | :heavy_check_mark: | N/A |
| `customFields` | [operations.CustomFields](../../../sdk/models/operations/customfields.md) | :heavy_check_mark: | N/A |
| `defaultListFilter` | *string* | :heavy_check_mark: | N/A |
| `defaultSlowModeSeconds` | *string* | :heavy_check_mark: | N/A |
| `defaultTopPeriod` | *string* | :heavy_check_mark: | N/A |
| `defaultView` | *string* | :heavy_check_mark: | N/A |
| `description` | *string* | :heavy_check_mark: | N/A |
| `descriptionExcerpt` | *string* | :heavy_check_mark: | N/A |
| `descriptionText` | *string* | :heavy_check_mark: | N/A |
| `emailIn` | *string* | :heavy_check_mark: | N/A |
| `emailInAllowStrangers` | *boolean* | :heavy_check_mark: | N/A |
| `formTemplateIds` | *any*[] | :heavy_minus_sign: | N/A |
| `groupPermissions` | [operations.GroupPermissions](../../../sdk/models/operations/grouppermissions.md)[] | :heavy_check_mark: | N/A |
| `hasChildren` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `mailinglistMirror` | *boolean* | :heavy_check_mark: | N/A |
| `minimumRequiredTags` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `navigateToFirstPostAfterRead` | *boolean* | :heavy_check_mark: | N/A |
| `notificationLevel` | *number* | :heavy_check_mark: | N/A |
| `numFeaturedTopics` | *number* | :heavy_check_mark: | N/A |
| `permission` | *number* | :heavy_check_mark: | N/A |
| `position` | *number* | :heavy_check_mark: | N/A |
| `postCount` | *number* | :heavy_check_mark: | N/A |
| `readOnlyBanner` | *string* | :heavy_check_mark: | N/A |
| `readRestricted` | *boolean* | :heavy_check_mark: | N/A |
| `requiredTagGroups` | [operations.RequiredTagGroups](../../../sdk/models/operations/requiredtaggroups.md)[] | :heavy_check_mark: | N/A |
| `searchPriority` | *number* | :heavy_check_mark: | N/A |
| `showSubcategoryList` | *boolean* | :heavy_check_mark: | N/A |
| `slug` | *string* | :heavy_check_mark: | N/A |
| `sortAscending` | *string* | :heavy_check_mark: | N/A |
| `sortOrder` | *string* | :heavy_check_mark: | N/A |
| `subcategoryListStyle` | *string* | :heavy_check_mark: | N/A |
| `textColor` | *string* | :heavy_check_mark: | N/A |
| `topicCount` | *number* | :heavy_check_mark: | N/A |
| `topicFeaturedLinkAllowed` | *boolean* | :heavy_check_mark: | N/A |
| `topicTemplate` | *string* | :heavy_check_mark: | N/A |
| `topicUrl` | *string* | :heavy_check_mark: | N/A |
| `uploadedBackground` | *string* | :heavy_check_mark: | N/A |
| `uploadedBackgroundDark` | *string* | :heavy_check_mark: | N/A |
| `uploadedLogo` | *string* | :heavy_check_mark: | N/A |
| `uploadedLogoDark` | *string* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/categorylist.md Normal file
View File

@@ -0,0 +1,10 @@
# CategoryList
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `canCreateCategory` | *boolean* | :heavy_check_mark: | N/A |
| `canCreateTopic` | *boolean* | :heavy_check_mark: | N/A |
| `categories` | [operations.Categories](../../../sdk/models/operations/categories.md)[] | :heavy_check_mark: | N/A |

7
docs/sdk/models/operations/censoredregexp.md Normal file
View File

@@ -0,0 +1,7 @@
# CensoredRegexp
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/sdk/models/operations/changepasswordrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# ChangePasswordRequest
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `token` | *string* | :heavy_check_mark: | N/A |
| `requestBody` | [operations.ChangePasswordRequestBody](../../../sdk/models/operations/changepasswordrequestbody.md) | :heavy_minus_sign: | N/A |

9
docs/sdk/models/operations/changepasswordrequestbody.md Normal file
View File

@@ -0,0 +1,9 @@
# ChangePasswordRequestBody
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `password` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/changepasswordresponse.md Normal file
View File

@@ -0,0 +1,10 @@
# ChangePasswordResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

11
docs/sdk/models/operations/completeexternaluploadrequestbody.md Normal file
View File

@@ -0,0 +1,11 @@
# CompleteExternalUploadRequestBody
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `forPrivateMessage` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload is for a private message. | true |
| `forSiteSetting` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload is for a site setting. | true |
| `pasted` | *string* | :heavy_minus_sign: | Optionally set this to true if the upload was pasted into the upload area. This will convert PNG files to JPEG. | true |
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /generate-presigned-put request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |

11
docs/sdk/models/operations/completeexternaluploadresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CompleteExternalUploadResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CompleteExternalUploadResponseBody](../../../sdk/models/operations/completeexternaluploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |

23
docs/sdk/models/operations/completeexternaluploadresponsebody.md Normal file
View File

@@ -0,0 +1,23 @@
# CompleteExternalUploadResponseBody
external upload initialized
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
| `extension` | *string* | :heavy_check_mark: | N/A |
| `filesize` | *number* | :heavy_check_mark: | N/A |
| `height` | *number* | :heavy_check_mark: | N/A |
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
| `retainHours` | *string* | :heavy_check_mark: | N/A |
| `shortPath` | *string* | :heavy_check_mark: | N/A |
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
| `url` | *string* | :heavy_check_mark: | N/A |
| `width` | *number* | :heavy_check_mark: | N/A |

9
docs/sdk/models/operations/completemultipartrequestbody.md Normal file
View File

@@ -0,0 +1,9 @@
# CompleteMultipartRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `parts` | *any*[] | :heavy_check_mark: | All of the part numbers and their corresponding ETags that have been uploaded must be provided. | [{"etag":"0c376dcfcc2606f4335bbc732de93344","part_number":1},{"etag":"09ert8cfcc2606f4335bbc732de91122","part_number":2}] |
| `uniqueIdentifier` | *string* | :heavy_check_mark: | The unique identifier returned in the original /create-multipart request. | 66e86218-80d9-4bda-b4d5-2b6def968705 |

11
docs/sdk/models/operations/completemultipartresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CompleteMultipartResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CompleteMultipartResponseBody](../../../sdk/models/operations/completemultipartresponsebody.md) | :heavy_minus_sign: | external upload initialized |

23
docs/sdk/models/operations/completemultipartresponsebody.md Normal file
View File

@@ -0,0 +1,23 @@
# CompleteMultipartResponseBody
external upload initialized
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
| `extension` | *string* | :heavy_check_mark: | N/A |
| `filesize` | *number* | :heavy_check_mark: | N/A |
| `height` | *number* | :heavy_check_mark: | N/A |
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
| `retainHours` | *string* | :heavy_check_mark: | N/A |
| `shortPath` | *string* | :heavy_check_mark: | N/A |
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
| `url` | *string* | :heavy_check_mark: | N/A |
| `width` | *number* | :heavy_check_mark: | N/A |

8
docs/sdk/models/operations/createbackuprequestbody.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateBackupRequestBody
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `withUploads` | *boolean* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/createbackupresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateBackupResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateBackupResponseBody](../../../sdk/models/operations/createbackupresponsebody.md) | :heavy_minus_sign: | success response |

10
docs/sdk/models/operations/createbackupresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateBackupResponseBody
success response
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `success` | *string* | :heavy_check_mark: | N/A | OK |

10
docs/sdk/models/operations/createbadgebadgetypes.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateBadgeBadgeTypes
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `sortOrder` | *number* | :heavy_check_mark: | N/A |

9
docs/sdk/models/operations/createbadgerequestbody.md Normal file
View File

@@ -0,0 +1,9 @@
# CreateBadgeRequestBody
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `badgeTypeId` | *number* | :heavy_check_mark: | The ID for the badge type. 1 for Gold, 2 for Silver, 3 for Bronze. |
| `name` | *string* | :heavy_check_mark: | The name for the new badge. |

11
docs/sdk/models/operations/createbadgeresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateBadgeResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateBadgeResponseBody](../../../sdk/models/operations/createbadgeresponsebody.md) | :heavy_minus_sign: | success response |

11
docs/sdk/models/operations/createbadgeresponsebody.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateBadgeResponseBody
success response
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `badge` | [operations.Badge](../../../sdk/models/operations/badge.md) | :heavy_check_mark: | N/A |
| `badgeTypes` | [operations.CreateBadgeBadgeTypes](../../../sdk/models/operations/createbadgebadgetypes.md)[] | :heavy_check_mark: | N/A |

17
docs/sdk/models/operations/createcategoryrequestbody.md Normal file
View File

@@ -0,0 +1,17 @@
# CreateCategoryRequestBody
## Fields
| Field | Type | Required | Description | Example |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `allowBadges` | *boolean* | :heavy_minus_sign: | N/A | |
| `color` | *string* | :heavy_minus_sign: | N/A | 49d9e9 |
| `formTemplateIds` | *any*[] | :heavy_minus_sign: | N/A | |
| `name` | *string* | :heavy_check_mark: | N/A | |
| `parentCategoryId` | *number* | :heavy_minus_sign: | N/A | |
| `permissions` | Record<string, *any*> | :heavy_minus_sign: | N/A | |
| `searchPriority` | *number* | :heavy_minus_sign: | N/A | |
| `slug` | *string* | :heavy_minus_sign: | N/A | |
| `textColor` | *string* | :heavy_minus_sign: | N/A | f0fcfd |
| `topicFeaturedLinksAllowed` | *boolean* | :heavy_minus_sign: | N/A | |

11
docs/sdk/models/operations/createcategoryresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateCategoryResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateCategoryResponseBody](../../../sdk/models/operations/createcategoryresponsebody.md) | :heavy_minus_sign: | success response |

10
docs/sdk/models/operations/createcategoryresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateCategoryResponseBody
success response
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `category` | [operations.Category](../../../sdk/models/operations/category.md) | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/createdby.md Normal file
View File

@@ -0,0 +1,11 @@
# CreatedBy
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

8
docs/sdk/models/operations/creategrouprequestbody.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateGroupRequestBody
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `group` | [operations.Group](../../../sdk/models/operations/group.md) | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/creategroupresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateGroupResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateGroupResponseBody](../../../sdk/models/operations/creategroupresponsebody.md) | :heavy_minus_sign: | group created |

10
docs/sdk/models/operations/creategroupresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateGroupResponseBody
group created
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `basicGroup` | [operations.BasicGroup](../../../sdk/models/operations/basicgroup.md) | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/createinviterequest.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateInviteRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
| `requestBody` | [operations.CreateInviteRequestBody](../../../sdk/models/operations/createinviterequestbody.md) | :heavy_minus_sign: | N/A |

15
docs/sdk/models/operations/createinviterequestbody.md Normal file
View File

@@ -0,0 +1,15 @@
# CreateInviteRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `customMessage` | *string* | :heavy_minus_sign: | optional, for email invites | |
| `email` | *string* | :heavy_minus_sign: | required for email invites only | not-a-user-yet@example.com |
| `expiresAt` | *string* | :heavy_minus_sign: | optional, if not supplied, the invite_expiry_days site setting is used | |
| `groupIds` | *string* | :heavy_minus_sign: | Optional, either this or `group_names`. Comma separated list for multiple ids. | 42,43 |
| `groupNames` | *string* | :heavy_minus_sign: | Optional, either this or `group_ids`. Comma separated list for multiple names. | foo,bar |
| `maxRedemptionsAllowed` | *number* | :heavy_minus_sign: | optional, for link invites | 5 |
| `skipEmail` | *boolean* | :heavy_minus_sign: | N/A | |
| `topicId` | *number* | :heavy_minus_sign: | N/A | |

11
docs/sdk/models/operations/createinviteresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateInviteResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateInviteResponseBody](../../../sdk/models/operations/createinviteresponsebody.md) | :heavy_minus_sign: | success response |

20
docs/sdk/models/operations/createinviteresponsebody.md Normal file
View File

@@ -0,0 +1,20 @@
# CreateInviteResponseBody
success response
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `createdAt` | *string* | :heavy_minus_sign: | N/A | 2021-01-01T12:00:00.000Z |
| `customMessage` | *string* | :heavy_minus_sign: | N/A | Hello world! |
| `email` | *string* | :heavy_minus_sign: | N/A | not-a-user-yet@example.com |
| `emailed` | *boolean* | :heavy_minus_sign: | N/A | false |
| `expired` | *boolean* | :heavy_minus_sign: | N/A | false |
| `expiresAt` | *string* | :heavy_minus_sign: | N/A | 2021-02-01T12:00:00.000Z |
| `groups` | *any*[] | :heavy_minus_sign: | N/A | [] |
| `id` | *number* | :heavy_minus_sign: | N/A | 42 |
| `link` | *string* | :heavy_minus_sign: | N/A | http://example.com/invites/9045fd767efe201ca60c6658bcf14158 |
| `topics` | *any*[] | :heavy_minus_sign: | N/A | [] |
| `updatedAt` | *string* | :heavy_minus_sign: | N/A | 2021-01-01T12:00:00.000Z |

11
docs/sdk/models/operations/createmultipartuploadrequestbody.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateMultipartUploadRequestBody
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `fileName` | *string* | :heavy_check_mark: | N/A | IMG_2021.jpeg |
| `fileSize` | *number* | :heavy_check_mark: | File size should be represented in bytes. | 4096 |
| `metadata` | [operations.Metadata](../../../sdk/models/operations/metadata.md) | :heavy_minus_sign: | N/A | |
| `uploadType` | [operations.UploadType](../../../sdk/models/operations/uploadtype.md) | :heavy_check_mark: | N/A | |

11
docs/sdk/models/operations/createmultipartuploadresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateMultipartUploadResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateMultipartUploadResponseBody](../../../sdk/models/operations/createmultipartuploadresponsebody.md) | :heavy_minus_sign: | external upload initialized |

12
docs/sdk/models/operations/createmultipartuploadresponsebody.md Normal file
View File

@@ -0,0 +1,12 @@
# CreateMultipartUploadResponseBody
external upload initialized
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalUploadIdentifier` | *string* | :heavy_check_mark: | The identifier of the multipart upload in the external storage provider. This is the multipart upload_id in AWS S3. | 84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ |
| `key` | *string* | :heavy_check_mark: | The path of the temporary file on the external storage service. | temp/site/uploads/default/12345/67890.jpg |
| `uniqueIdentifier` | *string* | :heavy_check_mark: | A unique string that identifies the external upload. This must be stored and then sent in the /complete-multipart and /batch-presign-multipart-parts endpoints. | 66e86218-80d9-4bda-b4d5-2b6def968705 |

8
docs/sdk/models/operations/createtaggrouprequestbody.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateTagGroupRequestBody
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/createtaggroupresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateTagGroupResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateTagGroupResponseBody](../../../sdk/models/operations/createtaggroupresponsebody.md) | :heavy_minus_sign: | tag group created |

10
docs/sdk/models/operations/createtaggroupresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateTagGroupResponseBody
tag group created
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `tagGroup` | [operations.TagGroup](../../../sdk/models/operations/taggroup.md) | :heavy_check_mark: | N/A |

9
docs/sdk/models/operations/createtopicpostpmactionssummary.md Normal file
View File

@@ -0,0 +1,9 @@
# CreateTopicPostPMActionsSummary
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `canAct` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |

18
docs/sdk/models/operations/createtopicpostpmrequestbody.md Normal file
View File

@@ -0,0 +1,18 @@
# CreateTopicPostPMRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `archetype` | *string* | :heavy_minus_sign: | Required for new private message. | private_message |
| `category` | *number* | :heavy_minus_sign: | Optional if creating a new topic, and ignored if creating a new post. | |
| `createdAt` | *string* | :heavy_minus_sign: | N/A | |
| `embedUrl` | *string* | :heavy_minus_sign: | Provide a URL from a remote system to associate a forum topic with that URL, typically for using Discourse as a comments system for an external blog. | |
| `externalId` | *string* | :heavy_minus_sign: | Provide an external_id from a remote system to associate a forum topic with that id. | |
| `raw` | *string* | :heavy_check_mark: | N/A | |
| `replyToPostNumber` | *number* | :heavy_minus_sign: | Optional, the post number to reply to inside a topic. | |
| `targetRecipients` | *string* | :heavy_minus_sign: | Required for private message, comma separated. | blake,sam |
| ~~`targetUsernames`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated. Use target_recipients instead. | |
| `title` | *string* | :heavy_minus_sign: | Required if creating a new topic or new private message. | |
| `topicId` | *number* | :heavy_minus_sign: | Required if creating a new post. | |

11
docs/sdk/models/operations/createtopicpostpmresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateTopicPostPMResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateTopicPostPMResponseBody](../../../sdk/models/operations/createtopicpostpmresponsebody.md) | :heavy_minus_sign: | post created |

61
docs/sdk/models/operations/createtopicpostpmresponsebody.md Normal file
View File

@@ -0,0 +1,61 @@
# CreateTopicPostPMResponseBody
post created
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `actionsSummary` | [operations.CreateTopicPostPMActionsSummary](../../../sdk/models/operations/createtopicpostpmactionssummary.md)[] | :heavy_check_mark: | N/A |
| `admin` | *boolean* | :heavy_check_mark: | N/A |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `bookmarked` | *boolean* | :heavy_check_mark: | N/A |
| `canDelete` | *boolean* | :heavy_check_mark: | N/A |
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
| `canRecover` | *boolean* | :heavy_check_mark: | N/A |
| `canSeeHiddenPost` | *boolean* | :heavy_minus_sign: | N/A |
| `canViewEditHistory` | *boolean* | :heavy_check_mark: | N/A |
| `canWiki` | *boolean* | :heavy_check_mark: | N/A |
| `cooked` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_check_mark: | N/A |
| `deletedAt` | *string* | :heavy_check_mark: | N/A |
| `displayUsername` | *string* | :heavy_check_mark: | N/A |
| `draftSequence` | *number* | :heavy_check_mark: | N/A |
| `editReason` | *string* | :heavy_check_mark: | N/A |
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
| `flairColor` | *string* | :heavy_check_mark: | N/A |
| `flairGroupId` | *string* | :heavy_minus_sign: | N/A |
| `flairName` | *string* | :heavy_check_mark: | N/A |
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
| `hidden` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `incomingLinkCount` | *number* | :heavy_check_mark: | N/A |
| `mentionedUsers` | *any*[] | :heavy_minus_sign: | N/A |
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `postNumber` | *number* | :heavy_check_mark: | N/A |
| `postType` | *number* | :heavy_check_mark: | N/A |
| `primaryGroupName` | *string* | :heavy_check_mark: | N/A |
| `quoteCount` | *number* | :heavy_check_mark: | N/A |
| `raw` | *string* | :heavy_minus_sign: | N/A |
| `readersCount` | *number* | :heavy_check_mark: | N/A |
| `reads` | *number* | :heavy_check_mark: | N/A |
| `replyCount` | *number* | :heavy_check_mark: | N/A |
| `replyToPostNumber` | *string* | :heavy_check_mark: | N/A |
| `reviewableId` | *string* | :heavy_check_mark: | N/A |
| `reviewableScoreCount` | *number* | :heavy_check_mark: | N/A |
| `reviewableScorePendingCount` | *number* | :heavy_check_mark: | N/A |
| `score` | *number* | :heavy_check_mark: | N/A |
| `staff` | *boolean* | :heavy_check_mark: | N/A |
| `topicId` | *number* | :heavy_check_mark: | N/A |
| `topicSlug` | *string* | :heavy_check_mark: | N/A |
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
| `updatedAt` | *string* | :heavy_check_mark: | N/A |
| `userDeleted` | *boolean* | :heavy_check_mark: | N/A |
| `userId` | *number* | :heavy_check_mark: | N/A |
| `userTitle` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |
| `version` | *number* | :heavy_check_mark: | N/A |
| `wiki` | *boolean* | :heavy_check_mark: | N/A |
| `yours` | *boolean* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/createtopictimerrequest.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateTopicTimerRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |
| `requestBody` | [operations.CreateTopicTimerRequestBody](../../../sdk/models/operations/createtopictimerrequestbody.md) | :heavy_minus_sign: | N/A |

11
docs/sdk/models/operations/createtopictimerrequestbody.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateTopicTimerRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `basedOnLastPost` | *boolean* | :heavy_minus_sign: | N/A | |
| `categoryId` | *number* | :heavy_minus_sign: | N/A | |
| `statusType` | *string* | :heavy_minus_sign: | N/A | |
| `time` | *string* | :heavy_minus_sign: | N/A | |

11
docs/sdk/models/operations/createtopictimerresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateTopicTimerResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateTopicTimerResponseBody](../../../sdk/models/operations/createtopictimerresponsebody.md) | :heavy_minus_sign: | topic updated |

15
docs/sdk/models/operations/createtopictimerresponsebody.md Normal file
View File

@@ -0,0 +1,15 @@
# CreateTopicTimerResponseBody
topic updated
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `basedOnLastPost` | *boolean* | :heavy_minus_sign: | N/A | |
| `categoryId` | *string* | :heavy_minus_sign: | N/A | |
| `closed` | *boolean* | :heavy_minus_sign: | N/A | |
| `duration` | *string* | :heavy_minus_sign: | N/A | |
| `executeAt` | *string* | :heavy_minus_sign: | N/A | |
| `success` | *string* | :heavy_minus_sign: | N/A | OK |

11
docs/sdk/models/operations/createuploadrequestbody.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateUploadRequestBody
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `file` | [operations.File](../../../sdk/models/operations/file.md) | :heavy_minus_sign: | N/A |
| `synchronous` | *boolean* | :heavy_minus_sign: | Use this flag to return an id and url |
| `type` | [operations.TypeT](../../../sdk/models/operations/typet.md) | :heavy_check_mark: | N/A |
| `userId` | *number* | :heavy_minus_sign: | required if uploading an avatar |

11
docs/sdk/models/operations/createuploadresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateUploadResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateUploadResponseBody](../../../sdk/models/operations/createuploadresponsebody.md) | :heavy_minus_sign: | file uploaded |

23
docs/sdk/models/operations/createuploadresponsebody.md Normal file
View File

@@ -0,0 +1,23 @@
# CreateUploadResponseBody
file uploaded
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `dominantColor` | *string* | :heavy_minus_sign: | N/A |
| `extension` | *string* | :heavy_check_mark: | N/A |
| `filesize` | *number* | :heavy_check_mark: | N/A |
| `height` | *number* | :heavy_check_mark: | N/A |
| `humanFilesize` | *string* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `originalFilename` | *string* | :heavy_check_mark: | N/A |
| `retainHours` | *string* | :heavy_check_mark: | N/A |
| `shortPath` | *string* | :heavy_check_mark: | N/A |
| `shortUrl` | *string* | :heavy_check_mark: | N/A |
| `thumbnailHeight` | *number* | :heavy_check_mark: | N/A |
| `thumbnailWidth` | *number* | :heavy_check_mark: | N/A |
| `url` | *string* | :heavy_check_mark: | N/A |
| `width` | *number* | :heavy_check_mark: | N/A |

10
docs/sdk/models/operations/createuserrequest.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateUserRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `apiKey` | *string* | :heavy_check_mark: | N/A |
| `apiUsername` | *string* | :heavy_check_mark: | N/A |
| `requestBody` | [operations.CreateUserRequestBody](../../../sdk/models/operations/createuserrequestbody.md) | :heavy_minus_sign: | N/A |

15
docs/sdk/models/operations/createuserrequestbody.md Normal file
View File

@@ -0,0 +1,15 @@
# CreateUserRequestBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `active` | *boolean* | :heavy_minus_sign: | This param requires an api key in the request header or it will be ignored |
| `approved` | *boolean* | :heavy_minus_sign: | N/A |
| `email` | *string* | :heavy_check_mark: | N/A |
| `externalIds` | [operations.ExternalIds](../../../sdk/models/operations/externalids.md) | :heavy_minus_sign: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `password` | *string* | :heavy_check_mark: | N/A |
| `userFields1` | *boolean* | :heavy_minus_sign: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/createuserresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateUserResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.CreateUserResponseBody](../../../sdk/models/operations/createuserresponsebody.md) | :heavy_minus_sign: | user created |

13
docs/sdk/models/operations/createuserresponsebody.md Normal file
View File

@@ -0,0 +1,13 @@
# CreateUserResponseBody
user created
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `active` | *boolean* | :heavy_check_mark: | N/A |
| `message` | *string* | :heavy_check_mark: | N/A |
| `success` | *boolean* | :heavy_check_mark: | N/A |
| `userId` | *number* | :heavy_minus_sign: | N/A |

7
docs/sdk/models/operations/customemojitranslation.md Normal file
View File

@@ -0,0 +1,7 @@
# CustomEmojiTranslation
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/sdk/models/operations/customfields.md Normal file
View File

@@ -0,0 +1,7 @@
# CustomFields
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

12
docs/sdk/models/operations/data.md Normal file
View File

@@ -0,0 +1,12 @@
# Data
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `badgeId` | *number* | :heavy_minus_sign: | N/A |
| `badgeName` | *string* | :heavy_minus_sign: | N/A |
| `badgeSlug` | *string* | :heavy_minus_sign: | N/A |
| `badgeTitle` | *boolean* | :heavy_minus_sign: | N/A |
| `username` | *string* | :heavy_minus_sign: | N/A |

8
docs/sdk/models/operations/deactivateuserrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# DeactivateUserRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |

11
docs/sdk/models/operations/deactivateuserresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# DeactivateUserResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.DeactivateUserResponseBody](../../../sdk/models/operations/deactivateuserresponsebody.md) | :heavy_minus_sign: | response |

10
docs/sdk/models/operations/deactivateuserresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# DeactivateUserResponseBody
response
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `success` | *string* | :heavy_check_mark: | N/A | OK |

7
docs/sdk/models/operations/defaultdarkcolorscheme.md Normal file
View File

@@ -0,0 +1,7 @@
# DefaultDarkColorScheme
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

8
docs/sdk/models/operations/deletebadgerequest.md Normal file
View File

@@ -0,0 +1,8 @@
# DeleteBadgeRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_check_mark: | N/A |

Some files were not shown because too many files have changed in this diff Show More