Class: DocuSign_WebForms::WebFormUserInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_webforms/models/web_form_user_info.rb

Overview

Information about a DocuSign system user. The user exists within the account associated with the form.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebFormUserInfo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 40

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?(:'userId')
    self.user_id = attributes[:'userId']
  end

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

Instance Attribute Details

#user_id ⇒ Object

Returns the value of attribute user_id.



17
18
19
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 17

def user_id
  @user_id
end

#user_name ⇒ Object

Name of the user that can be displayed in the user interface.



20
21
22
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 20

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 23

def self.attribute_map
  {
    :'user_id' => :'userId',
    :'user_name' => :'userName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 31

def self.swagger_types
  {
    :'user_id' => :'String',
    :'user_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



85
86
87
88
89
90
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 85

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      user_name == o.user_name
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 128

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 = DocuSign_WebForms.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 194

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 107

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


94
95
96
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 94

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



100
101
102
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 100

def hash
  [user_id, user_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



57
58
59
60
61
62
63
64
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 57

def list_invalid_properties
  invalid_properties = Array.new
  if !@user_name.nil? && @user_name.to_s.length > 150
    invalid_properties.push('invalid value for "user_name", the character length must be smaller than or equal to 150.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 174

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 180

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



168
169
170
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 168

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



68
69
70
71
 
# File 'lib/docusign_webforms/models/web_form_user_info.rb', line 68

def valid?
  return false if !@user_name.nil? && @user_name.to_s.length > 150
  true
end