docusign_rooms 1.1.0 → 1.2.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/CHANGELOG.md +6 -0
  2. data/docusign_rooms.gemspec +1 -0
  3. data/lib/docusign_rooms/api/accounts_api.rb +6 -4
  4. data/lib/docusign_rooms/api/activity_types_api.rb +4 -2
  5. data/lib/docusign_rooms/api/closing_statuses_api.rb +4 -2
  6. data/lib/docusign_rooms/api/contact_sides_api.rb +4 -2
  7. data/lib/docusign_rooms/api/countries_api.rb +4 -2
  8. data/lib/docusign_rooms/api/currencies_api.rb +4 -2
  9. data/lib/docusign_rooms/api/documents_api.rb +23 -19
  10. data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +6 -4
  11. data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +4 -4
  12. data/lib/docusign_rooms/api/fields_api.rb +9 -7
  13. data/lib/docusign_rooms/api/financing_types_api.rb +4 -2
  14. data/lib/docusign_rooms/api/form_details_api.rb +6 -4
  15. data/lib/docusign_rooms/api/form_groups_api.rb +68 -56
  16. data/lib/docusign_rooms/api/form_libraries_api.rb +12 -8
  17. data/lib/docusign_rooms/api/offices_api.rb +32 -24
  18. data/lib/docusign_rooms/api/origins_of_leads_api.rb +4 -2
  19. data/lib/docusign_rooms/api/property_types_api.rb +4 -2
  20. data/lib/docusign_rooms/api/regions_api.rb +30 -22
  21. data/lib/docusign_rooms/api/roles_api.rb +44 -31
  22. data/lib/docusign_rooms/api/room_contact_types_api.rb +4 -2
  23. data/lib/docusign_rooms/api/room_folders_api.rb +6 -4
  24. data/lib/docusign_rooms/api/room_templates_api.rb +7 -5
  25. data/lib/docusign_rooms/api/rooms_api.rb +147 -113
  26. data/lib/docusign_rooms/api/seller_decision_types_api.rb +4 -2
  27. data/lib/docusign_rooms/api/special_circumstance_types_api.rb +4 -2
  28. data/lib/docusign_rooms/api/states_api.rb +4 -2
  29. data/lib/docusign_rooms/api/task_date_types_api.rb +4 -2
  30. data/lib/docusign_rooms/api/task_list_templates_api.rb +8 -6
  31. data/lib/docusign_rooms/api/task_lists_api.rb +20 -16
  32. data/lib/docusign_rooms/api/task_responsibility_types_api.rb +4 -2
  33. data/lib/docusign_rooms/api/task_statuses_api.rb +4 -2
  34. data/lib/docusign_rooms/api/time_zones_api.rb +4 -2
  35. data/lib/docusign_rooms/api/transaction_sides_api.rb +4 -2
  36. data/lib/docusign_rooms/api/users_api.rb +81 -71
  37. data/lib/docusign_rooms/client/api_client.rb +3 -2
  38. data/lib/docusign_rooms/configuration.rb +2 -1
  39. data/lib/docusign_rooms/models/document.rb +13 -4
  40. data/lib/docusign_rooms/models/permissions.rb +10 -10
  41. data/lib/docusign_rooms/models/roles_filter_context_types.rb +30 -0
  42. data/lib/docusign_rooms/models/room_document.rb +10 -1
  43. data/lib/docusign_rooms/version.rb +1 -1
  44. data/lib/docusign_rooms.rb +1 -0
  45. data/runLinter.sh +1 -0
  46. metadata +101 -60
  47. checksums.yaml +0 -7
  48. data/Gemfile.lock +0 -71
  49. data/lib/.DS_Store +0 -0
  50. data/lib/docusign_rooms/.DS_Store +0 -0
  51. data/lib/docusign_rooms/client/.DS_Store +0 -0
  52. data/tests/Gemfile.lock +0 -42
  53. data/tests/docs/private.pem +0 -27
@@ -17,13 +17,13 @@ module DocuSign_Rooms
17
17
  # Optional parameter indicating to only return roles (internal/external) assignable to this user.
18
18
  attr_accessor :assignee_email
19
19
 
20
- #
20
+ # A search filter that returns assignable roles by the beginning of the role name.
21
21
  attr_accessor :filter
22
22
 
23
- #
23
+ # The index position within the total result set from which to start returning values. The default value is `0`.
24
24
  attr_accessor :start_position
