pingram 1.0.38 → 1.0.40

data/lib/pingram/models/{s2s.rb → openai_gpt_realtime21.rb}

@@ -14,18 +14,16 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Speech-to-speech realtime model — best call quality.
-  class S2s < ApiModelBase
-    attr_accessor :mode
-
-    # 'provider:model', e.g. 'openai:gpt-realtime'
+  class OpenaiGptRealtime21 < ApiModelBase
+    # Which realtime model processes the call.
     attr_accessor :model
 
-    # Provider-native voice id for the selected realtime model (e.g. OpenAI `marin`).
     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
@@ -53,7 +51,6 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'mode' => :'mode',
         :'model' => :'model',
         :'voice_id' => :'voiceId',
         :'temperature' => :'temperature',
@@ -74,7 +71,6 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'mode' => :'String',
         :'model' => :'String',
         :'voice_id' => :'String',
         :'temperature' => :'Float',
@@ -92,24 +88,18 @@ module Pingram
     # @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::S2s` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::OpenaiGptRealtime21` 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::S2s`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::OpenaiGptRealtime21`. 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?(:'mode')
-        self.mode = attributes[:'mode']
-      else
-        self.mode = nil
-      end
-
       if attributes.key?(:'model')
         self.model = attributes[:'model']
       else
@@ -118,20 +108,14 @@ module Pingram
 
       if attributes.key?(:'voice_id')
         self.voice_id = attributes[:'voice_id']
-      else
-        self.voice_id = nil
       end
 
       if attributes.key?(:'temperature')
         self.temperature = attributes[:'temperature']
-      else
-        self.temperature = nil
       end
 
       if attributes.key?(:'max_tokens')
         self.max_tokens = attributes[:'max_tokens']
-      else
-        self.max_tokens = nil
       end
     end
 
@@ -140,26 +124,10 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @mode.nil?
-        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
-      end
-
       if @model.nil?
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       end
 
-      if @voice_id.nil?
-        invalid_properties.push('invalid value for "voice_id", voice_id cannot be nil.')
-      end
-
-      if @temperature.nil?
-        invalid_properties.push('invalid value for "temperature", temperature cannot be nil.')
-      end
-
-      if @max_tokens.nil?
-        invalid_properties.push('invalid value for "max_tokens", max_tokens cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -167,72 +135,39 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @mode.nil?
-      mode_validator = EnumAttributeValidator.new('String', ["s2s"])
-      return false unless mode_validator.valid?(@mode)
       return false if @model.nil?
-      return false if @voice_id.nil?
-      return false if @temperature.nil?
-      return false if @max_tokens.nil?
+      model_validator = EnumAttributeValidator.new('String', ["openai:gpt-realtime-2.1"])
+      return false unless model_validator.valid?(@model)
+      voice_id_validator = EnumAttributeValidator.new('String', ["alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar"])
+      return false unless voice_id_validator.valid?(@voice_id)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] mode Object to be assigned
-    def mode=(mode)
-      validator = EnumAttributeValidator.new('String', ["s2s"])
-      unless validator.valid?(mode)
-        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
-      end
-      @mode = mode
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] model Value to be assigned
+    # @param [Object] model Object to be assigned
     def model=(model)
-      if model.nil?
-        fail ArgumentError, 'model cannot be nil'
+      validator = EnumAttributeValidator.new('String', ["openai:gpt-realtime-2.1"])
+      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 with validation
-    # @param [Object] voice_id Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] voice_id Object to be assigned
     def voice_id=(voice_id)
-      if voice_id.nil?
-        fail ArgumentError, 'voice_id cannot be nil'
+      validator = EnumAttributeValidator.new('String', ["alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar"])
+      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
 
-    # Custom attribute writer method with validation
-    # @param [Object] temperature Value to be assigned
-    def temperature=(temperature)
-      if temperature.nil?
-        fail ArgumentError, 'temperature cannot be nil'
-      end
-
-      @temperature = temperature
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] max_tokens Value to be assigned
-    def max_tokens=(max_tokens)
-      if max_tokens.nil?
-        fail ArgumentError, 'max_tokens cannot be nil'
-      end
-
-      @max_tokens = max_tokens
-    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 &&
-          mode == o.mode &&
           model == o.model &&
           voice_id == o.voice_id &&
           temperature == o.temperature &&
@@ -248,7 +183,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mode, model, voice_id, temperature, max_tokens].hash
+      [model, voice_id, temperature, max_tokens].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/openai_gpt_realtime21_mini.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 OpenaiGptRealtime21Mini < 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::OpenaiGptRealtime21Mini` 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::OpenaiGptRealtime21Mini`. 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', ["openai:gpt-realtime-2.1-mini"])
+      return false unless model_validator.valid?(@model)
+      voice_id_validator = EnumAttributeValidator.new('String', ["alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar"])
+      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', ["openai:gpt-realtime-2.1-mini"])
+      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', ["alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar"])
+      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/script.rb

@@ -0,0 +1,225 @@
+=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 Script < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :steps
+
+    attr_accessor :privacy
+
+    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
+      {
+        :'type' => :'type',
+        :'steps' => :'steps',
+        :'privacy' => :'privacy'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'steps' => :'Array<ScriptStepsInner>',
+        :'privacy' => :'ScriptPrivacy'
+      }
+    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::Script` 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::Script`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'steps')
+        if (value = attributes[:'steps']).is_a?(Array)
+          self.steps = value
+        end
+      else
+        self.steps = nil
+      end
+
+      if attributes.key?(:'privacy')
+        self.privacy = attributes[:'privacy']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @steps.nil?
+        invalid_properties.push('invalid value for "steps", steps 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["script"])
+      return false unless type_validator.valid?(@type)
+      return false if @steps.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["script"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] steps Value to be assigned
+    def steps=(steps)
+      if steps.nil?
+        fail ArgumentError, 'steps cannot be nil'
+      end
+
+      @steps = steps
+    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 &&
+          type == o.type &&
+          steps == o.steps &&
+          privacy == o.privacy
+    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
+      [type, steps, privacy].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