docusign_esign 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3726dc51d47aec791ccff297932417da726e2906518ef61b32518372de2c46f2
-  data.tar.gz: 6ea3e16488afdf2e4c1c1a8bdbd530c5c0d0404b09c63b8ce7f701bafb4739a2
+  metadata.gz: 98b3242e6d94f473aa2c047a16339235a963359c584685f546ae680ca026f991
+  data.tar.gz: 3b7a1128e7e8e279a83e61eb576701f6bcc5a87277765396c0499bdc862d7681
 SHA512:
-  metadata.gz: b8e5b50493b7248eafb0b52e1eecaa9904f388d5a1d5c9c096eca25ca88d62a6a899e1aed04d051543d65b2102b085cdf3870c0a0821b0ba1ff9a97337502140
-  data.tar.gz: 3084af308302d5d80086e4b8711a99c98a51f787de62480db2401d49d8f55f3afcf79c8e82b47a1b117f4133241f185e7d89442569ca04117e9f0639453f2427
+  metadata.gz: 36efcee69919d028304748affaba7eca7392eb0dd95aaac12148df8579a3906353ca0274740358aa38a207b90898f0d6f70f2d7fe140bbdbee8a19d98587257b
+  data.tar.gz: 29553be78d24f4d17d8784d16b626e6fe3aa20c411143dea43ef8703625e3a63297187fd493404e762f7a5a40bdc19b263073a5a244dc36b6dbc5ba877891043

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v3.15.0] - eSignature API v2.1-21.4.02.00 - 2022-02-08
+### Changed
+- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v3.14.0] - eSignature API v2.1-21.4.01.00 - 2022-01-06
 ### Changed
 - Added support for version v2.1-21.4.01.00 of the DocuSign ESignature API.

data/lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -560,6 +560,65 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Initiate a specific bulk send batch action
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_action 
+    # @param bulk_send_batch_id 
+    # @param bulk_send_batch_action_request  (optional parameter)
+    # @return [BulkSendBatchStatus]
+    def update_bulk_send_batch_action(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
+      data, _status_code, _headers = update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id,  bulk_send_batch_action_request)
+      return data
+    end
+
+    # Initiate a specific bulk send batch action
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_action 
+    # @param bulk_send_batch_id 
+    # @param bulk_send_batch_action_request  (optional parameter)
+    # @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
+    def update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_action ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if account_id.nil?
+      # verify the required parameter 'bulk_action' is set
+      fail ArgumentError, "Missing the required parameter 'bulk_action' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if bulk_action.nil?
+      # verify the required parameter 'bulk_send_batch_id' is set
+      fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if bulk_send_batch_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkAction' + '}', bulk_action.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(bulk_send_batch_action_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BulkSendBatchStatus')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Put/Update a specific bulk send batch status
     # 
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/client/api_client.rb

@@ -35,7 +35,7 @@ module DocuSign_eSign
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/3.14.0/ruby"
+      @user_agent = "Swagger-Codegen/3.15.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/docusign_esign/models/account_settings_information.rb

@@ -116,7 +116,7 @@ module DocuSign_eSign
 
     attr_accessor :allow_data_download_metadata
 
-    # 
+    # \"true\" if the account has permission to use the delayed routing feature to insert delays before routing an envelope to a recipient, \"false\" otherwise.
     attr_accessor :allow_delayed_routing
 
     attr_accessor :allow_delayed_routing_metadata
@@ -351,7 +351,7 @@ module DocuSign_eSign
 
     attr_accessor :allow_safe_bio_pharma_signer_certificate_metadata
 
-    # 
+    # \"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise.
     attr_accessor :allow_scheduled_sending
 
     attr_accessor :allow_scheduled_sending_metadata

data/lib/docusign_esign/models/agent.rb

@@ -70,6 +70,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
 
@@ -228,6 +231,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',
@@ -305,6 +309,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>',
@@ -453,6 +458,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
@@ -706,6 +715,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 &&
@@ -768,7 +778,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, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
+      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/bulk_send_batch_action_request.rb

@@ -0,0 +1,203 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class BulkSendBatchActionRequest
+    # 
+    attr_accessor :action
+
+    attr_accessor :notification
+
+    # 
+    attr_accessor :void_reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'notification' => :'notification',
+        :'void_reason' => :'voidReason'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'action' => :'String',
+        :'notification' => :'Notification',
+        :'void_reason' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      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 }
+
+      if attributes.has_key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'notification')
+        self.notification = attributes[:'notification']
+      end
+
+      if attributes.has_key?(:'voidReason')
+        self.void_reason = attributes[:'voidReason']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          action == o.action &&
+          notification == o.notification &&
+          void_reason == o.void_reason
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [action, notification, void_reason].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      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
+          # 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_eSign.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_esign/models/bulk_send_batch_status.rb

@@ -13,6 +13,12 @@ require 'date'
 
 module DocuSign_eSign
   class BulkSendBatchStatus
+    # 
+    attr_accessor :action
+
+    # 
+    attr_accessor :action_status
+
     # 
     attr_accessor :batch_id
 
@@ -60,6 +66,8 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'action' => :'action',
+        :'action_status' => :'actionStatus',
         :'batch_id' => :'batchId',
         :'batch_name' => :'batchName',
         :'batch_size' => :'batchSize',
@@ -81,6 +89,8 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'action' => :'String',
+        :'action_status' => :'String',
         :'batch_id' => :'String',
         :'batch_name' => :'String',
         :'batch_size' => :'String',
@@ -107,6 +117,14 @@ 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?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'actionStatus')
+        self.action_status = attributes[:'actionStatus']
+      end
+
       if attributes.has_key?(:'batchId')
         self.batch_id = attributes[:'batchId']
       end
@@ -188,6 +206,8 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          action == o.action &&
+          action_status == o.action_status &&
           batch_id == o.batch_id &&
           batch_name == o.batch_name &&
           batch_size == o.batch_size &&
@@ -214,7 +234,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash
+      [action, action_status, batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/carbon_copy.rb

@@ -75,6 +75,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
 
@@ -242,6 +245,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',
@@ -324,6 +328,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>',
@@ -483,6 +488,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
@@ -750,6 +759,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 &&
@@ -815,7 +825,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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, 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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, 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/certified_delivery.rb

@@ -75,6 +75,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
 
@@ -237,6 +240,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',
@@ -317,6 +321,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>',
@@ -474,6 +479,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
@@ -733,6 +742,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 &&
@@ -796,7 +806,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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, 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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
     end
 
     # Builds the object from hash