docusign_esign 3.14.0 → 3.15.0

data/lib/docusign_esign/models/radio_group.rb

@@ -33,6 +33,11 @@ module DocuSign_eSign
 
     attr_accessor :group_name_metadata
 
+    # The initial value of the tab when it was sent to the recipient. 
+    attr_accessor :original_value
+
+    attr_accessor :original_value_metadata
+
     # Specifies the locations and status for radio buttons that are grouped together.
     attr_accessor :radios
 
@@ -86,6 +91,11 @@ module DocuSign_eSign
 
     attr_accessor :tooltip_metadata
 
+    # Specifies the value of the tab. 
+    attr_accessor :value
+
+    attr_accessor :value_metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -97,6 +107,8 @@ module DocuSign_eSign
         :'document_id_metadata' => :'documentIdMetadata',
         :'group_name' => :'groupName',
         :'group_name_metadata' => :'groupNameMetadata',
+        :'original_value' => :'originalValue',
+        :'original_value_metadata' => :'originalValueMetadata',
         :'radios' => :'radios',
         :'recipient_id' => :'recipientId',
         :'recipient_id_guid' => :'recipientIdGuid',
@@ -117,7 +129,9 @@ module DocuSign_eSign
         :'template_required' => :'templateRequired',
         :'template_required_metadata' => :'templateRequiredMetadata',
         :'tooltip' => :'tooltip',
-        :'tooltip_metadata' => :'tooltipMetadata'
+        :'tooltip_metadata' => :'tooltipMetadata',
+        :'value' => :'value',
+        :'value_metadata' => :'valueMetadata'
       }
     end
 
@@ -132,6 +146,8 @@ module DocuSign_eSign
         :'document_id_metadata' => :'PropertyMetadata',
         :'group_name' => :'String',
         :'group_name_metadata' => :'PropertyMetadata',
+        :'original_value' => :'String',
+        :'original_value_metadata' => :'PropertyMetadata',
         :'radios' => :'Array<Radio>',
         :'recipient_id' => :'String',
         :'recipient_id_guid' => :'String',
@@ -152,7 +168,9 @@ module DocuSign_eSign
         :'template_required' => :'String',
         :'template_required_metadata' => :'PropertyMetadata',
         :'tooltip' => :'String',
-        :'tooltip_metadata' => :'PropertyMetadata'
+        :'tooltip_metadata' => :'PropertyMetadata',
+        :'value' => :'String',
+        :'value_metadata' => :'PropertyMetadata'
       }
     end
 
@@ -196,6 +214,14 @@ module DocuSign_eSign
         self.group_name_metadata = attributes[:'groupNameMetadata']
       end
 
+      if attributes.has_key?(:'originalValue')
+        self.original_value = attributes[:'originalValue']
+      end
+
+      if attributes.has_key?(:'originalValueMetadata')
+        self.original_value_metadata = attributes[:'originalValueMetadata']
+      end
+
       if attributes.has_key?(:'radios')
         if (value = attributes[:'radios']).is_a?(Array)
           self.radios = value
@@ -281,6 +307,14 @@ module DocuSign_eSign
       if attributes.has_key?(:'tooltipMetadata')
         self.tooltip_metadata = attributes[:'tooltipMetadata']
       end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.has_key?(:'valueMetadata')
+        self.value_metadata = attributes[:'valueMetadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -309,6 +343,8 @@ module DocuSign_eSign
           document_id_metadata == o.document_id_metadata &&
           group_name == o.group_name &&
           group_name_metadata == o.group_name_metadata &&
+          original_value == o.original_value &&
+          original_value_metadata == o.original_value_metadata &&
           radios == o.radios &&
           recipient_id == o.recipient_id &&
           recipient_id_guid == o.recipient_id_guid &&
@@ -329,7 +365,9 @@ module DocuSign_eSign
           template_required == o.template_required &&
           template_required_metadata == o.template_required_metadata &&
           tooltip == o.tooltip &&
-          tooltip_metadata == o.tooltip_metadata
+          tooltip_metadata == o.tooltip_metadata &&
+          value == o.value &&
+          value_metadata == o.value_metadata
     end
 
     # @see the `==` method
@@ -341,7 +379,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, document_id, document_id_metadata, group_name, group_name_metadata, radios, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tooltip_metadata].hash
+      [conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, document_id, document_id_metadata, group_name, group_name_metadata, original_value, original_value_metadata, radios, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tooltip_metadata, value, value_metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/scheduled_sending_api_model.rb

@@ -13,21 +13,21 @@ require 'date'
 
 module DocuSign_eSign
   class ScheduledSendingApiModel
-    # 
+    # An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent or null if the envelope has not yet been sent.
     attr_accessor :resume_date
 
-    # 
+    # A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.
     attr_accessor :rules
 
-    # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
+    # \"pending\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \"started\" if the scheduled sending delay is in progress. \"completed\" if the scheduled sending delay has elapsed and the envelope has been sent.
     attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'resume_date' => :'ResumeDate',
-        :'rules' => :'Rules',
-        :'status' => :'Status'
+        :'resume_date' => :'resumeDate',
+        :'rules' => :'rules',
+        :'status' => :'status'
       }
     end
 
