Class: ZoomUs::Roles

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/roles.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Roles

Returns a new instance of Roles.



19
20
21
 
# File 'lib/zoom_us/roles.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/zoom_us/roles.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_role_members(role_id, body, opts = {}) ⇒ InlineResponse20115

Assign a Role to Members User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members. Scopes: ‘role:write:admin`

Prerequisites:
* A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

  • body —

    Role members

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

    the optional parameters

Returns:

  • (InlineResponse20115) 


28
29
30
31
 
# File 'lib/zoom_us/roles.rb', line 28

def add_role_members(role_id, body, opts = {})
  data, _status_code, _headers = add_role_members_with_http_info(role_id, body, opts)
  data
end

#add_role_members_with_http_info(role_id, body, opts = {}) ⇒ Array<(InlineResponse20115, Fixnum, Hash)>

Assign a Role to Members User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members. Scopes: &#x60;role:write:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

  • body —

    Role members

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

    the optional parameters

Returns:

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

    InlineResponse20115 data, response status code and response headers



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
 
# File 'lib/zoom_us/roles.rb', line 39

def add_role_members_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.add_role_members ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.add_role_members"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RolesApi.add_role_members"
  end
  # resource path
  local_var_path = '/roles/{roleId}/members'.sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#create_role(opts = {}) ⇒ Object

Create a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Pre-requisite:
* Pro or higher plan. * For setting the initial role, you must be the Account Owner.
* For subsequent role management, you must be the Account Owner or user with role management permissions.
Scopes: ‘role:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body28)

Returns:

  • (Object) 


87
88
89
90
 
# File 'lib/zoom_us/roles.rb', line 87

def create_role(opts = {})
  data, _status_code, _headers = create_role_with_http_info(opts)
  data
end

#create_role_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Create a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Pre-requisite:&lt;br&gt; * Pro or higher plan. * For setting the initial role, you must be the Account Owner.&lt;br&gt; * For subsequent role management, you must be the Account Owner or user with role management permissions.&lt;br&gt; Scopes: &#x60;role:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body28)

Returns:

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

    Object data, response status code and response headers



97
98
99
100
101
102
103
104
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
 
# File 'lib/zoom_us/roles.rb', line 97

def create_role_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.create_role ...'
  end
  # resource path
  local_var_path = '/roles'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['OAuth']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RolesApi#create_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_role(role_id, opts = {}) ⇒ nil

Delete a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role.
Pre-requisite:
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: ‘role:write:admin`

Parameters:

  • role_id —

    Role Id.

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

    the optional parameters

Returns:

  • (nil) 


137
138
139
140
 
# File 'lib/zoom_us/roles.rb', line 137

def delete_role(role_id, opts = {})
  delete_role_with_http_info(role_id, opts)
  nil
end

#delete_role_with_http_info(role_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role.&lt;br&gt; Pre-requisite:&lt;br&gt; * A Pro or higher plan.&lt;br&gt; * For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: &#x60;role:write:admin&#x60;&lt;br&gt;

Parameters:

  • role_id —

    Role Id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/zoom_us/roles.rb', line 147

def delete_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.delete_role ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.delete_role"
  end
  # resource path
  local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: RolesApi#delete_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_role_information(role_id, opts = {}) ⇒ InlineResponse20071

Get Role Information Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).
Pre-requisite:
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: ‘role:read:admin`

Parameters:

  • role_id —

    Role Id.

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

    the optional parameters

Returns:

  • (InlineResponse20071) 


190
191
192
193
 
# File 'lib/zoom_us/roles.rb', line 190

def get_role_information(role_id, opts = {})
  data, _status_code, _headers = get_role_information_with_http_info(role_id, opts)
  data
end

#get_role_information_with_http_info(role_id, opts = {}) ⇒ Array<(InlineResponse20071, Fixnum, Hash)>

Get Role Information Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).&lt;br&gt; Pre-requisite:&lt;br&gt; * A Pro or higher plan.&lt;br&gt; * For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: &#x60;role:read:admin&#x60;&lt;br&gt;

Parameters:

  • role_id —

    Role Id.

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

    the optional parameters

Returns:

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

    InlineResponse20071 data, response status code and response headers



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/zoom_us/roles.rb', line 200

def get_role_information_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.get_role_information ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.get_role_information"
  end
  # resource path
  local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#role_member_delete(role_id, member_id, opts = {}) ⇒ nil

Unassign a Member’s Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user’s role. Scope: ‘role:write:admin`

