Class: PureCloud::Relationship

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Relationship

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
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
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 69

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

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

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

  if attributes.has_key?(:'externalDataSources')
    if (value = attributes[:'externalDataSources']).is_a?(Array)
      self.external_data_sources = value
    end
  end

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

end

Instance Attribute Details

#external_data_sources ⇒ Object

Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.



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

def external_data_sources
  @external_data_sources
end

#external_organization ⇒ Object

The external organization this relationship is attached to



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

def external_organization
  @external_organization
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#relationship ⇒ Object

The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 33

def relationship
  @relationship
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#user ⇒ Object

The user associated with the external organization



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'user' => :'user',
    :'external_organization' => :'externalOrganization',
    :'relationship' => :'relationship',
    :'external_data_sources' => :'externalDataSources',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 55

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'user' => :'User',
    :'external_organization' => :'ExternalOrganization',
    :'relationship' => :'String',
    :'external_data_sources' => :'Array<ExternalDataSource>',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      external_organization == o.external_organization &&
      relationship == o.relationship &&
      external_data_sources == o.external_data_sources &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 237

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



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

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


147
148
149
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 147

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 153

def hash
  [id, name, user, external_organization, relationship, external_data_sources, 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



109
110
111
112
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 109

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



220
221
222
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 225

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 



215
216
217
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 215

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/purecloudplatformclientv2/models/relationship.rb', line 116

def valid?
  if @user.nil?
    return false
  end

  if @external_organization.nil?
    return false
  end

  if @relationship.nil?
    return false
  end

end