zyphr 0.1.4 → 0.1.8

data/lib/zyphr/models/send_push_request.rb

@@ -15,64 +15,83 @@ require 'time'
 
 module Zyphr
   class SendPushRequest
-    # Send to specific device
+    # Send to all devices for a user
+    attr_accessor :user_id
+
+    # Send to a specific device
     attr_accessor :device_id
 
-    # Send to multiple devices
-    attr_accessor :device_ids
+    # Push notification title
+    attr_accessor :title
 
-    # Send to all subscriber devices
-    attr_accessor :subscriber_id
+    # Push notification body text
+    attr_accessor :body
+
+    # Custom data payload
+    attr_accessor :data
+
+    # Badge count (iOS)
+    attr_accessor :badge
 
-    # Send to topic subscribers
-    attr_accessor :topic
+    # Notification sound
+    attr_accessor :sound
 
-    attr_accessor :payload
+    # Image URL for rich notifications
+    attr_accessor :image_url
 
-    attr_accessor :priority
+    # Silent/background push notification
+    attr_accessor :content_available
 
-    # Time-to-live in seconds
-    attr_accessor :ttl
+    # Interactive notification buttons (max 3)
+    attr_accessor :action_buttons
+
+    attr_accessor :tags
+
+    attr_accessor :metadata
 
     # Replace previous notification with same key
     attr_accessor :collapse_key
 
-    attr_accessor :scheduled_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
+    # Subscriber ID for preference checking
+    attr_accessor :subscriber_id
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    # Subscriber external ID for preference checking
+    attr_accessor :subscriber_external_id
+
+    # Notification category for preference checking
+    attr_accessor :category
+
+    # Skip subscriber preference checks
+    attr_accessor :force
+
+    # Schedule for future delivery (ISO 8601)
+    attr_accessor :send_at
+
+    # Delay in seconds before sending
+    attr_accessor :delay
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'user_id' => :'user_id',
         :'device_id' => :'device_id',
-        :'device_ids' => :'device_ids',
-        :'subscriber_id' => :'subscriber_id',
-        :'topic' => :'topic',
-        :'payload' => :'payload',
-        :'priority' => :'priority',
-        :'ttl' => :'ttl',
+        :'title' => :'title',
+        :'body' => :'body',
+        :'data' => :'data',
+        :'badge' => :'badge',
+        :'sound' => :'sound',
+        :'image_url' => :'image_url',
+        :'content_available' => :'content_available',
+        :'action_buttons' => :'action_buttons',
+        :'tags' => :'tags',
+        :'metadata' => :'metadata',
         :'collapse_key' => :'collapse_key',
-        :'scheduled_at' => :'scheduled_at'
+        :'subscriber_id' => :'subscriber_id',
+        :'subscriber_external_id' => :'subscriber_external_id',
+        :'category' => :'category',
+        :'force' => :'force',
+        :'send_at' => :'send_at',
+        :'delay' => :'delay'
       }
     end
 
@@ -89,15 +108,25 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'user_id' => :'String',
         :'device_id' => :'String',
-        :'device_ids' => :'Array<String>',
-        :'subscriber_id' => :'String',
-        :'topic' => :'String',
-        :'payload' => :'PushPayload',
-        :'priority' => :'String',
-        :'ttl' => :'Integer',
+        :'title' => :'String',
+        :'body' => :'String',
+        :'data' => :'Hash<String, Object>',
+        :'badge' => :'Integer',
+        :'sound' => :'String',
+        :'image_url' => :'String',
+        :'content_available' => :'Boolean',
+        :'action_buttons' => :'Array<SendPushRequestActionButtonsInner>',
+        :'tags' => :'Array<String>',
+        :'metadata' => :'Hash<String, Object>',
         :'collapse_key' => :'String',
-        :'scheduled_at' => :'Time'
+        :'subscriber_id' => :'String',
+        :'subscriber_external_id' => :'String',
+        :'category' => :'String',
+        :'force' => :'Boolean',
+        :'send_at' => :'Time',
+        :'delay' => :'Integer'
       }
     end
 
@@ -123,46 +152,88 @@ module Zyphr
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
       if attributes.key?(:'device_id')
         self.device_id = attributes[:'device_id']
       end
 
-      if attributes.key?(:'device_ids')
-        if (value = attributes[:'device_ids']).is_a?(Array)
-          self.device_ids = value
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Hash)
+          self.data = value
         end
       end
 
-      if attributes.key?(:'subscriber_id')
-        self.subscriber_id = attributes[:'subscriber_id']
+      if attributes.key?(:'badge')
+        self.badge = attributes[:'badge']
       end
 
-      if attributes.key?(:'topic')
-        self.topic = attributes[:'topic']
+      if attributes.key?(:'sound')
+        self.sound = attributes[:'sound']
       end
 
-      if attributes.key?(:'payload')
-        self.payload = attributes[:'payload']
-      else
-        self.payload = nil
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
       end
 
-      if attributes.key?(:'priority')
-        self.priority = attributes[:'priority']
-      else
-        self.priority = 'normal'
+      if attributes.key?(:'content_available')
+        self.content_available = attributes[:'content_available']
       end
 
-      if attributes.key?(:'ttl')
-        self.ttl = attributes[:'ttl']
+      if attributes.key?(:'action_buttons')
+        if (value = attributes[:'action_buttons']).is_a?(Array)
+          self.action_buttons = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
       if attributes.key?(:'collapse_key')
         self.collapse_key = attributes[:'collapse_key']
       end
 
