pingram 1.0.14 → 1.0.17

data/lib/pingram/models/bind_number_response_agent_spec_conversation.rb

@@ -0,0 +1,328 @@
+=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 BindNumberResponseAgentSpecConversation < ApiModelBase
+    attr_accessor :turn_detection
+
+    attr_accessor :min_end_of_turn_silence_ms
+
+    attr_accessor :allow_interruptions
+
+    attr_accessor :min_interruption_duration_ms
+
+    attr_accessor :silence_timeout_seconds
+
+    attr_accessor :max_call_length_seconds
+
+    # When true (default), the agent may invoke the built-in end_call action.
+    attr_accessor :agent_can_end_call
+
+    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
+      {
+        :'turn_detection' => :'turnDetection',
+        :'min_end_of_turn_silence_ms' => :'minEndOfTurnSilenceMs',
+        :'allow_interruptions' => :'allowInterruptions',
+        :'min_interruption_duration_ms' => :'minInterruptionDurationMs',
+        :'silence_timeout_seconds' => :'silenceTimeoutSeconds',
+        :'max_call_length_seconds' => :'maxCallLengthSeconds',
+        :'agent_can_end_call' => :'agentCanEndCall'
+      }
+    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
+      {
+        :'turn_detection' => :'String',
+        :'min_end_of_turn_silence_ms' => :'Float',
+        :'allow_interruptions' => :'Boolean',
+        :'min_interruption_duration_ms' => :'Float',
+        :'silence_timeout_seconds' => :'Float',
+        :'max_call_length_seconds' => :'Float',
+        :'agent_can_end_call' => :'Boolean'
+      }
+    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::BindNumberResponseAgentSpecConversation` 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::BindNumberResponseAgentSpecConversation`. 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?(:'turn_detection')
+        self.turn_detection = attributes[:'turn_detection']
+      else
+        self.turn_detection = nil
+      end
+
+      if attributes.key?(:'min_end_of_turn_silence_ms')
+        self.min_end_of_turn_silence_ms = attributes[:'min_end_of_turn_silence_ms']
+      else
+        self.min_end_of_turn_silence_ms = nil
+      end
+
+      if attributes.key?(:'allow_interruptions')
+        self.allow_interruptions = attributes[:'allow_interruptions']
+      else
+        self.allow_interruptions = nil
+      end
+
+      if attributes.key?(:'min_interruption_duration_ms')
+        self.min_interruption_duration_ms = attributes[:'min_interruption_duration_ms']
+      else
+        self.min_interruption_duration_ms = nil
+      end
+
+      if attributes.key?(:'silence_timeout_seconds')
+        self.silence_timeout_seconds = attributes[:'silence_timeout_seconds']
+      else
+        self.silence_timeout_seconds = nil
+      end
+
+      if attributes.key?(:'max_call_length_seconds')
+        self.max_call_length_seconds = attributes[:'max_call_length_seconds']
+      else
+        self.max_call_length_seconds = nil
+      end
+
+      if attributes.key?(:'agent_can_end_call')
+        self.agent_can_end_call = attributes[:'agent_can_end_call']
+      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 @turn_detection.nil?
+        invalid_properties.push('invalid value for "turn_detection", turn_detection cannot be nil.')
+      end
+
+      if @min_end_of_turn_silence_ms.nil?
+        invalid_properties.push('invalid value for "min_end_of_turn_silence_ms", min_end_of_turn_silence_ms cannot be nil.')
+      end
+
+      if @allow_interruptions.nil?
+        invalid_properties.push('invalid value for "allow_interruptions", allow_interruptions cannot be nil.')
+      end
+
+      if @min_interruption_duration_ms.nil?
+        invalid_properties.push('invalid value for "min_interruption_duration_ms", min_interruption_duration_ms cannot be nil.')
+      end
+
+      if @silence_timeout_seconds.nil?
+        invalid_properties.push('invalid value for "silence_timeout_seconds", silence_timeout_seconds cannot be nil.')
+      end
+
+      if @max_call_length_seconds.nil?
+        invalid_properties.push('invalid value for "max_call_length_seconds", max_call_length_seconds 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 @turn_detection.nil?
+      turn_detection_validator = EnumAttributeValidator.new('String', ["semantic", "vad"])
+      return false unless turn_detection_validator.valid?(@turn_detection)
+      return false if @min_end_of_turn_silence_ms.nil?
+      return false if @allow_interruptions.nil?
+      return false if @min_interruption_duration_ms.nil?
+      return false if @silence_timeout_seconds.nil?
+      return false if @max_call_length_seconds.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] turn_detection Object to be assigned
+    def turn_detection=(turn_detection)
+      validator = EnumAttributeValidator.new('String', ["semantic", "vad"])
+      unless validator.valid?(turn_detection)
+        fail ArgumentError, "invalid value for \"turn_detection\", must be one of #{validator.allowable_values}."
+      end
+      @turn_detection = turn_detection
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_end_of_turn_silence_ms Value to be assigned
+    def min_end_of_turn_silence_ms=(min_end_of_turn_silence_ms)
+      if min_end_of_turn_silence_ms.nil?
+        fail ArgumentError, 'min_end_of_turn_silence_ms cannot be nil'
+      end
+
+      @min_end_of_turn_silence_ms = min_end_of_turn_silence_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allow_interruptions Value to be assigned
+    def allow_interruptions=(allow_interruptions)
+      if allow_interruptions.nil?
+        fail ArgumentError, 'allow_interruptions cannot be nil'
+      end
+
+      @allow_interruptions = allow_interruptions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_interruption_duration_ms Value to be assigned
+    def min_interruption_duration_ms=(min_interruption_duration_ms)
+      if min_interruption_duration_ms.nil?
+        fail ArgumentError, 'min_interruption_duration_ms cannot be nil'
+      end
+
+      @min_interruption_duration_ms = min_interruption_duration_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] silence_timeout_seconds Value to be assigned
+    def silence_timeout_seconds=(silence_timeout_seconds)
+      if silence_timeout_seconds.nil?
+        fail ArgumentError, 'silence_timeout_seconds cannot be nil'
+      end
+
+      @silence_timeout_seconds = silence_timeout_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_call_length_seconds Value to be assigned
+    def max_call_length_seconds=(max_call_length_seconds)
+      if max_call_length_seconds.nil?
+        fail ArgumentError, 'max_call_length_seconds cannot be nil'
+      end
+
+      @max_call_length_seconds = max_call_length_seconds
+    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 &&
+          turn_detection == o.turn_detection &&
+          min_end_of_turn_silence_ms == o.min_end_of_turn_silence_ms &&
+          allow_interruptions == o.allow_interruptions &&
+          min_interruption_duration_ms == o.min_interruption_duration_ms &&
+          silence_timeout_seconds == o.silence_timeout_seconds &&
+          max_call_length_seconds == o.max_call_length_seconds &&
+          agent_can_end_call == o.agent_can_end_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
+      [turn_detection, min_end_of_turn_silence_ms, allow_interruptions, min_interruption_duration_ms, silence_timeout_seconds, max_call_length_seconds, agent_can_end_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/bind_number_response_agent_spec_inbound.rb

@@ -0,0 +1,214 @@
+=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 BindNumberResponseAgentSpecInbound < ApiModelBase
+    attr_accessor :first_action
+
+    attr_accessor :greeting
+
+    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
+      {
+        :'first_action' => :'firstAction',
+        :'greeting' => :'greeting'
+      }
+    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
+      {
+        :'first_action' => :'String',
+        :'greeting' => :'String'
+      }
+    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::BindNumberResponseAgentSpecInbound` 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::BindNumberResponseAgentSpecInbound`. 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?(:'first_action')
+        self.first_action = attributes[:'first_action']
+      else
+        self.first_action = nil
+      end
+
+      if attributes.key?(:'greeting')
+        self.greeting = attributes[:'greeting']
+      else
+        self.greeting = 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 @first_action.nil?
+        invalid_properties.push('invalid value for "first_action", first_action cannot be nil.')
+      end
+
+      if @greeting.nil?
+        invalid_properties.push('invalid value for "greeting", greeting 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 @first_action.nil?
+      first_action_validator = EnumAttributeValidator.new('String', ["speak", "wait"])
+      return false unless first_action_validator.valid?(@first_action)
+      return false if @greeting.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] first_action Object to be assigned
+    def first_action=(first_action)
+      validator = EnumAttributeValidator.new('String', ["speak", "wait"])
+      unless validator.valid?(first_action)
+        fail ArgumentError, "invalid value for \"first_action\", must be one of #{validator.allowable_values}."
+      end
+      @first_action = first_action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] greeting Value to be assigned
+    def greeting=(greeting)
+      if greeting.nil?
+        fail ArgumentError, 'greeting cannot be nil'
+      end
+
+      @greeting = greeting
+    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 &&
+          first_action == o.first_action &&
+          greeting == o.greeting
+    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
+      [first_action, greeting].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/bind_number_response_agent_spec_model.rb

@@ -0,0 +1,105 @@
+=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
+  # Speech pipeline. Prefer s2s mode (e.g. `openai:gpt-realtime` with voice `marin`).
+  module BindNumberResponseAgentSpecModel
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Chained',
+          :'S2s'
+        ]
+      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