docusign_rooms 1.2.0.rc1 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5 -0
- data/docusign_rooms.gemspec +9 -7
- data/lib/docusign_rooms/api/accounts_api.rb +1 -1
- data/lib/docusign_rooms/api/activity_types_api.rb +3 -3
- data/lib/docusign_rooms/api/closing_statuses_api.rb +1 -1
- data/lib/docusign_rooms/api/contact_sides_api.rb +1 -1
- data/lib/docusign_rooms/api/countries_api.rb +1 -1
- data/lib/docusign_rooms/api/currencies_api.rb +1 -1
- data/lib/docusign_rooms/api/documents_api.rb +6 -6
- data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +1 -1
- data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +6 -6
- data/lib/docusign_rooms/api/fields_api.rb +1 -1
- data/lib/docusign_rooms/api/financing_types_api.rb +1 -1
- data/lib/docusign_rooms/api/form_details_api.rb +1 -1
- data/lib/docusign_rooms/api/form_group_forms_api.rb +95 -0
- data/lib/docusign_rooms/api/form_groups_api.rb +18 -18
- data/lib/docusign_rooms/api/form_libraries_api.rb +2 -2
- data/lib/docusign_rooms/api/form_provider_associations_api.rb +95 -0
- data/lib/docusign_rooms/api/offices_api.rb +12 -12
- data/lib/docusign_rooms/api/origins_of_leads_api.rb +1 -1
- data/lib/docusign_rooms/api/property_types_api.rb +1 -1
- data/lib/docusign_rooms/api/regions_api.rb +8 -8
- data/lib/docusign_rooms/api/roles_api.rb +11 -14
- data/lib/docusign_rooms/api/room_contact_types_api.rb +1 -1
- data/lib/docusign_rooms/api/room_envelopes_api.rb +81 -0
- data/lib/docusign_rooms/api/room_folders_api.rb +1 -1
- data/lib/docusign_rooms/api/room_templates_api.rb +1 -1
- data/lib/docusign_rooms/api/rooms_api.rb +36 -42
- data/lib/docusign_rooms/api/seller_decision_types_api.rb +1 -1
- data/lib/docusign_rooms/api/special_circumstance_types_api.rb +1 -1
- data/lib/docusign_rooms/api/states_api.rb +1 -1
- data/lib/docusign_rooms/api/task_date_types_api.rb +1 -1
- data/lib/docusign_rooms/api/task_list_templates_api.rb +1 -1
- data/lib/docusign_rooms/api/task_lists_api.rb +5 -5
- data/lib/docusign_rooms/api/task_responsibility_types_api.rb +1 -1
- data/lib/docusign_rooms/api/task_statuses_api.rb +1 -1
- data/lib/docusign_rooms/api/time_zones_api.rb +1 -1
- data/lib/docusign_rooms/api/transaction_sides_api.rb +1 -1
- data/lib/docusign_rooms/api/users_api.rb +34 -202
- data/lib/docusign_rooms/client/api_client.rb +14 -10
- data/lib/docusign_rooms/client/api_error.rb +2 -2
- data/lib/docusign_rooms/client/auth/oauth.rb +1 -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/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 +49 -4
- data/lib/docusign_rooms/models/room.rb +21 -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 +10 -3
- metadata +115 -89
@@ -20,7 +20,7 @@ module DocuSign_Rooms
|
|
20
20
|
# Valid values are 'FirstNameAsc', 'FirstNameDesc', 'LastNameAsc', 'LastNameDesc', 'EmailAsc', 'EmailDesc'
|
21
21
|
attr_accessor :sort
|
22
22
|
|
23
|
-
#
|
23
|
+
# Default office ID
|
24
24
|
attr_accessor :default_office_id
|
25
25
|
|
26
26
|
# Valid values are 'Company', 'Region', 'Office', 'Contributor'
|
@@ -61,7 +61,7 @@ module DocuSign_Rooms
|
|
61
61
|
# Adds the user to the designated office.
|
62
62
|
# @param user_id The id of the user.
|
63
63
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
64
|
-
# @param body
|
64
|
+
# @param body Details of the office that the user will be added to (optional parameter)
|
65
65
|
# @return [nil]
|
66
66
|
def add_user_to_office(user_id, account_id, body)
|
67
67
|
add_user_to_office_with_http_info(user_id, account_id, body)
|
@@ -72,7 +72,7 @@ module DocuSign_Rooms
|
|
72
72
|
# Adds the user to the designated office.
|
73
73
|
# @param user_id The id of the user.
|
74
74
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
75
|
-
# @param body
|
75
|
+
# @param body Details of the office that the user will be added to (optional parameter)
|
76
76
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
77
77
|
def add_user_to_office_with_http_info(user_id, account_id, body)
|
78
78
|
if @api_client.config.debugging
|
@@ -91,9 +91,9 @@ module DocuSign_Rooms
|
|
91
91
|
# header parameters
|
92
92
|
header_params = {}
|
93
93
|
# HTTP header 'Accept' (if needed)
|
94
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
94
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
95
95
|
# HTTP header 'Content-Type'
|
96
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
96
|
+
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'])
|
97
97
|
|
98
98
|
# form parameters
|
99
99
|
form_params = {}
|
@@ -117,7 +117,7 @@ module DocuSign_Rooms
|
|
117
117
|
# Adds the user to the designated region.
|
118
118
|
# @param user_id The id of the user.
|
119
119
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
120
|
-
# @param body
|
120
|
+
# @param body Region that given user will be added to (optional parameter)
|
121
121
|
# @return [nil]
|
122
122
|
def add_user_to_region(user_id, account_id, body)
|
123
123
|
add_user_to_region_with_http_info(user_id, account_id, body)
|
@@ -128,7 +128,7 @@ module DocuSign_Rooms
|
|
128
128
|
# Adds the user to the designated region.
|
129
129
|
# @param user_id The id of the user.
|
130
130
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
131
|
-
# @param body
|
131
|
+
# @param body Region that given user will be added to (optional parameter)
|
132
132
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
133
133
|
def add_user_to_region_with_http_info(user_id, account_id, body)
|
134
134
|
if @api_client.config.debugging
|
@@ -147,9 +147,9 @@ module DocuSign_Rooms
|
|
147
147
|
# header parameters
|
148
148
|
header_params = {}
|
149
149
|
# HTTP header 'Accept' (if needed)
|
150
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
151
151
|
# HTTP header 'Content-Type'
|
152
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
152
|
+
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'])
|
153
153
|
|
154
154
|
# form parameters
|
155
155
|
form_params = {}
|
@@ -201,7 +201,7 @@ module DocuSign_Rooms
|
|
201
201
|
# header parameters
|
202
202
|
header_params = {}
|
203
203
|
# HTTP header 'Accept' (if needed)
|
204
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
204
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
205
205
|
# HTTP header 'Content-Type'
|
206
206
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
207
207
|
|
@@ -245,15 +245,6 @@ module DocuSign_Rooms
|
|
245
245
|
end
|
246
246
|
# verify the required parameter 'account_id' is set
|
247
247
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_users" if account_id.nil?
|
248
|
-
if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
|
249
|
-
fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
|
250
|
-
end
|
251
|
-
if options.access_level && !['Contributor', 'Office', 'Region', 'Company', 'Admin'].include?(options.access_level)
|
252
|
-
fail ArgumentError, 'invalid value for "access_level", must be one of Contributor, Office, Region, Company, Admin'
|
253
|
-
end
|
254
|
-
if options.status && !['Active', 'Pending'].include?(options.status)
|
255
|
-
fail ArgumentError, 'invalid value for "status", must be one of Active, Pending'
|
256
|
-
end
|
257
248
|
# resource path
|
258
249
|
local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
259
250
|
|
@@ -273,7 +264,7 @@ module DocuSign_Rooms
|
|
273
264
|
# header parameters
|
274
265
|
header_params = {}
|
275
266
|
# HTTP header 'Accept' (if needed)
|
276
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
267
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
277
268
|
# HTTP header 'Content-Type'
|
278
269
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
279
270
|
|
@@ -296,169 +287,10 @@ module DocuSign_Rooms
|
|
296
287
|
return data, status_code, headers
|
297
288
|
end
|
298
289
|
|
299
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
|
300
|
-
# Invites a new user to join a company account on Rooms Version 5 as an Admin.
|
301
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
302
|
-
# @param body (optional parameter)
|
303
|
-
# @return [User]
|
304
|
-
def invite_classic_admin(account_id, body)
|
305
|
-
data, _status_code, _headers = invite_classic_admin_with_http_info(account_id, body)
|
306
|
-
return data
|
307
|
-
end
|
308
|
-
|
309
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
|
310
|
-
# Invites a new user to join a company account on Rooms Version 5 as an Admin.
|
311
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
312
|
-
# @param body (optional parameter)
|
313
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
314
|
-
def invite_classic_admin_with_http_info(account_id, body)
|
315
|
-
if @api_client.config.debugging
|
316
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_admin ..."
|
317
|
-
end
|
318
|
-
# verify the required parameter 'account_id' is set
|
319
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_admin" if account_id.nil?
|
320
|
-
# resource path
|
321
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_admin".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
322
|
-
|
323
|
-
# query parameters
|
324
|
-
query_params = {}
|
325
|
-
|
326
|
-
# header parameters
|
327
|
-
header_params = {}
|
328
|
-
# HTTP header 'Accept' (if needed)
|
329
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
330
|
-
# HTTP header 'Content-Type'
|
331
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
332
|
-
|
333
|
-
# form parameters
|
334
|
-
form_params = {}
|
335
|
-
|
336
|
-
# http body (model)
|
337
|
-
post_body = @api_client.object_to_http_body(body)
|
338
|
-
auth_names = []
|
339
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
340
|
-
:header_params => header_params,
|
341
|
-
:query_params => query_params,
|
342
|
-
:form_params => form_params,
|
343
|
-
:body => post_body,
|
344
|
-
:auth_names => auth_names,
|
345
|
-
:return_type => 'User')
|
346
|
-
if @api_client.config.debugging
|
347
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
348
|
-
end
|
349
|
-
return data, status_code, headers
|
350
|
-
end
|
351
|
-
|
352
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
|
353
|
-
# Invites a new user to join a company account on Rooms Version 5 as an Agent.
|
354
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
355
|
-
# @param body (optional parameter)
|
356
|
-
# @return [User]
|
357
|
-
def invite_classic_agent(account_id, body)
|
358
|
-
data, _status_code, _headers = invite_classic_agent_with_http_info(account_id, body)
|
359
|
-
return data
|
360
|
-
end
|
361
|
-
|
362
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
|
363
|
-
# Invites a new user to join a company account on Rooms Version 5 as an Agent.
|
364
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
365
|
-
# @param body (optional parameter)
|
366
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
367
|
-
def invite_classic_agent_with_http_info(account_id, body)
|
368
|
-
if @api_client.config.debugging
|
369
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_agent ..."
|
370
|
-
end
|
371
|
-
# verify the required parameter 'account_id' is set
|
372
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_agent" if account_id.nil?
|
373
|
-
# resource path
|
374
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_agent".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
375
|
-
|
376
|
-
# query parameters
|
377
|
-
query_params = {}
|
378
|
-
|
379
|
-
# header parameters
|
380
|
-
header_params = {}
|
381
|
-
# HTTP header 'Accept' (if needed)
|
382
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
383
|
-
# HTTP header 'Content-Type'
|
384
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
385
|
-
|
386
|
-
# form parameters
|
387
|
-
form_params = {}
|
388
|
-
|
389
|
-
# http body (model)
|
390
|
-
post_body = @api_client.object_to_http_body(body)
|
391
|
-
auth_names = []
|
392
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
393
|
-
:header_params => header_params,
|
394
|
-
:query_params => query_params,
|
395
|
-
:form_params => form_params,
|
396
|
-
:body => post_body,
|
397
|
-
:auth_names => auth_names,
|
398
|
-
:return_type => 'User')
|
399
|
-
if @api_client.config.debugging
|
400
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
401
|
-
end
|
402
|
-
return data, status_code, headers
|
403
|
-
end
|
404
|
-
|
405
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
|
406
|
-
# Invites a new user to join a company account on Rooms Version 5 as a Manager.
|
407
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
408
|
-
# @param body (optional parameter)
|
409
|
-
# @return [User]
|
410
|
-
def invite_classic_manager(account_id, body)
|
411
|
-
data, _status_code, _headers = invite_classic_manager_with_http_info(account_id, body)
|
412
|
-
return data
|
413
|
-
end
|
414
|
-
|
415
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
|
416
|
-
# Invites a new user to join a company account on Rooms Version 5 as a Manager.
|
417
|
-
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
418
|
-
# @param body (optional parameter)
|
419
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
420
|
-
def invite_classic_manager_with_http_info(account_id, body)
|
421
|
-
if @api_client.config.debugging
|
422
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_manager ..."
|
423
|
-
end
|
424
|
-
# verify the required parameter 'account_id' is set
|
425
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_manager" if account_id.nil?
|
426
|
-
# resource path
|
427
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_manager".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
428
|
-
|
429
|
-
# query parameters
|
430
|
-
query_params = {}
|
431
|
-
|
432
|
-
# header parameters
|
433
|
-
header_params = {}
|
434
|
-
# HTTP header 'Accept' (if needed)
|
435
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
436
|
-
# HTTP header 'Content-Type'
|
437
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
438
|
-
|
439
|
-
# form parameters
|
440
|
-
form_params = {}
|
441
|
-
|
442
|
-
# http body (model)
|
443
|
-
post_body = @api_client.object_to_http_body(body)
|
444
|
-
auth_names = []
|
445
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
446
|
-
:header_params => header_params,
|
447
|
-
:query_params => query_params,
|
448
|
-
:form_params => form_params,
|
449
|
-
:body => post_body,
|
450
|
-
:auth_names => auth_names,
|
451
|
-
:return_type => 'User')
|
452
|
-
if @api_client.config.debugging
|
453
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_manager\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
454
|
-
end
|
455
|
-
return data, status_code, headers
|
456
|
-
end
|
457
|
-
|
458
290
|
# NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
|
459
291
|
# Invites a new user to join a company account on Rooms Version 6.
|
460
292
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
461
|
-
# @param body
|
293
|
+
# @param body Invitee information (optional parameter)
|
462
294
|
# @return [User]
|
463
295
|
def invite_user(account_id, body)
|
464
296
|
data, _status_code, _headers = invite_user_with_http_info(account_id, body)
|
@@ -468,7 +300,7 @@ module DocuSign_Rooms
|
|
468
300
|
# NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
|
469
301
|
# Invites a new user to join a company account on Rooms Version 6.
|
470
302
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
471
|
-
# @param body
|
303
|
+
# @param body Invitee information (optional parameter)
|
472
304
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
473
305
|
def invite_user_with_http_info(account_id, body)
|
474
306
|
if @api_client.config.debugging
|
@@ -485,7 +317,7 @@ module DocuSign_Rooms
|
|
485
317
|
# header parameters
|
486
318
|
header_params = {}
|
487
319
|
# HTTP header 'Accept' (if needed)
|
488
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
320
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
489
321
|
# HTTP header 'Content-Type'
|
490
322
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
491
323
|
|
@@ -512,7 +344,7 @@ module DocuSign_Rooms
|
|
512
344
|
# Locks the account of the user.
|
513
345
|
# @param user_id User Id of the user attempting to be locked.
|
514
346
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
515
|
-
# @param body
|
347
|
+
# @param body Details containing the reason the user is being locked out (optional parameter)
|
516
348
|
# @return [nil]
|
517
349
|
def lock_user(user_id, account_id, body)
|
518
350
|
lock_user_with_http_info(user_id, account_id, body)
|
@@ -523,7 +355,7 @@ module DocuSign_Rooms
|
|
523
355
|
# Locks the account of the user.
|
524
356
|
# @param user_id User Id of the user attempting to be locked.
|
525
357
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
526
|
-
# @param body
|
358
|
+
# @param body Details containing the reason the user is being locked out (optional parameter)
|
527
359
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
528
360
|
def lock_user_with_http_info(user_id, account_id, body)
|
529
361
|
if @api_client.config.debugging
|
@@ -542,7 +374,7 @@ module DocuSign_Rooms
|
|
542
374
|
# header parameters
|
543
375
|
header_params = {}
|
544
376
|
# HTTP header 'Accept' (if needed)
|
545
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
377
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
546
378
|
# HTTP header 'Content-Type'
|
547
379
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
548
380
|
|
@@ -566,7 +398,7 @@ module DocuSign_Rooms
|
|
566
398
|
|
567
399
|
# Reinvites the pending user with the given userId.
|
568
400
|
# Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.
|
569
|
-
# @param user_id
|
401
|
+
# @param user_id ID of the user to be invited
|
570
402
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
571
403
|
# @return [nil]
|
572
404
|
def reinvite_user(user_id, account_id)
|
@@ -576,7 +408,7 @@ module DocuSign_Rooms
|
|
576
408
|
|
577
409
|
# Reinvites the pending user with the given userId.
|
578
410
|
# Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.
|
579
|
-
# @param user_id
|
411
|
+
# @param user_id ID of the user to be invited
|
580
412
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
581
413
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
582
414
|
def reinvite_user_with_http_info(user_id, account_id)
|
@@ -596,7 +428,7 @@ module DocuSign_Rooms
|
|
596
428
|
# header parameters
|
597
429
|
header_params = {}
|
598
430
|
# HTTP header 'Accept' (if needed)
|
599
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
431
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
600
432
|
# HTTP header 'Content-Type'
|
601
433
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
602
434
|
|
@@ -650,7 +482,7 @@ module DocuSign_Rooms
|
|
650
482
|
# header parameters
|
651
483
|
header_params = {}
|
652
484
|
# HTTP header 'Accept' (if needed)
|
653
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
485
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
654
486
|
# HTTP header 'Content-Type'
|
655
487
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
656
488
|
|
@@ -676,7 +508,7 @@ module DocuSign_Rooms
|
|
676
508
|
# Removes the user from the designated office.
|
677
509
|
# @param user_id The id of the user.
|
678
510
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
679
|
-
# @param body
|
511
|
+
# @param body Details of the office that the user will be removed from (optional parameter)
|
680
512
|
# @return [nil]
|
681
513
|
def remove_user_from_office(user_id, account_id, body)
|
682
514
|
remove_user_from_office_with_http_info(user_id, account_id, body)
|
@@ -687,7 +519,7 @@ module DocuSign_Rooms
|
|
687
519
|
# Removes the user from the designated office.
|
688
520
|
# @param user_id The id of the user.
|
689
521
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
690
|
-
# @param body
|
522
|
+
# @param body Details of the office that the user will be removed from (optional parameter)
|
691
523
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
692
524
|
def remove_user_from_office_with_http_info(user_id, account_id, body)
|
693
525
|
if @api_client.config.debugging
|
@@ -706,9 +538,9 @@ module DocuSign_Rooms
|
|
706
538
|
# header parameters
|
707
539
|
header_params = {}
|
708
540
|
# HTTP header 'Accept' (if needed)
|
709
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
541
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
710
542
|
# HTTP header 'Content-Type'
|
711
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
543
|
+
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'])
|
712
544
|
|
713
545
|
# form parameters
|
714
546
|
form_params = {}
|
@@ -732,7 +564,7 @@ module DocuSign_Rooms
|
|
732
564
|
# Removes the user from the designated region.
|
733
565
|
# @param user_id The id of the user.
|
734
566
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
735
|
-
# @param body
|
567
|
+
# @param body Region that given user will be removed from (optional parameter)
|
736
568
|
# @return [nil]
|
737
569
|
def remove_user_from_region(user_id, account_id, body)
|
738
570
|
remove_user_from_region_with_http_info(user_id, account_id, body)
|
@@ -743,7 +575,7 @@ module DocuSign_Rooms
|
|
743
575
|
# Removes the user from the designated region.
|
744
576
|
# @param user_id The id of the user.
|
745
577
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
746
|
-
# @param body
|
578
|
+
# @param body Region that given user will be removed from (optional parameter)
|
747
579
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
748
580
|
def remove_user_from_region_with_http_info(user_id, account_id, body)
|
749
581
|
if @api_client.config.debugging
|
@@ -762,9 +594,9 @@ module DocuSign_Rooms
|
|
762
594
|
# header parameters
|
763
595
|
header_params = {}
|
764
596
|
# HTTP header 'Accept' (if needed)
|
765
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
597
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
766
598
|
# HTTP header 'Content-Type'
|
767
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
599
|
+
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'])
|
768
600
|
|
769
601
|
# form parameters
|
770
602
|
form_params = {}
|
@@ -816,7 +648,7 @@ module DocuSign_Rooms
|
|
816
648
|
# header parameters
|
817
649
|
header_params = {}
|
818
650
|
# HTTP header 'Accept' (if needed)
|
819
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
651
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
820
652
|
# HTTP header 'Content-Type'
|
821
653
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
822
654
|
|
@@ -842,7 +674,7 @@ module DocuSign_Rooms
|
|
842
674
|
# Updates user information
|
843
675
|
# @param user_id The id of the user.
|
844
676
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
845
|
-
# @param body
|
677
|
+
# @param body Request body to update the user (optional parameter)
|
846
678
|
# @return [User]
|
847
679
|
def update_user(user_id, account_id, body)
|
848
680
|
data, _status_code, _headers = update_user_with_http_info(user_id, account_id, body)
|
@@ -853,7 +685,7 @@ module DocuSign_Rooms
|
|
853
685
|
# Updates user information
|
854
686
|
# @param user_id The id of the user.
|
855
687
|
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
856
|
-
# @param body
|
688
|
+
# @param body Request body to update the user (optional parameter)
|
857
689
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
858
690
|
def update_user_with_http_info(user_id, account_id, body)
|
859
691
|
if @api_client.config.debugging
|
@@ -872,9 +704,9 @@ module DocuSign_Rooms
|
|
872
704
|
# header parameters
|
873
705
|
header_params = {}
|
874
706
|
# HTTP header 'Accept' (if needed)
|
875
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
707
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
876
708
|
# HTTP header 'Content-Type'
|
877
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
709
|
+
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'])
|
878
710
|
|
879
711
|
# form parameters
|
880
712
|
form_params = {}
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#DocuSign Rooms API
|
2
|
+
#DocuSign Rooms API - v2
|
3
3
|
|
4
4
|
#An API for an integrator to access the features of DocuSign Rooms
|
5
5
|
|
@@ -35,7 +35,7 @@ module DocuSign_Rooms
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "Swagger-Codegen
|
38
|
+
@user_agent = "Swagger-Codegen/1.3.0/ruby"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => "application/json",
|
41
41
|
'User-Agent' => @user_agent
|
@@ -392,8 +392,11 @@ module DocuSign_Rooms
|
|
392
392
|
# Helper method to set oauth base path
|
393
393
|
# @param [String] oauth_base_path if passed nil it will determined from base_path
|
394
394
|
def set_oauth_base_path(oauth_base_path=nil)
|
395
|
-
|
396
|
-
|
395
|
+
if oauth_base_path
|
396
|
+
raise ArgumentError.new('OAuth base path should only include domain name (without https://)') if oauth_base_path.include? "//"
|
397
|
+
self.oauth_base_path = oauth_base_path
|
398
|
+
return
|
399
|
+
end
|
397
400
|
|
398
401
|
# did we need this check as we can determine it from base path
|
399
402
|
#raise ArgumentError.new('oAuthBasePath cannot be empty') unless oauth_base_path
|
@@ -572,13 +575,14 @@ module DocuSign_Rooms
|
|
572
575
|
:return_type => 'OAuth::OAuthToken',
|
573
576
|
:oauth => true
|
574
577
|
}
|
575
|
-
|
576
|
-
|
578
|
+
|
579
|
+
token, status_code, headers = self.call_api("POST", '/oauth/token', params)
|
577
580
|
|
578
|
-
|
581
|
+
if status_code == 200
|
582
|
+
self.default_headers.store('Authorization', "#{token.token_type} #{token.access_token}")
|
579
583
|
|
580
|
-
|
581
|
-
|
584
|
+
token
|
585
|
+
end
|
582
586
|
end
|
583
587
|
|
584
588
|
# Helper method to add default header params
|
@@ -588,4 +592,4 @@ module DocuSign_Rooms
|
|
588
592
|
@default_headers[header_name] = header_value
|
589
593
|
end
|
590
594
|
end
|
591
|
-
end
|
595
|
+
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
|
-
#DocuSign
|
2
|
+
#DocuSign Rooms API - v2
|
3
3
|
|
4
|
-
#
|
4
|
+
#An API for an integrator to access the features of DocuSign Rooms
|
5
5
|
|
6
6
|
OpenAPI spec version: v2
|
7
7
|
Contact: devcenter@docusign.com
|
@@ -25,6 +25,28 @@ module DocuSign_Rooms
|
|
25
25
|
|
26
26
|
attr_accessor :require_office_library_assignments
|
27
27
|
|
28
|
+
class EnumAttributeValidator
|
29
|
+
attr_reader :datatype
|
30
|
+
attr_reader :allowable_values
|
31
|
+
|
32
|
+
def initialize(datatype, allowable_values)
|
33
|
+
@allowable_values = allowable_values.map do |value|
|
34
|
+
case datatype.to_s
|
35
|
+
when /Integer/i
|
36
|
+
value.to_i
|
37
|
+
when /Float/i
|
38
|
+
value.to_f
|
39
|
+
else
|
40
|
+
value
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
def valid?(value)
|
46
|
+
!value || allowable_values.include?(value)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
28
50
|
# Attribute mapping from ruby-style variable name to JSON key.
|
29
51
|
def self.attribute_map
|
30
52
|
{
|
@@ -42,7 +64,7 @@ module DocuSign_Rooms
|
|
42
64
|
{
|
43
65
|
:'company_id' => :'Integer',
|
44
66
|
:'name' => :'String',
|
45
|
-
:'company_version' => :'
|
67
|
+
:'company_version' => :'String',
|
46
68
|
:'docu_sign_account_guid' => :'String',
|
47
69
|
:'default_field_set_id' => :'String',
|
48
70
|
:'require_office_library_assignments' => :'BOOLEAN'
|
@@ -92,9 +114,21 @@ module DocuSign_Rooms
|
|
92
114
|
# Check to see if the all the properties in the model are valid
|
93
115
|
# @return true if the model is valid
|
94
116
|
def valid?
|
117
|
+
company_version_validator = EnumAttributeValidator.new('String', ['v5', 'v6'])
|
118
|
+
return false unless company_version_validator.valid?(@company_version)
|
95
119
|
true
|
96
120
|
end
|
97
121
|
|
122
|
+
# Custom attribute writer method checking allowed values (enum).
|
123
|
+
# @param [Object] company_version Object to be assigned
|
124
|
+
def company_version=(company_version)
|
125
|
+
validator = EnumAttributeValidator.new('String', ['v5', 'v6'])
|
126
|
+
unless validator.valid?(company_version)
|
127
|
+
fail ArgumentError, 'invalid value for "company_version", must be one of #{validator.allowable_values}.'
|
128
|
+
end
|
129
|
+
@company_version = company_version
|
130
|
+
end
|
131
|
+
|
98
132
|
# Checks equality by comparing each attribute.
|
99
133
|
# @param [Object] Object to be compared
|
100
134
|
def ==(o)
|
@@ -17,11 +17,14 @@ module DocuSign_Rooms
|
|
17
17
|
|
18
18
|
attr_accessor :message
|
19
19
|
|
20
|
+
attr_accessor :reference_id
|
21
|
+
|
20
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
23
|
def self.attribute_map
|
22
24
|
{
|
23
25
|
:'error_code' => :'errorCode',
|
24
|
-
:'message' => :'message'
|
26
|
+
:'message' => :'message',
|
27
|
+
:'reference_id' => :'referenceId'
|
25
28
|
}
|
26
29
|
end
|
27
30
|
|
@@ -29,7 +32,8 @@ module DocuSign_Rooms
|
|
29
32
|
def self.swagger_types
|
30
33
|
{
|
31
34
|
:'error_code' => :'String',
|
32
|
-
:'message' => :'String'
|
35
|
+
:'message' => :'String',
|
36
|
+
:'reference_id' => :'String'
|
33
37
|
}
|
34
38
|
end
|
35
39
|
|
@@ -48,6 +52,10 @@ module DocuSign_Rooms
|
|
48
52
|
if attributes.has_key?(:'message')
|
49
53
|
self.message = attributes[:'message']
|
50
54
|
end
|
55
|
+
|
56
|
+
if attributes.has_key?(:'referenceId')
|
57
|
+
self.reference_id = attributes[:'referenceId']
|
58
|
+
end
|
51
59
|
end
|
52
60
|
|
53
61
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -69,7 +77,8 @@ module DocuSign_Rooms
|
|
69
77
|
return true if self.equal?(o)
|
70
78
|
self.class == o.class &&
|
71
79
|
error_code == o.error_code &&
|
72
|
-
message == o.message
|
80
|
+
message == o.message &&
|
81
|
+
reference_id == o.reference_id
|
73
82
|
end
|
74
83
|
|
75
84
|
# @see the `==` method
|
@@ -81,7 +90,7 @@ module DocuSign_Rooms
|
|
81
90
|
# Calculates hash code according to all attributes.
|
82
91
|
# @return [Fixnum] Hash code
|
83
92
|
def hash
|
84
|
-
[error_code, message].hash
|
93
|
+
[error_code, message, reference_id].hash
|
85
94
|
end
|
86
95
|
|
87
96
|
# Builds the object from hash
|