-      if attributes.key?(:'scheduled_at')
-        self.scheduled_at = attributes[:'scheduled_at']
+      if attributes.key?(:'subscriber_id')
+        self.subscriber_id = attributes[:'subscriber_id']
+      end
+
+      if attributes.key?(:'subscriber_external_id')
+        self.subscriber_external_id = attributes[:'subscriber_external_id']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'force')
+        self.force = attributes[:'force']
+      end
+
+      if attributes.key?(:'send_at')
+        self.send_at = attributes[:'send_at']
+      end
+
+      if attributes.key?(:'delay')
+        self.delay = attributes[:'delay']
       end
     end
 
@@ -171,8 +242,32 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @payload.nil?
-        invalid_properties.push('invalid value for "payload", payload cannot be nil.')
+      if !@title.nil? && @title.to_s.length > 255
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@body.nil? && @body.to_s.length > 4096
+        invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 4096.')
+      end
+
+      if !@badge.nil? && @badge < 0
+        invalid_properties.push('invalid value for "badge", must be greater than or equal to 0.')
+      end
+
+      if !@sound.nil? && @sound.to_s.length > 255
+        invalid_properties.push('invalid value for "sound", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@action_buttons.nil? && @action_buttons.length > 3
+        invalid_properties.push('invalid value for "action_buttons", number of items must be less than or equal to 3.')
+      end
+
+      if !@tags.nil? && @tags.length > 10
+        invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 10.')
+      end
+
+      if !@delay.nil? && @delay < 0
+        invalid_properties.push('invalid value for "delay", must be greater than or equal to 0.')
       end
 
       invalid_properties
@@ -182,30 +277,112 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @payload.nil?
-      priority_validator = EnumAttributeValidator.new('String', ["low", "normal", "high", "urgent"])
-      return false unless priority_validator.valid?(@priority)
+      return false if !@title.nil? && @title.to_s.length > 255
+      return false if !@body.nil? && @body.to_s.length > 4096
+      return false if !@badge.nil? && @badge < 0
+      return false if !@sound.nil? && @sound.to_s.length > 255
+      return false if !@action_buttons.nil? && @action_buttons.length > 3
+      return false if !@tags.nil? && @tags.length > 10
+      return false if !@delay.nil? && @delay < 0
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] payload Value to be assigned
-    def payload=(payload)
-      if payload.nil?
-        fail ArgumentError, 'payload cannot be nil'
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 255
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] body Value to be assigned
+    def body=(body)
+      if body.nil?
+        fail ArgumentError, 'body cannot be nil'
+      end
+
+      if body.to_s.length > 4096
+        fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 4096.'
+      end
+
+      @body = body
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] badge Value to be assigned
+    def badge=(badge)
+      if badge.nil?
+        fail ArgumentError, 'badge cannot be nil'
+      end
+
+      if badge < 0
+        fail ArgumentError, 'invalid value for "badge", must be greater than or equal to 0.'
+      end
+
+      @badge = badge
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sound Value to be assigned
+    def sound=(sound)
+      if sound.nil?
+        fail ArgumentError, 'sound cannot be nil'
+      end
+
+      if sound.to_s.length > 255
+        fail ArgumentError, 'invalid value for "sound", the character length must be smaller than or equal to 255.'
+      end
+
+      @sound = sound
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] action_buttons Value to be assigned
+    def action_buttons=(action_buttons)
+      if action_buttons.nil?
+        fail ArgumentError, 'action_buttons cannot be nil'
+      end
+
+      if action_buttons.length > 3
+        fail ArgumentError, 'invalid value for "action_buttons", number of items must be less than or equal to 3.'
+      end
+
+      @action_buttons = action_buttons
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tags Value to be assigned
+    def tags=(tags)
+      if tags.nil?
+        fail ArgumentError, 'tags cannot be nil'
+      end
+
+      if tags.length > 10
+        fail ArgumentError, 'invalid value for "tags", number of items must be less than or equal to 10.'
       end
 
-      @payload = payload
+      @tags = tags
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] priority Object to be assigned
-    def priority=(priority)
-      validator = EnumAttributeValidator.new('String', ["low", "normal", "high", "urgent"])
-      unless validator.valid?(priority)
-        fail ArgumentError, "invalid value for \"priority\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] delay Value to be assigned
+    def delay=(delay)
+      if delay.nil?
+        fail ArgumentError, 'delay cannot be nil'
+      end
+
+      if delay < 0
+        fail ArgumentError, 'invalid value for "delay", must be greater than or equal to 0.'
       end
-      @priority = priority
+
+      @delay = delay
     end
 
     # Checks equality by comparing each attribute.
@@ -213,15 +390,25 @@ module Zyphr
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          user_id == o.user_id &&
           device_id == o.device_id &&
-          device_ids == o.device_ids &&
-          subscriber_id == o.subscriber_id &&
-          topic == o.topic &&
-          payload == o.payload &&
-          priority == o.priority &&
-          ttl == o.ttl &&
+          title == o.title &&
+          body == o.body &&
+          data == o.data &&
+          badge == o.badge &&
+          sound == o.sound &&
+          image_url == o.image_url &&
+          content_available == o.content_available &&
+          action_buttons == o.action_buttons &&
+          tags == o.tags &&
+          metadata == o.metadata &&
           collapse_key == o.collapse_key &&
-          scheduled_at == o.scheduled_at
+          subscriber_id == o.subscriber_id &&
+          subscriber_external_id == o.subscriber_external_id &&
+          category == o.category &&
+          force == o.force &&
+          send_at == o.send_at &&
+          delay == o.delay
     end
 
     # @see the `==` method
@@ -233,7 +420,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [device_id, device_ids, subscriber_id, topic, payload, priority, ttl, collapse_key, scheduled_at].hash
+      [user_id, device_id, title, body, data, badge, sound, image_url, content_available, action_buttons, tags, metadata, collapse_key, subscriber_id, subscriber_external_id, category, force, send_at, delay].hash
     end
 
     # Builds the object from hash