Repository navigation
docs: Rewrite README, add InvoiceSalesOrderResult::findByProcessId() - #701
Merged
Merged
Conversation
Keeps the ProcessID parameter format in one place in the library, so users don't have to build "guid'...'" themselves. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Restructures the README around the tasks users have (authenticate, read, write, related data, rate limits, errors, webhooks) and brings it up to date: - Fix examples that led to broken setups: tokens are now stored through the token update callback (refresh tokens rotate), lock callbacks are set before the first refresh, find()/get() results are used instead of discarded, download() returns a stream, tokens are no longer serialized - Document what was missing: error handling and status codes, filter options, first()/findId(), manual paging, sync and bulk endpoints, lazy loading and $expand, setting the division, base urls per country, state for CSRF, logging via middleware, webhook code examples - Update troubleshooting, add a versions table and upgrade notes, add a contributing section with the entity generator - Remove the job openings link and leftover text copied from a PR Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
README rewrite
The README is restructured around what users need to do, and brought up to date with the current library.
Examples that led to broken setups are fixed:
connect(). Refresh tokens rotate, so a refresh during later requests lost the new token and locked users out. The README now putssetTokenUpdateCallback()front and centre.connect(), so they weren't active during the first refresh. The multi-process locking pattern is now explained, includingsetRefreshAccessTokenCallback().$item->find($id);and$item->get();threw away their results.download()was documented as returning a string. It returns a stream.serialize()/unserialize()for no reason.Newly documented: error handling and status codes; all
filter()options ($expand,$select, other OData options, headers such asCustomDescriptionLanguage);first()andfindId(); manual paging withgetResultSet(); sync endpoints (Timestamp) and bulk endpoints; lazy loading versus$expand; why to always set the division; base urls per country;statefor CSRF; logging via middleware; webhook code examples; the daily maintenance window (#691).Also: a table of contents, badges, updated troubleshooting, a versions table with upgrade notes for 4.7 and 4.8, and a contributing section that links the entity generator. The job openings link and text copied from an old PR are removed. The
#invoice-sales-orders-asyncanchor (linked from the v4.9.0 release notes) still works.InvoiceSalesOrderResult::findByProcessId()This keeps the
ProcessIDparameter format (guid'…') inside the library. If the format turns out to be wrong, a patch release fixes it for everyone, without users changing their code.get(['ProcessID' => …])keeps working.Test plan
php -lfindByProcessId();vendor/bin/phpunit(598 tests) andvendor/bin/phpstanpass🤖 Generated with Claude Code