signer.rb in signrequest_client-1.1.0

- old
+ new

@@ -4,18 +4,17 @@
 #API for SignRequest.com
 
 OpenAPI spec version: v1
 Contact: tech-support@signrequest.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.8
 
 =end
 
 require 'date'
 
 module SignRequestClient
-
   class Signer
     attr_accessor :email
 
     attr_accessor :display_name
 
@@ -69,20 +68,28 @@
 
     attr_accessor :embed_url_user_id
 
     attr_accessor :inputs
 
+    # Place an approval stamp on a document when a signer approves a document
+    attr_accessor :use_stamp_for_approve_only
+
     attr_accessor :embed_url
 
     attr_accessor :attachments
 
     attr_accessor :redirect_url
 
+    attr_accessor :redirect_url_declined
+
     attr_accessor :after_document
 
     attr_accessor :integrations
 
+    # Require the signer to enter this password before signing a document. This field is write only.
+    attr_accessor :password
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
 
       def initialize(datatype, allowable_values)
@@ -132,15 +139,18 @@
         :'forwarded_to_email' => :'forwarded_to_email',
         :'forwarded_reason' => :'forwarded_reason',
         :'message' => :'message',
         :'embed_url_user_id' => :'embed_url_user_id',
         :'inputs' => :'inputs',
+        :'use_stamp_for_approve_only' => :'use_stamp_for_approve_only',
         :'embed_url' => :'embed_url',
         :'attachments' => :'attachments',
         :'redirect_url' => :'redirect_url',
+        :'redirect_url_declined' => :'redirect_url_declined',
         :'after_document' => :'after_document',
-        :'integrations' => :'integrations'
+        :'integrations' => :'integrations',
+        :'password' => :'password'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
@@ -171,25 +181,28 @@
         :'forwarded_to_email' => :'String',
         :'forwarded_reason' => :'String',
         :'message' => :'String',
         :'embed_url_user_id' => :'String',
         :'inputs' => :'Array<SignerInputs>',
+        :'use_stamp_for_approve_only' => :'BOOLEAN',
         :'embed_url' => :'String',
         :'attachments' => :'Array<SignerAttachment>',
         :'redirect_url' => :'String',
+        :'redirect_url_declined' => :'String',
         :'after_document' => :'String',
-        :'integrations' => :'Array<InlineDocumentSignerIntegrationData>'
+        :'integrations' => :'Array<InlineDocumentSignerIntegrationData>',
+        :'password' => :'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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'email')
         self.email = attributes[:'email']
       end
 
@@ -303,10 +316,14 @@
         if (value = attributes[:'inputs']).is_a?(Array)
           self.inputs = value
         end
       end
 
+      if attributes.has_key?(:'use_stamp_for_approve_only')
+        self.use_stamp_for_approve_only = attributes[:'use_stamp_for_approve_only']
+      end
+
       if attributes.has_key?(:'embed_url')
         self.embed_url = attributes[:'embed_url']
       end
 
       if attributes.has_key?(:'attachments')
@@ -317,91 +334,106 @@
 
       if attributes.has_key?(:'redirect_url')
         self.redirect_url = attributes[:'redirect_url']
       end
 
+      if attributes.has_key?(:'redirect_url_declined')
+        self.redirect_url_declined = attributes[:'redirect_url_declined']
+      end
+
       if attributes.has_key?(:'after_document')
         self.after_document = attributes[:'after_document']
       end
 
       if attributes.has_key?(:'integrations')
         if (value = attributes[:'integrations']).is_a?(Array)
           self.integrations = value
         end
       end
 
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      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
       if @email.nil?
-        invalid_properties.push("invalid value for 'email', email cannot be nil.")
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
       if @email.to_s.length > 255
