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.



107
108
109
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 107

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



105
106
107
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 105

def api_client
  @api_client
end

Instance Method Details

#add_document_to_room(room_id, account_id, body) ⇒ RoomDocument

Add a document to a

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:



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

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.

Parameters:

  • room_id
  • account_id

Returns:



173
174
175
176
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 173

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.

Parameters:

  • room_id
  • account_id

Returns:

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

    RoomDocument data, response status code and response headers



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 183

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

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:

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

    RoomDocument data, response status code and response headers



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 128

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

Parameters:

  • room_id —

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

  • account_id
  • body (optional parameter)

Returns:



230
231
232
233
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 230

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

Parameters:

  • room_id —

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

  • account_id
  • body (optional parameter)

Returns:

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

    RoomDocument data, response status code and response headers



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
275
276
277
278
279
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 241

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

Parameters:

  • account_id
  • body (optional parameter)

Returns:



286
287
288
289
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 286

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

Parameters:

  • account_id
  • body (optional parameter)

Returns:

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

    Room data, response status code and response headers



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

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

Parameters:

  • room_id —

    ID of the room to be deleted.

  • account_id

Returns:

  • (nil) 


339
340
341
342
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 339

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.

Parameters:

  • room_id —

    ID of the room to be deleted.

  • account_id

Returns:

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

    nil, response status code and response headers



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 349

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

  # 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.

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetAssignableRolesOptions —

    Options for modifying the behavior of the function.

Returns:



392
393
394
395
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 392

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.

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetAssignableRolesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AssignableRoles data, response status code and response headers



403
404
405
406
407
408
409
410
411
412
413
414
415
416
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
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 403

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

  # 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.

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:



451
452
453
454
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 451

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.

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomDocumentList data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 462

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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/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

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetRoomOptions —

    Options for modifying the behavior of the function.

Returns:



508
509
510
511
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 508

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.

Parameters:

  • room_id
  • account_id

Returns:



563
564
565
566
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 563

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.

Parameters:

  • room_id
  • account_id

Returns:

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

    FieldData data, response status code and response headers



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 573

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

  # 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

Parameters:

  • room_id
  • account_id

Returns:



616
617
618
619
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 616

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

Parameters:

  • room_id
  • account_id

Returns:

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

    FieldSet data, response status code and response headers



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 626

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

  # 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

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetRoomUsersOptions —

    Options for modifying the behavior of the function.

Returns:



670
671
672
673
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 670

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

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetRoomUsersOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomUsersResult data, response status code and response headers



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 681

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?
  if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
    fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
  end
  # 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'])

  # 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

Parameters:

  • room_id
  • account_id
  • DocuSign_Rooms::GetRoomOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Room data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 519

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

  # 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.

Parameters:

  • account_id
  • DocuSign_Rooms::GetRoomsOptions —

    Options for modifying the behavior of the function.

Returns:



731
732
733
734
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 731

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.

Parameters:

  • account_id
  • DocuSign_Rooms::GetRoomsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RoomSummaryList data, response status code and response headers



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 741

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?
  if options.room_status && !['Active', 'Pending', 'Closed', 'Open'].include?(options.room_status)
    fail ArgumentError, 'invalid value for "room_status", must be one of Active, Pending, Closed, Open'
  end
  # 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'])

  # 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.

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:



794
795
796
797
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 794

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.

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:

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

    RoomInviteResponse data, response status code and response headers



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 805

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

Parameters:

  • room_id
  • user_id
  • account_id
  • body (optional parameter)

Returns:



852
853
854
855
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 852

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.

Parameters:

  • room_id
  • user_id
  • account_id
  • body (optional parameter)

Returns:

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

    RoomUser data, response status code and response headers



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 864

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

Parameters:

  • room_id —

    The room Id to restore access

  • user_id —

    The user Id getting restored to the room

  • account_id

Returns:

  • (nil) 


912
913
914
915
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 912

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

Parameters:

  • room_id —

    The room Id to restore access

  • user_id —

    The user Id getting restored to the room

  • account_id

Returns:

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

    nil, response status code and response headers



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 923

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

  # 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

Parameters:

  • room_id —

    The room Id to revoke access from

  • user_id —

    The user Id getting revoked from the room

  • account_id
  • body (optional parameter)

Returns:

  • (nil) 


969
970
971
972
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 969

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

Parameters:

  • room_id —

    The room Id to revoke access from

  • user_id —

    The user Id getting revoked from the room

  • account_id
  • body (optional parameter)

Returns:

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

    nil, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 981

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

Returns:



1027
1028
1029
1030
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1027

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 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

Returns:

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

    RoomPicture data, response status code and response headers



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1037

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.paramName.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.

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:



1084
1085
1086
1087
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1084

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.

Parameters:

  • room_id
  • account_id
  • body (optional parameter)

Returns:

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

    FieldData data, response status code and response headers



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 1095

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