module Agilix::Buzz::Commands::Domain

Public Instance Methods

create_domains(items = []) click to toggle source

api.create_domains [{name: “BuzzTest1”, userspace: 'buzz-test-fc-1', parentid: '57025'}]

# File lib/agilix/buzz/commands/domain.rb, line 7
def create_domains(items = [])
  options = items.map do |item|
    argument_cleaner(required_params: %i( name userspace parentid ), optional_params: %i( reference flags data ), options: item )
  end
  authenticated_bulk_post cmd: "createdomains", root_node: 'domain', body: options
end
delete_domain(options = {}) click to toggle source

api.delete_domain domainid: '57031'

# File lib/agilix/buzz/commands/domain.rb, line 15
def delete_domain(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "deletedomain", **options
end
get_domain(options = {})
Alias for: get_domain2
get_domain2(options = {}) click to toggle source

api.get_domain domainid: '57025'

# File lib/agilix/buzz/commands/domain.rb, line 21
def get_domain2(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( select ), options: options )
  authenticated_get cmd: "getdomain2", **options
end
Also aliased as: get_domain
get_domain_content(options = {}) click to toggle source

api.get_domain_content domainid: '57025'

# File lib/agilix/buzz/commands/domain.rb, line 28
def get_domain_content(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "getdomaincontent", **options
end
get_domain_enrollment_metrics(options = {}) click to toggle source

api.get_domain_enrollment_metrics domainid: '57025'

# File lib/agilix/buzz/commands/domain.rb, line 34
def get_domain_enrollment_metrics(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( skipempty ), options: options )
  authenticated_get cmd: "getdomainenrollmentmetrics", **options
end
get_domain_parent_list(options = {}) click to toggle source

api.get_domain_parent_list domainid: '57025'

# File lib/agilix/buzz/commands/domain.rb, line 40
def get_domain_parent_list(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "getdomainparentlist", **options
end
get_domain_settings(options = {}) click to toggle source

api.get_domain_settings domainid: '57025', path: “AgilixBuzzSettings.xml”

# File lib/agilix/buzz/commands/domain.rb, line 46
def get_domain_settings(options = {})
  options = argument_cleaner(required_params: %i( domainid path ), optional_params: %i( includesource ), options: options )
  authenticated_get cmd: "getdomainsettings", **options
end
get_domain_stats(options = {}) click to toggle source

api.get_domain_stats domainid: '57025', options: “users|courses”

# File lib/agilix/buzz/commands/domain.rb, line 53
def get_domain_stats(options = {})
  # options = 'users|courses|activecourses|sections|enrollments|activeenrollments|activestudents'
  options = argument_cleaner(required_params: %i( domainid options ), optional_params: %i( includesource ), options: options )

  authenticated_get cmd: "getdomainstats", **options
end
list_domains(options = {}) click to toggle source

api.list_domains domainid: '0' # all domains for user api.list_domains domainid: '57025'

# File lib/agilix/buzz/commands/domain.rb, line 62
def list_domains(options = {})
  options[:domainid] ||= 0
  options = argument_cleaner(required_params: %i( domainid  ), optional_params: %i( includedescendantdomains limit show select text query ), options: options )
  authenticated_get cmd: "listdomains", **options
end
restore_domain(options = {}) click to toggle source

api.restore_domain domainid: '57031'

# File lib/agilix/buzz/commands/domain.rb, line 69
def restore_domain(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "restoredomain", **options
end
update_domains(items) click to toggle source

api.update_domains [{ domainid: “57031”, name: “BuzzTestUpdated1”, userspace: 'buzz-test-fc-1', parentid: '57025'}]

# File lib/agilix/buzz/commands/domain.rb, line 75
def update_domains(items)
  options = items.map do |item|
    argument_cleaner(required_params: %i( domainid  ), optional_params: %i( name userspace parentid reference flags data ), options: item )
  end
  authenticated_bulk_post cmd: "updatedomains", root_node: 'domain', body: options
end