Class: DocuSign_Rooms::RoomsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/rooms_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = RoomsApi.default) ⇒ RoomsApi

Returns a new instance of RoomsApi.



119
120
121
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 119

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



117
118
119
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 117

def api_client
  @api_client
end

Instance Method Details

#add_document_to_room(room_id, account_id, body) ⇒ RoomDocument

Add a document to a room. Add a document to a room

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Document details to be added (optional parameter)

Returns:



129
130
131
132
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 129

def add_document_to_room(room_id, , body)
  data, _status_code, _headers = add_document_to_room_with_http_info(room_id, ,  body)
  return data
end

#add_document_to_room_via_file_upload(room_id, account_id) ⇒ RoomDocument

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



185
186
187
188
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 185

def add_document_to_room_via_file_upload(room_id, )
  data, _status_code, _headers = add_document_to_room_via_file_upload_with_http_info(room_id, )
  return data
end

#add_document_to_room_via_file_upload_with_http_info(room_id, account_id) ⇒ Array<(RoomDocument, Fixnum, Hash)>

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    RoomDocument data, response status code and response headers



195
196
197
198
199
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
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 195

def add_document_to_room_via_file_upload_with_http_info(room_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.add_document_to_room_via_file_upload ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_document_to_room_via_file_upload" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_document_to_room_via_file_upload" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents/contents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}
  form_params["file"] = options.file if !options.file.nil?

  # 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 => 'RoomDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#add_document_to_room_via_file_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_document_to_room_with_http_info(room_id, account_id, body) ⇒ Array<(RoomDocument, Fixnum, Hash)>

Add a document to a room. Add a document to a room

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Document details to be added (optional parameter)

Returns:

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

    RoomDocument data, response status code and response headers



140
141
142
143
144
145
146
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
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 140

