docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/envelope_definition.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Envelope object definition.
   class EnvelopeDefinition
     # 
     attr_accessor :access_control_list_base64
@@ -76,6 +77,7 @@ module DocuSign_eSign
     # Indicates the date and time the item was created.
     attr_accessor :created_date_time
 
+    # An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters.   **Note:** Any custom fields you set with this API method will _replace_ custom fields you have defined with [Envelope Custom Fields in Admin](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels), whether the **Show field to envelope creators** or **Make fields required for envelopes** options are checked or not. 
     attr_accessor :custom_fields
 
     # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -108,6 +110,7 @@ module DocuSign_eSign
     # Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters
     attr_accessor :email_blurb
 
+    # This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope.  **Important Note:** The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings.
     attr_accessor :email_settings
 
     # Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
@@ -122,6 +125,9 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
+    attr_accessor :envelope_custom_metadata
+
     # 
     attr_accessor :envelope_documents
 
@@ -134,11 +140,13 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_location
 
+    # Metadata about the features that are enabled for the envelope.
     attr_accessor :envelope_metadata
 
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
     attr_accessor :envelope_uri
 
+    # This optional object is used to register a webhook that will receive status changes for this envelope.
     attr_accessor :event_notification
 
     # 
@@ -189,11 +197,13 @@ module DocuSign_eSign
     # 
     attr_accessor :location
 
+    # Provides lock information about an envelope that a user has locked.
     attr_accessor :lock_information
 
     # When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.   Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.   However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
     attr_accessor :message_lock
 
+    # An optional complex element that specifies the notification options for the envelope.
     attr_accessor :notification
 
     # Contains a URI for an endpoint that you can use to retrieve the notifications.
@@ -202,6 +212,7 @@ module DocuSign_eSign
     # 
     attr_accessor :password
 
+    # Information about any PowerForms that are included in the envelope.
     attr_accessor :power_form
 
     # 
@@ -213,6 +224,7 @@ module DocuSign_eSign
     # Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue. 
     attr_accessor :purge_state
 
+    # Specifies the envelope recipients.
     attr_accessor :recipients
 
     # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -221,8 +233,10 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the recipients.
     attr_accessor :recipients_uri
 
+    # 
     attr_accessor :recipient_view_request
 
+    # Information about the sender of the envelope.
     attr_accessor :sender
 
     # The date and time the envelope was sent.
@@ -264,6 +278,7 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    # Describes the workflow for this envelope.
     attr_accessor :workflow
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -306,6 +321,7 @@ module DocuSign_eSign
         :'enable_wet_sign' => :'enableWetSign',
         :'enforce_signer_visibility' => :'enforceSignerVisibility',
         :'envelope_attachments' => :'envelopeAttachments',
+        :'envelope_custom_metadata' => :'envelopeCustomMetadata',
         :'envelope_documents' => :'envelopeDocuments',
         :'envelope_id' => :'envelopeId',
         :'envelope_id_stamping' => :'envelopeIdStamping',
@@ -400,6 +416,7 @@ module DocuSign_eSign
         :'enable_wet_sign' => :'String',
         :'enforce_signer_visibility' => :'String',
         :'envelope_attachments' => :'Array<Attachment>',
+        :'envelope_custom_metadata' => :'EnvelopeCustomMetadata',
         :'envelope_documents' => :'Array<EnvelopeDocument>',
         :'envelope_id' => :'String',
         :'envelope_id_stamping' => :'String',
@@ -618,6 +635,10 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'envelopeCustomMetadata')
+        self.envelope_custom_metadata = attributes[:'envelopeCustomMetadata']
+      end
+
       if attributes.has_key?(:'envelopeDocuments')
         if (value = attributes[:'envelopeDocuments']).is_a?(Array)
           self.envelope_documents = value
@@ -886,6 +907,7 @@ module DocuSign_eSign
           enable_wet_sign == o.enable_wet_sign &&
           enforce_signer_visibility == o.enforce_signer_visibility &&
           envelope_attachments == o.envelope_attachments &&
