docusign_rooms 1.1.0 → 1.2.0.rc1

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # DocuSign Rooms Ruby Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [1.2.0.rc1] - Rooms API v2-1.0.9 - 2021-10-04
+### Changed
+- Added support for version v2-1.0.9 of the DocuSign Rooms API.
+- Updated the SDK release version.
+
+
 ## [v1.1.0.rc1] - Rooms API v2-1.0.8 - 2020-12-17
 ### Changed
 - Added support for version v2-1.0.8 of the DocuSign Rooms API.

data/docusign_rooms.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'

data/lib/docusign_rooms/api/accounts_api.rb

@@ -22,8 +22,8 @@ module DocuSign_Rooms
     end
 
     # Get information about the account.
-    # 
-    # @param account_id 
+    # Returns details about a company account.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [AccountSummary]
     def get_account_information(account_id)
       data, _status_code, _headers = get_account_information_with_http_info(account_id)
@@ -31,8 +31,8 @@ module DocuSign_Rooms
     end
 
     # Get information about the account.
-    # 
-    # @param account_id 
+    # Returns details about a company account.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(AccountSummary, Fixnum, Hash)>] AccountSummary data, response status code and response headers
     def get_account_information_with_http_info(account_id)
       if @api_client.config.debugging
@@ -50,6 +50,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/activity_types_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid activity types.
-    # 
+    # Retrieves the list of valid activity types.
     # @return [GlobalActivityTypes]
     def get_activity_types()
       data, _status_code, _headers = get_activity_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid activity types.
-    # 
+    # Retrieves the list of valid activity types.
     # @return [Array<(GlobalActivityTypes, Fixnum, Hash)>] GlobalActivityTypes data, response status code and response headers
     def get_activity_types_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/closing_statuses_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid closing statuses.
-    # 
+    # Returns a list of closing statuses, or valid reasons for closing a room.
     # @return [GlobalClosingStatuses]
     def get_closing_statuses()
       data, _status_code, _headers = get_closing_statuses_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid closing statuses.
-    # 
+    # Returns a list of closing statuses, or valid reasons for closing a room.
     # @return [Array<(GlobalClosingStatuses, Fixnum, Hash)>] GlobalClosingStatuses data, response status code and response headers
     def get_closing_statuses_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/contact_sides_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid contact sides.
-    # 
+    # Returns a list of valid contact sides.
     # @return [GlobalContactSides]
     def get_contact_sides()
       data, _status_code, _headers = get_contact_sides_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid contact sides.
-    # 
+    # Returns a list of valid contact sides.
     # @return [Array<(GlobalContactSides, Fixnum, Hash)>] GlobalContactSides data, response status code and response headers
     def get_contact_sides_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/countries_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid countries.
-    # 
+    # Returns a list of countries that the API supports
     # @return [GlobalCountries]
     def get_countries()
       data, _status_code, _headers = get_countries_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid countries.
-    # 
+    # Returns a list of countries that the API supports
     # @return [Array<(GlobalCountries, Fixnum, Hash)>] GlobalCountries data, response status code and response headers
     def get_countries_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/currencies_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid currencies.
-    # 
+    # Returns a list of valid values for the currencies that you can use for listing, offer, and loan amounts.
     # @return [GlobalCurrencies]
     def get_currencies()
       data, _status_code, _headers = get_currencies_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid currencies.
-    # 
+    # Returns a list of valid values for the currencies that you can use for listing, offer, and loan amounts.
     # @return [Array<(GlobalCurrencies, Fixnum, Hash)>] GlobalCurrencies data, response status code and response headers
     def get_currencies_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/documents_api.rb

@@ -14,7 +14,7 @@ require "uri"
 module DocuSign_Rooms
 
   class GetDocumentOptions
-    # 
+    # When set to **true**, includes the contents of the document in the `base64Contents` property of the response. The default value is **false**.
     attr_accessor :include_contents
 
     def self.default
@@ -31,9 +31,9 @@ module DocuSign_Rooms
     end
 
     # Grants access to a document for a user.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # 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.
+    # @param document_id The id of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [DocumentUser]
     def create_document_user(document_id, account_id, body)
@@ -42,9 +42,9 @@ module DocuSign_Rooms
     end
 
     # Grants access to a document for a user.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # 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.
+    # @param document_id The id of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Array<(DocumentUser, Fixnum, Hash)>] DocumentUser data, response status code and response headers
     def create_document_user_with_http_info(document_id, account_id, body)
@@ -88,9 +88,9 @@ module DocuSign_Rooms
     end
 
     # Deletes a document.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # 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.
+    # @param document_id The ID of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [nil]
     def delete_document(document_id, account_id)
       delete_document_with_http_info(document_id, account_id)
@@ -98,9 +98,9 @@ module DocuSign_Rooms
     end
 
     # Deletes a document.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # Permanently deletes a document. To find the &#x60;documentId&#x60; 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.
+    # @param document_id The ID of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_document_with_http_info(document_id, account_id)
       if @api_client.config.debugging
