class PureCloud::ExternalOrganization

Attributes

address[RW]
company_type[RW]
create_date[RW]

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

custom_fields[RW]

Custom fields defined in the schema referenced by schemaId and schemaVersion.

employee_count[RW]
external_data_sources[RW]

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.

external_system_url[RW]

A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.

fax_number[RW]
id[RW]

The globally unique identifier for the object.

industry[RW]
modify_date[RW]

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

name[RW]

The name of the company.

phone_number[RW]
primary_contact_id[RW]
revenue[RW]
schema[RW]

The schema defining custom fields for this contact

self_uri[RW]

The URI for this object

tags[RW]
tickers[RW]
trustor[RW]
twitter_id[RW]
websites[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/external_organization.rb, line 75
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'company_type' => :'companyType',
    
    :'industry' => :'industry',
    
    :'primary_contact_id' => :'primaryContactId',
    
    :'address' => :'address',
    
    :'phone_number' => :'phoneNumber',
    
    :'fax_number' => :'faxNumber',
    
    :'employee_count' => :'employeeCount',
    
    :'revenue' => :'revenue',
    
    :'tags' => :'tags',
    
    :'websites' => :'websites',
    
    :'tickers' => :'tickers',
    
    :'twitter_id' => :'twitterId',
    
    :'external_system_url' => :'externalSystemUrl',
    
    :'modify_date' => :'modifyDate',
    
    :'create_date' => :'createDate',
    
    :'trustor' => :'trustor',
    
    :'schema' => :'schema',
    
    :'custom_fields' => :'customFields',
    
    :'external_data_sources' => :'externalDataSources',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/external_organization.rb, line 178
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?(:'companyType')
    
    
    self.company_type = attributes[:'companyType']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'customFields')
    
    if (value = attributes[:'customFields']).is_a?(Array)
      self.custom_fields = value
    end
    
    
  
  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/external_organization.rb, line 126
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'company_type' => :'String',
    
    :'industry' => :'String',
    
    :'primary_contact_id' => :'String',
    
    :'address' => :'ContactAddress',
    
    :'phone_number' => :'PhoneNumber',
    
    :'fax_number' => :'PhoneNumber',
    
    :'employee_count' => :'Integer',
    
    :'revenue' => :'Integer',
    
    :'tags' => :'Array<String>',
    
    :'websites' => :'Array<String>',
    
    :'tickers' => :'Array<Ticker>',
    
    :'twitter_id' => :'TwitterId',
    
    :'external_system_url' => :'String',
    
    :'modify_date' => :'DateTime',
    
    :'create_date' => :'DateTime',
    
    :'trustor' => :'Trustor',
    
    :'schema' => :'DataSchema',
    
    :'custom_fields' => :'Hash<String, Object>',
    
    :'external_data_sources' => :'Array<ExternalDataSource>',
    
    :'self_uri' => :'String'
    
  }
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/external_organization.rb, line 616
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      company_type == o.company_type &&
      industry == o.industry &&
      primary_contact_id == o.primary_contact_id &&
      address == o.address &&
      phone_number == o.phone_number &&
      fax_number == o.fax_number &&
      employee_count == o.employee_count &&
      revenue == o.revenue &&
      tags == o.tags &&
      websites == o.websites &&
      tickers == o.tickers &&
      twitter_id == o.twitter_id &&
      external_system_url == o.external_system_url &&
      modify_date == o.modify_date &&
      create_date == o.create_date &&
      trustor == o.trustor &&
      schema == o.schema &&
      custom_fields == o.custom_fields &&
      external_data_sources == o.external_data_sources &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/external_organization.rb, line 675
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/external_organization.rb, line 735
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/external_organization.rb, line 656
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/external_organization.rb, line 645
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/external_organization.rb, line 651
def hash
  [id, name, company_type, industry, primary_contact_id, address, phone_number, fax_number, employee_count, revenue, tags, websites, tickers, twitter_id, external_system_url, modify_date, create_date, trustor, schema, custom_fields, external_data_sources, self_uri].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/external_organization.rb, line 397
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/external_organization.rb, line 723
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/external_organization.rb, line 713
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/external_organization.rb, line 406
def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end