activitysmith 1.9.0 → 1.11.0

data/generated/activitysmith_openapi/models/live_activity_stream_request.rb

@@ -16,11 +16,14 @@ require 'time'
 module OpenapiClient
   # Send the latest state for a managed Live Activity stream. channels is the streamlined form for stream targeting. target.channels is also accepted for compatibility. If both are provided, they must match.
   class LiveActivityStreamRequest
+    # Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it.
+    attr_accessor :metadata
+
     attr_accessor :content_state
 
     attr_accessor :action
 
-    # Optional secondary action button. Supported only for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.
+    # Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.
     attr_accessor :secondary_action
 
     attr_accessor :alert
@@ -30,15 +33,20 @@ module OpenapiClient
 
     attr_accessor :target
 
+    # Optional tags to organize and filter notification history.
+    attr_accessor :tags
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'metadata' => :'metadata',
         :'content_state' => :'content_state',
         :'action' => :'action',
         :'secondary_action' => :'secondary_action',
         :'alert' => :'alert',
         :'channels' => :'channels',
-        :'target' => :'target'
+        :'target' => :'target',
+        :'tags' => :'tags'
       }
     end
 
@@ -50,12 +58,14 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'metadata' => :'Hash<String, MetadataValue>',
         :'content_state' => :'StreamContentState',
         :'action' => :'LiveActivityAction',
         :'secondary_action' => :'LiveActivityAction',
         :'alert' => :'AlertPayload',
         :'channels' => :'Array<String>',
-        :'target' => :'ChannelTarget'
+        :'target' => :'ChannelTarget',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -80,6 +90,12 @@ module OpenapiClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
       if attributes.key?(:'content_state')
         self.content_state = attributes[:'content_state']
       else
@@ -107,6 +123,12 @@ module OpenapiClient
       if attributes.key?(:'target')
         self.target = attributes[:'target']
       end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -114,6 +136,10 @@ module OpenapiClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@metadata.nil? && @metadata.length > 50
+        invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 50.')
+      end
+
       if @content_state.nil?
         invalid_properties.push('invalid value for "content_state", content_state cannot be nil.')
       end
@@ -129,11 +155,26 @@ module OpenapiClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@metadata.nil? && @metadata.length > 50
       return false if @content_state.nil?
       return false if !@channels.nil? && @channels.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      if metadata.length > 50
+        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 50.'
+      end
+
+      @metadata = metadata
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] channels Value to be assigned
     def channels=(channels)
@@ -153,12 +194,14 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          metadata == o.metadata &&
           content_state == o.content_state &&
           action == o.action &&
           secondary_action == o.secondary_action &&
           alert == o.alert &&
           channels == o.channels &&
-          target == o.target
+          target == o.target &&
+          tags == o.tags
     end
 
     # @see the `==` method
@@ -170,7 +213,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_state, action, secondary_action, alert, channels, target].hash
+      [metadata, content_state, action, secondary_action, alert, channels, target, tags].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_update_request.rb

@@ -16,19 +16,27 @@ require 'time'
 module OpenapiClient
   # Update an existing Live Activity by activity_id.
   class LiveActivityUpdateRequest
+    # Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it.
+    attr_accessor :metadata
+
     attr_accessor :activity_id
 
+    # Tags for notification history. Omit to keep existing Tags, supply an array to replace them, or send an empty array to clear them.
+    attr_accessor :tags
+
     attr_accessor :content_state
 
     attr_accessor :action
 
-    # Optional secondary action button. Supported only for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.
+    # Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.
     attr_accessor :secondary_action
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'metadata' => :'metadata',
         :'activity_id' => :'activity_id',
+        :'tags' => :'tags',
         :'content_state' => :'content_state',
         :'action' => :'action',
         :'secondary_action' => :'secondary_action'
@@ -43,7 +51,9 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'metadata' => :'Hash<String, MetadataValue>',
         :'activity_id' => :'String',
+        :'tags' => :'Array<String>',
         :'content_state' => :'ContentStateUpdate',
         :'action' => :'LiveActivityAction',
         :'secondary_action' => :'LiveActivityAction'
