Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version to 5.0.0 #34

Merged
merged 1 commit into from
Nov 27, 2024
Merged

Bump version to 5.0.0 #34

merged 1 commit into from
Nov 27, 2024

Conversation

stevenclouston
Copy link
Contributor

@stevenclouston stevenclouston commented Nov 26, 2024

Release Notes

Changes have been made so that conventions used in the Ruby SDK align with Authsignal's general SDK conventions.

Breaking Changes

  1. update_user

    • Renamed the user parameter to attributes in the update_user function.
  2. track

    • Updated function signature:
      • Old:
        def track(event)
      • New:
        def track(:user_id, :action, :attributes)
  3. enroll_verified_authenticator

    • Updated to accept named parameters: user_id and attributes.
  4. get_user

    • Removed redirectUrl from the function signature.
  5. update_action_state

    • Renamed method update_action_state to update_action.
    • Replaced input parameter state with attributes.
  6. Parameter Renaming

    • Renamed base_uri to api_url to align with Authsignal conventions.
  7. Error Handling Updates

    • Error response changes:
      • status replaced with status_code.
      • error replaced with error_code.

Non-Breaking Changes

  1. get_authenticators
    • Added a new method: get_authenticators.

@stevenclouston stevenclouston merged commit 8f6712c into main Nov 27, 2024
1 check passed
@stevenclouston stevenclouston deleted the 5.0.0 branch November 27, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants