Module: BWAPI::Client::User::TwitterCredentials

Included in:
BWAPI::Client::User
Defined in:
lib/bwapi/client/user/twitter_credentials.rb

Overview

TwitterCredentials module for user/twittercredentials endpoints

Instance Method Summary collapse

Instance Method Details

#delete_twitter_credentialsHash

Delete the current user’s Twitter credentials

Returns:

  • (Hash)

    Current users deleted Twitter credentials



27
28
29
# File 'lib/bwapi/client/user/twitter_credentials.rb', line 27

def delete_twitter_credentials
  delete '/user/twittercredentials'
end

#twitter_credentialsHash

Retrieve the current user’s Twitter credentials

Returns:

  • (Hash)

    Current users Twitter credentials



9
10
11
# File 'lib/bwapi/client/user/twitter_credentials.rb', line 9

def twitter_credentials
  get '/user/twittercredentials'
end

#update_twitter_credentials(opts = {}) ⇒ Hash

Update the current user’s Twitter credentials

Parameters:

  • opts (Hash) (defaults to: {})

    options Hash of parameters

Options Hash (opts):

  • 'consumerKey' (string)

    Twitter Consumer Key,

  • 'accessToken' (string)

    Twitter Access Token,

  • 'accessTokenSecret' (string)

    Twitter TokenSecret

Returns:

  • (Hash)

    Current user Twitter User credentials



20
21
22
# File 'lib/bwapi/client/user/twitter_credentials.rb', line 20

def update_twitter_credentials(opts = {})
  put '/user/twittercredentials', opts
end