class PureCloud::GDPRRequest

Attributes

created_by[RW]

The user that created this request

created_date[RW]

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

id[RW]

The globally unique identifier for the object.

name[RW]
replacement_terms[RW]

The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request

request_type[RW]

The type of GDPR request

results_url[RW]

The location where the results of the request can be retrieved

self_uri[RW]

The URI for this object

status[RW]

The status of the request

subject[RW]

The subject of the GDPR request

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/gdpr_request.rb, line 51
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'created_by' => :'createdBy',
    
    :'replacement_terms' => :'replacementTerms',
    
    :'request_type' => :'requestType',
    
    :'created_date' => :'createdDate',
    
    :'status' => :'status',
    
    :'subject' => :'subject',
    
    :'results_url' => :'resultsUrl',
    
    :'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/gdpr_request.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?(:'createdBy')
    
    
    self.created_by = attributes[:'createdBy']
    
  
  end

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

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

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

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

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

  
  if attributes.has_key?(:'resultsUrl')
    
    
    self.results_url = attributes[:'resultsUrl']
    
  
  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/gdpr_request.rb, line 78
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'created_by' => :'DomainEntityRef',
    
    :'replacement_terms' => :'Array<ReplacementTerm>',
    
    :'request_type' => :'String',
    
    :'created_date' => :'DateTime',
    
    :'status' => :'String',
    
    :'subject' => :'GDPRSubject',
    
    :'results_url' => :'String',
    
    :'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/gdpr_request.rb, line 368
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      created_by == o.created_by &&
      replacement_terms == o.replacement_terms &&
      request_type == o.request_type &&
      created_date == o.created_date &&
      status == o.status &&
      subject == o.subject &&
      results_url == o.results_url &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/gdpr_request.rb, line 415
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/gdpr_request.rb, line 475
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/gdpr_request.rb, line 396
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/gdpr_request.rb, line 385
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/gdpr_request.rb, line 391
def hash
  [id, name, created_by, replacement_terms, request_type, created_date, status, subject, results_url, 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/gdpr_request.rb, line 209
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
request_type=(request_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/gdpr_request.rb, line 321
def request_type=(request_type)
  allowed_values = ["GDPR_EXPORT", "GDPR_UPDATE", "GDPR_DELETE"]
  if request_type && !allowed_values.include?(request_type)
    fail ArgumentError, "invalid value for 'request_type', must be one of #{allowed_values}."
  end
  @request_type = request_type
end
status=(status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/gdpr_request.rb, line 340
def status=(status)
  allowed_values = ["INITIATED", "SEARCHING", "UPDATING", "DELETING", "COMPLETED", "ERROR", "FINALIZING"]
  if status && !allowed_values.include?(status)
    fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/gdpr_request.rb, line 463
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/gdpr_request.rb, line 453
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/gdpr_request.rb, line 218
def valid?
  
  
  
  
  
  
  
  
  
  
  if @created_by.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @request_type.nil?
    return false
  end

  
  
  allowed_values = ["GDPR_EXPORT", "GDPR_UPDATE", "GDPR_DELETE"]
  if @request_type && !allowed_values.include?(@request_type)
    return false
  end
  
  
  
  
  if @created_date.nil?
    return false
  end

  
  
  
  
  
  if @status.nil?
    return false
  end

  
  
  allowed_values = ["INITIATED", "SEARCHING", "UPDATING", "DELETING", "COMPLETED", "ERROR", "FINALIZING"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  if @subject.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
end