25
25
 
26
- #
26
+ # The number of results to return. This value must be a number between `1` and `100` (default).
27
27
  attr_accessor :count
28
28
 
29
29
  def self.default
@@ -38,6 +38,18 @@ module DocuSign_Rooms
38
38
  # Position of the first item in the total results. Defaults to 0.
39
39
  attr_accessor :start_position
40
40
 
41
+ # Filter out any isDynamic documents without content. Defaults to false.
42
+ attr_accessor :require_content_for_dynamic_documents
43
+
44
+ # Filter documents by folderId. Defaults to null, to not filter on folderId.
45
+ attr_accessor :room_folder_id
46
+
47
+ # Filter documents where Name contains the filter. Defaults to null, to not filter.
48
+ attr_accessor :name_filter
49
+
50
+ # Filter documents to have the same isArchived value as includeArchived. Defaults to true, to include archived documents.
51
+ attr_accessor :include_archived
52
+
41
53
  def self.default
42
54
  @@default ||= GetDocumentsOptions.new
43
55
  end
@@ -108,10 +120,10 @@ module DocuSign_Rooms
108
120
  @api_client = api_client
109
121
  end
110
122
 
111
- # Add a document to a
112
- #
113
- # @param room_id
114
- # @param account_id
123
+ # Add a document to a room.
124
+ # Add a document to a room
125
+ # @param room_id The id of the room.
126
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
115
127
  # @param body (optional parameter)
116
128
  # @return [RoomDocument]
117
129
  def add_document_to_room(room_id, account_id, body)
@@ -119,10 +131,10 @@ module DocuSign_Rooms
119
131
  return data
120
132
  end
121
133
 
122
- # Add a document to a
123
- #
124
- # @param room_id
125
- # @param account_id
134
+ # Add a document to a room.
135
+ # Add a document to a room
136
+ # @param room_id The id of the room.
137
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
126
138
  # @param body (optional parameter)
127
139
  # @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
128
140
  def add_document_to_room_with_http_info(room_id, account_id, body)
@@ -166,9 +178,9 @@ module DocuSign_Rooms
166
178
  end
167
179
 
168
180
  # Add a document to a room via file contents upload.
169
- #
170
- # @param room_id
171
- # @param account_id
181
+ # This method uploads the contents of file as a room document for the room that you specify.
182
+ # @param room_id The id of the room.
183
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
172
184
  # @return [RoomDocument]
173
185
  def add_document_to_room_via_file_upload(room_id, account_id)
174
186
  data, _status_code, _headers = add_document_to_room_via_file_upload_with_http_info(room_id, account_id)
@@ -176,9 +188,9 @@ module DocuSign_Rooms
176
188
  end
177
189
 
178
190
  # Add a document to a room via file contents upload.
179
- #
180
- # @param room_id
181
- # @param account_id
191
+ # This method uploads the contents of file as a room document for the room that you specify.
192
+ # @param room_id The id of the room.
193
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
182
194
  # @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
183
195
  def add_document_to_room_via_file_upload_with_http_info(room_id, account_id)
184
196
  if @api_client.config.debugging
@@ -203,7 +215,7 @@ module DocuSign_Rooms
203
215
 
204
216
  # form parameters
205
217
  form_params = {}
206
- form_params["file"] = options.file if !options.paramName.nil?
218
+ form_params["file"] = options.file if !options.file.nil?
207
219
 
208
220
  # http body (model)
209
221
  post_body = nil
@@ -222,9 +234,9 @@ module DocuSign_Rooms
222
234
  end
223
235
 
224
236
  # Adds a DocuSign Form to a room
225
- #
237
+ # Adds a form to a room.
226
238
  # @param room_id Id of the room to which the DocuSign Form is being added
227
- # @param account_id
239
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
228
240
  # @param body (optional parameter)
229
241
  # @return [RoomDocument]
230
242
  def add_form_to_room(room_id, account_id, body)
@@ -233,9 +245,9 @@ module DocuSign_Rooms
233
245
  end
234
246
 
235
247
  # Adds a DocuSign Form to a room
236
- #
248
+ # Adds a form to a room.
237
249
  # @param room_id Id of the room to which the DocuSign Form is being added
238
- # @param account_id
250
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
239
251
  # @param body (optional parameter)
240
252
  # @return [Array<(RoomDocument, Fixnum, Hash)>] RoomDocument data, response status code and response headers
