Class: WhiteLabelMachineName::UserSpaceRoleService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserSpaceRoleService

Returns a new instance of UserSpaceRoleService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#add_role(user_id, space_id, role_id, opts = {}) ⇒ UserSpaceRole

Add Role This operation grants the given role to the user in the given space.

Parameters:

  • user_id —

    The id of the user to whom the role is assigned.

  • space_id —

    The space to which the role is mapped.

  • role_id —

    The role which is mapped to the user and space.

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

    the optional parameters

Returns:



35
36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 35

def add_role(user_id, space_id, role_id, opts = {})
  data, _status_code, _headers = add_role_with_http_info(user_id, space_id, role_id, opts)
  return data
end

#add_role_with_http_info(user_id, space_id, role_id, opts = {}) ⇒ Array<(UserSpaceRole, Fixnum, Hash)>

Add Role This operation grants the given role to the user in the given space.

Parameters:

  • user_id —

    The id of the user to whom the role is assigned.

  • space_id —

    The space to which the role is mapped.

  • role_id —

    The role which is mapped to the user and space.

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

    the optional parameters

Returns:

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

    UserSpaceRole data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 47

def add_role_with_http_info(user_id, space_id, role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserSpaceRoleService.add_role ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UserSpaceRoleService.add_role" if user_id.nil?
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling UserSpaceRoleService.add_role" if space_id.nil?
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling UserSpaceRoleService.add_role" if role_id.nil?
  # resource path
  local_var_path = "/user-space-role/addRole".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'spaceId'] = space_id
  query_params[:'roleId'] = role_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = []
  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 = []
  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,
    :return_type => 'UserSpaceRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserSpaceRoleService#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(user_id, space_id, opts = {}) ⇒ Array<UserSpaceRole>

List Roles List all the roles that are assigned to the given user in the given space.

Parameters:

  • user_id —

    The id of the user to whom the role is assigned.

  • space_id —

    The space to which the role is mapped.

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 102

def list(user_id, space_id, opts = {})
  data, _status_code, _headers = list_with_http_info(user_id, space_id, opts)
  return data
end

#list_with_http_info(user_id, space_id, opts = {}) ⇒ Array<(Array<UserSpaceRole>, Fixnum, Hash)>

List Roles List all the roles that are assigned to the given user in the given space.

Parameters:

  • user_id —

    The id of the user to whom the role is assigned.

  • space_id —

    The space to which the role is mapped.

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

    the optional parameters

Returns:

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

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



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
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 113

def list_with_http_info(user_id, space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserSpaceRoleService.list ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UserSpaceRoleService.list" if user_id.nil?
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling UserSpaceRoleService.list" if space_id.nil?
  # resource path
  local_var_path = "/user-space-role/list".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = []
  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 = []
  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,
    :return_type => 'Array<UserSpaceRole>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserSpaceRoleService#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_role(id, opts = {}) ⇒ nil

Remove Role This operation removes the specified user space role.

Parameters:

  • id —

    The id of user space role which should be removed

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

    the optional parameters

Returns:

  • (nil) 


164
165
166
167
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 164

def remove_role(id, opts = {})
  remove_role_with_http_info(id, opts)
  return nil
end

#remove_role_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove Role This operation removes the specified user space role.

Parameters:

  • id —

    The id of user space role which should be removed

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_space_role_service_api.rb', line 174

def remove_role_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserSpaceRoleService.remove_role ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling UserSpaceRoleService.remove_role" if id.nil?
  # resource path
  local_var_path = "/user-space-role/removeRole".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = []
  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 = []
  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: UserSpaceRoleService#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end