twitter 8.2.0 → 8.3.1

data/lib/twitter/rest/direct_messages/welcome_messages.rb

@@ -6,43 +6,75 @@ require "twitter/utils"
 module Twitter
   module REST
     module DirectMessages
+      # Methods for managing welcome messages in direct messages
       module WelcomeMessages
         include Twitter::REST::UploadUtils
         include Twitter::REST::Utils
         include Twitter::Utils
 
-        # Welcome Message
-
+        # Creates a new welcome message
+        #
+        # @api public
+        # @example
+        #   client.create_welcome_message("Welcome!", "default")
+        # @param text [String] The text of the welcome message
+        # @param name [String] Optional name for the welcome message
+        # @param options [Hash] A customizable set of options
+        # @return [Twitter::DirectMessages::WelcomeMessage]
         def create_welcome_message(text, name = nil, options = {})
           json_options = {
             welcome_message: {
               message_data: {
-                text:,
-              },
-            },
+                text:
+              }
+            }
           }
-          json_options[:welcome_message][:name] = name if name
-          welcome_message_wrapper = perform_request_with_object(:json_post, "/1.1/direct_messages/welcome_messages/new.json", json_options.merge!(options), Twitter::DirectMessages::WelcomeMessageWrapper)
+          json_options.fetch(:welcome_message)[:name] = name if name # steep:ignore ArgumentTypeMismatch
+          welcome_message_wrapper = perform_request_with_object(:json_post, "/1.1/direct_messages/welcome_messages/new.json", options.merge(json_options), Twitter::DirectMessages::WelcomeMessageWrapper)
           welcome_message_wrapper.welcome_message
         end
 
+        # Destroys welcome messages
+        #
+        # @api public
+        # @example
+        #   client.destroy_welcome_message(123456789)
+        # @param ids [Array<Integer>] IDs of welcome messages to destroy
+        # @return [nil]
         def destroy_welcome_message(*ids)
           perform_requests(:delete, "/1.1/direct_messages/welcome_messages/destroy.json", ids)
         end
 
+        # Updates a welcome message
+        #
+        # @api public
+        # @example
+        #   client.update_welcome_message(123456789, "New text")
+        # @param welcome_message_id [Integer] The ID of the welcome message
+        # @param text [String] The new text for the welcome message
+        # @param options [Hash] A customizable set of options
+        # @return [Twitter::DirectMessages::WelcomeMessage]
         def update_welcome_message(welcome_message_id, text, options = {})
           params = {
-            id: welcome_message_id,
+            id: welcome_message_id
           }
           json_options = {
             message_data: {
-              text:,
-            },
+              text:
+            }
           }
-          welcome_message_wrapper = perform_request_with_object(:json_put, "/1.1/direct_messages/welcome_messages/update.json", json_options.merge!(options), Twitter::DirectMessages::WelcomeMessageWrapper, params)
+          welcome_message_wrapper = perform_request_with_object(:json_put, "/1.1/direct_messages/welcome_messages/update.json", options.merge(json_options), Twitter::DirectMessages::WelcomeMessageWrapper, params)
           welcome_message_wrapper.welcome_message
         end
 
+        # Returns a welcome message
+        #
+        # @api public
+        # @example
+        #   client.welcome_message(123456789)
+        # @param id [Integer] The ID of the welcome message
+        # @param options [Hash] A customizable set of options
+        # @return [Twitter::DirectMessages::WelcomeMessage]
         def welcome_message(id, options = {})
           options = options.dup
           options[:id] = id
@@ -50,28 +82,58 @@ module Twitter
           welcome_message_wrapper.welcome_message
         end
 
+        # Returns a list of welcome messages
+        #
+        # @api public
+        # @example
+        #   client.welcome_message_list
+        # @param options [Hash] A customizable set of options
+        # @option options [Integer] :count Number of records to retrieve
+        # @return [Array<Twitter::DirectMessages::WelcomeMessage>]
         def welcome_message_list(options = {})
           limit = options.fetch(:count, 20)
