pingram 1.0.16 → 1.0.17

data/lib/pingram/models/bind_number_response_agent.rb

@@ -0,0 +1,342 @@
+=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 record returned by GET /voice/agents.
+  class BindNumberResponseAgent < ApiModelBase
+    attr_accessor :agent_id
+
+    attr_accessor :deployment
+
+    attr_accessor :spec
+
+    attr_accessor :phone_numbers
+
+    attr_accessor :worker_presence
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    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
+      {
+        :'agent_id' => :'agentId',
+        :'deployment' => :'deployment',
+        :'spec' => :'spec',
+        :'phone_numbers' => :'phoneNumbers',
+        :'worker_presence' => :'workerPresence',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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
+      {
+        :'agent_id' => :'String',
+        :'deployment' => :'String',
+        :'spec' => :'BindNumberResponseAgentSpec',
+        :'phone_numbers' => :'Array<String>',
+        :'worker_presence' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'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::BindNumberResponseAgent` 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::BindNumberResponseAgent`. 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?(:'agent_id')
+        self.agent_id = attributes[:'agent_id']
+      else
+        self.agent_id = nil
+      end
+
+      if attributes.key?(:'deployment')
+        self.deployment = attributes[:'deployment']
+      else
+        self.deployment = nil
+      end
+
+      if attributes.key?(:'spec')
+        self.spec = attributes[:'spec']
+      else
+        self.spec = nil
+      end
+
+      if attributes.key?(:'phone_numbers')
+        if (value = attributes[:'phone_numbers']).is_a?(Array)
+          self.phone_numbers = value
+        end
+      else
+        self.phone_numbers = nil
+      end
+
+      if attributes.key?(:'worker_presence')
+        self.worker_presence = attributes[:'worker_presence']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @agent_id.nil?
+        invalid_properties.push('invalid value for "agent_id", agent_id cannot be nil.')
+      end
+
+      if @deployment.nil?
+        invalid_properties.push('invalid value for "deployment", deployment cannot be nil.')
+      end
+
+      if @spec.nil?
+        invalid_properties.push('invalid value for "spec", spec cannot be nil.')
+      end
+
+      if @phone_numbers.nil?
+        invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @agent_id.nil?
+      return false if @deployment.nil?
+      deployment_validator = EnumAttributeValidator.new('String', ["hosted", "ejected"])
+      return false unless deployment_validator.valid?(@deployment)
+      return false if @spec.nil?
+      return false if @phone_numbers.nil?
+      worker_presence_validator = EnumAttributeValidator.new('String', ["online", "offline"])
+      return false unless worker_presence_validator.valid?(@worker_presence)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] agent_id Value to be assigned
+    def agent_id=(agent_id)
+      if agent_id.nil?
+        fail ArgumentError, 'agent_id cannot be nil'
+      end
+
+      @agent_id = agent_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deployment Object to be assigned
+    def deployment=(deployment)
+      validator = EnumAttributeValidator.new('String', ["hosted", "ejected"])
+      unless validator.valid?(deployment)
+        fail ArgumentError, "invalid value for \"deployment\", must be one of #{validator.allowable_values}."
+      end
+      @deployment = deployment
+    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'
+      end
+
+      @spec = spec
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_numbers Value to be assigned
+    def phone_numbers=(phone_numbers)
+      if phone_numbers.nil?
+        fail ArgumentError, 'phone_numbers cannot be nil'
+      end
+
+      @phone_numbers = phone_numbers
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] worker_presence Object to be assigned
+    def worker_presence=(worker_presence)
+      validator = EnumAttributeValidator.new('String', ["online", "offline"])
+      unless validator.valid?(worker_presence)
+        fail ArgumentError, "invalid value for \"worker_presence\", must be one of #{validator.allowable_values}."
+      end
+      @worker_presence = worker_presence
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          agent_id == o.agent_id &&
+          deployment == o.deployment &&
+          spec == o.spec &&
+          phone_numbers == o.phone_numbers &&
+          worker_presence == o.worker_presence &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [agent_id, deployment, spec, phone_numbers, worker_presence, created_at, updated_at].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.rb

