class PureCloud::WidgetDeployment

Attributes

allowed_domains[RW]

The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.

authentication_required[RW]

When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation.

client_config[RW]

The client configuration options that should be made available to the clients of this Deployment.

client_type[RW]

The type of display widget for which this Deployment is configured, which controls the administrator settings shown.

description[RW]

A human-readable description of this Deployment.

disabled[RW]

When true, all create chat operations using this Deployment will be rejected.

flow[RW]

The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.

id[RW]

The globally unique identifier for the object.

name[RW]
self_uri[RW]

The URI for this object

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/widget_deployment.rb, line 51
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'authentication_required' => :'authenticationRequired',
    
    :'disabled' => :'disabled',
    
    :'flow' => :'flow',
    
    :'allowed_domains' => :'allowedDomains',
    
    :'client_type' => :'clientType',
    
    :'client_config' => :'clientConfig',
    
    :'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/widget_deployment.rb, line 106
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?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

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

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

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

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

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

  
  if attributes.has_key?(:'clientConfig')
    
    
    self.client_config = attributes[:'clientConfig']
    
  
  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/widget_deployment.rb, line 78
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'authentication_required' => :'BOOLEAN',
    
    :'disabled' => :'BOOLEAN',
    
    :'flow' => :'DomainEntityRef',
    
    :'allowed_domains' => :'Array<String>',
    
    :'client_type' => :'String',
    
    :'client_config' => :'WidgetClientConfig',
    
    :'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/widget_deployment.rb, line 329
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      authentication_required == o.authentication_required &&
      disabled == o.disabled &&
      flow == o.flow &&
      allowed_domains == o.allowed_domains &&
      client_type == o.client_type &&
      client_config == o.client_config &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/widget_deployment.rb, line 376
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/widget_deployment.rb, line 436
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/widget_deployment.rb, line 357
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
client_type=(client_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/widget_deployment.rb, line 306
def client_type=(client_type)
  allowed_values = ["v1", "v2", "v1-http", "third-party"]
  if client_type && !allowed_values.include?(client_type)
    fail ArgumentError, "invalid value for 'client_type', must be one of #{allowed_values}."
  end
  @client_type = client_type
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/widget_deployment.rb, line 346
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/widget_deployment.rb, line 352
def hash
  [id, name, description, authentication_required, disabled, flow, allowed_domains, client_type, client_config, 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/widget_deployment.rb, line 209
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/widget_deployment.rb, line 419
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/widget_deployment.rb, line 424
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/widget_deployment.rb, line 414
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/widget_deployment.rb, line 218
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["v1", "v2", "v1-http", "third-party"]
  if @client_type && !allowed_values.include?(@client_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end