docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/signer.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,10 +12,13 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class Signer
     # If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.   Maximum Length: 50 characters and it must conform to the account's access code format setting.  If blank, but the signer `accessCode` property is set in the envelope, then that value is used.  If blank and the signer `accessCode` property is not set, then the access code is not required.
     attr_accessor :access_code
 
+    attr_accessor :access_code_metadata
+
     # This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
     attr_accessor :add_access_code_to_email
 
@@ -37,6 +40,9 @@ module DocuSign_eSign
     # Specifies whether the recipient is embedded or remote.   If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true**, an error is generated on sending.ng.   Maximum length: 100 characters. 
     attr_accessor :client_user_id
 
+    # 
+    attr_accessor :completed_count
+
     # 
     attr_accessor :creation_reason
 
@@ -58,16 +64,17 @@ module DocuSign_eSign
     # Reserved: For DocuSign use only.
     attr_accessor :delivery_method
 
+    attr_accessor :delivery_method_metadata
+
     # 
     attr_accessor :document_visibility
 
     # Email id of the recipient. Notification of the document to sign is sent to this email id.   Maximum length: 100 characters. 
     attr_accessor :email
 
-    attr_accessor :email_notification
+    attr_accessor :email_metadata
 
-    # 
-    attr_accessor :email_recipient_post_signing_url
+    attr_accessor :email_notification
 
     # 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
@@ -80,15 +87,23 @@ module DocuSign_eSign
     # Reserved:
     attr_accessor :fax_number
 
+    attr_accessor :fax_number_metadata
+
     # The user's first name.  Maximum Length: 50 characters.
     attr_accessor :first_name
 
+    attr_accessor :first_name_metadata
+
     # 
     attr_accessor :full_name
 
+    attr_accessor :full_name_metadata
+
     # Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.  *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
     attr_accessor :id_check_configuration_name
 
+    attr_accessor :id_check_configuration_name_metadata
+
     attr_accessor :id_check_information_input
 
     attr_accessor :identity_verification
@@ -99,26 +114,41 @@ module DocuSign_eSign
     # When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.   Note that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient.  
     attr_accessor :is_bulk_recipient
 
+    attr_accessor :is_bulk_recipient_metadata
+
     # 
     attr_accessor :last_name
 
+    attr_accessor :last_name_metadata
+
+    # 
+    attr_accessor :locked_recipient_phone_auth_editable
+
+    # 
+    attr_accessor :locked_recipient_sms_editable
+
     # 
     attr_accessor :name
 
+    attr_accessor :name_metadata
+
     # Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.  Maximum Length: 1000 characters.
     attr_accessor :note
 
+    attr_accessor :note_metadata
+
     attr_accessor :offline_attributes
 
     attr_accessor :phone_authentication
 
-    attr_accessor :proof_file
-
     # Reserved:
     attr_accessor :recipient_attachments
 
     attr_accessor :recipient_authentication_status
 
+    # 
+    attr_accessor :recipient_feature_metadata
+
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
     attr_accessor :recipient_id
 
@@ -131,22 +161,32 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_supplies_tabs
 
+    # 
+    attr_accessor :recipient_type
+
+    attr_accessor :recipient_type_metadata
+
     # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. 
     attr_accessor :require_id_lookup
 
+    attr_accessor :require_id_lookup_metadata
+
     # Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are:  * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate.   **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information.   
     attr_accessor :require_signer_certificate
 
     # When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.
     attr_accessor :require_sign_on_paper
 
+    # 
+    attr_accessor :require_upload_signature
+
     # Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
     attr_accessor :role_name
 
     # Specifies the routing order of the recipient in the envelope. 
     attr_accessor :routing_order
 
-    attr_accessor :saml_authentication
+    attr_accessor :routing_order_metadata
 
     # The date and time the envelope was sent.
     attr_accessor :sent_date_time
@@ -159,9 +199,13 @@ module DocuSign_eSign
     # When set to **true**, specifies that the signer must sign in all locations.
     attr_accessor :sign_in_each_location
 
+    attr_accessor :sign_in_each_location_metadata
+
     # When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
     attr_accessor :signing_group_id
 
