docusign_rooms 1.0.0.beta → 1.2.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +7 -56
- data/README.md +1 -1
- data/docusign_rooms.gemspec +1 -0
- 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 +33 -31
- data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb +7 -5
- data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb +12 -14
- data/lib/docusign_rooms/api/fields_api.rb +11 -9
- 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_groups_api.rb +457 -5
- data/lib/docusign_rooms/api/form_libraries_api.rb +14 -10
- data/lib/docusign_rooms/api/offices_api.rb +42 -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 +40 -34
- data/lib/docusign_rooms/api/roles_api.rb +63 -54
- data/lib/docusign_rooms/api/room_contact_types_api.rb +5 -3
- data/lib/docusign_rooms/api/room_folders_api.rb +7 -5
- data/lib/docusign_rooms/api/room_templates_api.rb +11 -5
- data/lib/docusign_rooms/api/rooms_api.rb +202 -179
- 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 +26 -24
- 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 +164 -174
- data/lib/docusign_rooms/client/api_client.rb +3 -2
- data/lib/docusign_rooms/configuration.rb +2 -1
- data/lib/docusign_rooms/models/access_level.rb +32 -0
- data/lib/docusign_rooms/models/account_status.rb +29 -0
- data/lib/docusign_rooms/models/account_summary.rb +1 -35
- data/lib/docusign_rooms/models/assignable_roles.rb +13 -4
- data/lib/docusign_rooms/models/classic_agent_to_invite.rb +10 -1
- data/lib/docusign_rooms/models/classic_manager_to_invite.rb +1 -35
- data/lib/docusign_rooms/models/document.rb +22 -4
- data/lib/docusign_rooms/models/fields_custom_data_filter_type.rb +30 -0
- data/lib/docusign_rooms/models/form_group.rb +214 -0
- data/lib/docusign_rooms/models/form_group_for_create.rb +188 -0
- data/lib/docusign_rooms/models/form_group_for_update.rb +188 -0
- data/lib/docusign_rooms/models/form_group_form_to_assign.rb +197 -0
- data/lib/docusign_rooms/models/form_group_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/form_library_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/form_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/group_form.rb +210 -0
- data/lib/docusign_rooms/models/member_sorting_option.rb +33 -0
- data/lib/docusign_rooms/models/office_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/permissions.rb +79 -16
- data/lib/docusign_rooms/models/product_version.rb +29 -0
- data/lib/docusign_rooms/models/region_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/role.rb +1 -1
- data/lib/docusign_rooms/models/role_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/roles_filter_context_types.rb +30 -0
- data/lib/docusign_rooms/models/room.rb +1 -1
- data/lib/docusign_rooms/models/room_document.rb +40 -4
- data/lib/docusign_rooms/models/room_document_list.rb +10 -1
- data/lib/docusign_rooms/models/room_document_owner.rb +219 -0
- data/lib/docusign_rooms/models/room_folder_list.rb +13 -4
- data/lib/docusign_rooms/models/room_status.rb +31 -0
- data/lib/docusign_rooms/models/room_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/room_templates_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/room_user_sorting_option.rb +33 -0
- data/lib/docusign_rooms/models/room_user_summary.rb +22 -4
- data/lib/docusign_rooms/models/room_users_result.rb +13 -4
- data/lib/docusign_rooms/models/task_list_template_list.rb +13 -4
- data/lib/docusign_rooms/models/user.rb +1 -35
- data/lib/docusign_rooms/models/user_summary.rb +1 -35
- data/lib/docusign_rooms/models/user_summary_list.rb +13 -4
- data/lib/docusign_rooms/models/user_to_invite.rb +1 -35
- data/lib/docusign_rooms/version.rb +1 -1
- data/lib/docusign_rooms.rb +14 -2
- data/runLinter.sh +1 -0
- metadata +113 -60
- checksums.yaml +0 -7
- data/Gemfile.lock +0 -71
- data/docusign_rooms-1.0.0.pre.alpha.gem +0 -0
- 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
data/CHANGELOG.md
CHANGED
@@ -1,66 +1,17 @@
|
|
1
|
-
#
|
2
|
-
All notable changes to this project will be documented in this file.
|
3
|
-
|
1
|
+
# DocuSign Rooms Ruby Client Changelog
|
4
2
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
3
|
|
6
|
-
## [
|
4
|
+
## [1.2.0.rc1] - Rooms API v2-1.0.9 - 2021-10-04
|
7
5
|
### Changed
|
8
|
-
- Added support for version v2
|
6
|
+
- Added support for version v2-1.0.9 of the DocuSign Rooms API.
|
9
7
|
- Updated the SDK release version.
|
10
8
|
|
11
|
-
## [v3.2.1] - eSignature API v2.1-20.1.00 - 2020-04-15
|
12
|
-
### Changed
|
13
|
-
- Updated jwt to version 2.2.1.
|
14
9
|
|
15
|
-
## [
|
10
|
+
## [v1.1.0.rc1] - Rooms API v2-1.0.8 - 2020-12-17
|
16
11
|
### Changed
|
17
|
-
- Added support for version v2
|
18
|
-
- Updated rake to version 12.3.3.
|
12
|
+
- Added support for version v2-1.0.8 of the DocuSign Rooms API.
|
19
13
|
- Updated the SDK release version.
|
20
|
-
### Added
|
21
|
-
- Added the new property `copy_recipient_data` to envelopes. When set to **true**, the information that recipients enter is retained when you clone an envelope. For example, if you resend an envelope that was declined or voided after one or more recipients entered data, that data is retained. Note that the account setting `enable_envelope_copy_with_data` must be set to **true**.
|
22
|
-
- Added a new object, `RecipientIdentityInputOption`: Reserved for DocuSign.
|
23
|
-
- Added a new parameter, `input_options`, to `AccountIdentityVerificationWorkflow`: Reserved for DocuSign.
|
24
|
-
|
25
|
-
## [v3.0.0] - eSignature API v2.1-19.2.02 - 2019-10-08
|
26
|
-
### BREAKING
|
27
|
-
- The SDK now supports version 19.2.02 of the DocuSign eSignature v2.1 API.
|
28
|
-
### Changed
|
29
|
-
- SDK Release Version updated.
|
30
|
-
## Fixed
|
31
|
-
- Issue [`#23`](https://github.com/docusign/docusign-ruby-client/issues/23): Support for DocuSign API 2.1. (DCM-3546)
|
32
|
-
- Issue [`#22`](https://github.com/docusign/docusign-ruby-client/issues/22): JSON version of version 2.0. (DCM-3375)
|
33
|
-
- Issue [`#17`](https://github.com/docusign/docusign-ruby-client/issues/17): Client doesn't properly handle Dropdown. (DCM-3192)
|
34
|
-
- Issue [`#16`](https://github.com/docusign/docusign-ruby-client/issues/16): Client doesn't properly handle Text tabs with Date Validation. (DCM-3193)
|
35
|
-
- Issue [`#15`](https://github.com/docusign/docusign-ruby-client/issues/15): ListStatus not accepting envelope_ids. (DCM-3123)
|
36
|
-
- Issue [`#7`](https://github.com/docusign/docusign-ruby-client/issues/7): Allow passing in JWT. (DCM-2312)
|
37
14
|
|
38
|
-
## [
|
15
|
+
## [v1.0.0] - Rooms API v2-1.0.7 - 2020-10-15
|
39
16
|
### Changed
|
40
|
-
-
|
41
|
-
- SDK Release Version updated.
|
42
|
-
## Fixed
|
43
|
-
- Issue [`#23`](https://github.com/docusign/docusign-ruby-client/issues/23): Support for DocuSign API 2.1. (DCM-3546)
|
44
|
-
- Issue [`#22`](https://github.com/docusign/docusign-ruby-client/issues/22): JSON version of version 2.0. (DCM-3375)
|
45
|
-
- Issue [`#17`](https://github.com/docusign/docusign-ruby-client/issues/17): Client doesn't properly handle Dropdown. (DCM-3192)
|
46
|
-
- Issue [`#16`](https://github.com/docusign/docusign-ruby-client/issues/16): Client doesn't properly handle Text tabs with Date Validation. (DCM-3193)
|
47
|
-
- Issue [`#15`](https://github.com/docusign/docusign-ruby-client/issues/15): ListStatus not accepting envelope_ids. (DCM-3123)
|
48
|
-
- Issue [`#7`](https://github.com/docusign/docusign-ruby-client/issues/7): Allow passing in JWT. (DCM-2312)
|
49
|
-
|
50
|
-
## [2.0.0] - eSignature API v19.1.02 - 2019-06-08
|
51
|
-
### BREAKING
|
52
|
-
* Moved ApiClient and ApiException under Client folder
|
53
|
-
### Removed
|
54
|
-
* empty test placeholder files
|
55
|
-
### Changed
|
56
|
-
* updated existing test cases to use JWT instead of the legacy auth (still not fully working yet)
|
57
|
-
### Added
|
58
|
-
* OAuth models under Client/Auth folder
|
59
|
-
* new dependency for OAuth support (firebase/php-jwt)
|
60
|
-
* OAuthTests.php for OAuth support test
|
61
|
-
### Fixed
|
62
|
-
* A bug with that could cause the *moveEnvelopes* method call to return a response without a *Content-Type* header. (DCM-2871)
|
63
|
-
|
64
|
-
## [1.0.2] - Updates Json gem dependency from 1.8 to 2.1 - 2018-10-22
|
65
|
-
|
66
|
-
## [1.0.1] - Updated JWT version requirement - 2018-10-22
|
17
|
+
- First GA version of Rooms API.
|
data/README.md
CHANGED
@@ -77,4 +77,4 @@ The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/
|
|
77
77
|
* [DocuSign Developer Center](https://developers.docusign.com)
|
78
78
|
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
79
79
|
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
80
|
-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
80
|
+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
data/docusign_rooms.gemspec
CHANGED
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
|
|
29
29
|
s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
|
30
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
31
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
|
32
33
|
|
33
34
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
35
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
@@ -22,8 +22,8 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Get information about the account.
|
25
|
-
#
|
26
|
-
# @param account_id
|
25
|
+
# Returns details about a company account.
|
26
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
27
27
|
# @return [AccountSummary]
|
28
28
|
def get_account_information(account_id)
|
29
29
|
data, _status_code, _headers = get_account_information_with_http_info(account_id)
|
@@ -31,8 +31,8 @@ module DocuSign_Rooms
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Get information about the account.
|
34
|
-
#
|
35
|
-
# @param account_id
|
34
|
+
# Returns details about a company account.
|
35
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
36
36
|
# @return [Array<(AccountSummary, Fixnum, Hash)>] AccountSummary data, response status code and response headers
|
37
37
|
def get_account_information_with_http_info(account_id)
|
38
38
|
if @api_client.config.debugging
|
@@ -49,7 +49,9 @@ module DocuSign_Rooms
|
|
49
49
|
# header parameters
|
50
50
|
header_params = {}
|
51
51
|
# HTTP header 'Accept' (if needed)
|
52
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
53
|
+
# HTTP header 'Content-Type'
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
53
55
|
|
54
56
|
# form parameters
|
55
57
|
form_params = {}
|
@@ -22,7 +22,7 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Retrieves the list of valid activity types.
|
25
|
-
#
|
25
|
+
# Retrieves the list of valid activity types.
|
26
26
|
# @return [GlobalActivityTypes]
|
27
27
|
def get_activity_types()
|
28
28
|
data, _status_code, _headers = get_activity_types_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid activity types.
|
33
|
-
#
|
33
|
+
# Retrieves the list of valid activity types.
|
34
34
|
# @return [Array<(GlobalActivityTypes, Fixnum, Hash)>] GlobalActivityTypes data, response status code and response headers
|
35
35
|
def get_activity_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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 closing statuses.
|
25
|
-
#
|
25
|
+
# Returns a list of closing statuses, or valid reasons for closing a room.
|
26
26
|
# @return [GlobalClosingStatuses]
|
27
27
|
def get_closing_statuses()
|
28
28
|
data, _status_code, _headers = get_closing_statuses_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid closing statuses.
|
33
|
-
#
|
33
|
+
# Returns a list of closing statuses, or valid reasons for closing a room.
|
34
34
|
# @return [Array<(GlobalClosingStatuses, Fixnum, Hash)>] GlobalClosingStatuses data, response status code and response headers
|
35
35
|
def get_closing_statuses_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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 contact sides.
|
25
|
-
#
|
25
|
+
# Returns a list of valid contact sides.
|
26
26
|
# @return [GlobalContactSides]
|
27
27
|
def get_contact_sides()
|
28
28
|
data, _status_code, _headers = get_contact_sides_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid contact sides.
|
33
|
-
#
|
33
|
+
# Returns a list of valid contact sides.
|
34
34
|
# @return [Array<(GlobalContactSides, Fixnum, Hash)>] GlobalContactSides data, response status code and response headers
|
35
35
|
def get_contact_sides_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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 countries.
|
25
|
-
#
|
25
|
+
# Returns a list of countries that the API supports
|
26
26
|
# @return [GlobalCountries]
|
27
27
|
def get_countries()
|
28
28
|
data, _status_code, _headers = get_countries_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid countries.
|
33
|
-
#
|
33
|
+
# Returns a list of countries that the API supports
|
34
34
|
# @return [Array<(GlobalCountries, Fixnum, Hash)>] GlobalCountries data, response status code and response headers
|
35
35
|
def get_countries_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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 currencies.
|
25
|
-
#
|
25
|
+
# Returns a list of valid values for the currencies that you can use for listing, offer, and loan amounts.
|
26
26
|
# @return [GlobalCurrencies]
|
27
27
|
def get_currencies()
|
28
28
|
data, _status_code, _headers = get_currencies_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid currencies.
|
33
|
-
#
|
33
|
+
# Returns a list of valid values for the currencies that you can use for listing, offer, and loan amounts.
|
34
34
|
# @return [Array<(GlobalCurrencies, Fixnum, Hash)>] GlobalCurrencies data, response status code and response headers
|
35
35
|
def get_currencies_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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 = {}
|
@@ -14,7 +14,7 @@ require "uri"
|
|
14
14
|
module DocuSign_Rooms
|
15
15
|
|
16
16
|
class GetDocumentOptions
|
17
|
-
#
|
17
|
+
# When set to **true**, includes the contents of the document in the `base64Contents` property of the response. The default value is **false**.
|
18
18
|
attr_accessor :include_contents
|
19
19
|
|
20
20
|
def self.default
|
@@ -31,30 +31,28 @@ module DocuSign_Rooms
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Grants access to a document for a user.
|
34
|
-
#
|
35
|
-
# @param document_id
|
36
|
-
# @param account_id
|
37
|
-
# @param
|
34
|
+
# Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.
|
35
|
+
# @param document_id The id of the document.
|
36
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
37
|
+
# @param body (optional parameter)
|
38
38
|
# @return [DocumentUser]
|
39
|
-
def create_document_user(document_id, account_id,
|
40
|
-
data, _status_code, _headers = create_document_user_with_http_info(document_id, account_id,
|
39
|
+
def create_document_user(document_id, account_id, body)
|
40
|
+
data, _status_code, _headers = create_document_user_with_http_info(document_id, account_id, body)
|
41
41
|
return data
|
42
42
|
end
|
43
43
|
|
44
44
|
# Grants access to a document for a user.
|
45
|
-
#
|
46
|
-
# @param document_id
|
47
|
-
# @param account_id
|
48
|
-
# @param
|
45
|
+
# Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.
|
46
|
+
# @param document_id The id of the document.
|
47
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
48
|
+
# @param body (optional parameter)
|
49
49
|
# @return [Array<(DocumentUser, Fixnum, Hash)>] DocumentUser data, response status code and response headers
|
50
|
-
def create_document_user_with_http_info(document_id, account_id,
|
50
|
+
def create_document_user_with_http_info(document_id, account_id, body)
|
51
51
|
if @api_client.config.debugging
|
52
52
|
@api_client.config.logger.debug "Calling API: DocumentsApi.create_document_user ..."
|
53
53
|
end
|
54
54
|
# verify the required parameter 'document_id' is set
|
55
55
|
fail ArgumentError, "Missing the required parameter 'document_id' when calling DocumentsApi.create_document_user" if document_id.nil?
|
56
|
-
# verify the required parameter 'document_user_for_create' is set
|
57
|
-
fail ArgumentError, "Missing the required parameter 'document_user_for_create' when calling DocumentsApi.create_document_user" if document_user_for_create.nil?
|
58
56
|
# verify the required parameter 'account_id' is set
|
59
57
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling DocumentsApi.create_document_user" if account_id.nil?
|
60
58
|
# resource path
|
@@ -66,15 +64,15 @@ module DocuSign_Rooms
|
|
66
64
|
# header parameters
|
67
65
|
header_params = {}
|
68
66
|
# HTTP header 'Accept' (if needed)
|
69
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
67
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
70
68
|
# HTTP header 'Content-Type'
|
71
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
69
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
72
70
|
|
73
71
|
# form parameters
|
74
72
|
form_params = {}
|
75
73
|
|
76
74
|
# http body (model)
|
77
|
-
post_body = @api_client.object_to_http_body(
|
75
|
+
post_body = @api_client.object_to_http_body(body)
|
78
76
|
auth_names = []
|
79
77
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
80
78
|
:header_params => header_params,
|
@@ -90,9 +88,9 @@ module DocuSign_Rooms
|
|
90
88
|
end
|
91
89
|
|
92
90
|
# Deletes a document.
|
93
|
-
#
|
94
|
-
# @param document_id
|
95
|
-
# @param account_id
|
91
|
+
# Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.
|
92
|
+
# @param document_id The ID of the document.
|
93
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
96
94
|
# @return [nil]
|
97
95
|
def delete_document(document_id, account_id)
|
98
96
|
delete_document_with_http_info(document_id, account_id)
|
@@ -100,9 +98,9 @@ module DocuSign_Rooms
|
|
100
98
|
end
|
101
99
|
|
102
100
|
# Deletes a document.
|
103
|
-
#
|
104
|
-
# @param document_id
|
105
|
-
# @param account_id
|
101
|
+
# Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.
|
102
|
+
# @param document_id The ID of the document.
|
103
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
106
104
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
107
105
|
def delete_document_with_http_info(document_id, account_id)
|
108
106
|
if @api_client.config.debugging
|
@@ -121,7 +119,9 @@ module DocuSign_Rooms
|
|
121
119
|
# header parameters
|
122
120
|
header_params = {}
|
123
121
|
# HTTP header 'Accept' (if needed)
|
124
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
123
|
+
# HTTP header 'Content-Type'
|
124
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
125
125
|
|
126
126
|
# form parameters
|
127
127
|
form_params = {}
|
@@ -142,9 +142,9 @@ module DocuSign_Rooms
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Get information about the Document with the given DocumentId.
|
145
|
-
#
|
146
|
-
# @param document_id
|
147
|
-
# @param account_id
|
145
|
+
# Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.
|
146
|
+
# @param document_id The id of the document.
|
147
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
148
148
|
# @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
|
149
149
|
# @return [Document]
|
150
150
|
def get_document(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
|
@@ -153,9 +153,9 @@ module DocuSign_Rooms
|
|
153
153
|
end
|
154
154
|
|
155
155
|
# Get information about the Document with the given DocumentId.
|
156
|
-
#
|
157
|
-
# @param document_id
|
158
|
-
# @param account_id
|
156
|
+
# Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.
|
157
|
+
# @param document_id The id of the document.
|
158
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
159
159
|
# @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
|
160
160
|
# @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
|
161
161
|
def get_document_with_http_info(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
|
@@ -176,7 +176,9 @@ module DocuSign_Rooms
|
|
176
176
|
# header parameters
|
177
177
|
header_params = {}
|
178
178
|
# HTTP header 'Accept' (if needed)
|
179
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
180
|
+
# HTTP header 'Content-Type'
|
181
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
180
182
|
|
181
183
|
# form parameters
|
182
184
|
form_params = {}
|
@@ -22,8 +22,8 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Gets permission profiles from the associated eSign account.
|
25
|
-
#
|
26
|
-
# @param account_id
|
25
|
+
# When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.
|
26
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
27
27
|
# @return [ESignPermissionProfileList]
|
28
28
|
def get_e_sign_permission_profiles(account_id)
|
29
29
|
data, _status_code, _headers = get_e_sign_permission_profiles_with_http_info(account_id)
|
@@ -31,8 +31,8 @@ module DocuSign_Rooms
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Gets permission profiles from the associated eSign account.
|
34
|
-
#
|
35
|
-
# @param account_id
|
34
|
+
# When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.
|
35
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
36
36
|
# @return [Array<(ESignPermissionProfileList, Fixnum, Hash)>] ESignPermissionProfileList data, response status code and response headers
|
37
37
|
def get_e_sign_permission_profiles_with_http_info(account_id)
|
38
38
|
if @api_client.config.debugging
|
@@ -49,7 +49,9 @@ module DocuSign_Rooms
|
|
49
49
|
# header parameters
|
50
50
|
header_params = {}
|
51
51
|
# HTTP header 'Accept' (if needed)
|
52
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
53
|
+
# HTTP header 'Content-Type'
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
53
55
|
|
54
56
|
# form parameters
|
55
57
|
form_params = {}
|
@@ -22,26 +22,24 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Creates an external form fill session.
|
25
|
-
#
|
26
|
-
# @param account_id
|
27
|
-
# @param
|
25
|
+
# Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.
|
26
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
27
|
+
# @param body (optional parameter)
|
28
28
|
# @return [ExternalFormFillSession]
|
29
|
-
def create_external_form_fill_session(account_id,
|
30
|
-
data, _status_code, _headers = create_external_form_fill_session_with_http_info(account_id,
|
29
|
+
def create_external_form_fill_session(account_id, body)
|
30
|
+
data, _status_code, _headers = create_external_form_fill_session_with_http_info(account_id, body)
|
31
31
|
return data
|
32
32
|
end
|
33
33
|
|
34
34
|
# Creates an external form fill session.
|
35
|
-
#
|
36
|
-
# @param account_id
|
37
|
-
# @param
|
35
|
+
# Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.
|
36
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
37
|
+
# @param body (optional parameter)
|
38
38
|
# @return [Array<(ExternalFormFillSession, Fixnum, Hash)>] ExternalFormFillSession data, response status code and response headers
|
39
|
-
def create_external_form_fill_session_with_http_info(account_id,
|
39
|
+
def create_external_form_fill_session_with_http_info(account_id, body)
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug "Calling API: ExternalFormFillSessionsApi.create_external_form_fill_session ..."
|
42
42
|
end
|
43
|
-
# verify the required parameter 'form_fill_session_for_create' is set
|
44
|
-
fail ArgumentError, "Missing the required parameter 'form_fill_session_for_create' when calling ExternalFormFillSessionsApi.create_external_form_fill_session" if form_fill_session_for_create.nil?
|
45
43
|
# verify the required parameter 'account_id' is set
|
46
44
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling ExternalFormFillSessionsApi.create_external_form_fill_session" if account_id.nil?
|
47
45
|
# resource path
|
@@ -53,15 +51,15 @@ module DocuSign_Rooms
|
|
53
51
|
# header parameters
|
54
52
|
header_params = {}
|
55
53
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
57
55
|
# HTTP header 'Content-Type'
|
58
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
59
57
|
|
60
58
|
# form parameters
|
61
59
|
form_params = {}
|
62
60
|
|
63
61
|
# http body (model)
|
64
|
-
post_body = @api_client.object_to_http_body(
|
62
|
+
post_body = @api_client.object_to_http_body(body)
|
65
63
|
auth_names = []
|
66
64
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
67
65
|
:header_params => header_params,
|
@@ -14,7 +14,7 @@ require "uri"
|
|
14
14
|
module DocuSign_Rooms
|
15
15
|
|
16
16
|
class GetFieldSetOptions
|
17
|
-
#
|
17
|
+
# A comma-separated list that limits the fields to return:\\n\\n- `IsRequiredOnCreate`: include fields that are required in room creation.\\n- `IsRequiredOnSubmit`: include fields that are required when submitting a room for review.\\n
|
18
18
|
attr_accessor :fields_custom_data_filters
|
19
19
|
|
20
20
|
def self.default
|
@@ -31,9 +31,9 @@ module DocuSign_Rooms
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Get details of a specific field set.
|
34
|
-
#
|
35
|
-
# @param field_set_id
|
36
|
-
# @param account_id
|
34
|
+
# Get details of a specific field set.
|
35
|
+
# @param field_set_id The id of the field set.
|
36
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
37
37
|
# @param DocuSign_Rooms::GetFieldSetOptions Options for modifying the behavior of the function.
|
38
38
|
# @return [FieldSet]
|
39
39
|
def get_field_set(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default)
|
@@ -42,9 +42,9 @@ module DocuSign_Rooms
|
|
42
42
|
end
|
43
43
|
|
44
44
|
# Get details of a specific field set.
|
45
|
-
#
|
46
|
-
# @param field_set_id
|
47
|
-
# @param account_id
|
45
|
+
# Get details of a specific field set.
|
46
|
+
# @param field_set_id The id of the field set.
|
47
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
48
48
|
# @param DocuSign_Rooms::GetFieldSetOptions Options for modifying the behavior of the function.
|
49
49
|
# @return [Array<(FieldSet, Fixnum, Hash)>] FieldSet data, response status code and response headers
|
50
50
|
def get_field_set_with_http_info(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default)
|
@@ -63,12 +63,14 @@ module DocuSign_Rooms
|
|
63
63
|
|
64
64
|
# query parameters
|
65
65
|
query_params = {}
|
66
|
-
query_params[:'fieldsCustomDataFilters'] = @api_client.build_collection_param(options.fields_custom_data_filters, :
|
66
|
+
query_params[:'fieldsCustomDataFilters'] = @api_client.build_collection_param(options.fields_custom_data_filters, :csv) if !options.fields_custom_data_filters.nil?
|
67
67
|
|
68
68
|
# header parameters
|
69
69
|
header_params = {}
|
70
70
|
# HTTP header 'Accept' (if needed)
|
71
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
71
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
72
|
+
# HTTP header 'Content-Type'
|
73
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
72
74
|
|
73
75
|
# form parameters
|
74
76
|
form_params = {}
|
@@ -22,7 +22,7 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Retrieves the list of valid financing types.
|
25
|
-
#
|
25
|
+
# Returns a list of possible financing types
|
26
26
|
# @return [GlobalFinancingTypes]
|
27
27
|
def get_financing_types()
|
28
28
|
data, _status_code, _headers = get_financing_types_with_http_info()
|
@@ -30,7 +30,7 @@ module DocuSign_Rooms
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieves the list of valid financing types.
|
33
|
-
#
|
33
|
+
# Returns a list of possible financing types
|
34
34
|
# @return [Array<(GlobalFinancingTypes, Fixnum, Hash)>] GlobalFinancingTypes data, response status code and response headers
|
35
35
|
def get_financing_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(['application/json'])
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
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,9 +22,9 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Gets form based on Id.
|
25
|
-
#
|
25
|
+
# Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.
|
26
26
|
# @param form_id Form ID
|
27
|
-
# @param account_id
|
27
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
28
28
|
# @return [FormDetails]
|
29
29
|
def get_form_details(form_id, account_id)
|
30
30
|
data, _status_code, _headers = get_form_details_with_http_info(form_id, account_id)
|
@@ -32,9 +32,9 @@ module DocuSign_Rooms
|
|
32
32
|
end
|
33
33
|
|
34
34
|
# Gets form based on Id.
|
35
|
-
#
|
35
|
+
# Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.
|
36
36
|
# @param form_id Form ID
|
37
|
-
# @param account_id
|
37
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
38
38
|
# @return [Array<(FormDetails, Fixnum, Hash)>] FormDetails data, response status code and response headers
|
39
39
|
def get_form_details_with_http_info(form_id, account_id)
|
40
40
|
if @api_client.config.debugging
|
@@ -53,7 +53,9 @@ module DocuSign_Rooms
|
|
53
53
|
# header parameters
|
54
54
|
header_params = {}
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
57
59
|
|
58
60
|
# form parameters
|
59
61
|
form_params = {}
|