class YousignClient::UserInput

Attributes

config[RW]
default_sign_image[RW]

ID of file image

email[RW]

User's email address (This field is allowed only during creation)

firstname[RW]

User's firstname

group[RW]

User's UserGroup

lastname[RW]

User's lastname

notifications[RW]
permission[RW]
phone[RW]

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.

title[RW]

User's job title

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/yousign_client/models/user_input.rb, line 67
def self.attribute_map
  {
    :'firstname' => :'firstname',
    :'lastname' => :'lastname',
    :'email' => :'email',
    :'title' => :'title',
    :'phone' => :'phone',
    :'permission' => :'permission',
    :'group' => :'group',
    :'config' => :'config',
    :'default_sign_image' => :'defaultSignImage',
    :'notifications' => :'notifications'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/yousign_client/models/user_input.rb, line 100
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?(:'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?(:'permission')
    if (value = attributes[:'permission']).is_a?(Array)
      self.permission = value
    end
  end

  if attributes.has_key?(:'group')
    self.group = attributes[:'group']
  end

  if attributes.has_key?(:'config')
    self.config = attributes[:'config']
  end

  if attributes.has_key?(:'defaultSignImage')
    self.default_sign_image = attributes[:'defaultSignImage']
  end

  if attributes.has_key?(:'notifications')
    self.notifications = attributes[:'notifications']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/yousign_client/models/user_input.rb, line 83
def self.swagger_types
  {
    :'firstname' => :'String',
    :'lastname' => :'String',
    :'email' => :'String',
    :'title' => :'String',
    :'phone' => :'String',
    :'permission' => :'Array<String>',
    :'group' => :'String',
    :'config' => :'Object',
    :'default_sign_image' => :'String',
    :'notifications' => :'UserInputNotifications'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/yousign_client/models/user_input.rb, line 209
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      firstname == o.firstname &&
      lastname == o.lastname &&
      email == o.email &&
      title == o.title &&
      phone == o.phone &&
      permission == o.permission &&
      group == o.group &&
      config == o.config &&
      default_sign_image == o.default_sign_image &&
      notifications == o.notifications
end
_deserialize(type, value) click to toggle source

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_input.rb, line 260
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
_to_hash(value) click to toggle source

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_input.rb, line 326
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
build_from_hash(attributes) click to toggle source

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_input.rb, line 239
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
default_sign_image=(default_sign_image) click to toggle source

Custom attribute writer method with validation @param [Object] default_sign_image Value to be assigned

# File lib/yousign_client/models/user_input.rb, line 199
def default_sign_image=(default_sign_image)
  if !default_sign_image.nil? && default_sign_image !~ Regexp.new(/^\/files\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
    fail ArgumentError, 'invalid value for "default_sign_image", must conform to the pattern /^\/files\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.'
  end

  @default_sign_image = default_sign_image
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/yousign_client/models/user_input.rb, line 226
def eql?(o)
  self == o
end
group=(group) click to toggle source

Custom attribute writer method with validation @param [Object] group Value to be assigned

# File lib/yousign_client/models/user_input.rb, line 189
def group=(group)
  if !group.nil? && group !~ Regexp.new(/^\/user_groups\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
    fail ArgumentError, 'invalid value for "group", must conform to the pattern /^\/user_groups\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.'
  end

  @group = group
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/yousign_client/models/user_input.rb, line 232
def hash
  [firstname, lastname, email, title, phone, permission, group, config, default_sign_image, notifications].hash
end
list_invalid_properties() click to toggle source

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_input.rb, line 151
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

  if !@group.nil? && @group !~ Regexp.new(/^\/user_groups\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
    invalid_properties.push('invalid value for "group", must conform to the pattern /^\/user_groups\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.')
  end

  if !@default_sign_image.nil? && @default_sign_image !~ Regexp.new(/^\/files\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
    invalid_properties.push('invalid value for "default_sign_image", must conform to the pattern /^\/files\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/yousign_client/models/user_input.rb, line 306
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/yousign_client/models/user_input.rb, line 312
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/yousign_client/models/user_input.rb, line 300
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_input.rb, line 178
def valid?
  return false if @firstname.nil?
  return false if @lastname.nil?
  return false if @email.nil?
  return false if !@group.nil? && @group !~ Regexp.new(/^\/user_groups\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
  return false if !@default_sign_image.nil? && @default_sign_image !~ Regexp.new(/^\/files\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
  true
end