twitter 6.2.0 → 7.0.0

data/lib/twitter/null_object.rb

@@ -1,7 +1,7 @@
 require 'naught'
 
 module Twitter
-  NullObject = Naught.build do |config|
+  NullObject = Naught.build do |config| # rubocop:disable Metrics/BlockLength
     include Comparable
 
     config.black_hole
@@ -19,11 +19,13 @@ module Twitter
 
     def instance_of?(klass)
       raise(TypeError, 'class or module required') unless klass.is_a?(Class)
+
       self.class == klass
     end
 
     def kind_of?(mod)
       raise(TypeError, 'class or module required') unless mod.is_a?(Module)
+
       self.class.ancestors.include?(mod)
     end
 
@@ -48,5 +50,17 @@ module Twitter
     def to_json(*args)
       nil.to_json(*args)
     end
+
+    def presence
+      nil
+    end
+
+    def blank?
+      true
+    end
+
+    def present?
+      false
+    end
   end
 end

data/lib/twitter/premium_search_results.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+require 'twitter/enumerable'
+require 'twitter/rest/request'
+require 'twitter/utils'
+require 'uri'
+
+module Twitter
+  class PremiumSearchResults
+    include Twitter::Enumerable
+    include Twitter::Utils
+    # @return [Hash]
+    attr_reader :attrs
+    alias to_h attrs
+    alias to_hash to_h
+
+    # Initializes a new SearchResults object
+    #
+    # @param request [Twitter::REST::Request]
+    # @return [Twitter::PremiumSearchResults]
+    def initialize(request, request_config = {})
+      @client = request.client
+      @request_method = request.verb
+      @path = request.path
+      @options = request.options
+      @request_config = request_config
+      @collection = []
+      self.attrs = request.perform
+    end
+
+  private
+
+    # @return [Boolean]
+    def last?
+      !next_page?
+    end
+
+    # @return [Boolean]
+    def next_page?
+      !!@attrs[:next]
+    end
+
+    # Returns a Hash of query parameters for the next result in the search
+    #
+    # @note Returned Hash can be merged into the previous search options list to easily access the next page.
+    # @return [Hash] The parameters needed to fetch the next page.
+    def next_page
+      {next: @attrs[:next]} if next_page?
+    end
+
+    # @return [Hash]
+    def fetch_next_page
+      request = @client.premium_search(@options[:query], (@options.reject { |k| k == :query } || {}).merge(next_page), @request_config)
+
+      self.attrs = request.attrs
+    end
+
+    # @param attrs [Hash]
+    # @return [Hash]
+    def attrs=(attrs)
+      @attrs = attrs
+      @attrs.fetch(:results, []).collect do |tweet|
+        @collection << Tweet.new(tweet)
+      end
+      @attrs
+    end
+  end
+end

data/lib/twitter/profile.rb

@@ -4,8 +4,8 @@ require 'memoizable'
 
 module Twitter
   module Profile
-    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/i
-    PREDICATE_URI_METHOD_REGEX = /_uri\?$/
+    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/i.freeze
+    PREDICATE_URI_METHOD_REGEX = /_uri\?$/.freeze
     include Memoizable
 
     class << self

data/lib/twitter/rate_limit.rb

@@ -7,14 +7,14 @@ module Twitter
     # @return [Integer]
     def limit
       limit = @attrs['x-rate-limit-limit']
-      limit.to_i if limit
+      limit&.to_i
     end
     memoize :limit
 
     # @return [Integer]
     def remaining
       remaining = @attrs['x-rate-limit-remaining']
-      remaining.to_i if remaining
+      remaining&.to_i
     end
     memoize :remaining
 

data/lib/twitter/rest/account_activity.rb

