docusign_rooms 1.1.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -0
- data/docusign_rooms.gemspec +9 -6
- data/lib/docusign_rooms/api/accounts_api.rb +7 -5
- data/lib/docusign_rooms/api/activity_types_api.rb +5 -3
- data/lib/docusign_rooms/api/closing_statuses_api.rb +5 -3
- data/lib/docusign_rooms/api/contact_sides_api.rb +5 -3
- data/lib/docusign_rooms/api/countries_api.rb +5 -3
- data/lib/docusign_rooms/api/currencies_api.rb +5 -3
- data/lib/docusign_rooms/api/documents_api.rb +29 -25
- data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +7 -5
- data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +8 -8
- data/lib/docusign_rooms/api/fields_api.rb +10 -8
- data/lib/docusign_rooms/api/financing_types_api.rb +5 -3
- data/lib/docusign_rooms/api/form_details_api.rb +7 -5
- data/lib/docusign_rooms/api/form_group_forms_api.rb +95 -0
- data/lib/docusign_rooms/api/form_groups_api.rb +86 -74
- data/lib/docusign_rooms/api/form_libraries_api.rb +14 -10
- data/lib/docusign_rooms/api/form_provider_associations_api.rb +95 -0
- data/lib/docusign_rooms/api/offices_api.rb +44 -36
- data/lib/docusign_rooms/api/origins_of_leads_api.rb +5 -3
- data/lib/docusign_rooms/api/property_types_api.rb +5 -3
- data/lib/docusign_rooms/api/regions_api.rb +38 -30
- data/lib/docusign_rooms/api/roles_api.rb +52 -42
- data/lib/docusign_rooms/api/room_contact_types_api.rb +5 -3
- data/lib/docusign_rooms/api/room_envelopes_api.rb +81 -0
- data/lib/docusign_rooms/api/room_folders_api.rb +7 -5
- data/lib/docusign_rooms/api/room_templates_api.rb +8 -6
- data/lib/docusign_rooms/api/rooms_api.rb +183 -155
- data/lib/docusign_rooms/api/seller_decision_types_api.rb +5 -3
- data/lib/docusign_rooms/api/special_circumstance_types_api.rb +5 -3
- data/lib/docusign_rooms/api/states_api.rb +5 -3
- data/lib/docusign_rooms/api/task_date_types_api.rb +5 -3
- data/lib/docusign_rooms/api/task_list_templates_api.rb +9 -7
- data/lib/docusign_rooms/api/task_lists_api.rb +25 -21
- data/lib/docusign_rooms/api/task_responsibility_types_api.rb +5 -3
- data/lib/docusign_rooms/api/task_statuses_api.rb +5 -3
- data/lib/docusign_rooms/api/time_zones_api.rb +5 -3
- data/lib/docusign_rooms/api/transaction_sides_api.rb +5 -3
- data/lib/docusign_rooms/api/users_api.rb +103 -261
- data/lib/docusign_rooms/client/api_client.rb +17 -12
- data/lib/docusign_rooms/client/api_error.rb +2 -2
- data/lib/docusign_rooms/client/auth/oauth.rb +1 -1
- data/lib/docusign_rooms/configuration.rb +2 -1
- data/lib/docusign_rooms/models/account_summary.rb +35 -1
- data/lib/docusign_rooms/models/api_error.rb +13 -4
- data/lib/docusign_rooms/models/document.rb +13 -4
- data/lib/docusign_rooms/models/envelope.rb +183 -0
- data/lib/docusign_rooms/models/envelope_for_create.rb +194 -0
- data/lib/docusign_rooms/models/external_form_fill_session_for_create.rb +12 -6
- data/lib/docusign_rooms/models/form_group_form.rb +210 -0
- data/lib/docusign_rooms/models/form_group_form_list.rb +239 -0
- data/lib/docusign_rooms/models/form_provider_association_summary.rb +219 -0
- data/lib/docusign_rooms/models/form_provider_associations_summary_list.rb +239 -0
- data/lib/docusign_rooms/models/form_summary.rb +13 -4
- data/lib/docusign_rooms/models/group_form.rb +13 -4
- data/lib/docusign_rooms/models/listing_type.rb +29 -0
- data/lib/docusign_rooms/models/permissions.rb +58 -13
- data/lib/docusign_rooms/models/roles_filter_context_types.rb +30 -0
- data/lib/docusign_rooms/models/room.rb +21 -1
- data/lib/docusign_rooms/models/room_document.rb +10 -1
- data/lib/docusign_rooms/models/room_for_create.rb +47 -4
- data/lib/docusign_rooms/models/user.rb +35 -1
- data/lib/docusign_rooms/models/user_summary.rb +35 -1
- data/lib/docusign_rooms/models/user_to_invite.rb +47 -2
- data/lib/docusign_rooms/version.rb +1 -1
- data/lib/docusign_rooms.rb +11 -3
- data/runLinter.sh +1 -0
- metadata +90 -23
- data/Gemfile.lock +0 -71
- data/lib/.DS_Store +0 -0
- data/lib/docusign_rooms/.DS_Store +0 -0
- data/lib/docusign_rooms/client/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -42
- 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,22 +120,22 @@ 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
|
115
|
-
# @param body
|
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.
|
127
|
+
# @param body Document details to be added (optional parameter)
|
116
128
|
# @return [RoomDocument]
|
117
129
|
def add_document_to_room(room_id, account_id, body)
|
118
130
|
data, _status_code, _headers = add_document_to_room_with_http_info(room_id, account_id, body)
|
119
131
|
return data
|
120
132
|
end
|
121
133
|
|
122
|
-
# Add a document to a
|
123
|
-
#
|
124
|
-
# @param room_id
|
125
|
-
# @param account_id
|
126
|
-
# @param body
|
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.
|
138
|
+
# @param body Document details to be added (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)
|
129
141
|
if @api_client.config.debugging
|
@@ -142,9 +154,9 @@ module DocuSign_Rooms
|
|
142
154
|
# header parameters
|
143
155
|
header_params = {}
|
144
156
|
# HTTP header 'Accept' (if needed)
|
145
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
157
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
146
158
|
# HTTP header 'Content-Type'
|
147
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
159
|
+
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'])
|
148
160
|
|
149
161
|
# form parameters
|
150
162
|
form_params = {}
|
@@ -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
|
@@ -197,13 +209,13 @@ module DocuSign_Rooms
|
|
197
209
|
# header parameters
|
198
210
|
header_params = {}
|
199
211
|
# HTTP header 'Accept' (if needed)
|
200
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
212
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
201
213
|
# HTTP header 'Content-Type'
|
202
214
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
203
215
|
|
204
216
|
# form parameters
|
205
217
|
form_params = {}
|
206
|
-
form_params["file"] = options.file if !options.
|
218
|
+
form_params["file"] = options.file if !options.file.nil?
|
207
219
|
|
208
220
|
# http body (model)
|
209
221
|
post_body = nil
|
@@ -222,10 +234,10 @@ 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
|
228
|
-
# @param body
|
239
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
240
|
+
# @param body Contains information about the form being added (optional parameter)
|
229
241
|
# @return [RoomDocument]
|
230
242
|
def add_form_to_room(room_id, account_id, body)
|
231
243
|
data, _status_code, _headers = add_form_to_room_with_http_info(room_id, account_id, body)
|
@@ -233,10 +245,10 @@ 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
|
239
|
-
# @param body
|
250
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
251
|
+
# @param body Contains information about the form being added (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)
|
242
254
|
if @api_client.config.debugging
|
@@ -255,9 +267,9 @@ module DocuSign_Rooms
|
|
255
267
|
# header parameters
|
256
268
|
header_params = {}
|
257
269
|
# HTTP header 'Accept' (if needed)
|
258
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
270
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
259
271
|
# HTTP header 'Content-Type'
|
260
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
272
|
+
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'])
|
261
273
|
|
262
274
|
# form parameters
|
263
275
|
form_params = {}
|
@@ -279,9 +291,9 @@ module DocuSign_Rooms
|
|
279
291
|
end
|
280
292
|
|
281
293
|
# Creates a new Room
|
282
|
-
#
|
283
|
-
# @param account_id
|
284
|
-
# @param body
|
294
|
+
# Creates a new Room
|
295
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
296
|
+
# @param body The properties of the new room (optional parameter)
|
285
297
|
# @return [Room]
|
286
298
|
def create_room(account_id, body)
|
287
299
|
data, _status_code, _headers = create_room_with_http_info(account_id, body)
|
@@ -289,9 +301,9 @@ module DocuSign_Rooms
|
|
289
301
|
end
|
290
302
|
|
291
303
|
# Creates a new Room
|
292
|
-
#
|
293
|
-
# @param account_id
|
294
|
-
# @param body
|
304
|
+
# Creates a new Room
|
305
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
306
|
+
# @param body The properties of the new room (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)
|
297
309
|
if @api_client.config.debugging
|
@@ -308,7 +320,7 @@ module DocuSign_Rooms
|
|
308
320
|
# header parameters
|
309
321
|
header_params = {}
|
310
322
|
# HTTP header 'Accept' (if needed)
|
311
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
323
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
312
324
|
# HTTP header 'Content-Type'
|
313
325
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
314
326
|
|
@@ -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
|
@@ -363,7 +375,9 @@ module DocuSign_Rooms
|
|
363
375
|
# header parameters
|
364
376
|
header_params = {}
|
365
377
|
# HTTP header 'Accept' (if needed)
|
366
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
378
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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)
|
@@ -421,7 +435,9 @@ module DocuSign_Rooms
|
|
421
435
|
# header parameters
|
422
436
|
header_params = {}
|
423
437
|
# HTTP header 'Accept' (if needed)
|
424
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
438
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
501
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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)
|
@@ -534,7 +556,9 @@ module DocuSign_Rooms
|
|
534
556
|
# header parameters
|
535
557
|
header_params = {}
|
536
558
|
# HTTP header 'Accept' (if needed)
|
537
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
559
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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'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
|
@@ -587,7 +611,9 @@ module DocuSign_Rooms
|
|
587
611
|
# header parameters
|
588
612
|
header_params = {}
|
589
613
|
# HTTP header 'Accept' (if needed)
|
590
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
614
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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
|
@@ -640,7 +666,9 @@ module DocuSign_Rooms
|
|
640
666
|
# header parameters
|
641
667
|
header_params = {}
|
642
668
|
# HTTP header 'Accept' (if needed)
|
643
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
669
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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)
|
@@ -686,9 +714,6 @@ module DocuSign_Rooms
|
|
686
714
|
fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_room_users" if room_id.nil?
|
687
715
|
# verify the required parameter 'account_id' is set
|
688
716
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_room_users" if account_id.nil?
|
689
|
-
if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
|
690
|
-
fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
|
691
|
-
end
|
692
717
|
# resource path
|
693
718
|
local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/users".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
694
719
|
|
@@ -702,7 +727,9 @@ module DocuSign_Rooms
|
|
702
727
|
# header parameters
|
703
728
|
header_params = {}
|
704
729
|
# HTTP header 'Accept' (if needed)
|
705
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
730
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
731
|
+
# HTTP header 'Content-Type'
|
732
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
706
733
|
|
707
734
|
# form parameters
|
708
735
|
form_params = {}
|
@@ -724,8 +751,8 @@ module DocuSign_Rooms
|
|
724
751
|
end
|
725
752
|
|
726
753
|
# Gets rooms available to the calling user.
|
727
|
-
#
|
728
|
-
# @param account_id
|
754
|
+
# Gets rooms available to the calling user
|
755
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
729
756
|
# @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
|
730
757
|
# @return [RoomSummaryList]
|
731
758
|
def get_rooms(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
|
@@ -734,8 +761,8 @@ module DocuSign_Rooms
|
|
734
761
|
end
|
735
762
|
|
736
763
|
# Gets rooms available to the calling user.
|
737
|
-
#
|
738
|
-
# @param account_id
|
764
|
+
# Gets rooms available to the calling user
|
765
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
739
766
|
# @param DocuSign_Rooms::GetRoomsOptions Options for modifying the behavior of the function.
|
740
767
|
# @return [Array<(RoomSummaryList, Fixnum, Hash)>] RoomSummaryList data, response status code and response headers
|
741
768
|
def get_rooms_with_http_info(account_id, options = DocuSign_Rooms::GetRoomsOptions.default)
|
@@ -744,9 +771,6 @@ module DocuSign_Rooms
|
|
744
771
|
end
|
745
772
|
# verify the required parameter 'account_id' is set
|
746
773
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomsApi.get_rooms" if account_id.nil?
|
747
|
-
if options.room_status && !['Active', 'Pending', 'Closed', 'Open'].include?(options.room_status)
|
748
|
-
fail ArgumentError, 'invalid value for "room_status", must be one of Active, Pending, Closed, Open'
|
749
|
-
end
|
750
774
|
# resource path
|
751
775
|
local_var_path = "/v2/accounts/{accountId}/rooms".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
752
776
|
|
@@ -764,7 +788,9 @@ module DocuSign_Rooms
|
|
764
788
|
# header parameters
|
765
789
|
header_params = {}
|
766
790
|
# HTTP header 'Accept' (if needed)
|
767
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
791
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
792
|
+
# HTTP header 'Content-Type'
|
793
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
768
794
|
|
769
795
|
# form parameters
|
770
796
|
form_params = {}
|
@@ -786,10 +812,10 @@ module DocuSign_Rooms
|
|
786
812
|
end
|
787
813
|
|
788
814
|
# Invites a user to the room by email address.
|
789
|
-
#
|
790
|
-
# @param room_id
|
791
|
-
# @param account_id
|
792
|
-
# @param body
|
815
|
+
# This method invites an existing or new member to a specific room.
|
816
|
+
# @param room_id The id of the room.
|
817
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
818
|
+
# @param body Name, Email, Side, Role of the user being invited (optional parameter)
|
793
819
|
# @return [RoomInviteResponse]
|
794
820
|
def invite_user(room_id, account_id, body)
|
795
821
|
data, _status_code, _headers = invite_user_with_http_info(room_id, account_id, body)
|
@@ -797,10 +823,10 @@ module DocuSign_Rooms
|
|
797
823
|
end
|
798
824
|
|
799
825
|
# Invites a user to the room by email address.
|
800
|
-
#
|
801
|
-
# @param room_id
|
802
|
-
# @param account_id
|
803
|
-
# @param body
|
826
|
+
# This method invites an existing or new member to a specific room.
|
827
|
+
# @param room_id The id of the room.
|
828
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
829
|
+
# @param body Name, Email, Side, Role of the user being invited (optional parameter)
|
804
830
|
# @return [Array<(RoomInviteResponse, Fixnum, Hash)>] RoomInviteResponse data, response status code and response headers
|
805
831
|
def invite_user_with_http_info(room_id, account_id, body)
|
806
832
|
if @api_client.config.debugging
|
@@ -819,9 +845,9 @@ module DocuSign_Rooms
|
|
819
845
|
# header parameters
|
820
846
|
header_params = {}
|
821
847
|
# HTTP header 'Accept' (if needed)
|
822
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
848
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
823
849
|
# HTTP header 'Content-Type'
|
824
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
850
|
+
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'])
|
825
851
|
|
826
852
|
# form parameters
|
827
853
|
form_params = {}
|
@@ -843,11 +869,11 @@ module DocuSign_Rooms
|
|
843
869
|
end
|
844
870
|
|
845
871
|
# Updates the specified user's role and transaction side.
|
846
|
-
#
|
847
|
-
# @param room_id
|
848
|
-
# @param user_id
|
849
|
-
# @param account_id
|
850
|
-
# @param body
|
872
|
+
# Updates the specified user's role and transaction side.
|
873
|
+
# @param room_id The id of the room.
|
874
|
+
# @param user_id The id of the user to update.
|
875
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
876
|
+
# @param body Updated Role and Side of the given user (optional parameter)
|
851
877
|
# @return [RoomUser]
|
852
878
|
def put_room_user(room_id, user_id, account_id, body)
|
853
879
|
data, _status_code, _headers = put_room_user_with_http_info(room_id, user_id, account_id, body)
|
@@ -855,11 +881,11 @@ module DocuSign_Rooms
|
|
855
881
|
end
|
856
882
|
|
857
883
|
# Updates the specified user's role and transaction side.
|
858
|
-
#
|
859
|
-
# @param room_id
|
860
|
-
# @param user_id
|
861
|
-
# @param account_id
|
862
|
-
# @param body
|
884
|
+
# Updates the specified user's role and transaction side.
|
885
|
+
# @param room_id The id of the room.
|
886
|
+
# @param user_id The id of the user to update.
|
887
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
888
|
+
# @param body Updated Role and Side of the given user (optional parameter)
|
863
889
|
# @return [Array<(RoomUser, Fixnum, Hash)>] RoomUser data, response status code and response headers
|
864
890
|
def put_room_user_with_http_info(room_id, user_id, account_id, body)
|
865
891
|
if @api_client.config.debugging
|
@@ -880,9 +906,9 @@ module DocuSign_Rooms
|
|
880
906
|
# header parameters
|
881
907
|
header_params = {}
|
882
908
|
# HTTP header 'Accept' (if needed)
|
883
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
909
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
884
910
|
# HTTP header 'Content-Type'
|
885
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
911
|
+
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'])
|
886
912
|
|
887
913
|
# form parameters
|
888
914
|
form_params = {}
|
@@ -903,22 +929,22 @@ module DocuSign_Rooms
|
|
903
929
|
return data, status_code, headers
|
904
930
|
end
|
905
931
|
|
906
|
-
# Restores the specified user's access to the
|
907
|
-
#
|
932
|
+
# Restores the specified user's access to the room.
|
933
|
+
# Restores the specified user's access to the room.
|
908
934
|
# @param room_id The room Id to restore access
|
909
935
|
# @param user_id The user Id getting restored to the room
|
910
|
-
# @param account_id
|
936
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
911
937
|
# @return [nil]
|
912
938
|
def restore_room_user_access(room_id, user_id, account_id)
|
913
939
|
restore_room_user_access_with_http_info(room_id, user_id, account_id)
|
914
940
|
return nil
|
915
941
|
end
|
916
942
|
|
917
|
-
# Restores the specified user's access to the
|
918
|
-
#
|
943
|
+
# Restores the specified user's access to the room.
|
944
|
+
# Restores the specified user's access to the room.
|
919
945
|
# @param room_id The room Id to restore access
|
920
946
|
# @param user_id The user Id getting restored to the room
|
921
|
-
# @param account_id
|
947
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
922
948
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
923
949
|
def restore_room_user_access_with_http_info(room_id, user_id, account_id)
|
924
950
|
if @api_client.config.debugging
|
@@ -939,7 +965,9 @@ module DocuSign_Rooms
|
|
939
965
|
# header parameters
|
940
966
|
header_params = {}
|
941
967
|
# HTTP header 'Accept' (if needed)
|
942
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
968
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
969
|
+
# HTTP header 'Content-Type'
|
970
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
943
971
|
|
944
972
|
# form parameters
|
945
973
|
form_params = {}
|
@@ -959,24 +987,24 @@ module DocuSign_Rooms
|
|
959
987
|
return data, status_code, headers
|
960
988
|
end
|
961
989
|
|
962
|
-
# Revokes the specified user's access to the
|
963
|
-
#
|
990
|
+
# Revokes the specified user's access to the room.
|
991
|
+
# Revokes the specified user's access to the room.
|
964
992
|
# @param room_id The room Id to revoke access from
|
965
993
|
# @param user_id The user Id getting revoked from the room
|
966
|
-
# @param account_id
|
967
|
-
# @param body
|
994
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
995
|
+
# @param body Contains the date on which the users room access should be revoked (optional parameter)
|
968
996
|
# @return [nil]
|
969
997
|
def revoke_room_user_access(room_id, user_id, account_id, body)
|
970
998
|
revoke_room_user_access_with_http_info(room_id, user_id, account_id, body)
|
971
999
|
return nil
|
972
1000
|
end
|
973
1001
|
|
974
|
-
# Revokes the specified user's access to the
|
975
|
-
#
|
1002
|
+
# Revokes the specified user's access to the room.
|
1003
|
+
# Revokes the specified user's access to the room.
|
976
1004
|
# @param room_id The room Id to revoke access from
|
977
1005
|
# @param user_id The user Id getting revoked from the room
|
978
|
-
# @param account_id
|
979
|
-
# @param body
|
1006
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
1007
|
+
# @param body Contains the date on which the users room access should be revoked (optional parameter)
|
980
1008
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
981
1009
|
def revoke_room_user_access_with_http_info(room_id, user_id, account_id, body)
|
982
1010
|
if @api_client.config.debugging
|
@@ -997,9 +1025,9 @@ module DocuSign_Rooms
|
|
997
1025
|
# header parameters
|
998
1026
|
header_params = {}
|
999
1027
|
# HTTP header 'Accept' (if needed)
|
1000
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
1028
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
1001
1029
|
# HTTP header 'Content-Type'
|
1002
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
1030
|
+
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'])
|
1003
1031
|
|
1004
1032
|
# form parameters
|
1005
1033
|
form_params = {}
|
@@ -1019,20 +1047,20 @@ module DocuSign_Rooms
|
|
1019
1047
|
return data, status_code, headers
|
1020
1048
|
end
|
1021
1049
|
|
1022
|
-
# Update the picture for a
|
1050
|
+
# Update the picture for a room.
|
1023
1051
|
# 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
1052
|
# @param room_id ID of the room the picture is for.
|
1025
|
-
# @param account_id
|
1053
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
1026
1054
|
# @return [RoomPicture]
|
1027
1055
|
def update_picture(room_id, account_id)
|
1028
1056
|
data, _status_code, _headers = update_picture_with_http_info(room_id, account_id)
|
1029
1057
|
return data
|
1030
1058
|
end
|
1031
1059
|
|
1032
|
-
# Update the picture for a
|
1060
|
+
# Update the picture for a room.
|
1033
1061
|
# 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).
|
1034
1062
|
# @param room_id ID of the room the picture is for.
|
1035
|
-
# @param account_id
|
1063
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
1036
1064
|
# @return [Array<(RoomPicture, Fixnum, Hash)>] RoomPicture data, response status code and response headers
|
1037
1065
|
def update_picture_with_http_info(room_id, account_id)
|
1038
1066
|
if @api_client.config.debugging
|
@@ -1057,7 +1085,7 @@ module DocuSign_Rooms
|
|
1057
1085
|
|
1058
1086
|
# form parameters
|
1059
1087
|
form_params = {}
|
1060
|
-
form_params["file"] = options.file if !options.
|
1088
|
+
form_params["file"] = options.file if !options.file.nil?
|
1061
1089
|
|
1062
1090
|
# http body (model)
|
1063
1091
|
post_body = nil
|
@@ -1076,10 +1104,10 @@ module DocuSign_Rooms
|
|
1076
1104
|
end
|
1077
1105
|
|
1078
1106
|
# Updates room field data.
|
1079
|
-
#
|
1080
|
-
# @param room_id
|
1081
|
-
# @param account_id
|
1082
|
-
# @param body
|
1107
|
+
# Updates room field data.
|
1108
|
+
# @param room_id The id of the room.
|
1109
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
1110
|
+
# @param body Dictionary of data to be updated (optional parameter)
|
1083
1111
|
# @return [FieldData]
|
1084
1112
|
def update_room_field_data(room_id, account_id, body)
|
1085
1113
|
data, _status_code, _headers = update_room_field_data_with_http_info(room_id, account_id, body)
|
@@ -1087,10 +1115,10 @@ module DocuSign_Rooms
|
|
1087
1115
|
end
|
1088
1116
|
|
1089
1117
|
# Updates room field data.
|
1090
|
-
#
|
1091
|
-
# @param room_id
|
1092
|
-
# @param account_id
|
1093
|
-
# @param body
|
1118
|
+
# Updates room field data.
|
1119
|
+
# @param room_id The id of the room.
|
1120
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
1121
|
+
# @param body Dictionary of data to be updated (optional parameter)
|
1094
1122
|
# @return [Array<(FieldData, Fixnum, Hash)>] FieldData data, response status code and response headers
|
1095
1123
|
def update_room_field_data_with_http_info(room_id, account_id, body)
|
1096
1124
|
if @api_client.config.debugging
|
@@ -1109,7 +1137,7 @@ module DocuSign_Rooms
|
|
1109
1137
|
# header parameters
|
1110
1138
|
header_params = {}
|
1111
1139
|
# HTTP header 'Accept' (if needed)
|
1112
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
1140
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
1113
1141
|
# HTTP header 'Content-Type'
|
1114
1142
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
1115
1143
|
|