class OstKycSdkRuby::Saas::Users

Public Class Methods

new(params) click to toggle source

Initialize

Arguments:

api_base_url: (String)
api_key: (String)
api_secret: (String)
api_spec: (Boolean)
Calls superclass method OstKycSdkRuby::Saas::Base::new
# File lib/ost-kyc-sdk-ruby/saas/users.rb, line 15
def initialize(params)
  super
  @url_prefix = '/api/v2/users'
end

Public Instance Methods

create(params = {}) click to toggle source

Create a new user

Returns:

response: (OstKycSdkRuby::Util::Result)
# File lib/ost-kyc-sdk-ruby/saas/users.rb, line 25
def create(params = {})
  http_helper.send_post_request("#{@url_prefix}", params)
end
get(params) click to toggle source

Get an existing user

Returns:

response: (OstKycSdkRuby::Util::Result)
# File lib/ost-kyc-sdk-ruby/saas/users.rb, line 34
def get(params)
  http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
end
list(params = {}) click to toggle source

Fetches the list of an existing users

Returns:

response: (OstKycSdkRuby::Util::Result)
# File lib/ost-kyc-sdk-ruby/saas/users.rb, line 43
def list(params = {})
  http_helper.send_get_request("#{@url_prefix}", params)
end