-        invalid_properties.push("invalid value for 'email', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.')
       end
 
       if @email.to_s.length < 1
-        invalid_properties.push("invalid value for 'email', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
       end
 
       if !@display_name.nil? && @display_name.to_s.length < 1
-        invalid_properties.push("invalid value for 'display_name', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "display_name", the character length must be great than or equal to 1.')
       end
 
       if !@first_name.nil? && @first_name.to_s.length > 255
-        invalid_properties.push("invalid value for 'first_name', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 255.')
       end
 
       if !@last_name.nil? && @last_name.to_s.length > 255
-        invalid_properties.push("invalid value for 'last_name', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 255.')
       end
 
       if !@order.nil? && @order > 2147483647
-        invalid_properties.push("invalid value for 'order', must be smaller than or equal to 2147483647.")
+        invalid_properties.push('invalid value for "order", must be smaller than or equal to 2147483647.')
       end
 
       if !@order.nil? && @order < 0
-        invalid_properties.push("invalid value for 'order', must be greater than or equal to 0.")
+        invalid_properties.push('invalid value for "order", must be greater than or equal to 0.')
       end
 
       if !@verify_phone_number.nil? && @verify_phone_number.to_s.length > 255
-        invalid_properties.push("invalid value for 'verify_phone_number', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "verify_phone_number", the character length must be smaller than or equal to 255.')
       end
 
       if !@verify_bank_account.nil? && @verify_bank_account.to_s.length > 255
-        invalid_properties.push("invalid value for 'verify_bank_account', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "verify_bank_account", the character length must be smaller than or equal to 255.')
       end
 
       if !@forwarded_to_email.nil? && @forwarded_to_email.to_s.length < 1
-        invalid_properties.push("invalid value for 'forwarded_to_email', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "forwarded_to_email", the character length must be great than or equal to 1.')
       end
 
       if !@forwarded_reason.nil? && @forwarded_reason.to_s.length < 1
-        invalid_properties.push("invalid value for 'forwarded_reason', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "forwarded_reason", the character length must be great than or equal to 1.')
       end
 
       if !@message.nil? && @message.to_s.length < 1
-        invalid_properties.push("invalid value for 'message', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "message", the character length must be great than or equal to 1.')
       end
 
       if !@embed_url_user_id.nil? && @embed_url_user_id.to_s.length > 255
-        invalid_properties.push("invalid value for 'embed_url_user_id', the character length must be smaller than or equal to 255.")
+        invalid_properties.push('invalid value for "embed_url_user_id", the character length must be smaller than or equal to 255.')
       end
 
       if !@embed_url.nil? && @embed_url.to_s.length < 1
-        invalid_properties.push("invalid value for 'embed_url', the character length must be great than or equal to 1.")
+        invalid_properties.push('invalid value for "embed_url", the character length must be great than or equal to 1.')
       end
 
       if !@redirect_url.nil? && @redirect_url.to_s.length > 2100
-        invalid_properties.push("invalid value for 'redirect_url', the character length must be smaller than or equal to 2100.")
+        invalid_properties.push('invalid value for "redirect_url", the character length must be smaller than or equal to 2100.')
       end
 
-      return invalid_properties
+      if !@redirect_url_declined.nil? && @redirect_url_declined.to_s.length > 2100
+        invalid_properties.push('invalid value for "redirect_url_declined", the character length must be smaller than or equal to 2100.')
+      end
+
+      if !@password.nil? && @password.to_s.length < 1
+        invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.')
+      end
+
+      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?
@@ -411,187 +443,197 @@
       return false if !@display_name.nil? && @display_name.to_s.length < 1
       return false if !@first_name.nil? && @first_name.to_s.length > 255
       return false if !@last_name.nil? && @last_name.to_s.length > 255
       return false if !@order.nil? && @order > 2147483647
       return false if !@order.nil? && @order < 0
-      language_validator = EnumAttributeValidator.new('String', ["en", "en-gb", "nl", "fr", "de", "he", "da", "fi", "hu", "it", "no", "pl", "pt", "es", "sv", "ru"])
+      language_validator = EnumAttributeValidator.new('String', ['en', 'en-gb', 'nl', 'fr', 'de', 'he', 'da', 'fi', 'hu', 'it', 'no', 'pl', 'pt', 'es', 'sv', 'ru'])
       return false unless language_validator.valid?(@language)
       return false if !@verify_phone_number.nil? && @verify_phone_number.to_s.length > 255
       return false if !@verify_bank_account.nil? && @verify_bank_account.to_s.length > 255
       return false if !@forwarded_to_email.nil? && @forwarded_to_email.to_s.length < 1
       return false if !@forwarded_reason.nil? && @forwarded_reason.to_s.length < 1
       return false if !@message.nil? && @message.to_s.length < 1
       return false if !@embed_url_user_id.nil? && @embed_url_user_id.to_s.length > 255
       return false if !@embed_url.nil? && @embed_url.to_s.length < 1
       return false if !@redirect_url.nil? && @redirect_url.to_s.length > 2100
-      return true
+      return false if !@redirect_url_declined.nil? && @redirect_url_declined.to_s.length > 2100
+      return false if !@password.nil? && @password.to_s.length < 1
+      true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] email Value to be assigned
     def email=(email)
       if email.nil?
-        fail ArgumentError, "email cannot be nil"
+        fail ArgumentError, 'email cannot be nil'
       end
 
       if email.to_s.length > 255
-        fail ArgumentError, "invalid value for 'email', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 255.'
       end
 
       if email.to_s.length < 1
-        fail ArgumentError, "invalid value for 'email', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.'
       end
 
       @email = email
     end
 
     # Custom attribute writer method with validation
     # @param [Object] display_name Value to be assigned
     def display_name=(display_name)
-
       if !display_name.nil? && display_name.to_s.length < 1
-        fail ArgumentError, "invalid value for 'display_name', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "display_name", the character length must be great than or equal to 1.'
       end
 
       @display_name = display_name
     end
 
     # Custom attribute writer method with validation
     # @param [Object] first_name Value to be assigned
     def first_name=(first_name)
-
       if !first_name.nil? && first_name.to_s.length > 255
-        fail ArgumentError, "invalid value for 'first_name', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 255.'
       end
 
       @first_name = first_name
     end
 
     # Custom attribute writer method with validation
     # @param [Object] last_name Value to be assigned
     def last_name=(last_name)
-
       if !last_name.nil? && last_name.to_s.length > 255
-        fail ArgumentError, "invalid value for 'last_name', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 255.'
       end
 
       @last_name = last_name
     end
 
     # Custom attribute writer method with validation
     # @param [Object] order Value to be assigned
     def order=(order)
-
       if !order.nil? && order > 2147483647
-        fail ArgumentError, "invalid value for 'order', must be smaller than or equal to 2147483647."
+        fail ArgumentError, 'invalid value for "order", must be smaller than or equal to 2147483647.'
       end
 
       if !order.nil? && order < 0
-        fail ArgumentError, "invalid value for 'order', must be greater than or equal to 0."
+        fail ArgumentError, 'invalid value for "order", must be greater than or equal to 0.'
       end
 
       @order = order
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] language Object to be assigned
     def language=(language)
-      validator = EnumAttributeValidator.new('String', ["en", "en-gb", "nl", "fr", "de", "he", "da", "fi", "hu", "it", "no", "pl", "pt", "es", "sv", "ru"])
+      validator = EnumAttributeValidator.new('String', ['en', 'en-gb', 'nl', 'fr', 'de', 'he', 'da', 'fi', 'hu', 'it', 'no', 'pl', 'pt', 'es', 'sv', 'ru'])
       unless validator.valid?(language)
-        fail ArgumentError, "invalid value for 'language', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "language", must be one of #{validator.allowable_values}.'
       end
       @language = language
     end
 
     # Custom attribute writer method with validation
     # @param [Object] verify_phone_number Value to be assigned
     def verify_phone_number=(verify_phone_number)
-
       if !verify_phone_number.nil? && verify_phone_number.to_s.length > 255
-        fail ArgumentError, "invalid value for 'verify_phone_number', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "verify_phone_number", the character length must be smaller than or equal to 255.'
       end
 
       @verify_phone_number = verify_phone_number
     end
 
     # Custom attribute writer method with validation
     # @param [Object] verify_bank_account Value to be assigned
     def verify_bank_account=(verify_bank_account)
-
       if !verify_bank_account.nil? && verify_bank_account.to_s.length > 255
-        fail ArgumentError, "invalid value for 'verify_bank_account', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "verify_bank_account", the character length must be smaller than or equal to 255.'
       end
 
       @verify_bank_account = verify_bank_account
     end
 
     # Custom attribute writer method with validation
     # @param [Object] forwarded_to_email Value to be assigned
     def forwarded_to_email=(forwarded_to_email)
-
       if !forwarded_to_email.nil? && forwarded_to_email.to_s.length < 1
-        fail ArgumentError, "invalid value for 'forwarded_to_email', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "forwarded_to_email", the character length must be great than or equal to 1.'
       end
 
       @forwarded_to_email = forwarded_to_email
     end
 
     # Custom attribute writer method with validation
     # @param [Object] forwarded_reason Value to be assigned
     def forwarded_reason=(forwarded_reason)
-
       if !forwarded_reason.nil? && forwarded_reason.to_s.length < 1
-        fail ArgumentError, "invalid value for 'forwarded_reason', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "forwarded_reason", the character length must be great than or equal to 1.'
       end
 
       @forwarded_reason = forwarded_reason
     end
 
     # Custom attribute writer method with validation
     # @param [Object] message Value to be assigned
     def message=(message)
-
       if !message.nil? && message.to_s.length < 1
-        fail ArgumentError, "invalid value for 'message', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "message", the character length must be great than or equal to 1.'
       end
 
       @message = message
     end
 
     # Custom attribute writer method with validation
     # @param [Object] embed_url_user_id Value to be assigned
     def embed_url_user_id=(embed_url_user_id)
-
       if !embed_url_user_id.nil? && embed_url_user_id.to_s.length > 255
-        fail ArgumentError, "invalid value for 'embed_url_user_id', the character length must be smaller than or equal to 255."
+        fail ArgumentError, 'invalid value for "embed_url_user_id", the character length must be smaller than or equal to 255.'
       end
 
       @embed_url_user_id = embed_url_user_id
     end
 
     # Custom attribute writer method with validation
     # @param [Object] embed_url Value to be assigned
     def embed_url=(embed_url)
-
       if !embed_url.nil? && embed_url.to_s.length < 1
-        fail ArgumentError, "invalid value for 'embed_url', the character length must be great than or equal to 1."
+        fail ArgumentError, 'invalid value for "embed_url", the character length must be great than or equal to 1.'
       end
 
       @embed_url = embed_url
     end
 
     # Custom attribute writer method with validation
     # @param [Object] redirect_url Value to be assigned
     def redirect_url=(redirect_url)
-
       if !redirect_url.nil? && redirect_url.to_s.length > 2100
-        fail ArgumentError, "invalid value for 'redirect_url', the character length must be smaller than or equal to 2100."
+        fail ArgumentError, 'invalid value for "redirect_url", the character length must be smaller than or equal to 2100.'
       end
 
       @redirect_url = redirect_url
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] redirect_url_declined Value to be assigned
+    def redirect_url_declined=(redirect_url_declined)
+      if !redirect_url_declined.nil? && redirect_url_declined.to_s.length > 2100
+        fail ArgumentError, 'invalid value for "redirect_url_declined", the character length must be smaller than or equal to 2100.'
+      end
+
+      @redirect_url_declined = redirect_url_declined
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] password Value to be assigned
+    def password=(password)
+      if !password.nil? && password.to_s.length < 1
+        fail ArgumentError, 'invalid value for "password", the character length must be great than or equal to 1.'
+      end
+
+      @password = password
+    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 &&
@@ -621,15 +663,18 @@
           forwarded_to_email == o.forwarded_to_email &&
           forwarded_reason == o.forwarded_reason &&
           message == o.message &&
           embed_url_user_id == o.embed_url_user_id &&
           inputs == o.inputs &&
+          use_stamp_for_approve_only == o.use_stamp_for_approve_only &&
           embed_url == o.embed_url &&
           attachments == o.attachments &&
           redirect_url == o.redirect_url &&
+          redirect_url_declined == o.redirect_url_declined &&
           after_document == o.after_document &&
-          integrations == o.integrations
+          integrations == o.integrations &&
+          password == o.password
     end
 
     # @see the `==` method
     # @param [Object] Object to be compared
     def eql?(o)
@@ -637,11 +682,11 @@
     end
 
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email, display_name, first_name, last_name, email_viewed, viewed, signed, downloaded, signed_on, needs_to_sign, approve_only, notify_only, in_person, order, language, force_language, emailed, verify_phone_number, verify_bank_account, declined, declined_on, forwarded, forwarded_on, forwarded_to_email, forwarded_reason, message, embed_url_user_id, inputs, embed_url, attachments, redirect_url, after_document, integrations].hash
+      [email, display_name, first_name, last_name, email_viewed, viewed, signed, downloaded, signed_on, needs_to_sign, approve_only, notify_only, in_person, order, language, force_language, emailed, verify_phone_number, verify_bank_account, declined, declined_on, forwarded, forwarded_on, forwarded_to_email, forwarded_reason, message, embed_url_user_id, inputs, use_stamp_for_approve_only, embed_url, attachments, redirect_url, redirect_url_declined, after_document, integrations, password].hash
     end
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
@@ -650,11 +695,11 @@
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
           # 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]]))
         end # or else data not found in attributes(hash), not an issue as the data can be optional
       end
@@ -732,20 +777,18 @@
     # 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) }
+        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