class PureCloud::HistoryListing

Attributes

action_name[RW]

Action name

action_status[RW]

Action status

client[RW]
complete[RW]
completed[RW]

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

description[RW]
entities[RW]
error_code[RW]
error_details[RW]
error_message[RW]
error_message_params[RW]
id[RW]
name[RW]
page_count[RW]
page_number[RW]
page_size[RW]
started[RW]

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

system[RW]
total[RW]
user[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 66
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'complete' => :'complete',
    
    :'user' => :'user',
    
    :'client' => :'client',
    
    :'error_message' => :'errorMessage',
    
    :'error_code' => :'errorCode',
    
    :'error_details' => :'errorDetails',
    
    :'error_message_params' => :'errorMessageParams',
    
    :'action_name' => :'actionName',
    
    :'action_status' => :'actionStatus',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'system' => :'system',
    
    :'started' => :'started',
    
    :'completed' => :'completed',
    
    :'entities' => :'entities',
    
    :'total' => :'total',
    
    :'page_number' => :'pageNumber',
    
    :'page_size' => :'pageSize',
    
    :'page_count' => :'pageCount'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'actionStatus')
    
    
    self.action_status = attributes[:'actionStatus']
    
  
  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?(:'system')
    
    
    self.system = attributes[:'system']
    
  
  end

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 113
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'complete' => :'BOOLEAN',
    
    :'user' => :'User',
    
    :'client' => :'DomainEntityRef',
    
    :'error_message' => :'String',
    
    :'error_code' => :'String',
    
    :'error_details' => :'Array<Detail>',
    
    :'error_message_params' => :'Hash<String, String>',
    
    :'action_name' => :'String',
    
    :'action_status' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'system' => :'BOOLEAN',
    
    :'started' => :'DateTime',
    
    :'completed' => :'DateTime',
    
    :'entities' => :'Array<HistoryEntry>',
    
    :'total' => :'Integer',
    
    :'page_number' => :'Integer',
    
    :'page_size' => :'Integer',
    
    :'page_count' => :'Integer'
    
  }
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/history_listing.rb, line 582
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      complete == o.complete &&
      user == o.user &&
      client == o.client &&
      error_message == o.error_message &&
      error_code == o.error_code &&
      error_details == o.error_details &&
      error_message_params == o.error_message_params &&
      action_name == o.action_name &&
      action_status == o.action_status &&
      name == o.name &&
      description == o.description &&
      system == o.system &&
      started == o.started &&
      completed == o.completed &&
      entities == o.entities &&
      total == o.total &&
      page_number == o.page_number &&
      page_size == o.page_size &&
      page_count == o.page_count
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/history_listing.rb, line 639
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/history_listing.rb, line 699
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
action_name=(action_name) click to toggle source

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

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 505
def action_name=(action_name)
  allowed_values = ["CREATE", "CHECKIN", "DEBUG", "DELETE", "HISTORY", "PUBLISH", "STATE_CHANGE", "UPDATE", "VALIDATE"]
  if action_name && !allowed_values.include?(action_name)
    fail ArgumentError, "invalid value for 'action_name', must be one of #{allowed_values}."
  end
  @action_name = action_name
end
action_status=(action_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 519
def action_status=(action_status)
  allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
  if action_status && !allowed_values.include?(action_status)
    fail ArgumentError, "invalid value for 'action_status', must be one of #{allowed_values}."
  end
  @action_status = action_status
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 620
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/history_listing.rb, line 609
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/history_listing.rb, line 615
def hash
  [id, complete, user, client, error_message, error_code, error_details, error_message_params, action_name, action_status, name, description, system, started, completed, entities, total, page_number, page_size, page_count].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/history_listing.rb, line 358
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/history_listing.rb, line 682
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/history_listing.rb, line 687
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/history_listing.rb, line 677
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/history_listing.rb, line 367
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["CREATE", "CHECKIN", "DEBUG", "DELETE", "HISTORY", "PUBLISH", "STATE_CHANGE", "UPDATE", "VALIDATE"]
  if @action_name && !allowed_values.include?(@action_name)
    return false
  end
  
  
  
  
  
  allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
  if @action_status && !allowed_values.include?(@action_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end