docusign_esign 2.13.0.rc1 → 3.0.0.rc1

data/lib/docusign_esign/models/recipient_signature_provider_options.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,26 +12,40 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class RecipientSignatureProviderOptions
     # 
     attr_accessor :cpf_number
 
+    attr_accessor :cpf_number_metadata
+
     # 
     attr_accessor :one_time_password
 
+    attr_accessor :one_time_password_metadata
+
     # 
     attr_accessor :signer_role
 
+    attr_accessor :signer_role_metadata
+
     # 
     attr_accessor :sms
 
+    attr_accessor :sms_metadata
+
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'cpf_number' => :'cpfNumber',
+        :'cpf_number_metadata' => :'cpfNumberMetadata',
         :'one_time_password' => :'oneTimePassword',
+        :'one_time_password_metadata' => :'oneTimePasswordMetadata',
         :'signer_role' => :'signerRole',
-        :'sms' => :'sms'
+        :'signer_role_metadata' => :'signerRoleMetadata',
+        :'sms' => :'sms',
+        :'sms_metadata' => :'smsMetadata'
       }
     end
 
@@ -39,9 +53,13 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'cpf_number' => :'String',
+        :'cpf_number_metadata' => :'PropertyMetadata',
         :'one_time_password' => :'String',
+        :'one_time_password_metadata' => :'PropertyMetadata',
         :'signer_role' => :'String',
-        :'sms' => :'String'
+        :'signer_role_metadata' => :'PropertyMetadata',
+        :'sms' => :'String',
+        :'sms_metadata' => :'PropertyMetadata'
       }
     end
 
@@ -51,36 +69,53 @@ 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?(:'cpfNumber')
         self.cpf_number = attributes[:'cpfNumber']
       end
 
+      if attributes.has_key?(:'cpfNumberMetadata')
+        self.cpf_number_metadata = attributes[:'cpfNumberMetadata']
+      end
+
       if attributes.has_key?(:'oneTimePassword')
         self.one_time_password = attributes[:'oneTimePassword']
       end
 
+      if attributes.has_key?(:'oneTimePasswordMetadata')
+        self.one_time_password_metadata = attributes[:'oneTimePasswordMetadata']
+      end
+
       if attributes.has_key?(:'signerRole')
         self.signer_role = attributes[:'signerRole']
       end
 
+      if attributes.has_key?(:'signerRoleMetadata')
+        self.signer_role_metadata = attributes[:'signerRoleMetadata']
+      end
+
       if attributes.has_key?(:'sms')
         self.sms = attributes[:'sms']
       end
+
+      if attributes.has_key?(:'smsMetadata')
+        self.sms_metadata = attributes[:'smsMetadata']
+      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.
@@ -89,9 +124,13 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           cpf_number == o.cpf_number &&
+          cpf_number_metadata == o.cpf_number_metadata &&
           one_time_password == o.one_time_password &&
+          one_time_password_metadata == o.one_time_password_metadata &&
           signer_role == o.signer_role &&
-          sms == o.sms
+          signer_role_metadata == o.signer_role_metadata &&
+          sms == o.sms &&
+          sms_metadata == o.sms_metadata
     end
 
     # @see the `==` method
@@ -103,7 +142,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cpf_number, one_time_password, signer_role, sms].hash
+      [cpf_number, cpf_number_metadata, one_time_password, one_time_password_metadata, signer_role, signer_role_metadata, sms, sms_metadata].hash
     end
 
     # Builds the object from hash
@@ -113,10 +152,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]]))
@@ -198,7 +237,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) }
@@ -211,4 +250,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipient_sms_authentication.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
 
@@ -17,17 +17,22 @@ module DocuSign_eSign
     # An Array containing a list of phone numbers the recipient may use for SMS text authentication. 
     attr_accessor :sender_provided_numbers
 
+    attr_accessor :sender_provided_numbers_metadata
+
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'sender_provided_numbers' => :'senderProvidedNumbers'
+        :'sender_provided_numbers' => :'senderProvidedNumbers',
+        :'sender_provided_numbers_metadata' => :'senderProvidedNumbersMetadata'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'sender_provided_numbers' => :'Array<String>'
+        :'sender_provided_numbers' => :'Array<String>',
+        :'sender_provided_numbers_metadata' => :'PropertyMetadata'
       }
     end
 
@@ -37,26 +42,31 @@ 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?(:'senderProvidedNumbers')
         if (value = attributes[:'senderProvidedNumbers']).is_a?(Array)
           self.sender_provided_numbers = value
         end
       end
+
+      if attributes.has_key?(:'senderProvidedNumbersMetadata')
+        self.sender_provided_numbers_metadata = attributes[:'senderProvidedNumbersMetadata']
+      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.
@@ -64,7 +74,8 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          sender_provided_numbers == o.sender_provided_numbers
+          sender_provided_numbers == o.sender_provided_numbers &&
+          sender_provided_numbers_metadata == o.sender_provided_numbers_metadata
     end
 
     # @see the `==` method
@@ -76,7 +87,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [sender_provided_numbers].hash
+      [sender_provided_numbers, sender_provided_numbers_metadata].hash
     end
 
     # Builds the object from hash
@@ -86,10 +97,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]]))
@@ -171,7 +182,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) }
@@ -184,4 +195,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipient_update_response.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,19 +12,29 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class RecipientUpdateResponse
+    # 
+    attr_accessor :combined
+
     attr_accessor :error_details
 
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
     attr_accessor :recipient_id
 
