Class: Pipedrive::BaseUser

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/models/base_user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 139

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::BaseUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pipedrive::BaseUser`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

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

  if attributes.key?(:'default_currency')
    self.default_currency = attributes[:'default_currency']
  end

  if attributes.key?(:'locale')
    self.locale = attributes[:'locale']
  end

  if attributes.key?(:'lang')
    self.lang = attributes[:'lang']
  end

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

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.key?(:'activated')
    self.activated = attributes[:'activated']
  end

  if attributes.key?(:'last_login')
    self. = attributes[:'last_login']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'modified')
    self.modified = attributes[:'modified']
  end

  if attributes.key?(:'signup_flow_variation')
    self. = attributes[:'signup_flow_variation']
  end

  if attributes.key?(:'has_created_company')
    self.has_created_company = attributes[:'has_created_company']
  end

  if attributes.key?(:'is_admin')
    self.is_admin = attributes[:'is_admin']
  end

  if attributes.key?(:'active_flag')
    self.active_flag = attributes[:'active_flag']
  end

  if attributes.key?(:'timezone_name')
    self.timezone_name = attributes[:'timezone_name']
  end

  if attributes.key?(:'timezone_offset')
    self.timezone_offset = attributes[:'timezone_offset']
  end

  if attributes.key?(:'role_id')
    self.role_id = attributes[:'role_id']
  end

  if attributes.key?(:'icon_url')
    self.icon_url = attributes[:'icon_url']
  end

  if attributes.key?(:'is_you')
    self.is_you = attributes[:'is_you']
  end
end

Instance Attribute Details

#activated ⇒ Object

Boolean that indicates if the User is activated



39
40
41
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 39

def activated
  @activated
end

#active_flag ⇒ Object

Boolean that indicates if the User is activated



60
61
62
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 60

def active_flag
  @active_flag
end

#created ⇒ Object

The User creation date and time. Format: YYYY-MM-DD HH:MM:SS



45
46
47
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 45

def created
  @created
end

#default_currency ⇒ Object

The User default currency



24
25
26
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 24

def default_currency
  @default_currency
end

#email ⇒ Object

The User email



33
34
35
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 33

def email
  @email
end

#has_created_company ⇒ Object

Boolean that indicates if the User has created a Company



54
55
56
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 54

def has_created_company
  @has_created_company
end

#icon_url ⇒ Object

The User icon URL



72
73
74
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 72

def icon_url
  @icon_url
end

#id ⇒ Object

The User ID



18
19
20
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 18

def id
  @id
end

#is_admin ⇒ Object

Indication if the User is admin (1 = true, 0 = false)



57
58
59
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 57

def is_admin
  @is_admin
end

#is_you ⇒ Object

Boolean that indicates if the requested User is the same which is logged in (in this case, always true)



75
76
77
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 75

def is_you
  @is_you
end

#lang ⇒ Object

The User language ID



30
31
32
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 30

def lang
  @lang
end

#last_login ⇒ Object

The User last login date and time. Format: YYYY-MM-DD HH:MM:SS



42
43
44
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 42

def 
  @last_login
end

#locale ⇒ Object

The User locale



27
28
29
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 27

def locale
  @locale
end

#modified ⇒ Object

The User last modification date and time. Format: YYYY-MM-DD HH:MM:SS



48
49
50
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 48

def modified
  @modified
end

#name ⇒ Object

The User name



21
22
23
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 21

def name
  @name
end

#phone ⇒ Object

The User phone



36
37
38
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 36

def phone
  @phone
end

#role_id ⇒ Object

The ID of the User role



69
70
71
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 69

def role_id
  @role_id
end

#signup_flow_variation ⇒ Object

The variation of signup flow (if exists). E.g. google



51
52
53
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 51

def 
  @signup_flow_variation
end

#timezone_name ⇒ Object

The User timezone name



63
64
65
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 63

def timezone_name
  @timezone_name
end

#timezone_offset ⇒ Object

The User timezone offset



66
67
68
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 66

def timezone_offset
  @timezone_offset
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'default_currency' => :'default_currency',
    :'locale' => :'locale',
    :'lang' => :'lang',
    :'email' => :'email',
    :'phone' => :'phone',
    :'activated' => :'activated',
    :'last_login' => :'last_login',
    :'created' => :'created',
    :'modified' => :'modified',
    :'signup_flow_variation' => :'signup_flow_variation',
    :'has_created_company' => :'has_created_company',
    :'is_admin' => :'is_admin',
    :'active_flag' => :'active_flag',
    :'timezone_name' => :'timezone_name',
    :'timezone_offset' => :'timezone_offset',
    :'role_id' => :'role_id',
    :'icon_url' => :'icon_url',
    :'is_you' => :'is_you'
  }
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



288
289
290
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 288

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
134
135
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 130

def self.openapi_nullable
  Set.new([
    :'signup_flow_variation',
    :'icon_url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 104

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'default_currency' => :'String',
    :'locale' => :'String',
    :'lang' => :'Integer',
    :'email' => :'String',
    :'phone' => :'String',
    :'activated' => :'Boolean',
    :'last_login' => :'String',
    :'created' => :'String',
    :'modified' => :'String',
    :'signup_flow_variation' => :'String',
    :'has_created_company' => :'Boolean',
    :'is_admin' => :'NumberBoolean',
    :'active_flag' => :'Boolean',
    :'timezone_name' => :'String',
    :'timezone_offset' => :'String',
    :'role_id' => :'Integer',
    :'icon_url' => :'String',
    :'is_you' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      default_currency == o.default_currency &&
      locale == o.locale &&
      lang == o.lang &&
      email == o.email &&
      phone == o.phone &&
      activated == o.activated &&
       == o. &&
      created == o.created &&
      modified == o.modified &&
       == o. &&
      has_created_company == o.has_created_company &&
      is_admin == o.is_admin &&
      active_flag == o.active_flag &&
      timezone_name == o.timezone_name &&
      timezone_offset == o.timezone_offset &&
      role_id == o.role_id &&
      icon_url == o.icon_url &&
      is_you == o.is_you
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 316

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
    Pipedrive.const_get(type).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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 385

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 295

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


275
276
277
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 281

def hash
  [id, name, default_currency, locale, lang, email, phone, activated, , created, modified, , has_created_company, is_admin, active_flag, timezone_name, timezone_offset, role_id, icon_url, is_you].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



235
236
237
238
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 235

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



361
362
363
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 367

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



355
356
357
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 355

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



242
243
244
 
# File 'lib/pipedrive-openapi-client/models/base_user.rb', line 242

def valid?
  true
end