Class: PureCloud::Policy

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/policy.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Policy

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 90

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#actions ⇒ Object

Actions



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 45

def actions
  @actions
end

#conditions ⇒ Object

Conditions



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 42

def conditions
  @conditions
end

#created_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 30

def created_date
  @created_date
end

#description ⇒ Object

Returns the value of attribute description.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 34

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 36

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 22

def id
  @id
end

#media_policies ⇒ Object

Conditions and actions per media type



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 39

def media_policies
  @media_policies
end

#modified_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 27

def modified_date
  @modified_date
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 24

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 32

def order
  @order
end

#policy_errors ⇒ Object

Returns the value of attribute policy_errors.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 47

def policy_errors
  @policy_errors
end

#self_uri ⇒ Object

The URI for this object



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 50

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'modified_date' => :'modifiedDate',
    :'created_date' => :'createdDate',
    :'order' => :'order',
    :'description' => :'description',
    :'enabled' => :'enabled',
    :'media_policies' => :'mediaPolicies',
    :'conditions' => :'conditions',
    :'actions' => :'actions',
    :'policy_errors' => :'policyErrors',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'modified_date' => :'DateTime',
    :'created_date' => :'DateTime',
    :'order' => :'Integer',
    :'description' => :'String',
    :'enabled' => :'BOOLEAN',
    :'media_policies' => :'MediaPolicies',
    :'conditions' => :'PolicyConditions',
    :'actions' => :'PolicyActions',
    :'policy_errors' => :'PolicyErrors',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      modified_date == o.modified_date &&
      created_date == o.created_date &&
      order == o.order &&
      description == o.description &&
      enabled == o.enabled &&
      media_policies == o.media_policies &&
      conditions == o.conditions &&
      actions == o.actions &&
      policy_errors == o.policy_errors &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 209

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 269

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 190

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 185

def hash
  [id, name, modified_date, created_date, order, description, enabled, media_policies, conditions, actions, policy_errors, self_uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



148
149
150
151
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 148

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))



252
253
254
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 252

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 257

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 



247
248
249
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 247

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



155
156
 
# File 'lib/purecloudplatformclientv2/models/policy.rb', line 155

def valid?
end