+    attr_accessor :signing_group_id_metadata
+
     # The display name for the signing group.   Maximum Length: 100 characters. 
     attr_accessor :signing_group_name
 
@@ -176,6 +220,12 @@ module DocuSign_eSign
     # 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.
     attr_accessor :status
 
+    # 
+    attr_accessor :status_code
+
+    # 
+    attr_accessor :suppress_emails
+
     attr_accessor :tabs
 
     # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 
@@ -190,10 +240,12 @@ module DocuSign_eSign
     # 
     attr_accessor :user_id
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'access_code' => :'accessCode',
+        :'access_code_metadata' => :'accessCodeMetadata',
         :'add_access_code_to_email' => :'addAccessCodeToEmail',
         :'agent_can_edit_email' => :'agentCanEditEmail',
         :'agent_can_edit_name' => :'agentCanEditName',
@@ -201,6 +253,7 @@ module DocuSign_eSign
         :'bulk_recipients_uri' => :'bulkRecipientsUri',
         :'can_sign_offline' => :'canSignOffline',
         :'client_user_id' => :'clientUserId',
+        :'completed_count' => :'completedCount',
         :'creation_reason' => :'creationReason',
         :'custom_fields' => :'customFields',
         :'declined_date_time' => :'declinedDateTime',
@@ -208,49 +261,68 @@ module DocuSign_eSign
         :'default_recipient' => :'defaultRecipient',
         :'delivered_date_time' => :'deliveredDateTime',
         :'delivery_method' => :'deliveryMethod',
+        :'delivery_method_metadata' => :'deliveryMethodMetadata',
         :'document_visibility' => :'documentVisibility',
         :'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',
         :'fax_number' => :'faxNumber',
+        :'fax_number_metadata' => :'faxNumberMetadata',
         :'first_name' => :'firstName',
+        :'first_name_metadata' => :'firstNameMetadata',
         :'full_name' => :'fullName',
+        :'full_name_metadata' => :'fullNameMetadata',
         :'id_check_configuration_name' => :'idCheckConfigurationName',
+        :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
         :'id_check_information_input' => :'idCheckInformationInput',
         :'identity_verification' => :'identityVerification',
         :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
         :'is_bulk_recipient' => :'isBulkRecipient',
+        :'is_bulk_recipient_metadata' => :'isBulkRecipientMetadata',
         :'last_name' => :'lastName',
+        :'last_name_metadata' => :'lastNameMetadata',
+        :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
+        :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
         :'name' => :'name',
+        :'name_metadata' => :'nameMetadata',
         :'note' => :'note',
+        :'note_metadata' => :'noteMetadata',
         :'offline_attributes' => :'offlineAttributes',
         :'phone_authentication' => :'phoneAuthentication',
-        :'proof_file' => :'proofFile',
         :'recipient_attachments' => :'recipientAttachments',
         :'recipient_authentication_status' => :'recipientAuthenticationStatus',
+        :'recipient_feature_metadata' => :'recipientFeatureMetadata',
         :'recipient_id' => :'recipientId',
         :'recipient_id_guid' => :'recipientIdGuid',
         :'recipient_signature_providers' => :'recipientSignatureProviders',
         :'recipient_supplies_tabs' => :'recipientSuppliesTabs',
+        :'recipient_type' => :'recipientType',
+        :'recipient_type_metadata' => :'recipientTypeMetadata',
         :'require_id_lookup' => :'requireIdLookup',
+        :'require_id_lookup_metadata' => :'requireIdLookupMetadata',
         :'require_signer_certificate' => :'requireSignerCertificate',
         :'require_sign_on_paper' => :'requireSignOnPaper',
+        :'require_upload_signature' => :'requireUploadSignature',
         :'role_name' => :'roleName',
         :'routing_order' => :'routingOrder',
-        :'saml_authentication' => :'samlAuthentication',
+        :'routing_order_metadata' => :'routingOrderMetadata',
         :'sent_date_time' => :'sentDateTime',
         :'signature_info' => :'signatureInfo',
         :'signed_date_time' => :'signedDateTime',
         :'sign_in_each_location' => :'signInEachLocation',
