Class: SamplifyAPIClient::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/samplify_api_client/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



19
20
21
 
# File 'lib/samplify_api_client/api/users_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/samplify_api_client/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#users_get_user_info(opts = {}) ⇒ UserInfo

getUserInfo users

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :app_id (Integer) —

    Only return apps with the given id

  • :current (BOOLEAN) —

    Only return current app for the user id

  • :default (BOOLEAN) —

    Only return default app for the user id

  • :name (String) —

    Only return apps with the given name

Returns:



29
30
31
32
 
# File 'lib/samplify_api_client/api/users_api.rb', line 29

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#users_get_user_info_with_http_info(opts = {}) ⇒ Array<(UserInfo, Fixnum, Hash)>

getUserInfo users

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :app_id (Integer) —

    Only return apps with the given id

  • :current (BOOLEAN) —

    Only return current app for the user id

  • :default (BOOLEAN) —

    Only return default app for the user id

  • :name (String) —

    Only return apps with the given name

Returns:

  • (Array<(UserInfo, Fixnum, Hash)>) —

    UserInfo data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/samplify_api_client/api/users_api.rb', line 41

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_get_user_info ...'
  end
  # resource path
  local_var_path = '/sample/v1/users/info'

  # query parameters
  query_params = {}
  query_params[:'appId'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'current'] = opts[:'current'] if !opts[:'current'].nil?
  query_params[:'default'] = opts[:'default'] if !opts[:'default'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.userinfo+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml', 'application/gob', 'application/x-gob'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jwt']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#users_get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end