241
253
  def add_form_to_room_with_http_info(room_id, account_id, body)
@@ -279,8 +291,8 @@ module DocuSign_Rooms
279
291
  end
280
292
 
281
293
  # Creates a new Room
282
- #
283
- # @param account_id
294
+ # Creates a new Room
295
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
284
296
  # @param body (optional parameter)
285
297
  # @return [Room]
286
298
  def create_room(account_id, body)
@@ -289,8 +301,8 @@ module DocuSign_Rooms
289
301
  end
290
302
 
291
303
  # Creates a new Room
292
- #
293
- # @param account_id
304
+ # Creates a new Room
305
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
294
306
  # @param body (optional parameter)
295
307
  # @return [Array<(Room, Fixnum, Hash)>] Room data, response status code and response headers
296
308
  def create_room_with_http_info(account_id, body)
@@ -332,9 +344,9 @@ module DocuSign_Rooms
332
344
  end
333
345
 
334
346
  # Deletes the room having the given room ID.
335
- #
347
+ # Deletes the room having the given room ID.
336
348
  # @param room_id ID of the room to be deleted.
337
- # @param account_id
349
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
338
350
  # @return [nil]
339
351
  def delete_room(room_id, account_id)
340
352
  delete_room_with_http_info(room_id, account_id)
@@ -342,9 +354,9 @@ module DocuSign_Rooms
342
354
  end
343
355
 
344
356
  # Deletes the room having the given room ID.
345
- #
357
+ # Deletes the room having the given room ID.
346
358
  # @param room_id ID of the room to be deleted.
347
- # @param account_id
359
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
348
360
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
349
361
  def delete_room_with_http_info(room_id, account_id)
350
362
  if @api_client.config.debugging
@@ -364,6 +376,8 @@ module DocuSign_Rooms
364
376
  header_params = {}
365
377
  # HTTP header 'Accept' (if needed)
366
378
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
379
+ # HTTP header 'Content-Type'
380
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
367
381
 
368
382
  # form parameters
369
383
  form_params = {}
@@ -384,9 +398,9 @@ module DocuSign_Rooms
384
398
  end
385
399
 
386
400
  # Returns the roles for which the calling user, based on their role within the room, can assign to invitees.
387
- #
388
- # @param room_id
389
- # @param account_id
401
+ # This method returns the room-level roles that the current user can assign to the members that they invite to a room.
402
+ # @param room_id The id of the room.
403
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
390
404
  # @param DocuSign_Rooms::GetAssignableRolesOptions Options for modifying the behavior of the function.
391
405
  # @return [AssignableRoles]
392
406
  def get_assignable_roles(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default)
@@ -395,9 +409,9 @@ module DocuSign_Rooms
395
409
  end
396
410
 
397
411
  # Returns the roles for which the calling user, based on their role within the room, can assign to invitees.
398
- #
399
- # @param room_id
400
- # @param account_id
412
+ # This method returns the room-level roles that the current user can assign to the members that they invite to a room.
413
+ # @param room_id The id of the room.
414
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
401
415
  # @param DocuSign_Rooms::GetAssignableRolesOptions Options for modifying the behavior of the function.
402
416
  # @return [Array<(AssignableRoles, Fixnum, Hash)>] AssignableRoles data, response status code and response headers
403
417
  def get_assignable_roles_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetAssignableRolesOptions.default)
@@ -422,6 +436,8 @@ module DocuSign_Rooms
422
436
  header_params = {}
423
437
  # HTTP header 'Accept' (if needed)
424
438
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
439
+ # HTTP header 'Content-Type'
440
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
425
441
 
426
442
  # form parameters
427
443
  form_params = {}
@@ -443,9 +459,9 @@ module DocuSign_Rooms
443
459
  end
444
460
 
445
461
  # Get documents in the room accessible to the calling user.
446
- #
447
- # @param room_id
448
- # @param account_id
462
+ # This method returns a list of documents that the current user can access for a specific room.
463
+ # @param room_id The id of the room.
464
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
449
465
  # @param DocuSign_Rooms::GetDocumentsOptions Options for modifying the behavior of the function.
450
466
  # @return [RoomDocumentList]
451
467
  def get_documents(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default)
@@ -454,9 +470,9 @@ module DocuSign_Rooms
454
470
  end
455
471
 
456
472
  # Get documents in the room accessible to the calling user.