@@ -0,0 +1,376 @@
+=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 BindNumberResponseAgentSpec < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :instructions
+
+    attr_accessor :inbound
+
+    attr_accessor :outbound
+
+    attr_accessor :model
+
+    attr_accessor :tools
+
+    attr_accessor :variables
+
+    attr_accessor :conversation
+
+    attr_accessor :compliance
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'instructions' => :'instructions',
+        :'inbound' => :'inbound',
+        :'outbound' => :'outbound',
+        :'model' => :'model',
+        :'tools' => :'tools',
+        :'variables' => :'variables',
+        :'conversation' => :'conversation',
+        :'compliance' => :'compliance'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'instructions' => :'String',
+        :'inbound' => :'BindNumberResponseAgentSpecInbound',
+        :'outbound' => :'BindNumberResponseAgentSpecOutbound',
+        :'model' => :'BindNumberResponseAgentSpecModel',
+        :'tools' => :'Array<BindNumberResponseAgentSpecToolsInner>',
+        :'variables' => :'Array<BindNumberResponseAgentSpecVariablesInner>',
+        :'conversation' => :'BindNumberResponseAgentSpecConversation',
+        :'compliance' => :'BindNumberResponseAgentSpecCompliance'
+      }
+    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::BindNumberResponseAgentSpec` 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::BindNumberResponseAgentSpec`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'instructions')
+        self.instructions = attributes[:'instructions']
+      else
+        self.instructions = nil
+      end
+
+      if attributes.key?(:'inbound')
+        self.inbound = attributes[:'inbound']
+      else
+        self.inbound = nil
+      end
+
+      if attributes.key?(:'outbound')
+        self.outbound = attributes[:'outbound']
+      else
+        self.outbound = 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
+      else
+        self.tools = nil
+      end
+
+      if attributes.key?(:'variables')
+        if (value = attributes[:'variables']).is_a?(Array)
+          self.variables = value
+        end
+      else
+        self.variables = nil
+      end
+
+      if attributes.key?(:'conversation')
+        self.conversation = attributes[:'conversation']
+      else
+        self.conversation = nil
+      end
+
+      if attributes.key?(:'compliance')
+        self.compliance = attributes[:'compliance']
+      else
+        self.compliance = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @instructions.nil?
+        invalid_properties.push('invalid value for "instructions", instructions cannot be nil.')
+      end
+
+      if @inbound.nil?
+        invalid_properties.push('invalid value for "inbound", inbound cannot be nil.')
+      end
+
+      if @outbound.nil?
+        invalid_properties.push('invalid value for "outbound", outbound cannot be nil.')
+      end
+
+      if @model.nil?
+        invalid_properties.push('invalid value for "model", model cannot be nil.')
+      end
+
+      if @tools.nil?
+        invalid_properties.push('invalid value for "tools", tools cannot be nil.')
+      end
+
+      if @variables.nil?
+        invalid_properties.push('invalid value for "variables", variables cannot be nil.')
+      end
+
+      if @conversation.nil?
+        invalid_properties.push('invalid value for "conversation", conversation cannot be nil.')
+      end
+
+      if @compliance.nil?
+        invalid_properties.push('invalid value for "compliance", compliance 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 @name.nil?
+      return false if @instructions.nil?
+      return false if @inbound.nil?
+      return false if @outbound.nil?
+      return false if @model.nil?
+      return false if @tools.nil?
+      return false if @variables.nil?
+      return false if @conversation.nil?
+      return false if @compliance.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    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] inbound Value to be assigned
+    def inbound=(inbound)
+      if inbound.nil?
+        fail ArgumentError, 'inbound cannot be nil'
+      end
+
+      @inbound = inbound
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] outbound Value to be assigned
+    def outbound=(outbound)
+      if outbound.nil?
+        fail ArgumentError, 'outbound cannot be nil'
+      end
+
+      @outbound = outbound
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] tools Value to be assigned
+    def tools=(tools)
+      if tools.nil?
+        fail ArgumentError, 'tools cannot be nil'
+      end
+
+      @tools = tools
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variables Value to be assigned
+    def variables=(variables)
+      if variables.nil?
+        fail ArgumentError, 'variables cannot be nil'
+      end
+
+      @variables = variables
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] conversation Value to be assigned
+    def conversation=(conversation)
+      if conversation.nil?
+        fail ArgumentError, 'conversation cannot be nil'
+      end
+
+      @conversation = conversation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] compliance Value to be assigned
+    def compliance=(compliance)
+      if compliance.nil?
+        fail ArgumentError, 'compliance cannot be nil'
+      end
+
+      @compliance = compliance
+    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 &&
+          name == o.name &&
+          instructions == o.instructions &&
+          inbound == o.inbound &&
+          outbound == o.outbound &&
+          model == o.model &&
+          tools == o.tools &&
+          variables == o.variables &&
+          conversation == o.conversation &&
+          compliance == o.compliance
+    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
+      [name, instructions, inbound, outbound, model, tools, variables, conversation, compliance].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