docusign_esign 2.13.0.rc1 → 3.0.0.rc1

data/lib/docusign_esign/models/envelope_document.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,13 +12,19 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class EnvelopeDocument
+    # 
+    attr_accessor :added_recipient_ids
+
     # 
     attr_accessor :attachment_tab_id
 
     # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
     attr_accessor :authoritative_copy
 
+    attr_accessor :authoritative_copy_metadata
+
     # 
     attr_accessor :available_document_types
 
@@ -28,20 +34,32 @@ module DocuSign_eSign
     # 
     attr_accessor :display
 
+    attr_accessor :display_metadata
+
     # 
     attr_accessor :document_fields
 
+    # 
+    attr_accessor :document_group
+
     # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
     attr_accessor :document_id
 
+    # 
+    attr_accessor :document_id_guid
+
     attr_accessor :error_details
 
     # 
     attr_accessor :include_in_download
 
+    attr_accessor :include_in_download_metadata
+
     # 
     attr_accessor :name
 
+    attr_accessor :name_metadata
+
     # 
     attr_accessor :order
 
@@ -51,8 +69,13 @@ module DocuSign_eSign
     # 
     attr_accessor :signer_must_acknowledge
 
-    # 
-    attr_accessor :size_bytes
+    attr_accessor :signer_must_acknowledge_metadata
+
+    # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 
+    attr_accessor :template_locked
+
+    # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
+    attr_accessor :template_required
 
     # 
     attr_accessor :type
@@ -60,23 +83,33 @@ module DocuSign_eSign
     # 
     attr_accessor :uri
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'added_recipient_ids' => :'addedRecipientIds',
         :'attachment_tab_id' => :'attachmentTabId',
         :'authoritative_copy' => :'authoritativeCopy',
+        :'authoritative_copy_metadata' => :'authoritativeCopyMetadata',
         :'available_document_types' => :'availableDocumentTypes',
         :'contains_pdf_form_fields' => :'containsPdfFormFields',
         :'display' => :'display',
+        :'display_metadata' => :'displayMetadata',
         :'document_fields' => :'documentFields',
+        :'document_group' => :'documentGroup',
         :'document_id' => :'documentId',
+        :'document_id_guid' => :'documentIdGuid',
         :'error_details' => :'errorDetails',
         :'include_in_download' => :'includeInDownload',
+        :'include_in_download_metadata' => :'includeInDownloadMetadata',
         :'name' => :'name',
+        :'name_metadata' => :'nameMetadata',
         :'order' => :'order',
         :'pages' => :'pages',
         :'signer_must_acknowledge' => :'signerMustAcknowledge',
-        :'size_bytes' => :'sizeBytes',
+        :'signer_must_acknowledge_metadata' => :'signerMustAcknowledgeMetadata',
+        :'template_locked' => :'templateLocked',
+        :'template_required' => :'templateRequired',
         :'type' => :'type',
         :'uri' => :'uri'
       }
@@ -85,20 +118,29 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'added_recipient_ids' => :'Array<String>',
         :'attachment_tab_id' => :'String',
         :'authoritative_copy' => :'String',
+        :'authoritative_copy_metadata' => :'PropertyMetadata',
         :'available_document_types' => :'Array<SignatureType>',
         :'contains_pdf_form_fields' => :'String',
         :'display' => :'String',
+        :'display_metadata' => :'PropertyMetadata',
         :'document_fields' => :'Array<NameValue>',
+        :'document_group' => :'String',
         :'document_id' => :'String',
+        :'document_id_guid' => :'String',
         :'error_details' => :'ErrorDetails',
         :'include_in_download' => :'String',
+        :'include_in_download_metadata' => :'PropertyMetadata',
         :'name' => :'String',
+        :'name_metadata' => :'PropertyMetadata',
         :'order' => :'String',
-        :'pages' => :'String',
+        :'pages' => :'Array<Page>',
         :'signer_must_acknowledge' => :'String',
-        :'size_bytes' => :'String',
+        :'signer_must_acknowledge_metadata' => :'PropertyMetadata',
+        :'template_locked' => :'String',
+        :'template_required' => :'String',
         :'type' => :'String',
         :'uri' => :'String'
       }
@@ -110,7 +152,13 @@ module DocuSign_eSign
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'addedRecipientIds')
+        if (value = attributes[:'addedRecipientIds']).is_a?(Array)
+          self.added_recipient_ids = value
+        end
+      end
 
       if attributes.has_key?(:'attachmentTabId')
         self.attachment_tab_id = attributes[:'attachmentTabId']
