pingram 1.0.39 → 1.0.40

data/lib/pingram/models/voice_browser_call_request.rb

@@ -15,20 +15,42 @@ require 'time'
 
 module Pingram
   class VoiceBrowserCallRequest < ApiModelBase
-    attr_accessor :spec
+    attr_accessor :config
 
     # Optional per-call {{variable}} overrides for browser playground.
     attr_accessor :variables
 
-    # Saved agent id when testing from the dashboard playground.
-    attr_accessor :agent_id
+    # inbound speaks the greeting. outbound speaks the opener. Omitted means outbound.
+    attr_accessor :direction
+
+    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
       {
-        :'spec' => :'spec',
+        :'config' => :'config',
         :'variables' => :'variables',
-        :'agent_id' => :'agentId'
+        :'direction' => :'direction'
       }
     end
 
@@ -45,9 +67,9 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'spec' => :'BindNumberResponseAgentSpec',
+        :'config' => :'VoiceBrowserCallRequestConfig',
         :'variables' => :'Hash<String, String>',
-        :'agent_id' => :'String'
+        :'direction' => :'String'
       }
     end
 
@@ -73,10 +95,10 @@ module Pingram
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'spec')
-        self.spec = attributes[:'spec']
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
       else
-        self.spec = nil
+        self.config = nil
       end
 
       if attributes.key?(:'variables')
@@ -85,8 +107,8 @@ module Pingram
         end
       end
 
-      if attributes.key?(:'agent_id')
-        self.agent_id = attributes[:'agent_id']
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
       end
     end
 
@@ -95,8 +117,8 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @spec.nil?
-        invalid_properties.push('invalid value for "spec", spec cannot be nil.')
+      if @config.nil?
+        invalid_properties.push('invalid value for "config", config cannot be nil.')
       end
 
       invalid_properties
@@ -106,18 +128,30 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @spec.nil?
+      return false if @config.nil?
+      direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
+      return false unless direction_validator.valid?(@direction)
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] spec Value to be assigned
-    def spec=(spec)
-      if spec.nil?
-        fail ArgumentError, 'spec cannot be nil'
+    # @param [Object] config Value to be assigned
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'config cannot be nil'
       end
 
-      @spec = spec
+      @config = config
+    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
 
     # Checks equality by comparing each attribute.
@@ -125,9 +159,9 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          spec == o.spec &&
+          config == o.config &&
           variables == o.variables &&
-          agent_id == o.agent_id
+          direction == o.direction
     end
 
     # @see the `==` method
@@ -139,7 +173,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [spec, variables, agent_id].hash
+      [config, variables, direction].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/voice_browser_call_request_config.rb

@@ -0,0 +1,104 @@
+=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
+  # Agent behavior for this browser call. Script calls use POST /voice/call.
+  module VoiceBrowserCallRequestConfig
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'ArmVoiceInboundClaimRequestInbound',
+          :'VoiceBrowserCallRequestConfigAnyOf'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - 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_any_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_any_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_any_of) # nested anyOf 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/voice_browser_call_request_config_any_of.rb

@@ -0,0 +1,104 @@
+=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 VoiceBrowserCallRequestConfigAnyOf
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Agent1',
+          :'Script1'
+        ]
+      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/voice_call_request.rb

@@ -15,23 +15,20 @@ require 'time'
 
 module Pingram
   class VoiceCallRequest < ApiModelBase
-    attr_accessor :phone_number
+    # E.164 number to dial.
+    attr_accessor :to
 
-    attr_accessor :spec
+    attr_accessor :config
 
     # Optional per-call {{variable}} overrides.
     attr_accessor :variables
 
-    # Saved agent id when testing from the dashboard playground.
-    attr_accessor :agent_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'phone_number' => :'phoneNumber',
-        :'spec' => :'spec',
-        :'variables' => :'variables',
-        :'agent_id' => :'agentId'
+        :'to' => :'to',
+        :'config' => :'config',
+        :'variables' => :'variables'
       }
     end
 
@@ -48,10 +45,9 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'phone_number' => :'String',
-        :'spec' => :'BindNumberResponseAgentSpec',
-        :'variables' => :'Hash<String, String>',
-        :'agent_id' => :'String'
+        :'to' => :'String',
+        :'config' => :'VoiceBrowserCallRequestConfigAnyOf',
+        :'variables' => :'Hash<String, String>'
       }
     end
 
