fix(docs): Fix account settings types #452
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
This pull-request implements all the types missing from the current implementation of
accountsettings.js. We're looking to add the returned types values from the backend when callingGET /account/settings.jsonandPUT /account/settings.json.It should be noted the following types are undocumented and therefore aren't documented.
Furthermore, I noticed that the following key doesn't exist when queried against the API. For this reason, I added a
{number=} maximum_requests/maximum_requests?: number | undefinedtype so that this won't throw errors in code.Its a bit of a foot-gun though, I'm for changing it.
{ "chat": { // maximum_requests: 1, } }Related Issue(s)
Additional Information
Test Cases
Include any test cases or steps you took to test your changes. If you have added new functionality, please include relevant unit tests.
Documentation
Checklist