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
@@ -0,0 +1,95 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Rooms API - v2
|
3
|
+
|
4
|
+
#An API for an integrator to access the features of DocuSign Rooms
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_Rooms
|
15
|
+
|
16
|
+
class GetFormGroupFormsOptions
|
17
|
+
# Default value is 100 and max value is 100
|
18
|
+
attr_accessor :count
|
19
|
+
|
20
|
+
# Default value is 0
|
21
|
+
attr_accessor :start_position
|
22
|
+
|
23
|
+
def self.default
|
24
|
+
@@default ||= GetFormGroupFormsOptions.new
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
|
29
|
+
class FormGroupFormsApi
|
30
|
+
attr_accessor :api_client
|
31
|
+
|
32
|
+
def initialize(api_client = FormGroupFormsApi.default)
|
33
|
+
@api_client = api_client
|
34
|
+
end
|
35
|
+
|
36
|
+
# Gets the user's form group's forms.
|
37
|
+
# Get forms of the specified form group.
|
38
|
+
# @param form_group_id The ID of the form group.
|
39
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
40
|
+
# @param DocuSign_Rooms::GetFormGroupFormsOptions Options for modifying the behavior of the function.
|
41
|
+
# @return [FormGroupFormList]
|
42
|
+
def get_form_group_forms(form_group_id, account_id, options = DocuSign_Rooms::GetFormGroupFormsOptions.default)
|
43
|
+
data, _status_code, _headers = get_form_group_forms_with_http_info(form_group_id, account_id, options)
|
44
|
+
return data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Gets the user's form group's forms.
|
48
|
+
# Get forms of the specified form group.
|
49
|
+
# @param form_group_id The ID of the form group.
|
50
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
51
|
+
# @param DocuSign_Rooms::GetFormGroupFormsOptions Options for modifying the behavior of the function.
|
52
|
+
# @return [Array<(FormGroupFormList, Fixnum, Hash)>] FormGroupFormList data, response status code and response headers
|
53
|
+
def get_form_group_forms_with_http_info(form_group_id, account_id, options = DocuSign_Rooms::GetFormGroupFormsOptions.default)
|
54
|
+
if @api_client.config.debugging
|
55
|
+
@api_client.config.logger.debug "Calling API: FormGroupFormsApi.get_form_group_forms ..."
|
56
|
+
end
|
57
|
+
# verify the required parameter 'form_group_id' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'form_group_id' when calling FormGroupFormsApi.get_form_group_forms" if form_group_id.nil?
|
59
|
+
# verify the required parameter 'account_id' is set
|
60
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FormGroupFormsApi.get_form_group_forms" if account_id.nil?
|
61
|
+
# resource path
|
62
|
+
local_var_path = "/v2/accounts/{accountId}/form_groups/{formGroupId}/forms".sub('{format}','json').sub('{' + 'formGroupId' + '}', form_group_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
63
|
+
|
64
|
+
# query parameters
|
65
|
+
query_params = {}
|
66
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
67
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
68
|
+
|
69
|
+
# header parameters
|
70
|
+
header_params = {}
|
71
|
+
# HTTP header 'Accept' (if needed)
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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'])
|
75
|
+
|
76
|
+
# form parameters
|
77
|
+
form_params = {}
|
78
|
+
|
79
|
+
# http body (model)
|
80
|
+
post_body = nil
|
81
|
+
auth_names = []
|
82
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => 'FormGroupFormList')
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: FormGroupFormsApi#get_form_group_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
@@ -34,10 +34,10 @@ module DocuSign_Rooms
|
|
34
34
|
end
|
35
35
|
|
36
36
|
# Assigns a form to a form group.
|
37
|
-
#
|
38
|
-
# @param form_group_id
|
39
|
-
# @param account_id
|
40
|
-
# @param body
|
37
|
+
# Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.
|
38
|
+
# @param form_group_id The ID of the form group.
|
39
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
40
|
+
# @param body Assigns the form specified in the `formId` property of the request to the form group `formGroupId`. (optional parameter)
|
41
41
|
# @return [FormGroupFormToAssign]
|
42
42
|
def assign_form_group_form(form_group_id, account_id, body)
|
43
43
|
data, _status_code, _headers = assign_form_group_form_with_http_info(form_group_id, account_id, body)
|
@@ -45,10 +45,10 @@ module DocuSign_Rooms
|
|
45
45
|
end
|
46
46
|
|
47
47
|
# Assigns a form to a form group.
|
48
|
-
#
|
49
|
-
# @param form_group_id
|
50
|
-
# @param account_id
|
51
|
-
# @param body
|
48
|
+
# Assigns the form specified in the `formId` property of the request to the form group `formGroupId`.
|
49
|
+
# @param form_group_id The ID of the form group.
|
50
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
51
|
+
# @param body Assigns the form specified in the `formId` property of the request to the form group `formGroupId`. (optional parameter)
|
52
52
|
# @return [Array<(FormGroupFormToAssign, Fixnum, Hash)>] FormGroupFormToAssign data, response status code and response headers
|
53
53
|
def assign_form_group_form_with_http_info(form_group_id, account_id, body)
|
54
54
|
if @api_client.config.debugging
|
@@ -67,9 +67,9 @@ module DocuSign_Rooms
|
|
67
67
|
# header parameters
|
68
68
|
header_params = {}
|
69
69
|
# HTTP header 'Accept' (if needed)
|
70
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
70
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
71
71
|
# HTTP header 'Content-Type'
|
72
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
72
|
+
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'])
|
73
73
|
|
74
74
|
# form parameters
|
75
75
|
form_params = {}
|
@@ -91,9 +91,9 @@ module DocuSign_Rooms
|
|
91
91
|
end
|
92
92
|
|
93
93
|
# Creates a form group.
|
94
|
-
#
|
95
|
-
# @param account_id
|
96
|
-
# @param body
|
94
|
+
# Creates a new form group with the name given in the `name` property of the request body.
|
95
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
96
|
+
# @param body Required input of name for the form group (optional parameter)
|
97
97
|
# @return [FormGroup]
|
98
98
|
def create_form_group(account_id, body)
|
99
99
|
data, _status_code, _headers = create_form_group_with_http_info(account_id, body)
|
@@ -101,9 +101,9 @@ module DocuSign_Rooms
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Creates a form group.
|
104
|
-
#
|
105
|
-
# @param account_id
|
106
|
-
# @param body
|
104
|
+
# Creates a new form group with the name given in the `name` property of the request body.
|
105
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
106
|
+
# @param body Required input of name for the form group (optional parameter)
|
107
107
|
# @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers
|
108
108
|
def create_form_group_with_http_info(account_id, body)
|
109
109
|
if @api_client.config.debugging
|
@@ -120,9 +120,9 @@ module DocuSign_Rooms
|
|
120
120
|
# header parameters
|
121
121
|
header_params = {}
|
122
122
|
# HTTP header 'Accept' (if needed)
|
123
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
123
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
124
124
|
# HTTP header 'Content-Type'
|
125
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
125
|
+
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'])
|
126
126
|
|
127
127
|
# form parameters
|
128
128
|
form_params = {}
|
@@ -144,9 +144,9 @@ module DocuSign_Rooms
|
|
144
144
|
end
|
145
145
|
|
146
146
|
# Deletes a form group.
|
147
|
-
#
|
148
|
-
# @param form_group_id
|
149
|
-
# @param account_id
|
147
|
+
# Deletes the specified form group.
|
148
|
+
# @param form_group_id The ID of the form group.
|
149
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
150
150
|
# @return [nil]
|
151
151
|
def delete_form_group(form_group_id, account_id)
|
152
152
|
delete_form_group_with_http_info(form_group_id, account_id)
|
@@ -154,9 +154,9 @@ module DocuSign_Rooms
|
|
154
154
|
end
|
155
155
|
|
156
156
|
# Deletes a form group.
|
157
|
-
#
|
158
|
-
# @param form_group_id
|
159
|
-
# @param account_id
|
157
|
+
# Deletes the specified form group.
|
158
|
+
# @param form_group_id The ID of the form group.
|
159
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
160
160
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
161
161
|
def delete_form_group_with_http_info(form_group_id, account_id)
|
162
162
|
if @api_client.config.debugging
|
@@ -175,7 +175,9 @@ module DocuSign_Rooms
|
|
175
175
|
# header parameters
|
176
176
|
header_params = {}
|
177
177
|
# HTTP header 'Accept' (if needed)
|
178
|
-
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'])
|
179
181
|
|
180
182
|
# form parameters
|
181
183
|
form_params = {}
|
@@ -196,9 +198,9 @@ module DocuSign_Rooms
|
|
196
198
|
end
|
197
199
|
|
198
200
|
# Gets a form group.
|
199
|
-
#
|
200
|
-
# @param form_group_id
|
201
|
-
# @param account_id
|
201
|
+
# Get the specified form group.
|
202
|
+
# @param form_group_id The ID of the form group.
|
203
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
202
204
|
# @return [FormGroup]
|
203
205
|
def get_form_group(form_group_id, account_id)
|
204
206
|
data, _status_code, _headers = get_form_group_with_http_info(form_group_id, account_id)
|
@@ -206,9 +208,9 @@ module DocuSign_Rooms
|
|
206
208
|
end
|
207
209
|
|
208
210
|
# Gets a form group.
|
209
|
-
#
|
210
|
-
# @param form_group_id
|
211
|
-
# @param account_id
|
211
|
+
# Get the specified form group.
|
212
|
+
# @param form_group_id The ID of the form group.
|
213
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
212
214
|
# @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers
|
213
215
|
def get_form_group_with_http_info(form_group_id, account_id)
|
214
216
|
if @api_client.config.debugging
|
@@ -227,7 +229,9 @@ module DocuSign_Rooms
|
|
227
229
|
# header parameters
|
228
230
|
header_params = {}
|
229
231
|
# HTTP header 'Accept' (if needed)
|
230
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
232
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
233
|
+
# HTTP header 'Content-Type'
|
234
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
231
235
|
|
232
236
|
# form parameters
|
233
237
|
form_params = {}
|
@@ -249,8 +253,8 @@ module DocuSign_Rooms
|
|
249
253
|
end
|
250
254
|
|
251
255
|
# Get account Form Groups.
|
252
|
-
#
|
253
|
-
# @param account_id
|
256
|
+
# Returns the company form groups to which the current user has access.
|
257
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
254
258
|
# @param DocuSign_Rooms::GetFormGroupsOptions Options for modifying the behavior of the function.
|
255
259
|
# @return [FormGroupSummaryList]
|
256
260
|
def get_form_groups(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default)
|
@@ -259,8 +263,8 @@ module DocuSign_Rooms
|
|
259
263
|
end
|
260
264
|
|
261
265
|
# Get account Form Groups.
|
262
|
-
#
|
263
|
-
# @param account_id
|
266
|
+
# Returns the company form groups to which the current user has access.
|
267
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
264
268
|
# @param DocuSign_Rooms::GetFormGroupsOptions Options for modifying the behavior of the function.
|
265
269
|
# @return [Array<(FormGroupSummaryList, Fixnum, Hash)>] FormGroupSummaryList data, response status code and response headers
|
266
270
|
def get_form_groups_with_http_info(account_id, options = DocuSign_Rooms::GetFormGroupsOptions.default)
|
@@ -280,7 +284,9 @@ module DocuSign_Rooms
|
|
280
284
|
# header parameters
|
281
285
|
header_params = {}
|
282
286
|
# HTTP header 'Accept' (if needed)
|
283
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
287
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
288
|
+
# HTTP header 'Content-Type'
|
289
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
284
290
|
|
285
291
|
# form parameters
|
286
292
|
form_params = {}
|
@@ -302,10 +308,10 @@ module DocuSign_Rooms
|
|
302
308
|
end
|
303
309
|
|
304
310
|
# Assign office to a form group so the specified office has access to the form group.
|
305
|
-
#
|
306
|
-
# @param form_group_id
|
307
|
-
# @param office_id
|
308
|
-
# @param account_id
|
311
|
+
# \"Grants the office `officeId` access to the form group `formGroupId`.
|
312
|
+
# @param form_group_id The ID of the form group.
|
313
|
+
# @param office_id The id of the office. This is the id that the system generated when you created the office.
|
314
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
309
315
|
# @return [nil]
|
310
316
|
def grant_office_access_to_form_group(form_group_id, office_id, account_id)
|
311
317
|
grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id)
|
@@ -313,10 +319,10 @@ module DocuSign_Rooms
|
|
313
319
|
end
|
314
320
|
|
315
321
|
# Assign office to a form group so the specified office has access to the form group.
|
316
|
-
#
|
317
|
-
# @param form_group_id
|
318
|
-
# @param office_id
|
319
|
-
# @param account_id
|
322
|
+
# \"Grants the office `officeId` access to the form group `formGroupId`.
|
323
|
+
# @param form_group_id The ID of the form group.
|
324
|
+
# @param office_id The id of the office. This is the id that the system generated when you created the office.
|
325
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
320
326
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
321
327
|
def grant_office_access_to_form_group_with_http_info(form_group_id, office_id, account_id)
|
322
328
|
if @api_client.config.debugging
|
@@ -337,7 +343,9 @@ module DocuSign_Rooms
|
|
337
343
|
# header parameters
|
338
344
|
header_params = {}
|
339
345
|
# HTTP header 'Accept' (if needed)
|
340
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
346
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
347
|
+
# HTTP header 'Content-Type'
|
348
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
341
349
|
|
342
350
|
# form parameters
|
343
351
|
form_params = {}
|
@@ -358,10 +366,10 @@ module DocuSign_Rooms
|
|
358
366
|
end
|
359
367
|
|
360
368
|
# Removes a form from a form group.
|
361
|
-
#
|
362
|
-
# @param form_group_id
|
363
|
-
# @param form_id
|
364
|
-
# @param account_id
|
369
|
+
# Removes the form `formId` from the form group `formGroupId`.
|
370
|
+
# @param form_group_id The ID of the form group.
|
371
|
+
# @param form_id The id of the form.
|
372
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
365
373
|
# @return [nil]
|
366
374
|
def remove_form_group_form(form_group_id, form_id, account_id)
|
367
375
|
remove_form_group_form_with_http_info(form_group_id, form_id, account_id)
|
@@ -369,10 +377,10 @@ module DocuSign_Rooms
|
|
369
377
|
end
|
370
378
|
|
371
379
|
# Removes a form from a form group.
|
372
|
-
#
|
373
|
-
# @param form_group_id
|
374
|
-
# @param form_id
|
375
|
-
# @param account_id
|
380
|
+
# Removes the form `formId` from the form group `formGroupId`.
|
381
|
+
# @param form_group_id The ID of the form group.
|
382
|
+
# @param form_id The id of the form.
|
383
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
376
384
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
377
385
|
def remove_form_group_form_with_http_info(form_group_id, form_id, account_id)
|
378
386
|
if @api_client.config.debugging
|
@@ -393,7 +401,9 @@ module DocuSign_Rooms
|
|
393
401
|
# header parameters
|
394
402
|
header_params = {}
|
395
403
|
# HTTP header 'Accept' (if needed)
|
396
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
404
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
405
|
+
# HTTP header 'Content-Type'
|
406
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
397
407
|
|
398
408
|
# form parameters
|
399
409
|
form_params = {}
|
@@ -414,10 +424,10 @@ module DocuSign_Rooms
|
|
414
424
|
end
|
415
425
|
|
416
426
|
# Renames a form group.
|
417
|
-
#
|
418
|
-
# @param form_group_id
|
419
|
-
# @param account_id
|
420
|
-
# @param body
|
427
|
+
# Renames the specified form group with the name given in the `name` property of the request.
|
428
|
+
# @param form_group_id The ID of the form group.
|
429
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
430
|
+
# @param body Required input of name for the form group (optional parameter)
|
421
431
|
# @return [FormGroup]
|
422
432
|
def rename_form_group(form_group_id, account_id, body)
|
423
433
|
data, _status_code, _headers = rename_form_group_with_http_info(form_group_id, account_id, body)
|
@@ -425,10 +435,10 @@ module DocuSign_Rooms
|
|
425
435
|
end
|
426
436
|
|
427
437
|
# Renames a form group.
|
428
|
-
#
|
429
|
-
# @param form_group_id
|
430
|
-
# @param account_id
|
431
|
-
# @param body
|
438
|
+
# Renames the specified form group with the name given in the `name` property of the request.
|
439
|
+
# @param form_group_id The ID of the form group.
|
440
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
441
|
+
# @param body Required input of name for the form group (optional parameter)
|
432
442
|
# @return [Array<(FormGroup, Fixnum, Hash)>] FormGroup data, response status code and response headers
|
433
443
|
def rename_form_group_with_http_info(form_group_id, account_id, body)
|
434
444
|
if @api_client.config.debugging
|
@@ -447,9 +457,9 @@ module DocuSign_Rooms
|
|
447
457
|
# header parameters
|
448
458
|
header_params = {}
|
449
459
|
# HTTP header 'Accept' (if needed)
|
450
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
460
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
451
461
|
# HTTP header 'Content-Type'
|
452
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
462
|
+
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'])
|
453
463
|
|
454
464
|
# form parameters
|
455
465
|
form_params = {}
|
@@ -471,10 +481,10 @@ module DocuSign_Rooms
|
|
471
481
|
end
|
472
482
|
|
473
483
|
# Remove office to a form group so the specified office doesn't have access to the form group.
|
474
|
-
#
|
475
|
-
# @param form_group_id
|
476
|
-
# @param office_id
|
477
|
-
# @param account_id
|
484
|
+
# Revoke access to the form group `formGroupId` from the office `officeId`.
|
485
|
+
# @param form_group_id The ID of the form group.
|
486
|
+
# @param office_id The id of the office. This is the id that the system generated when you created the office.
|
487
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
478
488
|
# @return [nil]
|
479
489
|
def revoke_office_access_from_form_group(form_group_id, office_id, account_id)
|
480
490
|
revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id)
|
@@ -482,10 +492,10 @@ module DocuSign_Rooms
|
|
482
492
|
end
|
483
493
|
|
484
494
|
# Remove office to a form group so the specified office doesn't have access to the form group.
|
485
|
-
#
|
486
|
-
# @param form_group_id
|
487
|
-
# @param office_id
|
488
|
-
# @param account_id
|
495
|
+
# Revoke access to the form group `formGroupId` from the office `officeId`.
|
496
|
+
# @param form_group_id The ID of the form group.
|
497
|
+
# @param office_id The id of the office. This is the id that the system generated when you created the office.
|
498
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
489
499
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
490
500
|
def revoke_office_access_from_form_group_with_http_info(form_group_id, office_id, account_id)
|
491
501
|
if @api_client.config.debugging
|
@@ -506,7 +516,9 @@ module DocuSign_Rooms
|
|
506
516
|
# header parameters
|
507
517
|
header_params = {}
|
508
518
|
# HTTP header 'Accept' (if needed)
|
509
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
519
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
520
|
+
# HTTP header 'Content-Type'
|
521
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
510
522
|
|
511
523
|
# form parameters
|
512
524
|
form_params = {}
|
@@ -46,8 +46,8 @@ module DocuSign_Rooms
|
|
46
46
|
end
|
47
47
|
|
48
48
|
# Gets a paged list of forms libraries.
|
49
|
-
#
|
50
|
-
# @param account_id
|
49
|
+
# Returns a list of form libraries to which the current user has access.
|
50
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
51
51
|
# @param DocuSign_Rooms::GetFormLibrariesOptions Options for modifying the behavior of the function.
|
52
52
|
# @return [FormLibrarySummaryList]
|
53
53
|
def get_form_libraries(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
|
@@ -56,8 +56,8 @@ module DocuSign_Rooms
|
|
56
56
|
end
|
57
57
|
|
58
58
|
# Gets a paged list of forms libraries.
|
59
|
-
#
|
60
|
-
# @param account_id
|
59
|
+
# Returns a list of form libraries to which the current user has access.
|
60
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
61
61
|
# @param DocuSign_Rooms::GetFormLibrariesOptions Options for modifying the behavior of the function.
|
62
62
|
# @return [Array<(FormLibrarySummaryList, Fixnum, Hash)>] FormLibrarySummaryList data, response status code and response headers
|
63
63
|
def get_form_libraries_with_http_info(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
|
@@ -77,7 +77,9 @@ module DocuSign_Rooms
|
|
77
77
|
# header parameters
|
78
78
|
header_params = {}
|
79
79
|
# HTTP header 'Accept' (if needed)
|
80
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
80
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
81
|
+
# HTTP header 'Content-Type'
|
82
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
81
83
|
|
82
84
|
# form parameters
|
83
85
|
form_params = {}
|
@@ -99,9 +101,9 @@ module DocuSign_Rooms
|
|
99
101
|
end
|
100
102
|
|
101
103
|
# Gets a paged list of forms in a forms library.
|
102
|
-
#
|
104
|
+
# Returns a list of forms to which the current user has access in the specified form library.
|
103
105
|
# @param form_library_id Library Id
|
104
|
-
# @param account_id
|
106
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
105
107
|
# @param DocuSign_Rooms::GetFormLibraryFormsOptions Options for modifying the behavior of the function.
|
106
108
|
# @return [FormSummaryList]
|
107
109
|
def get_form_library_forms(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
|
@@ -110,9 +112,9 @@ module DocuSign_Rooms
|
|
110
112
|
end
|
111
113
|
|
112
114
|
# Gets a paged list of forms in a forms library.
|
113
|
-
#
|
115
|
+
# Returns a list of forms to which the current user has access in the specified form library.
|
114
116
|
# @param form_library_id Library Id
|
115
|
-
# @param account_id
|
117
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
116
118
|
# @param DocuSign_Rooms::GetFormLibraryFormsOptions Options for modifying the behavior of the function.
|
117
119
|
# @return [Array<(FormSummaryList, Fixnum, Hash)>] FormSummaryList data, response status code and response headers
|
118
120
|
def get_form_library_forms_with_http_info(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
|
@@ -134,7 +136,9 @@ module DocuSign_Rooms
|
|
134
136
|
# header parameters
|
135
137
|
header_params = {}
|
136
138
|
# HTTP header 'Accept' (if needed)
|
137
|
-
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'])
|
138
142
|
|
139
143
|
# form parameters
|
140
144
|
form_params = {}
|
@@ -0,0 +1,95 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Rooms API - v2
|
3
|
+
|
4
|
+
#An API for an integrator to access the features of DocuSign Rooms
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_Rooms
|
15
|
+
|
16
|
+
class GetFormProviderAssociationsOptions
|
17
|
+
# Total number of associations to be returned
|
18
|
+
attr_accessor :count
|
19
|
+
|
20
|
+
# starting position of the list
|
21
|
+
attr_accessor :start_position
|
22
|
+
|
23
|
+
def self.default
|
24
|
+
@@default ||= GetFormProviderAssociationsOptions.new
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
|
29
|
+
class FormProviderAssociationsApi
|
30
|
+
attr_accessor :api_client
|
31
|
+
|
32
|
+
def initialize(api_client = FormProviderAssociationsApi.default)
|
33
|
+
@api_client = api_client
|
34
|
+
end
|
35
|
+
|
36
|
+
# Retrieves all Associations by provider
|
37
|
+
# Retrieves all Associations for given provider
|
38
|
+
# @param provider_id provider id like nar, nwmls etc..
|
39
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
40
|
+
# @param DocuSign_Rooms::GetFormProviderAssociationsOptions Options for modifying the behavior of the function.
|
41
|
+
# @return [FormProviderAssociationsSummaryList]
|
42
|
+
def get_form_provider_associations(provider_id, account_id, options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default)
|
43
|
+
data, _status_code, _headers = get_form_provider_associations_with_http_info(provider_id, account_id, options)
|
44
|
+
return data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Retrieves all Associations by provider
|
48
|
+
# Retrieves all Associations for given provider
|
49
|
+
# @param provider_id provider id like nar, nwmls etc..
|
50
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
51
|
+
# @param DocuSign_Rooms::GetFormProviderAssociationsOptions Options for modifying the behavior of the function.
|
52
|
+
# @return [Array<(FormProviderAssociationsSummaryList, Fixnum, Hash)>] FormProviderAssociationsSummaryList data, response status code and response headers
|
53
|
+
def get_form_provider_associations_with_http_info(provider_id, account_id, options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default)
|
54
|
+
if @api_client.config.debugging
|
55
|
+
@api_client.config.logger.debug "Calling API: FormProviderAssociationsApi.get_form_provider_associations ..."
|
56
|
+
end
|
57
|
+
# verify the required parameter 'provider_id' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'provider_id' when calling FormProviderAssociationsApi.get_form_provider_associations" if provider_id.nil?
|
59
|
+
# verify the required parameter 'account_id' is set
|
60
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FormProviderAssociationsApi.get_form_provider_associations" if account_id.nil?
|
61
|
+
# resource path
|
62
|
+
local_var_path = "/v2/accounts/{accountId}/form_providers/{providerId}/associations".sub('{format}','json').sub('{' + 'providerId' + '}', provider_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
63
|
+
|
64
|
+
# query parameters
|
65
|
+
query_params = {}
|
66
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
67
|
+
query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
|
68
|
+
|
69
|
+
# header parameters
|
70
|
+
header_params = {}
|
71
|
+
# HTTP header 'Accept' (if needed)
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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'])
|
75
|
+
|
76
|
+
# form parameters
|
77
|
+
form_params = {}
|
78
|
+
|
79
|
+
# http body (model)
|
80
|
+
post_body = nil
|
81
|
+
auth_names = []
|
82
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => 'FormProviderAssociationsSummaryList')
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: FormProviderAssociationsApi#get_form_provider_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|