pingram 1.0.39 → 1.0.40

data/lib/pingram/models/transfer.rb

@@ -14,14 +14,13 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Transfer the caller to a phone number.
   class Transfer < ApiModelBase
+    # Transfer the live call to one of destinations.
     attr_accessor :type
 
-    attr_accessor :transfer_mode
-
-    attr_accessor :destination
-
-    attr_accessor :briefing
+    # Numbers the agent can transfer to. Set a condition on each when there is more than one.
+    attr_accessor :destinations
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -49,9 +48,7 @@ module Pingram
     def self.attribute_map
       {
         :'type' => :'type',
-        :'transfer_mode' => :'transferMode',
-        :'destination' => :'destination',
-        :'briefing' => :'briefing'
+        :'destinations' => :'destinations'
       }
     end
 
@@ -69,9 +66,7 @@ module Pingram
     def self.openapi_types
       {
         :'type' => :'String',
-        :'transfer_mode' => :'String',
-        :'destination' => :'String',
-        :'briefing' => :'String'
+        :'destinations' => :'Array<TransferDestinationsInner>'
       }
     end
 
@@ -103,20 +98,12 @@ module Pingram
         self.type = nil
       end
 
-      if attributes.key?(:'transfer_mode')
-        self.transfer_mode = attributes[:'transfer_mode']
-      else
-        self.transfer_mode = nil
-      end
-
-      if attributes.key?(:'destination')
-        self.destination = attributes[:'destination']
+      if attributes.key?(:'destinations')
+        if (value = attributes[:'destinations']).is_a?(Array)
+          self.destinations = value
+        end
       else
-        self.destination = nil
-      end
-
-      if attributes.key?(:'briefing')
-        self.briefing = attributes[:'briefing']
+        self.destinations = nil
       end
     end
 
@@ -129,12 +116,8 @@ module Pingram
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @transfer_mode.nil?
-        invalid_properties.push('invalid value for "transfer_mode", transfer_mode cannot be nil.')
-      end
-
-      if @destination.nil?
-        invalid_properties.push('invalid value for "destination", destination cannot be nil.')
+      if @destinations.nil?
+        invalid_properties.push('invalid value for "destinations", destinations cannot be nil.')
       end
 
       invalid_properties
@@ -147,10 +130,7 @@ module Pingram
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["transfer"])
       return false unless type_validator.valid?(@type)
-      return false if @transfer_mode.nil?
-      transfer_mode_validator = EnumAttributeValidator.new('String', ["warm", "cold"])
-      return false unless transfer_mode_validator.valid?(@transfer_mode)
-      return false if @destination.nil?
+      return false if @destinations.nil?
       true
     end
 
@@ -164,24 +144,14 @@ module Pingram
       @type = type
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] transfer_mode Object to be assigned
-    def transfer_mode=(transfer_mode)
-      validator = EnumAttributeValidator.new('String', ["warm", "cold"])
-      unless validator.valid?(transfer_mode)
-        fail ArgumentError, "invalid value for \"transfer_mode\", must be one of #{validator.allowable_values}."
-      end
-      @transfer_mode = transfer_mode
-    end
-
     # Custom attribute writer method with validation
-    # @param [Object] destination Value to be assigned
-    def destination=(destination)
-      if destination.nil?
-        fail ArgumentError, 'destination cannot be nil'
+    # @param [Object] destinations Value to be assigned
+    def destinations=(destinations)
+      if destinations.nil?
+        fail ArgumentError, 'destinations cannot be nil'
       end
 
-      @destination = destination
+      @destinations = destinations
     end
 
     # Checks equality by comparing each attribute.
@@ -190,9 +160,7 @@ module Pingram
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          transfer_mode == o.transfer_mode &&
-          destination == o.destination &&
-          briefing == o.briefing
+          destinations == o.destinations
     end
 
     # @see the `==` method
@@ -204,7 +172,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, transfer_mode, destination, briefing].hash
+      [type, destinations].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/transfer1.rb

