pingram 1.0.39 → 1.0.40

data/lib/pingram/models/{bind_number_response_agent_spec_inbound.rb → agent.rb}

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module Pingram
-  class BindNumberResponseAgentSpecInbound < ApiModelBase
-    attr_accessor :first_action
+  class Agent < ApiModelBase
+    attr_accessor :type
 
     attr_accessor :greeting
 
+    attr_accessor :agent
+
+    attr_accessor :privacy
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -44,8 +48,10 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'first_action' => :'firstAction',
-        :'greeting' => :'greeting'
+        :'type' => :'type',
+        :'greeting' => :'greeting',
+        :'agent' => :'agent',
+        :'privacy' => :'privacy'
       }
     end
 
@@ -62,8 +68,10 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'first_action' => :'String',
-        :'greeting' => :'String'
+        :'type' => :'String',
+        :'greeting' => :'String',
+        :'agent' => :'AgentAgent',
+        :'privacy' => :'ScriptPrivacy'
       }
     end
 
@@ -77,28 +85,36 @@ 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::BindNumberResponseAgentSpecInbound` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::Agent` 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
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::Agent`. 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']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       else
-        self.first_action = nil
+        self.type = nil
       end
 
       if attributes.key?(:'greeting')
         self.greeting = attributes[:'greeting']
+      end
+
+      if attributes.key?(:'agent')
+        self.agent = attributes[:'agent']
       else
-        self.greeting = nil
+        self.agent = nil
+      end
+
+      if attributes.key?(:'privacy')
+        self.privacy = attributes[:'privacy']
       end
     end
 
@@ -107,12 +123,12 @@ module Pingram
     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.')
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @greeting.nil?
-        invalid_properties.push('invalid value for "greeting", greeting cannot be nil.')
+      if @agent.nil?
+        invalid_properties.push('invalid value for "agent", agent cannot be nil.')
       end
 
       invalid_properties
@@ -122,31 +138,31 @@ module Pingram
     # @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?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["agent"])
+      return false unless type_validator.valid?(@type)
+      return false if @agent.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}."
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["agent"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
-      @first_action = first_action
+      @type = type
     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'
+    # @param [Object] agent Value to be assigned
+    def agent=(agent)
+      if agent.nil?
+        fail ArgumentError, 'agent cannot be nil'
       end
 
-      @greeting = greeting
+      @agent = agent
     end
 
     # Checks equality by comparing each attribute.
@@ -154,8 +170,10 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          first_action == o.first_action &&
-          greeting == o.greeting
+          type == o.type &&
+          greeting == o.greeting &&
+          agent == o.agent &&
+          privacy == o.privacy
     end
 
     # @see the `==` method
@@ -167,7 +185,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_action, greeting].hash
+      [type, greeting, agent, privacy].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/{bind_number_response_agent_spec_outbound.rb → agent1.rb}

@@ -14,15 +14,20 @@ require 'date'
 require 'time'
 
 module Pingram
-  class BindNumberResponseAgentSpecOutbound < ApiModelBase
-    attr_accessor :first_action
+  class Agent1 < ApiModelBase
+    attr_accessor :type
 
     attr_accessor :opener
 
+    # What to do when an answering machine picks up. hangup ends the call, message plays voicemailMessage, continue keeps talking. Default: continue.
     attr_accessor :voicemail_action
 
     attr_accessor :voicemail_message
 
+    attr_accessor :agent
+
+    attr_accessor :privacy
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,10 +53,12 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'first_action' => :'firstAction',
+        :'type' => :'type',
         :'opener' => :'opener',
         :'voicemail_action' => :'voicemailAction',
-        :'voicemail_message' => :'voicemailMessage'
+        :'voicemail_message' => :'voicemailMessage',
+        :'agent' => :'agent',
+        :'privacy' => :'privacy'
       }
     end
 
@@ -68,10 +75,12 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'first_action' => :'String',
+        :'type' => :'String',
         :'opener' => :'String',
         :'voicemail_action' => :'String',
-        :'voicemail_message' => :'String'
+        :'voicemail_message' => :'String',
+        :'agent' => :'AgentAgent',
+        :'privacy' => :'ScriptPrivacy'
       }
     end
 
@@ -85,39 +94,45 @@ 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::BindNumberResponseAgentSpecOutbound` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::Agent1` 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::BindNumberResponseAgentSpecOutbound`. 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::Agent1`. 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']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       else
-        self.first_action = nil
+        self.type = nil
       end
 
       if attributes.key?(:'opener')
         self.opener = attributes[:'opener']
-      else
-        self.opener = nil
       end
 
       if attributes.key?(:'voicemail_action')
         self.voicemail_action = attributes[:'voicemail_action']
-      else
-        self.voicemail_action = nil
       end
 
       if attributes.key?(:'voicemail_message')
         self.voicemail_message = attributes[:'voicemail_message']
       end
+
+      if attributes.key?(:'agent')
+        self.agent = attributes[:'agent']
+      else
+        self.agent = nil
+      end
+
+      if attributes.key?(:'privacy')
+        self.privacy = attributes[:'privacy']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -125,16 +140,12 @@ module Pingram
     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 @opener.nil?
-        invalid_properties.push('invalid value for "opener", opener cannot be nil.')
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @voicemail_action.nil?
-        invalid_properties.push('invalid value for "voicemail_action", voicemail_action cannot be nil.')
+      if @agent.nil?
+        invalid_properties.push('invalid value for "agent", agent cannot be nil.')
       end
 
       invalid_properties
@@ -144,34 +155,23 @@ module Pingram
     # @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 @opener.nil?
-      return false if @voicemail_action.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["agent"])
+      return false unless type_validator.valid?(@type)
       voicemail_action_validator = EnumAttributeValidator.new('String', ["hangup", "message", "continue"])
       return false unless voicemail_action_validator.valid?(@voicemail_action)
+      return false if @agent.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}."
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["agent"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
-      @first_action = first_action
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] opener Value to be assigned
-    def opener=(opener)
-      if opener.nil?
-        fail ArgumentError, 'opener cannot be nil'
-      end
-
-      @opener = opener
+      @type = type
     end
 
     # Custom attribute writer method checking allowed values (enum).
@@ -184,15 +184,27 @@ module Pingram
       @voicemail_action = voicemail_action
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] agent Value to be assigned
+    def agent=(agent)
+      if agent.nil?
+        fail ArgumentError, 'agent cannot be nil'
+      end
+
+      @agent = agent
+    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 &&
+          type == o.type &&
           opener == o.opener &&
           voicemail_action == o.voicemail_action &&
-          voicemail_message == o.voicemail_message
+          voicemail_message == o.voicemail_message &&
+          agent == o.agent &&
+          privacy == o.privacy
     end
 
     # @see the `==` method
@@ -204,7 +216,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_action, opener, voicemail_action, voicemail_message].hash
+      [type, opener, voicemail_action, voicemail_message, agent, privacy].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/agent_agent.rb

@@ -0,0 +1,222 @@
+=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-to-speech block shared by inbound and outbound agent calls.
+  class AgentAgent < ApiModelBase
+    attr_accessor :instructions
+
+    attr_accessor :model
+
+    attr_accessor :tools
+
+    attr_accessor :variables
+
+    attr_accessor :conversation
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'instructions' => :'instructions',
+        :'model' => :'model',
+        :'tools' => :'tools',
+        :'variables' => :'variables',
+        :'conversation' => :'conversation'
+      }
+    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
+      {
+        :'instructions' => :'String',
+        :'model' => :'AgentAgentModel',
+        :'tools' => :'Array<AgentAgentToolsInner>',
+        :'variables' => :'Array<AgentAgentVariablesInner>',
+        :'conversation' => :'AgentAgentConversation'
+      }
+    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::AgentAgent` 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::AgentAgent`. 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?(:'instructions')
+        self.instructions = attributes[:'instructions']
+      else
+        self.instructions = nil
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      else
+        self.model = nil
+      end
+
+      if attributes.key?(:'tools')
+        if (value = attributes[:'tools']).is_a?(Array)
+          self.tools = value
+        end
+      end
+
+      if attributes.key?(:'variables')
+        if (value = attributes[:'variables']).is_a?(Array)
+          self.variables = value
+        end
+      end
+
+      if attributes.key?(:'conversation')
+        self.conversation = attributes[:'conversation']
+      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 @instructions.nil?
+        invalid_properties.push('invalid value for "instructions", instructions cannot be nil.')
+      end
+
+      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 @instructions.nil?
+      return false if @model.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] instructions Value to be assigned
+    def instructions=(instructions)
+      if instructions.nil?
+        fail ArgumentError, 'instructions cannot be nil'
+      end
+
+      @instructions = instructions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] model Value to be assigned
+    def model=(model)
+      if model.nil?
+        fail ArgumentError, 'model cannot be nil'
+      end
+
+      @model = model
+    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 &&
+          instructions == o.instructions &&
+          model == o.model &&
+          tools == o.tools &&
+          variables == o.variables &&
+          conversation == o.conversation
+    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
+      [instructions, model, tools, variables, conversation].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