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


86
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
# File 'lib/docusign_esign/models/login_account.rb', line 86

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_idObject

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_guidObject

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_urlObject

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

#emailObject

The email address for the user.


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

def email
  @email
end

#is_defaultObject

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_settingsObject

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_settingsObject

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

#nameObject

The name associated with the account.


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

def name
  @name
end

#site_descriptionObject

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_idObject

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_nameObject

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_mapObject

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


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

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_typesObject

Attribute type mapping.


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

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


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

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


208
209
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
# File 'lib/docusign_esign/models/login_account.rb', line 208

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


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

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


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

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

174
175
176
# File 'lib/docusign_esign/models/login_account.rb', line 174

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


180
181
182
# File 'lib/docusign_esign/models/login_account.rb', line 180

def hash
  [, , base_url, email, is_default, , , name, site_description, user_id, user_name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


143
144
145
146
# File 'lib/docusign_esign/models/login_account.rb', line 143

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


254
255
256
# File 'lib/docusign_esign/models/login_account.rb', line 254

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


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

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


248
249
250
# File 'lib/docusign_esign/models/login_account.rb', line 248

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


150
151
152
# File 'lib/docusign_esign/models/login_account.rb', line 150

def valid?
  true
end