docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/bulk_send_envelopes_info.rb

@@ -0,0 +1,304 @@
+=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 BulkSendEnvelopesInfo
+    # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
+    attr_accessor :authoritative_copy
+
+    # 
+    attr_accessor :completed
+
+    # 
+    attr_accessor :correct
+
+    # 
+    attr_accessor :created
+
+    # 
+    attr_accessor :declined
+
+    # 
+    attr_accessor :deleted
+
+    # 
+    attr_accessor :delivered
+
+    # 
+    attr_accessor :digital_signatures_pending
+
+    # 
+    attr_accessor :sent
+
+    # 
+    attr_accessor :signed
+
+    # 
+    attr_accessor :timed_out
+
+    # 
+    attr_accessor :transfer_completed
+
+    # 
+    attr_accessor :voided
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'authoritative_copy' => :'authoritativeCopy',
+        :'completed' => :'completed',
+        :'correct' => :'correct',
+        :'created' => :'created',
+        :'declined' => :'declined',
+        :'deleted' => :'deleted',
+        :'delivered' => :'delivered',
+        :'digital_signatures_pending' => :'digitalSignaturesPending',
+        :'sent' => :'sent',
+        :'signed' => :'signed',
+        :'timed_out' => :'timedOut',
+        :'transfer_completed' => :'transferCompleted',
+        :'voided' => :'voided'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'authoritative_copy' => :'String',
+        :'completed' => :'String',
+        :'correct' => :'String',
+        :'created' => :'String',
+        :'declined' => :'String',
+        :'deleted' => :'String',
+        :'delivered' => :'String',
+        :'digital_signatures_pending' => :'String',
+        :'sent' => :'String',
+        :'signed' => :'String',
+        :'timed_out' => :'String',
+        :'transfer_completed' => :'String',
+        :'voided' => :'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?(:'authoritativeCopy')
+        self.authoritative_copy = attributes[:'authoritativeCopy']
+      end
+
+      if attributes.has_key?(:'completed')
+        self.completed = attributes[:'completed']
+      end
+
+      if attributes.has_key?(:'correct')
+        self.correct = attributes[:'correct']
+      end
+
+      if attributes.has_key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.has_key?(:'declined')
+        self.declined = attributes[:'declined']
+      end
+
+      if attributes.has_key?(:'deleted')
+        self.deleted = attributes[:'deleted']
+      end
+
+      if attributes.has_key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.has_key?(:'digitalSignaturesPending')
+        self.digital_signatures_pending = attributes[:'digitalSignaturesPending']
+      end
+
+      if attributes.has_key?(:'sent')
+        self.sent = attributes[:'sent']
+      end
+
+      if attributes.has_key?(:'signed')
+        self.signed = attributes[:'signed']
+      end
+
+      if attributes.has_key?(:'timedOut')
+        self.timed_out = attributes[:'timedOut']
+      end
+
+      if attributes.has_key?(:'transferCompleted')
+        self.transfer_completed = attributes[:'transferCompleted']
+      end
+
+      if attributes.has_key?(:'voided')
+        self.voided = attributes[:'voided']
+      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 &&
+          authoritative_copy == o.authoritative_copy &&
+          completed == o.completed &&
+          correct == o.correct &&
+          created == o.created &&
+          declined == o.declined &&
+          deleted == o.deleted &&
+          delivered == o.delivered &&
+          digital_signatures_pending == o.digital_signatures_pending &&
+          sent == o.sent &&
+          signed == o.signed &&
+          timed_out == o.timed_out &&
+          transfer_completed == o.transfer_completed &&
+          voided == o.voided
+    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
+      [authoritative_copy, completed, correct, created, declined, deleted, delivered, digital_signatures_pending, sent, signed, timed_out, transfer_completed, voided].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_error_status.rb

@@ -12,10 +12,14 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A single bulk send error report.
   class BulkSendErrorStatus
     # 
     attr_accessor :created
 
+    # The envelope ID of the envelope status that failed to post.
+    attr_accessor :envelope_id
+
     # 
     attr_accessor :error_message
 
