Class: WhatpulseSdk::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/whatpulse-sdk/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/whatpulse-sdk/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/whatpulse-sdk/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_users_index(opts = {}) ⇒ V1UsersIndex200Response

Search users Search for users by username. Returns a paginated list of users matching the search criteria. Only public user information (ID and username) is returned. The search is case-insensitive and matches partial usernames.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String)
  • :per_page (String)

Returns:



28
29
30
31
 
# File 'lib/whatpulse-sdk/api/users_api.rb', line 28

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

#v1_users_index_with_http_info(opts = {}) ⇒ Array<(V1UsersIndex200Response, Integer, Hash)>

Search users Search for users by username. Returns a paginated list of users matching the search criteria. Only public user information (ID and username) is returned. The search is case-insensitive and matches partial usernames.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String)
  • :per_page (String)

Returns:

  • (Array<(V1UsersIndex200Response, Integer, Hash)>) —

    V1UsersIndex200Response data, response status code and response headers



39
40
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
80
81
82
83
 
# File 'lib/whatpulse-sdk/api/users_api.rb', line 39

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1UsersIndex200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['http']

  new_options = opts.merge(
    :operation => :"UsersApi.v1_users_index",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#v1_users_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_users_show(id, opts = {}) ⇒ V1UsersShow200Response

Get user details Get detailed information about a specific user. Returns public profile information that can be viewed by anyone, or private information if you’re viewing your own profile or have the appropriate permissions.

Parameters:

  • id (String) —

    User ID or username

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/whatpulse-sdk/api/users_api.rb', line 90

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

#v1_users_show_with_http_info(id, opts = {}) ⇒ Array<(V1UsersShow200Response, Integer, Hash)>

Get user details Get detailed information about a specific user. Returns public profile information that can be viewed by anyone, or private information if you&#39;re viewing your own profile or have the appropriate permissions.

Parameters:

  • id (String) —

    User ID or username

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

    the optional parameters

Returns:

  • (Array<(V1UsersShow200Response, Integer, Hash)>) —

    V1UsersShow200Response data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/whatpulse-sdk/api/users_api.rb', line 100

def v1_users_show_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.v1_users_show ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.v1_users_show"
  end
  # resource path
  local_var_path = '/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1UsersShow200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['http']

  new_options = opts.merge(
    :operation => :"UsersApi.v1_users_show",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#v1_users_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end