=begin #Dropbox Sign API #Dropbox Sign v3 API The version of the OpenAPI document: 3.0.0 Contact: apisupport@hellosign.com Generated by: https://openapi-generator.tech Generator version: 7.7.0 =end require 'date' require 'time' module Dropbox end module Dropbox::Sign class SubSignatureRequestTemplateSigner # Must match an existing role in chosen Template(s). It's case-sensitive. # @return [String] attr_accessor :role # The name of the signer. # @return [String] attr_accessor :name # The email address of the signer. # @return [String] attr_accessor :email_address # The 4- to 12-character access code that will secure this signer's signature page. # @return [String] attr_accessor :pin # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. # @return [String] attr_accessor :sms_phone_number # Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). # @return [String] attr_accessor :sms_phone_number_type class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values def initialize(datatype, allowable_values) @allowable_values = allowable_values.map do |value| case datatype.to_s when /Integer/i value.to_i when /Float/i value.to_f else value end end end def valid?(value) !value || allowable_values.include?(value) end end # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'role' => :'role', :'name' => :'name', :'email_address' => :'email_address', :'pin' => :'pin', :'sms_phone_number' => :'sms_phone_number', :'sms_phone_number_type' => :'sms_phone_number_type' } end # Returns all the JSON keys this model knows about def self.acceptable_attributes attribute_map.values end # Returns attribute map of this model + parent def self.merged_attributes self.attribute_map end # Attribute type mapping. def self.openapi_types { :'role' => :'String', :'name' => :'String', :'email_address' => :'String', :'pin' => :'String', :'sms_phone_number' => :'String', :'sms_phone_number_type' => :'String' } end # Attribute type mapping of this model + parent def self.merged_types self.openapi_types end # List of attributes with nullable: true def self.openapi_nullable Set.new([ ]) end # Returns list of attributes with nullable: true of this model + parent def self.merged_nullable self.openapi_nullable end # Attempt to instantiate and hydrate a new instance of this class # @param [Object] data Data to be converted # @return [SubSignatureRequestTemplateSigner] def self.init(data) return ApiClient.default.convert_to_type( data, "SubSignatureRequestTemplateSigner" ) || SubSignatureRequestTemplateSigner.new end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubSignatureRequestTemplateSigner` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestTemplateSigner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'role') self.role = attributes[:'role'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.key?(:'pin') self.pin = attributes[:'pin'] end if attributes.key?(:'sms_phone_number') self.sms_phone_number = attributes[:'sms_phone_number'] end if attributes.key?(:'sms_phone_number_type') self.sms_phone_number_type = attributes[:'sms_phone_number_type'] 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 @role.nil? invalid_properties.push('invalid value for "role", role cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @email_address.nil? invalid_properties.push('invalid value for "email_address", email_address cannot be nil.') end if !@pin.nil? && @pin.to_s.length > 12 invalid_properties.push('invalid value for "pin", the character length must be smaller than or equal to 12.') end if !@pin.nil? && @pin.to_s.length < 4 invalid_properties.push('invalid value for "pin", the character length must be great than or equal to 4.') 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? return false if @role.nil? return false if @name.nil? return false if @email_address.nil? return false if !@pin.nil? && @pin.to_s.length > 12 return false if !@pin.nil? && @pin.to_s.length < 4 sms_phone_number_type_validator = EnumAttributeValidator.new('String', ["authentication", "delivery"]) return false unless sms_phone_number_type_validator.valid?(@sms_phone_number_type) true end # Custom attribute writer method with validation # @param [Object] pin Value to be assigned def pin=(pin) if pin.to_s.length > 12 fail ArgumentError, 'invalid value for "pin", the character length must be smaller than or equal to 12.' end if pin.to_s.length < 4 fail ArgumentError, 'invalid value for "pin", the character length must be great than or equal to 4.' end @pin = pin end # Custom attribute writer method checking allowed values (enum). # @param [Object] sms_phone_number_type Object to be assigned def sms_phone_number_type=(sms_phone_number_type) validator = EnumAttributeValidator.new('String', ["authentication", "delivery"]) unless validator.valid?(sms_phone_number_type) fail ArgumentError, "invalid value for \"sms_phone_number_type\", must be one of #{validator.allowable_values}." end @sms_phone_number_type = sms_phone_number_type 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 && role == o.role && name == o.name && email_address == o.email_address && pin == o.pin && sms_phone_number == o.sms_phone_number && sms_phone_number_type == o.sms_phone_number_type end # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash [role, name, email_address, pin, sms_phone_number, sms_phone_number_type].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) new.build_from_hash(attributes) end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attribute_map = self.class.merged_attributes self.class.merged_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) end end self end # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) klass = Dropbox::Sign.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash(include_nil = true) hash = {} self.class.merged_attributes.each_pair do |attr, param| value = self.send(attr) if value.nil? next unless include_nil is_nullable = self.class.merged_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value, include_nil) end hash end # Outputs non-array value in the form of hash # For object, use to_hash. Otherwise, just return the value # @param [Object] value Any valid value # @return [Hash] Returns the value in the form of hash def _to_hash(value, include_nil = true) if value.is_a?(Array) value.compact.map { |v| _to_hash(v, include_nil) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v, include_nil) } end elsif value.respond_to? :to_hash value.to_hash(include_nil) else value end end end end