+    # 
+    attr_accessor :recipient_id_guid
+
     attr_accessor :tabs
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'combined' => :'combined',
         :'error_details' => :'errorDetails',
         :'recipient_id' => :'recipientId',
+        :'recipient_id_guid' => :'recipientIdGuid',
         :'tabs' => :'tabs'
       }
     end
@@ -32,8 +42,10 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'combined' => :'String',
         :'error_details' => :'ErrorDetails',
         :'recipient_id' => :'String',
+        :'recipient_id_guid' => :'String',
         :'tabs' => :'Tabs'
       }
     end
@@ -44,7 +56,11 @@ 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?(:'combined')
+        self.combined = attributes[:'combined']
+      end
 
       if attributes.has_key?(:'errorDetails')
         self.error_details = attributes[:'errorDetails']
@@ -54,22 +70,27 @@ module DocuSign_eSign
         self.recipient_id = attributes[:'recipientId']
       end
 
+      if attributes.has_key?(:'recipientIdGuid')
+        self.recipient_id_guid = attributes[:'recipientIdGuid']
+      end
+
       if attributes.has_key?(:'tabs')
         self.tabs = attributes[:'tabs']
       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.
@@ -77,8 +98,10 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          combined == o.combined &&
           error_details == o.error_details &&
           recipient_id == o.recipient_id &&
+          recipient_id_guid == o.recipient_id_guid &&
           tabs == o.tabs
     end
 
@@ -91,7 +114,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [error_details, recipient_id, tabs].hash
+      [combined, error_details, recipient_id, recipient_id_guid, tabs].hash
     end
 
     # Builds the object from hash
@@ -101,10 +124,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]]))
@@ -186,7 +209,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) }
@@ -199,4 +222,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipient_view_request.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 RecipientViewRequest
     # A unique identifier of the authentication event executed by the client application.
     attr_accessor :assertion_id
@@ -28,12 +29,6 @@ module DocuSign_eSign
     # Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
     attr_accessor :email
 
-    # 
-    attr_accessor :frame_ancestors
-
-    # 
-    attr_accessor :message_origins
-
     # Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl.  The default is 300 seconds. Valid values are 60-1200 seconds.
     attr_accessor :ping_frequency
 
@@ -61,6 +56,7 @@ module DocuSign_eSign
     # 
     attr_accessor :x_frame_options_allow_from_url
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,8 +65,6 @@ module DocuSign_eSign
         :'authentication_method' => :'authenticationMethod',
         :'client_user_id' => :'clientUserId',
         :'email' => :'email',
-        :'frame_ancestors' => :'frameAncestors',
-        :'message_origins' => :'messageOrigins',
         :'ping_frequency' => :'pingFrequency',
         :'ping_url' => :'pingUrl',
         :'recipient_id' => :'recipientId',
@@ -91,8 +85,6 @@ module DocuSign_eSign
         :'authentication_method' => :'String',
         :'client_user_id' => :'String',
         :'email' => :'String',
-        :'frame_ancestors' => :'Array<String>',
-        :'message_origins' => :'Array<String>',
         :'ping_frequency' => :'String',
         :'ping_url' => :'String',
         :'recipient_id' => :'String',
@@ -111,7 +103,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?(:'assertionId')
         self.assertion_id = attributes[:'assertionId']
@@ -133,18 +125,6 @@ module DocuSign_eSign
         self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'frameAncestors')
-        if (value = attributes[:'frameAncestors']).is_a?(Array)
-          self.frame_ancestors = value
-        end
-      end
-
-      if attributes.has_key?(:'messageOrigins')
-        if (value = attributes[:'messageOrigins']).is_a?(Array)
-          self.message_origins = value
-        end
-      end
-
       if attributes.has_key?(:'pingFrequency')
         self.ping_frequency = attributes[:'pingFrequency']
       end
@@ -180,19 +160,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'xFrameOptionsAllowFromUrl')
         self.x_frame_options_allow_from_url = attributes[:'xFrameOptionsAllowFromUrl']
       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.
@@ -205,8 +186,6 @@ module DocuSign_eSign
           authentication_method == o.authentication_method &&
           client_user_id == o.client_user_id &&
           email == o.email &&
-          frame_ancestors == o.frame_ancestors &&
-          message_origins == o.message_origins &&
           ping_frequency == o.ping_frequency &&
           ping_url == o.ping_url &&
           recipient_id == o.recipient_id &&
@@ -227,7 +206,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [assertion_id, authentication_instant, authentication_method, client_user_id, email, frame_ancestors, message_origins, ping_frequency, ping_url, recipient_id, return_url, security_domain, user_id, user_name, x_frame_options, x_frame_options_allow_from_url].hash
+      [assertion_id, authentication_instant, authentication_method, client_user_id, email, ping_frequency, ping_url, recipient_id, return_url, security_domain, user_id, user_name, x_frame_options, x_frame_options_allow_from_url].hash
     end
 
     # Builds the object from hash
@@ -237,10 +216,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]]))
@@ -322,7 +301,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) }
@@ -335,4 +314,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipients.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
 
@@ -49,6 +49,7 @@ module DocuSign_eSign
     # 
     attr_accessor :witnesses
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -91,7 +92,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?(:'agents')
         if (value = attributes[:'agents']).is_a?(Array)
@@ -158,19 +159,20 @@ module DocuSign_eSign
           self.witnesses = 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.
@@ -211,10 +213,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]]))
@@ -296,7 +298,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) }
@@ -309,4 +311,5 @@ module DocuSign_eSign
     end
 
   end
+
 end