Prerequisites:
* A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

  • member_id —

    Member&#39;s ID

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

    the optional parameters

Returns:

  • (nil) 


245
246
247
248
 
# File 'lib/zoom_us/roles.rb', line 245

def role_member_delete(role_id, member_id, opts = {})
  role_member_delete_with_http_info(role_id, member_id, opts)
  nil
end

#role_member_delete_with_http_info(role_id, member_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unassign a Member&#39;s Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user&#39;s role. Scope: &#x60;role:write:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

  • member_id —

    Member&#39;s ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/zoom_us/roles.rb', line 256

def role_member_delete_with_http_info(role_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.role_member_delete ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.role_member_delete"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling RolesApi.role_member_delete"
  end
  # resource path
  local_var_path = '/roles/{roleId}/members/{memberId}'.sub('{' + 'roleId' + '}', role_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: RolesApi#role_member_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#role_members(role_id, opts = {}) ⇒ RoleMembersList

List Members in a Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. Scope: ‘role:read:admin`

Prerequisites:
* A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

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

    the optional parameters

Returns:

  • (RoleMembersList) 


303
304
305
306
 
# File 'lib/zoom_us/roles.rb', line 303

def role_members(role_id, opts = {})
  data, _status_code, _headers = role_members_with_http_info(role_id, opts)
  data
end

#role_members_with_http_info(role_id, opts = {}) ⇒ Array<(RoleMembersList, Fixnum, Hash)>

List Members in a Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. Scope: &#x60;role:read:admin&#x60;&lt;br&gt; &lt;br&gt;Prerequisites:&lt;br&gt; * A Pro or a higher plan.

Parameters:

  • role_id —

    The role ID

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

    the optional parameters

Returns:

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

    RoleMembersList data, response status code and response headers



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
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/zoom_us/roles.rb', line 313

def role_members_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.role_members ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.role_members"
  end
  # resource path
  local_var_path = '/roles/{roleId}/members'.sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#roles(opts = {}) ⇒ Object

List Roles List [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account Scopes: ‘role:read:admin`

Prerequisites : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


356
357
358
359
 
# File 'lib/zoom_us/roles.rb', line 356

def roles(opts = {})
  data, _status_code, _headers = roles_with_http_info(opts)
  data
end

#roles_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List Roles List [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account Scopes: &#x60;role:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/zoom_us/roles.rb', line 365

def roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.roles ...'
  end
  # resource path
  local_var_path = '/roles'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

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

#update_role(role_id, opts = {}) ⇒ Object

Update Role Information Each Zoom user automatically has a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name and description of a specific role.
Pre-requisite:
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: ‘role:write:admin`

Parameters:

  • role_id —

    Role Id

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

    the optional parameters

Options Hash (opts):

  • :body (Body52)

Returns:

  • (Object) 


406
407
408
409
 
# File 'lib/zoom_us/roles.rb', line 406

def update_role(role_id, opts = {})
  data, _status_code, _headers = update_role_with_http_info(role_id, opts)
  data
end

#update_role_with_http_info(role_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Role Information Each Zoom user automatically has a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name and description of a specific role.&lt;br&gt; Pre-requisite:&lt;br&gt; * A Pro or higher plan.&lt;br&gt; * For role management and updates, you must be the Account Owner or user with role management permissions.&lt;br&gt;Scopes: &#x60;role:write:admin&#x60;&lt;br&gt;

Parameters:

  • role_id —

    Role Id

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

    the optional parameters

Options Hash (opts):

  • :body (Body52)

Returns:

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

    Object data, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/zoom_us/roles.rb', line 417

def update_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.update_role ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.update_role"
  end
  # resource path
  local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RolesApi#update_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end