Module: Twitter::REST::DirectMessages::WelcomeMessages

Includes:
UploadUtils, Utils, Utils
Included in:
API
Defined in:
lib/twitter/rest/direct_messages/welcome_messages.rb

Overview

Methods for managing welcome messages in direct messages

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#create_welcome_message(text, name = nil, options = {}) ⇒ Twitter::DirectMessages::WelcomeMessage

Creates a new welcome message

Examples:

client.create_welcome_message("Welcome!", "default")

Parameters:

  • text (String) —

    The text of the welcome message

  • name (String) (defaults to: nil) —

    Optional name for the welcome message

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 24

def create_welcome_message(text, name = nil, options = {})
  json_options = {
    welcome_message: {
      message_data: {
        text:
      }
    }
  }
  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

#create_welcome_message_rule(welcome_message_id, options = {}) ⇒ Twitter::DirectMessages::WelcomeMessageRule

Creates a new welcome message rule

Examples:

client.create_welcome_message_rule(123456789)

Parameters:

  • welcome_message_id (Integer) —

    The ID of the welcome message

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Returns:



108
109
110
111
112
113
114
115
116
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 108

def create_welcome_message_rule(welcome_message_id, options = {})
  json_options = {
    welcome_message_rule: {
      welcome_message_id:
    }
  }
  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

#destroy_welcome_message(*ids) ⇒ nil

Destroys welcome messages

Examples:

client.destroy_welcome_message(123456789)

Parameters:

  • ids (Array<Integer>) —

    IDs of welcome messages to destroy

Returns:

  • (nil) 


44
45
46
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 44

def destroy_welcome_message(*ids)
  perform_requests(:delete, "/1.1/direct_messages/welcome_messages/destroy.json", ids)
end

#destroy_welcome_message_rule(*ids) ⇒ nil

Destroys welcome message rules

Examples:

client.destroy_welcome_message_rule(123456789)

Parameters:

  • ids (Array<Integer>) —

    IDs of welcome message rules to destroy

Returns:

  • (nil) 


125
126
127
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 125

def destroy_welcome_message_rule(*ids)
  perform_requests(:delete, "/1.1/direct_messages/welcome_messages/rules/destroy.json", ids)
end

#update_welcome_message(welcome_message_id, text, options = {}) ⇒ Twitter::DirectMessages::WelcomeMessage

Updates a welcome message

Examples:

client.update_welcome_message(123456789, "New text")

Parameters:

  • welcome_message_id (Integer) —

    The ID of the welcome message

  • text (String) —

    The new text for the welcome message

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 57

def update_welcome_message(welcome_message_id, text, options = {})
  params = {
    id: welcome_message_id
  }
  json_options = {
    message_data: {
      text:
    }
  }
  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

#welcome_message(id, options = {}) ⇒ Twitter::DirectMessages::WelcomeMessage

Returns a welcome message

Examples:

client.welcome_message(123456789)

Parameters:

  • id (Integer) —

    The ID of the welcome message

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Returns:



78
79
80
81
82
83
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 78

def welcome_message(id, options = {})
  options = options.dup
  options[:id] = id
  welcome_message_wrapper = perform_get_with_object("/1.1/direct_messages/welcome_messages/show.json", options, Twitter::DirectMessages::WelcomeMessageWrapper)
  welcome_message_wrapper.welcome_message
end

#welcome_message_list(options = {}) ⇒ Array<Twitter::DirectMessages::WelcomeMessage>

Returns a list of welcome messages

Examples:

client.welcome_message_list

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Options Hash (options):

  • :count (Integer) —

    Number of records to retrieve

Returns:



93
94
95
96
97
98
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 93

def welcome_message_list(options = {})
  limit = options.fetch(:count, 20)
  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(id, options = {}) ⇒ Twitter::DirectMessages::WelcomeMessageRule

Returns a welcome message rule

Examples:

client.welcome_message_rule(123456789)

Parameters:

  • id (Integer) —

    The ID of the welcome message rule

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Returns:



137
138
139
140
141
142
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 137

def welcome_message_rule(id, options = {})
  options = options.dup
  options[:id] = id
  rule_wrapper = perform_get_with_object("/1.1/direct_messages/welcome_messages/rules/show.json", options, Twitter::DirectMessages::WelcomeMessageRuleWrapper)
  rule_wrapper.welcome_message_rule
end

#welcome_message_rule_list(options = {}) ⇒ Array<Twitter::DirectMessages::WelcomeMessageRule>

Returns a list of welcome message rules

Examples:

client.welcome_message_rule_list

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options

Options Hash (options):

  • :count (Integer) —

    Number of records to retrieve

Returns:



152
153
154
155
156
157
 
# File 'lib/twitter/rest/direct_messages/welcome_messages.rb', line 152

def welcome_message_rule_list(options = {})
  limit = options.fetch(:count, 20)
  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