Documentation #14
Documentation #14
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
| ### Patch Changes | ||
|
|
||
| - 24abeea: Add support for upserting customers. |
There was a problem hiding this comment.
Deleting the changelog here since these releases were just to set up and test the release process with changesets.
There was a problem hiding this comment.
From this release onwards these will actually make sense / be real.
| /* Handled mutation errors */ | ||
| type MutationError = { | ||
| code: 'mutation_error'; | ||
| type: 'mutation_error'; |
There was a problem hiding this comment.
I renamed these to type so they are not confused with our error codes!
|
|
||
| **[Documentation](https://plain-typescript-sdk-docs.vercel.app/classes/PlainSDKClient.html)** | ||
|
|
||
| If you would like to add a query or mutation please open an issue and we can add it for you. |
There was a problem hiding this comment.
| If you would like to add a query or mutation please open an issue and we can add it for you. | |
| If you would like to add support for a query or mutation please open an issue and we can add it for you. |
Also, instead of we can add it for you, might as well suggest that they can open a PR and we'll review it, no?
There was a problem hiding this comment.
Can we link to the API reference to check for other available queries/mutations? https://docs.plain.com/core-api/reference
There was a problem hiding this comment.
Also, instead of we can add it for you, might as well suggest that they can open a PR and we'll review it, no?
No contributing guidelines yet!
There was a problem hiding this comment.
Can we link to the API reference to check for other available queries/mutations? https://docs.plain.com/core-api/reference
I don't want to do this since that page is not very useful and if you are not familiar with GraphQL it's very confusing.
There was a problem hiding this comment.
I'd love to make that better one day though
Co-authored-by: Jesus <jesus@plain.com>
Co-authored-by: Jesus <jesus@plain.com>
Co-authored-by: Jesus <jesus@plain.com>
This PR adds generated documentation using https://typedoc.org/ and documents some other basics manually in the readme. The documentation leaves a lot to be desired but as a first pass I think this is usable.
👉 This also makes the package public 👈 so that anyone and everyone can install this.
As a next step I will add all the queries and mutations and such that are missing!