-          welcome_message_wrappers = perform_get_with_cursor("/1.1/direct_messages/welcome_messages/list.json", options.merge!(no_default_cursor: true, count: 50, limit:), :welcome_messages, Twitter::DirectMessages::WelcomeMessageWrapper)
+          request_options = options.merge(no_default_cursor: true, count: 50, limit:)
+          welcome_message_wrappers = perform_get_with_cursor("/1.1/direct_messages/welcome_messages/list.json", request_options, :welcome_messages, Twitter::DirectMessages::WelcomeMessageWrapper)
           welcome_message_wrappers.collect(&:welcome_message)
         end
 
-        # Welcome Message Rule
-
+        # Creates a new welcome message rule
+        #
+        # @api public
+        # @example
+        #   client.create_welcome_message_rule(123456789)
+        # @param welcome_message_id [Integer] The ID of the welcome message
+        # @param options [Hash] A customizable set of options
+        # @return [Twitter::DirectMessages::WelcomeMessageRule]
         def create_welcome_message_rule(welcome_message_id, options = {})
           json_options = {
             welcome_message_rule: {
-              welcome_message_id:,
-            },
+              welcome_message_id:
+            }
           }
-          rule_wrapper = perform_request_with_object(:json_post, "/1.1/direct_messages/welcome_messages/rules/new.json", json_options.merge!(options), Twitter::DirectMessages::WelcomeMessageRuleWrapper)
+          rule_wrapper = perform_request_with_object(:json_post, "/1.1/direct_messages/welcome_messages/rules/new.json", options.merge(json_options), Twitter::DirectMessages::WelcomeMessageRuleWrapper)
           rule_wrapper.welcome_message_rule
         end
 
+        # Destroys welcome message rules
+        #
+        # @api public
+        # @example
+        #   client.destroy_welcome_message_rule(123456789)
+        # @param ids [Array<Integer>] IDs of welcome message rules to destroy
+        # @return [nil]
         def destroy_welcome_message_rule(*ids)
           perform_requests(:delete, "/1.1/direct_messages/welcome_messages/rules/destroy.json", ids)
         end
 
+        # Returns a welcome message rule
+        #
+        # @api public
+        # @example
+        #   client.welcome_message_rule(123456789)
+        # @param id [Integer] The ID of the welcome message rule
+        # @param options [Hash] A customizable set of options
+        # @return [Twitter::DirectMessages::WelcomeMessageRule]
         def welcome_message_rule(id, options = {})
           options = options.dup
           options[:id] = id
@@ -79,9 +141,18 @@ module Twitter
           rule_wrapper.welcome_message_rule
         end
 
+        # Returns a list of welcome message rules
+        #
+        # @api public
+        # @example
+        #   client.welcome_message_rule_list
+        # @param options [Hash] A customizable set of options
+        # @option options [Integer] :count Number of records to retrieve
+        # @return [Array<Twitter::DirectMessages::WelcomeMessageRule>]
         def welcome_message_rule_list(options = {})
           limit = options.fetch(:count, 20)
-          rule_wrappers = perform_get_with_cursor("/1.1/direct_messages/welcome_messages/rules/list.json", options.merge!(no_default_cursor: true, count: 50, limit:), :welcome_message_rules, Twitter::DirectMessages::WelcomeMessageRuleWrapper)
+          request_options = options.merge(no_default_cursor: true, count: 50, limit:)
+          rule_wrappers = perform_get_with_cursor("/1.1/direct_messages/welcome_messages/rules/list.json", request_options, :welcome_message_rules, Twitter::DirectMessages::WelcomeMessageRuleWrapper)
           rule_wrappers.collect(&:welcome_message_rule)
         end
       end

data/lib/twitter/rest/direct_messages.rb

@@ -8,126 +8,150 @@ require "twitter/utils"
 
 module Twitter
   module REST
+    # Methods for interacting with direct messages
     module DirectMessages
       include Twitter::REST::UploadUtils
       include Twitter::REST::Utils
       include Twitter::Utils
 