@@ -120,6 +120,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}
@@ -140,9 +142,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the Document with the given DocumentId.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # 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.
+    # @param document_id The id of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
     # @return [Document]
     def get_document(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
@@ -151,9 +153,9 @@ module DocuSign_Rooms
     end
 
     # Get information about the Document with the given DocumentId.
-    # 
-    # @param document_id 
-    # @param account_id 
+    # 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 &#x60;documentId&#x60; of the document that you want to retrieve, use the Rooms::GetDocuments method.
+    # @param document_id The id of the document.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetDocumentOptions Options for modifying the behavior of the function.
     # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
     def get_document_with_http_info(document_id, account_id, options = DocuSign_Rooms::GetDocumentOptions.default)
@@ -175,6 +177,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/e_sign_permission_profiles_api.rb

@@ -22,8 +22,8 @@ module DocuSign_Rooms
     end
 
     # Gets permission profiles from the associated eSign account.
-    # 
-    # @param account_id 
+    # 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.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [ESignPermissionProfileList]
     def get_e_sign_permission_profiles(account_id)
       data, _status_code, _headers = get_e_sign_permission_profiles_with_http_info(account_id)
@@ -31,8 +31,8 @@ module DocuSign_Rooms
     end
 
     # Gets permission profiles from the associated eSign account.
-    # 
-    # @param account_id 
+    # 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.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(ESignPermissionProfileList, Fixnum, Hash)>] ESignPermissionProfileList data, response status code and response headers
     def get_e_sign_permission_profiles_with_http_info(account_id)
       if @api_client.config.debugging
@@ -50,6 +50,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/external_form_fill_sessions_api.rb

@@ -22,8 +22,8 @@ module DocuSign_Rooms
     end
 
     # Creates an external form fill session.
-    # 
-    # @param account_id 
+    # Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [ExternalFormFillSession]
     def create_external_form_fill_session(account_id, body)
@@ -32,8 +32,8 @@ module DocuSign_Rooms
     end
 
     # Creates an external form fill session.
-    # 
-    # @param account_id 
+    # Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param body  (optional parameter)
     # @return [Array<(ExternalFormFillSession, Fixnum, Hash)>] ExternalFormFillSession data, response status code and response headers
     def create_external_form_fill_session_with_http_info(account_id, body)

data/lib/docusign_rooms/api/fields_api.rb

@@ -14,7 +14,7 @@ require "uri"
 module DocuSign_Rooms
 
   class GetFieldSetOptions
-    # 
+    # 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
     attr_accessor :fields_custom_data_filters
 
     def self.default
@@ -31,9 +31,9 @@ module DocuSign_Rooms
     end
 
     # Get details of a specific field set.
-    # 
-    # @param field_set_id 
-    # @param account_id 
+    # Get details of a specific field set.
+    # @param field_set_id The id of the field set.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetFieldSetOptions Options for modifying the behavior of the function.
     # @return [FieldSet]
     def get_field_set(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default)
@@ -42,9 +42,9 @@ module DocuSign_Rooms
     end
 
     # Get details of a specific field set.
-    # 
-    # @param field_set_id 
-    # @param account_id 
+    # Get details of a specific field set.
+    # @param field_set_id The id of the field set.
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @param DocuSign_Rooms::GetFieldSetOptions Options for modifying the behavior of the function.
     # @return [Array<(FieldSet, Fixnum, Hash)>] FieldSet data, response status code and response headers
     def get_field_set_with_http_info(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default)
@@ -69,6 +69,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/financing_types_api.rb

@@ -22,7 +22,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid financing types.
-    # 
+    # Returns a list of possible financing types
     # @return [GlobalFinancingTypes]
     def get_financing_types()
       data, _status_code, _headers = get_financing_types_with_http_info()
@@ -30,7 +30,7 @@ module DocuSign_Rooms
     end
 
     # Retrieves the list of valid financing types.
-    # 
+    # Returns a list of possible financing types
     # @return [Array<(GlobalFinancingTypes, Fixnum, Hash)>] GlobalFinancingTypes data, response status code and response headers
     def get_financing_types_with_http_info()
       if @api_client.config.debugging
@@ -46,6 +46,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}

data/lib/docusign_rooms/api/form_details_api.rb

@@ -22,9 +22,9 @@ module DocuSign_Rooms
     end
 
     # Gets form based on Id.
-    # 
+    # 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.
     # @param form_id Form ID
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [FormDetails]
     def get_form_details(form_id, account_id)
       data, _status_code, _headers = get_form_details_with_http_info(form_id, account_id)
@@ -32,9 +32,9 @@ module DocuSign_Rooms
     end
 
     # Gets form based on Id.
-    # 
+    # 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.
     # @param form_id Form ID
-    # @param account_id 
+    # @param account_id (Required) The globally unique identifier (GUID) for the account.
     # @return [Array<(FormDetails, Fixnum, Hash)>] FormDetails data, response status code and response headers
     def get_form_details_with_http_info(form_id, account_id)
       if @api_client.config.debugging
@@ -54,6 +54,8 @@ module DocuSign_Rooms
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
 
       # form parameters
       form_params = {}