Module: JPSClient::API::User

Included in:
Client
Defined in:
lib/jpsclient/api/user.rb

Overview

User 相关 API 自动生成的模块，处理 user 相关接口

Instance Method Summary collapse

Instance Method Details

#delete_user(userId:, params: {}) ⇒ Hash

Delete User

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



39
40
41
42
43
44
45
46
47
 
# File 'lib/jpsclient/api/user.rb', line 39

def delete_user(userId:, params: {})
  config = @request_config && @request_config["user_user"]
  raise JPSClient::ExceptionError, "Missing config for user_user" unless config && config["url"]

  path = config["url"]
  path = path.gsub("{userId}", userId.to_s)

  return request_with_auth(:delete, path)
end

#get_user_detail(userId:, params: {}) ⇒ Hash

Get User Detail

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



11
12
13
14
15
16
17
18
19
 
# File 'lib/jpsclient/api/user.rb', line 11

def get_user_detail(userId:, params: {})
  config = @request_config && @request_config["user_user_detail"]
  raise JPSClient::ExceptionError, "Missing config for user_user_detail" unless config && config["url"]

  path = config["url"]
  path = path.gsub("{userId}", userId.to_s)

  return request_with_auth(:get, path, params: params)
end

#get_users(params: {}) ⇒ Hash

Get Users

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



53
54
55
56
57
58
59
60
 
# File 'lib/jpsclient/api/user.rb', line 53

def get_users(params: {})
  config = @request_config && @request_config["user_users"]
  raise JPSClient::ExceptionError, "Missing config for user_users" unless config && config["url"]

  path = config["url"]

  return request_with_auth(:get, path, params: params)
end

#update_user(userId:, params: {}) ⇒ Hash

Update User

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



25
26
27
28
29
30
31
32
33
 
# File 'lib/jpsclient/api/user.rb', line 25

def update_user(userId:, params: {})
  config = @request_config && @request_config["user_user"]
  raise JPSClient::ExceptionError, "Missing config for user_user" unless config && config["url"]

  path = config["url"]
  path = path.gsub("{userId}", userId.to_s)

  return request_with_auth(:put, path, body: params)
end