-      # Returns all Direct Message events for the authenticated user (both sent and received) within the last 30 days. Sorted in reverse-chronological order.
+      # Returns all Direct Message events for the authenticated user
+      #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessageEvent>] Direct message events sent by and received by the authenticating user.
-      # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 50. Default is 20
-      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
+      # @example
+      #   client.direct_messages_events
+      # @param options [Hash] A customizable set of options
+      # @option options [Integer] :count Number of records to retrieve (max 50)
+      # @option options [String] :cursor Cursor position of results
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Array<Twitter::DirectMessageEvent>] Direct message events
       def direct_messages_events(options = {})
         limit = options.fetch(:count, 20)
-        perform_get_with_cursor("/1.1/direct_messages/events/list.json", options.merge!(no_default_cursor: true, count: 50, limit:), :events, Twitter::DirectMessageEvent)
+        request_options = options.merge(no_default_cursor: true, count: 50, limit:)
+        perform_get_with_cursor("/1.1/direct_messages/events/list.json", request_options, :events, DirectMessageEvent)
       end
 
-      # Returns all Direct Messages for the authenticated user (both sent and received) within the last 30 days. Sorted in reverse-chronological order.
+      # Returns all Direct Messages for the authenticated user
+      #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessage>] Direct messages sent by and received by the authenticating user.
-      # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 50. Default is 20
-      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
+      # @example
+      #   client.direct_messages_list
+      # @param options [Hash] A customizable set of options
+      # @option options [Integer] :count Number of records to retrieve (max 50)
+      # @option options [String] :cursor Cursor position of results
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Array<Twitter::DirectMessage>] Direct messages
       def direct_messages_list(options = {})
         direct_messages_events(options).collect(&:direct_message)
       end
 
-      # Returns Direct Messages received by the authenticated user within the last 30 days. Sorted in reverse-chronological order.
+      # Returns Direct Messages received by the authenticated user
+      #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessage>] Direct messages received by the authenticating user.
-      # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :count Specifies the number of records (sent and received dms) to retrieve. Must be less than or equal to 50. Default is 20
-      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
+      # @example
+      #   client.direct_messages_received
+      # @param options [Hash] A customizable set of options
+      # @option options [Integer] :count Number of records to retrieve (max 50)
+      # @option options [String] :cursor Cursor position of results
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Array<Twitter::DirectMessage>] Direct messages received
       def direct_messages_received(options = {})
         limit = options.fetch(:count, 20)
-        direct_messages_list(options).select { |dm| dm.recipient_id == user_id }.first(limit)
+        direct_messages_list(options).select { |dm| dm.recipient_id.eql?(user_id) }.first(limit)
       end
 
-      # Returns Direct Messages sent by the authenticated user within the last 30 days. Sorted in reverse-chronological order.
+      # Returns Direct Messages sent by the authenticated user
+      #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessage>] Direct messages sent by the authenticating user.
-      # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :count Specifies the number of records (sent and received dms) to retrieve. Must be less than or equal to 50. Default is 20
-      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
+      # @example
+      #   client.direct_messages_sent
+      # @param options [Hash] A customizable set of options
+      # @option options [Integer] :count Number of records to retrieve (max 50)
+      # @option options [String] :cursor Cursor position of results
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Array<Twitter::DirectMessage>] Direct messages sent
       def direct_messages_sent(options = {})
         limit = options.fetch(:count, 20)
-        direct_messages_list(options).select { |dm| dm.sender_id == user_id }.first(limit)
+        direct_messages_list(options).select { |dm| dm.sender_id.eql?(user_id) }.first(limit)
       end
 
       # Returns a direct message
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::DirectMessage] The requested message.
-      # @param id [Integer] A direct message ID.
-      # @param options [Hash] A customizable set of options.
+      # @example
+      #   client.direct_message(123456789)
+      # @param id [Integer] A direct message ID
+      # @param options [Hash] A customizable set of options
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Twitter::DirectMessage] The requested message
       def direct_message(id, options = {})
         direct_message_event(id, options).direct_message
       end
 
       # Returns a direct message event
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::DirectMessageEvent] The requested message.
-      # @param id [Integer] A direct message ID.
-      # @param options [Hash] A customizable set of options.
+      # @example
+      #   client.direct_message_event(123456789)
+      # @param id [Integer] A direct message ID
+      # @param options [Hash] A customizable set of options
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Twitter::DirectMessageEvent] The requested message event
       def direct_message_event(id, options = {})
