docusign_esign 2.13.0.rc1 → 3.0.0.rc1

data/lib/docusign_esign/models/{offline_attributes.rb → display_appliance_signer_attachment.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,47 +12,53 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
-  # Reserved for DocuSign use.
-  class OfflineAttributes
-    # A GUID identifying the account associated with the consumer disclosure
-    attr_accessor :account_esign_id
 
-    # A string containing information about the model of the device used for offline signing.
-    attr_accessor :device_model
+  class DisplayApplianceSignerAttachment
+    # 
+    attr_accessor :attachment_description
 
-    # A string containing information about the type of device used for offline signing.
-    attr_accessor :device_name
+    # 
+    attr_accessor :attachment_tab_id
 
-    # A string containing the latitude of the device location at the time of signing.
-    attr_accessor :gps_latitude
+    # 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
 
-    # A string containing the longitude of the device location at the time of signing.
-    attr_accessor :gps_longitude
+    # The envelope ID of the envelope status that failed to post.
+    attr_accessor :envelope_id
 
     # 
-    attr_accessor :offline_signing_hash
+    attr_accessor :page_count
+
+    # 
+    attr_accessor :page_id
+
+    # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
+    attr_accessor :recipient_id
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'account_esign_id' => :'accountEsignId',
-        :'device_model' => :'deviceModel',
-        :'device_name' => :'deviceName',
-        :'gps_latitude' => :'gpsLatitude',
-        :'gps_longitude' => :'gpsLongitude',
-        :'offline_signing_hash' => :'offlineSigningHash'
+        :'attachment_description' => :'attachmentDescription',
+        :'attachment_tab_id' => :'attachmentTabId',
+        :'document_id' => :'documentId',
+        :'envelope_id' => :'envelopeId',
+        :'page_count' => :'pageCount',
+        :'page_id' => :'pageId',
+        :'recipient_id' => :'recipientId'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'account_esign_id' => :'String',
-        :'device_model' => :'String',
-        :'device_name' => :'String',
-        :'gps_latitude' => :'String',
-        :'gps_longitude' => :'String',
-        :'offline_signing_hash' => :'String'
+        :'attachment_description' => :'String',
+        :'attachment_tab_id' => :'String',
+        :'document_id' => :'String',
+        :'envelope_id' => :'String',
+        :'page_count' => :'Integer',
+        :'page_id' => :'String',
+        :'recipient_id' => :'String'
       }
     end
 
@@ -62,44 +68,49 @@ 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?(:'attachmentDescription')
+        self.attachment_description = attributes[:'attachmentDescription']
+      end
 
-      if attributes.has_key?(:'accountEsignId')
-        self.account_esign_id = attributes[:'accountEsignId']
+      if attributes.has_key?(:'attachmentTabId')
+        self.attachment_tab_id = attributes[:'attachmentTabId']
       end
 
-      if attributes.has_key?(:'deviceModel')
-        self.device_model = attributes[:'deviceModel']
+      if attributes.has_key?(:'documentId')
+        self.document_id = attributes[:'documentId']
       end
 
-      if attributes.has_key?(:'deviceName')
-        self.device_name = attributes[:'deviceName']
+      if attributes.has_key?(:'envelopeId')
+        self.envelope_id = attributes[:'envelopeId']
       end
 
-      if attributes.has_key?(:'gpsLatitude')
-        self.gps_latitude = attributes[:'gpsLatitude']
+      if attributes.has_key?(:'pageCount')
+        self.page_count = attributes[:'pageCount']
       end
 
-      if attributes.has_key?(:'gpsLongitude')
-        self.gps_longitude = attributes[:'gpsLongitude']
+      if attributes.has_key?(:'pageId')
+        self.page_id = attributes[:'pageId']
       end
 
-      if attributes.has_key?(:'offlineSigningHash')
-        self.offline_signing_hash = attributes[:'offlineSigningHash']
+      if attributes.has_key?(:'recipientId')
+        self.recipient_id = attributes[:'recipientId']
       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.