@@ -77,16 +73,16 @@ module Pingram
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'phone_number')
-        self.phone_number = attributes[:'phone_number']
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
       else
-        self.phone_number = nil
+        self.to = nil
       end
 
-      if attributes.key?(:'spec')
-        self.spec = attributes[:'spec']
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
       else
-        self.spec = nil
+        self.config = nil
       end
 
       if attributes.key?(:'variables')
@@ -94,10 +90,6 @@ module Pingram
           self.variables = value
         end
       end
-
-      if attributes.key?(:'agent_id')
-        self.agent_id = attributes[:'agent_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -105,12 +97,12 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @phone_number.nil?
-        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
 
-      if @spec.nil?
-        invalid_properties.push('invalid value for "spec", spec cannot be nil.')
+      if @config.nil?
+        invalid_properties.push('invalid value for "config", config cannot be nil.')
       end
 
       invalid_properties
@@ -120,29 +112,29 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @phone_number.nil?
-      return false if @spec.nil?
+      return false if @to.nil?
+      return false if @config.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] phone_number Value to be assigned
-    def phone_number=(phone_number)
-      if phone_number.nil?
-        fail ArgumentError, 'phone_number cannot be nil'
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
       end
 
-      @phone_number = phone_number
+      @to = to
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] spec Value to be assigned
-    def spec=(spec)
-      if spec.nil?
-        fail ArgumentError, 'spec cannot be nil'
+    # @param [Object] config Value to be assigned
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'config cannot be nil'
       end
 
-      @spec = spec
+      @config = config
     end
 
     # Checks equality by comparing each attribute.
@@ -150,10 +142,9 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          phone_number == o.phone_number &&
-          spec == o.spec &&
-          variables == o.variables &&
-          agent_id == o.agent_id
+          to == o.to &&
+          config == o.config &&
+          variables == o.variables
     end
 
     # @see the `==` method
@@ -165,7 +156,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, spec, variables, agent_id].hash
+      [to, config, variables].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/voice_call_response.rb

@@ -18,15 +18,13 @@ module Pingram
     # Stable tracking id — use with GET /voice/calls/{trackingId}.
     attr_accessor :tracking_id
 
-    attr_accessor :call_control_id
-
+    # Live transcript socket. The path id is the trackingId.
     attr_accessor :websocket
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'tracking_id' => :'trackingId',
-        :'call_control_id' => :'callControlId',
         :'websocket' => :'websocket'
       }
     end
@@ -45,7 +43,6 @@ module Pingram
     def self.openapi_types
       {
         :'tracking_id' => :'String',
-        :'call_control_id' => :'String',
         :'websocket' => :'String'
       }
     end
@@ -78,12 +75,6 @@ module Pingram
         self.tracking_id = nil
       end
 
-      if attributes.key?(:'call_control_id')
-        self.call_control_id = attributes[:'call_control_id']
-      else
-        self.call_control_id = nil
-      end
-
       if attributes.key?(:'websocket')
         self.websocket = attributes[:'websocket']
       else
@@ -100,10 +91,6 @@ module Pingram
         invalid_properties.push('invalid value for "tracking_id", tracking_id cannot be nil.')
       end
 
-      if @call_control_id.nil?
-        invalid_properties.push('invalid value for "call_control_id", call_control_id cannot be nil.')
-      end
-
       if @websocket.nil?
         invalid_properties.push('invalid value for "websocket", websocket cannot be nil.')
       end
@@ -116,7 +103,6 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @tracking_id.nil?
-      return false if @call_control_id.nil?
       return false if @websocket.nil?
       true
     end
@@ -131,16 +117,6 @@ module Pingram
       @tracking_id = tracking_id
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] call_control_id Value to be assigned
-    def call_control_id=(call_control_id)
-      if call_control_id.nil?
-        fail ArgumentError, 'call_control_id cannot be nil'
-      end
-
-      @call_control_id = call_control_id
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] websocket Value to be assigned
     def websocket=(websocket)
@@ -157,7 +133,6 @@ module Pingram
       return true if self.equal?(o)
       self.class == o.class &&
           tracking_id == o.tracking_id &&
-          call_control_id == o.call_control_id &&
           websocket == o.websocket
     end
 
@@ -170,7 +145,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tracking_id, call_control_id, websocket].hash
+      [tracking_id, websocket].hash
     end
 
     # Builds the object from hash