-        options = options.dup
         options[:id] = id
-        perform_get_with_object("/1.1/direct_messages/events/show.json", options, Twitter::DirectMessageEvent)
+        perform_get_with_object("/1.1/direct_messages/events/show.json", options, DirectMessageEvent)
       end
 
-      # Returns direct messages specified in arguments, or, if no arguments are given, returns direct messages received by authenticating user
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # Returns direct messages
+      #
+      # @api public
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessage>] The requested messages.
+      # @example
+      #   client.direct_messages
       # @overload direct_messages(options = {})
       #   Returns the 20 most recent direct messages sent to the authenticating user
-
       #   @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events
-      #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :count Specifies the number of records (sent and received dms) to retrieve. Must be less than or equal to 50. Default is 20
-      #   @option options [String] :cursor Specifies the cursor position of results to retrieve.
+      #   @param options [Hash] A customizable set of options
+      #   @option options [Integer] :count Number of records to retrieve (max 50)
+      #   @option options [String] :cursor Cursor position of results
       # @overload direct_messages(*ids)
       #   Returns direct messages
-      #
       #   @see https://dev.twitter.com/rest/reference/get/direct_messages/show
-      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs
       # @overload direct_messages(*ids, options)
       #   Returns direct messages
-      #
       #   @see https://dev.twitter.com/rest/reference/get/direct_messages/show
-      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
-      #   @param options [Hash] A customizable set of options.
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs
+      #   @param options [Hash] A customizable set of options
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Array<Twitter::DirectMessage>] The requested messages
       def direct_messages(*args)
-        arguments = Twitter::Arguments.new(args)
+        arguments = Arguments.new(args)
         if arguments.empty?
           direct_messages_received(arguments.options)
         else
@@ -139,81 +163,121 @@ module Twitter
 
       # Destroys direct messages
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message-event
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [nil] Response body from Twitter is nil if successful
+      # @example
+      #   client.destroy_direct_message(123456789)
       # @overload destroy_direct_message(*ids)
-      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+      #   @param ids [Enumerable<Integer>] A collection of direct message IDs
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [nil] Response body from Twitter is nil if successful
       def destroy_direct_message(*ids)
         pmap(ids) do |id|
-          perform_requests(:delete, "/1.1/direct_messages/events/destroy.json", id:)
+          perform_requests(:delete, "/1.1/direct_messages/events/destroy.json", id:) # steep:ignore ArgumentTypeMismatch
         end
         nil
       end
 
-      # Sends a new direct message to the specified user from the authenticating user
+      # Sends a new direct message to the specified user
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::DirectMessage] The sent message.
+      # @example
+      #   client.create_direct_message(123456789, "Hello!")
       # @param user_id [Integer] A Twitter user ID
-      # @param text [String] The text of your direct message, up to 10,000 characters.
-      # @param options [Hash] A customizable set of options.
+      # @param text [String] The text of the message (up to 10,000 characters)
+      # @param options [Hash] A customizable set of options
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Twitter::DirectMessage] The sent message
       def create_direct_message(user_id, text, options = {})
-        event = perform_request_with_object(:json_post, "/1.1/direct_messages/events/new.json", format_json_options(user_id, text, options), Twitter::DirectMessageEvent)
+        event = perform_request_with_object(:json_post, "/1.1/direct_messages/events/new.json", format_json_options(user_id, text, options), DirectMessageEvent)
         event.direct_message
       end
-      alias d create_direct_message
-      alias m create_direct_message
-      alias dm create_direct_message
 
