activitysmith 1.13.0 → 1.15.0

data/generated/activitysmith_openapi/models/account_device_list_response_meta.rb

@@ -0,0 +1,299 @@
+=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 AccountDeviceListResponseMeta
+    # Devices matching the filter.
+    attr_accessor :total
+
+    attr_accessor :limit
+
+    attr_accessor :offset
+
+    attr_accessor :has_more
+
+    # Offset for the next page, or null on the last page.
+    attr_accessor :next_offset
+
+    attr_accessor :include_inactive
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'limit' => :'limit',
+        :'offset' => :'offset',
+        :'has_more' => :'has_more',
+        :'next_offset' => :'next_offset',
+        :'include_inactive' => :'include_inactive'
+      }
+    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
+      {
+        :'total' => :'Integer',
+        :'limit' => :'Integer',
+        :'offset' => :'Integer',
+        :'has_more' => :'Boolean',
+        :'next_offset' => :'Integer',
+        :'include_inactive' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_offset',
+      ])
+    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::AccountDeviceListResponseMeta` 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::AccountDeviceListResponseMeta`. 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?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      else
+        self.limit = nil
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      else
+        self.offset = nil
+      end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      else
+        self.has_more = nil
+      end
+
+      if attributes.key?(:'next_offset')
+        self.next_offset = attributes[:'next_offset']
+      else
+        self.next_offset = nil
+      end
+
+      if attributes.key?(:'include_inactive')
+        self.include_inactive = attributes[:'include_inactive']
+      else
+        self.include_inactive = 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 @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      if @limit.nil?
+        invalid_properties.push('invalid value for "limit", limit cannot be nil.')
+      end
+
+      if @offset.nil?
+        invalid_properties.push('invalid value for "offset", offset cannot be nil.')
+      end
+
+      if @has_more.nil?
+        invalid_properties.push('invalid value for "has_more", has_more cannot be nil.')
+      end
+
+      if @include_inactive.nil?
+        invalid_properties.push('invalid value for "include_inactive", include_inactive 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 @total.nil?
+      return false if @limit.nil?
+      return false if @offset.nil?
+      return false if @has_more.nil?
+      return false if @include_inactive.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 &&
+          total == o.total &&
+          limit == o.limit &&
+          offset == o.offset &&
+          has_more == o.has_more &&
+          next_offset == o.next_offset &&
+          include_inactive == o.include_inactive
+    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
+      [total, limit, offset, has_more, next_offset, include_inactive].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/app_icon_badge_count_update_response.rb

@@ -19,7 +19,7 @@ module OpenapiClient
 
     attr_accessor :badge
 
-    # Number of devices whose App Icon Badge Count was updated.
+    # Number of devices whose App Icon Badge was updated.
     attr_accessor :devices_updated
 
     # Number of account users with at least one updated device.
@@ -35,6 +35,15 @@ 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +54,10 @@ module OpenapiClient
         :'devices_notified' => :'devices_notified',
         :'users_notified' => :'users_notified',
         :'effective_channel_slugs' => :'effective_channel_slugs',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'devices_targeted' => :'devices_targeted',
+        :'devices_deactivated' => :'devices_deactivated',
+        :'devices_unregistered' => :'devices_unregistered'
       }
     end
 
@@ -64,7 +76,10 @@ module OpenapiClient
         :'devices_notified' => :'Integer',
         :'users_notified' => :'Integer',
         :'effective_channel_slugs' => :'Array<String>',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'devices_targeted' => :'Integer',
+        :'devices_deactivated' => :'Integer',
+        :'devices_unregistered' => :'Integer'
       }
     end
 
@@ -134,6 +149,18 @@ 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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -221,7 +248,10 @@ module OpenapiClient
           devices_notified == o.devices_notified &&
           users_notified == o.users_notified &&
           effective_channel_slugs == o.effective_channel_slugs &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          devices_targeted == o.devices_targeted &&
+          devices_deactivated == o.devices_deactivated &&
+          devices_unregistered == o.devices_unregistered
     end
 
     # @see the `==` method
@@ -233,7 +263,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, badge, devices_updated, users_updated, devices_notified, users_notified, effective_channel_slugs, timestamp].hash
+      [success, badge, devices_updated, users_updated, devices_notified, users_notified, effective_channel_slugs, timestamp, devices_targeted, devices_deactivated, devices_unregistered].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_end_response.rb

@@ -26,6 +26,21 @@ module OpenapiClient
 
     attr_accessor :timestamp
 
+    # True when the Live Activity had already ended and the request had no effect.
+    attr_accessor :ignored
+
+    attr_accessor :message
+
+    attr_accessor :end_reason
+
+    # True when the Live Activity was marked complete without a confirmed APNs end delivery.
+    attr_accessor :forced_completion
+
+    attr_accessor :warning
+
+    # 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 +48,13 @@ module OpenapiClient
         :'activity_id' => :'activity_id',
         :'devices_queued' => :'devices_queued',
         :'devices_notified' => :'devices_notified',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'ignored' => :'ignored',
+        :'message' => :'message',
+        :'end_reason' => :'end_reason',
+        :'forced_completion' => :'forced_completion',
+        :'warning' => :'warning',
+        :'errors' => :'errors'
       }
     end
 
@@ -49,13 +70,20 @@ module OpenapiClient
         :'activity_id' => :'String',
         :'devices_queued' => :'Integer',
         :'devices_notified' => :'Integer',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'ignored' => :'Boolean',
