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
@@ -40,9 +40,9 @@ module DocuSign_Rooms
|
|
40
40
|
end
|
41
41
|
|
42
42
|
# Create an office.
|
43
|
-
#
|
44
|
-
# @param account_id
|
45
|
-
# @param body
|
43
|
+
# Create an office.
|
44
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
45
|
+
# @param body Creates an office with given name and other details like Region,Address (optional parameter)
|
46
46
|
# @return [Office]
|
47
47
|
def create_office(account_id, body)
|
48
48
|
data, _status_code, _headers = create_office_with_http_info(account_id, body)
|
@@ -50,9 +50,9 @@ module DocuSign_Rooms
|
|
50
50
|
end
|
51
51
|
|
52
52
|
# Create an office.
|
53
|
-
#
|
54
|
-
# @param account_id
|
55
|
-
# @param body
|
53
|
+
# Create an office.
|
54
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
55
|
+
# @param body Creates an office with given name and other details like Region,Address (optional parameter)
|
56
56
|
# @return [Array<(Office, Fixnum, Hash)>] Office data, response status code and response headers
|
57
57
|
def create_office_with_http_info(account_id, body)
|
58
58
|
if @api_client.config.debugging
|
@@ -69,9 +69,9 @@ module DocuSign_Rooms
|
|
69
69
|
# header parameters
|
70
70
|
header_params = {}
|
71
71
|
# HTTP header 'Accept' (if needed)
|
72
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
73
73
|
# HTTP header 'Content-Type'
|
74
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
74
|
+
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'])
|
75
75
|
|
76
76
|
# form parameters
|
77
77
|
form_params = {}
|
@@ -93,9 +93,9 @@ module DocuSign_Rooms
|
|
93
93
|
end
|
94
94
|
|
95
95
|
# Delete an office.
|
96
|
-
#
|
97
|
-
# @param office_id
|
98
|
-
# @param account_id
|
96
|
+
# This method deletes an office from a Rooms account.
|
97
|
+
# @param office_id Office ID to be deleted
|
98
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
99
99
|
# @return [nil]
|
100
100
|
def delete_office(office_id, account_id)
|
101
101
|
delete_office_with_http_info(office_id, account_id)
|
@@ -103,9 +103,9 @@ module DocuSign_Rooms
|
|
103
103
|
end
|
104
104
|
|
105
105
|
# Delete an office.
|
106
|
-
#
|
107
|
-
# @param office_id
|
108
|
-
# @param account_id
|
106
|
+
# This method deletes an office from a Rooms account.
|
107
|
+
# @param office_id Office ID to be deleted
|
108
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
109
109
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
110
110
|
def delete_office_with_http_info(office_id, account_id)
|
111
111
|
if @api_client.config.debugging
|
@@ -124,7 +124,9 @@ module DocuSign_Rooms
|
|
124
124
|
# header parameters
|
125
125
|
header_params = {}
|
126
126
|
# HTTP header 'Accept' (if needed)
|
127
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
127
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
128
|
+
# HTTP header 'Content-Type'
|
129
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
128
130
|
|
129
131
|
# form parameters
|
130
132
|
form_params = {}
|
@@ -145,9 +147,9 @@ module DocuSign_Rooms
|
|
145
147
|
end
|
146
148
|
|
147
149
|
# Get information about the office with the given officeId.
|
148
|
-
#
|
149
|
-
# @param office_id
|
150
|
-
# @param account_id
|
150
|
+
# Get information about the office with the given officeId.
|
151
|
+
# @param office_id The id of the office.
|
152
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
151
153
|
# @return [Office]
|
152
154
|
def get_office(office_id, account_id)
|
153
155
|
data, _status_code, _headers = get_office_with_http_info(office_id, account_id)
|
@@ -155,9 +157,9 @@ module DocuSign_Rooms
|
|
155
157
|
end
|
156
158
|
|
157
159
|
# Get information about the office with the given officeId.
|
158
|
-
#
|
159
|
-
# @param office_id
|
160
|
-
# @param account_id
|
160
|
+
# Get information about the office with the given officeId.
|
161
|
+
# @param office_id The id of the office.
|
162
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
161
163
|
# @return [Array<(Office, Fixnum, Hash)>] Office data, response status code and response headers
|
162
164
|
def get_office_with_http_info(office_id, account_id)
|
163
165
|
if @api_client.config.debugging
|
@@ -176,7 +178,9 @@ module DocuSign_Rooms
|
|
176
178
|
# header parameters
|
177
179
|
header_params = {}
|
178
180
|
# HTTP header 'Accept' (if needed)
|
179
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
181
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
182
|
+
# HTTP header 'Content-Type'
|
183
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
180
184
|
|
181
185
|
# form parameters
|
182
186
|
form_params = {}
|
@@ -197,9 +201,9 @@ module DocuSign_Rooms
|
|
197
201
|
return data, status_code, headers
|
198
202
|
end
|
199
203
|
|
200
|
-
# Get all
|
201
|
-
#
|
202
|
-
# @param account_id
|
204
|
+
# Get all offices.
|
205
|
+
# This method returns a list of offices associated with an account.
|
206
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
203
207
|
# @param DocuSign_Rooms::GetOfficesOptions Options for modifying the behavior of the function.
|
204
208
|
# @return [OfficeSummaryList]
|
205
209
|
def get_offices(account_id, options = DocuSign_Rooms::GetOfficesOptions.default)
|
@@ -207,9 +211,9 @@ module DocuSign_Rooms
|
|
207
211
|
return data
|
208
212
|
end
|
209
213
|
|
210
|
-
# Get all
|
211
|
-
#
|
212
|
-
# @param account_id
|
214
|
+
# Get all offices.
|
215
|
+
# This method returns a list of offices associated with an account.
|
216
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
213
217
|
# @param DocuSign_Rooms::GetOfficesOptions Options for modifying the behavior of the function.
|
214
218
|
# @return [Array<(OfficeSummaryList, Fixnum, Hash)>] OfficeSummaryList data, response status code and response headers
|
215
219
|
def get_offices_with_http_info(account_id, options = DocuSign_Rooms::GetOfficesOptions.default)
|
@@ -231,7 +235,9 @@ module DocuSign_Rooms
|
|
231
235
|
# header parameters
|
232
236
|
header_params = {}
|
233
237
|
# HTTP header 'Accept' (if needed)
|
234
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
238
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
239
|
+
# HTTP header 'Content-Type'
|
240
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
235
241
|
|
236
242
|
# form parameters
|
237
243
|
form_params = {}
|
@@ -253,9 +259,9 @@ module DocuSign_Rooms
|
|
253
259
|
end
|
254
260
|
|
255
261
|
# Lists the number of objects of each type that reference the office.
|
256
|
-
#
|
257
|
-
# @param office_id
|
258
|
-
# @param account_id
|
262
|
+
# This method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be deleted while existing objects reference it.
|
263
|
+
# @param office_id ID of the office
|
264
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
259
265
|
# @return [OfficeReferenceCountList]
|
260
266
|
def get_reference_counts(office_id, account_id)
|
261
267
|
data, _status_code, _headers = get_reference_counts_with_http_info(office_id, account_id)
|
@@ -263,9 +269,9 @@ module DocuSign_Rooms
|
|
263
269
|
end
|
264
270
|
|
265
271
|
# Lists the number of objects of each type that reference the office.
|
266
|
-
#
|
267
|
-
# @param office_id
|
268
|
-
# @param account_id
|
272
|
+
# This method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be deleted while existing objects reference it.
|
273
|
+
# @param office_id ID of the office
|
274
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
269
275
|
# @return [Array<(OfficeReferenceCountList, Fixnum, Hash)>] OfficeReferenceCountList data, response status code and response headers
|
270
276
|
def get_reference_counts_with_http_info(office_id, account_id)
|
271
277
|
if @api_client.config.debugging
|
@@ -284,7 +290,9 @@ module DocuSign_Rooms
|
|
284
290
|
# header parameters
|
285
291
|
header_params = {}
|
286
292
|
# HTTP header 'Accept' (if needed)
|
287
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
293
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
294
|
+
# HTTP header 'Content-Type'
|
295
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
288
296
|
|
289
297
|
# form parameters
|
290
298
|
form_params = {}
|
@@ -22,7 +22,7 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Retrieves the list of valid origins of leads.
|
25
|
-
#
|
25
|
+
# Returns a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms.
|
26
26
|
# @return [GlobalOriginsOfLeads]
|
27
27
|
def get_origins_of_leads()
|
28
28
|
data, _status_code, _headers = get_origins_of_leads_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid origins of leads.
|
33
|
-
#
|
33
|
+
# Returns a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms.
|
34
34
|
# @return [Array<(GlobalOriginsOfLeads, Fixnum, Hash)>] GlobalOriginsOfLeads data, response status code and response headers
|
35
35
|
def get_origins_of_leads_with_http_info()
|
36
36
|
if @api_client.config.debugging
|
@@ -45,7 +45,9 @@ module DocuSign_Rooms
|
|
45
45
|
# header parameters
|
46
46
|
header_params = {}
|
47
47
|
# HTTP header 'Accept' (if needed)
|
48
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
49
|
+
# HTTP header 'Content-Type'
|
50
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
49
51
|
|
50
52
|
# form parameters
|
51
53
|
form_params = {}
|
@@ -22,7 +22,7 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Retrieves the list of valid property types.
|
25
|
-
#
|
25
|
+
# Returns a list of property types.
|
26
26
|
# @return [GlobalPropertyTypes]
|
27
27
|
def get_property_types()
|
28
28
|
data, _status_code, _headers = get_property_types_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid property types.
|
33
|
-
#
|
33
|
+
# Returns a list of property types.
|
34
34
|
# @return [Array<(GlobalPropertyTypes, Fixnum, Hash)>] GlobalPropertyTypes data, response status code and response headers
|
35
35
|
def get_property_types_with_http_info()
|
36
36
|
if @api_client.config.debugging
|
@@ -45,7 +45,9 @@ module DocuSign_Rooms
|
|
45
45
|
# header parameters
|
46
46
|
header_params = {}
|
47
47
|
# HTTP header 'Accept' (if needed)
|
48
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
49
|
+
# HTTP header 'Content-Type'
|
50
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
49
51
|
|
50
52
|
# form parameters
|
51
53
|
form_params = {}
|
@@ -37,9 +37,9 @@ module DocuSign_Rooms
|
|
37
37
|
end
|
38
38
|
|
39
39
|
# Creates a new region for a company
|
40
|
-
#
|
41
|
-
# @param account_id
|
42
|
-
# @param body
|
40
|
+
# Creates a new region for a company
|
41
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
42
|
+
# @param body The information required to create a new region for the caller's company (optional parameter)
|
43
43
|
# @return [Region]
|
44
44
|
def create_region(account_id, body)
|
45
45
|
data, _status_code, _headers = create_region_with_http_info(account_id, body)
|
@@ -47,9 +47,9 @@ module DocuSign_Rooms
|
|
47
47
|
end
|
48
48
|
|
49
49
|
# Creates a new region for a company
|
50
|
-
#
|
51
|
-
# @param account_id
|
52
|
-
# @param body
|
50
|
+
# Creates a new region for a company
|
51
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
52
|
+
# @param body The information required to create a new region for the caller's company (optional parameter)
|
53
53
|
# @return [Array<(Region, Fixnum, Hash)>] Region data, response status code and response headers
|
54
54
|
def create_region_with_http_info(account_id, body)
|
55
55
|
if @api_client.config.debugging
|
@@ -66,9 +66,9 @@ module DocuSign_Rooms
|
|
66
66
|
# header parameters
|
67
67
|
header_params = {}
|
68
68
|
# HTTP header 'Accept' (if needed)
|
69
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
69
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
70
70
|
# HTTP header 'Content-Type'
|
71
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
71
|
+
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'])
|
72
72
|
|
73
73
|
# form parameters
|
74
74
|
form_params = {}
|
@@ -90,9 +90,9 @@ module DocuSign_Rooms
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Delete a region.
|
93
|
-
#
|
93
|
+
# Delete a region.
|
94
94
|
# @param region_id Id of the desired region
|
95
|
-
# @param account_id
|
95
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
96
96
|
# @return [nil]
|
97
97
|
def delete_region(region_id, account_id)
|
98
98
|
delete_region_with_http_info(region_id, account_id)
|
@@ -100,9 +100,9 @@ module DocuSign_Rooms
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Delete a region.
|
103
|
-
#
|
103
|
+
# Delete a region.
|
104
104
|
# @param region_id Id of the desired region
|
105
|
-
# @param account_id
|
105
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
106
106
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
107
107
|
def delete_region_with_http_info(region_id, account_id)
|
108
108
|
if @api_client.config.debugging
|
@@ -121,7 +121,9 @@ module DocuSign_Rooms
|
|
121
121
|
# header parameters
|
122
122
|
header_params = {}
|
123
123
|
# HTTP header 'Accept' (if needed)
|
124
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
125
|
+
# HTTP header 'Content-Type'
|
126
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
125
127
|
|
126
128
|
# form parameters
|
127
129
|
form_params = {}
|
@@ -142,9 +144,9 @@ module DocuSign_Rooms
|
|
142
144
|
end
|
143
145
|
|
144
146
|
# Get information about the region with the given regionId
|
145
|
-
#
|
147
|
+
# Get information about the region with the given regionId
|
146
148
|
# @param region_id Id of the desired region
|
147
|
-
# @param account_id
|
149
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
148
150
|
# @return [Region]
|
149
151
|
def get_region(region_id, account_id)
|
150
152
|
data, _status_code, _headers = get_region_with_http_info(region_id, account_id)
|
@@ -152,9 +154,9 @@ module DocuSign_Rooms
|
|
152
154
|
end
|
153
155
|
|
154
156
|
# Get information about the region with the given regionId
|
155
|
-
#
|
157
|
+
# Get information about the region with the given regionId
|
156
158
|
# @param region_id Id of the desired region
|
157
|
-
# @param account_id
|
159
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
158
160
|
# @return [Array<(Region, Fixnum, Hash)>] Region data, response status code and response headers
|
159
161
|
def get_region_with_http_info(region_id, account_id)
|
160
162
|
if @api_client.config.debugging
|
@@ -173,7 +175,9 @@ module DocuSign_Rooms
|
|
173
175
|
# header parameters
|
174
176
|
header_params = {}
|
175
177
|
# HTTP header 'Accept' (if needed)
|
176
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
178
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
179
|
+
# HTTP header 'Content-Type'
|
180
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
177
181
|
|
178
182
|
# form parameters
|
179
183
|
form_params = {}
|
@@ -195,9 +199,9 @@ module DocuSign_Rooms
|
|
195
199
|
end
|
196
200
|
|
197
201
|
# Get region reference counts.
|
198
|
-
#
|
202
|
+
# This method returns a list of each type of object and the number of objects of that type referencing the specified region.
|
199
203
|
# @param region_id Id of the desired region
|
200
|
-
# @param account_id
|
204
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
201
205
|
# @return [RegionReferenceCountList]
|
202
206
|
def get_region_reference_counts(region_id, account_id)
|
203
207
|
data, _status_code, _headers = get_region_reference_counts_with_http_info(region_id, account_id)
|
@@ -205,9 +209,9 @@ module DocuSign_Rooms
|
|
205
209
|
end
|
206
210
|
|
207
211
|
# Get region reference counts.
|
208
|
-
#
|
212
|
+
# This method returns a list of each type of object and the number of objects of that type referencing the specified region.
|
209
213
|
# @param region_id Id of the desired region
|
210
|
-
# @param account_id
|
214
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
211
215
|
# @return [Array<(RegionReferenceCountList, Fixnum, Hash)>] RegionReferenceCountList data, response status code and response headers
|
212
216
|
def get_region_reference_counts_with_http_info(region_id, account_id)
|
213
217
|
if @api_client.config.debugging
|
@@ -226,7 +230,9 @@ module DocuSign_Rooms
|
|
226
230
|
# header parameters
|
227
231
|
header_params = {}
|
228
232
|
# HTTP header 'Accept' (if needed)
|
229
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
233
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
234
|
+
# HTTP header 'Content-Type'
|
235
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
230
236
|
|
231
237
|
# form parameters
|
232
238
|
form_params = {}
|
@@ -247,9 +253,9 @@ module DocuSign_Rooms
|
|
247
253
|
return data, status_code, headers
|
248
254
|
end
|
249
255
|
|
250
|
-
# Get account
|
251
|
-
#
|
252
|
-
# @param account_id
|
256
|
+
# Get account regions.
|
257
|
+
# Returns a list of regions that are associated with a Rooms account.
|
258
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
253
259
|
# @param DocuSign_Rooms::GetRegionsOptions Options for modifying the behavior of the function.
|
254
260
|
# @return [RegionSummaryList]
|
255
261
|
def get_regions(account_id, options = DocuSign_Rooms::GetRegionsOptions.default)
|
@@ -257,9 +263,9 @@ module DocuSign_Rooms
|
|
257
263
|
return data
|
258
264
|
end
|
259
265
|
|
260
|
-
# Get account
|
261
|
-
#
|
262
|
-
# @param account_id
|
266
|
+
# Get account regions.
|
267
|
+
# Returns a list of regions that are associated with a Rooms account.
|
268
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
263
269
|
# @param DocuSign_Rooms::GetRegionsOptions Options for modifying the behavior of the function.
|
264
270
|
# @return [Array<(RegionSummaryList, Fixnum, Hash)>] RegionSummaryList data, response status code and response headers
|
265
271
|
def get_regions_with_http_info(account_id, options = DocuSign_Rooms::GetRegionsOptions.default)
|
@@ -280,7 +286,9 @@ module DocuSign_Rooms
|
|
280
286
|
# header parameters
|
281
287
|
header_params = {}
|
282
288
|
# HTTP header 'Accept' (if needed)
|
283
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
289
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
290
|
+
# HTTP header 'Content-Type'
|
291
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
284
292
|
|
285
293
|
# form parameters
|
286
294
|
form_params = {}
|
@@ -14,7 +14,7 @@ require "uri"
|
|
14
14
|
module DocuSign_Rooms
|
15
15
|
|
16
16
|
class GetRoleOptions
|
17
|
-
#
|
17
|
+
# When set to true, the response includes the `isAssigned` property, which specifies whether the role is currently assigned to any users. The default is false.
|
18
18
|
attr_accessor :include_is_assigned
|
19
19
|
|
20
20
|
def self.default
|
@@ -23,16 +23,19 @@ module DocuSign_Rooms
|
|
23
23
|
end
|
24
24
|
|
25
25
|
class GetRolesOptions
|
26
|
-
#
|
26
|
+
# Returns assignable roles based on calling user's company permissions. DEPRECATED: Please use filterContext parameter to get the assignable roles. AssignableRolesBasedOnCompanyPermissions returns same results as onlyAssignable=true
|
27
27
|
attr_accessor :only_assignable
|
28
28
|
|
29
|
-
#
|
29
|
+
# Attribute establishing filter context for roles being returned - AllRoles, AssignableRolesBasedOnCompanyPermissions, AssignableRolesBasedOnAllPermissions
|
30
|
+
attr_accessor :filter_context
|
31
|
+
|
32
|
+
# A search filter that returns roles by the beginning of the role name. You can enter the beginning of the role name only to return all of the roles that begin with the text that you entered.
|
30
33
|
attr_accessor :filter
|
31
34
|
|
32
|
-
#
|
35
|
+
# The starting zero-based index position of the result set. The default value is 0.
|
33
36
|
attr_accessor :start_position
|
34
37
|
|
35
|
-
#
|
38
|
+
# The number of results to return. This value must be a number between `1` and `100` (default).
|
36
39
|
attr_accessor :count
|
37
40
|
|
38
41
|
def self.default
|
@@ -49,9 +52,9 @@ module DocuSign_Rooms
|
|
49
52
|
end
|
50
53
|
|
51
54
|
# Creates a role.
|
52
|
-
#
|
53
|
-
# @param account_id
|
54
|
-
# @param body
|
55
|
+
# Creates a new company role in Rooms
|
56
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
57
|
+
# @param body Name and permission details of the role to be created (optional parameter)
|
55
58
|
# @return [Role]
|
56
59
|
def create_role(account_id, body)
|
57
60
|
data, _status_code, _headers = create_role_with_http_info(account_id, body)
|
@@ -59,9 +62,9 @@ module DocuSign_Rooms
|
|
59
62
|
end
|
60
63
|
|
61
64
|
# Creates a role.
|
62
|
-
#
|
63
|
-
# @param account_id
|
64
|
-
# @param body
|
65
|
+
# Creates a new company role in Rooms
|
66
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
67
|
+
# @param body Name and permission details of the role to be created (optional parameter)
|
65
68
|
# @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
|
66
69
|
def create_role_with_http_info(account_id, body)
|
67
70
|
if @api_client.config.debugging
|
@@ -78,9 +81,9 @@ module DocuSign_Rooms
|
|
78
81
|
# header parameters
|
79
82
|
header_params = {}
|
80
83
|
# HTTP header 'Accept' (if needed)
|
81
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
84
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
82
85
|
# HTTP header 'Content-Type'
|
83
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
86
|
+
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'])
|
84
87
|
|
85
88
|
# form parameters
|
86
89
|
form_params = {}
|
@@ -102,9 +105,9 @@ module DocuSign_Rooms
|
|
102
105
|
end
|
103
106
|
|
104
107
|
# Deletes the role with the given roleId.
|
105
|
-
#
|
106
|
-
# @param role_id
|
107
|
-
# @param account_id
|
108
|
+
# Deletes a role from a company account in Rooms
|
109
|
+
# @param role_id The id of the role.
|
110
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
108
111
|
# @return [nil]
|
109
112
|
def delete_role(role_id, account_id)
|
110
113
|
delete_role_with_http_info(role_id, account_id)
|
@@ -112,9 +115,9 @@ module DocuSign_Rooms
|
|
112
115
|
end
|
113
116
|
|
114
117
|
# Deletes the role with the given roleId.
|
115
|
-
#
|
116
|
-
# @param role_id
|
117
|
-
# @param account_id
|
118
|
+
# Deletes a role from a company account in Rooms
|
119
|
+
# @param role_id The id of the role.
|
120
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
118
121
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
119
122
|
def delete_role_with_http_info(role_id, account_id)
|
120
123
|
if @api_client.config.debugging
|
@@ -133,7 +136,9 @@ module DocuSign_Rooms
|
|
133
136
|
# header parameters
|
134
137
|
header_params = {}
|
135
138
|
# HTTP header 'Accept' (if needed)
|
136
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
139
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
140
|
+
# HTTP header 'Content-Type'
|
141
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
137
142
|
|
138
143
|
# form parameters
|
139
144
|
form_params = {}
|
@@ -154,9 +159,9 @@ module DocuSign_Rooms
|
|
154
159
|
end
|
155
160
|
|
156
161
|
# Get information about the role with the given roleId.
|
157
|
-
#
|
158
|
-
# @param role_id
|
159
|
-
# @param account_id
|
162
|
+
# Get information about the role with the given roleId.
|
163
|
+
# @param role_id The id of the role.
|
164
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
160
165
|
# @param DocuSign_Rooms::GetRoleOptions Options for modifying the behavior of the function.
|
161
166
|
# @return [Role]
|
162
167
|
def get_role(role_id, account_id, options = DocuSign_Rooms::GetRoleOptions.default)
|
@@ -165,9 +170,9 @@ module DocuSign_Rooms
|
|
165
170
|
end
|
166
171
|
|
167
172
|
# Get information about the role with the given roleId.
|
168
|
-
#
|
169
|
-
# @param role_id
|
170
|
-
# @param account_id
|
173
|
+
# Get information about the role with the given roleId.
|
174
|
+
# @param role_id The id of the role.
|
175
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
171
176
|
# @param DocuSign_Rooms::GetRoleOptions Options for modifying the behavior of the function.
|
172
177
|
# @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
|
173
178
|
def get_role_with_http_info(role_id, account_id, options = DocuSign_Rooms::GetRoleOptions.default)
|
@@ -188,7 +193,9 @@ module DocuSign_Rooms
|
|
188
193
|
# header parameters
|
189
194
|
header_params = {}
|
190
195
|
# HTTP header 'Accept' (if needed)
|
191
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
197
|
+
# HTTP header 'Content-Type'
|
198
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
192
199
|
|
193
200
|
# form parameters
|
194
201
|
form_params = {}
|
@@ -210,8 +217,8 @@ module DocuSign_Rooms
|
|
210
217
|
end
|
211
218
|
|
212
219
|
# Gets a paged-list of roles in your company
|
213
|
-
#
|
214
|
-
# @param account_id
|
220
|
+
# Returns a list of roles associated with a company account
|
221
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
215
222
|
# @param DocuSign_Rooms::GetRolesOptions Options for modifying the behavior of the function.
|
216
223
|
# @return [RoleSummaryList]
|
217
224
|
def get_roles(account_id, options = DocuSign_Rooms::GetRolesOptions.default)
|
@@ -220,8 +227,8 @@ module DocuSign_Rooms
|
|
220
227
|
end
|
221
228
|
|
222
229
|
# Gets a paged-list of roles in your company
|
223
|
-
#
|
224
|
-
# @param account_id
|
230
|
+
# Returns a list of roles associated with a company account
|
231
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
225
232
|
# @param DocuSign_Rooms::GetRolesOptions Options for modifying the behavior of the function.
|
226
233
|
# @return [Array<(RoleSummaryList, Fixnum, Hash)>] RoleSummaryList data, response status code and response headers
|
227
234
|
def get_roles_with_http_info(account_id, options = DocuSign_Rooms::GetRolesOptions.default)
|
@@ -236,6 +243,7 @@ module DocuSign_Rooms
|
|
236
243
|
# query parameters
|
237
244
|
query_params = {}
|
238
245
|
query_params[:'onlyAssignable'] = options.only_assignable if !options.only_assignable.nil?
|
246
|
+
query_params[:'filterContext'] = options.filter_context if !options.filter_context.nil?
|
239
247
|
query_params[:'filter'] = options.filter if !options.filter.nil?
|
240
248
|
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
241
249
|
query_params[:'count'] = options.count if !options.count.nil?
|
@@ -243,7 +251,9 @@ module DocuSign_Rooms
|
|
243
251
|
# header parameters
|
244
252
|
header_params = {}
|
245
253
|
# HTTP header 'Accept' (if needed)
|
246
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
254
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
255
|
+
# HTTP header 'Content-Type'
|
256
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
247
257
|
|
248
258
|
# form parameters
|
249
259
|
form_params = {}
|
@@ -265,10 +275,10 @@ module DocuSign_Rooms
|
|
265
275
|
end
|
266
276
|
|
267
277
|
# Updates the role with the given roleId.
|
268
|
-
#
|
269
|
-
# @param role_id
|
270
|
-
# @param account_id
|
271
|
-
# @param body
|
278
|
+
# Updates the role with the given roleId.
|
279
|
+
# @param role_id The id of the role.
|
280
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
281
|
+
# @param body Name and permission details of the role to be updated (optional parameter)
|
272
282
|
# @return [Role]
|
273
283
|
def update_role(role_id, account_id, body)
|
274
284
|
data, _status_code, _headers = update_role_with_http_info(role_id, account_id, body)
|
@@ -276,10 +286,10 @@ module DocuSign_Rooms
|
|
276
286
|
end
|
277
287
|
|
278
288
|
# Updates the role with the given roleId.
|
279
|
-
#
|
280
|
-
# @param role_id
|
281
|
-
# @param account_id
|
282
|
-
# @param body
|
289
|
+
# Updates the role with the given roleId.
|
290
|
+
# @param role_id The id of the role.
|
291
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
292
|
+
# @param body Name and permission details of the role to be updated (optional parameter)
|
283
293
|
# @return [Array<(Role, Fixnum, Hash)>] Role data, response status code and response headers
|
284
294
|
def update_role_with_http_info(role_id, account_id, body)
|
285
295
|
if @api_client.config.debugging
|
@@ -298,9 +308,9 @@ module DocuSign_Rooms
|
|
298
308
|
# header parameters
|
299
309
|
header_params = {}
|
300
310
|
# HTTP header 'Accept' (if needed)
|
301
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
311
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
302
312
|
# HTTP header 'Content-Type'
|
303
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
313
|
+
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'])
|
304
314
|
|
305
315
|
# form parameters
|
306
316
|
form_params = {}
|