Support email param in update_user (#365)

Author: cmatheson

.rubocop.yml

@@ -12,10 +12,14 @@ Layout/LineLength:
     - '(\A|\s)/.*?/'
 Metrics/BlockLength:
   AllowedMethods: ['describe', 'context', 'before', 'it']
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 Metrics/MethodLength:
-  Max: 30
+  Enabled: false
 Metrics/ModuleLength:
-  Max: 200
+  Enabled: false
 Metrics/ParameterLists:
   Max: 6
 Naming/ConstantName:

lib/workos/client.rb

@@ -86,7 +86,7 @@ def user_agent
       ].join('; ')
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity:
+    # rubocop:disable Metrics/AbcSize:
     def handle_error_response(response:)
       http_status = response.code.to_i
       json = JSON.parse(response.body)

lib/workos/mfa.rb

@@ -32,7 +32,6 @@ def get_factor(
         WorkOS::Factor.new(response.body)
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
       def validate_args(
         type:,

lib/workos/session.rb

@@ -64,7 +64,6 @@ def authenticate
     # @return [Hash] A hash containing a new sealed session, the authentication response,
     # and a reason if the refresh failed
     # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
     def refresh(options = nil)
       cookie_password = options.nil? || options[:cookie_password].nil? ? @cookie_password : options[:cookie_password]

lib/workos/user_management.rb

@@ -6,8 +6,6 @@
 module WorkOS
   # The UserManagement module provides convenience methods for working with the
   # WorkOS User platform. You'll need a valid API key.
-
-  # rubocop:disable Metrics/ModuleLength
   module UserManagement
     module Types
       # The ProviderEnum is a declaration of a
@@ -217,6 +215,7 @@ def create_user(
       # Update a user
       #
       # @param [String] id of the user.
+      # @param [String] email of the user.
       # @param [String] first_name The user's first name.
       # @param [String] last_name The user's last name.
       # @param [Boolean] email_verified Whether the user's email address was previously verified.
@@ -228,6 +227,7 @@ def create_user(
       # @return [WorkOS::User]
       def update_user(
         id:,
+        email: nil,
         first_name: nil,
         last_name: nil,
         email_verified: nil,
@@ -238,6 +238,7 @@ def update_user(
         request = put_request(
           path: "/user_management/users/#{id}",
           body: {
+            email: email,
             first_name: first_name,
             last_name: last_name,
             email_verified: email_verified,

spec/lib/workos/user_management_spec.rb

@@ -343,6 +343,17 @@
         end
       end
 
+      it 'can update email addresses' do
+        VCR.use_cassette 'user_management/update_user/email' do
+          user = described_class.update_user(
+            id: 'user_01H7TVSKS45SDHN5V9XPSM6H44',
+            email: '[email protected]',
+          )
+          expect(user.email).to eq('[email protected]')
+          expect(user.email_verified).to eq(false)
+        end
+      end
+
       context 'with an invalid payload' do
         it 'returns an error' do
           VCR.use_cassette 'user_management/update_user/invalid' do