+        :'sign_in_each_location_metadata' => :'signInEachLocationMetadata',
         :'signing_group_id' => :'signingGroupId',
+        :'signing_group_id_metadata' => :'signingGroupIdMetadata',
         :'signing_group_name' => :'signingGroupName',
         :'signing_group_users' => :'signingGroupUsers',
         :'sms_authentication' => :'smsAuthentication',
         :'social_authentications' => :'socialAuthentications',
         :'status' => :'status',
+        :'status_code' => :'statusCode',
+        :'suppress_emails' => :'suppressEmails',
         :'tabs' => :'tabs',
         :'template_locked' => :'templateLocked',
         :'template_required' => :'templateRequired',
@@ -263,6 +335,7 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'access_code' => :'String',
+        :'access_code_metadata' => :'PropertyMetadata',
         :'add_access_code_to_email' => :'String',
         :'agent_can_edit_email' => :'String',
         :'agent_can_edit_name' => :'String',
@@ -270,6 +343,7 @@ module DocuSign_eSign
         :'bulk_recipients_uri' => :'String',
         :'can_sign_offline' => :'String',
         :'client_user_id' => :'String',
+        :'completed_count' => :'String',
         :'creation_reason' => :'String',
         :'custom_fields' => :'Array<String>',
         :'declined_date_time' => :'String',
@@ -277,49 +351,68 @@ module DocuSign_eSign
         :'default_recipient' => :'String',
         :'delivered_date_time' => :'String',
         :'delivery_method' => :'String',
+        :'delivery_method_metadata' => :'PropertyMetadata',
         :'document_visibility' => :'Array<DocumentVisibility>',
         :'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>',
         :'fax_number' => :'String',
+        :'fax_number_metadata' => :'PropertyMetadata',
         :'first_name' => :'String',
+        :'first_name_metadata' => :'PropertyMetadata',
         :'full_name' => :'String',
+        :'full_name_metadata' => :'PropertyMetadata',
         :'id_check_configuration_name' => :'String',
+        :'id_check_configuration_name_metadata' => :'PropertyMetadata',
         :'id_check_information_input' => :'IdCheckInformationInput',
         :'identity_verification' => :'RecipientIdentityVerification',
         :'inherit_email_notification_configuration' => :'String',
         :'is_bulk_recipient' => :'String',
+        :'is_bulk_recipient_metadata' => :'PropertyMetadata',
         :'last_name' => :'String',
+        :'last_name_metadata' => :'PropertyMetadata',
+        :'locked_recipient_phone_auth_editable' => :'String',
+        :'locked_recipient_sms_editable' => :'String',
         :'name' => :'String',
+        :'name_metadata' => :'PropertyMetadata',
         :'note' => :'String',
+        :'note_metadata' => :'PropertyMetadata',
         :'offline_attributes' => :'OfflineAttributes',
         :'phone_authentication' => :'RecipientPhoneAuthentication',
-        :'proof_file' => :'RecipientProofFile',
         :'recipient_attachments' => :'Array<RecipientAttachment>',
         :'recipient_authentication_status' => :'AuthenticationStatus',
+        :'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
         :'recipient_id' => :'String',
         :'recipient_id_guid' => :'String',
         :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>',
         :'recipient_supplies_tabs' => :'String',
+        :'recipient_type' => :'String',
+        :'recipient_type_metadata' => :'PropertyMetadata',
         :'require_id_lookup' => :'String',
+        :'require_id_lookup_metadata' => :'PropertyMetadata',
         :'require_signer_certificate' => :'String',
         :'require_sign_on_paper' => :'String',
+        :'require_upload_signature' => :'String',
         :'role_name' => :'String',
         :'routing_order' => :'String',
-        :'saml_authentication' => :'RecipientSAMLAuthentication',
+        :'routing_order_metadata' => :'PropertyMetadata',
         :'sent_date_time' => :'String',
         :'signature_info' => :'RecipientSignatureInformation',
         :'signed_date_time' => :'String',
         :'sign_in_each_location' => :'String',
+        :'sign_in_each_location_metadata' => :'PropertyMetadata',
         :'signing_group_id' => :'String',
