feat: [BREAKING] migrate from REST API to Sync API #263
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.
🗺 Overview
In line with ongoing internal efforts, this PR refactors the SDK to serve as an intermediary between consumers and the Todoist Sync API, replacing the Todoist REST API.
Changes in this Refactor:
The SDK API remains largely unchanged, with the following exceptions:
Some new properties have been added to entities.
Certain existing properties have been marked as required.
The following methods are now paginated:
This refactor ensures compatibility with the latest version of the Todoist Sync API while maintaining the familiar client API interface for consumers.
Caveats:
ids
argument to thegetTasks
method only works with v1 IDs.updateComment
only works with v1 IDs.delete*
methods throw an error due to CORS restrictions (the respective Sync API endpointsAccess-Control-Allow-Methods
response header only allowsGET, POST
).addSection
only works if the project ID is a v1 ID.updateSection
only works with v1 IDs.Release:
This PR will be merged into the
v4
branch, from which several pre-release versions will be created until a stable v4 release.