class OnappMarket::Admin

Market Administration Functions

Public Class Methods

new(api) click to toggle source

Create a new instance of Admin API

Attributes

  • api - The API to communicate over

# File lib/onapp_market/admin.rb, line 10
def initialize(api)
  raise "No OnAppMarket API specified" if api == nil
  @api = api
end

Public Instance Methods

add_user(user) click to toggle source

Add a user account

Attributes

Returns

Roles

admin

# File lib/onapp_market/admin.rb, line 23
def add_user(user)
  @api.post("/admin/user", OnappMarket::API::Serialize.to_hash(user))
end
del_user(user_id) click to toggle source

Delete a user

Attributes

  • user_id - user id of user to delete

Returns

Roles

admin

# File lib/onapp_market/admin.rb, line 61
def del_user(user_id)
  @api.delete("/admin/user/#{user_id.url_safe}")
end
get_user(user_id) click to toggle source

Get a user

Attributes

  • user_id - User id of user we wish to retrieve

Returns

Roles

admin

# File lib/onapp_market/admin.rb, line 35
def get_user(user_id)
  @api.get("/admin/user/#{user_id.url_safe}")
end
get_user_billing_data(user_id, start_date, end_date, period = :daily) click to toggle source

Get a user’s billing statistics

Attributes

  • user_id - user id of user whose billing data we require

  • start_date - DateTime - start date

  • end_date - DateTime - end date

  • period - Billing period: hourly|daily|monthly

Returns

Roles

admin

# File lib/onapp_market/admin.rb, line 76
def get_user_billing_data(user_id, start_date, end_date, period = :daily)
  @api.get("/admin/user/#{user_id.url_safe}/billing", {:start => start_date.rfc3339, :end => end_date.rfc3339, :period => period.to_s})
end
get_users(filter = {}, detail = false) click to toggle source

Get a list of users

Attributes

  • filter - Hash of exact match filters, for example: {:name => "Jon*"}, default none

  • detail - Detail or not, default not

Returns

Roles

admin

# File lib/onapp_market/admin.rb, line 49
def get_users(filter = {}, detail = false)
  @api.get("/admin/user", {:filter => filter, :detail => detail})
end