Class: PureCloud::OAuthClient

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/o_auth_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthClient

Returns a new instance of OAuthClient.



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
134
135
 
# File 'lib/purecloud/models/o_auth_client.rb', line 88

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'accessTokenValiditySeconds']
    self.access_token_validity_seconds = attributes[:'accessTokenValiditySeconds']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'registeredRedirectUri']
    if (value = attributes[:'registeredRedirectUri']).is_a?(Array)
      self.registered_redirect_uri = value
    end
  end
  
  if attributes[:'secret']
    self.secret = attributes[:'secret']
  end
  
  if attributes[:'roleIds']
    if (value = attributes[:'roleIds']).is_a?(Array)
      self.role_ids = value
    end
  end
  
  if attributes[:'authorizedGrantType']
    self.authorized_grant_type = attributes[:'authorizedGrantType']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#access_token_validity_seconds ⇒ Object

The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.



28
29
30
 
# File 'lib/purecloud/models/o_auth_client.rb', line 28

def access_token_validity_seconds
  @access_token_validity_seconds
end

#authorized_grant_type ⇒ Object

The OAuth Grant/Client type supported by this client.nCode 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.nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.nClient Credential grant type - Used to created access tokens that are tied only to the client.n



42
43
44
 
# File 'lib/purecloud/models/o_auth_client.rb', line 42

def authorized_grant_type
  @authorized_grant_type
end

#description ⇒ Object

Returns the value of attribute description.



30
31
32
 
# File 'lib/purecloud/models/o_auth_client.rb', line 30

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/o_auth_client.rb', line 22

def id
  @id
end

#name ⇒ Object

The name of the OAuth client.



25
26
27
 
# File 'lib/purecloud/models/o_auth_client.rb', line 25

def name
  @name
end

#registered_redirect_uri ⇒ Object

List of allowed callbacks for this client. For example: myap.example.com/auth/callback



33
34
35
 
# File 'lib/purecloud/models/o_auth_client.rb', line 33

def registered_redirect_uri
  @registered_redirect_uri
end

#role_ids ⇒ Object

Roles assigned to this client. Roles only apply to clients using the client_credential grant



39
40
41
 
# File 'lib/purecloud/models/o_auth_client.rb', line 39

def role_ids
  @role_ids
end

#secret ⇒ Object

System created secret assigned to this client. Secrets are required for code authorization and client credential grants.



36
37
38
 
# File 'lib/purecloud/models/o_auth_client.rb', line 36

def secret
  @secret
end

#self_uri ⇒ Object

The URI for this object



45
46
47
 
# File 'lib/purecloud/models/o_auth_client.rb', line 45

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloud/models/o_auth_client.rb', line 48

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'access_token_validity_seconds' => :'accessTokenValiditySeconds',
    
    :'description' => :'description',
    
    :'registered_redirect_uri' => :'registeredRedirectUri',
    
    :'secret' => :'secret',
    
    :'role_ids' => :'roleIds',
    
    :'authorized_grant_type' => :'authorizedGrantType',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloud/models/o_auth_client.rb', line 73

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'access_token_validity_seconds' => :'Integer',
    :'description' => :'String',
    :'registered_redirect_uri' => :'Array<String>',
    :'secret' => :'String',
    :'role_ids' => :'Array<String>',
    :'authorized_grant_type' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/purecloud/models/o_auth_client.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      access_token_validity_seconds == o.access_token_validity_seconds &&
      description == o.description &&
      registered_redirect_uri == o.registered_redirect_uri &&
      secret == o.secret &&
      role_ids == o.role_ids &&
      authorized_grant_type == o.authorized_grant_type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/o_auth_client.rb', line 191

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



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

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloud/models/o_auth_client.rb', line 172

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

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/purecloud/models/o_auth_client.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



167
168
169
 
# File 'lib/purecloud/models/o_auth_client.rb', line 167

def hash
  [id, name, access_token_validity_seconds, description, registered_redirect_uri, secret, role_ids, authorized_grant_type, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



234
235
236
 
# File 'lib/purecloud/models/o_auth_client.rb', line 234

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



239
240
241
242
243
244
245
246
247
 
# File 'lib/purecloud/models/o_auth_client.rb', line 239

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 



229
230
231
 
# File 'lib/purecloud/models/o_auth_client.rb', line 229

def to_s
  to_hash.to_s
end