@@ -0,0 +1,223 @@
+=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 Transfer1 < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :to
+
+    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',
+        :'to' => :'to',
+        :'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',
+        :'to' => :'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::Transfer1` 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::Transfer1`. 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?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = 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 @to.nil?
+        invalid_properties.push('invalid value for "to", to 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', ["transfer"])
+      return false unless type_validator.valid?(@type)
+      return false if @to.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', ["transfer"])
+      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] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    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 &&
+          to == o.to &&
+          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, to, 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/transfer_destinations_inner.rb

@@ -0,0 +1,253 @@
+=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 TransferDestinationsInner < ApiModelBase
+    # E.164 number to transfer the caller to.
+    attr_accessor :phone_number
+
+    # When the model should choose this number. Required when more than one destination is set.
+    attr_accessor :condition
+
+    # warm briefs the recipient before connecting. cold connects the caller immediately.
+    attr_accessor :transfer_mode
+
+    # Spoken to the rep before a warm transfer connects.
+    attr_accessor :briefing
+
+    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
+      {
+        :'phone_number' => :'phoneNumber',
+        :'condition' => :'condition',
+        :'transfer_mode' => :'transferMode',
+        :'briefing' => :'briefing'
+      }
+    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
+      {
+        :'phone_number' => :'String',
+        :'condition' => :'String',
+        :'transfer_mode' => :'String',
+        :'briefing' => :'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::TransferDestinationsInner` 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::TransferDestinationsInner`. 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?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      else
+        self.phone_number = nil
+      end
+
+      if attributes.key?(:'condition')
+        self.condition = attributes[:'condition']
+      else
+        self.condition = nil
+      end
+
+      if attributes.key?(:'transfer_mode')
+        self.transfer_mode = attributes[:'transfer_mode']
+      else
+        self.transfer_mode = nil
+      end
+
+      if attributes.key?(:'briefing')
+        self.briefing = attributes[:'briefing']
+      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 @phone_number.nil?
+        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+      end
+
+      if @condition.nil?
+        invalid_properties.push('invalid value for "condition", condition cannot be nil.')
+      end
+
+      if @transfer_mode.nil?
+        invalid_properties.push('invalid value for "transfer_mode", transfer_mode 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 @phone_number.nil?
+      return false if @condition.nil?
+      return false if @transfer_mode.nil?
+      transfer_mode_validator = EnumAttributeValidator.new('String', ["warm", "cold"])
+      return false unless transfer_mode_validator.valid?(@transfer_mode)
+      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'
+      end
+
+      @phone_number = phone_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] condition Value to be assigned
+    def condition=(condition)
+      if condition.nil?
+        fail ArgumentError, 'condition cannot be nil'
+      end
+
+      @condition = condition
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transfer_mode Object to be assigned
+    def transfer_mode=(transfer_mode)
+      validator = EnumAttributeValidator.new('String', ["warm", "cold"])
+      unless validator.valid?(transfer_mode)
+        fail ArgumentError, "invalid value for \"transfer_mode\", must be one of #{validator.allowable_values}."
+      end
+      @transfer_mode = transfer_mode
+    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 &&
+          phone_number == o.phone_number &&
+          condition == o.condition &&
+          transfer_mode == o.transfer_mode &&
+          briefing == o.briefing
+    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
+      [phone_number, condition, transfer_mode, briefing].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_broadcast_request.rb

@@ -25,6 +25,7 @@ module Pingram
 
     attr_accessor :from_name
 
+    # From address. Use an address on a domain verified for this account to email other people. The shared address `noreply@pingram.io` can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience.
     attr_accessor :from_address
 
     # Omit to leave unchanged. Empty string clears Reply-To.
@@ -34,7 +35,7 @@ module Pingram
 
     attr_accessor :html
 
-    # Optional visual-editor source. Can be updated only when the broadcast was created with it; cannot be added to an html-only broadcast. Pair with html.
+    # Visual-editor source. Send with html to add it to an html-only draft or to update it. Cannot be removed.
     attr_accessor :internal_template
 
     class EnumAttributeValidator