Class: MergeCRMClient::User

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_crm_client/models/user.rb

Overview

# The User Object ### Description The ‘User` object is used to represent a user in the CRM system. ### Usage Example TODO

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
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
 
# File 'lib/merge_crm_client/models/user.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeCRMClient::User` 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 `MergeCRMClient::User`. 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?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

The user’s email address.



28
29
30
 
# File 'lib/merge_crm_client/models/user.rb', line 28

def email
  @email
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_crm_client/models/user.rb', line 19

def id
  @id
end

#is_active ⇒ Object

Whether or not the user is active.



31
32
33
 
# File 'lib/merge_crm_client/models/user.rb', line 31

def is_active
  @is_active
end

#name ⇒ Object

The user’s name.



25
26
27
 
# File 'lib/merge_crm_client/models/user.rb', line 25

def name
  @name
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



33
34
35
 
# File 'lib/merge_crm_client/models/user.rb', line 33

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_crm_client/models/user.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

Indicates whether or not this object has been deleted by third party webhooks.



36
37
38
 
# File 'lib/merge_crm_client/models/user.rb', line 36

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/merge_crm_client/models/user.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/merge_crm_client/models/user.rb', line 39

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'name' => :'name',
    :'email' => :'email',
    :'is_active' => :'is_active',
    :'remote_data' => :'remote_data',
    :'remote_was_deleted' => :'remote_was_deleted'
  }
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



168
169
170
 
# File 'lib/merge_crm_client/models/user.rb', line 168

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
74
75
76
77
78
 
# File 'lib/merge_crm_client/models/user.rb', line 70

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'name',
    :'email',
    :'is_active',
    :'remote_data',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/merge_crm_client/models/user.rb', line 57

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'name' => :'String',
    :'email' => :'String',
    :'is_active' => :'Boolean',
    :'remote_data' => :'Array<RemoteData>',
    :'remote_was_deleted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/merge_crm_client/models/user.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      name == o.name &&
      email == o.email &&
      is_active == o.is_active &&
      remote_data == o.remote_data &&
      remote_was_deleted == o.remote_was_deleted
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



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
232
233
234
235
 
# File 'lib/merge_crm_client/models/user.rb', line 198

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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
    # models (e.g. Pet) or oneOf
    klass = MergeCRMClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/merge_crm_client/models/user.rb', line 269

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/merge_crm_client/models/user.rb', line 175

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/merge_crm_client/models/user.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/merge_crm_client/models/user.rb', line 161

def hash
  [id, remote_id, name, email, is_active, remote_data, remote_was_deleted].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



128
129
130
131
 
# File 'lib/merge_crm_client/models/user.rb', line 128

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



245
246
247
 
# File 'lib/merge_crm_client/models/user.rb', line 245

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/merge_crm_client/models/user.rb', line 251

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



239
240
241
 
# File 'lib/merge_crm_client/models/user.rb', line 239

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



135
136
137
 
# File 'lib/merge_crm_client/models/user.rb', line 135

def valid?
  true
end