def add_document_to_room_with_http_info(room_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.add_document_to_room ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_document_to_room" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_document_to_room" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

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

#add_form_to_room(room_id, account_id, body) ⇒ RoomDocument

Adds a DocuSign Form to a room Adds a form to a room.

Parameters:

  • room_id —

    Id of the room to which the DocuSign Form is being added

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Contains information about the form being added (optional parameter)

Returns:



242
243
244
245
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 242

def add_form_to_room(room_id, , body)
  data, _status_code, _headers = add_form_to_room_with_http_info(room_id, ,  body)
  return data
end

#add_form_to_room_with_http_info(room_id, account_id, body) ⇒ Array<(RoomDocument, Fixnum, Hash)>

Adds a DocuSign Form to a room Adds a form to a room.

Parameters:

  • room_id —

    Id of the room to which the DocuSign Form is being added

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Contains information about the form being added (optional parameter)

Returns:

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

    RoomDocument data, response status code and response headers



253
254
255
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
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 253

def add_form_to_room_with_http_info(room_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.add_form_to_room ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.add_form_to_room" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.add_form_to_room" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/forms".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

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

#create_room(account_id, body) ⇒ Room

Creates a new Room Creates a new Room

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    The properties of the new room (optional parameter)

Returns:



298
299
300
301
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 298

def create_room(, body)
  data, _status_code, _headers = create_room_with_http_info(,  body)
  return data
end

#create_room_with_http_info(account_id, body) ⇒ Array<(Room, Fixnum, Hash)>

Creates a new Room Creates a new Room

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    The properties of the new room (optional parameter)

Returns:

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

    Room data, response status code and response headers



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
341
342
343
344
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 308

def create_room_with_http_info(, body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.create_room ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.create_room" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#delete_room(room_id, account_id) ⇒ nil

Deletes the room having the given room ID. Deletes the room having the given room ID.

Parameters:

  • room_id —

    ID of the room to be deleted.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


351
352
353
354
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 351

def delete_room(room_id, )
  delete_room_with_http_info(room_id, )
  return nil
end

#delete_room_with_http_info(room_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the room having the given room ID. Deletes the room having the given room ID.

Parameters:

  • room_id —

    ID of the room to be deleted.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, response status code and response headers



361
362
363
364
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
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 361

def delete_room_with_http_info(room_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.delete_room ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.delete_room" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.delete_room" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: RoomsApi#delete_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assignable_roles(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default) ⇒ AssignableRoles

Returns the roles for which the calling user, based on their role within the room, can assign to invitees. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetAssignableRolesOptions —

    Options for modifying the behavior of the function.

Returns:



406
407
408
409
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 406

def get_assignable_roles(room_id, , options = DocuSign_Rooms::GetAssignableRolesOptions.default)
  data, _status_code, _headers = get_assignable_roles_with_http_info(room_id, , options)
  return data
end

#get_assignable_roles_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default) ⇒ Array<(AssignableRoles, Fixnum, Hash)>

Returns the roles for which the calling user, based on their role within the room, can assign to invitees. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetAssignableRolesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AssignableRoles 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
456
457
458
459
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 417

def get_assignable_roles_with_http_info(room_id, , options = DocuSign_Rooms::GetAssignableRolesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_assignable_roles ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_assignable_roles" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_assignable_roles" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'assigneeEmail'] = options.assignee_email if !options.assignee_email.nil?
  query_params[:'filter'] = options.filter if !options.filter.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
  query_params[:'count'] = options.count if !options.count.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_documents(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default) ⇒ RoomDocumentList

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:



467
468
469
470
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 467

def get_documents(room_id, , options = DocuSign_Rooms::GetDocumentsOptions.default)
  data, _status_code, _headers = get_documents_with_http_info(room_id, , options)
  return data
end

#get_documents_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default) ⇒ Array<(RoomDocumentList, Fixnum, Hash)>

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomDocumentList data, response status code and response headers



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 478

def get_documents_with_http_info(room_id, , options = DocuSign_Rooms::GetDocumentsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_documents ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_documents" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_documents" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/documents".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
  query_params[:'requireContentForDynamicDocuments'] = options.require_content_for_dynamic_documents if !options.require_content_for_dynamic_documents.nil?
  query_params[:'roomFolderId'] = options.room_folder_id if !options.room_folder_id.nil?
  query_params[:'nameFilter'] = options.name_filter if !options.name_filter.nil?
  query_params[:'includeArchived'] = options.include_archived if !options.include_archived.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_room(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default) ⇒ Room

Gets information about the given room. Returns details about the given room

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomOptions —

    Options for modifying the behavior of the function.

Returns:



530
531
532
533
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 530

def get_room(room_id, , options = DocuSign_Rooms::GetRoomOptions.default)
  data, _status_code, _headers = get_room_with_http_info(room_id, , options)
  return data
end

#get_room_field_data(room_id, account_id) ⇒ FieldData

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room’s Details tab.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



587
588
589
590
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 587

def get_room_field_data(room_id, )
  data, _status_code, _headers = get_room_field_data_with_http_info(room_id, )
  return data
end

#get_room_field_data_with_http_info(room_id, account_id) ⇒ Array<(FieldData, Fixnum, Hash)>

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room&#39;s Details tab.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    FieldData data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 597

def get_room_field_data_with_http_info(room_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_room_field_data ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_field_data" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_field_data" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_data".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_room_field_set(room_id, account_id) ⇒ FieldSet

Gets the field set associated with the room. Returns the field set that a room uses.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



642
643
644
645
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 642

def get_room_field_set(room_id, )
  data, _status_code, _headers = get_room_field_set_with_http_info(room_id, )
  return data
end

#get_room_field_set_with_http_info(room_id, account_id) ⇒ Array<(FieldSet, Fixnum, Hash)>

Gets the field set associated with the room. Returns the field set that a room uses.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    FieldSet data, response status code and response headers



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 652

def get_room_field_set_with_http_info(room_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_room_field_set ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_field_set" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_field_set" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_set".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_room_users(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default) ⇒ RoomUsersResult

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomUsersOptions —

    Options for modifying the behavior of the function.

Returns:



698
699
700
701
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 698

def get_room_users(room_id, , options = DocuSign_Rooms::GetRoomUsersOptions.default)
  data, _status_code, _headers = get_room_users_with_http_info(room_id, , options)
  return data
end

#get_room_users_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default) ⇒ Array<(RoomUsersResult, Fixnum, Hash)>

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomUsersOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomUsersResult data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 709

def get_room_users_with_http_info(room_id, , options = DocuSign_Rooms::GetRoomUsersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_room_users ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_users" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_users" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
  query_params[:'filter'] = options.filter if !options.filter.nil?
  query_params[:'sort'] = options.sort if !options.sort.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_room_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default) ⇒ Array<(Room, Fixnum, Hash)>

Gets information about the given room. Returns details about the given room

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Room data, response status code and response headers



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 541

def get_room_with_http_info(room_id, , options = DocuSign_Rooms::GetRoomOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_room ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'includeFieldData'] = options.include_field_data if !options.include_field_data.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#get_rooms(account_id, options = DocuSign_Rooms::GetRoomsOptions.default) ⇒ RoomSummaryList

Gets rooms available to the calling user. Gets rooms available to the calling user

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomsOptions —

    Options for modifying the behavior of the function.

Returns:



758
759
760
761
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 758

def get_rooms(, options = DocuSign_Rooms::GetRoomsOptions.default)
  data, _status_code, _headers = get_rooms_with_http_info(, options)
  return data
end

#get_rooms_with_http_info(account_id, options = DocuSign_Rooms::GetRoomsOptions.default) ⇒ Array<(RoomSummaryList, Fixnum, Hash)>

Gets rooms available to the calling user. Gets rooms available to the calling user

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomSummaryList data, response status code and response headers



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 768

def get_rooms_with_http_info(, options = DocuSign_Rooms::GetRoomsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.get_rooms ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_rooms" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
  query_params[:'roomStatus'] = options.room_status if !options.room_status.nil?
  query_params[:'officeId'] = options.office_id if !options.office_id.nil?
  query_params[:'fieldDataChangedStartDate'] = options.field_data_changed_start_date if !options.field_data_changed_start_date.nil?
  query_params[:'fieldDataChangedEndDate'] = options.field_data_changed_end_date if !options.field_data_changed_end_date.nil?
  query_params[:'roomClosedStartDate'] = options.room_closed_start_date if !options.room_closed_start_date.nil?
  query_params[:'roomClosedEndDate'] = options.room_closed_end_date if !options.room_closed_end_date.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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

#invite_user(room_id, account_id, body) ⇒ RoomInviteResponse

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Name, Email, Side, Role of the user being invited (optional parameter)

Returns:



820
821
822
823
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 820

def invite_user(room_id, , body)
  data, _status_code, _headers = invite_user_with_http_info(room_id, ,  body)
  return data
end

#invite_user_with_http_info(room_id, account_id, body) ⇒ Array<(RoomInviteResponse, Fixnum, Hash)>

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Name, Email, Side, Role of the user being invited (optional parameter)

Returns:

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

    RoomInviteResponse data, response status code and response headers



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 831

def invite_user_with_http_info(room_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.invite_user ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.invite_user" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.invite_user" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

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

#put_room_user(room_id, user_id, account_id, body) ⇒ RoomUser

Updates the specified user’s role and transaction side. Updates the specified user’s role and transaction side.

Parameters:

  • room_id —

    The id of the room.

  • user_id —

    The id of the user to update.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Updated Role and Side of the given user (optional parameter)

Returns:



878
879
880
881
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 878

def put_room_user(room_id, user_id, , body)
  data, _status_code, _headers = put_room_user_with_http_info(room_id, user_id, ,  body)
  return data
end

#put_room_user_with_http_info(room_id, user_id, account_id, body) ⇒ Array<(RoomUser, Fixnum, Hash)>

Updates the specified user&#39;s role and transaction side. Updates the specified user&#39;s role and transaction side.

Parameters:

  • room_id —

    The id of the room.

  • user_id —

    The id of the user to update.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Updated Role and Side of the given user (optional parameter)

Returns:

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

    RoomUser data, response status code and response headers



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 890

def put_room_user_with_http_info(room_id, user_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.put_room_user ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.put_room_user" if room_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.put_room_user" if user_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.put_room_user" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

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

#restore_room_user_access(room_id, user_id, account_id) ⇒ nil

Restores the specified user’s access to the room. Restores the specified user’s access to the room.

Parameters:

  • room_id —

    The room Id to restore access

  • user_id —

    The user Id getting restored to the room

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

  • (nil) 


938
939
940
941
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 938

def restore_room_user_access(room_id, user_id, )
  restore_room_user_access_with_http_info(room_id, user_id, )
  return nil
end

#restore_room_user_access_with_http_info(room_id, user_id, account_id) ⇒ Array<(nil, Fixnum, Hash)>

Restores the specified user&#39;s access to the room. Restores the specified user&#39;s access to the room.

Parameters:

  • room_id —

    The room Id to restore access

  • user_id —

    The user Id getting restored to the room

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    nil, response status code and response headers



949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 949

def restore_room_user_access_with_http_info(room_id, user_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.restore_room_user_access ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.restore_room_user_access" if room_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.restore_room_user_access" if user_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.restore_room_user_access" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # 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: RoomsApi#restore_room_user_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_room_user_access(room_id, user_id, account_id, body) ⇒ nil

Revokes the specified user’s access to the room. Revokes the specified user’s access to the room.

Parameters:

  • room_id —

    The room Id to revoke access from

  • user_id —

    The user Id getting revoked from the room

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Contains the date on which the users room access should be revoked (optional parameter)

Returns:

  • (nil) 


997
998
999
1000
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 997

def revoke_room_user_access(room_id, user_id, , body)
  revoke_room_user_access_with_http_info(room_id, user_id, ,  body)
  return nil
end

#revoke_room_user_access_with_http_info(room_id, user_id, account_id, body) ⇒ Array<(nil, Fixnum, Hash)>

Revokes the specified user&#39;s access to the room. Revokes the specified user&#39;s access to the room.

Parameters:

  • room_id —

    The room Id to revoke access from

  • user_id —

    The user Id getting revoked from the room

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Contains the date on which the users room access should be revoked (optional parameter)

Returns:

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

    nil, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1009

def revoke_room_user_access_with_http_info(room_id, user_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.revoke_room_user_access ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.revoke_room_user_access" if room_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoomsApi.revoke_room_user_access" if user_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.revoke_room_user_access" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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: RoomsApi#revoke_room_user_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_picture(room_id, account_id) ⇒ RoomPicture

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate"Base64Contents":"string", multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

Parameters:

  • room_id —

    ID of the room the picture is for.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:



1055
1056
1057
1058
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1055

def update_picture(room_id, )
  data, _status_code, _headers = update_picture_with_http_info(room_id, )
  return data
end

#update_picture_with_http_info(room_id, account_id) ⇒ Array<(RoomPicture, Fixnum, Hash)>

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate&quot;Base64Contents&quot;:&quot;string&quot;, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

Parameters:

  • room_id —

    ID of the room the picture is for.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

Returns:

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

    RoomPicture data, response status code and response headers



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1065

def update_picture_with_http_info(room_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.update_picture ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_picture" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.update_picture" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/picture".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file"] = options.file if !options.file.nil?

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoomPicture')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#update_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_room_field_data(room_id, account_id, body) ⇒ FieldData

Updates room field data. Updates room field data.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Dictionary of data to be updated (optional parameter)

Returns:



1112
1113
1114
1115
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1112

def update_room_field_data(room_id, , body)
  data, _status_code, _headers = update_room_field_data_with_http_info(room_id, ,  body)
  return data
end

#update_room_field_data_with_http_info(room_id, account_id, body) ⇒ Array<(FieldData, Fixnum, Hash)>

Updates room field data. Updates room field data.

Parameters:

  • room_id —

    The id of the room.

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • body —

    Dictionary of data to be updated (optional parameter)

Returns:

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

    FieldData data, response status code and response headers



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1123

def update_room_field_data_with_http_info(room_id, , body)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomsApi.update_room_field_data ..."
  end
  # verify the required parameter 'room_id' is set
  fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_room_field_data" if room_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.update_room_field_data" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/field_data".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

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