+        :'signing_group_id_metadata' => :'PropertyMetadata',
         :'signing_group_name' => :'String',
         :'signing_group_users' => :'Array<UserInfo>',
         :'sms_authentication' => :'RecipientSMSAuthentication',
         :'social_authentications' => :'Array<SocialAuthentication>',
         :'status' => :'String',
+        :'status_code' => :'String',
+        :'suppress_emails' => :'String',
         :'tabs' => :'Tabs',
         :'template_locked' => :'String',
         :'template_required' => :'String',
@@ -334,12 +427,16 @@ module DocuSign_eSign
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'accessCode')
         self.access_code = attributes[:'accessCode']
       end
 
+      if attributes.has_key?(:'accessCodeMetadata')
+        self.access_code_metadata = attributes[:'accessCodeMetadata']
+      end
+
       if attributes.has_key?(:'addAccessCodeToEmail')
         self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
       end
@@ -368,6 +465,10 @@ module DocuSign_eSign
         self.client_user_id = attributes[:'clientUserId']
       end
 
+      if attributes.has_key?(:'completedCount')
+        self.completed_count = attributes[:'completedCount']
+      end
+
       if attributes.has_key?(:'creationReason')
         self.creation_reason = attributes[:'creationReason']
       end
@@ -398,6 +499,10 @@ module DocuSign_eSign
         self.delivery_method = attributes[:'deliveryMethod']
       end
 
+      if attributes.has_key?(:'deliveryMethodMetadata')
+        self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
+      end
+
       if attributes.has_key?(:'documentVisibility')
         if (value = attributes[:'documentVisibility']).is_a?(Array)
           self.document_visibility = value
@@ -408,12 +513,12 @@ module DocuSign_eSign
         self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'emailNotification')
-        self.email_notification = attributes[:'emailNotification']
+      if attributes.has_key?(:'emailMetadata')
+        self.email_metadata = attributes[:'emailMetadata']
       end
 
-      if attributes.has_key?(:'emailRecipientPostSigningURL')
-        self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
+      if attributes.has_key?(:'emailNotification')
+        self.email_notification = attributes[:'emailNotification']
       end
 
       if attributes.has_key?(:'embeddedRecipientStartURL')
@@ -434,18 +539,34 @@ module DocuSign_eSign
         self.fax_number = attributes[:'faxNumber']
       end
 
+      if attributes.has_key?(:'faxNumberMetadata')
+        self.fax_number_metadata = attributes[:'faxNumberMetadata']
+      end
+
       if attributes.has_key?(:'firstName')
         self.first_name = attributes[:'firstName']
       end
 
+      if attributes.has_key?(:'firstNameMetadata')
+        self.first_name_metadata = attributes[:'firstNameMetadata']
+      end
+
       if attributes.has_key?(:'fullName')
         self.full_name = attributes[:'fullName']
       end
 
+      if attributes.has_key?(:'fullNameMetadata')
+        self.full_name_metadata = attributes[:'fullNameMetadata']
+      end
+
       if attributes.has_key?(:'idCheckConfigurationName')
         self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
       end
 
+      if attributes.has_key?(:'idCheckConfigurationNameMetadata')
+        self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
+      end
+
       if attributes.has_key?(:'idCheckInformationInput')
         self.id_check_information_input = attributes[:'idCheckInformationInput']
       end
@@ -462,18 +583,42 @@ module DocuSign_eSign
         self.is_bulk_recipient = attributes[:'isBulkRecipient']
       end
 
+      if attributes.has_key?(:'isBulkRecipientMetadata')
+        self.is_bulk_recipient_metadata = attributes[:'isBulkRecipientMetadata']
+      end
+
       if attributes.has_key?(:'lastName')
         self.last_name = attributes[:'lastName']
       end
 
+      if attributes.has_key?(:'lastNameMetadata')
+        self.last_name_metadata = attributes[:'lastNameMetadata']
+      end
+
+      if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
+        self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
+      end
+
+      if attributes.has_key?(:'lockedRecipientSmsEditable')
+        self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'nameMetadata')
+        self.name_metadata = attributes[:'nameMetadata']
+      end
+
       if attributes.has_key?(:'note')
         self.note = attributes[:'note']
       end
 
