class PureCloud::Organization

Attributes

default_country_code[RW]

The default country code for this organization. Example: 'US'

default_language[RW]

The default language for this organization. Example: 'en'

default_site_id[RW]
domain[RW]
features[RW]

The state of features available for the organization.

id[RW]

The globally unique identifier for the object.

name[RW]
product_platform[RW]

Organizations Originating Platform.

self_uri[RW]

The URI for this object

state[RW]

The current state. Examples are active, inactive, deleted.

support_uri[RW]

Email address where support tickets are sent to.

third_party_org_name[RW]

The short name for the organization. This field is globally unique and cannot be changed.

third_party_uri[RW]
version[RW]

The current version of the organization.

voicemail_enabled[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/organization.rb, line 62
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'default_language' => :'defaultLanguage',
    
    :'default_country_code' => :'defaultCountryCode',
    
    :'third_party_org_name' => :'thirdPartyOrgName',
    
    :'third_party_uri' => :'thirdPartyURI',
    
    :'domain' => :'domain',
    
    :'version' => :'version',
    
    :'state' => :'state',
    
    :'default_site_id' => :'defaultSiteId',
    
    :'support_uri' => :'supportURI',
    
    :'voicemail_enabled' => :'voicemailEnabled',
    
    :'product_platform' => :'productPlatform',
    
    :'self_uri' => :'selfUri',
    
    :'features' => :'features'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/organization.rb, line 137
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?(:'defaultLanguage')
    
    
    self.default_language = attributes[:'defaultLanguage']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/organization.rb, line 99
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'default_language' => :'String',
    
    :'default_country_code' => :'String',
    
    :'third_party_org_name' => :'String',
    
    :'third_party_uri' => :'String',
    
    :'domain' => :'String',
    
    :'version' => :'Integer',
    
    :'state' => :'String',
    
    :'default_site_id' => :'String',
    
    :'support_uri' => :'String',
    
    :'voicemail_enabled' => :'BOOLEAN',
    
    :'product_platform' => :'String',
    
    :'self_uri' => :'String',
    
    :'features' => :'Hash<String, BOOLEAN>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/organization.rb, line 469
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      default_language == o.default_language &&
      default_country_code == o.default_country_code &&
      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 &&
      support_uri == o.support_uri &&
      voicemail_enabled == o.voicemail_enabled &&
      product_platform == o.product_platform &&
      self_uri == o.self_uri &&
      features == o.features
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/organization.rb, line 521
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) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/organization.rb, line 581
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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/organization.rb, line 502
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/organization.rb, line 491
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/organization.rb, line 497
def hash
  [id, name, default_language, default_country_code, third_party_org_name, third_party_uri, domain, version, state, default_site_id, support_uri, voicemail_enabled, product_platform, self_uri, features].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/organization.rb, line 285
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
product_platform=(product_platform) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] product_platform Object to be assigned

# File lib/purecloudplatformclientv2/models/organization.rb, line 446
def product_platform=(product_platform)
  allowed_values = ["PureCloud", "PureEngage", "PureEngageCloud", "PureConnect", "PureConnectCloud", "Unknown"]
  if product_platform && !allowed_values.include?(product_platform)
    fail ArgumentError, "invalid value for 'product_platform', must be one of #{allowed_values}."
  end
  @product_platform = product_platform
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/organization.rb, line 417
def state=(state)
  allowed_values = ["active", "inactive", "deleted"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/organization.rb, line 564
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/organization.rb, line 569
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() click to toggle source
# File lib/purecloudplatformclientv2/models/organization.rb, line 559
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/organization.rb, line 294
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @version.nil?
    return false
  end

  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PureCloud", "PureEngage", "PureEngageCloud", "PureConnect", "PureConnectCloud", "Unknown"]
  if @product_platform && !allowed_values.include?(@product_platform)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end