pingram 1.0.14 → 1.0.17

data/lib/pingram/models/get_voice_call_response.rb

@@ -0,0 +1,164 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class GetVoiceCallResponse < ApiModelBase
+    attr_accessor :call
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'call' => :'call'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'call' => :'GetVoiceCallResponseCall'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::GetVoiceCallResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::GetVoiceCallResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'call')
+        self.call = attributes[:'call']
+      else
+        self.call = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @call.nil?
+        invalid_properties.push('invalid value for "call", call cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @call.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] call Value to be assigned
+    def call=(call)
+      if call.nil?
+        fail ArgumentError, 'call cannot be nil'
+      end
+
+      @call = call
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          call == o.call
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [call].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end

data/lib/pingram/models/get_voice_call_response_call.rb

@@ -0,0 +1,521 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class GetVoiceCallResponseCall < ApiModelBase
+    attr_accessor :tracking_id
+
+    attr_accessor :status
+
+    # Omitted for playground calls made before the agent was saved.
+    attr_accessor :agent_id
+
+    attr_accessor :agent_name
+
+    attr_accessor :direction
+
+    attr_accessor :source
+
+    attr_accessor :from
+
+    attr_accessor :to
+
+    attr_accessor :started_at
+
+    attr_accessor :duration_seconds
+
+    attr_accessor :outcome
+
+    # Machine-readable reason the call ended — persisted on every call record.
+    attr_accessor :end_reason
+
+    # Short human-readable detail (e.g. provider error message).
+    attr_accessor :end_detail
+
+    # Full chronological timeline (transcript + ops events).
+    attr_accessor :timeline
+
+    attr_accessor :recording_url
+
+    attr_accessor :variables
+
+    attr_accessor :cost
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tracking_id' => :'trackingId',
+        :'status' => :'status',
+        :'agent_id' => :'agentId',
+        :'agent_name' => :'agentName',
+        :'direction' => :'direction',
+        :'source' => :'source',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'started_at' => :'startedAt',
+        :'duration_seconds' => :'durationSeconds',
+        :'outcome' => :'outcome',
+        :'end_reason' => :'endReason',
+        :'end_detail' => :'endDetail',
+        :'timeline' => :'timeline',
+        :'recording_url' => :'recordingUrl',
+        :'variables' => :'variables',
+        :'cost' => :'cost'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'tracking_id' => :'String',
+        :'status' => :'String',
+        :'agent_id' => :'String',
+        :'agent_name' => :'String',
+        :'direction' => :'String',
+        :'source' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'started_at' => :'String',
+        :'duration_seconds' => :'Float',
+        :'outcome' => :'String',
+        :'end_reason' => :'String',
+        :'end_detail' => :'String',
+        :'timeline' => :'Array<GetVoiceCallResponseCallTimelineInner>',
+        :'recording_url' => :'String',
+        :'variables' => :'Hash<String, String>',
+        :'cost' => :'GetVoiceCallResponseCallCost'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::GetVoiceCallResponseCall` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::GetVoiceCallResponseCall`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      else
+        self.tracking_id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'agent_id')
+        self.agent_id = attributes[:'agent_id']
+      end
+
+      if attributes.key?(:'agent_name')
+        self.agent_name = attributes[:'agent_name']
+      else
+        self.agent_name = nil
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      else
+        self.direction = nil
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = nil
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      else
+        self.from = nil
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      else
+        self.started_at = nil
+      end
+
+      if attributes.key?(:'duration_seconds')
+        self.duration_seconds = attributes[:'duration_seconds']
+      else
+        self.duration_seconds = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'end_reason')
+        self.end_reason = attributes[:'end_reason']
+      end
+
+      if attributes.key?(:'end_detail')
+        self.end_detail = attributes[:'end_detail']
+      end
+
+      if attributes.key?(:'timeline')
+        if (value = attributes[:'timeline']).is_a?(Array)
+          self.timeline = value
+        end
+      else
+        self.timeline = nil
+      end
+
+      if attributes.key?(:'recording_url')
+        self.recording_url = attributes[:'recording_url']
+      end
+
+      if attributes.key?(:'variables')
+        if (value = attributes[:'variables']).is_a?(Hash)
+          self.variables = value
+        end
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @tracking_id.nil?
+        invalid_properties.push('invalid value for "tracking_id", tracking_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @agent_name.nil?
+        invalid_properties.push('invalid value for "agent_name", agent_name cannot be nil.')
+      end
+
+      if @direction.nil?
+        invalid_properties.push('invalid value for "direction", direction cannot be nil.')
+      end
+
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
+      end
+
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @started_at.nil?
+        invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
+      end
+
+      if @duration_seconds.nil?
+        invalid_properties.push('invalid value for "duration_seconds", duration_seconds cannot be nil.')
+      end
+
+      if @timeline.nil?
+        invalid_properties.push('invalid value for "timeline", timeline cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @tracking_id.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "ended", "failed"])
+      return false unless status_validator.valid?(@status)
+      return false if @agent_name.nil?
+      return false if @direction.nil?
+      direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
+      return false unless direction_validator.valid?(@direction)
+      return false if @source.nil?
+      source_validator = EnumAttributeValidator.new('String', ["pstn", "web"])
+      return false unless source_validator.valid?(@source)
+      return false if @from.nil?
+      return false if @to.nil?
+      return false if @started_at.nil?
+      return false if @duration_seconds.nil?
+      outcome_validator = EnumAttributeValidator.new('String', ["completed", "transferred", "voicemail", "no_answer", "failed"])
+      return false unless outcome_validator.valid?(@outcome)
+      end_reason_validator = EnumAttributeValidator.new('String', ["user_hangup", "agent_end_call", "silence_timeout", "max_duration", "free_tier_limit", "transferred", "voicemail", "provider_error", "connection_lost", "no_answer", "session_expired", "server_shutdown"])
+      return false unless end_reason_validator.valid?(@end_reason)
+      return false if @timeline.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracking_id Value to be assigned
+    def tracking_id=(tracking_id)
+      if tracking_id.nil?
+        fail ArgumentError, 'tracking_id cannot be nil'
+      end
+
+      @tracking_id = tracking_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "ended", "failed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] agent_name Value to be assigned
+    def agent_name=(agent_name)
+      if agent_name.nil?
+        fail ArgumentError, 'agent_name cannot be nil'
+      end
+
+      @agent_name = agent_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
+      unless validator.valid?(direction)
+        fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
+      end
+      @direction = direction
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["pstn", "web"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from Value to be assigned
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'from cannot be nil'
+      end
+
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] started_at Value to be assigned
+    def started_at=(started_at)
+      if started_at.nil?
+        fail ArgumentError, 'started_at cannot be nil'
+      end
+
+      @started_at = started_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] duration_seconds Value to be assigned
+    def duration_seconds=(duration_seconds)
+      if duration_seconds.nil?
+        fail ArgumentError, 'duration_seconds cannot be nil'
+      end
+
+      @duration_seconds = duration_seconds
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome Object to be assigned
+    def outcome=(outcome)
+      validator = EnumAttributeValidator.new('String', ["completed", "transferred", "voicemail", "no_answer", "failed"])
+      unless validator.valid?(outcome)
+        fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
+      end
+      @outcome = outcome
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] end_reason Object to be assigned
+    def end_reason=(end_reason)
+      validator = EnumAttributeValidator.new('String', ["user_hangup", "agent_end_call", "silence_timeout", "max_duration", "free_tier_limit", "transferred", "voicemail", "provider_error", "connection_lost", "no_answer", "session_expired", "server_shutdown"])
+      unless validator.valid?(end_reason)
+        fail ArgumentError, "invalid value for \"end_reason\", must be one of #{validator.allowable_values}."
+      end
+      @end_reason = end_reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timeline Value to be assigned
+    def timeline=(timeline)
+      if timeline.nil?
+        fail ArgumentError, 'timeline cannot be nil'
+      end
+
+      @timeline = timeline
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          tracking_id == o.tracking_id &&
+          status == o.status &&
+          agent_id == o.agent_id &&
+          agent_name == o.agent_name &&
+          direction == o.direction &&
+          source == o.source &&
+          from == o.from &&
+          to == o.to &&
+          started_at == o.started_at &&
+          duration_seconds == o.duration_seconds &&
+          outcome == o.outcome &&
+          end_reason == o.end_reason &&
+          end_detail == o.end_detail &&
+          timeline == o.timeline &&
+          recording_url == o.recording_url &&
+          variables == o.variables &&
+          cost == o.cost
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [tracking_id, status, agent_id, agent_name, direction, source, from, to, started_at, duration_seconds, outcome, end_reason, end_detail, timeline, recording_url, variables, cost].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end