+      if attributes.has_key?(:'noteMetadata')
+        self.note_metadata = attributes[:'noteMetadata']
+      end
+
       if attributes.has_key?(:'offlineAttributes')
         self.offline_attributes = attributes[:'offlineAttributes']
       end
@@ -482,10 +627,6 @@ module DocuSign_eSign
         self.phone_authentication = attributes[:'phoneAuthentication']
       end
 
-      if attributes.has_key?(:'proofFile')
-        self.proof_file = attributes[:'proofFile']
-      end
-
       if attributes.has_key?(:'recipientAttachments')
         if (value = attributes[:'recipientAttachments']).is_a?(Array)
           self.recipient_attachments = value
@@ -496,6 +637,12 @@ module DocuSign_eSign
         self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
       end
 
+      if attributes.has_key?(:'recipientFeatureMetadata')
+        if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
+          self.recipient_feature_metadata = value
+        end
+      end
+
       if attributes.has_key?(:'recipientId')
         self.recipient_id = attributes[:'recipientId']
       end
@@ -514,10 +661,22 @@ module DocuSign_eSign
         self.recipient_supplies_tabs = attributes[:'recipientSuppliesTabs']
       end
 
+      if attributes.has_key?(:'recipientType')
+        self.recipient_type = attributes[:'recipientType']
+      end
+
+      if attributes.has_key?(:'recipientTypeMetadata')
+        self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
+      end
+
       if attributes.has_key?(:'requireIdLookup')
         self.require_id_lookup = attributes[:'requireIdLookup']
       end
 
+      if attributes.has_key?(:'requireIdLookupMetadata')
+        self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
+      end
+
       if attributes.has_key?(:'requireSignerCertificate')
         self.require_signer_certificate = attributes[:'requireSignerCertificate']
       end
@@ -526,6 +685,10 @@ module DocuSign_eSign
         self.require_sign_on_paper = attributes[:'requireSignOnPaper']
       end
 
+      if attributes.has_key?(:'requireUploadSignature')
+        self.require_upload_signature = attributes[:'requireUploadSignature']
+      end
+
       if attributes.has_key?(:'roleName')
         self.role_name = attributes[:'roleName']
       end
@@ -534,8 +697,8 @@ module DocuSign_eSign
         self.routing_order = attributes[:'routingOrder']
       end
 
-      if attributes.has_key?(:'samlAuthentication')
-        self.saml_authentication = attributes[:'samlAuthentication']
+      if attributes.has_key?(:'routingOrderMetadata')
+        self.routing_order_metadata = attributes[:'routingOrderMetadata']
       end
 
       if attributes.has_key?(:'sentDateTime')
@@ -554,10 +717,18 @@ module DocuSign_eSign
         self.sign_in_each_location = attributes[:'signInEachLocation']
       end
 
+      if attributes.has_key?(:'signInEachLocationMetadata')
+        self.sign_in_each_location_metadata = attributes[:'signInEachLocationMetadata']
+      end
+
       if attributes.has_key?(:'signingGroupId')
         self.signing_group_id = attributes[:'signingGroupId']
       end
 
+      if attributes.has_key?(:'signingGroupIdMetadata')
+        self.signing_group_id_metadata = attributes[:'signingGroupIdMetadata']
+      end
+
       if attributes.has_key?(:'signingGroupName')
         self.signing_group_name = attributes[:'signingGroupName']
       end
@@ -582,6 +753,14 @@ module DocuSign_eSign
         self.status = attributes[:'status']
       end
 
+      if attributes.has_key?(:'statusCode')
+        self.status_code = attributes[:'statusCode']
+      end
+
+      if attributes.has_key?(:'suppressEmails')
+        self.suppress_emails = attributes[:'suppressEmails']
+      end
+
       if attributes.has_key?(:'tabs')
         self.tabs = attributes[:'tabs']
       end
@@ -601,19 +780,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'userId')
         self.user_id = attributes[:'userId']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -622,6 +802,7 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           access_code == o.access_code &&
+          access_code_metadata == o.access_code_metadata &&
           add_access_code_to_email == o.add_access_code_to_email &&
           agent_can_edit_email == o.agent_can_edit_email &&
           agent_can_edit_name == o.agent_can_edit_name &&
