class YousignClient::UserOutput
Attributes
Created date of the object
ID of the default sign image.
Defines if the User is deleted or not
Defines the date where the user has been deleted
User's email address
Defines if the fast signature is available for the user on the Yousign application
User's firstname
User's full name
Object's ID
Internal usage, should not be used
User's lastname
ID of the organization the user belongs to
User's phone number (mobiles and landline telephones are supported). Phone number must be formatted to E164 (en.wikipedia.org/wiki/E.164) which includes the symbol '+' and the country code. For example : +33612131315. All countries are supported.
ID of SAML
User's status
User's title
Updated date of the object
List of workspaces to which the user is connected and has access
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/yousign_client/models/user_output.rb, line 102 def self.attribute_map { :'id' => :'id', :'firstname' => :'firstname', :'lastname' => :'lastname', :'email' => :'email', :'title' => :'title', :'phone' => :'phone', :'status' => :'status', :'organization' => :'organization', :'workspaces' => :'workspaces', :'permission' => :'permission', :'group' => :'group', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'deleted' => :'deleted', :'deleted_at' => :'deletedAt', :'config' => :'config', :'inwebo_user_request' => :'inweboUserRequest', :'saml_name_id' => :'samlNameId', :'default_sign_image' => :'defaultSignImage', :'notifications' => :'notifications', :'fast_sign' => :'fastSign', :'full_name' => :'fullName' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/yousign_client/models/user_output.rb, line 159 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?(:'id') self.id = attributes[:'id'] 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?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'phone') self.phone = attributes[:'phone'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end if attributes.has_key?(:'workspaces') if (value = attributes[:'workspaces']).is_a?(Array) self.workspaces = value end end if attributes.has_key?(:'permission') self.permission = attributes[:'permission'] end if attributes.has_key?(:'group') self.group = attributes[:'group'] end if attributes.has_key?(:'createdAt') self.created_at = attributes[:'createdAt'] end if attributes.has_key?(:'updatedAt') self.updated_at = attributes[:'updatedAt'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'deletedAt') self.deleted_at = attributes[:'deletedAt'] end if attributes.has_key?(:'config') self.config = attributes[:'config'] end if attributes.has_key?(:'inweboUserRequest') self.inwebo_user_request = attributes[:'inweboUserRequest'] end if attributes.has_key?(:'samlNameId') self.saml_name_id = attributes[:'samlNameId'] end if attributes.has_key?(:'defaultSignImage') self.default_sign_image = attributes[:'defaultSignImage'] end if attributes.has_key?(:'notifications') self.notifications = attributes[:'notifications'] end if attributes.has_key?(:'fastSign') self.fast_sign = attributes[:'fastSign'] end if attributes.has_key?(:'fullName') self.full_name = attributes[:'fullName'] end end
Attribute type mapping.
# File lib/yousign_client/models/user_output.rb, line 130 def self.swagger_types { :'id' => :'String', :'firstname' => :'String', :'lastname' => :'String', :'email' => :'String', :'title' => :'String', :'phone' => :'String', :'status' => :'String', :'organization' => :'String', :'workspaces' => :'Array<UserWorkspaceOutput>', :'permission' => :'String', :'group' => :'UserGroup', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'deleted' => :'BOOLEAN', :'deleted_at' => :'DateTime', :'config' => :'Object', :'inwebo_user_request' => :'String', :'saml_name_id' => :'String', :'default_sign_image' => :'String', :'notifications' => :'UserOutputNotifications', :'fast_sign' => :'BOOLEAN', :'full_name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/yousign_client/models/user_output.rb, line 298 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && firstname == o.firstname && lastname == o.lastname && email == o.email && title == o.title && phone == o.phone && status == o.status && organization == o.organization && workspaces == o.workspaces && permission == o.permission && group == o.group && created_at == o.created_at && updated_at == o.updated_at && deleted == o.deleted && deleted_at == o.deleted_at && config == o.config && inwebo_user_request == o.inwebo_user_request && saml_name_id == o.saml_name_id && default_sign_image == o.default_sign_image && notifications == o.notifications && fast_sign == o.fast_sign && full_name == o.full_name 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/user_output.rb, line 361 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/user_output.rb, line 427 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/user_output.rb, line 340 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/user_output.rb, line 327 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/yousign_client/models/user_output.rb, line 333 def hash [id, firstname, lastname, email, title, phone, status, organization, workspaces, permission, group, created_at, updated_at, deleted, deleted_at, config, inwebo_user_request, saml_name_id, default_sign_image, notifications, fast_sign, full_name].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/user_output.rb, line 258 def list_invalid_properties invalid_properties = Array.new if @firstname.nil? invalid_properties.push('invalid value for "firstname", firstname cannot be nil.') end if @lastname.nil? invalid_properties.push('invalid value for "lastname", lastname cannot be nil.') end if @email.nil? invalid_properties.push('invalid value for "email", email cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/yousign_client/models/user_output.rb, line 288 def status=(status) validator = EnumAttributeValidator.new('String', ['not_activated', 'activated']) unless validator.valid?(status) fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.' end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/yousign_client/models/user_output.rb, line 413 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/user_output.rb, line 401 def to_s to_hash.to_s 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/user_output.rb, line 277 def valid? return false if @firstname.nil? return false if @lastname.nil? return false if @email.nil? status_validator = EnumAttributeValidator.new('String', ['not_activated', 'activated']) return false unless status_validator.valid?(@status) true end