@@ -107,12 +118,13 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          account_esign_id == o.account_esign_id &&
-          device_model == o.device_model &&
-          device_name == o.device_name &&
-          gps_latitude == o.gps_latitude &&
-          gps_longitude == o.gps_longitude &&
-          offline_signing_hash == o.offline_signing_hash
+          attachment_description == o.attachment_description &&
+          attachment_tab_id == o.attachment_tab_id &&
+          document_id == o.document_id &&
+          envelope_id == o.envelope_id &&
+          page_count == o.page_count &&
+          page_id == o.page_id &&
+          recipient_id == o.recipient_id
     end
 
     # @see the `==` method
@@ -124,7 +136,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_esign_id, device_model, device_name, gps_latitude, gps_longitude, offline_signing_hash].hash
+      [attachment_description, attachment_tab_id, document_id, envelope_id, page_count, page_id, recipient_id].hash
     end
 
     # Builds the object from hash
@@ -134,10 +146,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]]))
@@ -219,7 +231,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) }
@@ -232,4 +244,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/dob_information_input.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
 
@@ -23,6 +23,7 @@ module DocuSign_eSign
     # When set to **true**, the information needs to be returned in the response.
     attr_accessor :receive_in_response
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -47,7 +48,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?(:'dateOfBirth')
         self.date_of_birth = attributes[:'dateOfBirth']
@@ -60,19 +61,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'receiveInResponse')
         self.receive_in_response = attributes[:'receiveInResponse']
       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.
@@ -104,10 +106,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]]))
@@ -189,7 +191,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) }
@@ -202,4 +204,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/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,11 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class Document
     # Reserved: TBD
     attr_accessor :apply_anchor_tabs
 
-    # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
-    attr_accessor :authoritative_copy
-
     # 
     attr_accessor :display
 
@@ -28,6 +26,9 @@ module DocuSign_eSign
     # 
     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
 
@@ -54,18 +55,29 @@ module DocuSign_eSign
     # 
     attr_accessor :order
 
+    # 
+    attr_accessor :page_count
+
     # 
     attr_accessor :pages
 
+    # 
+    attr_accessor :page_sizes
+
     # 
     attr_accessor :password
 
+    # 
+    attr_accessor :pdf_form_field_option
+
     # The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. 
     attr_accessor :remote_url
 
     # 
     attr_accessor :signer_must_acknowledge
 
+    attr_accessor :tabs
+
     # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 
     attr_accessor :template_locked
 
@@ -78,14 +90,15 @@ module DocuSign_eSign
     # 
     attr_accessor :uri
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'apply_anchor_tabs' => :'applyAnchorTabs',
-        :'authoritative_copy' => :'authoritativeCopy',
         :'display' => :'display',
         :'document_base64' => :'documentBase64',
         :'document_fields' => :'documentFields',
+        :'document_group' => :'documentGroup',
         :'document_id' => :'documentId',
         :'encrypted_with_key_manager' => :'encryptedWithKeyManager',
         :'file_extension' => :'fileExtension',
@@ -95,10 +108,14 @@ module DocuSign_eSign
         :'match_boxes' => :'matchBoxes',
         :'name' => :'name',
         :'order' => :'order',
+        :'page_count' => :'pageCount',
         :'pages' => :'pages',
+        :'page_sizes' => :'pageSizes',
         :'password' => :'password',
+        :'pdf_form_field_option' => :'pdfFormFieldOption',
         :'remote_url' => :'remoteUrl',
         :'signer_must_acknowledge' => :'signerMustAcknowledge',
+        :'tabs' => :'tabs',
         :'template_locked' => :'templateLocked',
         :'template_required' => :'templateRequired',
         :'transform_pdf_fields' => :'transformPdfFields',
@@ -110,10 +127,10 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'apply_anchor_tabs' => :'String',
-        :'authoritative_copy' => :'BOOLEAN',
         :'display' => :'String',
         :'document_base64' => :'String',
         :'document_fields' => :'Array<NameValue>',
+        :'document_group' => :'String',
         :'document_id' => :'String',
         :'encrypted_with_key_manager' => :'String',
         :'file_extension' => :'String',
@@ -123,10 +140,14 @@ module DocuSign_eSign
         :'match_boxes' => :'Array<MatchBox>',
         :'name' => :'String',
         :'order' => :'String',
+        :'page_count' => :'String',
         :'pages' => :'String',
+        :'page_sizes' => :'Array<PageSize>',
         :'password' => :'String',
+        :'pdf_form_field_option' => :'String',
         :'remote_url' => :'String',
         :'signer_must_acknowledge' => :'String',
