activitysmith 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7049fc74d1e6413d076f29460c876e25eed8288a443f083d4f67286098efcb72
-  data.tar.gz: 6240b7a43f373237b794dcbf04654211b5a1c97f3796b949f16bdf9a8a17d92b
+  metadata.gz: 4d97dda055e4f02cb5a23a068d6cf926aa298df90d535ed90b04f04a054274d5
+  data.tar.gz: 1f7207214477f6dad9a1421b57664f644d181234e061e554531f461f5cfd9ad7
 SHA512:
-  metadata.gz: d033284e3d2e932d928096037880a61a34650e233578244cc70819b4d8bf04a019dc67b74c42d693a372978a2bf1e7882bb674aa8c6e4830b722642246dc8fbd
-  data.tar.gz: be32ed8bc216d5710ab192b542df9e3f8ac4528e476acdccfb35502997cc561d14a603e839f5529e47b1b32a0273fd46f92ca468f2c1330b9f3acc95f2306ecc
+  metadata.gz: 4b458cd36f4170e00116fe5e443a4e4590ea9c1d1d9b493d49daced2b3bf41b70ed0a6e9d5a2fc5e0a625e07fdfb7b61ac84125d099f5abba024fa0f60678ce1
+  data.tar.gz: a544c93e039ed071d9f0627d406f6577ca63ed03db7d160f719e0b37a66ec725b15a8696cefa8ef971ed51aea66cdb18fb3e9e022b8eda98dda939f9c510248a

data/README.md