@@ -48,18 +48,18 @@ module DocuSign_eSign
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'ResumeDate')
-        self.resume_date = attributes[:'ResumeDate']
+      if attributes.has_key?(:'resumeDate')
+        self.resume_date = attributes[:'resumeDate']
       end
 
-      if attributes.has_key?(:'Rules')
-        if (value = attributes[:'Rules']).is_a?(Array)
+      if attributes.has_key?(:'rules')
+        if (value = attributes[:'rules']).is_a?(Array)
           self.rules = value
         end
       end
 
-      if attributes.has_key?(:'Status')
-        self.status = attributes[:'Status']
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
       end
     end
 

data/lib/docusign_esign/models/signer.rb

@@ -95,6 +95,9 @@ module DocuSign_eSign
 
     attr_accessor :email_notification
 
+    # 
+    attr_accessor :email_recipient_post_signing_url
+
     # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.   If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.  It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.  If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.   *Example*:   `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` 
     attr_accessor :embedded_recipient_start_url
 
@@ -301,6 +304,7 @@ module DocuSign_eSign
         :'email' => :'email',
         :'email_metadata' => :'emailMetadata',
         :'email_notification' => :'emailNotification',
+        :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
         :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
         :'error_details' => :'errorDetails',
         :'excluded_documents' => :'excludedDocuments',
@@ -402,6 +406,7 @@ module DocuSign_eSign
         :'email' => :'String',
         :'email_metadata' => :'PropertyMetadata',
         :'email_notification' => :'RecipientEmailNotification',
+        :'email_recipient_post_signing_url' => :'String',
         :'embedded_recipient_start_url' => :'String',
         :'error_details' => :'ErrorDetails',
         :'excluded_documents' => :'Array<String>',
@@ -603,6 +608,10 @@ module DocuSign_eSign
         self.email_notification = attributes[:'emailNotification']
       end
 
+      if attributes.has_key?(:'emailRecipientPostSigningURL')
+        self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
+      end
+
       if attributes.has_key?(:'embeddedRecipientStartURL')
         self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
       end
@@ -927,6 +936,7 @@ module DocuSign_eSign
           email == o.email &&
           email_metadata == o.email_metadata &&
           email_notification == o.email_notification &&
+          email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
           embedded_recipient_start_url == o.embedded_recipient_start_url &&
           error_details == o.error_details &&
           excluded_documents == o.excluded_documents &&
@@ -1004,7 +1014,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
+      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/witness.rb

@@ -95,6 +95,9 @@ module DocuSign_eSign
 
     attr_accessor :email_notification
 
+    # 
+    attr_accessor :email_recipient_post_signing_url
+
     # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.   If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.  It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.  If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.   *Example*:   `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` 
     attr_accessor :embedded_recipient_start_url
 
@@ -307,6 +310,7 @@ module DocuSign_eSign
         :'email' => :'email',
         :'email_metadata' => :'emailMetadata',
         :'email_notification' => :'emailNotification',
+        :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
         :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
         :'error_details' => :'errorDetails',
         :'excluded_documents' => :'excludedDocuments',
@@ -410,6 +414,7 @@ module DocuSign_eSign
         :'email' => :'String',
         :'email_metadata' => :'PropertyMetadata',
         :'email_notification' => :'RecipientEmailNotification',
+        :'email_recipient_post_signing_url' => :'String',
         :'embedded_recipient_start_url' => :'String',
         :'error_details' => :'ErrorDetails',
         :'excluded_documents' => :'Array<String>',
@@ -613,6 +618,10 @@ module DocuSign_eSign
         self.email_notification = attributes[:'emailNotification']
       end
 
+      if attributes.has_key?(:'emailRecipientPostSigningURL')
+        self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
+      end
+
       if attributes.has_key?(:'embeddedRecipientStartURL')
         self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
       end
@@ -945,6 +954,7 @@ module DocuSign_eSign
           email == o.email &&
           email_metadata == o.email_metadata &&
           email_notification == o.email_notification &&
+          email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
           embedded_recipient_start_url == o.embedded_recipient_start_url &&
           error_details == o.error_details &&
           excluded_documents == o.excluded_documents &&
@@ -1024,7 +1034,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
+      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/version.rb

@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module DocuSign_eSign
-  VERSION = '3.14.0'
+  VERSION = '3.15.0'
 end

data/lib/docusign_esign.rb

@@ -113,6 +113,7 @@ require 'docusign_esign/models/bulk_recipients_request'
 require 'docusign_esign/models/bulk_recipients_response'
 require 'docusign_esign/models/bulk_recipients_summary_response'
 require 'docusign_esign/models/bulk_recipients_update_response'
+require 'docusign_esign/models/bulk_send_batch_action_request'
 require 'docusign_esign/models/bulk_send_batch_error'
 require 'docusign_esign/models/bulk_send_batch_request'
 require 'docusign_esign/models/bulk_send_batch_status'