pingram 1.0.38 → 1.0.40

data/lib/pingram/models/script1.rb

@@ -0,0 +1,256 @@
+=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 Script1 < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :steps
+
+    # 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 :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',
+        :'voicemail_action' => :'voicemailAction',
+        :'voicemail_message' => :'voicemailMessage',
+        :'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>',
+        :'voicemail_action' => :'String',
+        :'voicemail_message' => :'String',
+        :'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::Script1` 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::Script1`. 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?(:'voicemail_action')
+        self.voicemail_action = attributes[:'voicemail_action']
+      end
+
+      if attributes.key?(:'voicemail_message')
+        self.voicemail_message = attributes[:'voicemail_message']
+      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?
+      voicemail_action_validator = EnumAttributeValidator.new('String', ["hangup", "message", "continue"])
+      return false unless voicemail_action_validator.valid?(@voicemail_action)
+      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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] voicemail_action Object to be assigned
+    def voicemail_action=(voicemail_action)
+      validator = EnumAttributeValidator.new('String', ["hangup", "message", "continue"])
+      unless validator.valid?(voicemail_action)
+        fail ArgumentError, "invalid value for \"voicemail_action\", must be one of #{validator.allowable_values}."
+      end
+      @voicemail_action = voicemail_action
+    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 &&
+          voicemail_action == o.voicemail_action &&
+          voicemail_message == o.voicemail_message &&
+          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, voicemail_action, voicemail_message, 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

data/lib/pingram/models/{update_voice_agent_request.rb → script_privacy.rb}

@@ -14,13 +14,17 @@ require 'date'
 require 'time'
 
 module Pingram
-  class UpdateVoiceAgentRequest < ApiModelBase
-    attr_accessor :spec
+  # Omitted privacy means record and transcribe are both on.
+  class ScriptPrivacy < ApiModelBase
+    attr_accessor :record
+
+    attr_accessor :transcribe
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'spec' => :'spec'
+        :'record' => :'record',
+        :'transcribe' => :'transcribe'
       }
     end
 
@@ -37,7 +41,8 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'spec' => :'BindNumberResponseAgentSpec'
+        :'record' => :'Boolean',
+        :'transcribe' => :'Boolean'
       }
     end
 
@@ -51,22 +56,24 @@ 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::UpdateVoiceAgentRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::ScriptPrivacy` 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::UpdateVoiceAgentRequest`. 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::ScriptPrivacy`. 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?(:'spec')
-        self.spec = attributes[:'spec']
-      else
-        self.spec = nil
+      if attributes.key?(:'record')
+        self.record = attributes[:'record']
+      end
+
+      if attributes.key?(:'transcribe')
+        self.transcribe = attributes[:'transcribe']
       end
     end
 
@@ -75,10 +82,6 @@ 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.')
-      end
-
       invalid_properties
     end
 
@@ -86,26 +89,16 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @spec.nil?
       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'
-      end
-
-      @spec = spec
-    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 &&
-          spec == o.spec
+          record == o.record &&
+          transcribe == o.transcribe
     end
 
     # @see the `==` method
@@ -117,7 +110,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [spec].hash
+      [record, transcribe].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/script_steps_inner.rb

@@ -0,0 +1,215 @@
+=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
+  # One spoken line.
+  class ScriptStepsInner < ApiModelBase
+    attr_accessor :verb
+
+    attr_accessor :text
+
+    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
+      {
+        :'verb' => :'verb',
+        :'text' => :'text'
+      }
+    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
+      {
+        :'verb' => :'String',
+        :'text' => :'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::ScriptStepsInner` 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::ScriptStepsInner`. 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?(:'verb')
+        self.verb = attributes[:'verb']
+      else
+        self.verb = nil
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      else
+        self.text = 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 @verb.nil?
+        invalid_properties.push('invalid value for "verb", verb cannot be nil.')
+      end
+
+      if @text.nil?
+        invalid_properties.push('invalid value for "text", text 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 @verb.nil?
+      verb_validator = EnumAttributeValidator.new('String', ["Say"])
+      return false unless verb_validator.valid?(@verb)
+      return false if @text.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verb Object to be assigned
+    def verb=(verb)
+      validator = EnumAttributeValidator.new('String', ["Say"])
+      unless validator.valid?(verb)
+        fail ArgumentError, "invalid value for \"verb\", must be one of #{validator.allowable_values}."
+      end
+      @verb = verb
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text Value to be assigned
+    def text=(text)
+      if text.nil?
+        fail ArgumentError, 'text cannot be nil'
+      end
+
+      @text = text
+    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 &&
+          verb == o.verb &&
+          text == o.text
+    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
+      [verb, text].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/{create_voice_agent_request.rb → sign_out_request.rb}

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module Pingram
-  class CreateVoiceAgentRequest < ApiModelBase
-    attr_accessor :spec
+  # This browser's Cognito refresh token, revoked on dashboard sign-out.
+  class SignOutRequest < ApiModelBase
+    attr_accessor :refresh_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'spec' => :'spec'
+        :'refresh_token' => :'refreshToken'
       }
     end
 
@@ -37,7 +38,7 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'spec' => :'BindNumberResponseAgentSpec'
+        :'refresh_token' => :'String'
       }
     end
 
@@ -51,22 +52,22 @@ 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::CreateVoiceAgentRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SignOutRequest` 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::CreateVoiceAgentRequest`. 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::SignOutRequest`. 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?(:'spec')
-        self.spec = attributes[:'spec']
+      if attributes.key?(:'refresh_token')
+        self.refresh_token = attributes[:'refresh_token']
       else
-        self.spec = nil
+        self.refresh_token = nil
       end
     end
 
@@ -75,8 +76,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 @refresh_token.nil?
+        invalid_properties.push('invalid value for "refresh_token", refresh_token cannot be nil.')
       end
 
       invalid_properties
@@ -86,18 +87,18 @@ 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 @refresh_token.nil?
       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] refresh_token Value to be assigned
+    def refresh_token=(refresh_token)
+      if refresh_token.nil?
+        fail ArgumentError, 'refresh_token cannot be nil'
       end
 
-      @spec = spec
+      @refresh_token = refresh_token
     end
 
     # Checks equality by comparing each attribute.
@@ -105,7 +106,7 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          spec == o.spec
+          refresh_token == o.refresh_token
     end
 
     # @see the `==` method
@@ -117,7 +118,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [spec].hash
+      [refresh_token].hash
     end
 
     # Builds the object from hash