Class: PureCloud::Organization

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Organization

Returns a new instance of Organization.



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
122
123
124
125
126
127
128
129
# File 'lib/purecloud/models/organization.rb', line 76

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[:'thirdPartyOrgId']
    self.third_party_org_id = attributes[:'thirdPartyOrgId']
  end
  
  if attributes[:'thirdPartyOrgName']
    self.third_party_org_name = attributes[:'thirdPartyOrgName']
  end
  
  if attributes[:'thirdPartyURI']
    self.third_party_uri = attributes[:'thirdPartyURI']
  end
  
  if attributes[:'domain']
    self.domain = attributes[:'domain']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'defaultSiteId']
    self.default_site_id = attributes[:'defaultSiteId']
  end
  
  if attributes[:'deletable']
    self.deletable = attributes[:'deletable']
  else
    self.deletable = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#default_site_idObject

Returns the value of attribute default_site_id.



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

def default_site_id
  @default_site_id
end

#deletableObject

Returns the value of attribute deletable.



24
25
26
# File 'lib/purecloud/models/organization.rb', line 24

def deletable
  @deletable
end

#domainObject

Returns the value of attribute domain.



16
17
18
# File 'lib/purecloud/models/organization.rb', line 16

def domain
  @domain
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#nameObject

Returns the value of attribute name.



8
9
10
# File 'lib/purecloud/models/organization.rb', line 8

def name
  @name
end

#self_uriObject

The URI for this object



27
28
29
# File 'lib/purecloud/models/organization.rb', line 27

def self_uri
  @self_uri
end

#stateObject

Returns the value of attribute state.



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

def state
  @state
end

#third_party_org_idObject

Returns the value of attribute third_party_org_id.



10
11
12
# File 'lib/purecloud/models/organization.rb', line 10

def third_party_org_id
  @third_party_org_id
end

#third_party_org_nameObject

Returns the value of attribute third_party_org_name.



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

def third_party_org_name
  @third_party_org_name
end

#third_party_uriObject

Returns the value of attribute third_party_uri.



14
15
16
# File 'lib/purecloud/models/organization.rb', line 14

def third_party_uri
  @third_party_uri
end

#versionObject

Returns the value of attribute version.



18
19
20
# File 'lib/purecloud/models/organization.rb', line 18

def version
  @version
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'third_party_org_id' => :'thirdPartyOrgId',
    
    :'third_party_org_name' => :'thirdPartyOrgName',
    
    :'third_party_uri' => :'thirdPartyURI',
    
    :'domain' => :'domain',
    
    :'version' => :'version',
    
    :'state' => :'state',
    
    :'default_site_id' => :'defaultSiteId',
    
    :'deletable' => :'deletable',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/purecloud/models/organization.rb', line 59

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'third_party_org_id' => :'String',
    :'third_party_org_name' => :'String',
    :'third_party_uri' => :'String',
    :'domain' => :'String',
    :'version' => :'Integer',
    :'state' => :'String',
    :'default_site_id' => :'String',
    :'deletable' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/purecloud/models/organization.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      third_party_org_id == o.third_party_org_id &&
      third_party_org_name == o.third_party_org_name &&
      third_party_uri == o.third_party_uri &&
      domain == o.domain &&
      version == o.version &&
      state == o.state &&
      default_site_id == o.default_site_id &&
      deletable == o.deletable &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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
214
215
216
217
218
219
220
# File 'lib/purecloud/models/organization.rb', line 187

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



244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/purecloud/models/organization.rb', line 244

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/purecloud/models/organization.rb', line 168

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


158
159
160
# File 'lib/purecloud/models/organization.rb', line 158

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



163
164
165
# File 'lib/purecloud/models/organization.rb', line 163

def hash
  [id, name, third_party_org_id, third_party_org_name, third_party_uri, domain, version, state, default_site_id, deletable, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



227
228
229
# File 'lib/purecloud/models/organization.rb', line 227

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



232
233
234
235
236
237
238
239
240
# File 'lib/purecloud/models/organization.rb', line 232

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_sObject



222
223
224
# File 'lib/purecloud/models/organization.rb', line 222

def to_s
  to_hash.to_s
end