@@ -0,0 +1,99 @@
+require 'twitter/rest/request'
+require 'twitter/rest/utils'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module AccountActivity
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # Registers a webhook URL for all event types. The URL will be validated via CRC request before saving. In case the validation failed, returns comprehensive error message to the requester.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-webhooks
+      # @note Create a webhook
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Hash]
+      # @param env_name [String] Environment Name.
+      # @param url [String] Encoded URL for the callback endpoint.
+      def create_webhook(env_name, url)
+        perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/webhooks.json?url=#{url}")
+      end
+
+      # Returns all environments, webhook URLs and their statuses for the authenticating app. Currently, only one webhook URL can be registered to each environment.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-webhooks
+      # @note List webhooks
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Hash]
+      # @param env_name [String] Environment Name.
+      def list_webhooks(env_name)
+        perform_request(:get, "/1.1/account_activity/all/#{env_name}/webhooks.json")
+      end
+
+      # Removes the webhook from the provided application's all activities configuration. The webhook ID can be accessed by making a call to GET /1.1/account_activity/all/webhooks.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-webhooks-webhook-id
+      # @note Delete a webhook
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name.
+      # @param webhook_id [String] Webhook ID.
+      def delete_webhook(env_name, webhook_id)
+        perform_request(:delete, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
+      end
+
+      # Triggers the challenge response check (CRC) for the given enviroments webhook for all activites. If the check is successful, returns 204 and reenables the webhook by setting its status to valid.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#put-account-activity-all-env-name-webhooks-webhook-id
+      # @note Trigger CRC check to a webhook
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name.
+      # @param webhook_id [String] Webhook ID.
+      def trigger_crc_check(env_name, webhook_id)
+        perform_request(:json_put, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
+      end
+
+      # Subscribes the provided application to all events for the provided environment for all message types. After activation, all events for the requesting user will be sent to the application's webhook via POST request.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-subscriptions
+      # @note Subscribe the user(whose credentials are provided) to the app so that the webhook can receive all types of events from user
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def create_subscription(env_name)
+        perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+
+      # Provides a way to determine if a webhook configuration is subscribed to the provided user's events. If the provided user context has an active subscription with provided application, returns 204 OK.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-env-name-subscriptions
+      # @note Check if the user is subscribed to the given app
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def check_subscription(env_name)
+        perform_request(:get, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+
+      # Deactivates subscription(s) for the provided user context and application for all activities. After deactivation, all events for the requesting user will no longer be sent to the webhook URL.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-subscriptions
+      # @note Deactivate a subscription, Users events will not be sent to the app
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def deactivate_subscription(env_name)
+        perform_request(:delete, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+    end
+  end
+end

data/lib/twitter/rest/api.rb

@@ -1,4 +1,6 @@
+require 'twitter/rest/account_activity'
 require 'twitter/rest/direct_messages'
+require 'twitter/rest/direct_messages/welcome_messages'
 require 'twitter/rest/favorites'
 require 'twitter/rest/friends_and_followers'
 require 'twitter/rest/help'
@@ -7,6 +9,7 @@ require 'twitter/rest/oauth'
 require 'twitter/rest/places_and_geo'
 require 'twitter/rest/saved_searches'
 require 'twitter/rest/search'
+require 'twitter/rest/premium_search'
 require 'twitter/rest/spam_reporting'
 require 'twitter/rest/suggested_users'
 require 'twitter/rest/timelines'
@@ -20,13 +23,16 @@ module Twitter
     # @note All methods have been separated into modules and follow the same grouping used in {http://dev.twitter.com/doc the Twitter API Documentation}.
     # @see https://dev.twitter.com/overview/general/things-every-developer-should-know
     module API
+      include Twitter::REST::AccountActivity
       include Twitter::REST::DirectMessages
+      include Twitter::REST::DirectMessages::WelcomeMessages
       include Twitter::REST::Favorites
       include Twitter::REST::FriendsAndFollowers
       include Twitter::REST::Help
       include Twitter::REST::Lists
       include Twitter::REST::OAuth
       include Twitter::REST::PlacesAndGeo
+      include Twitter::REST::PremiumSearch
       include Twitter::REST::SavedSearches
       include Twitter::REST::Search
       include Twitter::REST::SpamReporting

data/lib/twitter/rest/direct_messages.rb

@@ -1,5 +1,7 @@
 require 'twitter/arguments'
 require 'twitter/direct_message'
+require 'twitter/direct_message_event'
+require 'twitter/rest/upload_utils'
 require 'twitter/rest/utils'
 require 'twitter/user'
 require 'twitter/utils'
@@ -7,59 +9,103 @@ require 'twitter/utils'
 module Twitter
   module REST
     module DirectMessages
+      include Twitter::REST::UploadUtils
       include Twitter::REST::Utils
       include Twitter::Utils
 
-      # Returns the 20 most recent direct messages sent to the authenticating user
-      #
-      # @see https://dev.twitter.com/rest/reference/get/direct_messages
+      # Returns all Direct Message events for the authenticated user (both sent and received) within the last 30 days. Sorted in reverse-chronological order.
+      # @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.
+      # @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.
+      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: limit), :events, Twitter::DirectMessageEvent)
+      end
+
+      # Returns all Direct Messages for the authenticated user (both sent and received) within the last 30 days. Sorted in reverse-chronological order.
+      # @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.
+      # @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.
+      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.
+      # @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.
       # @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 to the authenticating user.
+      # @return [Array<Twitter::DirectMessage>] Direct messages received by the authenticating user.
       # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
-      # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
-      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
-      # @option options [Integer] :page Specifies the page of results to retrieve.
+      # @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 50
+      # this count does not directly correspond to the output, as we pull sent and received messages from twitter and only present received to the user
+      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
       def direct_messages_received(options = {})
-        perform_get_with_objects('/1.1/direct_messages.json', options, Twitter::DirectMessage)
+        limit = options.fetch(:count, 20)
+        direct_messages_list(options).select { |dm| dm.recipient_id == user_id }.first(limit)
       end
 
-      # Returns the 20 most recent direct messages sent by the authenticating user
-      #
-      # @see https://dev.twitter.com/rest/reference/get/direct_messages/sent
+      # Returns Direct Messages sent by the authenticated user within the last 30 days. Sorted in reverse-chronological order.
+      # @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.
       # @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] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
-      # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
-      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
-      # @option options [Integer] :page Specifies the page of results to retrieve.
+      # @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 50
+      # this count does not directly correspond to the output, as we pull sent and received messages from twitter and only present received to the user
+      # @option options [String] :cursor Specifies the cursor position of results to retrieve.
       def direct_messages_sent(options = {})
-        perform_get_with_objects('/1.1/direct_messages/sent.json', options, Twitter::DirectMessage)
+        limit = options.fetch(:count, 20)
+        direct_messages_list(options).select { |dm| dm.sender_id == user_id }.first(limit)
       end
 
       # Returns a direct message
       #
-      # @see https://dev.twitter.com/rest/reference/get/direct_messages/show
+      # @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.
       # @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 messages.
+      # @return [Twitter::DirectMessage] The requested message.
       # @param id [Integer] A direct message ID.
       # @param options [Hash] A customizable set of options.
+
       def direct_message(id, options = {})
+        direct_message_event(id, options).direct_message
+      end
+
+      # Returns a direct message event
+      #
+      # @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.
+      # @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.
+      def direct_message_event(id, options = {})
         options = options.dup
         options[:id] = id
-        perform_get_with_object('/1.1/direct_messages/show.json', options, Twitter::DirectMessage)
+        perform_get_with_object('/1.1/direct_messages/events/show.json', options, Twitter::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.
       # @rate_limited Yes
       # @authentication Requires user context
@@ -67,13 +113,12 @@ module Twitter
       # @return [Array<Twitter::DirectMessage>] The requested messages.
       # @overload direct_messages(options = {})
       #   Returns the 20 most recent direct messages sent to the authenticating user
-      #
-      #   @see https://dev.twitter.com/rest/reference/get/direct_messages
+
+      #   @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] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
-      #   @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
-      #   @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
-      #   @option options [Integer] :page Specifies the page of results to retrieve.
+      #   @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 50
+      #   this count does not directly correspond to the output, as we pull sent and received messages from twitter and only present received to the user
+      #   @option options [String] :cursor Specifies the cursor position of results to retrieve.
       # @overload direct_messages(*ids)
       #   Returns direct messages
       #
@@ -98,40 +143,84 @@ module Twitter
 
       # Destroys direct messages
       #
-      # @see https://dev.twitter.com/rest/reference/post/direct_messages/destroy
+      # @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.
-      # @rate_limited No
+      # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Array<Twitter::DirectMessage>] Deleted direct message.
+      # @return [nil] Response body from Twitter is nil if successful
       # @overload destroy_direct_message(*ids)
       #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
-      # @overload destroy_direct_message(*ids, options)
-      #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
-      #   @param options [Hash] A customizable set of options.
-      def destroy_direct_message(*args)
-        parallel_objects_from_response(Twitter::DirectMessage, :post, '/1.1/direct_messages/destroy.json', args)
+      def destroy_direct_message(*ids)
+        pmap(ids) do |id|
+          perform_requests(:delete, '/1.1/direct_messages/events/destroy.json', id: id)
+        end
+        nil
       end
 
       # Sends a new direct message to the specified user from the authenticating user
       #
-      # @see https://dev.twitter.com/rest/reference/post/direct_messages/new
-      # @rate_limited No
+      # @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.
-      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
+      # @param user [Integer, String, Twitter::User] 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.
-      def create_direct_message(user, text, options = {})
-        options = options.dup
-        merge_user!(options, user)
-        options[:text] = text
-        perform_post_with_object('/1.1/direct_messages/new.json', options, Twitter::DirectMessage)
+      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.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
+      #
+      # @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.
+      # @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.
+      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])
+      end
+
+      # Create a new direct message event to the specified user from the authenticating user with media
+      #
+      # @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.
+      # @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.
+      def create_direct_message_event_with_media(user, text, media, options = {})
+        media_id = upload(media, media_category_prefix: 'dm')[:media_id]
+        options = options.dup
+        options[:event] = {type: 'message_create', message_create: {target: {recipient_id: extract_id(user)}, message_data: {text: 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])
+      end
+
+    private
+
+      def format_json_options(user_id, text, options)
+        {'event': {'type': 'message_create', 'message_create': {'target': {'recipient_id': user_id}, 'message_data': {'text': text}.merge(options)}}}
+      end
     end
   end
 end