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
@@ -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'
|
@@ -35,7 +35,7 @@ module DocuSign_Rooms
|
|
35
35
|
# Valid values are 'Active', 'Pending'
|
36
36
|
attr_accessor :status
|
37
37
|
|
38
|
-
#
|
38
|
+
# When set to true, filters for users whose accounts are locked
|
39
39
|
attr_accessor :locked_only
|
40
40
|
|
41
41
|
# Defaults to 0
|
@@ -58,10 +58,10 @@ module DocuSign_Rooms
|
|
58
58
|
end
|
59
59
|
|
60
60
|
# Adds the user to the designated office.
|
61
|
-
#
|
62
|
-
# @param user_id
|
63
|
-
# @param account_id
|
64
|
-
# @param body
|
61
|
+
# Adds the user to the designated office.
|
62
|
+
# @param user_id The id of the user.
|
63
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
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)
|
@@ -69,10 +69,10 @@ module DocuSign_Rooms
|
|
69
69
|
end
|
70
70
|
|
71
71
|
# Adds the user to the designated office.
|
72
|
-
#
|
73
|
-
# @param user_id
|
74
|
-
# @param account_id
|
75
|
-
# @param body
|
72
|
+
# Adds the user to the designated office.
|
73
|
+
# @param user_id The id of the user.
|
74
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
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 = {}
|
@@ -114,10 +114,10 @@ module DocuSign_Rooms
|
|
114
114
|
end
|
115
115
|
|
116
116
|
# Adds the user to the designated region.
|
117
|
-
#
|
118
|
-
# @param user_id
|
119
|
-
# @param account_id
|
120
|
-
# @param body
|
117
|
+
# Adds the user to the designated region.
|
118
|
+
# @param user_id The id of the user.
|
119
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
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)
|
@@ -125,10 +125,10 @@ module DocuSign_Rooms
|
|
125
125
|
end
|
126
126
|
|
127
127
|
# Adds the user to the designated region.
|
128
|
-
#
|
129
|
-
# @param user_id
|
130
|
-
# @param account_id
|
131
|
-
# @param body
|
128
|
+
# Adds the user to the designated region.
|
129
|
+
# @param user_id The id of the user.
|
130
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
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 = {}
|
@@ -170,9 +170,9 @@ module DocuSign_Rooms
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Retrieves user information for the user having the given UserId.
|
173
|
-
#
|
174
|
-
# @param user_id
|
175
|
-
# @param account_id
|
173
|
+
# Retrieves user information for the user having the given UserId.
|
174
|
+
# @param user_id The id of the user.
|
175
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
176
176
|
# @return [User]
|
177
177
|
def get_user(user_id, account_id)
|
178
178
|
data, _status_code, _headers = get_user_with_http_info(user_id, account_id)
|
@@ -180,9 +180,9 @@ module DocuSign_Rooms
|
|
180
180
|
end
|
181
181
|
|
182
182
|
# Retrieves user information for the user having the given UserId.
|
183
|
-
#
|
184
|
-
# @param user_id
|
185
|
-
# @param account_id
|
183
|
+
# Retrieves user information for the user having the given UserId.
|
184
|
+
# @param user_id The id of the user.
|
185
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
186
186
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
187
187
|
def get_user_with_http_info(user_id, account_id)
|
188
188
|
if @api_client.config.debugging
|
@@ -201,7 +201,9 @@ 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
|
+
# HTTP header 'Content-Type'
|
206
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
205
207
|
|
206
208
|
# form parameters
|
207
209
|
form_params = {}
|
@@ -222,9 +224,9 @@ module DocuSign_Rooms
|
|
222
224
|
return data, status_code, headers
|
223
225
|
end
|
224
226
|
|
225
|
-
# Gets a paged-list of
|
227
|
+
# Gets a paged-list of users.
|
226
228
|
# Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.
|
227
|
-
# @param account_id
|
229
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
228
230
|
# @param DocuSign_Rooms::GetUsersOptions Options for modifying the behavior of the function.
|
229
231
|
# @return [UserSummaryList]
|
230
232
|
def get_users(account_id, options = DocuSign_Rooms::GetUsersOptions.default)
|
@@ -232,9 +234,9 @@ module DocuSign_Rooms
|
|
232
234
|
return data
|
233
235
|
end
|
234
236
|
|
235
|
-
# Gets a paged-list of
|
237
|
+
# Gets a paged-list of users.
|
236
238
|
# Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.
|
237
|
-
# @param account_id
|
239
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
238
240
|
# @param DocuSign_Rooms::GetUsersOptions Options for modifying the behavior of the function.
|
239
241
|
# @return [Array<(UserSummaryList, Fixnum, Hash)>] UserSummaryList data, response status code and response headers
|
240
242
|
def get_users_with_http_info(account_id, options = DocuSign_Rooms::GetUsersOptions.default)
|
@@ -243,15 +245,6 @@ module DocuSign_Rooms
|
|
243
245
|
end
|
244
246
|
# verify the required parameter 'account_id' is set
|
245
247
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_users" if account_id.nil?
|
246
|
-
if options.sort && !['FirstNameAsc', 'LastNameAsc', 'EmailAsc', 'FirstNameDesc', 'LastNameDesc', 'EmailDesc'].include?(options.sort)
|
247
|
-
fail ArgumentError, 'invalid value for "sort", must be one of FirstNameAsc, LastNameAsc, EmailAsc, FirstNameDesc, LastNameDesc, EmailDesc'
|
248
|
-
end
|
249
|
-
if options.access_level && !['Contributor', 'Office', 'Region', 'Company', 'Admin'].include?(options.access_level)
|
250
|
-
fail ArgumentError, 'invalid value for "access_level", must be one of Contributor, Office, Region, Company, Admin'
|
251
|
-
end
|
252
|
-
if options.status && !['Active', 'Pending'].include?(options.status)
|
253
|
-
fail ArgumentError, 'invalid value for "status", must be one of Active, Pending'
|
254
|
-
end
|
255
248
|
# resource path
|
256
249
|
local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
257
250
|
|
@@ -271,7 +264,9 @@ module DocuSign_Rooms
|
|
271
264
|
# header parameters
|
272
265
|
header_params = {}
|
273
266
|
# HTTP header 'Accept' (if needed)
|
274
|
-
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'])
|
268
|
+
# HTTP header 'Content-Type'
|
269
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
275
270
|
|
276
271
|
# form parameters
|
277
272
|
form_params = {}
|
@@ -292,169 +287,10 @@ module DocuSign_Rooms
|
|
292
287
|
return data, status_code, headers
|
293
288
|
end
|
294
289
|
|
295
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
|
296
|
-
#
|
297
|
-
# @param account_id
|
298
|
-
# @param body (optional parameter)
|
299
|
-
# @return [User]
|
300
|
-
def invite_classic_admin(account_id, body)
|
301
|
-
data, _status_code, _headers = invite_classic_admin_with_http_info(account_id, body)
|
302
|
-
return data
|
303
|
-
end
|
304
|
-
|
305
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin.
|
306
|
-
#
|
307
|
-
# @param account_id
|
308
|
-
# @param body (optional parameter)
|
309
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
310
|
-
def invite_classic_admin_with_http_info(account_id, body)
|
311
|
-
if @api_client.config.debugging
|
312
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_admin ..."
|
313
|
-
end
|
314
|
-
# verify the required parameter 'account_id' is set
|
315
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_admin" if account_id.nil?
|
316
|
-
# resource path
|
317
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_admin".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
318
|
-
|
319
|
-
# query parameters
|
320
|
-
query_params = {}
|
321
|
-
|
322
|
-
# header parameters
|
323
|
-
header_params = {}
|
324
|
-
# HTTP header 'Accept' (if needed)
|
325
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
326
|
-
# HTTP header 'Content-Type'
|
327
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
328
|
-
|
329
|
-
# form parameters
|
330
|
-
form_params = {}
|
331
|
-
|
332
|
-
# http body (model)
|
333
|
-
post_body = @api_client.object_to_http_body(body)
|
334
|
-
auth_names = []
|
335
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
336
|
-
:header_params => header_params,
|
337
|
-
:query_params => query_params,
|
338
|
-
:form_params => form_params,
|
339
|
-
:body => post_body,
|
340
|
-
:auth_names => auth_names,
|
341
|
-
:return_type => 'User')
|
342
|
-
if @api_client.config.debugging
|
343
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
344
|
-
end
|
345
|
-
return data, status_code, headers
|
346
|
-
end
|
347
|
-
|
348
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
|
349
|
-
#
|
350
|
-
# @param account_id
|
351
|
-
# @param body (optional parameter)
|
352
|
-
# @return [User]
|
353
|
-
def invite_classic_agent(account_id, body)
|
354
|
-
data, _status_code, _headers = invite_classic_agent_with_http_info(account_id, body)
|
355
|
-
return data
|
356
|
-
end
|
357
|
-
|
358
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent.
|
359
|
-
#
|
360
|
-
# @param account_id
|
361
|
-
# @param body (optional parameter)
|
362
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
363
|
-
def invite_classic_agent_with_http_info(account_id, body)
|
364
|
-
if @api_client.config.debugging
|
365
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_agent ..."
|
366
|
-
end
|
367
|
-
# verify the required parameter 'account_id' is set
|
368
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_agent" if account_id.nil?
|
369
|
-
# resource path
|
370
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_agent".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
371
|
-
|
372
|
-
# query parameters
|
373
|
-
query_params = {}
|
374
|
-
|
375
|
-
# header parameters
|
376
|
-
header_params = {}
|
377
|
-
# HTTP header 'Accept' (if needed)
|
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'])
|
381
|
-
|
382
|
-
# form parameters
|
383
|
-
form_params = {}
|
384
|
-
|
385
|
-
# http body (model)
|
386
|
-
post_body = @api_client.object_to_http_body(body)
|
387
|
-
auth_names = []
|
388
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
389
|
-
:header_params => header_params,
|
390
|
-
:query_params => query_params,
|
391
|
-
:form_params => form_params,
|
392
|
-
:body => post_body,
|
393
|
-
:auth_names => auth_names,
|
394
|
-
:return_type => 'User')
|
395
|
-
if @api_client.config.debugging
|
396
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
397
|
-
end
|
398
|
-
return data, status_code, headers
|
399
|
-
end
|
400
|
-
|
401
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
|
402
|
-
#
|
403
|
-
# @param account_id
|
404
|
-
# @param body (optional parameter)
|
405
|
-
# @return [User]
|
406
|
-
def invite_classic_manager(account_id, body)
|
407
|
-
data, _status_code, _headers = invite_classic_manager_with_http_info(account_id, body)
|
408
|
-
return data
|
409
|
-
end
|
410
|
-
|
411
|
-
# CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager.
|
412
|
-
#
|
413
|
-
# @param account_id
|
414
|
-
# @param body (optional parameter)
|
415
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
416
|
-
def invite_classic_manager_with_http_info(account_id, body)
|
417
|
-
if @api_client.config.debugging
|
418
|
-
@api_client.config.logger.debug "Calling API: UsersApi.invite_classic_manager ..."
|
419
|
-
end
|
420
|
-
# verify the required parameter 'account_id' is set
|
421
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.invite_classic_manager" if account_id.nil?
|
422
|
-
# resource path
|
423
|
-
local_var_path = "/v2/accounts/{accountId}/users/invite_classic_manager".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
424
|
-
|
425
|
-
# query parameters
|
426
|
-
query_params = {}
|
427
|
-
|
428
|
-
# header parameters
|
429
|
-
header_params = {}
|
430
|
-
# HTTP header 'Accept' (if needed)
|
431
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
432
|
-
# HTTP header 'Content-Type'
|
433
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
434
|
-
|
435
|
-
# form parameters
|
436
|
-
form_params = {}
|
437
|
-
|
438
|
-
# http body (model)
|
439
|
-
post_body = @api_client.object_to_http_body(body)
|
440
|
-
auth_names = []
|
441
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
442
|
-
:header_params => header_params,
|
443
|
-
:query_params => query_params,
|
444
|
-
:form_params => form_params,
|
445
|
-
:body => post_body,
|
446
|
-
:auth_names => auth_names,
|
447
|
-
:return_type => 'User')
|
448
|
-
if @api_client.config.debugging
|
449
|
-
@api_client.config.logger.debug "API called: UsersApi#invite_classic_manager\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
450
|
-
end
|
451
|
-
return data, status_code, headers
|
452
|
-
end
|
453
|
-
|
454
290
|
# NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
|
455
|
-
#
|
456
|
-
# @param account_id
|
457
|
-
# @param body
|
291
|
+
# Invites a new user to join a company account on Rooms Version 6.
|
292
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
293
|
+
# @param body Invitee information (optional parameter)
|
458
294
|
# @return [User]
|
459
295
|
def invite_user(account_id, body)
|
460
296
|
data, _status_code, _headers = invite_user_with_http_info(account_id, body)
|
@@ -462,9 +298,9 @@ module DocuSign_Rooms
|
|
462
298
|
end
|
463
299
|
|
464
300
|
# NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email.
|
465
|
-
#
|
466
|
-
# @param account_id
|
467
|
-
# @param body
|
301
|
+
# Invites a new user to join a company account on Rooms Version 6.
|
302
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
303
|
+
# @param body Invitee information (optional parameter)
|
468
304
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
469
305
|
def invite_user_with_http_info(account_id, body)
|
470
306
|
if @api_client.config.debugging
|
@@ -481,7 +317,7 @@ module DocuSign_Rooms
|
|
481
317
|
# header parameters
|
482
318
|
header_params = {}
|
483
319
|
# HTTP header 'Accept' (if needed)
|
484
|
-
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'])
|
485
321
|
# HTTP header 'Content-Type'
|
486
322
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
487
323
|
|
@@ -505,10 +341,10 @@ module DocuSign_Rooms
|
|
505
341
|
end
|
506
342
|
|
507
343
|
# Locks the account of the user.
|
508
|
-
#
|
344
|
+
# Locks the account of the user.
|
509
345
|
# @param user_id User Id of the user attempting to be locked.
|
510
|
-
# @param account_id
|
511
|
-
# @param body
|
346
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
347
|
+
# @param body Details containing the reason the user is being locked out (optional parameter)
|
512
348
|
# @return [nil]
|
513
349
|
def lock_user(user_id, account_id, body)
|
514
350
|
lock_user_with_http_info(user_id, account_id, body)
|
@@ -516,10 +352,10 @@ module DocuSign_Rooms
|
|
516
352
|
end
|
517
353
|
|
518
354
|
# Locks the account of the user.
|
519
|
-
#
|
355
|
+
# Locks the account of the user.
|
520
356
|
# @param user_id User Id of the user attempting to be locked.
|
521
|
-
# @param account_id
|
522
|
-
# @param body
|
357
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
358
|
+
# @param body Details containing the reason the user is being locked out (optional parameter)
|
523
359
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
524
360
|
def lock_user_with_http_info(user_id, account_id, body)
|
525
361
|
if @api_client.config.debugging
|
@@ -538,7 +374,7 @@ module DocuSign_Rooms
|
|
538
374
|
# header parameters
|
539
375
|
header_params = {}
|
540
376
|
# HTTP header 'Accept' (if needed)
|
541
|
-
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'])
|
542
378
|
# HTTP header 'Content-Type'
|
543
379
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
544
380
|
|
@@ -561,9 +397,9 @@ module DocuSign_Rooms
|
|
561
397
|
end
|
562
398
|
|
563
399
|
# Reinvites the pending user with the given userId.
|
564
|
-
#
|
565
|
-
# @param user_id
|
566
|
-
# @param account_id
|
400
|
+
# Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.
|
401
|
+
# @param user_id ID of the user to be invited
|
402
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
567
403
|
# @return [nil]
|
568
404
|
def reinvite_user(user_id, account_id)
|
569
405
|
reinvite_user_with_http_info(user_id, account_id)
|
@@ -571,9 +407,9 @@ module DocuSign_Rooms
|
|
571
407
|
end
|
572
408
|
|
573
409
|
# Reinvites the pending user with the given userId.
|
574
|
-
#
|
575
|
-
# @param user_id
|
576
|
-
# @param account_id
|
410
|
+
# Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.
|
411
|
+
# @param user_id ID of the user to be invited
|
412
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
577
413
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
578
414
|
def reinvite_user_with_http_info(user_id, account_id)
|
579
415
|
if @api_client.config.debugging
|
@@ -592,7 +428,9 @@ module DocuSign_Rooms
|
|
592
428
|
# header parameters
|
593
429
|
header_params = {}
|
594
430
|
# HTTP header 'Accept' (if needed)
|
595
|
-
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'])
|
432
|
+
# HTTP header 'Content-Type'
|
433
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
596
434
|
|
597
435
|
# form parameters
|
598
436
|
form_params = {}
|
@@ -615,7 +453,7 @@ module DocuSign_Rooms
|
|
615
453
|
# Removes a user from the company.
|
616
454
|
# Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.
|
617
455
|
# @param user_id Id of the user you wish to remove.
|
618
|
-
# @param account_id
|
456
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
619
457
|
# @return [nil]
|
620
458
|
def remove_user(user_id, account_id)
|
621
459
|
remove_user_with_http_info(user_id, account_id)
|
@@ -625,7 +463,7 @@ module DocuSign_Rooms
|
|
625
463
|
# Removes a user from the company.
|
626
464
|
# Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.
|
627
465
|
# @param user_id Id of the user you wish to remove.
|
628
|
-
# @param account_id
|
466
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
629
467
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
630
468
|
def remove_user_with_http_info(user_id, account_id)
|
631
469
|
if @api_client.config.debugging
|
@@ -644,7 +482,9 @@ module DocuSign_Rooms
|
|
644
482
|
# header parameters
|
645
483
|
header_params = {}
|
646
484
|
# HTTP header 'Accept' (if needed)
|
647
|
-
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'])
|
486
|
+
# HTTP header 'Content-Type'
|
487
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
648
488
|
|
649
489
|
# form parameters
|
650
490
|
form_params = {}
|
@@ -665,10 +505,10 @@ module DocuSign_Rooms
|
|
665
505
|
end
|
666
506
|
|
667
507
|
# Removes the user from the designated office.
|
668
|
-
#
|
669
|
-
# @param user_id
|
670
|
-
# @param account_id
|
671
|
-
# @param body
|
508
|
+
# Removes the user from the designated office.
|
509
|
+
# @param user_id The id of the user.
|
510
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
511
|
+
# @param body Details of the office that the user will be removed from (optional parameter)
|
672
512
|
# @return [nil]
|
673
513
|
def remove_user_from_office(user_id, account_id, body)
|
674
514
|
remove_user_from_office_with_http_info(user_id, account_id, body)
|
@@ -676,10 +516,10 @@ module DocuSign_Rooms
|
|
676
516
|
end
|
677
517
|
|
678
518
|
# Removes the user from the designated office.
|
679
|
-
#
|
680
|
-
# @param user_id
|
681
|
-
# @param account_id
|
682
|
-
# @param body
|
519
|
+
# Removes the user from the designated office.
|
520
|
+
# @param user_id The id of the user.
|
521
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
522
|
+
# @param body Details of the office that the user will be removed from (optional parameter)
|
683
523
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
684
524
|
def remove_user_from_office_with_http_info(user_id, account_id, body)
|
685
525
|
if @api_client.config.debugging
|
@@ -698,9 +538,9 @@ module DocuSign_Rooms
|
|
698
538
|
# header parameters
|
699
539
|
header_params = {}
|
700
540
|
# HTTP header 'Accept' (if needed)
|
701
|
-
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'])
|
702
542
|
# HTTP header 'Content-Type'
|
703
|
-
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'])
|
704
544
|
|
705
545
|
# form parameters
|
706
546
|
form_params = {}
|
@@ -721,10 +561,10 @@ module DocuSign_Rooms
|
|
721
561
|
end
|
722
562
|
|
723
563
|
# Removes the user from the designated region.
|
724
|
-
#
|
725
|
-
# @param user_id
|
726
|
-
# @param account_id
|
727
|
-
# @param body
|
564
|
+
# Removes the user from the designated region.
|
565
|
+
# @param user_id The id of the user.
|
566
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
567
|
+
# @param body Region that given user will be removed from (optional parameter)
|
728
568
|
# @return [nil]
|
729
569
|
def remove_user_from_region(user_id, account_id, body)
|
730
570
|
remove_user_from_region_with_http_info(user_id, account_id, body)
|
@@ -732,10 +572,10 @@ module DocuSign_Rooms
|
|
732
572
|
end
|
733
573
|
|
734
574
|
# Removes the user from the designated region.
|
735
|
-
#
|
736
|
-
# @param user_id
|
737
|
-
# @param account_id
|
738
|
-
# @param body
|
575
|
+
# Removes the user from the designated region.
|
576
|
+
# @param user_id The id of the user.
|
577
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
578
|
+
# @param body Region that given user will be removed from (optional parameter)
|
739
579
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
740
580
|
def remove_user_from_region_with_http_info(user_id, account_id, body)
|
741
581
|
if @api_client.config.debugging
|
@@ -754,9 +594,9 @@ module DocuSign_Rooms
|
|
754
594
|
# header parameters
|
755
595
|
header_params = {}
|
756
596
|
# HTTP header 'Accept' (if needed)
|
757
|
-
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'])
|
758
598
|
# HTTP header 'Content-Type'
|
759
|
-
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'])
|
760
600
|
|
761
601
|
# form parameters
|
762
602
|
form_params = {}
|
@@ -777,9 +617,9 @@ module DocuSign_Rooms
|
|
777
617
|
end
|
778
618
|
|
779
619
|
# Unlocks the account of the user.
|
780
|
-
#
|
620
|
+
# Unlocks the account of the user.
|
781
621
|
# @param user_id User Id of the user attempting to be unlocked.
|
782
|
-
# @param account_id
|
622
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
783
623
|
# @return [nil]
|
784
624
|
def unlock_user(user_id, account_id)
|
785
625
|
unlock_user_with_http_info(user_id, account_id)
|
@@ -787,9 +627,9 @@ module DocuSign_Rooms
|
|
787
627
|
end
|
788
628
|
|
789
629
|
# Unlocks the account of the user.
|
790
|
-
#
|
630
|
+
# Unlocks the account of the user.
|
791
631
|
# @param user_id User Id of the user attempting to be unlocked.
|
792
|
-
# @param account_id
|
632
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
793
633
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
794
634
|
def unlock_user_with_http_info(user_id, account_id)
|
795
635
|
if @api_client.config.debugging
|
@@ -808,7 +648,9 @@ module DocuSign_Rooms
|
|
808
648
|
# header parameters
|
809
649
|
header_params = {}
|
810
650
|
# HTTP header 'Accept' (if needed)
|
811
|
-
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'])
|
652
|
+
# HTTP header 'Content-Type'
|
653
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
812
654
|
|
813
655
|
# form parameters
|
814
656
|
form_params = {}
|
@@ -829,10 +671,10 @@ module DocuSign_Rooms
|
|
829
671
|
end
|
830
672
|
|
831
673
|
# Updates user information
|
832
|
-
#
|
833
|
-
# @param user_id
|
834
|
-
# @param account_id
|
835
|
-
# @param body
|
674
|
+
# Updates user information
|
675
|
+
# @param user_id The id of the user.
|
676
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
677
|
+
# @param body Request body to update the user (optional parameter)
|
836
678
|
# @return [User]
|
837
679
|
def update_user(user_id, account_id, body)
|
838
680
|
data, _status_code, _headers = update_user_with_http_info(user_id, account_id, body)
|
@@ -840,10 +682,10 @@ module DocuSign_Rooms
|
|
840
682
|
end
|
841
683
|
|
842
684
|
# Updates user information
|
843
|
-
#
|
844
|
-
# @param user_id
|
845
|
-
# @param account_id
|
846
|
-
# @param body
|
685
|
+
# Updates user information
|
686
|
+
# @param user_id The id of the user.
|
687
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
688
|
+
# @param body Request body to update the user (optional parameter)
|
847
689
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
848
690
|
def update_user_with_http_info(user_id, account_id, body)
|
849
691
|
if @api_client.config.debugging
|
@@ -862,9 +704,9 @@ module DocuSign_Rooms
|
|
862
704
|
# header parameters
|
863
705
|
header_params = {}
|
864
706
|
# HTTP header 'Accept' (if needed)
|
865
|
-
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'])
|
866
708
|
# HTTP header 'Content-Type'
|
867
|
-
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'])
|
868
710
|
|
869
711
|
# form parameters
|
870
712
|
form_params = {}
|