module BWAPI::Client::Brandwatch::Clients::Users

Users module for brandwatch/users endpoints

Public Instance Methods

brandwatch_create_client_user(client_id, opts = {}) click to toggle source

Create a new client user

@param client_id [Integer] Id of the client @param opts [Hash] options Hash of parameters @option opts [String] address The users address @option opts [Array] apiRole The users api role @option opts [String] ccAccess The user Vizia access level @option opts [Integer] clientId The users client id @option opts [Date] creationDate Date the user was created on @option opts [String] department The users department @option opts [Boolean] enabled The status of the user @option opts [String] externalId The Users external Id @option opts [String] firstName The users first name @option opts [Integer] id Id of the user @option opts [String] job The users job @option opts [String] lastName The last name of the user @option opts [String] messenger The users IM details @option opts [String] mobile The users mobile number @option opts [String] oldPassword The old password of the user @option opts [String] password The password of the user @option opts [String] passwordConfirmation The confirmed password @option opts [String] phone The users phone number @option opts [Hash] tags The users assigned tags @option opts [String] uiRole The users ui role @option opts [String] username The users username @return [Hash] New user

# File lib/bwapi/client/brandwatch/clients/users.rb, line 40
def brandwatch_create_client_user(client_id, opts = {})
  post "brandwatch/clients/#{client_id}/users", opts
end
brandwatch_get_client_user(client_id, user_id, opts = {}) click to toggle source

Get a user in a client

TODO: Add parameters documentation

# File lib/bwapi/client/brandwatch/clients/users.rb, line 47
def brandwatch_get_client_user(client_id, user_id, opts = {})
  get "brandwatch/clients/#{client_id}/users/#{user_id}", opts
end
brandwatch_get_client_users(client_id, opts = {}) click to toggle source

List all users in a client

TODO: Add parameters documentation

# File lib/bwapi/client/brandwatch/clients/users.rb, line 10
def brandwatch_get_client_users(client_id, opts = {})
  get "brandwatch/clients/#{client_id}/users", opts
end
brandwatch_update_client_user(client_id, user_id, opts = {}) click to toggle source

Update a user in a client

TODO: Add parameters documentation

# File lib/bwapi/client/brandwatch/clients/users.rb, line 54
def brandwatch_update_client_user(client_id, user_id, opts = {})
  put "brandwatch/clients/#{client_id}/users/#{user_id}", opts
end