@@ -17,6 +17,7 @@ See [API reference](https://activitysmith.com/docs/api-reference/introduction).
 - [Live Activities](#live-activities)
   - [Simple: Let ActivitySmith manage the Live Activity for you](#simple-let-activitysmith-manage-the-live-activity-for-you)
   - [Advanced: Full lifecycle control](#advanced-full-lifecycle-control)
+  - [Stats Type](#stats-type)
   - [Metrics Type](#metrics-type)
   - [Segmented Progress Type](#segmented-progress-type)
   - [Progress Type](#progress-type)
@@ -127,8 +128,9 @@ activitysmith.notifications.send(
   <img src="https://cdn.activitysmith.com/features/metrics-live-activity-action.png" alt="Metrics Live Activity screenshot" width="680" />
 </p>
 
-There are three types of Live Activities:
+There are four types of Live Activities:
 
+- `stats`: best for compact business or product stats like revenue, orders, conversion, and average order value
 - `metrics`: best for live operational stats like server CPU and memory, queue depth, or replica lag
 - `segmented_progress`: best for step-based workflows like deployments, backups, and ETL pipelines
 - `progress`: best for continuous jobs like uploads, reindexes, and long-running migrations tracked as a percentage
@@ -155,6 +157,33 @@ such as a server, deployment, build pipeline, cron job, or charging session.
 This is especially useful for cron jobs and other scheduled tasks where you do
 not want to store `activity_id` between runs.
 
+#### Stats
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/stats-live-activity.png" alt="Stats stream example" width="680" />
+</p>
+
+```ruby
+status = activitysmith.live_activities.stream(
+  "sales-hourly",
+  {
+    content_state: {
+      title: "Sales",
+      subtitle: "last hour",
+      type: "stats",
+      metrics: [
+        { label: "Revenue", value: "$2430", color: "blue" },
+        { label: "Orders", value: "37", color: "green" },
+        { label: "Conversion", value: "4.8%", color: "magenta" },
+        { label: "Avg Order", value: "$65.68", color: "yellow" },
+        { label: "Refunds", value: "$84", color: "red" },
+        { label: "New Buyers", value: "18", color: "cyan" }
+      ]
+    }
+  }
+)
+```
+
 #### Metrics
 
 <p align="center">
@@ -265,6 +294,89 @@ Use these methods when you want to manage the Live Activity lifecycle yourself:
 3. Call `activitysmith.live_activities.update(...)` as progress changes.
 4. Call `activitysmith.live_activities.end(...)` when the work is finished.
 
+### Stats Type
+
+Keep your key numbers on your Lock Screen. `stats` fits 1 to 8 labeled values,
+such as revenue, orders, conversion, uptime, or any other business metric you
+want visible at a glance. Each metric can use a formatted string or number as
+its `value`. Add `color` to a metric to show an accent dot next to its label;
+omit `color` to show the label without a dot.
+
+#### Start
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/stats-live-activity.png" alt="Stats Live Activity with sales revenue, orders, conversion, and average order value" width="680" />
+</p>
+
+```ruby
+start = activitysmith.live_activities.start(
+  {
+    content_state: {
+      title: "Sales",
+      subtitle: "last hour",
+      type: "stats",
+      metrics: [
+        { label: "Revenue", value: "$2430", color: "blue" },
+        { label: "Orders", value: "37", color: "green" },
+        { label: "Conversion", value: "4.8%", color: "magenta" },
+        { label: "Avg Order", value: "$65.68", color: "yellow" },
+        { label: "Refunds", value: "$84", color: "red" },
+        { label: "New Buyers", value: "18", color: "cyan" }
+      ]
+    }
+  }
+)
+
+activity_id = start.activity_id
+```
+
+#### Update
+
+```ruby
+activitysmith.live_activities.update(
+  {
+    activity_id: activity_id,
+    content_state: {
+      title: "Sales",
+      subtitle: "last hour",
+      type: "stats",
+      metrics: [
+        { label: "Revenue", value: "$3180", color: "blue" },
+        { label: "Orders", value: "51", color: "green" },
+        { label: "Conversion", value: "5.2%", color: "magenta" },
+        { label: "Avg Order", value: "$62.35", color: "yellow" },
+        { label: "Refunds", value: "$126", color: "red" },
+        { label: "New Buyers", value: "24", color: "cyan" }
+      ]
+    }
+  }
+)
+```
+
+#### End
+
+```ruby
+activitysmith.live_activities.end(
+  {
+    activity_id: activity_id,
+    content_state: {
+      title: "Sales",
+      subtitle: "last hour",
+      type: "stats",
+      metrics: [
+        { label: "Revenue", value: "$3460", color: "blue" },
+        { label: "Orders", value: "58", color: "green" },
+        { label: "Conversion", value: "5.4%", color: "magenta" },
+        { label: "Avg Order", value: "$59.66", color: "yellow" },
+        { label: "Refunds", value: "$92", color: "red" },
+        { label: "New Buyers", value: "31", color: "cyan" }
+      ],
+      auto_dismiss_minutes: 2
+    }
+  }
+)
+```
+
 ### Metrics Type
 
 Use `metrics` when you want to keep a small set of live stats visible, such as
@@ -561,7 +673,7 @@ activitysmith.notifications.send(
   <img src="https://cdn.activitysmith.com/features/lock-screen-widgets.png" alt="Lock screen widgets" width="680" />
 </p>
 
-ActivitySmith lets you display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track. Create a metric in the web app, then update the metric value using our API, add a widget to your lock screen and it will fetch the latest update automatically.
+ActivitySmith lets you display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track. Create a metric in the <a href="https://activitysmith.com/app/widgets" target="_blank" rel="noopener noreferrer">web app</a>, then update the metric value using our API, add a widget to your lock screen and it will fetch the latest update automatically.
 
 <p align="center">
   <img src="https://cdn.activitysmith.com/features/create-widget-metric.png" alt="Create widget metric" width="680" />

data/generated/activitysmith_openapi/api/live_activities_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # End a Live Activity
-    # Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
     # @param live_activity_end_request [LiveActivityEndRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityEndResponse]
@@ -30,7 +30,7 @@ module OpenapiClient
     end
 
     # End a Live Activity
-    # Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
     # @param live_activity_end_request [LiveActivityEndRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityEndResponse, Integer, Hash)>] LiveActivityEndResponse data, response status code and response headers
@@ -250,7 +250,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity
-    # Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityStartResponse]
@@ -260,7 +260,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity
-    # Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityStartResponse, Integer, Hash)>] LiveActivityStartResponse data, response status code and response headers
@@ -318,7 +318,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity
-    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityUpdateResponse]
@@ -328,7 +328,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity
-    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, and metrics activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityUpdateResponse, Integer, Hash)>] LiveActivityUpdateResponse data, response status code and response headers

data/generated/activitysmith_openapi/api/metrics_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # Update a widget metric value
-    # Updates the latest value for a metric configured in ActivitySmith widgets. Create the metric in the web app first, then write values using its key. Numeric metric formats accept finite numbers. String metrics accept non-empty text up to 64 characters.
+    # Updates the latest value for a metric displayed in ActivitySmith widgets. Create the metric in the web app first, then update its value using the key.
     # @param key [String] Metric key configured in the web app. Lowercase letters, numbers, dots, underscores, and dashes are allowed.
     # @param metric_value_update_request [MetricValueUpdateRequest] 
     # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module OpenapiClient
     end
 
     # Update a widget metric value
-    # Updates the latest value for a metric configured in ActivitySmith widgets. Create the metric in the web app first, then write values using its key. Numeric metric formats accept finite numbers. String metrics accept non-empty text up to 64 characters.
+    # Updates the latest value for a metric displayed in ActivitySmith widgets. Create the metric in the web app first, then update its value using the key.
     # @param key [String] Metric key configured in the web app. Lowercase letters, numbers, dots, underscores, and dashes are allowed.
     # @param metric_value_update_request [MetricValueUpdateRequest] 
     # @param [Hash] opts the optional parameters

data/generated/activitysmith_openapi/models/activity_metric.rb

@@ -21,12 +21,38 @@ module OpenapiClient
 
     attr_accessor :unit
 
+    # Optional per-metric accent color for metrics and stats activities.
+    attr_accessor :color
+
+    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',
         :'value' => :'value',
-        :'unit' => :'unit'
+        :'unit' => :'unit',
+        :'color' => :'color'
       }
     end
 
@@ -39,8 +65,9 @@ module OpenapiClient
     def self.openapi_types
       {
         :'label' => :'String',
-        :'value' => :'Float',
-        :'unit' => :'String'
+        :'value' => :'ActivityMetricValue',
+        :'unit' => :'String',
+        :'color' => :'String'
       }
     end
 
@@ -80,6 +107,10 @@ module OpenapiClient
       if attributes.key?(:'unit')
         self.unit = attributes[:'unit']
       end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -99,14 +130,6 @@ module OpenapiClient
         invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
 
-      if @value > 100
-        invalid_properties.push('invalid value for "value", must be smaller than or equal to 100.')
-      end
-
-      if @value < 0
-        invalid_properties.push('invalid value for "value", must be greater than or equal to 0.')
-      end
-
       invalid_properties
     end
 
@@ -117,8 +140,8 @@ module OpenapiClient
       return false if @label.nil?
       return false if @label.to_s.length < 1
       return false if @value.nil?
-      return false if @value > 100
-      return false if @value < 0
+      color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      return false unless color_validator.valid?(@color)
       true
     end
 
@@ -136,22 +159,14 @@ module OpenapiClient
       @label = label
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] value Value to be assigned
-    def value=(value)
-      if value.nil?
-        fail ArgumentError, 'value cannot be nil'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] color Object to be assigned
+    def color=(color)
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      unless validator.valid?(color)
+        fail ArgumentError, "invalid value for \"color\", must be one of #{validator.allowable_values}."
       end
-
-      if value > 100
-        fail ArgumentError, 'invalid value for "value", must be smaller than or equal to 100.'
-      end
-
-      if value < 0
-        fail ArgumentError, 'invalid value for "value", must be greater than or equal to 0.'
-      end
-
-      @value = value
+      @color = color
     end
 
     # Checks equality by comparing each attribute.
@@ -161,7 +176,8 @@ module OpenapiClient
       self.class == o.class &&
           label == o.label &&
           value == o.value &&
-          unit == o.unit
+          unit == o.unit &&
+          color == o.color
     end
 
     # @see the `==` method
@@ -173,7 +189,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [label, value, unit].hash
+      [label, value, unit, color].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/{widget_metric_latest_value.rb → activity_metric_value.rb}

@@ -14,11 +14,10 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Latest metric value. Numeric formats return a number. String metrics return text.
-  module WidgetMetricLatestValue
+  module ActivityMetricValue
     class << self
-      # List of class defined in anyOf (OpenAPI v3)
-      def openapi_any_of
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
         [
           :'Float',
           :'String'
@@ -26,16 +25,17 @@ module OpenapiClient
       end
 
       # Builds the object
-      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @param [Mixed] Data to be matched against the list of oneOf items
       # @return [Object] Returns the model or the data itself
       def build(data)
-        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
         # Note:
+        # - We do not attempt to check whether exactly one item matches.
         # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
         #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
         # - TODO: scalar values are de facto behaving as if they were nullable.
         # - TODO: logging when debugging is set.
-        openapi_any_of.each do |klass|
+        openapi_one_of.each do |klass|
           begin
             next if klass == :AnyType # "nullable: true"
             typed_data = find_and_cast_into_type(klass, data)
@@ -44,7 +44,7 @@ module OpenapiClient
           end
         end
 
-        openapi_any_of.include?(:AnyType) ? data : nil
+        openapi_one_of.include?(:AnyType) ? data : nil
       end
 
       private
@@ -83,7 +83,7 @@ module OpenapiClient
         else # model
           const = OpenapiClient.const_get(klass)
           if const
-            if const.respond_to?(:openapi_any_of) # nested anyOf model
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
               model = const.build(data)
               return model if model
             else

data/generated/activitysmith_openapi/models/content_state_end.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
+  # End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
   class ContentStateEnd
     attr_accessor :title
 
@@ -35,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     # Optional. When omitted, the API uses the existing Live Activity type.
@@ -227,6 +227,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      end
+
       if !@metrics.nil? && @metrics.length < 1
         invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
       end
@@ -247,8 +251,9 @@ module OpenapiClient
       return false if !@current_step.nil? && @current_step < 1
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
+      return false if !@metrics.nil? && @metrics.length > 8
       return false if !@metrics.nil? && @metrics.length < 1
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       return false unless type_validator.valid?(@type)
       color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
       return false unless color_validator.valid?(@color)
@@ -311,6 +316,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -321,7 +330,7 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/generated/activitysmith_openapi/models/content_state_start.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Start payload requires title and type. For segmented_progress include number_of_steps and current_step. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
+  # Start payload requires title and type. For segmented_progress include number_of_steps and current_step. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
   class ContentStateStart
     attr_accessor :title
 
@@ -35,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     attr_accessor :type
@@ -217,6 +217,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      end
+
       if !@metrics.nil? && @metrics.length < 1
         invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
       end
@@ -237,9 +241,10 @@ module OpenapiClient
       return false if !@current_step.nil? && @current_step < 1
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
+      return false if !@metrics.nil? && @metrics.length > 8
       return false if !@metrics.nil? && @metrics.length < 1
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       return false unless type_validator.valid?(@type)
       color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
       return false unless color_validator.valid?(@color)
@@ -301,6 +306,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -311,7 +320,7 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/generated/activitysmith_openapi/models/content_state_update.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
+  # Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
   class ContentStateUpdate
     attr_accessor :title
 
@@ -35,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     # Optional. When omitted, the API uses the existing Live Activity type.
@@ -216,6 +216,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      end
+
       if !@metrics.nil? && @metrics.length < 1
         invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
       end
@@ -232,8 +236,9 @@ module OpenapiClient
       return false if !@current_step.nil? && @current_step < 1
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
+      return false if !@metrics.nil? && @metrics.length > 8
       return false if !@metrics.nil? && @metrics.length < 1
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       return false unless type_validator.valid?(@type)
       color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
       return false unless color_validator.valid?(@color)
@@ -295,6 +300,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -305,7 +314,7 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end