@@ -629,6 +810,7 @@ module DocuSign_eSign
           bulk_recipients_uri == o.bulk_recipients_uri &&
           can_sign_offline == o.can_sign_offline &&
           client_user_id == o.client_user_id &&
+          completed_count == o.completed_count &&
           creation_reason == o.creation_reason &&
           custom_fields == o.custom_fields &&
           declined_date_time == o.declined_date_time &&
@@ -636,49 +818,68 @@ module DocuSign_eSign
           default_recipient == o.default_recipient &&
           delivered_date_time == o.delivered_date_time &&
           delivery_method == o.delivery_method &&
+          delivery_method_metadata == o.delivery_method_metadata &&
           document_visibility == o.document_visibility &&
           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 &&
           fax_number == o.fax_number &&
+          fax_number_metadata == o.fax_number_metadata &&
           first_name == o.first_name &&
+          first_name_metadata == o.first_name_metadata &&
           full_name == o.full_name &&
+          full_name_metadata == o.full_name_metadata &&
           id_check_configuration_name == o.id_check_configuration_name &&
+          id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
           id_check_information_input == o.id_check_information_input &&
           identity_verification == o.identity_verification &&
           inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
           is_bulk_recipient == o.is_bulk_recipient &&
+          is_bulk_recipient_metadata == o.is_bulk_recipient_metadata &&
           last_name == o.last_name &&
+          last_name_metadata == o.last_name_metadata &&
+          locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
+          locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
           name == o.name &&
+          name_metadata == o.name_metadata &&
           note == o.note &&
+          note_metadata == o.note_metadata &&
           offline_attributes == o.offline_attributes &&
           phone_authentication == o.phone_authentication &&
-          proof_file == o.proof_file &&
           recipient_attachments == o.recipient_attachments &&
           recipient_authentication_status == o.recipient_authentication_status &&
+          recipient_feature_metadata == o.recipient_feature_metadata &&
           recipient_id == o.recipient_id &&
           recipient_id_guid == o.recipient_id_guid &&
           recipient_signature_providers == o.recipient_signature_providers &&
           recipient_supplies_tabs == o.recipient_supplies_tabs &&
+          recipient_type == o.recipient_type &&
+          recipient_type_metadata == o.recipient_type_metadata &&
           require_id_lookup == o.require_id_lookup &&
+          require_id_lookup_metadata == o.require_id_lookup_metadata &&
           require_signer_certificate == o.require_signer_certificate &&
           require_sign_on_paper == o.require_sign_on_paper &&
+          require_upload_signature == o.require_upload_signature &&
           role_name == o.role_name &&
           routing_order == o.routing_order &&
-          saml_authentication == o.saml_authentication &&
+          routing_order_metadata == o.routing_order_metadata &&
           sent_date_time == o.sent_date_time &&
           signature_info == o.signature_info &&
           signed_date_time == o.signed_date_time &&
           sign_in_each_location == o.sign_in_each_location &&
+          sign_in_each_location_metadata == o.sign_in_each_location_metadata &&
           signing_group_id == o.signing_group_id &&
+          signing_group_id_metadata == o.signing_group_id_metadata &&
           signing_group_name == o.signing_group_name &&
           signing_group_users == o.signing_group_users &&
           sms_authentication == o.sms_authentication &&
           social_authentications == o.social_authentications &&
           status == o.status &&
+          status_code == o.status_code &&
+          suppress_emails == o.suppress_emails &&
           tabs == o.tabs &&
           template_locked == o.template_locked &&
           template_required == o.template_required &&
@@ -695,7 +896,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, last_name, name, note, offline_attributes, phone_authentication, proof_file, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, sign_in_each_location, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id].hash
+      [access_code, access_code_metadata, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, delivery_method_metadata, 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, note, note_metadata, offline_attributes, phone_authentication, 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
@@ -705,10 +906,10 @@ module DocuSign_eSign
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
+          # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -790,7 +991,7 @@ module DocuSign_eSign
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -803,4 +1004,5 @@ module DocuSign_eSign
     end
 
   end
+
 end