Class: OSDNClient::UserApi

Inherits:
Object
  • Object
show all
Defined in:
lib/osdn-client/api/user_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



30
31
32
 
# File 'lib/osdn-client/api/user_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/osdn-client/api/user_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#get_user(id_or_name, opts = {}) ⇒ User

Get user profile.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/osdn-client/api/user_api.rb', line 39

def get_user(id_or_name, opts = {})
  data, _status_code, _headers = get_user_with_http_info(id_or_name, opts)
  return data
end

#get_user_history(id_or_name, opts = {}) ⇒ Array<History>

get user monthly stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/osdn-client/api/user_api.rb', line 96

def get_user_history(id_or_name, opts = {})
  data, _status_code, _headers = get_user_history_with_http_info(id_or_name, opts)
  return data
end

#get_user_history_with_http_info(id_or_name, opts = {}) ⇒ Array<(Array<History>, Fixnum, Hash)>

get user monthly stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:

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

    Array<History> data, response status code and response headers



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/osdn-client/api/user_api.rb', line 106

def get_user_history_with_http_info(id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.get_user_history ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.get_user_history" if id_or_name.nil?
  # resource path
  local_var_path = "/user/{id_or_name}/history".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  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 => 'Array<History>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_stats_daily(id_or_name, opts = {}) ⇒ Array<UserStats>

get user daily stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/osdn-client/api/user_api.rb', line 153

def get_user_stats_daily(id_or_name, opts = {})
  data, _status_code, _headers = get_user_stats_daily_with_http_info(id_or_name, opts)
  return data
end

#get_user_stats_daily_with_http_info(id_or_name, opts = {}) ⇒ Array<(Array<UserStats>, Fixnum, Hash)>

get user daily stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:

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

    Array<UserStats> data, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/osdn-client/api/user_api.rb', line 163

def get_user_stats_daily_with_http_info(id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.get_user_stats_daily ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.get_user_stats_daily" if id_or_name.nil?
  # resource path
  local_var_path = "/user/{id_or_name}/stats/daily".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  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 => 'Array<UserStats>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user_stats_daily\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_stats_monthly(id_or_name, opts = {}) ⇒ Array<UserStats>

get user monthly stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/osdn-client/api/user_api.rb', line 210

def get_user_stats_monthly(id_or_name, opts = {})
  data, _status_code, _headers = get_user_stats_monthly_with_http_info(id_or_name, opts)
  return data
end

#get_user_stats_monthly_with_http_info(id_or_name, opts = {}) ⇒ Array<(Array<UserStats>, Fixnum, Hash)>

get user monthly stats.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:

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

    Array<UserStats> data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/osdn-client/api/user_api.rb', line 220

def get_user_stats_monthly_with_http_info(id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.get_user_stats_monthly ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.get_user_stats_monthly" if id_or_name.nil?
  # resource path
  local_var_path = "/user/{id_or_name}/stats/monthly".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  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 => 'Array<UserStats>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user_stats_monthly\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_with_http_info(id_or_name, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get user profile.

Parameters:

  • id_or_name —

    numeric user id or user name

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



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
84
85
86
87
88
89
 
# File 'lib/osdn-client/api/user_api.rb', line 49

def get_user_with_http_info(id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.get_user ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.get_user" if id_or_name.nil?
  # resource path
  local_var_path = "/user/{id_or_name}".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_icon(id_or_name, image, opts = {}) ⇒ nil

Update user icon, the image will be resized to 12x12 automatically.

Parameters:

  • id_or_name —

    numeric user id or user name

  • image —

    The image data to update, you need to send with multipart/form-data.

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

    the optional parameters

Returns:

  • (nil) 


268
269
270
271
 
# File 'lib/osdn-client/api/user_api.rb', line 268

def update_user_icon(id_or_name, image, opts = {})
  update_user_icon_with_http_info(id_or_name, image, opts)
  return nil
end

#update_user_icon_with_http_info(id_or_name, image, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update user icon, the image will be resized to 12x12 automatically.

Parameters:

  • id_or_name —

    numeric user id or user name

  • image —

    The image data to update, you need to send with multipart/form-data.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/osdn-client/api/user_api.rb', line 279

def update_user_icon_with_http_info(id_or_name, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.update_user_icon ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.update_user_icon" if id_or_name.nil?
  # verify the required parameter 'image' is set
  fail ArgumentError, "Missing the required parameter 'image' when calling UserApi.update_user_icon" if image.nil?
  # resource path
  local_var_path = "/user/{id_or_name}/icon".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['multipart/form-data']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["image"] = image

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user_icon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_photo(id_or_name, image, opts = {}) ⇒ nil

Update user profile photo.

Parameters:

  • id_or_name —

    numeric user id or user name

  • image —

    The image data to update, you need to send with multipart/form-data.

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

    the optional parameters

Returns:

  • (nil) 


329
330
331
332
 
# File 'lib/osdn-client/api/user_api.rb', line 329

def update_user_photo(id_or_name, image, opts = {})
  update_user_photo_with_http_info(id_or_name, image, opts)
  return nil
end

#update_user_photo_with_http_info(id_or_name, image, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update user profile photo.

Parameters:

  • id_or_name —

    numeric user id or user name

  • image —

    The image data to update, you need to send with multipart/form-data.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/osdn-client/api/user_api.rb', line 340

def update_user_photo_with_http_info(id_or_name, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.update_user_photo ..."
  end
  # verify the required parameter 'id_or_name' is set
  fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.update_user_photo" if id_or_name.nil?
  # verify the required parameter 'image' is set
  fail ArgumentError, "Missing the required parameter 'image' when calling UserApi.update_user_photo" if image.nil?
  # resource path
  local_var_path = "/user/{id_or_name}/photo".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['multipart/form-data']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["image"] = image

  # http body (model)
  post_body = nil
  auth_names = ['oauth2-code', 'oauth2-implicit']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end