docusign_click 1.2.2 → 1.3.0

data/lib/docusign_click/models/clickwrap_version_summary_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,48 +13,49 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapVersionSummaryResponse
-    # 
+    # The external account number (int) or account ID GUID.
     attr_accessor :account_id
 
-    # 
+    # The ID of the clickwrap.
     attr_accessor :clickwrap_id
 
-    # 
+    # The name of the clickwrap.
     attr_accessor :clickwrap_name
 
-    # 
+    # The unique version ID, a GUID, of this clickwrap version.
     attr_accessor :clickwrap_version_id
 
-    # 
+    # The time that the clickwrap was created.
     attr_accessor :created_time
 
-    # 
+    # The list of all the data fields available for the clickwrap (custom fields and standard fields).
     attr_accessor :data_fields
 
-    # 
+    # The time that the clickwrap was last modified.
     attr_accessor :last_modified
 
-    # 
+    # The user ID of the last user who modified this clickwrap.
     attr_accessor :last_modified_by
 
-    # 
+    # The user ID of the owner of this clickwrap.
     attr_accessor :owner_user_id
 
-    # 
+    # When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
     attr_accessor :require_reacceptance
 
-    # 
+    # The time and date when this clickwrap is activated.
     attr_accessor :scheduled_date
 
+    # Specifies the interval between reacceptances in days, weeks, months, or years.
     attr_accessor :scheduled_reacceptance
 
-    # 
+    # Clickwrap status. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
-    # 
+    # The ID of the version.
     attr_accessor :version_id
 
-    # 
+    # Version of the clickwrap.
     attr_accessor :version_number
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_versions_delete_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,13 +13,13 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapVersionsDeleteResponse
-    # 
+    # The ID of the clickwrap.
     attr_accessor :clickwrap_id
 
-    # 
+    # The name of the clickwrap.
     attr_accessor :clickwrap_name
 
-    # 
+    # An array of delete responses.
     attr_accessor :versions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_versions_paged_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,26 +12,27 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # The results are paginated. Use the following properties to navigate the pages.  - `page`: The page number of the current results. - `pageSize`: The number of results in the current page. - `minimumPagesRemaining`: The number of pages that follow this one.  
   class ClickwrapVersionsPagedResponse
-    # 
+    # The external account number (int) or account ID GUID.
     attr_accessor :account_id
 
-    # 
+    # The ID of the clickwrap.
     attr_accessor :clickwrap_id
 
-    # 
+    # The name of the clickwrap.
     attr_accessor :clickwrap_name
 
-    # 
+    # An array of clickwrap versions.
     attr_accessor :minimum_pages_remaining
 
-    # 
+    # The number of the current page.
     attr_accessor :page
 
-    # 
+    # The number of items per page.
     attr_accessor :page_size
 
-    # 
+    # An array of clickwrap versions.
     attr_accessor :versions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_versions_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,17 +12,18 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # The results are paginated. Use the following properties to navigate the pages. Use the `page_number` query parameter to specify a page.  - `page`: The page number of the current results. - `pageSize`: The number of results in the current page. - `minimumPagesRemaining`: The number of pages that follow this one. 
   class ClickwrapVersionsResponse
-    # 
+    # An array of `clickwrapVersionSummaryResponse` objects.
     attr_accessor :clickwraps
 
-    # 
+    # Number of pages remaining in the response.
     attr_accessor :minimum_pages_remaining
 
-    # 
+    # The number of the current page.
     attr_accessor :page
 
-    # 
+    # The number of items per page.
     attr_accessor :page_size
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwraps_delete_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,7 +13,7 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapsDeleteResponse
-    # 
+    # An array of clickwrap deletion results.
     attr_accessor :clickwraps
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/data_field.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com

data/lib/docusign_click/models/display_settings.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,59 +12,60 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Information about how an agreement is displayed.
   class DisplaySettings
-    # 
+    # Position of the Accept button in the agreement. One of   - `right` - `left` 
     attr_accessor :action_button_alignment
 
-    # 
+    # When **true,** this agreement can be be used in client-only integrations.
     attr_accessor :allow_client_only
 
-    # 
+    # Hosts that can host the clickwrap.  It is an error if the clickwrap didn't come from one of these hosts. 
     attr_accessor :allowed_hosts
 
-    # 
+    # The signing brand ID.
     attr_accessor :brand_id
 
-    # 
+    # Text on the agree button.
     attr_accessor :consent_button_text
 
-    # 
+    # The statement prefixing the Electronic Record and Signature Disclosure agreement.
     attr_accessor :consent_text
 
-    # 
+    # The text on the decline button.
     attr_accessor :decline_button_text
 
-    # 
+    # The display name of the user agreement.
     attr_accessor :display_name
 