@@ -71,12 +81,24 @@ module OpenapiClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
       if attributes.key?(:'activity_id')
         self.activity_id = attributes[:'activity_id']
       else
         self.activity_id = nil
       end
 
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
       if attributes.key?(:'content_state')
         self.content_state = attributes[:'content_state']
       else
@@ -97,10 +119,18 @@ module OpenapiClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@metadata.nil? && @metadata.length > 50
+        invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 50.')
+      end
+
       if @activity_id.nil?
         invalid_properties.push('invalid value for "activity_id", activity_id cannot be nil.')
       end
 
+      if !@tags.nil? && @tags.length > 20
+        invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 20.')
+      end
+
       if @content_state.nil?
         invalid_properties.push('invalid value for "content_state", content_state cannot be nil.')
       end
@@ -112,17 +142,49 @@ module OpenapiClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@metadata.nil? && @metadata.length > 50
       return false if @activity_id.nil?
+      return false if !@tags.nil? && @tags.length > 20
       return false if @content_state.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      if metadata.length > 50
+        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 50.'
+      end
+
+      @metadata = metadata
+    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 > 20
+        fail ArgumentError, 'invalid value for "tags", number of items must be less than or equal to 20.'
+      end
+
+      @tags = tags
+    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 &&
+          metadata == o.metadata &&
           activity_id == o.activity_id &&
+          tags == o.tags &&
           content_state == o.content_state &&
           action == o.action &&
           secondary_action == o.secondary_action
@@ -137,7 +199,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [activity_id, content_state, action, secondary_action].hash
+      [metadata, activity_id, tags, content_state, action, secondary_action].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/metadata_value.rb

@@ -0,0 +1,106 @@
+=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
+  module MetadataValue
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Boolean',
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = OpenapiClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/generated/activitysmith_openapi/models/push_notification_action.rb

@@ -20,7 +20,7 @@ module OpenapiClient
 
     attr_accessor :type
 
-    # Action URL. For open_url, use an HTTPS URL or a shortcuts://run-shortcut?name=... URL that runs a specific iPhone Shortcut. For webhook, use an HTTPS URL called by the ActivitySmith backend.
+    # Action URL. For open_url, use HTTP, HTTPS, Shortcuts, or an installed app’s custom URL scheme, such as spotify:// or spotify:track:123. Custom app schemes require iOS 1.13.4 build 2 or later; no web fallback is provided. Internal and executable schemes are blocked. For webhook, use an HTTPS URL called by the ActivitySmith backend.
     attr_accessor :url
 
     # Webhook HTTP method. Used only when type=webhook.

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module OpenapiClient
   class PushNotificationRequest
+    # Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it.
+    attr_accessor :metadata
+
     attr_accessor :title
 
     attr_accessor :message
@@ -24,7 +27,7 @@ module OpenapiClient
     # 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
 
-    # Optional HTTPS URL or shortcuts://run-shortcut?name=... URL opened when the user taps the notification body. Use shortcuts://run-shortcut?name=... to run a specific iPhone Shortcut that already exists on the user's device. Overrides the default tap target from `media` when both are provided.
+    # Optional HTTP, HTTPS, Shortcuts, or installed app URL opened when the user taps the notification body. Custom schemes such as spotify:// and spotify:track:123 require iOS 1.13.4 build 2 or later and an installed handler; no web fallback is provided. Internal and executable schemes are blocked. Overrides the default tap target from media.
     attr_accessor :redirection
 
     # Optional interactive actions shown when users expand the notification. Cannot be combined with `media`.
@@ -38,9 +41,13 @@ module OpenapiClient
 
     attr_accessor :target
 
+    # Optional tags to organize and filter notification history.
+    attr_accessor :tags
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'metadata' => :'metadata',
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
@@ -50,7 +57,8 @@ module OpenapiClient
         :'payload' => :'payload',
         :'badge' => :'badge',
         :'sound' => :'sound',
-        :'target' => :'target'
+        :'target' => :'target',
+        :'tags' => :'tags'
       }
     end
 