+          envelope_custom_metadata == o.envelope_custom_metadata &&
           envelope_documents == o.envelope_documents &&
           envelope_id == o.envelope_id &&
           envelope_id_stamping == o.envelope_id_stamping &&
@@ -948,7 +970,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, event_notification, event_notifications, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, recipient_view_request, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
+      [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_custom_metadata, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, event_notification, event_notifications, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, recipient_view_request, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope_delay_rule.rb

@@ -0,0 +1,194 @@
+=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 EnvelopeDelayRule
+    # 
+    attr_accessor :delay
+
+    # 
+    attr_accessor :resume_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'delay' => :'delay',
+        :'resume_date' => :'resumeDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'delay' => :'String',
+        :'resume_date' => :'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?(:'delay')
+        self.delay = attributes[:'delay']
+      end
+
+      if attributes.has_key?(:'resumeDate')
+        self.resume_date = attributes[:'resumeDate']
+      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 &&
+          delay == o.delay &&
+          resume_date == o.resume_date
+    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
+      [delay, resume_date].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/envelope_delay_rule_api_model.rb

@@ -0,0 +1,195 @@
+=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
+  # An envelope delay rule is a rule which determines how the envelope should be delayed either for sending or routing. It can expressed as either a delay in some number of days, hours, minutes and seconds or an exact resumeDate in the future.
+  class EnvelopeDelayRuleApiModel
+    # A string timespan duration represented as d.hh:mm:ss where the d component is days, hh is hours measured on a 24-hour clock, mm is minutes and ss is seconds, indicating the expected delay for this envelope rule. The maximum delay is 30 days.
+    attr_accessor :delay
+
+    # A string formatted as an ISO 8601 DATETIME with TimeZone specified, indicating the expected resumeDate for this envelope rule. The specified datetime must occur in the future relative to the current UTC time hen the request is made. The maximum resumeDate must not exceed 30 days in the future.
+    attr_accessor :resume_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'delay' => :'delay',
+        :'resume_date' => :'resumeDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'delay' => :'String',
+        :'resume_date' => :'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?(:'delay')
+        self.delay = attributes[:'delay']
+      end
+
+      if attributes.has_key?(:'resumeDate')
+        self.resume_date = attributes[:'resumeDate']
+      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 &&
+          delay == o.delay &&
+          resume_date == o.resume_date
+    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
+      [delay, resume_date].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/envelope_document.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains details about the envelope document.
   class EnvelopeDocument
     # 
     attr_accessor :added_recipient_ids
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
     attr_accessor :authoritative_copy
 
+    # Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.
     attr_accessor :authoritative_copy_metadata
 
     # 
@@ -33,6 +35,7 @@ module DocuSign_eSign
     # 
     attr_accessor :display
 
+    # Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.
     attr_accessor :display_metadata
 
     # 
@@ -47,16 +50,19 @@ module DocuSign_eSign
     # 
     attr_accessor :document_id_guid
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
     attr_accessor :include_in_download
 
+    # Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.
     attr_accessor :include_in_download_metadata
 
     # 
     attr_accessor :name
 
+    # Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.
     attr_accessor :name_metadata
 
     # 
@@ -68,6 +74,7 @@ module DocuSign_eSign
     # 
     attr_accessor :signer_must_acknowledge
 
+    # Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.
     attr_accessor :signer_must_acknowledge_metadata
 
     # 

data/lib/docusign_esign/models/envelope_event.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # For which envelope events should your webhook be called?
   class EnvelopeEvent
     # he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.
     attr_accessor :envelope_event_status_code

data/lib/docusign_esign/models/envelope_form_data.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes the form data of the envelope.
   class EnvelopeFormData
     # Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
     attr_accessor :email_subject
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :form_data
 
+    # An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). 
     attr_accessor :prefill_form_data
 
     #