-    # 
+    # Display type: link, document or pdf
     attr_accessor :document_display
 
-    # 
+    # **True** if the agreement is downloadable.
     attr_accessor :downloadable
 
-    # 
+    # Display format: inline or modal.
     attr_accessor :format
 
-    # 
+    # **True** if the agreement has a decline button.
     attr_accessor :has_decline_button
 
-    # 
+    # **True** if the user needs to scroll to the end of the document.
     attr_accessor :must_read
 
-    # 
+    # **True** if the user must view the document.
     attr_accessor :must_view
 
-    # 
+    # When **true,** this agreement records decline actions.
     attr_accessor :record_decline_responses
 
-    # 
+    # **True** if a checkbox is required to accept.
     attr_accessor :require_accept
 
-    # 
+    # **True** if send to email is applicable.
     attr_accessor :send_to_email
 
-    # 
+    # Position of the agreement statement. One of   - `top` - `bottom` 
     attr_accessor :statement_alignment
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/document.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,29 +12,30 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Information about a document.
   class Document
-    # 
+    # The base64-encoded contents of the document.
     attr_accessor :document_base64
 
-    # 
+    # Display type: link, document or pdf
     attr_accessor :document_display
 
-    # 
+    # The HTML representation of the document.
     attr_accessor :document_html
 
-    # 
+    # The name of the document.
     attr_accessor :document_name
 
-    # 
+    # The file extension of the document.
     attr_accessor :file_extension
 
-    # 
+    # **True** if the user needs to scroll to the end of the document.
     attr_accessor :must_read
 
-    # 
+    # **True** if the user must view the document.
     attr_accessor :must_view
 
-    # 
+    # The order of document layout.
     attr_accessor :order
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/error_details.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,11 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Error details.
   class ErrorDetails
-    # 
+    # The error code.
     attr_accessor :error_code
 
-    # 
+    # The error message.
     attr_accessor :message
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/service_information.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,22 +13,22 @@ require 'date'
 
 module DocuSign_Click
   class ServiceInformation
-    # 
+    # The internal source control branch.
     attr_accessor :build_branch
 
-    # 
+    # The date-time this branch was deployed.
     attr_accessor :build_branch_deployed_date_time
 
-    # 
+    # The internal source control SHA.
     attr_accessor :build_sha
 
-    # 
+    # The internal build version information.
     attr_accessor :build_version
 
-    # 
+    # An array of URLs (strings) of related sites.
     attr_accessor :linked_sites
 
-    # 
+    # An array of `serviceVersion` objects.
     attr_accessor :service_versions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/service_version.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,10 +13,10 @@ require 'date'
 
 module DocuSign_Click
   class ServiceVersion
-    # 
+    # The human-readable semver version string.
     attr_accessor :version
 
-    # 
+    # The URL where this version of the API can be found.
     attr_accessor :version_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/user_agreement_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,22 +12,27 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Data used to create the agreement.
   class UserAgreementRequest
-    # 
+    # A unique value that identifies a user. You can use anything that your system uses to identify unique users, such as employee IDs, email addresses, and surrogate keys as the value of `clientUserId`.  A clickwrap with a specific `clientUserId` will not appear again once it has been accepted. 
     attr_accessor :client_user_id
 
-    # 
+    # This property specifies the data used to create a clickwrap with [dynamic content][].    [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content 
     attr_accessor :document_data
 
-    # 
+    # A customer-defined string you can use in requests. This string will appear in the corresponding response.
     attr_accessor :metadata
 
+    # The URL to redirect to after the agreement is complete when the agreement is not rendered in an iframe.
+    attr_accessor :return_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_user_id' => :'clientUserId',
         :'document_data' => :'documentData',
-        :'metadata' => :'metadata'
+        :'metadata' => :'metadata',
+        :'return_url' => :'returnUrl'
       }
     end
 
@@ -36,7 +41,8 @@ module DocuSign_Click
       {
         :'client_user_id' => :'String',
         :'document_data' => :'Hash<String, String>',
-        :'metadata' => :'String'
+        :'metadata' => :'String',
+        :'return_url' => :'String'
       }
     end
 
@@ -61,6 +67,10 @@ module DocuSign_Click
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
+
+      if attributes.has_key?(:'returnUrl')
+        self.return_url = attributes[:'returnUrl']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -83,7 +93,8 @@ module DocuSign_Click
       self.class == o.class &&
           client_user_id == o.client_user_id &&
           document_data == o.document_data &&
-          metadata == o.metadata
+          metadata == o.metadata &&
+          return_url == o.return_url
     end
 
     # @see the `==` method
@@ -95,7 +106,7 @@ module DocuSign_Click
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [client_user_id, document_data, metadata].hash
+      [client_user_id, document_data, metadata, return_url].hash
     end
 
     # Builds the object from hash