457
- #
458
- # @param room_id
459
- # @param account_id
473
+ # This method returns a list of documents that the current user can access for a specific room.
474
+ # @param room_id The id of the room.
475
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
460
476
  # @param DocuSign_Rooms::GetDocumentsOptions Options for modifying the behavior of the function.
461
477
  # @return [Array<(RoomDocumentList, Fixnum, Hash)>] RoomDocumentList data, response status code and response headers
462
478
  def get_documents_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetDocumentsOptions.default)
@@ -474,11 +490,17 @@ module DocuSign_Rooms
474
490
  query_params = {}
475
491
  query_params[:'count'] = options.count if !options.count.nil?
476
492
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
493
+ query_params[:'requireContentForDynamicDocuments'] = options.require_content_for_dynamic_documents if !options.require_content_for_dynamic_documents.nil?
494
+ query_params[:'roomFolderId'] = options.room_folder_id if !options.room_folder_id.nil?
495
+ query_params[:'nameFilter'] = options.name_filter if !options.name_filter.nil?
496
+ query_params[:'includeArchived'] = options.include_archived if !options.include_archived.nil?
477
497
 
478
498
  # header parameters
479
499
  header_params = {}
480
500
  # HTTP header 'Accept' (if needed)
481
501
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
502
+ # HTTP header 'Content-Type'
503
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
482
504
 
483
505
  # form parameters
484
506
  form_params = {}
@@ -499,10 +521,10 @@ module DocuSign_Rooms
499
521
  return data, status_code, headers
500
522
  end
501
523
 
502
- # Gets information about the given
503
- #
504
- # @param room_id
505
- # @param account_id
524
+ # Gets information about the given room.
525
+ # Returns details about the given room
526
+ # @param room_id The id of the room.
527
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
506
528
  # @param DocuSign_Rooms::GetRoomOptions Options for modifying the behavior of the function.
507
529
  # @return [Room]
508
530
  def get_room(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default)
@@ -510,10 +532,10 @@ module DocuSign_Rooms
510
532
  return data
511
533
  end
512
534
 
513
- # Gets information about the given
514
- #
515
- # @param room_id
516
- # @param account_id
535
+ # Gets information about the given room.
536
+ # Returns details about the given room
537
+ # @param room_id The id of the room.
538
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
517
539
  # @param DocuSign_Rooms::GetRoomOptions Options for modifying the behavior of the function.
518
540
  # @return [Array<(Room, Fixnum, Hash)>] Room data, response status code and response headers
519
541
  def get_room_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomOptions.default)
@@ -535,6 +557,8 @@ module DocuSign_Rooms
535
557
  header_params = {}
536
558
  # HTTP header 'Accept' (if needed)
537
559
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
560
+ # HTTP header 'Content-Type'
561
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
538
562
 
539
563
  # form parameters
540
564
  form_params = {}
@@ -556,9 +580,9 @@ module DocuSign_Rooms
556
580
  end
557
581
 
558
582
  # Returns the FieldData associated with the provided roomId.
559
- #
560
- # @param room_id
561
- # @param account_id
583
+ # Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.
584
+ # @param room_id The id of the room.
585
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
562
586
  # @return [FieldData]
563
587
  def get_room_field_data(room_id, account_id)
564
588
  data, _status_code, _headers = get_room_field_data_with_http_info(room_id, account_id)
@@ -566,9 +590,9 @@ module DocuSign_Rooms
566
590
  end
567
591
 
568
592
  # Returns the FieldData associated with the provided roomId.
569
- #
570
- # @param room_id
571
- # @param account_id
593
+ # Returns the field data associated with a room. This is the information that appears on the room&#39;s **Details** tab.
594
+ # @param room_id The id of the room.
595
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
572
596
  # @return [Array<(FieldData, Fixnum, Hash)>] FieldData data, response status code and response headers
573
597
  def get_room_field_data_with_http_info(room_id, account_id)
574
598
  if @api_client.config.debugging
@@ -588,6 +612,8 @@ module DocuSign_Rooms
588
612
  header_params = {}
589
613
  # HTTP header 'Accept' (if needed)
590
614
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
615
+ # HTTP header 'Content-Type'
616
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
591
617
 
592
618
  # form parameters
593
619
  form_params = {}
@@ -608,20 +634,20 @@ module DocuSign_Rooms
608
634
  return data, status_code, headers
609
635
  end
610
636
 
