docusign_esign 3.17.0 → 3.19.0

data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.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 EnvelopePublishTransactionErrorRollup
+    # 
+    attr_accessor :count
+
+    # 
+    attr_accessor :error_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'count' => :'count',
+        :'error_type' => :'errorType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'count' => :'String',
+        :'error_type' => :'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?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.has_key?(:'errorType')
+        self.error_type = attributes[:'errorType']
+      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 &&
+          count == o.count &&
+          error_type == o.error_type
+    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
+      [count, error_type].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_purge_configuration.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). 
   class EnvelopePurgeConfiguration
     # 
     attr_accessor :purge_envelopes

data/lib/docusign_esign/models/envelope_summary.rb

@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  #  This object describes an envelope.
   class EnvelopeSummary
+    # An object that describes the status of the bulk send envelopes.
     attr_accessor :bulk_envelope_status
 
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/envelope_template.rb

@@ -73,6 +73,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.
     attr_accessor :custom_fields
 
     # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -108,6 +109,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email_blurb
 
+    # A complex type that contains email settings.
     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 +124,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
     attr_accessor :envelope_custom_metadata
 
     # 
@@ -136,6 +139,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_location
 
+    # Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.
     attr_accessor :envelope_metadata
 
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
@@ -195,6 +199,7 @@ module DocuSign_eSign
     # 
     attr_accessor :last_modified
 
+    # 
     attr_accessor :last_modified_by
 
     # The date and time the item was last modified.
@@ -206,6 +211,7 @@ 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.
@@ -217,11 +223,13 @@ module DocuSign_eSign
     # 
     attr_accessor :new_password
 
+    # 
     attr_accessor :notification
 
     # Contains a URI for an endpoint that you can use to retrieve the notifications.
     attr_accessor :notification_uri
 
+    # 
     attr_accessor :owner
 
     # 
@@ -233,6 +241,7 @@ module DocuSign_eSign
     # 
     attr_accessor :password_protected
 
+    # Information about any PowerForms that are included in the envelope.
     attr_accessor :power_form
 
     # 
@@ -247,6 +256,7 @@ module DocuSign_eSign
     # 
     attr_accessor :purge_state
 
+    # An array of recipient objects that provides details about the recipients of the envelope.
     attr_accessor :recipients
 
     # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -255,6 +265,7 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the recipients.
     attr_accessor :recipients_uri
 
+    # Information about the sender of the envelope.
     attr_accessor :sender
 
     # The date and time the envelope was sent.
@@ -299,6 +310,7 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    # 
     attr_accessor :workflow
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_template_results.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about templates.
   class EnvelopeTemplateResults
     # The last position in the result set. 
     attr_accessor :end_position

data/lib/docusign_esign/models/envelope_transaction_status.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 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.

data/lib/docusign_esign/models/envelope_transfer_rule.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 an envelope transfer rule.
   class EnvelopeTransferRule
     # 
     attr_accessor :carbon_copy_original_owner
@@ -25,17 +26,22 @@ module DocuSign_eSign
     # 
     attr_accessor :event_type
 
+    # Information about the group that triggers the transfer.
     attr_accessor :from_group
 
+    # Information about the user who triggers the transfer.
     attr_accessor :from_user
 
     # 
     attr_accessor :modified_date
 
+    # Information about the user who last modified the envelope transfer rule.
     attr_accessor :modified_user
 
+    # Information about the destination folder to which the envelope is transferred.
     attr_accessor :to_folder
 
+    # Information about the user to which the envelope is transferred.
     attr_accessor :to_user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_transfer_rule_request.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 transfer rule that you want to create.
   class EnvelopeTransferRuleRequest
     # 
     attr_accessor :carbon_copy_original_owner
@@ -34,10 +35,13 @@ module DocuSign_eSign
     # 
     attr_accessor :modified_date
 
+    # Information about the user who last modified the envelope transfer rule.
     attr_accessor :modified_user
 
+    # Information about the destination folder to which the envelope is transferred.
     attr_accessor :to_folder
 
+    # Information about the user to which the envelope is transferred.
     attr_accessor :to_user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_update_summary.rb

@@ -13,16 +13,19 @@ require 'date'
 
 module DocuSign_eSign
   class EnvelopeUpdateSummary
+    # An object that describes the status of the bulk send envelopes.
     attr_accessor :bulk_envelope_status
 
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
     attr_accessor :list_custom_field_update_results
 
+    # Provides lock information about an envelope that a user has locked.
     attr_accessor :lock_information
 
     # 
@@ -31,6 +34,7 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_update_results
 
+    # 
     attr_accessor :tab_update_results
 
     # 

data/lib/docusign_esign/models/envelopes_information.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Result set for the Envelopes: listStatusChanges method
   class EnvelopesInformation
     # 
     attr_accessor :continuation_token

data/lib/docusign_esign/models/event_notification.rb

@@ -20,6 +20,7 @@ module DocuSign_eSign
     # A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.   To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
     attr_accessor :envelope_events
 
+    # Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)
     attr_accessor :event_data
 
     # 

data/lib/docusign_esign/models/event_result.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about the result of an event.
   class EventResult
     # 
     attr_accessor :event_timestamp

data/lib/docusign_esign/models/external_document_sources.rb

@@ -12,30 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A complex object specifying the external document sources.
   class ExternalDocumentSources
     # 
     attr_accessor :boxnet_enabled
 
+    # Metadata indicating whether the `boxnetEnabled` property is editable.
     attr_accessor :boxnet_metadata
 
     # 
     attr_accessor :dropbox_enabled
 
+    # Metadata indicating whether the `dropboxEnabled` property is editable.
     attr_accessor :dropbox_metadata
 
     # 
     attr_accessor :google_drive_enabled
 
+    # Metadata indicating whether the `googleDriveEnabled` property is editable.
     attr_accessor :google_drive_metadata
 
     # 
     attr_accessor :one_drive_enabled
 
+    # Metadata indicating whether the `oneDriveEnabled` property is editable.
     attr_accessor :one_drive_metadata
 
     # 
     attr_accessor :salesforce_enabled
 
+    # Metadata indicating whether the `salesforceEnabled` property is editable.
     attr_accessor :salesforce_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/external_file.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains information about a file or folder in cloud storage.
   class ExternalFile
     # 
     attr_accessor :date

data/lib/docusign_esign/models/external_folder.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # The last position in the result set. 
     attr_accessor :end_position
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/favorite_templates_content_item.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class FavoriteTemplatesContentItem
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/favorite_templates_info.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class FavoriteTemplatesInfo
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/feature_set.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.
   class FeatureSet
     # A complex type that contains alternate currency values that are configured for this plan feature set.
     attr_accessor :currency_feature_set_prices

data/lib/docusign_esign/models/filter.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Use this object to create a filtered view of the items in a folder.
   class Filter
     # Access token information.
     attr_accessor :action_required