Skip to content

Conversation

@mattgd
Copy link
Contributor

@mattgd mattgd commented Mar 3, 2025

Description

Add email standard attribute to DirectoryUser and mark deprecated standard attributes.

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

@mattgd mattgd self-assigned this Mar 3, 2025
@linear
Copy link

linear bot commented Mar 3, 2025

@mattgd mattgd marked this pull request as ready for review March 19, 2025 15:38
@mattgd mattgd requested a review from a team as a code owner March 19, 2025 15:38
@mattgd mattgd requested a review from jonatascastro12 March 19, 2025 15:38
Comment on lines 19 to 22
* @deprecated Will be removed in a future major version.
* Enable the `emails` custom attribute in dashboard and pull from customAttributes instead.
* See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems for PHP, you prefix the comment with [Deprecated] instead of @deprecated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, will update, thanks!

Copy link
Contributor

@jonatascastro12 jonatascastro12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we just change from @deprecated to [Deprecated]. Other than that, it looks good to me.

@mattgd mattgd merged commit e1ab9c0 into main Mar 21, 2025
5 checks passed
@mattgd mattgd deleted the feature/dsync-2750-add-email-attribute-to-directoryuser-in-php-sdk branch March 21, 2025 18:08
bradenkeith pushed a commit to bradenkeith/workos-php that referenced this pull request Mar 28, 2025
nicknisi pushed a commit that referenced this pull request Apr 2, 2025
* Improve Webhook and BaseWorkOSResource PHPDoc types

* Enhance Webhook class with improved code style and PHPDoc annotations

* Add accessToken and refreshToken to AuthenticationResponse class

* Update AuthenticationResponse class to include organizationId as nullable, and add accessToken, refreshToken, and impersonator properties

* Enhance OrganizationMembership class with additional PHPDoc properties for improved type documentation

* Add metadata and external id (#268)

And allow to be passed when creating or updating a user or organization.

* Add email standard attribute to DirectoryUser and mark deprecated standard attributes (#261)

* Add function to get organization by external id (#270)

And fix typo in getOrganization docstring

* Add support for creating, getting and updating users with external_id property (#267)

Co-authored-by: Eric Roberts <ericroberts@gmail.com>

* Bump to version 4.22.0. (#269)

* Structured responses to webhook events (#265)

* Add WebhookResponse class for handling webhook actions and responses

* Refactor WebhookResponse create method and improve validation

* Resolve linting error

---------

Co-authored-by: Braden Keith <bkeith@romegadigital.com>

* Update deprecation notices in DirectoryUser class to include version information and improve clarity

* Update deprecation notices in Organizations class to include version information and improve formatting

* Update doc blocks for deprecation notices

* Update tests to expect Role Slug

---------

Co-authored-by: Braden Keith <bkeith@romegadigital.com>
Co-authored-by: Eric Roberts <ericroberts@gmail.com>
Co-authored-by: Matt Dzwonczyk <9063128+mattgd@users.noreply.github.com>
Co-authored-by: Pepe <pgarciag93@gmail.com>
bradenkeith added a commit to bradenkeith/workos-php that referenced this pull request Apr 3, 2025
* Improve Webhook and BaseWorkOSResource PHPDoc types

* Enhance Webhook class with improved code style and PHPDoc annotations

* Add accessToken and refreshToken to AuthenticationResponse class

* Update AuthenticationResponse class to include organizationId as nullable, and add accessToken, refreshToken, and impersonator properties

* Enhance OrganizationMembership class with additional PHPDoc properties for improved type documentation

* Add metadata and external id (workos#268)

And allow to be passed when creating or updating a user or organization.

* Add email standard attribute to DirectoryUser and mark deprecated standard attributes (workos#261)

* Add function to get organization by external id (workos#270)

And fix typo in getOrganization docstring

* Add support for creating, getting and updating users with external_id property (workos#267)

Co-authored-by: Eric Roberts <ericroberts@gmail.com>

* Bump to version 4.22.0. (workos#269)

* Structured responses to webhook events (workos#265)

* Add WebhookResponse class for handling webhook actions and responses

* Refactor WebhookResponse create method and improve validation

* Resolve linting error

---------

Co-authored-by: Braden Keith <bkeith@romegadigital.com>

* Update deprecation notices in DirectoryUser class to include version information and improve clarity

* Update deprecation notices in Organizations class to include version information and improve formatting

* Update doc blocks for deprecation notices

* Update tests to expect Role Slug

---------

Co-authored-by: Braden Keith <bkeith@romegadigital.com>
Co-authored-by: Eric Roberts <ericroberts@gmail.com>
Co-authored-by: Matt Dzwonczyk <9063128+mattgd@users.noreply.github.com>
Co-authored-by: Pepe <pgarciag93@gmail.com>
bradenkeith pushed a commit to bradenkeith/workos-php that referenced this pull request Apr 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants