activitysmith 1.8.0 → 1.10.0

data/generated/activitysmith_openapi/models/app_icon_badge_count_update_response.rb

@@ -0,0 +1,331 @@
+=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
+  class AppIconBadgeCountUpdateResponse
+    attr_accessor :success
+
+    attr_accessor :badge
+
+    attr_accessor :devices_notified
+
+    attr_accessor :users_notified
+
+    attr_accessor :effective_channel_slugs
+
+    attr_accessor :timestamp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success' => :'success',
+        :'badge' => :'badge',
+        :'devices_notified' => :'devices_notified',
+        :'users_notified' => :'users_notified',
+        :'effective_channel_slugs' => :'effective_channel_slugs',
+        :'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',
+        :'badge' => :'Integer',
+        :'devices_notified' => :'Integer',
+        :'users_notified' => :'Integer',
+        :'effective_channel_slugs' => :'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::AppIconBadgeCountUpdateResponse` 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::AppIconBadgeCountUpdateResponse`. 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?(:'badge')
+        self.badge = attributes[:'badge']
+      else
+        self.badge = nil
+      end
+
+      if attributes.key?(:'devices_notified')
+        self.devices_notified = attributes[:'devices_notified']
+      else
+        self.devices_notified = nil
+      end
+
+      if attributes.key?(:'users_notified')
+        self.users_notified = attributes[:'users_notified']
+      else
+        self.users_notified = nil
+      end
+
+      if attributes.key?(:'effective_channel_slugs')
+        if (value = attributes[:'effective_channel_slugs']).is_a?(Array)
+          self.effective_channel_slugs = value
+        end
+      else
+        self.effective_channel_slugs = nil
+      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 @badge.nil?
+        invalid_properties.push('invalid value for "badge", badge cannot be nil.')
+      end
+
+      if @badge > 2147483647
+        invalid_properties.push('invalid value for "badge", must be smaller than or equal to 2147483647.')
+      end
+
+      if @badge < 0
+        invalid_properties.push('invalid value for "badge", must be greater than or equal to 0.')
+      end
+
+      if @devices_notified.nil?
+        invalid_properties.push('invalid value for "devices_notified", devices_notified cannot be nil.')
+      end
+
+      if @users_notified.nil?
+        invalid_properties.push('invalid value for "users_notified", users_notified cannot be nil.')
+      end
+
+      if @effective_channel_slugs.nil?
+        invalid_properties.push('invalid value for "effective_channel_slugs", effective_channel_slugs 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 @badge.nil?
+      return false if @badge > 2147483647
+      return false if @badge < 0
+      return false if @devices_notified.nil?
+      return false if @users_notified.nil?
+      return false if @effective_channel_slugs.nil?
+      return false if @timestamp.nil?
+      true
+    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 > 2147483647
+        fail ArgumentError, 'invalid value for "badge", must be smaller than or equal to 2147483647.'
+      end
+
+      if badge < 0
+        fail ArgumentError, 'invalid value for "badge", must be greater than or equal to 0.'
+      end
+
+      @badge = badge
+    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 &&
+          badge == o.badge &&
+          devices_notified == o.devices_notified &&
+          users_notified == o.users_notified &&
+          effective_channel_slugs == o.effective_channel_slugs &&
+          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, badge, devices_notified, users_notified, effective_channel_slugs, 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/live_activity_action.rb

@@ -21,7 +21,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 an HTTP or 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.
     attr_accessor :url
 
     # Webhook HTTP method. Used only when type=webhook.
@@ -53,7 +53,7 @@ module OpenapiClient
         :'type' => :'LiveActivityActionType',
         :'url' => :'String',
         :'method' => :'LiveActivityWebhookMethod',
-        :'body' => :'Hash<String, Object>'
+        :'body' => :'Object'
       }
     end
 
@@ -103,9 +103,7 @@ module OpenapiClient
       end
 
       if attributes.key?(:'body')
-        if (value = attributes[:'body']).is_a?(Hash)
-          self.body = value
-        end
+        self.body = attributes[:'body']
       end
     end
 

data/generated/activitysmith_openapi/models/live_activity_end_request.rb

@@ -22,7 +22,7 @@ module OpenapiClient
 
     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.

data/generated/activitysmith_openapi/models/live_activity_start_request.rb

@@ -20,13 +20,16 @@ module OpenapiClient
 
     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
       {
@@ -34,7 +37,8 @@ module OpenapiClient
         :'action' => :'action',
         :'secondary_action' => :'secondary_action',
         :'alert' => :'alert',
-        :'target' => :'target'
+        :'target' => :'target',
+        :'tags' => :'tags'
       }
     end
 
@@ -50,7 +54,8 @@ module OpenapiClient
         :'action' => :'LiveActivityAction',
         :'secondary_action' => :'LiveActivityAction',
         :'alert' => :'AlertPayload',
-        :'target' => :'ChannelTarget'
+        :'target' => :'ChannelTarget',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -96,6 +101,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?
@@ -127,7 +138,8 @@ module OpenapiClient
           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 +151,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_state, action, secondary_action, alert, target].hash
+      [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

@@ -20,7 +20,7 @@ module OpenapiClient
 
     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

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

data/generated/activitysmith_openapi/models/live_activity_stream_request.rb

@@ -20,7 +20,7 @@ module OpenapiClient
 
     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,6 +30,9 @@ 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
       {
@@ -38,7 +41,8 @@ module OpenapiClient
         :'secondary_action' => :'secondary_action',
         :'alert' => :'alert',
         :'channels' => :'channels',
-        :'target' => :'target'
+        :'target' => :'target',
+        :'tags' => :'tags'
       }
     end
 
@@ -55,7 +59,8 @@ module OpenapiClient
         :'secondary_action' => :'LiveActivityAction',
         :'alert' => :'AlertPayload',
         :'channels' => :'Array<String>',
-        :'target' => :'ChannelTarget'
+        :'target' => :'ChannelTarget',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -107,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?
@@ -158,7 +169,8 @@ module OpenapiClient
           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 +182,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
+      [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

@@ -22,7 +22,7 @@ module OpenapiClient
 
     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.

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 an HTTP or 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.
     attr_accessor :url
 
     # Webhook HTTP method. Used only when type=webhook.
@@ -52,7 +52,7 @@ module OpenapiClient
         :'type' => :'PushNotificationActionType',
         :'url' => :'String',
         :'method' => :'PushNotificationWebhookMethod',
-        :'body' => :'Hash<String, Object>'
+        :'body' => :'Object'
       }
     end
 
@@ -102,9 +102,7 @@ module OpenapiClient
       end
 
       if attributes.key?(:'body')
-        if (value = attributes[:'body']).is_a?(Hash)
-          self.body = value
-        end
+        self.body = attributes[:'body']
       end
     end