module Croudia::API::SecretMails

Public Instance Methods

destroy_secret_mail(id, params={}) click to toggle source

Destroy a secret mail

@see developer.croudia.com/docs/24_secret_mails_destroy @param [String, Integer, Croudia::SecretMail] id ID of the secret mail to delete @param [Hash] params Additional query params @return [Croudia::SecretMail] Deleted secret mail

# File lib/croudia/api/secret_mails.rb, line 83
def destroy_secret_mail(id, params={})
  resp = post("/secret_mails/destroy/#{get_id(id)}.json", params)
  Croudia::SecretMail.new(resp)
end
secret_mails(params={}) click to toggle source

Get incoming secret mails

@see developer.croudia.com/docs/21_secret_mails @param [Hash] params Additional query parameters @option params [String, Integer] :count Number of secret mails in the response @option params [String, Integer] :max_id Paging parameter @option params [String, Integer] :since_id Paging parameter @return [Array<Croudia::SecretMail>]

# File lib/croudia/api/secret_mails.rb, line 14
def secret_mails(params={})
  resp = get('/secret_mails.json', params)
  objects(Croudia::SecretMail, resp)
end
secret_mails_sent(params={}) click to toggle source

Get outgoing secret mails

@see developer.croudia.com/docs/22_secret_mails_sent @param [Hash] params Additional query parameters @option params [String, Integer] :count Number of secret mails in the response @option params [String, Integer] :max_id Paging parameter @option params [String, Integer] :since_id Paging parameter @return [Array<Croudia::SecretMail>]

# File lib/croudia/api/secret_mails.rb, line 27
def secret_mails_sent(params={})
  resp = get('/secret_mails/sent.json', params)
  objects(Croudia::SecretMail, resp)
end
secret_photo(id) click to toggle source

Get an image attached to a secret mail

@see developer.croudia.com/docs/27_secret_mails_get_secret_photo @param [String, Integer] id Image ID @return [String] Raw image

# File lib/croudia/api/secret_mails.rb, line 104
def secret_photo(id)
  get("/secret_mails/get_secret_photo/#{id}")
end
send_secret_mail(text, to_user={}, params={}) click to toggle source

Send a new secret mail

@see developer.croudia.com/docs/23_secret_mails_new @overload send_secret_mail(text, to_user, params={})

@param [String] text Message body
@param [String, Integer, Croudia::User] to_user Recipient user
@param [Hash] params Additional query parameters

@overload send_secret_mail(params={})

@param [Hash] params Query parameters
@option params [String] :screen_name Screen name of the recipient
@option params [String] :text Message body
@option params [String, Integer] :user_id ID of the recipient

@return [Croudia::SecretMail] Sent message

# File lib/croudia/api/secret_mails.rb, line 45
def send_secret_mail(text, to_user={}, params={})
  merge_text!(params, text, :text)
  merge_user!(params, to_user)

  resp = post('/secret_mails/new.json', params)
  Croudia::SecretMail.new(resp)
end
send_secret_mail_with_media(text, to_user={}, media={}, params={}) click to toggle source

Send a new secret mail with media

@see developer.croudia.com/docs/26_secret_mails_new_with_media @overload send_secret_mail_with_media(text, to_user, media, params={})

@param [String] text Message body
@param [String, Integer, Croudia::User] to_user Recipient user
@param [File, #to_io] media Image to upload with
@param [Hash] params Additional query parameters

@overload send_secret_mail_with_media(params={})

@param [Hash] params Query parameters
@option params [File, #to_io] :media Image to upload with
@option params [String] :screen_name Screen name of the recipient
@option params [String] :text Message body
@option params [String, Integer] :user_id ID of the recipient

@return [Croudia::SecretMail] Sent message

# File lib/croudia/api/secret_mails.rb, line 68
def send_secret_mail_with_media(text, to_user={}, media={}, params={})
  merge_text!(params, text, :text)
  merge_user!(params, to_user)
  merge_file!(params, media, :media)

  resp = post('/secret_mails/new_with_media.json')
  Croudia::SecretMail.new(resp)
end
show_secret_mail(id, params={}) click to toggle source

Get a secret mail

@see developer.croudia.com/docs/25_secret_mails_show @param [String, Integer, Croudia::SecretMail] id ID of the secret mail to get @param [Hash] params Additional query parameters @return [Croudia::SecretMail]

# File lib/croudia/api/secret_mails.rb, line 94
def show_secret_mail(id, params={})
  resp = get("/secret_mails/show/#{get_id(id)}.json", params)
  Croudia::SecretMail.new(resp)
end