@@ -62,6 +70,7 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'metadata' => :'Hash<String, MetadataValue>',
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
@@ -71,7 +80,8 @@ module OpenapiClient
         :'payload' => :'Object',
         :'badge' => :'Integer',
         :'sound' => :'String',
-        :'target' => :'ChannelTarget'
+        :'target' => :'ChannelTarget',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -96,6 +106,12 @@ module OpenapiClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
       if attributes.key?(:'title')
         self.title = attributes[:'title']
       else
@@ -139,6 +155,12 @@ module OpenapiClient
       if attributes.key?(:'target')
         self.target = attributes[:'target']
       end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,6 +168,10 @@ module OpenapiClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@metadata.nil? && @metadata.length > 50
+        invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 50.')
+      end
+
       if @title.nil?
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
@@ -155,7 +181,11 @@ module OpenapiClient
         invalid_properties.push("invalid value for \"media\", must conform to the pattern #{pattern}.")
       end
 
-      pattern = Regexp.new(/^(https|shortcuts):\/\//)
+      if !@redirection.nil? && @redirection.to_s.length > 2048
+        invalid_properties.push('invalid value for "redirection", the character length must be smaller than or equal to 2048.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9+.-]*:/)
       if !@redirection.nil? && @redirection !~ pattern
         invalid_properties.push("invalid value for \"redirection\", must conform to the pattern #{pattern}.")
       end
@@ -171,13 +201,29 @@ module OpenapiClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@metadata.nil? && @metadata.length > 50
       return false if @title.nil?
       return false if !@media.nil? && @media !~ Regexp.new(/^https:\/\//)
-      return false if !@redirection.nil? && @redirection !~ Regexp.new(/^(https|shortcuts):\/\//)
+      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+.-]*:/)
       return false if !@actions.nil? && @actions.length > 4
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      if metadata.length > 50
+        fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 50.'
+      end
+
+      @metadata = metadata
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] media Value to be assigned
     def media=(media)
@@ -200,7 +246,11 @@ module OpenapiClient
         fail ArgumentError, 'redirection cannot be nil'
       end
 
-      pattern = Regexp.new(/^(https|shortcuts):\/\//)
+      if redirection.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "redirection", the character length must be smaller than or equal to 2048.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9+.-]*:/)
       if redirection !~ pattern
         fail ArgumentError, "invalid value for \"redirection\", must conform to the pattern #{pattern}."
       end
@@ -227,6 +277,7 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          metadata == o.metadata &&
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
@@ -236,7 +287,8 @@ module OpenapiClient
           payload == o.payload &&
           badge == o.badge &&
           sound == o.sound &&
-          target == o.target
+          target == o.target &&
+          tags == o.tags
     end
 
     # @see the `==` method
@@ -248,7 +300,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, message, subtitle, media, redirection, actions, payload, badge, sound, target].hash
+      [metadata, title, message, subtitle, media, redirection, actions, payload, badge, sound, target, tags].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/push_notification_response.rb

@@ -23,6 +23,9 @@ module OpenapiClient
 
     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.
@@ -32,6 +35,7 @@ module OpenapiClient
         :'devices_notified' => :'devices_notified',
         :'users_notified' => :'users_notified',
         :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'tags' => :'tags',
         :'timestamp' => :'timestamp'
       }
     end
@@ -48,6 +52,7 @@ module OpenapiClient
         :'devices_notified' => :'Integer',
         :'users_notified' => :'Integer',
         :'effective_channel_slugs' => :'Array<String>',
+        :'tags' => :'Array<String>',
         :'timestamp' => :'Time'
       }
     end
@@ -93,6 +98,12 @@ module OpenapiClient
         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
@@ -134,6 +145,7 @@ module OpenapiClient
           devices_notified == o.devices_notified &&
           users_notified == o.users_notified &&
           effective_channel_slugs == o.effective_channel_slugs &&
+          tags == o.tags &&
           timestamp == o.timestamp
     end
 
@@ -146,7 +158,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, devices_notified, users_notified, effective_channel_slugs, timestamp].hash
+      [success, devices_notified, users_notified, effective_channel_slugs, tags, timestamp].hash
     end
 
     # Builds the object from hash