Class: DependencyTracker::PermissionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/api/permission_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PermissionApi 



19
20
21
 
# File 'lib/dependency-tracker-client/api/permission_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/dependency-tracker-client/api/permission_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_permission_to_team(uuid, permission, opts = {}) ⇒ Team

Adds the permission to the specified username. Requires ‘manage users’ permission.



28
29
30
31
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 28

def add_permission_to_team(uuid, permission, opts = {})
  data, _status_code, _headers = add_permission_to_team_with_http_info(uuid, permission, opts)
  data
end

#add_permission_to_team_with_http_info(uuid, permission, opts = {}) ⇒ Array<(Team, Integer, Hash)>

Adds the permission to the specified username. Requires &#39;manage users&#39; permission.



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
84
85
86
87
88
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 39

def add_permission_to_team_with_http_info(uuid, permission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionApi.add_permission_to_team ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling PermissionApi.add_permission_to_team"
  end
  # verify the required parameter 'permission' is set
  if @api_client.config.client_side_validation && permission.nil?
    fail ArgumentError, "Missing the required parameter 'permission' when calling PermissionApi.add_permission_to_team"
  end
  # resource path
  local_var_path = '/v1/permission/{permission}/team/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s)).sub('{' + 'permission' + '}', CGI.escape(permission.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Team' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionApi#add_permission_to_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_permission_to_user(username, permission, opts = {}) ⇒ UserPrincipal

Adds the permission to the specified username.



95
96
97
98
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 95

def add_permission_to_user(username, permission, opts = {})
  data, _status_code, _headers = add_permission_to_user_with_http_info(username, permission, opts)
  data
end

#add_permission_to_user_with_http_info(username, permission, opts = {}) ⇒ Array<(UserPrincipal, Integer, Hash)>

Adds the permission to the specified username.



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
147
148
149
150
151
152
153
154
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 105

def add_permission_to_user_with_http_info(username, permission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionApi.add_permission_to_user ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling PermissionApi.add_permission_to_user"
  end
  # verify the required parameter 'permission' is set
  if @api_client.config.client_side_validation && permission.nil?
    fail ArgumentError, "Missing the required parameter 'permission' when calling PermissionApi.add_permission_to_user"
  end
  # resource path
  local_var_path = '/v1/permission/{permission}/user/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'permission' + '}', CGI.escape(permission.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'UserPrincipal' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionApi#add_permission_to_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_permissions(opts = {}) ⇒ Array<Permission>

Returns a list of all permissions



159
160
161
162
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 159

def get_all_permissions(opts = {})
  data, _status_code, _headers = get_all_permissions_with_http_info(opts)
  data
end

#get_all_permissions_with_http_info(opts = {}) ⇒ Array<(Array<Permission>, Integer, Hash)>

Returns a list of all permissions



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
204
205
206
207
208
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 167

def get_all_permissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionApi.get_all_permissions ...'
  end
  # resource path
  local_var_path = '/v1/permission'

  # 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<Permission>' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :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: PermissionApi#get_all_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_permission_from_team(uuid, permission, opts = {}) ⇒ Team

Removes the permission from the team.



215
216
217
218
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 215

def remove_permission_from_team(uuid, permission, opts = {})
  data, _status_code, _headers = remove_permission_from_team_with_http_info(uuid, permission, opts)
  data
end

#remove_permission_from_team_with_http_info(uuid, permission, opts = {}) ⇒ Array<(Team, Integer, Hash)>

Removes the permission from the team.



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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 225

def remove_permission_from_team_with_http_info(uuid, permission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionApi.remove_permission_from_team ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling PermissionApi.remove_permission_from_team"
  end
  # verify the required parameter 'permission' is set
  if @api_client.config.client_side_validation && permission.nil?
    fail ArgumentError, "Missing the required parameter 'permission' when calling PermissionApi.remove_permission_from_team"
  end
  # resource path
  local_var_path = '/v1/permission/{permission}/team/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s)).sub('{' + 'permission' + '}', CGI.escape(permission.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Team' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionApi#remove_permission_from_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_permission_from_user(username, permission, opts = {}) ⇒ UserPrincipal

Removes the permission from the user.



281
282
283
284
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 281

def remove_permission_from_user(username, permission, opts = {})
  data, _status_code, _headers = remove_permission_from_user_with_http_info(username, permission, opts)
  data
end

#remove_permission_from_user_with_http_info(username, permission, opts = {}) ⇒ Array<(UserPrincipal, Integer, Hash)>

Removes the permission from the user.



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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/dependency-tracker-client/api/permission_api.rb', line 291

def remove_permission_from_user_with_http_info(username, permission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionApi.remove_permission_from_user ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling PermissionApi.remove_permission_from_user"
  end
  # verify the required parameter 'permission' is set
  if @api_client.config.client_side_validation && permission.nil?
    fail ArgumentError, "Missing the required parameter 'permission' when calling PermissionApi.remove_permission_from_user"
  end
  # resource path
  local_var_path = '/v1/permission/{permission}/user/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'permission' + '}', CGI.escape(permission.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'UserPrincipal' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionApi#remove_permission_from_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end