Class: Bfwd::UserCreationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/user_creation_request.rb

Overview

Request entity for creating a user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserCreationRequest

Initializes the object



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
125
126
127
128
129
130
131
132
133
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 83

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'sendEmail')
    self.send_email = attributes[:'sendEmail']
  else
    self.send_email = false
  end

end

Instance Attribute Details

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 22

def changed_by
  @changed_by
end

#company_name ⇒ Object

Company.“,”verbs“:



37
38
39
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 37

def company_name
  @company_name
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 19

def created
  @created
end

#email ⇒ Object

E-mail address of the User.“,”verbs“:



28
29
30
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 28

def email
  @email
end

#first_name ⇒ Object

Name of the User.“,”verbs“:



31
32
33
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 31

def first_name
  @first_name
end

#last_name ⇒ Object

Name of the User.“,”verbs“:



34
35
36
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 34

def last_name
  @last_name
end

#organization_id ⇒ Object

for which the User is created.“,”verbs“:



25
26
27
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 25

def organization_id
  @organization_id
end

#password ⇒ Object

Password for the User.“,”verbs“:



40
41
42
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 40

def password
  @password
end

#roles ⇒ Object

permission groups the user will belong to.“,”verbs“:



43
44
45
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 43

def roles
  @roles
end

#send_email ⇒ Object

an email should be sent upon creation.“,”verbs“:



46
47
48
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 46

def send_email
  @send_email
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 50

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'organization_id' => :'organizationID',
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'company_name' => :'companyName',
    :'password' => :'password',
    :'roles' => :'roles',
    :'send_email' => :'sendEmail'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 66

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'organization_id' => :'String',
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company_name' => :'String',
    :'password' => :'String',
    :'roles' => :'Array<String>',
    :'send_email' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      organization_id == o.organization_id &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company_name == o.company_name &&
      password == o.password &&
      roles == o.roles &&
      send_email == o.send_email
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 241

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 = Bfwd.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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 307

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 220

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

See Also:

  • `==` method


207
208
209
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



213
214
215
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 213

def hash
  [created, changed_by, organization_id, email, first_name, last_name, company_name, password, roles, send_email].hash
end

#list_invalid_properties ⇒ Object

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



137
138
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
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  if @organization_id.nil?
    invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.")
  end

  if @email.nil?
    invalid_properties.push("invalid value for 'email', email cannot be nil.")
  end

  if @first_name.nil?
    invalid_properties.push("invalid value for 'first_name', first_name cannot be nil.")
  end

  if @last_name.nil?
    invalid_properties.push("invalid value for 'last_name', last_name cannot be nil.")
  end

  if @company_name.nil?
    invalid_properties.push("invalid value for 'company_name', company_name cannot be nil.")
  end

  if @password.nil?
    invalid_properties.push("invalid value for 'password', password cannot be nil.")
  end

  if @roles.nil?
    invalid_properties.push("invalid value for 'roles', roles cannot be nil.")
  end

  if @send_email.nil?
    invalid_properties.push("invalid value for 'send_email', send_email cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



287
288
289
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 287

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 293

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



281
282
283
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 281

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bf_ruby2/models/user_creation_request.rb', line 176

def valid?
  return false if @organization_id.nil?
  return false if @email.nil?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @company_name.nil?
  return false if @password.nil?
  return false if @roles.nil?
  return false if @send_email.nil?
  return true
end