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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '0933d85cae9bda0d7835ad033a42eac3371c2297bfd374c6d6bce5f9ab9c625c'
|
4
|
+
data.tar.gz: ebc6c08f0caa5ae6fa1f4aeda50c7208352124626aa3cc1665a1b690a2584150
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e77381d3a4cf99894f27ad41be78aa2ce71af6b9c39b31c630bb0f9cd99d37c76f52591eb3df59c40388b9485933a76dc0963a120aef6425a2edb786551f1632
|
7
|
+
data.tar.gz: 4a1ba92e92cd0701eaa5def076799bc6e34ce1059b62c84214ae6a2781fbc9d62b8b58e629d7c84bd3bc131716b9146f8cbfc79e2812950cac7104ecb8dfc083
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,17 @@
|
|
1
1
|
# DocuSign Rooms Ruby Client Changelog
|
2
2
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
3
3
|
|
4
|
+
## [v1.3.0] - Rooms API v2-1.1.0 - 2023-01-30
|
5
|
+
### Changed
|
6
|
+
- Added support for version v2-1.1.0 of the DocuSign Rooms API.
|
7
|
+
- Updated the SDK release version.
|
8
|
+
|
9
|
+
## [1.2.0.rc1] - Rooms API v2-1.0.9 - 2021-10-04
|
10
|
+
### Changed
|
11
|
+
- Added support for version v2-1.0.9 of the DocuSign Rooms API.
|
12
|
+
- Updated the SDK release version.
|
13
|
+
|
14
|
+
|
4
15
|
## [v1.1.0.rc1] - Rooms API v2-1.0.8 - 2020-12-17
|
5
16
|
### Changed
|
6
17
|
- Added support for version v2-1.0.8 of the DocuSign Rooms API.
|
data/docusign_rooms.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
2
2
|
|
3
3
|
=begin
|
4
|
-
#DocuSign Rooms API
|
4
|
+
#DocuSign Rooms API - v2
|
5
5
|
|
6
6
|
#An API for an integrator to access the features of DocuSign Rooms
|
7
7
|
|
@@ -21,25 +21,28 @@ Gem::Specification.new do |s|
|
|
21
21
|
s.authors = ["DocuSign"]
|
22
22
|
s.email = ["devcenter@docusign.com"]
|
23
23
|
s.homepage = "https://github.com/docusign/docusign-rooms-ruby-client"
|
24
|
-
s.summary = "DocuSign Rooms API Ruby Gem"
|
24
|
+
s.summary = "DocuSign Rooms API - v2 Ruby Gem"
|
25
25
|
s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-rooms-ruby-client repository."
|
26
26
|
s.license = "MIT"
|
27
27
|
s.required_ruby_version = ">= 1.9"
|
28
28
|
|
29
29
|
s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
|
30
|
+
s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
|
30
31
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
32
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
33
|
|
33
|
-
s.add_development_dependency 'rspec', '~> 3.
|
34
|
+
s.add_development_dependency 'rspec-mocks', '~> 3.8', '>= 3.8.0'
|
35
|
+
s.add_development_dependency 'rspec-expectations', '~> 3.8', '>= 3.8.0'
|
36
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
34
37
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
35
38
|
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
36
39
|
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
37
40
|
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
38
41
|
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
39
|
-
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.
|
42
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
40
43
|
|
41
|
-
s.files = `find *`.split("\n").uniq.sort.select
|
44
|
+
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
42
45
|
s.test_files = `find spec/*`.split("\n")
|
43
46
|
s.executables = []
|
44
47
|
s.require_paths = ["lib"]
|
45
|
-
end
|
48
|
+
end
|
@@ -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(['text/plain', 'application/json', 'text/json'])
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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
|
+
# Returns 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
|
+
# Returns 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(['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 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(['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 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(['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 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(['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 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(['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 = {}
|
@@ -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,10 +31,10 @@ 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 body
|
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 Request body with user id that the document has to be granted to (optional parameter)
|
38
38
|
# @return [DocumentUser]
|
39
39
|
def create_document_user(document_id, account_id, body)
|
40
40
|
data, _status_code, _headers = create_document_user_with_http_info(document_id, account_id, body)
|
@@ -42,10 +42,10 @@ module DocuSign_Rooms
|
|
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 body
|
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 Request body with user id that the document has to be granted to (optional parameter)
|
49
49
|
# @return [Array<(DocumentUser, Fixnum, Hash)>] DocumentUser data, response status code and response headers
|
50
50
|
def create_document_user_with_http_info(document_id, account_id, body)
|
51
51
|
if @api_client.config.debugging
|
@@ -64,9 +64,9 @@ module DocuSign_Rooms
|
|
64
64
|
# header parameters
|
65
65
|
header_params = {}
|
66
66
|
# HTTP header 'Accept' (if needed)
|
67
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
67
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
68
68
|
# HTTP header 'Content-Type'
|
69
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
69
|
+
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'])
|
70
70
|
|
71
71
|
# form parameters
|
72
72
|
form_params = {}
|
@@ -88,9 +88,9 @@ module DocuSign_Rooms
|
|
88
88
|
end
|
89
89
|
|
90
90
|
# Deletes a document.
|
91
|
-
#
|
92
|
-
# @param document_id
|
93
|
-
# @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.
|
94
94
|
# @return [nil]
|
95
95
|
def delete_document(document_id, account_id)
|
96
96
|
delete_document_with_http_info(document_id, account_id)
|
@@ -98,9 +98,9 @@ module DocuSign_Rooms
|
|
98
98
|
end
|
99
99
|
|
100
100
|
# Deletes a document.
|
101
|
-
#
|
102
|
-
# @param document_id
|
103
|
-
# @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.
|
104
104
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
105
105
|
def delete_document_with_http_info(document_id, account_id)
|
106
106
|
if @api_client.config.debugging
|
@@ -119,7 +119,9 @@ module DocuSign_Rooms
|
|
119
119
|
# header parameters
|
120
120
|
header_params = {}
|
121
121
|
# HTTP header 'Accept' (if needed)
|
122
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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'])
|
123
125
|
|
124
126
|
# form parameters
|
125
127
|
form_params = {}
|
@@ -140,9 +142,9 @@ module DocuSign_Rooms
|
|
140
142
|
end
|
141
143
|
|
142
144
|
# Get information about the Document with the given DocumentId.
|
143
|
-
#
|
144
|
-
# @param document_id
|
145
|
-
# @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.
|
146
148
|
# @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
|
147
149
|
# @return [Document]
|
148
150
|
def get_document(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
|
@@ -151,9 +153,9 @@ module DocuSign_Rooms
|
|
151
153
|
end
|
152
154
|
|
153
155
|
# Get information about the Document with the given DocumentId.
|
154
|
-
#
|
155
|
-
# @param document_id
|
156
|
-
# @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.
|
157
159
|
# @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
|
158
160
|
# @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
|
159
161
|
def get_document_with_http_info(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
|
@@ -174,7 +176,9 @@ module DocuSign_Rooms
|
|
174
176
|
# header parameters
|
175
177
|
header_params = {}
|
176
178
|
# HTTP header 'Accept' (if needed)
|
177
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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'])
|
178
182
|
|
179
183
|
# form parameters
|
180
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(['text/plain', 'application/json', 'text/json'])
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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,9 +22,9 @@ module DocuSign_Rooms
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Creates an external form fill session.
|
25
|
-
#
|
26
|
-
# @param account_id
|
27
|
-
# @param body
|
25
|
+
# Returns a URL for a new external form fill session, based on the `roomId` and `formId` or `formIds` that you specify in the `formFillSessionForCreate` request body. User may supply up to 10 `formIds`. Eventually, `formId` will be deprecated.
|
26
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
27
|
+
# @param body Request body that accepts the `roomId` and `formId` or `formIds` that you specify in the `formFillSessionForCreate` request body. User may supply up to 10 `formIds`. Eventually, `formId` will be deprecated (optional parameter)
|
28
28
|
# @return [ExternalFormFillSession]
|
29
29
|
def create_external_form_fill_session(account_id, body)
|
30
30
|
data, _status_code, _headers = create_external_form_fill_session_with_http_info(account_id, body)
|
@@ -32,9 +32,9 @@ module DocuSign_Rooms
|
|
32
32
|
end
|
33
33
|
|
34
34
|
# Creates an external form fill session.
|
35
|
-
#
|
36
|
-
# @param account_id
|
37
|
-
# @param body
|
35
|
+
# Returns a URL for a new external form fill session, based on the `roomId` and `formId` or `formIds` that you specify in the `formFillSessionForCreate` request body. User may supply up to 10 `formIds`. Eventually, `formId` will be deprecated.
|
36
|
+
# @param account_id (Required) The globally unique identifier (GUID) for the account.
|
37
|
+
# @param body Request body that accepts the `roomId` and `formId` or `formIds` that you specify in the `formFillSessionForCreate` request body. User may supply up to 10 `formIds`. Eventually, `formId` will be deprecated (optional parameter)
|
38
38
|
# @return [Array<(ExternalFormFillSession, Fixnum, Hash)>] ExternalFormFillSession data, response status code and response headers
|
39
39
|
def create_external_form_fill_session_with_http_info(account_id, body)
|
40
40
|
if @api_client.config.debugging
|
@@ -51,9 +51,9 @@ module DocuSign_Rooms
|
|
51
51
|
# header parameters
|
52
52
|
header_params = {}
|
53
53
|
# HTTP header 'Accept' (if needed)
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
55
55
|
# HTTP header 'Content-Type'
|
56
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
56
|
+
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'])
|
57
57
|
|
58
58
|
# form parameters
|
59
59
|
form_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)
|
@@ -68,7 +68,9 @@ module DocuSign_Rooms
|
|
68
68
|
# header parameters
|
69
69
|
header_params = {}
|
70
70
|
# HTTP header 'Accept' (if needed)
|
71
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
|
71
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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(['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,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(['text/plain', 'application/json', 'text/json'])
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
|
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 = {}
|