class YousignClient::MemberInput
Attributes
Email of an external member. Required if user field is blank
Firstname of an external member. Required if user field is blank
Lastname of an external member. Required if user field is blank
Phone of an external member. Required if user field is blank
If the procedure have the boolean "ordered" at true, you can define position of the order to invite your members to sign. Only the first member will be invited to sign. When the first member have signed, the second will be invited, etc…
Procedure id reference
Type of a member. "signer" to sign documents (legally) and "validator" to validate documents.
ID of the user in your companies. Informations about the member will be duplicate (first name, last name, email and phone number). Required if none of fields above are specified.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/yousign_client/models/member_input.rb, line 72 def self.attribute_map { :'user' => :'user', :'type' => :'type', :'firstname' => :'firstname', :'lastname' => :'lastname', :'email' => :'email', :'phone' => :'phone', :'position' => :'position', :'file_objects' => :'fileObjects', :'procedure' => :'procedure', :'operation_level' => :'operationLevel', :'operation_custom_modes' => :'operationCustomModes', :'mode_sms_configuration' => :'modeSmsConfiguration' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/yousign_client/models/member_input.rb, line 109 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 } if attributes.has_key?(:'user') self.user = attributes[:'user'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] else self.type = 'signer' end if attributes.has_key?(:'firstname') self.firstname = attributes[:'firstname'] end if attributes.has_key?(:'lastname') self.lastname = attributes[:'lastname'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'phone') self.phone = attributes[:'phone'] end if attributes.has_key?(:'position') self.position = attributes[:'position'] end if attributes.has_key?(:'fileObjects') if (value = attributes[:'fileObjects']).is_a?(Array) self.file_objects = value end end if attributes.has_key?(:'procedure') self.procedure = attributes[:'procedure'] end if attributes.has_key?(:'operationLevel') self.operation_level = attributes[:'operationLevel'] end if attributes.has_key?(:'operationCustomModes') if (value = attributes[:'operationCustomModes']).is_a?(Array) self.operation_custom_modes = value end end if attributes.has_key?(:'modeSmsConfiguration') self.mode_sms_configuration = attributes[:'modeSmsConfiguration'] end end
Attribute type mapping.
# File lib/yousign_client/models/member_input.rb, line 90 def self.swagger_types { :'user' => :'String', :'type' => :'String', :'firstname' => :'String', :'lastname' => :'String', :'email' => :'String', :'phone' => :'String', :'position' => :'Integer', :'file_objects' => :'Array<FileObjectInput>', :'procedure' => :'String', :'operation_level' => :'String', :'operation_custom_modes' => :'Array<String>', :'mode_sms_configuration' => :'ModeSmsConfiguration' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/yousign_client/models/member_input.rb, line 209 def ==(o) return true if self.equal?(o) self.class == o.class && user == o.user && type == o.type && firstname == o.firstname && lastname == o.lastname && email == o.email && phone == o.phone && position == o.position && file_objects == o.file_objects && procedure == o.procedure && operation_level == o.operation_level && operation_custom_modes == o.operation_custom_modes && mode_sms_configuration == o.mode_sms_configuration end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/yousign_client/models/member_input.rb, line 262 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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 temp_model = YousignClient.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/yousign_client/models/member_input.rb, line 328 def _to_hash(value) if value.is_a?(Array) 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/yousign_client/models/member_input.rb, line 241 def build_from_hash(attributes) 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 # 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) }) 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 self end
@see the `==` method @param [Object] Object to be compared
# File lib/yousign_client/models/member_input.rb, line 228 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/yousign_client/models/member_input.rb, line 234 def hash [user, type, firstname, lastname, email, phone, position, file_objects, procedure, operation_level, operation_custom_modes, mode_sms_configuration].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/yousign_client/models/member_input.rb, line 172 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] operation_level
Object to be assigned
# File lib/yousign_client/models/member_input.rb, line 199 def operation_level=(operation_level) validator = EnumAttributeValidator.new('String', ['none', 'custom', 'advanced']) unless validator.valid?(operation_level) fail ArgumentError, 'invalid value for "operation_level", must be one of #{validator.allowable_values}.' end @operation_level = operation_level end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/yousign_client/models/member_input.rb, line 314 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/yousign_client/models/member_input.rb, line 302 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/yousign_client/models/member_input.rb, line 189 def type=(type) validator = EnumAttributeValidator.new('String', ['signer', 'validator']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/yousign_client/models/member_input.rb, line 179 def valid? type_validator = EnumAttributeValidator.new('String', ['signer', 'validator']) return false unless type_validator.valid?(@type) operation_level_validator = EnumAttributeValidator.new('String', ['none', 'custom', 'advanced']) return false unless operation_level_validator.valid?(@operation_level) true end