pingram 1.0.38 → 1.0.40

data/lib/pingram/models/get_voice_call_response_call.rb

@@ -19,10 +19,7 @@ module Pingram
 
     attr_accessor :status
 
-    # Omitted for playground calls made before the agent was saved.
-    attr_accessor :agent_id
-
-    attr_accessor :agent_name
+    attr_accessor :config_name
 
     attr_accessor :direction
 
@@ -34,6 +31,9 @@ module Pingram
 
     attr_accessor :started_at
 
+    # Set when the callee answers. Absent while the phone is still ringing.
+    attr_accessor :answered_at
+
     attr_accessor :duration_seconds
 
     attr_accessor :outcome
@@ -41,7 +41,7 @@ module Pingram
     # Machine-readable reason the call ended — persisted on every call record.
     attr_accessor :end_reason
 
-    # Short human-readable detail (e.g. provider error message).
+    # Short human-readable detail, such as why the call failed.
     attr_accessor :end_detail
 
     # Full chronological timeline (transcript + ops events).
@@ -80,13 +80,13 @@ module Pingram
       {
         :'tracking_id' => :'trackingId',
         :'status' => :'status',
-        :'agent_id' => :'agentId',
-        :'agent_name' => :'agentName',
+        :'config_name' => :'configName',
         :'direction' => :'direction',
         :'source' => :'source',
         :'from' => :'from',
         :'to' => :'to',
         :'started_at' => :'startedAt',
+        :'answered_at' => :'answeredAt',
         :'duration_seconds' => :'durationSeconds',
         :'outcome' => :'outcome',
         :'end_reason' => :'endReason',
@@ -113,13 +113,13 @@ module Pingram
       {
         :'tracking_id' => :'String',
         :'status' => :'String',
-        :'agent_id' => :'String',
-        :'agent_name' => :'String',
+        :'config_name' => :'String',
         :'direction' => :'String',
         :'source' => :'String',
         :'from' => :'String',
         :'to' => :'String',
         :'started_at' => :'String',
+        :'answered_at' => :'String',
         :'duration_seconds' => :'Float',
         :'outcome' => :'String',
         :'end_reason' => :'String',
@@ -165,14 +165,10 @@ module Pingram
         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']
+      if attributes.key?(:'config_name')
+        self.config_name = attributes[:'config_name']
       else
-        self.agent_name = nil
+        self.config_name = nil
       end
 
       if attributes.key?(:'direction')
@@ -205,6 +201,10 @@ module Pingram
         self.started_at = nil
       end
 
+      if attributes.key?(:'answered_at')
+        self.answered_at = attributes[:'answered_at']
+      end
+
       if attributes.key?(:'duration_seconds')
         self.duration_seconds = attributes[:'duration_seconds']
       else
@@ -259,8 +259,8 @@ module Pingram
         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.')
+      if @config_name.nil?
+        invalid_properties.push('invalid value for "config_name", config_name cannot be nil.')
       end
 
       if @direction.nil?
@@ -302,7 +302,7 @@ module Pingram
       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 @config_name.nil?
       return false if @direction.nil?
       direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
       return false unless direction_validator.valid?(@direction)
@@ -342,13 +342,13 @@ module Pingram
     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'
+    # @param [Object] config_name Value to be assigned
+    def config_name=(config_name)
+      if config_name.nil?
+        fail ArgumentError, 'config_name cannot be nil'
       end
 
-      @agent_name = agent_name
+      @config_name = config_name
     end
 
     # Custom attribute writer method checking allowed values (enum).
@@ -448,13 +448,13 @@ module Pingram
       self.class == o.class &&
           tracking_id == o.tracking_id &&
           status == o.status &&
-          agent_id == o.agent_id &&
-          agent_name == o.agent_name &&
+          config_name == o.config_name &&
           direction == o.direction &&
           source == o.source &&
           from == o.from &&
           to == o.to &&
           started_at == o.started_at &&
+          answered_at == o.answered_at &&
           duration_seconds == o.duration_seconds &&
           outcome == o.outcome &&
           end_reason == o.end_reason &&
@@ -474,7 +474,7 @@ module Pingram
     # 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
+      [tracking_id, status, config_name, direction, source, from, to, started_at, answered_at, duration_seconds, outcome, end_reason, end_detail, timeline, recording_url, variables, cost].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/get_voice_call_response_call_cost.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Customer-facing call cost on GET /voice/calls/{trackingId} (SDK: GetVoiceCallResponseCallCost).
+  # Customer-facing cost for this call.
   class GetVoiceCallResponseCallCost < ApiModelBase
     attr_accessor :total_usd
 

data/lib/pingram/models/get_voice_call_response_call_cost_lines_inner.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # One line item in a call cost breakdown (API / SDK).
+  # One line in the call cost breakdown.
   class GetVoiceCallResponseCallCostLinesInner < ApiModelBase
     attr_accessor :role
 

data/lib/pingram/models/google_gemini31_flash_live_preview.rb

@@ -0,0 +1,230 @@
+=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 GoogleGemini31FlashLivePreview < ApiModelBase
+    # Which realtime model processes the call.
+    attr_accessor :model
+
+    attr_accessor :voice_id
+
+    # How varied replies are. 0 is focused, 1 is more creative. Default: 0.8.
+    attr_accessor :temperature
+
+    # Maximum length of one reply, in tokens. Default: 4096.
+    attr_accessor :max_tokens
+
+    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
+      {
+        :'model' => :'model',
+        :'voice_id' => :'voiceId',
+        :'temperature' => :'temperature',
+        :'max_tokens' => :'maxTokens'
+      }
+    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
+      {
+        :'model' => :'String',
+        :'voice_id' => :'String',
+        :'temperature' => :'Float',
+        :'max_tokens' => :'Float'
+      }
+    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::GoogleGemini31FlashLivePreview` 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::GoogleGemini31FlashLivePreview`. 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?(:'model')
+        self.model = attributes[:'model']
+      else
+        self.model = nil
+      end
+
+      if attributes.key?(:'voice_id')
+        self.voice_id = attributes[:'voice_id']
+      end
+
+      if attributes.key?(:'temperature')
+        self.temperature = attributes[:'temperature']
+      end
+
+      if attributes.key?(:'max_tokens')
+        self.max_tokens = attributes[:'max_tokens']
+      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 @model.nil?
+        invalid_properties.push('invalid value for "model", model 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 @model.nil?
+      model_validator = EnumAttributeValidator.new('String', ["google:gemini-3.1-flash-live-preview"])
+      return false unless model_validator.valid?(@model)
+      voice_id_validator = EnumAttributeValidator.new('String', ["Puck", "Charon", "Kore", "Fenrir", "Aoede", "Leda", "Orus", "Zephyr"])
+      return false unless voice_id_validator.valid?(@voice_id)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] model Object to be assigned
+    def model=(model)
+      validator = EnumAttributeValidator.new('String', ["google:gemini-3.1-flash-live-preview"])
+      unless validator.valid?(model)
+        fail ArgumentError, "invalid value for \"model\", must be one of #{validator.allowable_values}."
+      end
+      @model = model
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] voice_id Object to be assigned
+    def voice_id=(voice_id)
+      validator = EnumAttributeValidator.new('String', ["Puck", "Charon", "Kore", "Fenrir", "Aoede", "Leda", "Orus", "Zephyr"])
+      unless validator.valid?(voice_id)
+        fail ArgumentError, "invalid value for \"voice_id\", must be one of #{validator.allowable_values}."
+      end
+      @voice_id = voice_id
+    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 &&
+          model == o.model &&
+          voice_id == o.voice_id &&
+          temperature == o.temperature &&
+          max_tokens == o.max_tokens
+    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
+      [model, voice_id, temperature, max_tokens].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/inbound_config.rb

@@ -0,0 +1,106 @@
+=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
+  module InboundConfig
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Agent',
+          :'Disabled',
+          :'Script',
+          :'Transfer1'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Pingram.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/pingram/models/knowledge.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Answer from uploaded documents.
   class Knowledge < ApiModelBase
+    # Search uploaded documents during the call.
     attr_accessor :type
 
+    # Files the agent can search.
     attr_accessor :documents
 
     class EnumAttributeValidator

data/lib/pingram/models/knowledge_documents_inner.rb

@@ -18,8 +18,10 @@ module Pingram
     # Opaque identifier for an uploaded knowledge document.
     attr_accessor :doc_id
 
+    # File name shown to the agent and in the dashboard.
     attr_accessor :name
 
+    # File size in bytes.
     attr_accessor :size_bytes
 
     # Attribute mapping from ruby-style variable name to JSON key.