+        :'message' => :'String',
+        :'end_reason' => :'String',
+        :'forced_completion' => :'Boolean',
+        :'warning' => :'String',
+        :'errors' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'end_reason',
       ])
     end
 
@@ -99,6 +127,32 @@ module OpenapiClient
       else
         self.timestamp = nil
       end
+
+      if attributes.key?(:'ignored')
+        self.ignored = attributes[:'ignored']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'end_reason')
+        self.end_reason = attributes[:'end_reason']
+      end
+
+      if attributes.key?(:'forced_completion')
+        self.forced_completion = attributes[:'forced_completion']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 +194,13 @@ module OpenapiClient
           activity_id == o.activity_id &&
           devices_queued == o.devices_queued &&
           devices_notified == o.devices_notified &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          ignored == o.ignored &&
+          message == o.message &&
+          end_reason == o.end_reason &&
+          forced_completion == o.forced_completion &&
+          warning == o.warning &&
+          errors == o.errors
     end
 
     # @see the `==` method
@@ -152,7 +212,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, ignored, message, end_reason, forced_completion, warning, errors].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_start_response.rb

@@ -31,6 +31,14 @@ module OpenapiClient
 
     attr_accessor :timestamp
 
+    # Present when starting this Live Activity ended an older one to stay within the device limit.
+    attr_accessor :ended_activity_id
+
+    attr_accessor :message
+
+    # 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
       {
@@ -40,7 +48,10 @@ module OpenapiClient
         :'activity_id' => :'activity_id',
         :'effective_channel_slugs' => :'effective_channel_slugs',
         :'tags' => :'tags',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'ended_activity_id' => :'ended_activity_id',
+        :'message' => :'message',
+        :'errors' => :'errors'
       }
     end
 
@@ -58,7 +69,10 @@ module OpenapiClient
         :'activity_id' => :'String',
         :'effective_channel_slugs' => :'Array<String>',
         :'tags' => :'Array<String>',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'ended_activity_id' => :'String',
+        :'message' => :'String',
+        :'errors' => :'Array<String>'
       }
     end
 
@@ -120,6 +134,20 @@ module OpenapiClient
       else
         self.timestamp = nil
       end
+
+      if attributes.key?(:'ended_activity_id')
+        self.ended_activity_id = attributes[:'ended_activity_id']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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?
@@ -163,7 +191,10 @@ module OpenapiClient
           activity_id == o.activity_id &&
           effective_channel_slugs == o.effective_channel_slugs &&
           tags == o.tags &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          ended_activity_id == o.ended_activity_id &&
+          message == o.message &&
+          errors == o.errors
     end
 
     # @see the `==` method
@@ -175,7 +206,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, tags, timestamp].hash
+      [success, devices_notified, users_notified, activity_id, effective_channel_slugs, tags, timestamp, ended_activity_id, message, errors].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_stream_delete_response.rb

@@ -30,6 +30,22 @@ module OpenapiClient
 
     attr_accessor :timestamp
 
+    # True when the stream was already ended and the request had no effect.
+    attr_accessor :ignored
+
+    attr_accessor :message
+
+    attr_accessor :forced_completion
+
+    # Present when the stream had a current Live Activity. True when the end was sent to at least one device, or queued for a device that has not registered yet. False when no device received it, so the Live Activity may stay on the Lock Screen until iOS removes it or someone dismisses it.
+    attr_accessor :delivered
+
+    # Explains why the end may not have removed the Live Activity, for example because iOS had already ended a Live Activity that started more than 8 hours ago.
+    attr_accessor :warning
+
+    # Per-device delivery errors when some devices could not be reached.
+    attr_accessor :errors
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -61,7 +77,13 @@ module OpenapiClient
         :'activity_id' => :'activity_id',
         :'devices_queued' => :'devices_queued',
         :'devices_notified' => :'devices_notified',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'ignored' => :'ignored',
+        :'message' => :'message',
+        :'forced_completion' => :'forced_completion',
+        :'delivered' => :'delivered',
+        :'warning' => :'warning',
+        :'errors' => :'errors'
       }
     end
 
@@ -79,7 +101,13 @@ module OpenapiClient
         :'activity_id' => :'String',
         :'devices_queued' => :'Integer',
         :'devices_notified' => :'Integer',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'ignored' => :'Boolean',
+        :'message' => :'String',
+        :'forced_completion' => :'Boolean',
+        :'delivered' => :'Boolean',
+        :'warning' => :'String',
+        :'errors' => :'Array<String>'
       }
     end
 
@@ -140,6 +168,32 @@ module OpenapiClient
       else
         self.timestamp = nil
       end
+
+      if attributes.key?(:'ignored')
+        self.ignored = attributes[:'ignored']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'forced_completion')
+        self.forced_completion = attributes[:'forced_completion']
+      end
+
+      if attributes.key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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?
@@ -200,7 +254,13 @@ module OpenapiClient
           activity_id == o.activity_id &&
           devices_queued == o.devices_queued &&
           devices_notified == o.devices_notified &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          ignored == o.ignored &&
+          message == o.message &&
+          forced_completion == o.forced_completion &&
+          delivered == o.delivered &&
+          warning == o.warning &&
+          errors == o.errors
     end
 
     # @see the `==` method
@@ -212,7 +272,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, operation, stream_key, activity_id, devices_queued, devices_notified, timestamp].hash
+      [success, operation, stream_key, activity_id, devices_queued, devices_notified, timestamp, ignored, message, forced_completion, delivered, warning, errors].hash
     end
 
     # Builds the object from hash