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.

[View source]

72
73
74
75
76
77
78
79
80
81
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
 
# File 'lib/purecloud/models/o_auth_client.rb', line 72

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[:'authorizedGrantTypes']
    if (value = attributes[:'authorizedGrantTypes']).is_a?(Array)
      self.authorized_grant_types = value
    end
  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[:'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.


12
13
14
 
# File 'lib/purecloud/models/o_auth_client.rb', line 12

def access_token_validity_seconds
  @access_token_validity_seconds
end

#authorized_grant_types ⇒ Object

One or more OAuth Grant/Client types supported by this client.


15
16
17
 
# File 'lib/purecloud/models/o_auth_client.rb', line 15

def authorized_grant_types
  @authorized_grant_types
end

#description ⇒ Object

Returns the value of attribute description.


17
18
19
 
# File 'lib/purecloud/models/o_auth_client.rb', line 17

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.


6
7
8
 
# File 'lib/purecloud/models/o_auth_client.rb', line 6

def id
  @id
end

#name ⇒ Object

The name of the OAuth client.


9
10
11
 
# File 'lib/purecloud/models/o_auth_client.rb', line 9

def name
  @name
end

#registered_redirect_uri ⇒ Object

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


20
21
22
 
# File 'lib/purecloud/models/o_auth_client.rb', line 20

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


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

def role_ids
  @role_ids
end

#secret ⇒ Object

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


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

def secret
  @secret
end

#self_uri ⇒ Object

The URI for this object


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

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloud/models/o_auth_client.rb', line 32

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

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloud/models/o_auth_client.rb', line 57

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.

[View source]

124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/purecloud/models/o_auth_client.rb', line 124

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 &&
      authorized_grant_types == o.authorized_grant_types &&
      description == o.description &&
      registered_redirect_uri == o.registered_redirect_uri &&
      secret == o.secret &&
      role_ids == o.role_ids &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object

[View source]

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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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

[View source]

225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloud/models/o_auth_client.rb', line 225

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

[View source]

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/purecloud/models/o_auth_client.rb', line 149

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
[View source]

139
140
141
 
# File 'lib/purecloud/models/o_auth_client.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.

[View source]

144
145
146
 
# File 'lib/purecloud/models/o_auth_client.rb', line 144

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))

[View source]

208
209
210
 
# File 'lib/purecloud/models/o_auth_client.rb', line 208

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash

[View source]

213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloud/models/o_auth_client.rb', line 213

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

[View source]

203
204
205
 
# File 'lib/purecloud/models/o_auth_client.rb', line 203

def to_s
  to_hash.to_s
end