class Freeclimb::CallResult

Attributes

account_id[RW]

ID of the account that owns this Call.

answered_by[RW]

If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise.

call_id[RW]

String that uniquely identifies this Call resource.

connect_duration[RW]

Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.

connect_time[RW]

Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.

date_created[RW]

The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).

date_updated[RW]

The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).

direction[RW]

Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command.

duration[RW]

Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.

end_time[RW]

End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully.

from[RW]

Phone number that initiated this Call.

parent_call_id[RW]

ID of the Call that created this leg (child Call).

phone_number_id[RW]

If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).

revision[RW]

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.

start_time[RW]

Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.

status[RW]
  • `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered.

subresource_uris[RW]

The list of subresources for this Call. These include things like logs and recordings associated with the Call.

to[RW]

Phone number that received this Call.

uri[RW]

The URI for this resource, relative to /apiserver.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 97
def self.attribute_map
  {
    :'uri' => :'uri',
    :'date_created' => :'dateCreated',
    :'date_updated' => :'dateUpdated',
    :'revision' => :'revision',
    :'call_id' => :'callId',
    :'parent_call_id' => :'parentCallId',
    :'account_id' => :'accountId',
    :'from' => :'from',
    :'to' => :'to',
    :'phone_number_id' => :'phoneNumberId',
    :'status' => :'status',
    :'start_time' => :'startTime',
    :'connect_time' => :'connectTime',
    :'end_time' => :'endTime',
    :'duration' => :'duration',
    :'connect_duration' => :'connectDuration',
    :'direction' => :'direction',
    :'answered_by' => :'answeredBy',
    :'subresource_uris' => :'subresourceUris'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/freeclimb/models/call_result.rb, line 318
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 162
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::CallResult` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::CallResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'uri')
    self.uri = attributes[:'uri']
  end

  if attributes.key?(:'date_created')
    self.date_created = attributes[:'date_created']
  end

  if attributes.key?(:'date_updated')
    self.date_updated = attributes[:'date_updated']
  end

  if attributes.key?(:'revision')
    self.revision = attributes[:'revision']
  end

  if attributes.key?(:'call_id')
    self.call_id = attributes[:'call_id']
  end

  if attributes.key?(:'parent_call_id')
    self.parent_call_id = attributes[:'parent_call_id']
  end

  if attributes.key?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  end

  if attributes.key?(:'phone_number_id')
    self.phone_number_id = attributes[:'phone_number_id']
  end

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

  if attributes.key?(:'start_time')
    self.start_time = attributes[:'start_time']
  end

  if attributes.key?(:'connect_time')
    self.connect_time = attributes[:'connect_time']
  end

  if attributes.key?(:'end_time')
    self.end_time = attributes[:'end_time']
  end

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.key?(:'connect_duration')
    self.connect_duration = attributes[:'connect_duration']
  end

  if attributes.key?(:'direction')
    self.direction = attributes[:'direction']
  end

  if attributes.key?(:'answered_by')
    self.answered_by = attributes[:'answered_by']
  end

  if attributes.key?(:'subresource_uris')
    self.subresource_uris = attributes[:'subresource_uris']
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/freeclimb/models/call_result.rb, line 153
def self.openapi_all_of
  [
  :'CallResultAllOf',
  :'MutableResourceModel'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/freeclimb/models/call_result.rb, line 147
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/freeclimb/models/call_result.rb, line 122
def self.openapi_types
  {
    :'uri' => :'String',
    :'date_created' => :'String',
    :'date_updated' => :'String',
    :'revision' => :'Integer',
    :'call_id' => :'String',
    :'parent_call_id' => :'String',
    :'account_id' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'phone_number_id' => :'String',
    :'status' => :'String',
    :'start_time' => :'String',
    :'connect_time' => :'String',
    :'end_time' => :'String',
    :'duration' => :'Integer',
    :'connect_duration' => :'Integer',
    :'direction' => :'String',
    :'answered_by' => :'String',
    :'subresource_uris' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 279
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uri == o.uri &&
      date_created == o.date_created &&
      date_updated == o.date_updated &&
      revision == o.revision &&
      call_id == o.call_id &&
      parent_call_id == o.parent_call_id &&
      account_id == o.account_id &&
      from == o.from &&
      to == o.to &&
      phone_number_id == o.phone_number_id &&
      status == o.status &&
      start_time == o.start_time &&
      connect_time == o.connect_time &&
      end_time == o.end_time &&
      duration == o.duration &&
      connect_duration == o.connect_duration &&
      direction == o.direction &&
      answered_by == o.answered_by &&
      subresource_uris == o.subresource_uris
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/freeclimb/models/call_result.rb, line 346
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 =~ /\A(true|t|yes|y|1)\z/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
    Freeclimb.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/freeclimb/models/call_result.rb, line 415
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

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/freeclimb/models/call_result.rb, line 325
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 305
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 311
def hash
  [uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
end
list_invalid_properties() click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 254
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
status=(status) click to toggle source

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

# File lib/freeclimb/models/call_result.rb, line 269
def status=(status)
  validator = EnumAttributeValidator.new('String', ["queued", "ringing", "inProgress", "canceled", "completed", "busy", "failed", "noAnswer"])
  unless validator.valid?(status)
    fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/freeclimb/models/call_result.rb, line 391
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/freeclimb/models/call_result.rb, line 397
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/freeclimb/models/call_result.rb, line 385
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/freeclimb/models/call_result.rb, line 261
def valid?
  status_validator = EnumAttributeValidator.new('String', ["queued", "ringing", "inProgress", "canceled", "completed", "busy", "failed", "noAnswer"])
  return false unless status_validator.valid?(@status)
  true
end