Class: PureCloud::OrgOAuthClient
- Inherits:
-
Object
- Object
- PureCloud::OrgOAuthClient
- Defined in:
- lib/purecloudplatformclientv2/models/org_o_auth_client.rb
Instance Attribute Summary collapse
-
#authorized_grant_type ⇒ Object
The OAuth Grant/Client type supported by this client.
-
#created_by ⇒ Object
User that created this client.
-
#date_created ⇒ Object
Date this client was created.
-
#date_modified ⇒ Object
Date this client was last modified.
-
#date_to_delete ⇒ Object
The time at which this client will be deleted.
-
#id ⇒ Object
The globally unique identifier for the object.
-
#modified_by ⇒ Object
User that last modified this client.
-
#name ⇒ Object
The name of the OAuth client.
-
#organization ⇒ Object
The oauth client’s organization.
-
#role_divisions ⇒ Object
Set of roles and their corresponding divisions associated with this client.
-
#scope ⇒ Object
The scope requested by this client.
-
#state ⇒ Object
The state of the OAuth client.
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 = {}) ⇒ OrgOAuthClient
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 = {}) ⇒ OrgOAuthClient
Initializes the object
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 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 232 233 234 235 236 237 238 239 240 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 121 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?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'dateModified') self.date_modified = attributes[:'dateModified'] end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'modifiedBy') self.modified_by = attributes[:'modifiedBy'] end if attributes.has_key?(:'authorizedGrantType') self. = attributes[:'authorizedGrantType'] end if attributes.has_key?(:'scope') if (value = attributes[:'scope']).is_a?(Array) self.scope = value end end if attributes.has_key?(:'roleDivisions') if (value = attributes[:'roleDivisions']).is_a?(Array) self.role_divisions = value end end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'dateToDelete') self.date_to_delete = attributes[:'dateToDelete'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end end |
Instance Attribute Details
#authorized_grant_type ⇒ Object
The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.
40 41 42 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 40 def @authorized_grant_type end |
#created_by ⇒ Object
User that created this client
34 35 36 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 34 def created_by @created_by end |
#date_created ⇒ Object
Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
28 29 30 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 28 def date_created @date_created end |
#date_modified ⇒ Object
Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
31 32 33 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 31 def date_modified @date_modified end |
#date_to_delete ⇒ Object
The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
52 53 54 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 52 def date_to_delete @date_to_delete end |
#id ⇒ Object
The globally unique identifier for the object.
22 23 24 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 22 def id @id end |
#modified_by ⇒ Object
User that last modified this client
37 38 39 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 37 def modified_by @modified_by end |
#name ⇒ Object
The name of the OAuth client.
25 26 27 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 25 def name @name end |
#organization ⇒ Object
The oauth client’s organization.
55 56 57 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 55 def organization @organization end |
#role_divisions ⇒ Object
Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant
46 47 48 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 46 def role_divisions @role_divisions end |
#scope ⇒ Object
The scope requested by this client. Scopes only apply to clients not using the client_credential grant
43 44 45 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 43 def scope @scope end |
#state ⇒ Object
The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.
49 50 51 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 49 def state @state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 58 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'created_by' => :'createdBy', :'modified_by' => :'modifiedBy', :'authorized_grant_type' => :'authorizedGrantType', :'scope' => :'scope', :'role_divisions' => :'roleDivisions', :'state' => :'state', :'date_to_delete' => :'dateToDelete', :'organization' => :'organization' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 89 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'created_by' => :'DomainEntityRef', :'modified_by' => :'DomainEntityRef', :'authorized_grant_type' => :'String', :'scope' => :'Array<String>', :'role_divisions' => :'Array<RoleDivision>', :'state' => :'String', :'date_to_delete' => :'DateTime', :'organization' => :'NamedEntity' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 406 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && date_created == o.date_created && date_modified == o.date_modified && created_by == o.created_by && modified_by == o.modified_by && == o. && scope == o.scope && role_divisions == o.role_divisions && state == o.state && date_to_delete == o.date_to_delete && organization == o.organization end |
#_deserialize(type, value) ⇒ Object
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 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 455 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
515 516 517 518 519 520 521 522 523 524 525 526 527 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 515 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
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 436 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
425 426 427 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 425 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
431 432 433 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 431 def hash [id, name, date_created, date_modified, created_by, modified_by, , scope, role_divisions, state, date_to_delete, organization].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
244 245 246 247 248 249 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 244 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))
498 499 500 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 498 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
503 504 505 506 507 508 509 510 511 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 503 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
493 494 495 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 493 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
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 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 |
# File 'lib/purecloudplatformclientv2/models/org_o_auth_client.rb', line 253 def valid? if @name.nil? return false end if @authorized_grant_type.nil? return false end allowed_values = ["CODE", "TOKEN", "SAML2BEARER", "PASSWORD", "CLIENT_CREDENTIALS"] if @authorized_grant_type && !allowed_values.include?(@authorized_grant_type) return false end allowed_values = ["active", "disabled", "inactive"] if @state && !allowed_values.include?(@state) return false end end |