+        :'tabs' => :'Tabs',
         :'template_locked' => :'String',
         :'template_required' => :'String',
         :'transform_pdf_fields' => :'String',
@@ -140,16 +161,12 @@ 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?(:'applyAnchorTabs')
         self.apply_anchor_tabs = attributes[:'applyAnchorTabs']
       end
 
-      if attributes.has_key?(:'authoritativeCopy')
-        self.authoritative_copy = attributes[:'authoritativeCopy']
-      end
-
       if attributes.has_key?(:'display')
         self.display = attributes[:'display']
       end
@@ -164,6 +181,10 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'documentGroup')
+        self.document_group = attributes[:'documentGroup']
+      end
+
       if attributes.has_key?(:'documentId')
         self.document_id = attributes[:'documentId']
       end
@@ -202,14 +223,28 @@ module DocuSign_eSign
         self.order = attributes[:'order']
       end
 
+      if attributes.has_key?(:'pageCount')
+        self.page_count = attributes[:'pageCount']
+      end
+
       if attributes.has_key?(:'pages')
         self.pages = attributes[:'pages']
       end
 
+      if attributes.has_key?(:'pageSizes')
+        if (value = attributes[:'pageSizes']).is_a?(Array)
+          self.page_sizes = value
+        end
+      end
+
       if attributes.has_key?(:'password')
         self.password = attributes[:'password']
       end
 
+      if attributes.has_key?(:'pdfFormFieldOption')
+        self.pdf_form_field_option = attributes[:'pdfFormFieldOption']
+      end
+
       if attributes.has_key?(:'remoteUrl')
         self.remote_url = attributes[:'remoteUrl']
       end
@@ -218,6 +253,10 @@ module DocuSign_eSign
         self.signer_must_acknowledge = attributes[:'signerMustAcknowledge']
       end
 
+      if attributes.has_key?(:'tabs')
+        self.tabs = attributes[:'tabs']
+      end
+
       if attributes.has_key?(:'templateLocked')
         self.template_locked = attributes[:'templateLocked']
       end
@@ -233,19 +272,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.
@@ -254,10 +294,10 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           apply_anchor_tabs == o.apply_anchor_tabs &&
-          authoritative_copy == o.authoritative_copy &&
           display == o.display &&
           document_base64 == o.document_base64 &&
           document_fields == o.document_fields &&
+          document_group == o.document_group &&
           document_id == o.document_id &&
           encrypted_with_key_manager == o.encrypted_with_key_manager &&
           file_extension == o.file_extension &&
@@ -267,10 +307,14 @@ module DocuSign_eSign
           match_boxes == o.match_boxes &&
           name == o.name &&
           order == o.order &&
+          page_count == o.page_count &&
           pages == o.pages &&
+          page_sizes == o.page_sizes &&
           password == o.password &&
+          pdf_form_field_option == o.pdf_form_field_option &&
           remote_url == o.remote_url &&
           signer_must_acknowledge == o.signer_must_acknowledge &&
+          tabs == o.tabs &&
           template_locked == o.template_locked &&
           template_required == o.template_required &&
           transform_pdf_fields == o.transform_pdf_fields &&
@@ -286,7 +330,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [apply_anchor_tabs, authoritative_copy, display, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, pages, password, remote_url, signer_must_acknowledge, template_locked, template_required, transform_pdf_fields, uri].hash
+      [apply_anchor_tabs, display, document_base64, document_fields, document_group, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, page_count, pages, page_sizes, password, pdf_form_field_option, remote_url, signer_must_acknowledge, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
     end
 
     # Builds the object from hash
@@ -296,10 +340,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]]))
@@ -381,7 +425,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) }
@@ -394,4 +438,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/document_fields_information.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,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class DocumentFieldsInformation
     # The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements:   * name - A string that can be a maximum of 50 characters.  * value - A string that can be a maximum of 200 characters.  *IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element.  
     attr_accessor :document_fields
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,26 +38,27 @@ 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?(:'documentFields')
         if (value = attributes[:'documentFields']).is_a?(Array)
           self.document_fields = value
         end
       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.
@@ -85,10 +88,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]]))
@@ -170,7 +173,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) }
@@ -183,4 +186,5 @@ module DocuSign_eSign
     end
 
   end
+
 end