@@ -120,6 +168,10 @@ module DocuSign_eSign
         self.authoritative_copy = attributes[:'authoritativeCopy']
       end
 
+      if attributes.has_key?(:'authoritativeCopyMetadata')
+        self.authoritative_copy_metadata = attributes[:'authoritativeCopyMetadata']
+      end
+
       if attributes.has_key?(:'availableDocumentTypes')
         if (value = attributes[:'availableDocumentTypes']).is_a?(Array)
           self.available_document_types = value
@@ -134,16 +186,28 @@ module DocuSign_eSign
         self.display = attributes[:'display']
       end
 
+      if attributes.has_key?(:'displayMetadata')
+        self.display_metadata = attributes[:'displayMetadata']
+      end
+
       if attributes.has_key?(:'documentFields')
         if (value = attributes[:'documentFields']).is_a?(Array)
           self.document_fields = value
         end
       end
 
+      if attributes.has_key?(:'documentGroup')
+        self.document_group = attributes[:'documentGroup']
+      end
+
       if attributes.has_key?(:'documentId')
         self.document_id = attributes[:'documentId']
       end
 
+      if attributes.has_key?(:'documentIdGuid')
+        self.document_id_guid = attributes[:'documentIdGuid']
+      end
+
       if attributes.has_key?(:'errorDetails')
         self.error_details = attributes[:'errorDetails']
       end
@@ -152,24 +216,42 @@ module DocuSign_eSign
         self.include_in_download = attributes[:'includeInDownload']
       end
 
+      if attributes.has_key?(:'includeInDownloadMetadata')
+        self.include_in_download_metadata = attributes[:'includeInDownloadMetadata']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'nameMetadata')
+        self.name_metadata = attributes[:'nameMetadata']
+      end
+
       if attributes.has_key?(:'order')
         self.order = attributes[:'order']
       end
 
       if attributes.has_key?(:'pages')
-        self.pages = attributes[:'pages']
+        if (value = attributes[:'pages']).is_a?(Array)
+          self.pages = value
+        end
       end
 
       if attributes.has_key?(:'signerMustAcknowledge')
         self.signer_must_acknowledge = attributes[:'signerMustAcknowledge']
       end
 
-      if attributes.has_key?(:'sizeBytes')
-        self.size_bytes = attributes[:'sizeBytes']
+      if attributes.has_key?(:'signerMustAcknowledgeMetadata')
+        self.signer_must_acknowledge_metadata = attributes[:'signerMustAcknowledgeMetadata']
+      end
+
+      if attributes.has_key?(:'templateLocked')
+        self.template_locked = attributes[:'templateLocked']
+      end
+
+      if attributes.has_key?(:'templateRequired')
+        self.template_required = attributes[:'templateRequired']
       end
 
       if attributes.has_key?(:'type')
@@ -179,19 +261,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'uri')
         self.uri = attributes[:'uri']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -199,20 +282,29 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          added_recipient_ids == o.added_recipient_ids &&
           attachment_tab_id == o.attachment_tab_id &&
           authoritative_copy == o.authoritative_copy &&
+          authoritative_copy_metadata == o.authoritative_copy_metadata &&
           available_document_types == o.available_document_types &&
           contains_pdf_form_fields == o.contains_pdf_form_fields &&
           display == o.display &&
+          display_metadata == o.display_metadata &&
           document_fields == o.document_fields &&
+          document_group == o.document_group &&
           document_id == o.document_id &&
+          document_id_guid == o.document_id_guid &&
           error_details == o.error_details &&
           include_in_download == o.include_in_download &&
+          include_in_download_metadata == o.include_in_download_metadata &&
           name == o.name &&
+          name_metadata == o.name_metadata &&
           order == o.order &&
           pages == o.pages &&
           signer_must_acknowledge == o.signer_must_acknowledge &&
-          size_bytes == o.size_bytes &&
+          signer_must_acknowledge_metadata == o.signer_must_acknowledge_metadata &&
+          template_locked == o.template_locked &&
+          template_required == o.template_required &&
           type == o.type &&
           uri == o.uri
     end
