Class: PureCloud::Share

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Share

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 81

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#group ⇒ Object

Returns the value of attribute group.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 40

def group
  @group
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#member ⇒ Object

Returns the value of attribute member.



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

def member
  @member
end

#member_type ⇒ Object

Returns the value of attribute member_type.



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

def member_type
  @member_type
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 43

def self_uri
  @self_uri
end

#shared_by ⇒ Object

Returns the value of attribute shared_by.



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

def shared_by
  @shared_by
end

#shared_entity ⇒ Object

Returns the value of attribute shared_entity.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 28

def shared_entity
  @shared_entity
end

#shared_entity_type ⇒ Object

Returns the value of attribute shared_entity_type.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 26

def shared_entity_type
  @shared_entity_type
end

#user ⇒ Object

Returns the value of attribute user.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 38

def user
  @user
end

#workspace ⇒ Object

Returns the value of attribute workspace.



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

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'shared_entity_type' => :'sharedEntityType',
    :'shared_entity' => :'sharedEntity',
    :'member_type' => :'memberType',
    :'member' => :'member',
    :'shared_by' => :'sharedBy',
    :'workspace' => :'workspace',
    :'user' => :'user',
    :'group' => :'group',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'shared_entity_type' => :'String',
    :'shared_entity' => :'UriReference',
    :'member_type' => :'String',
    :'member' => :'UriReference',
    :'shared_by' => :'UriReference',
    :'workspace' => :'UriReference',
    :'user' => :'User',
    :'group' => :'Group',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      shared_entity_type == o.shared_entity_type &&
      shared_entity == o.shared_entity &&
      member_type == o.member_type &&
      member == o.member &&
      shared_by == o.shared_by &&
      workspace == o.workspace &&
      user == o.user &&
      group == o.group &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
259
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 223

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 283

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 204

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


193
194
195
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 199

def hash
  [id, name, shared_entity_type, shared_entity, member_type, member, shared_by, workspace, user, group, 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



135
136
137
138
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 135

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



266
267
268
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 266

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 271

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 



261
262
263
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 261

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



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/purecloudplatformclientv2/models/share.rb', line 142

def valid?
  allowed_values = ["DOCUMENT"]
  if @shared_entity_type && !allowed_values.include?(@shared_entity_type)
    return false
  end
  allowed_values = ["USER", "GROUP", "PUBLIC"]
  if @member_type && !allowed_values.include?(@member_type)
    return false
  end
end