activitysmith 1.12.0 → 1.14.0

data/generated/activitysmith_openapi/models/push_notification_replace_response.rb

@@ -0,0 +1,298 @@
+=begin
+#ActivitySmith API
+
+#Send push notifications and Live Activities to your own devices via a single API key.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenapiClient
+  # Apple APNs acceptance result for the replacement. Acceptance does not confirm device delivery or presentation.
+  class PushNotificationReplaceResponse
+    # True when APNs accepts the replacement for at least one device.
+    attr_accessor :success
+
+    # ID of the replaced Push Notification. It stays the same, so you can replace it again.
+    attr_accessor :notification_id
+
+    # Number of device tokens for which APNs accepted the notification, without confirming on-device delivery.
+    attr_accessor :devices_notified
+
+    attr_accessor :users_notified
+
+    attr_accessor :effective_channel_slugs
+
+    # Optional tags to organize and filter notification history.
+    attr_accessor :tags
+
+    attr_accessor :timestamp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success' => :'success',
+        :'notification_id' => :'notification_id',
+        :'devices_notified' => :'devices_notified',
+        :'users_notified' => :'users_notified',
+        :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'tags' => :'tags',
+        :'timestamp' => :'timestamp'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'success' => :'Boolean',
+        :'notification_id' => :'String',
+        :'devices_notified' => :'Integer',
+        :'users_notified' => :'Integer',
+        :'effective_channel_slugs' => :'Array<String>',
+        :'tags' => :'Array<String>',
+        :'timestamp' => :'Time'
+      }
+    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 `OpenapiClient::PushNotificationReplaceResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PushNotificationReplaceResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      else
+        self.success = nil
+      end
+
+      if attributes.key?(:'notification_id')
+        self.notification_id = attributes[:'notification_id']
+      else
+        self.notification_id = nil
+      end
+
+      if attributes.key?(:'devices_notified')
+        self.devices_notified = attributes[:'devices_notified']
+      end
+
+      if attributes.key?(:'users_notified')
+        self.users_notified = attributes[:'users_notified']
+      end
+
+      if attributes.key?(:'effective_channel_slugs')
+        if (value = attributes[:'effective_channel_slugs']).is_a?(Array)
+          self.effective_channel_slugs = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      else
+        self.timestamp = 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 @success.nil?
+        invalid_properties.push('invalid value for "success", success cannot be nil.')
+      end
+
+      if @notification_id.nil?
+        invalid_properties.push('invalid value for "notification_id", notification_id cannot be nil.')
+      end
+
+      if @timestamp.nil?
+        invalid_properties.push('invalid value for "timestamp", timestamp 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 @success.nil?
+      return false if @notification_id.nil?
+      return false if @timestamp.nil?
+      true
+    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 &&
+          success == o.success &&
+          notification_id == o.notification_id &&
+          devices_notified == o.devices_notified &&
+          users_notified == o.users_notified &&
+          effective_channel_slugs == o.effective_channel_slugs &&
+          tags == o.tags &&
+          timestamp == o.timestamp
+    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
+      [success, notification_id, devices_notified, users_notified, effective_channel_slugs, tags, timestamp].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = OpenapiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -24,6 +24,12 @@ module OpenapiClient
 
     attr_accessor :subtitle
 
+    # Optional HTTPS image URL without credentials for a custom notification icon. If the image cannot be loaded, the app icon is used. iOS may omit subtitle when displaying a custom icon.
+    attr_accessor :icon
+
+    # Optional. How urgently iOS presents the notification: `passive` (quiet, no sound or screen wake), `active` (default), or `time-sensitive` (can break through Focus and Scheduled Summary when allowed). Omit for normal delivery.
+    attr_accessor :interruption_level
+
     # Optional HTTPS URL for an image, audio file, or video that users can preview or play when they expand the notification. If `redirection` is omitted, tapping the notification opens this URL. Cannot be combined with `actions`.
     attr_accessor :media
 
@@ -44,6 +50,28 @@ module OpenapiClient
     # Optional tags to organize and filter notification history.
     attr_accessor :tags
 
+    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
       {
@@ -51,6 +79,8 @@ module OpenapiClient
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
+        :'icon' => :'icon',
+        :'interruption_level' => :'interruption_level',
         :'media' => :'media',
         :'redirection' => :'redirection',
         :'actions' => :'actions',
@@ -74,6 +104,8 @@ module OpenapiClient
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
+        :'icon' => :'String',
+        :'interruption_level' => :'PushInterruptionLevel',
         :'media' => :'String',
         :'redirection' => :'String',
         :'actions' => :'Array<PushNotificationAction>',
@@ -126,6 +158,14 @@ module OpenapiClient
         self.subtitle = attributes[:'subtitle']
       end
 
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'interruption_level')
+        self.interruption_level = attributes[:'interruption_level']
+      end
+
       if attributes.key?(:'media')
         self.media = attributes[:'media']
       end
@@ -176,6 +216,11 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
+      pattern = Regexp.new(/^https:\/\//)
+      if !@icon.nil? && @icon !~ pattern
+        invalid_properties.push("invalid value for \"icon\", must conform to the pattern #{pattern}.")
+      end
+
       pattern = Regexp.new(/^https:\/\//)
       if !@media.nil? && @media !~ pattern
         invalid_properties.push("invalid value for \"media\", must conform to the pattern #{pattern}.")
@@ -203,6 +248,7 @@ module OpenapiClient
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@metadata.nil? && @metadata.length > 50
       return false if @title.nil?
+      return false if !@icon.nil? && @icon !~ Regexp.new(/^https:\/\//)
       return false if !@media.nil? && @media !~ Regexp.new(/^https:\/\//)
       return false if !@redirection.nil? && @redirection.to_s.length > 2048
       return false if !@redirection.nil? && @redirection !~ Regexp.new(/^[A-Za-z][A-Za-z0-9+.-]*:/)
@@ -224,6 +270,21 @@ module OpenapiClient
       @metadata = metadata
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] icon Value to be assigned
+    def icon=(icon)
+      if icon.nil?
+        fail ArgumentError, 'icon cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if icon !~ pattern
+        fail ArgumentError, "invalid value for \"icon\", must conform to the pattern #{pattern}."
+      end
+
+      @icon = icon
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] media Value to be assigned
     def media=(media)
@@ -281,6 +342,8 @@ module OpenapiClient
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
+          icon == o.icon &&
+          interruption_level == o.interruption_level &&
           media == o.media &&
           redirection == o.redirection &&
           actions == o.actions &&
@@ -300,7 +363,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [metadata, title, message, subtitle, media, redirection, actions, payload, badge, sound, target, tags].hash
+      [metadata, title, message, subtitle, icon, interruption_level, media, redirection, actions, payload, badge, sound, target, tags].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/push_notification_response.rb

@@ -14,9 +14,15 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Apple APNs acceptance result. Acceptance does not confirm device delivery or presentation. Alerts remain eligible for APNs delivery retries for 24 hours; device settings and APNs storage policies still apply.
   class PushNotificationResponse
+    # True when APNs accepts the notification for at least one targeted device.
     attr_accessor :success
 
+    # ID of this Push Notification. Pass it to `PUT /push-notification/{notification_id}` to replace the notification later.
+    attr_accessor :notification_id
+
+    # Number of device tokens for which APNs accepted the notification, without confirming on-device delivery.
     attr_accessor :devices_notified
 
     attr_accessor :users_notified
@@ -28,15 +34,35 @@ module OpenapiClient
 
     attr_accessor :timestamp
 
+    # Number of device tokens targeted.
+    attr_accessor :devices_targeted
+
+    # Number of device tokens deactivated because APNs reported them unregistered.
+    attr_accessor :devices_deactivated
+
+    # Number of targeted device tokens APNs reported as unregistered.
+    attr_accessor :devices_unregistered
+
+    # True when the request was an integration connection test and no paired devices were available.
+    attr_accessor :credential_test
+
+    attr_accessor :message
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'success' => :'success',
+        :'notification_id' => :'notification_id',
         :'devices_notified' => :'devices_notified',
         :'users_notified' => :'users_notified',
         :'effective_channel_slugs' => :'effective_channel_slugs',
         :'tags' => :'tags',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'devices_targeted' => :'devices_targeted',
+        :'devices_deactivated' => :'devices_deactivated',
+        :'devices_unregistered' => :'devices_unregistered',
+        :'credential_test' => :'credential_test',
+        :'message' => :'message'
       }
     end
 
@@ -49,11 +75,17 @@ module OpenapiClient
     def self.openapi_types
       {
         :'success' => :'Boolean',
+        :'notification_id' => :'String',
         :'devices_notified' => :'Integer',
         :'users_notified' => :'Integer',
         :'effective_channel_slugs' => :'Array<String>',
         :'tags' => :'Array<String>',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'devices_targeted' => :'Integer',
+        :'devices_deactivated' => :'Integer',
+        :'devices_unregistered' => :'Integer',
+        :'credential_test' => :'Boolean',
+        :'message' => :'String'
       }
     end
 
@@ -84,6 +116,10 @@ module OpenapiClient
         self.success = nil
       end
 
+      if attributes.key?(:'notification_id')
+        self.notification_id = attributes[:'notification_id']
+      end
+
       if attributes.key?(:'devices_notified')
         self.devices_notified = attributes[:'devices_notified']
       end
@@ -109,6 +145,26 @@ module OpenapiClient
       else
         self.timestamp = nil
       end
+
+      if attributes.key?(:'devices_targeted')
+        self.devices_targeted = attributes[:'devices_targeted']
+      end
+
+      if attributes.key?(:'devices_deactivated')
+        self.devices_deactivated = attributes[:'devices_deactivated']
+      end
+
+      if attributes.key?(:'devices_unregistered')
+        self.devices_unregistered = attributes[:'devices_unregistered']
+      end
+
+      if attributes.key?(:'credential_test')
+        self.credential_test = attributes[:'credential_test']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -142,11 +198,17 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           success == o.success &&
+          notification_id == o.notification_id &&
           devices_notified == o.devices_notified &&
           users_notified == o.users_notified &&
           effective_channel_slugs == o.effective_channel_slugs &&
           tags == o.tags &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          devices_targeted == o.devices_targeted &&
+          devices_deactivated == o.devices_deactivated &&
+          devices_unregistered == o.devices_unregistered &&
+          credential_test == o.credential_test &&
+          message == o.message
     end
 
     # @see the `==` method
@@ -158,7 +220,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, devices_notified, users_notified, effective_channel_slugs, tags, timestamp].hash
+      [success, notification_id, devices_notified, users_notified, effective_channel_slugs, tags, timestamp, devices_targeted, devices_deactivated, devices_unregistered, credential_test, message].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.7.0
 =end
 
 module OpenapiClient
-  VERSION = '1.12.0'
+  VERSION = '1.13.0'
 end

data/generated/activitysmith_openapi.rb

@@ -24,6 +24,8 @@ require 'activitysmith_openapi/models/app_icon_badge_count_update_error'
 require 'activitysmith_openapi/models/app_icon_badge_count_update_request'
 require 'activitysmith_openapi/models/app_icon_badge_count_update_response'
 require 'activitysmith_openapi/models/bad_request_error'
+require 'activitysmith_openapi/models/billing_blocked_error'
+require 'activitysmith_openapi/models/billing_blocked_error_trial_period'
 require 'activitysmith_openapi/models/channel_target'
 require 'activitysmith_openapi/models/content_state_end'
 require 'activitysmith_openapi/models/content_state_start'
@@ -54,8 +56,11 @@ require 'activitysmith_openapi/models/metric_value_update_request_value'
 require 'activitysmith_openapi/models/metric_value_update_response'
 require 'activitysmith_openapi/models/no_recipients_error'
 require 'activitysmith_openapi/models/not_found_error'
+require 'activitysmith_openapi/models/push_interruption_level'
 require 'activitysmith_openapi/models/push_notification_action'
 require 'activitysmith_openapi/models/push_notification_action_type'
+require 'activitysmith_openapi/models/push_notification_replace_request'
+require 'activitysmith_openapi/models/push_notification_replace_response'
 require 'activitysmith_openapi/models/push_notification_request'
 require 'activitysmith_openapi/models/push_notification_response'
 require 'activitysmith_openapi/models/push_notification_webhook_method'

data/generated/openapi-source.json

@@ -1,6 +1,6 @@
 {
   "repository": "ActivitySmithHQ/activitysmith-backend",
-  "commit": "6832df646de7de8a6aaf0110960c37074b513c48",
+  "commit": "dd6757c5defa3d1e6524faef789b6829184fb852",
   "path": "openapi.json",
-  "sha256": "9ae85ad6127cfa2d50c33261459f5f9e85e011939d01ac4a9d507fa6ed11aa61"
+  "sha256": "24dae2d064095351d5e5cf800228e64a2d23c40b1e31a9754503081ddf31c5d8"
 }

data/lib/activitysmith/notifications.rb

@@ -9,14 +9,25 @@ module ActivitySmith
     def send(request = nil, opts = {}, tags: nil, **request_fields)
       normalized = normalize_channels_target(with_tags(combine_request(request, request_fields), tags))
       assert_valid_media_actions!(normalized)
+      assert_valid_interruption_level!(normalized)
       @api.send_push_notification(normalized, opts)
     end
 
     # Backward-compatible alias.
-    def send_push_notification(push_notification_request, opts = {}, tags: nil)
-      normalized = normalize_channels_target(with_tags(push_notification_request, tags))
+    def send_push_notification(push_notification_request = nil, opts = {}, tags: nil, **request_fields)
+      send(push_notification_request, opts, tags: tags, **request_fields)
+    end
+
+    # Silently replaces a sent Push Notification, using the notification_id returned by send.
+    def replace(notification_id, request = nil, opts = {}, tags: nil, **request_fields)
+      normalized = with_tags(combine_request(request, request_fields), tags)
       assert_valid_media_actions!(normalized)
-      @api.send_push_notification(normalized, opts)
+      @api.replace_push_notification(notification_id, normalized, opts)
+    end
+
+    # Generated-style alias.
+    def replace_push_notification(notification_id, push_notification_replace_request = nil, opts = {}, tags: nil, **request_fields)
+      replace(notification_id, push_notification_replace_request, opts, tags: tags, **request_fields)
     end
 
     def method_missing(name, *args, &block)
@@ -80,6 +91,13 @@ module ActivitySmith
       raise ArgumentError, "ActivitySmith: media cannot be combined with actions"
     end
 
+    def assert_valid_interruption_level!(request)
+      level = request_value(request, :interruption_level)
+      return if level.nil? || PushInterruptionLevel::VALUES.include?(level.to_s)
+
+      raise ArgumentError, "ActivitySmith: interruption_level must be passive, active, or time-sensitive"
+    end
+
     def request_value(request, key)
       if request.is_a?(Hash)
         return request[key] if request.key?(key)

data/lib/activitysmith/push_interruption_level.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActivitySmith
+  module PushInterruptionLevel
+    PASSIVE = "passive"
+    ACTIVE = "active"
+    TIME_SENSITIVE = "time-sensitive"
+    VALUES = [PASSIVE, ACTIVE, TIME_SENSITIVE].freeze
+  end
+end

data/lib/activitysmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivitySmith
-  VERSION = "1.12.0"
+  VERSION = "1.14.0"
 end

data/lib/activitysmith.rb

@@ -2,6 +2,7 @@
 
 require_relative "activitysmith/version"
 require_relative "activitysmith/versioned_user_agent"
+require_relative "activitysmith/push_interruption_level"
 require_relative "activitysmith/notifications"
 require_relative "activitysmith/live_activities"
 require_relative "activitysmith/metrics"