Module: JPSClient::API::Role

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

Overview

Role 相关 API 自动生成的模块，处理 role 相关接口

Instance Method Summary collapse

Instance Method Details

#create_menu(params: {}) ⇒ Hash

Create Menu

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



79
80
81
82
83
84
85
86
 
# File 'lib/jpsclient/api/role.rb', line 79

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

  path = config["url"]

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

#create_role(params: {}) ⇒ Hash

Create Role

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



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

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

  path = config["url"]

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

#create_user(params: {}) ⇒ Hash

Create User

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



66
67
68
69
70
71
72
73
 
# File 'lib/jpsclient/api/role.rb', line 66

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

  path = config["url"]

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

#delete_role(roleId:, params: {}) ⇒ Hash

Delete Role

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



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

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

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

  return request_with_auth(:delete, path)
end

#get_role_detail(roleId:, params: {}) ⇒ Hash

Get Role Detail

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



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

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

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

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

#get_roles(params: {}) ⇒ Hash

Get Roles

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



92
93
94
95
96
97
98
99
 
# File 'lib/jpsclient/api/role.rb', line 92

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

  path = config["url"]

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

#update_role(roleId:, params: {}) ⇒ Hash

Update Role

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



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

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

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

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