Class: PureCloud::OrgUser
- Inherits:
-
Object
- Object
- PureCloud::OrgUser
- Defined in:
- lib/purecloudplatformclientv2/models/org_user.rb
Instance Attribute Summary collapse
-
#acd_auto_answer ⇒ Object
acd auto answer.
-
#addresses ⇒ Object
Email addresses and phone numbers for this user.
-
#authorization ⇒ Object
Roles and permissions assigned to the user.
-
#biography ⇒ Object
Returns the value of attribute biography.
-
#certifications ⇒ Object
Returns the value of attribute certifications.
-
#chat ⇒ Object
Returns the value of attribute chat.
-
#conversation_summary ⇒ Object
Summary of conversion statistics for conversation types.
-
#department ⇒ Object
Returns the value of attribute department.
-
#division ⇒ Object
The division to which this entity belongs.
-
#email ⇒ Object
Returns the value of attribute email.
-
#employer_info ⇒ Object
Returns the value of attribute employer_info.
-
#geolocation ⇒ Object
Current geolocation position.
-
#groups ⇒ Object
The groups the user is a member of.
-
#id ⇒ Object
The globally unique identifier for the object.
-
#images ⇒ Object
Returns the value of attribute images.
-
#language_preference ⇒ Object
preferred language by the user.
-
#languages ⇒ Object
Routing (ACD) languages possessed by the user.
-
#last_token_issued ⇒ Object
Returns the value of attribute last_token_issued.
-
#locations ⇒ Object
The user placement at each site location.
-
#manager ⇒ Object
Returns the value of attribute manager.
-
#name ⇒ Object
Returns the value of attribute name.
-
#organization ⇒ Object
Returns the value of attribute organization.
-
#out_of_office ⇒ Object
Determine if out of office is enabled.
-
#presence ⇒ Object
Active presence.
-
#primary_contact_info ⇒ Object
Auto populated from addresses.
-
#profile_skills ⇒ Object
Profile skills possessed by the user.
-
#routing_status ⇒ Object
ACD routing status.
-
#skills ⇒ Object
Routing (ACD) skills possessed by the user.
-
#state ⇒ Object
The current state for this user.
-
#station ⇒ Object
Effective, default, and last station information.
-
#team ⇒ Object
The team the user is a member of.
-
#title ⇒ Object
Returns the value of attribute title.
-
#username ⇒ Object
Returns the value of attribute username.
-
#version ⇒ Object
Required when updating a user, this value should be the current version of the user.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
- #_deserialize(type, value) ⇒ Object
-
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
build the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OrgUser
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility)).
-
#to_hash ⇒ Object
return the object in the form of hash.
- #to_s ⇒ Object
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ OrgUser
Initializes the object
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 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 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 262 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'division') self.division = attributes[:'division'] end if attributes.has_key?(:'chat') self.chat = attributes[:'chat'] end if attributes.has_key?(:'department') self.department = attributes[:'department'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'primaryContactInfo') if (value = attributes[:'primaryContactInfo']).is_a?(Array) self.primary_contact_info = value end end if attributes.has_key?(:'addresses') if (value = attributes[:'addresses']).is_a?(Array) self.addresses = value end end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'username') self.username = attributes[:'username'] end if attributes.has_key?(:'manager') self.manager = attributes[:'manager'] end if attributes.has_key?(:'images') if (value = attributes[:'images']).is_a?(Array) self.images = value end end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'certifications') if (value = attributes[:'certifications']).is_a?(Array) self.certifications = value end end if attributes.has_key?(:'biography') self.biography = attributes[:'biography'] end if attributes.has_key?(:'employerInfo') self.employer_info = attributes[:'employerInfo'] end if attributes.has_key?(:'routingStatus') self.routing_status = attributes[:'routingStatus'] end if attributes.has_key?(:'presence') self.presence = attributes[:'presence'] end if attributes.has_key?(:'conversationSummary') self.conversation_summary = attributes[:'conversationSummary'] end if attributes.has_key?(:'outOfOffice') self.out_of_office = attributes[:'outOfOffice'] end if attributes.has_key?(:'geolocation') self.geolocation = attributes[:'geolocation'] end if attributes.has_key?(:'station') self.station = attributes[:'station'] end if attributes.has_key?(:'authorization') self. = attributes[:'authorization'] end if attributes.has_key?(:'profileSkills') if (value = attributes[:'profileSkills']).is_a?(Array) self.profile_skills = value end end if attributes.has_key?(:'locations') if (value = attributes[:'locations']).is_a?(Array) self.locations = value end end if attributes.has_key?(:'groups') if (value = attributes[:'groups']).is_a?(Array) self.groups = value end end if attributes.has_key?(:'team') self.team = attributes[:'team'] end if attributes.has_key?(:'skills') if (value = attributes[:'skills']).is_a?(Array) self.skills = value end end if attributes.has_key?(:'languages') if (value = attributes[:'languages']).is_a?(Array) self.languages = value end end if attributes.has_key?(:'acdAutoAnswer') self.acd_auto_answer = attributes[:'acdAutoAnswer'] end if attributes.has_key?(:'languagePreference') self.language_preference = attributes[:'languagePreference'] end if attributes.has_key?(:'lastTokenIssued') self.last_token_issued = attributes[:'lastTokenIssued'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end end |
Instance Attribute Details
#acd_auto_answer ⇒ Object
acd auto answer
101 102 103 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 101 def acd_auto_answer @acd_auto_answer end |
#addresses ⇒ Object
Email addresses and phone numbers for this user
39 40 41 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 39 def addresses @addresses end |
#authorization ⇒ Object
Roles and permissions assigned to the user
80 81 82 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 80 def @authorization end |
#biography ⇒ Object
Returns the value of attribute biography.
57 58 59 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 57 def biography @biography end |
#certifications ⇒ Object
Returns the value of attribute certifications.
55 56 57 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 55 def certifications @certifications end |
#chat ⇒ Object
Returns the value of attribute chat.
29 30 31 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 29 def chat @chat end |
#conversation_summary ⇒ Object
Summary of conversion statistics for conversation types.
68 69 70 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 68 def conversation_summary @conversation_summary end |
#department ⇒ Object
Returns the value of attribute department.
31 32 33 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 31 def department @department end |
#division ⇒ Object
The division to which this entity belongs.
27 28 29 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 27 def division @division end |
#email ⇒ Object
Returns the value of attribute email.
33 34 35 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 33 def email @email end |
#employer_info ⇒ Object
Returns the value of attribute employer_info.
59 60 61 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 59 def employer_info @employer_info end |
#geolocation ⇒ Object
Current geolocation position
74 75 76 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 74 def geolocation @geolocation end |
#groups ⇒ Object
The groups the user is a member of
89 90 91 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 89 def groups @groups end |
#id ⇒ Object
The globally unique identifier for the object.
22 23 24 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 22 def id @id end |
#images ⇒ Object
Returns the value of attribute images.
50 51 52 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 50 def images @images end |
#language_preference ⇒ Object
preferred language by the user
104 105 106 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 104 def language_preference @language_preference end |
#languages ⇒ Object
Routing (ACD) languages possessed by the user
98 99 100 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 98 def languages @languages end |
#last_token_issued ⇒ Object
Returns the value of attribute last_token_issued.
106 107 108 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 106 def last_token_issued @last_token_issued end |
#locations ⇒ Object
The user placement at each site location.
86 87 88 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 86 def locations @locations end |
#manager ⇒ Object
Returns the value of attribute manager.
48 49 50 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 48 def manager @manager end |
#name ⇒ Object
Returns the value of attribute name.
24 25 26 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 24 def name @name end |
#organization ⇒ Object
Returns the value of attribute organization.
108 109 110 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 108 def organization @organization end |
#out_of_office ⇒ Object
Determine if out of office is enabled
71 72 73 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 71 def out_of_office @out_of_office end |
#presence ⇒ Object
Active presence
65 66 67 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 65 def presence @presence end |
#primary_contact_info ⇒ Object
Auto populated from addresses.
36 37 38 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 36 def primary_contact_info @primary_contact_info end |
#profile_skills ⇒ Object
Profile skills possessed by the user
83 84 85 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 83 def profile_skills @profile_skills end |
#routing_status ⇒ Object
ACD routing status
62 63 64 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 62 def routing_status @routing_status end |
#skills ⇒ Object
Routing (ACD) skills possessed by the user
95 96 97 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 95 def skills @skills end |
#state ⇒ Object
The current state for this user.
42 43 44 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 42 def state @state end |
#station ⇒ Object
Effective, default, and last station information
77 78 79 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 77 def station @station end |
#team ⇒ Object
The team the user is a member of
92 93 94 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 92 def team @team end |
#title ⇒ Object
Returns the value of attribute title.
44 45 46 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 44 def title @title end |
#username ⇒ Object
Returns the value of attribute username.
46 47 48 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 46 def username @username end |
#version ⇒ Object
Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH.
53 54 55 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 53 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 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 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 111 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'division' => :'division', :'chat' => :'chat', :'department' => :'department', :'email' => :'email', :'primary_contact_info' => :'primaryContactInfo', :'addresses' => :'addresses', :'state' => :'state', :'title' => :'title', :'username' => :'username', :'manager' => :'manager', :'images' => :'images', :'version' => :'version', :'certifications' => :'certifications', :'biography' => :'biography', :'employer_info' => :'employerInfo', :'routing_status' => :'routingStatus', :'presence' => :'presence', :'conversation_summary' => :'conversationSummary', :'out_of_office' => :'outOfOffice', :'geolocation' => :'geolocation', :'station' => :'station', :'authorization' => :'authorization', :'profile_skills' => :'profileSkills', :'locations' => :'locations', :'groups' => :'groups', :'team' => :'team', :'skills' => :'skills', :'languages' => :'languages', :'acd_auto_answer' => :'acdAutoAnswer', :'language_preference' => :'languagePreference', :'last_token_issued' => :'lastTokenIssued', :'organization' => :'organization' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 186 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'division' => :'Division', :'chat' => :'Chat', :'department' => :'String', :'email' => :'String', :'primary_contact_info' => :'Array<Contact>', :'addresses' => :'Array<Contact>', :'state' => :'String', :'title' => :'String', :'username' => :'String', :'manager' => :'User', :'images' => :'Array<UserImage>', :'version' => :'Integer', :'certifications' => :'Array<String>', :'biography' => :'Biography', :'employer_info' => :'EmployerInfo', :'routing_status' => :'RoutingStatus', :'presence' => :'UserPresence', :'conversation_summary' => :'UserConversationSummary', :'out_of_office' => :'OutOfOffice', :'geolocation' => :'Geolocation', :'station' => :'UserStations', :'authorization' => :'UserAuthorization', :'profile_skills' => :'Array<String>', :'locations' => :'Array<Location>', :'groups' => :'Array<Group>', :'team' => :'Team', :'skills' => :'Array<UserRoutingSkill>', :'languages' => :'Array<UserRoutingLanguage>', :'acd_auto_answer' => :'BOOLEAN', :'language_preference' => :'String', :'last_token_issued' => :'OAuthLastTokenIssued', :'organization' => :'Organization' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 938 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && division == o.division && chat == o.chat && department == o.department && email == o.email && primary_contact_info == o.primary_contact_info && addresses == o.addresses && state == o.state && title == o.title && username == o.username && manager == o.manager && images == o.images && version == o.version && certifications == o.certifications && biography == o.biography && employer_info == o.employer_info && routing_status == o.routing_status && presence == o.presence && conversation_summary == o.conversation_summary && out_of_office == o.out_of_office && geolocation == o.geolocation && station == o.station && == o. && profile_skills == o.profile_skills && locations == o.locations && groups == o.groups && team == o.team && skills == o.skills && languages == o.languages && acd_auto_answer == o.acd_auto_answer && language_preference == o.language_preference && last_token_issued == o.last_token_issued && organization == o.organization end |
#_deserialize(type, value) ⇒ Object
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 1009 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 1069 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
build the object from hash
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 990 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end |
#eql?(o) ⇒ Boolean
979 980 981 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 979 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
985 986 987 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 985 def hash [id, name, division, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, certifications, biography, employer_info, routing_status, presence, conversation_summary, out_of_office, geolocation, station, , profile_skills, locations, groups, team, skills, languages, acd_auto_answer, language_preference, last_token_issued, organization].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
597 598 599 600 601 602 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 597 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility))
1052 1053 1054 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 1052 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
1057 1058 1059 1060 1061 1062 1063 1064 1065 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 1057 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 ⇒ Object
1047 1048 1049 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 1047 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'lib/purecloudplatformclientv2/models/org_user.rb', line 606 def valid? allowed_values = ["active", "inactive", "deleted"] if @state && !allowed_values.include?(@state) return false end if @version.nil? return false end end |