-      # Create a new direct message event to the specified user from the authenticating user
+      # @!method d
+      #   @see #create_direct_message
+      #   @api public
+      #   @example
+      #     client.d(123456789, "Hello!")
+      #   @return [Twitter::DirectMessage]
+      alias_method :d, :create_direct_message
+
+      # @!method m
+      #   @see #create_direct_message
+      #   @api public
+      #   @example
+      #     client.m(123456789, "Hello!")
+      #   @return [Twitter::DirectMessage]
+      alias_method :m, :create_direct_message
+
+      # @!method dm
+      #   @see #create_direct_message
+      #   @api public
+      #   @example
+      #     client.dm(123456789, "Hello!")
+      #   @return [Twitter::DirectMessage]
+      alias_method :dm, :create_direct_message
+
+      # Creates a new direct message event to the specified user
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::DirectMessageEvent] The created direct message event.
-      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
-      # @param text [String] The text of your direct message, up to 10,000 characters.
-      # @param options [Hash] A customizable set of options.
+      # @example
+      #   client.create_direct_message_event(123456789, "Hello!")
+      # @overload create_direct_message_event(user, text, options = {})
+      #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
+      #   @param text [String] The text of the message (up to 10,000 characters).
+      #   @param options [Hash] A customizable set of options.
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Twitter::DirectMessageEvent] The created direct message event
       def create_direct_message_event(*args)
-        arguments = Twitter::Arguments.new(args)
-        options = arguments.options.dup
-        options[:event] = {type: "message_create", message_create: {target: {recipient_id: extract_id(arguments[0])}, message_data: {text: arguments[1]}}} if arguments.length >= 2
-        response = Twitter::REST::Request.new(self, :json_post, "/1.1/direct_messages/events/new.json", options).perform
-        Twitter::DirectMessageEvent.new(response[:event])
+        arguments = Arguments.new(args)
+        options = arguments.options
+        options[:event] = {type: "message_create", message_create: {target: {recipient_id: extract_id(arguments.fetch(0))}, message_data: {text: arguments.fetch(1)}}} if arguments.length.eql?(2)
+        response = Request.new(self, :json_post, "/1.1/direct_messages/events/new.json", options).perform
+        DirectMessageEvent.new(response)
       end
 
-      # Create a new direct message event to the specified user from the authenticating user with media
+      # Creates a direct message event with media attachment
       #
+      # @api public
       # @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event
       # @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/guides/attaching-media
-      # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+      # @note This method requires an access token with RWD permissions
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::DirectMessageEvent] The created direct message event.
-      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
-      # @param text [String] The text of your direct message, up to 10,000 characters.
-      # @param media [File] A media file (PNG, JPEG, GIF or MP4).
-      # @param options [Hash] A customizable set of options.
+      # @example
+      #   client.create_direct_message_event_with_media(123, "Hi!", File.new("image.png"))
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object
+      # @param text [String] The text of the message (up to 10,000 characters)
+      # @param media [File] A media file (PNG, JPEG, GIF or MP4)
+      # @param options [Hash] A customizable set of options
+      # @raise [Twitter::Error::Unauthorized] Error raised when credentials are not valid
+      # @return [Twitter::DirectMessageEvent] The created direct message event
       def create_direct_message_event_with_media(user, text, media, options = {})
-        media_id = upload(media, media_category_prefix: "dm")[:media_id]
-        options = options.dup
+        media_id = upload(media, media_category_prefix: "dm").fetch(:media_id) # steep:ignore NoMethod
         options[:event] = {type: "message_create", message_create: {target: {recipient_id: extract_id(user)}, message_data: {text:, attachment: {type: "media", media: {id: media_id}}}}}
-        response = Twitter::REST::Request.new(self, :json_post, "/1.1/direct_messages/events/new.json", options).perform
-        Twitter::DirectMessageEvent.new(response[:event])
+        response = Request.new(self, :json_post, "/1.1/direct_messages/events/new.json", options).perform
+        DirectMessageEvent.new(response)
       end
 
-    private
+      private
 
+      # Formats options for JSON direct message requests
+      #
+      # @api private
+      # @param user_id [Integer] The recipient user ID
+      # @param text [String] The message text
+      # @param options [Hash] Additional options
+      # @return [Hash]
       def format_json_options(user_id, text, options)
         {event: {type: "message_create", message_create: {target: {recipient_id: user_id}, message_data: {text:}.merge(options)}}}
       end