@@ -26,6 +30,7 @@ module DocuSign_eSign
     def self.attribute_map
       {
         :'created' => :'created',
+        :'envelope_id' => :'envelopeId',
         :'error_message' => :'errorMessage',
         :'recipient_emails' => :'recipientEmails'
       }
@@ -35,6 +40,7 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'created' => :'String',
+        :'envelope_id' => :'String',
         :'error_message' => :'String',
         :'recipient_emails' => :'Array<String>'
       }
@@ -52,6 +58,10 @@ module DocuSign_eSign
         self.created = attributes[:'created']
       end
 
+      if attributes.has_key?(:'envelopeId')
+        self.envelope_id = attributes[:'envelopeId']
+      end
+
       if attributes.has_key?(:'errorMessage')
         self.error_message = attributes[:'errorMessage']
       end
@@ -82,6 +92,7 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           created == o.created &&
+          envelope_id == o.envelope_id &&
           error_message == o.error_message &&
           recipient_emails == o.recipient_emails
     end
@@ -95,7 +106,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [created, error_message, recipient_emails].hash
+      [created, envelope_id, error_message, recipient_emails].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/bulk_send_request.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 the envelope or template that you want to send in bulk.
   class BulkSendRequest
     # 
     attr_accessor :batch_name

data/lib/docusign_esign/models/bulk_send_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The object contains the response to a bulk send request.
   class BulkSendResponse
     # 
     attr_accessor :batch_id

data/lib/docusign_esign/models/bulk_send_test_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the results of a bulk send test.
   class BulkSendTestResponse
     # 
     attr_accessor :can_be_sent

data/lib/docusign_esign/models/bulk_sending_copy.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.
   class BulkSendingCopy
     # An optional array of strings that allows 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

data/lib/docusign_esign/models/bulk_sending_copy_custom_field.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 a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.
   class BulkSendingCopyCustomField
     # 
     attr_accessor :name

data/lib/docusign_esign/models/bulk_sending_copy_recipient.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 a bulk send recipient.
   class BulkSendingCopyRecipient
     # 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
@@ -28,6 +29,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email
 
+    # An optional complex type that sets a specific email subject and body for this recipient's notification email.   **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. 
     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]]` 
@@ -45,6 +47,7 @@ module DocuSign_eSign
     # 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
 
+    # An object that contains input information related to a recipient ID check.
     attr_accessor :id_check_information_input
 
     # 
@@ -56,6 +59,7 @@ module DocuSign_eSign
     # 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
 
+    # When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:  * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings.  A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.  
     attr_accessor :phone_authentication
 
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -73,6 +77,7 @@ module DocuSign_eSign
     # 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
 
+    # When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.   
     attr_accessor :sms_authentication
 
     #  Lists the social ID type that can be used for recipient authentication.

data/lib/docusign_esign/models/bulk_sending_copy_tab.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.  For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.
   class BulkSendingCopyTab
     # The original value of the tab.
     attr_accessor :initial_value

data/lib/docusign_esign/models/bulk_sending_list.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the details for the bulk send list.
   class BulkSendingList
     # 
     attr_accessor :bulk_copies

data/lib/docusign_esign/models/bulk_sending_list_summaries.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.
   class BulkSendingListSummaries
     # 
     attr_accessor :bulk_list_summaries

data/lib/docusign_esign/models/bulk_sending_list_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains basic information about a bulk send list.
   class BulkSendingListSummary
     # 
     attr_accessor :bulk_send_list_id

data/lib/docusign_esign/models/captive_recipient.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 a captive (embedded) recipient.
   class CaptiveRecipient
     # 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
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # Specifies the email address associated with the captive recipient.
     attr_accessor :email
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Specifies the user name associated with the captive recipient.

data/lib/docusign_esign/models/captive_recipient_information.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about captive (embedded) recipients.
   class CaptiveRecipientInformation
     # A complex type containing information about one or more captive recipients.
     attr_accessor :captive_recipients