activitysmith 1.14.0 → 1.15.0

data/generated/activitysmith_openapi/models/metric_upsert_request.rb

@@ -0,0 +1,370 @@
+=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
+  # Metric definition. Omitted fields keep their current values, or use defaults for a new metric: a label made from the key and the number format.
+  class MetricUpsertRequest
+    # Name shown on the widget.
+    attr_accessor :label
+
+    # How widgets display the value: number (1,234), currency (requires currency_code), percent (send 99.9 to show 99.9%), unit (a number with a unit suffix, such as 120 ms), or string (text up to 64 characters). Defaults to number for a new metric.
+    attr_accessor :format
+
+    # 3-letter ISO 4217 currency code, such as USD. Required for the currency format.
+    attr_accessor :currency_code
+
+    # Unit suffix for the unit format, such as ms or GB.
+    attr_accessor :unit
+
+    # For the unit format: none shows 120ms, space shows 120 ms.
+    attr_accessor :unit_spacing
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'label' => :'label',
+        :'format' => :'format',
+        :'currency_code' => :'currency_code',
+        :'unit' => :'unit',
+        :'unit_spacing' => :'unit_spacing'
+      }
+    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
+      {
+        :'label' => :'String',
+        :'format' => :'String',
+        :'currency_code' => :'String',
+        :'unit' => :'String',
+        :'unit_spacing' => :'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::MetricUpsertRequest` 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::MetricUpsertRequest`. 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?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'unit_spacing')
+        self.unit_spacing = attributes[:'unit_spacing']
+      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 !@label.nil? && @label.to_s.length > 80
+        invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@label.nil? && @label.to_s.length < 1
+        invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z]{3}$/)
+      if !@currency_code.nil? && @currency_code !~ pattern
+        invalid_properties.push("invalid value for \"currency_code\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@unit.nil? && @unit.to_s.length > 16
+        invalid_properties.push('invalid value for "unit", the character length must be smaller than or equal to 16.')
+      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 !@label.nil? && @label.to_s.length > 80
+      return false if !@label.nil? && @label.to_s.length < 1
+      format_validator = EnumAttributeValidator.new('String', ["number", "currency", "percent", "unit", "string"])
+      return false unless format_validator.valid?(@format)
+      return false if !@currency_code.nil? && @currency_code !~ Regexp.new(/^[A-Za-z]{3}$/)
+      return false if !@unit.nil? && @unit.to_s.length > 16
+      unit_spacing_validator = EnumAttributeValidator.new('String', ["none", "space"])
+      return false unless unit_spacing_validator.valid?(@unit_spacing)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      if label.to_s.length > 80
+        fail ArgumentError, 'invalid value for "label", the character length must be smaller than or equal to 80.'
+      end
+
+      if label.to_s.length < 1
+        fail ArgumentError, 'invalid value for "label", the character length must be great than or equal to 1.'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] format Object to be assigned
+    def format=(format)
+      validator = EnumAttributeValidator.new('String', ["number", "currency", "percent", "unit", "string"])
+      unless validator.valid?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
+      end
+      @format = format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_code Value to be assigned
+    def currency_code=(currency_code)
+      if currency_code.nil?
+        fail ArgumentError, 'currency_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z]{3}$/)
+      if currency_code !~ pattern
+        fail ArgumentError, "invalid value for \"currency_code\", must conform to the pattern #{pattern}."
+      end
+
+      @currency_code = currency_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit Value to be assigned
+    def unit=(unit)
+      if unit.nil?
+        fail ArgumentError, 'unit cannot be nil'
+      end
+
+      if unit.to_s.length > 16
+        fail ArgumentError, 'invalid value for "unit", the character length must be smaller than or equal to 16.'
+      end
+
+      @unit = unit
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] unit_spacing Object to be assigned
+    def unit_spacing=(unit_spacing)
+      validator = EnumAttributeValidator.new('String', ["none", "space"])
+      unless validator.valid?(unit_spacing)
+        fail ArgumentError, "invalid value for \"unit_spacing\", must be one of #{validator.allowable_values}."
+      end
+      @unit_spacing = unit_spacing
+    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 &&
+          label == o.label &&
+          format == o.format &&
+          currency_code == o.currency_code &&
+          unit == o.unit &&
+          unit_spacing == o.unit_spacing
+    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
+      [label, format, currency_code, unit, unit_spacing].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/metric_value_update_response.rb

@@ -17,10 +17,14 @@ module OpenapiClient
   class MetricValueUpdateResponse
     attr_accessor :success
 
+    # true when this request created the metric because no metric used the key yet.
+    attr_accessor :created
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'success' => :'success'
+        :'success' => :'success',
+        :'created' => :'created'
       }
     end
 
@@ -32,7 +36,8 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'success' => :'Boolean'
+        :'success' => :'Boolean',
+        :'created' => :'Boolean'
       }
     end
 
@@ -62,6 +67,10 @@ module OpenapiClient
       else
         self.success = nil
       end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +98,8 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          success == o.success
+          success == o.success &&
+          created == o.created
     end
 
     # @see the `==` method
@@ -101,7 +111,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success].hash
+      [success, created].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/no_recipients_error.rb

@@ -17,15 +17,23 @@ module OpenapiClient
   class NoRecipientsError
     attr_accessor :error
 
+    # Machine-readable reason. no_paired_devices: the account has no active paired iOS devices; pair an iPhone with the ActivitySmith app. no_recipients_found: devices are paired, but none matched the targeted channels. Treat unknown values as a generic no-delivery error.
+    attr_accessor :code
+
     attr_accessor :message
 
+    # ActivitySmith App Store link. Present when code is no_paired_devices.
+    attr_accessor :app_store_url
+
     attr_accessor :effective_channel_slugs
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'error' => :'error',
+        :'code' => :'code',
         :'message' => :'message',
+        :'app_store_url' => :'app_store_url',
         :'effective_channel_slugs' => :'effective_channel_slugs'
       }
     end
@@ -39,7 +47,9 @@ module OpenapiClient
     def self.openapi_types
       {
         :'error' => :'String',
+        :'code' => :'String',
         :'message' => :'String',
+        :'app_store_url' => :'String',
         :'effective_channel_slugs' => :'Array<String>'
       }
     end
@@ -71,12 +81,20 @@ module OpenapiClient
         self.error = nil
       end
 
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
       if attributes.key?(:'message')
         self.message = attributes[:'message']
       else
         self.message = nil
       end
 
+      if attributes.key?(:'app_store_url')
+        self.app_store_url = attributes[:'app_store_url']
+      end
+
       if attributes.key?(:'effective_channel_slugs')
         if (value = attributes[:'effective_channel_slugs']).is_a?(Array)
           self.effective_channel_slugs = value
@@ -115,7 +133,9 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           error == o.error &&
+          code == o.code &&
           message == o.message &&
+          app_store_url == o.app_store_url &&
           effective_channel_slugs == o.effective_channel_slugs
     end
 
@@ -128,7 +148,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, message, effective_channel_slugs].hash
+      [error, code, message, app_store_url, effective_channel_slugs].hash
     end
 
     # Builds the object from hash