activitysmith 1.13.0 → 1.14.0

data/generated/activitysmith_openapi/models/live_activity_update_response.rb

@@ -26,6 +26,23 @@ module OpenapiClient
 
     attr_accessor :timestamp
 
+    attr_accessor :users_notified
+
+    attr_accessor :effective_channel_slugs
+
+    # Optional tags to organize and filter notification history.
+    attr_accessor :tags
+
+    # Present when the update started a new Live Activity for a managed stream.
+    attr_accessor :operation
+
+    attr_accessor :stream_key
+
+    attr_accessor :previous_activity_id
+
+    # Per-device delivery errors when some devices could not be reached.
+    attr_accessor :errors
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -33,7 +50,14 @@ module OpenapiClient
         :'activity_id' => :'activity_id',
         :'devices_queued' => :'devices_queued',
         :'devices_notified' => :'devices_notified',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'users_notified' => :'users_notified',
+        :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'tags' => :'tags',
+        :'operation' => :'operation',
+        :'stream_key' => :'stream_key',
+        :'previous_activity_id' => :'previous_activity_id',
+        :'errors' => :'errors'
       }
     end
 
@@ -49,7 +73,14 @@ module OpenapiClient
         :'activity_id' => :'String',
         :'devices_queued' => :'Integer',
         :'devices_notified' => :'Integer',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'users_notified' => :'Integer',
+        :'effective_channel_slugs' => :'Array<String>',
+        :'tags' => :'Array<String>',
+        :'operation' => :'String',
+        :'stream_key' => :'String',
+        :'previous_activity_id' => :'String',
+        :'errors' => :'Array<String>'
       }
     end
 
@@ -99,6 +130,40 @@ module OpenapiClient
       else
         self.timestamp = nil
       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?(:'operation')
+        self.operation = attributes[:'operation']
+      end
+
+      if attributes.key?(:'stream_key')
+        self.stream_key = attributes[:'stream_key']
+      end
+
+      if attributes.key?(:'previous_activity_id')
+        self.previous_activity_id = attributes[:'previous_activity_id']
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -140,7 +205,14 @@ module OpenapiClient
           activity_id == o.activity_id &&
           devices_queued == o.devices_queued &&
           devices_notified == o.devices_notified &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          users_notified == o.users_notified &&
+          effective_channel_slugs == o.effective_channel_slugs &&
+          tags == o.tags &&
+          operation == o.operation &&
+          stream_key == o.stream_key &&
+          previous_activity_id == o.previous_activity_id &&
+          errors == o.errors
     end
 
     # @see the `==` method
@@ -152,7 +224,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, activity_id, devices_queued, devices_notified, timestamp].hash
+      [success, activity_id, devices_queued, devices_notified, timestamp, users_notified, effective_channel_slugs, tags, operation, stream_key, previous_activity_id, errors].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/push_notification_replace_request.rb

@@ -0,0 +1,434 @@
+=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
+  # Replacement content. title, subtitle, message, redirection, media, icon, actions, and payload fully replace the original values. Omit metadata or tags to keep the stored values; send {} or [] to clear them.
+  class PushNotificationReplaceRequest
+    # 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
+
+    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 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 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`.
+    attr_accessor :actions
+
+    attr_accessor :payload
+
+    attr_accessor :badge
+
+    # 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',
+        :'icon' => :'icon',
+        :'media' => :'media',
+        :'redirection' => :'redirection',
+        :'actions' => :'actions',
+        :'payload' => :'payload',
+        :'badge' => :'badge',
+        :'tags' => :'tags'
+      }
+    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
+      {
+        :'metadata' => :'Hash<String, MetadataValue>',
+        :'title' => :'String',
+        :'message' => :'String',
+        :'subtitle' => :'String',
+        :'icon' => :'String',
+        :'media' => :'String',
+        :'redirection' => :'String',
+        :'actions' => :'Array<PushNotificationAction>',
+        :'payload' => :'Object',
+        :'badge' => :'Integer',
+        :'tags' => :'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 `OpenapiClient::PushNotificationReplaceRequest` 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::PushNotificationReplaceRequest`. 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?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'subtitle')
+        self.subtitle = attributes[:'subtitle']
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      end
+
+      if attributes.key?(:'redirection')
+        self.redirection = attributes[:'redirection']
+      end
+
+      if attributes.key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      end
+
+      if attributes.key?(:'badge')
+        self.badge = attributes[:'badge']
+      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?
+    # @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 !@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
+
+      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}.")
+      end
+
+      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
+
+      if !@actions.nil? && @actions.length > 4
+        invalid_properties.push('invalid value for "actions", number of items must be less than or equal to 4.')
+      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 !@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+.-]*:/)
+      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] 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)
+      if media.nil?
+        fail ArgumentError, 'media cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if media !~ pattern
+        fail ArgumentError, "invalid value for \"media\", must conform to the pattern #{pattern}."
+      end
+
+      @media = media
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] redirection Value to be assigned
+    def redirection=(redirection)
+      if redirection.nil?
+        fail ArgumentError, 'redirection cannot be nil'
+      end
+
+      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
+
+      @redirection = redirection
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actions Value to be assigned
+    def actions=(actions)
+      if actions.nil?
+        fail ArgumentError, 'actions cannot be nil'
+      end
+
+      if actions.length > 4
+        fail ArgumentError, 'invalid value for "actions", number of items must be less than or equal to 4.'
+      end
+
+      @actions = actions
+    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 &&
+          title == o.title &&
+          message == o.message &&
+          subtitle == o.subtitle &&
+          icon == o.icon &&
+          media == o.media &&
+          redirection == o.redirection &&
+          actions == o.actions &&
+          payload == o.payload &&
+          badge == o.badge &&
+          tags == o.tags
+    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
+      [metadata, title, message, subtitle, icon, media, redirection, actions, payload, badge, tags].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