611
- # Gets the field set associated with the
612
- #
613
- # @param room_id
614
- # @param account_id
637
+ # Gets the field set associated with the room.
638
+ # Returns the field set that a room uses.
639
+ # @param room_id The id of the room.
640
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
615
641
  # @return [FieldSet]
616
642
  def get_room_field_set(room_id, account_id)
617
643
  data, _status_code, _headers = get_room_field_set_with_http_info(room_id, account_id)
618
644
  return data
619
645
  end
620
646
 
621
- # Gets the field set associated with the
622
- #
623
- # @param room_id
624
- # @param account_id
647
+ # Gets the field set associated with the room.
648
+ # Returns the field set that a room uses.
649
+ # @param room_id The id of the room.
650
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
625
651
  # @return [Array<(FieldSet, Fixnum, Hash)>] FieldSet data, response status code and response headers
626
652
  def get_room_field_set_with_http_info(room_id, account_id)
627
653
  if @api_client.config.debugging
@@ -641,6 +667,8 @@ module DocuSign_Rooms
641
667
  header_params = {}
642
668
  # HTTP header 'Accept' (if needed)
643
669
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
670
+ # HTTP header 'Content-Type'
671
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
644
672
 
645
673
  # form parameters
646
674
  form_params = {}
@@ -661,10 +689,10 @@ module DocuSign_Rooms
661
689
  return data, status_code, headers
662
690
  end
663
691
 
664
- # Retrieves the list of users in the given
665
- #
666
- # @param room_id
667
- # @param account_id
692
+ # Retrieves the list of users in the given room.
693
+ # This method returns a list of users associated with a room.
694
+ # @param room_id The id of the room.
695
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
668
696
  # @param DocuSign_Rooms::GetRoomUsersOptions Options for modifying the behavior of the function.
669
697
  # @return [RoomUsersResult]
670
698
  def get_room_users(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default)
@@ -672,10 +700,10 @@ module DocuSign_Rooms
672
700
  return data
673
701
  end
674
702
 
675
- # Retrieves the list of users in the given
676
- #
677
- # @param room_id
678
- # @param account_id
703
+ # Retrieves the list of users in the given room.
704
+ # This method returns a list of users associated with a room.
705
+ # @param room_id The id of the room.
706
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
679
707
  # @param DocuSign_Rooms::GetRoomUsersOptions Options for modifying the behavior of the function.
680
708
  # @return [Array<(RoomUsersResult, Fixnum, Hash)>] RoomUsersResult data, response status code and response headers
681
709
  def get_room_users_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomUsersOptions.default)
@@ -703,6 +731,8 @@ module DocuSign_Rooms
703
731
  header_params = {}
704
732
  # HTTP header 'Accept' (if needed)
705
733
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
734
+ # HTTP header 'Content-Type'
735
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
706
736
 
707
737
  # form parameters
708
738
  form_params = {}
@@ -724,8 +754,8 @@ module DocuSign_Rooms
724
754
  end
725
755
 
726
756
  # Gets rooms available to the calling user.
727
- #
728
- # @param account_id
757
+ # Gets rooms available to the calling user
758
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
729
759
  # @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
730
760
  # @return [RoomSummaryList]
