pingram 0.1.3 → 0.1.5

data/lib/pingram/models/notification_patch_request_deduplication.rb

@@ -0,0 +1,164 @@
+=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 NotificationPatchRequestDeduplication < ApiModelBase
+    attr_accessor :duration
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'duration' => :'duration'
+      }
+    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
+      {
+        :'duration' => :'Float'
+      }
+    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::NotificationPatchRequestDeduplication` 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::NotificationPatchRequestDeduplication`. 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?(:'duration')
+        self.duration = attributes[:'duration']
+      else
+        self.duration = 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 @duration.nil?
+        invalid_properties.push('invalid value for "duration", duration 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 @duration.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] duration Value to be assigned
+    def duration=(duration)
+      if duration.nil?
+        fail ArgumentError, 'duration cannot be nil'
+      end
+
+      @duration = duration
+    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 &&
+          duration == o.duration
+    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
+      [duration].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/notification_patch_request_throttling.rb

@@ -0,0 +1,294 @@
+=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 NotificationPatchRequestThrottling < ApiModelBase
+    attr_accessor :max
+
+    attr_accessor :period
+
+    attr_accessor :unit
+
+    attr_accessor :forever
+
+    attr_accessor :scope
+
+    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
+      {
+        :'max' => :'max',
+        :'period' => :'period',
+        :'unit' => :'unit',
+        :'forever' => :'forever',
+        :'scope' => :'scope'
+      }
+    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
+      {
+        :'max' => :'Float',
+        :'period' => :'Float',
+        :'unit' => :'String',
+        :'forever' => :'Boolean',
+        :'scope' => :'Array<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::NotificationPatchRequestThrottling` 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::NotificationPatchRequestThrottling`. 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?(:'max')
+        self.max = attributes[:'max']
+      else
+        self.max = nil
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      else
+        self.unit = nil
+      end
+
+      if attributes.key?(:'forever')
+        self.forever = attributes[:'forever']
+      else
+        self.forever = nil
+      end
+
+      if attributes.key?(:'scope')
+        if (value = attributes[:'scope']).is_a?(Array)
+          self.scope = value
+        end
+      else
+        self.scope = 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 @max.nil?
+        invalid_properties.push('invalid value for "max", max cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      end
+
+      if @unit.nil?
+        invalid_properties.push('invalid value for "unit", unit cannot be nil.')
+      end
+
+      if @forever.nil?
+        invalid_properties.push('invalid value for "forever", forever cannot be nil.')
+      end
+
+      if @scope.nil?
+        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      end
+
+      if @scope.length > 2
+        invalid_properties.push('invalid value for "scope", number of items must be less than or equal to 2.')
+      end
+
+      if @scope.length < 2
+        invalid_properties.push('invalid value for "scope", number of items must be greater than or equal to 2.')
+      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 @max.nil?
+      return false if @period.nil?
+      return false if @unit.nil?
+      unit_validator = EnumAttributeValidator.new('String', ["seconds", "minutes", "hours", "days", "months", "years"])
+      return false unless unit_validator.valid?(@unit)
+      return false if @forever.nil?
+      return false if @scope.nil?
+      return false if @scope.length > 2
+      return false if @scope.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max Value to be assigned
+    def max=(max)
+      if max.nil?
+        fail ArgumentError, 'max cannot be nil'
+      end
+
+      @max = max
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] period Value to be assigned
+    def period=(period)
+      if period.nil?
+        fail ArgumentError, 'period cannot be nil'
+      end
+
+      @period = period
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] unit Object to be assigned
+    def unit=(unit)
+      validator = EnumAttributeValidator.new('String', ["seconds", "minutes", "hours", "days", "months", "years"])
+      unless validator.valid?(unit)
+        fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}."
+      end
+      @unit = unit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] forever Value to be assigned
+    def forever=(forever)
+      if forever.nil?
+        fail ArgumentError, 'forever cannot be nil'
+      end
+
+      @forever = forever
+    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 &&
+          max == o.max &&
+          period == o.period &&
+          unit == o.unit &&
+          forever == o.forever &&
+          scope == o.scope
+    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
+      [max, period, unit, forever, scope].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/post_email_test_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/post_email_test_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/post_senders_request_body.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/post_user_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -15,16 +15,22 @@ require 'time'
 
 module Pingram
   class PostUserRequest < ApiModelBase
+    # Unique user identifier. Required.
     attr_accessor :id
 
+    # User's email address for email notifications.
     attr_accessor :email
 
+    # User's phone number for SMS/call notifications.
     attr_accessor :number
 
+    # Mobile push tokens (FCM, APN) for push notifications.
     attr_accessor :push_tokens
 
+    # Web push subscription config from the browser.
     attr_accessor :web_push_tokens
 
+    # User's timezone (e.g. \"America/New_York\") for scheduling.
     attr_accessor :timezone
 
     # The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. \"test\" - Channel name with # prefix, e.g. \"#test\" - Channel ID, e.g. \"C1234567890\" - User ID for DM, e.g. \"U1234567890\" - Username with @ prefix, e.g. \"@test\"

data/lib/pingram/models/sender_post_body.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -23,18 +23,24 @@ module Pingram
 
     attr_accessor :replace
 
+    # ID of the notification type (e.g. \"welcome_email\"). Creates a new notification if it does not exist.
     attr_accessor :type
 
     attr_accessor :to
 
+    # Override which channels to send to (e.g. [\"EMAIL\", \"SMS\"]). Bypasses notification channel config.
     attr_accessor :force_channels
 
+    # Key-value pairs for template merge tags. Replaces placeholders like {{firstName}} in templates.
     attr_accessor :parameters
 
+    # Optional sub-notification identifier for grouping or tracking.
     attr_accessor :secondary_id
 
+    # Specific template ID to use. If omitted, uses the default template for each channel.
     attr_accessor :template_id
 
+    # Sub-notification identifier (e.g. for grouping related notifications).
     attr_accessor :sub_notification_id
 
     attr_accessor :options
@@ -110,7 +116,7 @@ module Pingram
         :'email' => :'SenderPostBodyEmail',
         :'inapp' => :'SenderPostBodyInapp',
         :'sms' => :'SenderPostBodySms',
-        :'call' => :'SenderPostBodySmsAutoReply',
+        :'call' => :'SenderPostBodyCall',
         :'web_push' => :'SenderPostBodyWebPush',
         :'mobile_push' => :'SenderPostBodyMobilePush',
         :'slack' => :'SenderPostBodySlack'