Class: DocuSign_eSign::UserInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/user_info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
# File 'lib/docusign_esign/models/user_info.rb', line 95

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_idObject

The account ID associated with the envelope.


18
19
20
# File 'lib/docusign_esign/models/user_info.rb', line 18

def 
  @account_id
end

#account_nameObject

Returns the value of attribute account_name


21
22
23
# File 'lib/docusign_esign/models/user_info.rb', line 21

def 
  @account_name
end

#activation_access_codeObject

Returns the value of attribute activation_access_code


24
25
26
# File 'lib/docusign_esign/models/user_info.rb', line 24

def activation_access_code
  @activation_access_code
end

#emailObject

Returns the value of attribute email


27
28
29
# File 'lib/docusign_esign/models/user_info.rb', line 27

def email
  @email
end

#error_detailsObject

Returns the value of attribute error_details


29
30
31
# File 'lib/docusign_esign/models/user_info.rb', line 29

def error_details
  @error_details
end

#login_statusObject

Returns the value of attribute login_status


32
33
34
# File 'lib/docusign_esign/models/user_info.rb', line 32

def 
  @login_status
end

#membership_idObject

Returns the value of attribute membership_id


35
36
37
# File 'lib/docusign_esign/models/user_info.rb', line 35

def membership_id
  @membership_id
end

#send_activation_emailObject

Returns the value of attribute send_activation_email


38
39
40
# File 'lib/docusign_esign/models/user_info.rb', line 38

def send_activation_email
  @send_activation_email
end

#uriObject

Returns the value of attribute uri


41
42
43
# File 'lib/docusign_esign/models/user_info.rb', line 41

def uri
  @uri
end

#user_idObject

Returns the value of attribute user_id


44
45
46
# File 'lib/docusign_esign/models/user_info.rb', line 44

def user_id
  @user_id
end

#user_nameObject

Returns the value of attribute user_name


47
48
49
# File 'lib/docusign_esign/models/user_info.rb', line 47

def user_name
  @user_name
end

#user_statusObject

Returns the value of attribute user_status


50
51
52
# File 'lib/docusign_esign/models/user_info.rb', line 50

def user_status
  @user_status
end

#user_typeObject

Returns the value of attribute user_type


53
54
55
# File 'lib/docusign_esign/models/user_info.rb', line 53

def user_type
  @user_type
end

Class Method Details

.attribute_mapObject

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


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/docusign_esign/models/user_info.rb', line 56

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'account_name' => :'accountName',
    :'activation_access_code' => :'activationAccessCode',
    :'email' => :'email',
    :'error_details' => :'errorDetails',
    :'login_status' => :'loginStatus',
    :'membership_id' => :'membershipId',
    :'send_activation_email' => :'sendActivationEmail',
    :'uri' => :'uri',
    :'user_id' => :'userId',
    :'user_name' => :'userName',
    :'user_status' => :'userStatus',
    :'user_type' => :'userType'
  }
end

.swagger_typesObject

Attribute type mapping.


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/docusign_esign/models/user_info.rb', line 75

def self.swagger_types
  {
    :'account_id' => :'String',
    :'account_name' => :'String',
    :'activation_access_code' => :'String',
    :'email' => :'String',
    :'error_details' => :'ErrorDetails',
    :'login_status' => :'String',
    :'membership_id' => :'String',
    :'send_activation_email' => :'String',
    :'uri' => :'String',
    :'user_id' => :'String',
    :'user_name' => :'String',
    :'user_status' => :'String',
    :'user_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/docusign_esign/models/user_info.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      activation_access_code == o.activation_access_code &&
      email == o.email &&
      error_details == o.error_details &&
       == o. &&
      membership_id == o.membership_id &&
      send_activation_email == o.send_activation_email &&
      uri == o.uri &&
      user_id == o.user_id &&
      user_name == o.user_name &&
      user_status == o.user_status &&
      user_type == o.user_type
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


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/docusign_esign/models/user_info.rb', line 223

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_eSign.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


289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/docusign_esign/models/user_info.rb', line 289

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


202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/docusign_esign/models/user_info.rb', line 202

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

189
190
191
# File 'lib/docusign_esign/models/user_info.rb', line 189

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


195
196
197
# File 'lib/docusign_esign/models/user_info.rb', line 195

def hash
  [, , activation_access_code, email, error_details, , membership_id, send_activation_email, uri, user_id, user_name, user_status, user_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


156
157
158
159
# File 'lib/docusign_esign/models/user_info.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


269
270
271
# File 'lib/docusign_esign/models/user_info.rb', line 269

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


275
276
277
278
279
280
281
282
283
# File 'lib/docusign_esign/models/user_info.rb', line 275

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


263
264
265
# File 'lib/docusign_esign/models/user_info.rb', line 263

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


163
164
165
# File 'lib/docusign_esign/models/user_info.rb', line 163

def valid?
  true
end