activitysmith 1.9.0 → 1.11.0

data/generated/activitysmith_openapi/models/live_activity_end_request.rb

@@ -16,19 +16,27 @@ require 'time'
 module OpenapiClient
   # End an existing Live Activity by activity_id.
   class LiveActivityEndRequest
+    # 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' => :'ContentStateEnd',
         :'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/live_activity_limit_error.rb

@@ -21,16 +21,24 @@ module OpenapiClient
 
     attr_accessor :limit
 
-    # Current number of active Live Activities.
+    # Highest number of active Live Activities among the targeted devices.
     attr_accessor :active
 
+    # Number of targeted devices that have reached the enforced iOS Live Activity concurrency threshold. Included only when targeted devices have mixed capacity.
+    attr_accessor :blocked_devices
+
+    # Total number of targeted devices. Included only when targeted devices have mixed capacity.
+    attr_accessor :targeted_devices
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'error' => :'error',
         :'message' => :'message',
         :'limit' => :'limit',
-        :'active' => :'active'
+        :'active' => :'active',
+        :'blocked_devices' => :'blocked_devices',
+        :'targeted_devices' => :'targeted_devices'
       }
     end
 
@@ -45,7 +53,9 @@ module OpenapiClient
         :'error' => :'String',
         :'message' => :'String',
         :'limit' => :'Integer',
-        :'active' => :'Integer'
+        :'active' => :'Integer',
+        :'blocked_devices' => :'Integer',
+        :'targeted_devices' => :'Integer'
       }
     end
 
@@ -93,6 +103,14 @@ module OpenapiClient
       else
         self.active = nil
       end
+
+      if attributes.key?(:'blocked_devices')
+        self.blocked_devices = attributes[:'blocked_devices']
+      end
+
+      if attributes.key?(:'targeted_devices')
+        self.targeted_devices = attributes[:'targeted_devices']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -138,7 +156,9 @@ module OpenapiClient
           error == o.error &&
           message == o.message &&
           limit == o.limit &&
-          active == o.active
+          active == o.active &&
+          blocked_devices == o.blocked_devices &&
+          targeted_devices == o.targeted_devices
     end
 
     # @see the `==` method
@@ -150,7 +170,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, message, limit, active].hash
+      [error, message, limit, active, blocked_devices, targeted_devices].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_start_request.rb

@@ -16,25 +16,33 @@ require 'time'
 module OpenapiClient
   # Start a new Live Activity. The response includes activity_id for later update and end calls.
   class LiveActivityStartRequest
+    # 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
 
     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',
-        :'target' => :'target'
+        :'target' => :'target',
+        :'tags' => :'tags'
       }
     end
 
@@ -46,11 +54,13 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'metadata' => :'Hash<String, MetadataValue>',
         :'content_state' => :'ContentStateStart',
         :'action' => :'LiveActivityAction',
         :'secondary_action' => :'LiveActivityAction',
         :'alert' => :'AlertPayload',
-        :'target' => :'ChannelTarget'
+        :'target' => :'ChannelTarget',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -75,6 +85,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
@@ -96,6 +112,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?
@@ -103,6 +125,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
@@ -114,20 +140,37 @@ 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?
       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
+
     # 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 &&
           content_state == o.content_state &&
           action == o.action &&
           secondary_action == o.secondary_action &&
           alert == o.alert &&
-          target == o.target
+          target == o.target &&
+          tags == o.tags
     end
 
     # @see the `==` method
@@ -139,7 +182,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_state, action, secondary_action, alert, target].hash
+      [metadata, content_state, action, secondary_action, alert, target, tags].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_start_response.rb

@@ -26,6 +26,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.
@@ -36,6 +39,7 @@ module OpenapiClient
         :'users_notified' => :'users_notified',
         :'activity_id' => :'activity_id',
         :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'tags' => :'tags',
         :'timestamp' => :'timestamp'
       }
     end
@@ -53,6 +57,7 @@ module OpenapiClient
         :'users_notified' => :'Integer',
         :'activity_id' => :'String',
         :'effective_channel_slugs' => :'Array<String>',
+        :'tags' => :'Array<String>',
         :'timestamp' => :'Time'
       }
     end
@@ -104,6 +109,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
@@ -151,6 +162,7 @@ module OpenapiClient
           users_notified == o.users_notified &&
           activity_id == o.activity_id &&
           effective_channel_slugs == o.effective_channel_slugs &&
+          tags == o.tags &&
           timestamp == o.timestamp
     end
 
@@ -163,7 +175,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, devices_notified, users_notified, activity_id, effective_channel_slugs, timestamp].hash
+      [success, devices_notified, users_notified, activity_id, effective_channel_slugs, tags, timestamp].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_stream_delete_request.rb

@@ -16,11 +16,17 @@ require 'time'
 module OpenapiClient
   # Optional payload for ending a managed stream. When omitted, ActivitySmith ends the stream using the latest known state when possible.
   class LiveActivityStreamDeleteRequest
+    # 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
+
+    # Optional tags to organize and filter notification history.
+    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
 
     attr_accessor :alert
@@ -28,6 +34,8 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'metadata' => :'metadata',
+        :'tags' => :'tags',
         :'content_state' => :'content_state',
         :'action' => :'action',
         :'secondary_action' => :'secondary_action',
@@ -43,6 +51,8 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'metadata' => :'Hash<String, MetadataValue>',
+        :'tags' => :'Array<String>',
         :'content_state' => :'StreamContentState',
         :'action' => :'LiveActivityAction',
         :'secondary_action' => :'LiveActivityAction',
@@ -71,6 +81,18 @@ 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?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
       if attributes.key?(:'content_state')
         self.content_state = attributes[:'content_state']
       end
@@ -93,6 +115,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
+
       invalid_properties
     end
 
@@ -100,14 +126,31 @@ 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
       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
+
     # 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 &&
+          tags == o.tags &&
           content_state == o.content_state &&
           action == o.action &&
           secondary_action == o.secondary_action &&
@@ -123,7 +166,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_state, action, secondary_action, alert].hash
+      [metadata, tags, content_state, action, secondary_action, alert].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_stream_put_response.rb

@@ -34,6 +34,9 @@ module OpenapiClient
 
     attr_accessor :effective_channel_slugs
 
+    # Optional tags to organize and filter notification history.
+    attr_accessor :tags
+
     attr_accessor :timestamp
 
     class EnumAttributeValidator
@@ -70,6 +73,7 @@ module OpenapiClient
         :'devices_queued' => :'devices_queued',
         :'users_notified' => :'users_notified',
         :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'tags' => :'tags',
         :'timestamp' => :'timestamp'
       }
     end
@@ -91,6 +95,7 @@ module OpenapiClient
         :'devices_queued' => :'Integer',
         :'users_notified' => :'Integer',
         :'effective_channel_slugs' => :'Array<String>',
+        :'tags' => :'Array<String>',
         :'timestamp' => :'Time'
       }
     end
@@ -161,6 +166,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
@@ -229,6 +240,7 @@ module OpenapiClient
           devices_queued == o.devices_queued &&
           users_notified == o.users_notified &&
           effective_channel_slugs == o.effective_channel_slugs &&
+          tags == o.tags &&
           timestamp == o.timestamp
     end
 
@@ -241,7 +253,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, operation, stream_key, activity_id, previous_activity_id, devices_notified, devices_queued, users_notified, effective_channel_slugs, timestamp].hash
+      [success, operation, stream_key, activity_id, previous_activity_id, devices_notified, devices_queued, users_notified, effective_channel_slugs, tags, timestamp].hash
     end
 
     # Builds the object from hash