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.
This change adds named methods to the
Client
class for each of the endpoints in the Notion API. It follows the pattern established in #1.Fixes #13
Future work
It's clear that the type definitions are not ideal. I intentionally avoided complex type constructs such as conditional types and heavy use of generics because the eventual goal is to generate these types from an OpenAPI format. If we used these more complex types now, it's very unlikely we could generate something which kept stability in the type names. TypeScript is just more expressive than OpenAPI and JSON Schema.
Another shortcoming is that there isn't a good separation between "input" types and "output" types. This matters in situations where a method accepts, for example, a
Block
in its parameters. At call time, a block won't have properties likeid
- those are assigned by the server. However, theBlock
type hasid
set as a non-optional property. This is a real issue and should be handled in a bugfix.