Class: DocuSign_eSign::LoginAccount

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoginAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
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
 
# File 'lib/docusign_esign/models/login_account.rb', line 87

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

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

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

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

  if attributes.has_key?(:'loginAccountSettings')
    if (value = attributes[:'loginAccountSettings']).is_a?(Array)
      self. = value
    end
  end

  if attributes.has_key?(:'loginUserSettings')
    if (value = attributes[:'loginUserSettings']).is_a?(Array)
      self. = value
    end
  end

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

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

  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

#account_id ⇒ Object

The account ID associated with the envelope.



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

def 
  @account_id
end

#account_id_guid ⇒ Object

The GUID associated with the account ID.



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

def 
  @account_id_guid
end

#base_url ⇒ Object

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri’s that are relative to this baseUrl.



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

def base_url
  @base_url
end

#email ⇒ Object

The email address for the user.



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

def email
  @email
end

#is_default ⇒ Object

This value is true if this is the default account for the user, otherwise false is returned.



30
31
32
 
# File 'lib/docusign_esign/models/login_account.rb', line 30

def is_default
  @is_default
end

#login_account_settings ⇒ Object

A list of settings on the acccount that indicate what features are available.



33
34
35
 
# File 'lib/docusign_esign/models/login_account.rb', line 33

def 
  @login_account_settings
end

#login_user_settings ⇒ Object

A list of user-level settings that indicate what user-specific features are available.



36
37
38
 
# File 'lib/docusign_esign/models/login_account.rb', line 36

def 
  @login_user_settings
end

#name ⇒ Object

The name associated with the account.



39
40
41
 
# File 'lib/docusign_esign/models/login_account.rb', line 39

def name
  @name
end

#site_description ⇒ Object

An optional descirption of the site that hosts the account.



42
43
44
 
# File 'lib/docusign_esign/models/login_account.rb', line 42

def site_description
  @site_description
end

#user_id ⇒ Object

Returns the value of attribute user_id.



45
46
47
 
# File 'lib/docusign_esign/models/login_account.rb', line 45

def user_id
  @user_id
end

#user_name ⇒ Object

The name of this user as defined by the account.



48
49
50
 
# File 'lib/docusign_esign/models/login_account.rb', line 48

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/docusign_esign/models/login_account.rb', line 52

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'account_id_guid' => :'accountIdGuid',
    :'base_url' => :'baseUrl',
    :'email' => :'email',
    :'is_default' => :'isDefault',
    :'login_account_settings' => :'loginAccountSettings',
    :'login_user_settings' => :'loginUserSettings',
    :'name' => :'name',
    :'site_description' => :'siteDescription',
    :'user_id' => :'userId',
    :'user_name' => :'userName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/docusign_esign/models/login_account.rb', line 69

def self.swagger_types
  {
    :'account_id' => :'String',
    :'account_id_guid' => :'String',
    :'base_url' => :'String',
    :'email' => :'String',
    :'is_default' => :'String',
    :'login_account_settings' => :'Array<NameValue>',
    :'login_user_settings' => :'Array<NameValue>',
    :'name' => :'String',
    :'site_description' => :'String',
    :'user_id' => :'String',
    :'user_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/docusign_esign/models/login_account.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      base_url == o.base_url &&
      email == o.email &&
      is_default == o.is_default &&
       == o. &&
       == o. &&
      name == o.name &&
      site_description == o.site_description &&
      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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/docusign_esign/models/login_account.rb', line 210

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/docusign_esign/models/login_account.rb', line 276

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/docusign_esign/models/login_account.rb', line 189

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


176
177
178
 
# File 'lib/docusign_esign/models/login_account.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/docusign_esign/models/login_account.rb', line 182

def hash
  [, , base_url, email, is_default, , , name, site_description, 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 properies with the reasons



145
146
147
148
 
# File 'lib/docusign_esign/models/login_account.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  return 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



256
257
258
 
# File 'lib/docusign_esign/models/login_account.rb', line 256

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/docusign_esign/models/login_account.rb', line 262

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



250
251
252
 
# File 'lib/docusign_esign/models/login_account.rb', line 250

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



152
153
154
 
# File 'lib/docusign_esign/models/login_account.rb', line 152

def valid?
  return true
end