@@ -226,7 +318,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [attachment_tab_id, authoritative_copy, available_document_types, contains_pdf_form_fields, display, document_fields, document_id, error_details, include_in_download, name, order, pages, signer_must_acknowledge, size_bytes, type, uri].hash
+      [added_recipient_ids, attachment_tab_id, authoritative_copy, authoritative_copy_metadata, available_document_types, contains_pdf_form_fields, display, display_metadata, document_fields, document_group, document_id, document_id_guid, error_details, include_in_download, include_in_download_metadata, name, name_metadata, order, pages, signer_must_acknowledge, signer_must_acknowledge_metadata, template_locked, template_required, type, uri].hash
     end
 
     # Builds the object from hash
@@ -236,10 +328,10 @@ module DocuSign_eSign
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
+          # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -321,7 +413,7 @@ module DocuSign_eSign
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -334,4 +426,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/envelope_documents_result.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class EnvelopeDocumentsResult
     # 
     attr_accessor :envelope_documents
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +43,7 @@ module DocuSign_eSign
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'envelopeDocuments')
         if (value = attributes[:'envelopeDocuments']).is_a?(Array)
@@ -52,19 +54,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'envelopeId')
         self.envelope_id = attributes[:'envelopeId']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -95,10 +98,10 @@ module DocuSign_eSign
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
+          # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -180,7 +183,7 @@ module DocuSign_eSign
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -193,4 +196,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/envelope_event.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class EnvelopeEvent
     # he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.
     attr_accessor :envelope_event_status_code
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # When set to **true**, the PDF documents are included in the message along with the updated XML. 
     attr_accessor :include_documents
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +43,7 @@ module DocuSign_eSign
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'envelopeEventStatusCode')
         self.envelope_event_status_code = attributes[:'envelopeEventStatusCode']
@@ -50,19 +52,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'includeDocuments')
         self.include_documents = attributes[:'includeDocuments']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -93,10 +96,10 @@ module DocuSign_eSign
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
+          # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -178,7 +181,7 @@ module DocuSign_eSign
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -191,4 +194,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/envelope_form_data.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   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,8 +23,6 @@ module DocuSign_eSign
     # 
     attr_accessor :form_data
 
-    attr_accessor :prefill_form_data
-
     # 
     attr_accessor :recipient_form_data
 
@@ -33,13 +32,13 @@ module DocuSign_eSign
     # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
     attr_accessor :status
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'email_subject' => :'emailSubject',
         :'envelope_id' => :'envelopeId',
         :'form_data' => :'formData',
-        :'prefill_form_data' => :'prefillFormData',
         :'recipient_form_data' => :'recipientFormData',
         :'sent_date_time' => :'sentDateTime',
         :'status' => :'status'
@@ -51,8 +50,7 @@ module DocuSign_eSign
       {
         :'email_subject' => :'String',
         :'envelope_id' => :'String',
-        :'form_data' => :'Array<NameValue>',
-        :'prefill_form_data' => :'PrefillFormData',
+        :'form_data' => :'Array<FormDataItem>',
         :'recipient_form_data' => :'Array<RecipientFormData>',
         :'sent_date_time' => :'String',
         :'status' => :'String'
@@ -65,7 +63,7 @@ module DocuSign_eSign
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'emailSubject')
         self.email_subject = attributes[:'emailSubject']
@@ -81,10 +79,6 @@ module DocuSign_eSign
         end
       end
 
-      if attributes.has_key?(:'prefillFormData')
-        self.prefill_form_data = attributes[:'prefillFormData']
-      end
-
       if attributes.has_key?(:'recipientFormData')
         if (value = attributes[:'recipientFormData']).is_a?(Array)
           self.recipient_form_data = value
@@ -98,19 +92,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -121,7 +116,6 @@ module DocuSign_eSign
           email_subject == o.email_subject &&
           envelope_id == o.envelope_id &&
           form_data == o.form_data &&
-          prefill_form_data == o.prefill_form_data &&
           recipient_form_data == o.recipient_form_data &&
           sent_date_time == o.sent_date_time &&
           status == o.status
@@ -136,7 +130,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email_subject, envelope_id, form_data, prefill_form_data, recipient_form_data, sent_date_time, status].hash
+      [email_subject, envelope_id, form_data, recipient_form_data, sent_date_time, status].hash
     end
 
     # Builds the object from hash
@@ -146,10 +140,10 @@ module DocuSign_eSign
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
+          # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -231,7 +225,7 @@ module DocuSign_eSign
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -244,4 +238,5 @@ module DocuSign_eSign
     end
 
   end
+
 end