module Agilix::Buzz::Commands::User

Public Instance Methods

create_users(items = [])
Alias for: create_users2
create_users2(items = []) click to toggle source

api.create_users [{ domainid: '57025', username: “BuzzUserTest1”, email: 'buzzusertest1@agilix.com', password: 'testpassword1234', firstname: 'Buzz', lastname: “Man”, passwordquestion: “Who's your best friend?”, passwordanswer: “Me”}]

# File lib/agilix/buzz/commands/user.rb, line 7
def create_users2(items = [])
  options = items.map do |item|
    argument_cleaner(required_params: %i( domainid username email password firstname lastname   ), optional_params: %i( passwordquestion passwordanswer reference flags rights roleid data ), options: item )
  end
  authenticated_bulk_post cmd: "createusers2", root_node: 'user', body: options
end
Also aliased as: create_users
delete_users(items = {}) click to toggle source

api.delete_users [userid: '57181']

# File lib/agilix/buzz/commands/user.rb, line 16
def delete_users(items = {})
  options = items.map do |item|
    argument_cleaner(required_params: %i( userid ), optional_params: %i( ), options: item )
  end
  authenticated_bulk_post cmd: "deleteusers", root_node: 'user', body: options
end
get_active_user_count(options = {}) click to toggle source

api.get_active_user_count domainid: '57025' api.get_active_user_count domainid: '5', includedescendantdomains: true, bymonth:true, startdate: '2018-01-01', enddate: '2019-03-01'

# File lib/agilix/buzz/commands/user.rb, line 25
def get_active_user_count(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i(includedescendantdomains persona startdate enddate byday bymonth byyear ), options: options)
  authenticated_get cmd: "getactiveusercount", **options
end
get_domain_activity(options = {}) click to toggle source

api.get_domain_activity domainid: '57025'

# File lib/agilix/buzz/commands/user.rb, line 31
def get_domain_activity(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( startdate enddate maxusers select ), options: options)
  authenticated_get cmd: "getdomainactivity", **options
end
get_profile_picture(options = {}) click to toggle source

api.get_profile_picture entityid: 57026

api.get_profile_picture entityid: 57025, default: "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mm"
# File lib/agilix/buzz/commands/user.rb, line 38
def get_profile_picture(options = {})
  options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( default ), options: options)
  authenticated_get cmd: "getprofilepicture", **options
end
get_user(options = {})
Alias for: get_user2
get_user2(options = {}) click to toggle source

api.get_user2 userid: 57026

# File lib/agilix/buzz/commands/user.rb, line 44
def get_user2(options = {})
  options = argument_cleaner(required_params: %i( userid ), optional_params: %i( select ), options: options)
  authenticated_get cmd: "getuser2", **options
end
Also aliased as: get_user
get_user_activity(options = {}) click to toggle source

api.get_user_activity userid: 57026

# File lib/agilix/buzz/commands/user.rb, line 51
def get_user_activity(options = {})
  options = argument_cleaner(required_params: %i( userid ), optional_params: %i( startdate enddate ), options: options)
  authenticated_get cmd: "getuseractivity", **options
end
get_user_activity_stream(options = {}) click to toggle source

api.get_user_activity_stream userid: 57026

# File lib/agilix/buzz/commands/user.rb, line 57
def get_user_activity_stream(options = {})
  options = argument_cleaner(required_params: %i( userid ), optional_params: %i( enrollmentid startkey limit types ), options: options)
  authenticated_get cmd: "getuseractivitystream", **options
end
list_users(options = {}) click to toggle source

api.list_users domainid: 57025

# File lib/agilix/buzz/commands/user.rb, line 63
def list_users(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( includedescendantdomains limit show select text query ), options: options)
  authenticated_get cmd: "listusers", **options
end
restore_user(options = {}) click to toggle source

api.restore_user userid: 57026

# File lib/agilix/buzz/commands/user.rb, line 69
def restore_user(options = {})
  options = argument_cleaner(required_params: %i( userid ), optional_params: %i( ), options: options)
  authenticated_get cmd: "restoreuser", **options
end
update_users(items) click to toggle source

api.update_users [{ userid: '57026', username: “BuzzUserTestUpdated1”, email: 'buzzusertest1@agilix.com',firstname: 'Buzz', lastname: “ManUpdated”}]

# File lib/agilix/buzz/commands/user.rb, line 75
def update_users(items)
  options = items.map do |item|
    argument_cleaner(required_params: %i( userid ), optional_params: %i( domainid username firstname lastname email reference flags data ), options: item)
  end
  authenticated_bulk_post cmd: "updateusers", root_node: 'user', body: options
end