Add deprecation notice for domain in directory sync #273
Conversation
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
…able, and add accessToken, refreshToken, and impersonator properties
…s for improved type documentation
And allow to be passed when creating or updating a user or organization.
…ndard attributes (workos#261)
And fix typo in getOrganization docstring
… property (workos#267) Co-authored-by: Eric Roberts <[email protected]>
* Add WebhookResponse class for handling webhook actions and responses * Refactor WebhookResponse create method and improve validation * Resolve linting error --------- Co-authored-by: Braden Keith <[email protected]>
…information and improve clarity
…information and improve formatting
…error for better error reporting. Update phpunit.xml to display details on deprecations and warnings. Enhance test cases to assert deprecation warnings for deprecated methods.
…eOrganization' in Organizations class, and 'primaryEmail' in DirectoryUser class. Update tests to assert deprecation messages for these changes.
…rganizations class to provide clearer guidance for users. Add a test to assert the deprecation warning is triggered correctly.
…ent formatting and clarity. Adjust tests to reflect the updated messages for 'actors', 'primaryEmail', 'domains', and other parameters, enhancing overall error reporting.
…s method, advising users to switch to 'search' or 'organizationId'. Add a test to verify that the deprecation warning is triggered correctly.
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.
Description
This paves the way for @mattgd's PR #215, which will remove the
$domainparameter in the next major release. Since the domain is no longer used today, this provides a graceful deprecation notice for developers to begin the transition to alternative methods.I also caught a bug on DirectorySync.php:105 that referenced
$groupinstead of$user. Group is not a defined parameter.This PR relies on the testing methods introduced in #272. Please merge #272 first.
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.