731
761
  def get_rooms(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
@@ -734,8 +764,8 @@ module DocuSign_Rooms
734
764
  end
735
765
 
736
766
  # Gets rooms available to the calling user.
737
- #
738
- # @param account_id
767
+ # Gets rooms available to the calling user
768
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
739
769
  # @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
740
770
  # @return [Array<(RoomSummaryList, Fixnum, Hash)>] RoomSummaryList data, response status code and response headers
741
771
  def get_rooms_with_http_info(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
@@ -765,6 +795,8 @@ module DocuSign_Rooms
765
795
  header_params = {}
766
796
  # HTTP header 'Accept' (if needed)
767
797
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
798
+ # HTTP header 'Content-Type'
799
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
768
800
 
769
801
  # form parameters
770
802
  form_params = {}
@@ -786,9 +818,9 @@ module DocuSign_Rooms
786
818
  end
787
819
 
788
820
  # Invites a user to the room by email address.
789
- #
790
- # @param room_id
791
- # @param account_id
821
+ # This method invites an existing or new member to a specific room.
822
+ # @param room_id The id of the room.
823
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
792
824
  # @param body (optional parameter)
793
825
  # @return [RoomInviteResponse]
794
826
  def invite_user(room_id, account_id, body)
@@ -797,9 +829,9 @@ module DocuSign_Rooms
797
829
  end
798
830
 
799
831
  # Invites a user to the room by email address.
800
- #
801
- # @param room_id
802
- # @param account_id
832
+ # This method invites an existing or new member to a specific room.
833
+ # @param room_id The id of the room.
834
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
803
835
  # @param body (optional parameter)
804
836
  # @return [Array<(RoomInviteResponse, Fixnum, Hash)>] RoomInviteResponse data, response status code and response headers
805
837
  def invite_user_with_http_info(room_id, account_id, body)
@@ -843,10 +875,10 @@ module DocuSign_Rooms
843
875
  end
844
876
 
845
877
  # Updates the specified user's role and transaction side.
846
- #
847
- # @param room_id
848
- # @param user_id
849
- # @param account_id
878
+ # Updates the specified user's role and transaction side.
879
+ # @param room_id The id of the room.
880
+ # @param user_id The id of the user to update.
881
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
850
882
  # @param body (optional parameter)
851
883
  # @return [RoomUser]
852
884
  def put_room_user(room_id, user_id, account_id, body)
@@ -855,10 +887,10 @@ module DocuSign_Rooms
855
887
  end
856
888
 
857
889
  # Updates the specified user&#39;s role and transaction side.
858
- #
859
- # @param room_id
860
- # @param user_id
861
- # @param account_id
890
+ # Updates the specified user&#39;s role and transaction side.
891
+ # @param room_id The id of the room.
892
+ # @param user_id The id of the user to update.
893
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
862
894
  # @param body (optional parameter)
863
895
  # @return [Array<(RoomUser, Fixnum, Hash)>] RoomUser data, response status code and response headers
864
896
  def put_room_user_with_http_info(room_id, user_id, account_id, body)
@@ -903,22 +935,22 @@ module DocuSign_Rooms
903
935
  return data, status_code, headers
904
936
  end
905
937
 
906
- # Restores the specified user's access to the
907
- #
938
+ # Restores the specified user's access to the room.
939
+ # Restores the specified user's access to the room.
908
940
  # @param room_id The room Id to restore access
909
941
  # @param user_id The user Id getting restored to the room
910
- # @param account_id
942
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
911
943
  # @return [nil]
912
944
  def restore_room_user_access(room_id, user_id, account_id)
913
945
  restore_room_user_access_with_http_info(room_id, user_id, account_id)
914
946
  return nil
915
947
  end
916
948
 
917
- # Restores the specified user&#39;s access to the
918
- #
949
+ # Restores the specified user&#39;s access to the room.
950
+ # Restores the specified user&#39;s access to the room.
919
951
  # @param room_id The room Id to restore access
920
952
  # @param user_id The user Id getting restored to the room
921
- # @param account_id
953
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
922
954
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
923
955
  def restore_room_user_access_with_http_info(room_id, user_id, account_id)
924
956
  if @api_client.config.debugging
@@ -940,6 +972,8 @@ module DocuSign_Rooms
940
972
  header_params = {}
941
973
  # HTTP header 'Accept' (if needed)
942
974
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
975
+ # HTTP header 'Content-Type'
976
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
943
977
 
944
978
  # form parameters
945
979
  form_params = {}
@@ -959,11 +993,11 @@ module DocuSign_Rooms
959
993
  return data, status_code, headers
960
994
  end
961
995
 
962
- # Revokes the specified user's access to the
963
- #
996
+ # Revokes the specified user's access to the room.
997
+ # Revokes the specified user's access to the room.
964
998
  # @param room_id The room Id to revoke access from
965
999
  # @param user_id The user Id getting revoked from the room
966
- # @param account_id
1000
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
967
1001
  # @param body (optional parameter)
968
1002
  # @return [nil]
969
1003
  def revoke_room_user_access(room_id, user_id, account_id, body)
@@ -971,11 +1005,11 @@ module DocuSign_Rooms
971
1005
  return nil
972
1006
  end
973
1007
 
974
- # Revokes the specified user&#39;s access to the
975
- #
1008
+ # Revokes the specified user&#39;s access to the room.
1009
+ # Revokes the specified user&#39;s access to the room.
976
1010
  # @param room_id The room Id to revoke access from
977
1011
  # @param user_id The user Id getting revoked from the room
978
- # @param account_id
1012
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
979
1013
  # @param body (optional parameter)
980
1014
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
981
1015
  def revoke_room_user_access_with_http_info(room_id, user_id, account_id, body)
@@ -1019,20 +1053,20 @@ module DocuSign_Rooms
1019
1053
  return data, status_code, headers
1020
1054
  end
1021
1055
 
1022
- # Update the picture for a
1056
+ # Update the picture for a room.
1023
1057
  # This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"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).
1024
1058
  # @param room_id ID of the room the picture is for.
1025
- # @param account_id
1059
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
1026
1060
  # @return [RoomPicture]
1027
1061
  def update_picture(room_id, account_id)
1028
1062
  data, _status_code, _headers = update_picture_with_http_info(room_id, account_id)
1029
1063
  return data
1030
1064
  end
1031
1065
 
1032
- # Update the picture for a
1066
+ # Update the picture for a room.
1033
1067
  # This endpoint supports the following content types, application/json as JSON PictureForUpdate{\&quot;fileName\&quot;:\&quot;string\&quot;, \&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).
1034
1068
  # @param room_id ID of the room the picture is for.
1035
- # @param account_id
1069
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
1036
1070
  # @return [Array<(RoomPicture, Fixnum, Hash)>] RoomPicture data, response status code and response headers
1037
1071
  def update_picture_with_http_info(room_id, account_id)
1038
1072
  if @api_client.config.debugging
@@ -1057,7 +1091,7 @@ module DocuSign_Rooms
1057
1091
 
1058
1092
  # form parameters
1059
1093
  form_params = {}
1060
- form_params["file"] = options.file if !options.paramName.nil?
1094
+ form_params["file"] = options.file if !options.file.nil?
1061
1095
 
1062
1096
  # http body (model)
1063
1097
  post_body = nil
@@ -1076,9 +1110,9 @@ module DocuSign_Rooms
1076
1110
  end
1077
1111
 
1078
1112
  # Updates room field data.
1079
- #
1080
- # @param room_id
1081
- # @param account_id
1113
+ # Updates room field data.
1114
+ # @param room_id The id of the room.
1115
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
1082
1116
  # @param body (optional parameter)
1083
1117
  # @return [FieldData]
1084
1118
  def update_room_field_data(room_id, account_id, body)
@@ -1087,9 +1121,9 @@ module DocuSign_Rooms
1087
1121
  end
1088
1122
 
1089
1123
  # Updates room field data.
1090
- #
1091
- # @param room_id
1092
- # @param account_id
1124
+ # Updates room field data.
1125
+ # @param room_id The id of the room.
1126
+ # @param account_id (Required) The globally unique identifier (GUID) for the account.
1093
1127
  # @param body (optional parameter)
1094
1128
  # @return [Array<(FieldData, Fixnum, Hash)>] FieldData data, response status code and response headers
1095
1129
  def update_room_field_data_with_http_info(room_id, account_id, body)
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid seller decision types.
25
- #
25
+ # Returns a list of valid seller decision types.
26
26
  # @return [GlobalSellerDecisionTypes]
27
27
  def get_seller_decision_types()
28
28
  data, _status_code, _headers = get_seller_decision_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid seller decision types.
33
- #
33
+ # Returns a list of valid seller decision types.
34
34
  # @return [Array<(GlobalSellerDecisionTypes, Fixnum, Hash)>] GlobalSellerDecisionTypes data, response status code and response headers
35
35
  def get_seller_decision_types_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}
@@ -22,7 +22,7 @@ module DocuSign_Rooms
22
22
  end
23
23
 
24
24
  # Retrieves the list of valid special circumstance types.
25
- #
25
+ # Returns a list of special circumstance types
26
26
  # @return [GlobalSpecialCircumstanceTypes]
27
27
  def get_special_circumstance_types()
28
28
  data, _status_code, _headers = get_special_circumstance_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
30
30
  end
31
31
 
32
32
  # Retrieves the list of valid special circumstance types.
33
- #
33
+ # Returns a list of special circumstance types
34
34
  # @return [Array<(GlobalSpecialCircumstanceTypes, Fixnum, Hash)>] GlobalSpecialCircumstanceTypes data, response status code and response headers
35
35
  def get_special_circumstance_types_with_http_info()
36
36
  if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
46
46
  header_params = {}
47
47
  # HTTP header 'Accept' (if needed)
48
48
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
49
51
 
50
52
  # form parameters
51
53
  form_params = {}