activitysmith 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ceddf3ae5045d286636cd3fa23783c922dc649b79e04ec96920994fbbf20e4
-  data.tar.gz: 3beeee49f2549b2d76db40ad5ab3e68ebc47b19513090780ac1dbc8891599edb
+  metadata.gz: d2f19ff232a66a24046463a9e5c902981f4f6372c5f5b159c5c4dbd34599bfc3
+  data.tar.gz: 770153b7ebc383f129c2c19247e452bce49786171d1e32a02b919e49648cee43
 SHA512:
-  metadata.gz: 82dac88237bf62fd4b7d9895d235a65d6b85cda0818a36808b6851779977e70b13e2f5e1066104f1590fda9b3d4f250198cb85da57c3a18fe3027ea5b0c9142f
-  data.tar.gz: f0f9ed517c2fbe3e870061ce4ae7240b4efa93e66965f5c0779a79b9bbb0b5784fcb5e86eeba4d8d65a842a670f4aaa8d9895a0fbea5e0685789fa961c11139f
+  metadata.gz: ec35e8a04066ec01d2b17aafd100f9ee82107a1645149999c2095f8565e8e92a16fbcb05fae09330aa199912093c8ff982278660a538c074a4c15c61f3803b55
+  data.tar.gz: acdfddcc23f59dba508b71e4711a59d6084b37c74eb0303e386502ab50518b25f460671128a2ac0842c723ba095759ee21a2043392ad75689e999f376a5aaa40

data/README.md

@@ -20,7 +20,7 @@ require "activitysmith"
 activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_KEY"))
 ```
 
-## Usage
+## Push Notifications
 
 ### Send a Push Notification
 
@@ -29,15 +29,78 @@ activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_
 </p>
 
 ```ruby
-response = activitysmith.notifications.send(
+activitysmith.notifications.send(
   {
     title: "New subscription 💸",
     message: "Customer upgraded to Pro plan"
   }
 )
+```
+
+### Rich Push Notifications with Media
 
-puts response.success
-puts response.devices_notified
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-image.png" alt="Rich push notification with image" width="680" />
+</p>
+
+```ruby
+activitysmith.notifications.send(
+  {
+    title: "Homepage ready",
+    message: "Your agent finished the redesign.",
+    media: "https://cdn.example.com/output/homepage-v2.png",
+    redirection: "https://github.com/acme/web/pull/482"
+  }
+)
+```
+
+Send images, videos, or audio with your push notifications, press and hold to preview media directly from the notification, then tap through to open the linked content.
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-audio.png" alt="Rich push notification with audio" width="680" />
+</p>
+
+What will work:
+
+- direct image URL: `.jpg`, `.png`, `.gif`, etc.
+- direct audio file URL: `.mp3`, `.m4a`, etc.
+- direct video file URL: `.mp4`, `.mov`, etc.
+- URL that responds with a proper media `Content-Type`, even if the path has no extension
+
+### Actionable Push Notifications
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/actionable-push-notifications-2.png" alt="Actionable push notification example" width="680" />
+</p>
+
+Actionable push notifications can open a URL on tap or trigger actions when someone long-presses the notification.
+Webhooks are executed by the ActivitySmith backend.
+
+```ruby
+activitysmith.notifications.send(
+  {
+    title: "New subscription 💸",
+    message: "Customer upgraded to Pro plan",
+    redirection: "https://crm.example.com/customers/cus_9f3a1d", # Optional
+    actions: [ # Optional (max 4)
+      {
+        title: "Open CRM Profile",
+        type: "open_url",
+        url: "https://crm.example.com/customers/cus_9f3a1d"
+      },
+      {
+        title: "Start Onboarding Workflow",
+        type: "webhook",
+        url: "https://hooks.example.com/activitysmith/onboarding/start",
+        method: "POST",
+        body: {
+          customer_id: "cus_9f3a1d",
+          plan: "pro"
+        }
+      }
+    ]
+  }
+)
 ```
 
 ## Live Activities
@@ -95,7 +158,7 @@ activity_id = start.activity_id
 </p>
 
 ```ruby
-update = activitysmith.live_activities.update(
+activitysmith.live_activities.update(
   {
     activity_id: activity_id,
     content_state: {
@@ -106,8 +169,6 @@ update = activitysmith.live_activities.update(
     }
   }
 )
-
-puts update.devices_notified
 ```
 
 #### End
@@ -117,7 +178,7 @@ puts update.devices_notified
 </p>
 
 ```ruby
-finish = activitysmith.live_activities.end(
+activitysmith.live_activities.end(
   {
     activity_id: activity_id,
     content_state: {
@@ -129,8 +190,6 @@ finish = activitysmith.live_activities.end(
     }
   }
 )
-
-puts finish.success
 ```
 
 ### Progress Type
@@ -200,48 +259,73 @@ activitysmith.live_activities.end(
 )
 ```
 
-## Channels
+### Live Activity Action
 
-Channels are used to target specific team members or devices. Can be used for both push notifications and live activities.
+Just like Actionable Push Notifications, Live Activities can have a button that opens provided URL in a browser or triggers a webhook. Webhooks are executed by the ActivitySmith backend.
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/live-activity-with-action.png?v=20260319-1" alt="Live Activity with action" width="680" />
+</p>
+
+#### Open URL action
 
 ```ruby
-response = activitysmith.notifications.send(
+start = activitysmith.live_activities.start(
   {
-    title: "New subscription 💸",
-    message: "Customer upgraded to Pro plan",
-    channels: ["sales", "customer-success"] # Optional
+    content_state: {
+      title: "Deploying payments-api",
+      subtitle: "Running database migrations",
+      number_of_steps: 5,
+      current_step: 3,
+      type: "segmented_progress"
+    },
+    action: {
+      title: "Open Workflow",
+      type: "open_url",
+      url: "https://github.com/acme/payments-api/actions/runs/1234567890"
+    }
   }
 )
+
+activity_id = start.activity_id
 ```
 
-## Push Notification Redirection and Actions
+#### Webhook action
 
-Push notification redirection and actions are optional and can be used to redirect the user to a specific URL when they tap the notification or to trigger a specific action when they long-press the notification.
-Webhooks are executed by ActivitySmith backend.
+```ruby
+activitysmith.live_activities.update(
+  {
+    activity_id: activity_id,
+    content_state: {
+      title: "Reindexing product search",
+      subtitle: "Shard 7 of 12",
+      number_of_steps: 12,
+      current_step: 7
+    },
+    action: {
+      title: "Pause Reindex",
+      type: "webhook",
+      url: "https://ops.example.com/hooks/search/reindex/pause",
+      method: "POST",
+      body: {
+        job_id: "reindex-2026-03-19",
+        requested_by: "activitysmith-ruby"
+      }
+    }
+  }
+)
+```
+
+## Channels
+
+Channels are used to target specific team members or devices. Can be used for both push notifications and live activities.
 
 ```ruby
-response = activitysmith.notifications.send(
+activitysmith.notifications.send(
   {
     title: "New subscription 💸",
     message: "Customer upgraded to Pro plan",
-    redirection: "https://crm.example.com/customers/cus_9f3a1d", # Optional
-    actions: [ # Optional (max 4)
-      {
-        title: "Open CRM Profile",
-        type: "open_url",
-        url: "https://crm.example.com/customers/cus_9f3a1d"
-      },
-      {
-        title: "Start Onboarding Workflow",
-        type: "webhook",
-        url: "https://hooks.example.com/activitysmith/onboarding/start",
-        method: "POST",
-        body: {
-          customer_id: "cus_9f3a1d",
-          plan: "pro"
-        }
-      }
-    ]
+    channels: ["sales", "customer-success"] # Optional
   }
 )
 ```

data/generated/activitysmith_openapi/api/push_notifications_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PushNotificationResponse]
@@ -30,7 +30,7 @@ module OpenapiClient
     end
 
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PushNotificationResponse, Integer, Hash)>] PushNotificationResponse data, response status code and response headers

data/generated/activitysmith_openapi/models/live_activity_action.rb

@@ -0,0 +1,323 @@
+=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
+  # Optional single action button shown in the Live Activity UI.
+  class LiveActivityAction
+    # Button title displayed in the Live Activity UI.
+    attr_accessor :title
+
+    attr_accessor :type
+
+    # HTTPS URL. For open_url it is opened in browser. For webhook it is called by ActivitySmith backend.
+    attr_accessor :url
+
+    # Webhook HTTP method. Used only when type=webhook.
+    attr_accessor :method
+
+    # Optional webhook payload body. Used only when type=webhook.
+    attr_accessor :body
+
+    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
+      {
+        :'title' => :'title',
+        :'type' => :'type',
+        :'url' => :'url',
+        :'method' => :'method',
+        :'body' => :'body'
+      }
+    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
+      {
+        :'title' => :'String',
+        :'type' => :'LiveActivityActionType',
+        :'url' => :'String',
+        :'method' => :'LiveActivityWebhookMethod',
+        :'body' => :'Hash<String, Object>'
+      }
+    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::LiveActivityAction` 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::LiveActivityAction`. 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?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = 'POST'
+      end
+
+      if attributes.key?(:'body')
+        if (value = attributes[:'body']).is_a?(Hash)
+          self.body = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if @url !~ pattern
+        invalid_properties.push("invalid value for \"url\", must conform to the pattern #{pattern}.")
+      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 @title.nil?
+      return false if @type.nil?
+      return false if @url.nil?
+      return false if @url !~ Regexp.new(/^https:\/\//)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if url !~ pattern
+        fail ArgumentError, "invalid value for \"url\", must conform to the pattern #{pattern}."
+      end
+
+      @url = url
+    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 &&
+          title == o.title &&
+          type == o.type &&
+          url == o.url &&
+          method == o.method &&
+          body == o.body
+    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
+      [title, type, url, method, body].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_type.rb

@@ -0,0 +1,40 @@
+=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 LiveActivityActionType
+    OPEN_URL = "open_url".freeze
+    WEBHOOK = "webhook".freeze
+
+    def self.all_vars
+      @all_vars ||= [OPEN_URL, WEBHOOK].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if LiveActivityActionType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #LiveActivityActionType"
+    end
+  end
+end

data/generated/activitysmith_openapi/models/live_activity_end_request.rb

@@ -20,11 +20,14 @@ module OpenapiClient
 
     attr_accessor :content_state
 
+    attr_accessor :action
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'activity_id' => :'activity_id',
-        :'content_state' => :'content_state'
+        :'content_state' => :'content_state',
+        :'action' => :'action'
       }
     end
 
@@ -37,7 +40,8 @@ module OpenapiClient
     def self.openapi_types
       {
         :'activity_id' => :'String',
-        :'content_state' => :'ContentStateEnd'
+        :'content_state' => :'ContentStateEnd',
+        :'action' => :'LiveActivityAction'
       }
     end
 
@@ -73,6 +77,10 @@ module OpenapiClient
       else
         self.content_state = nil
       end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +114,8 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           activity_id == o.activity_id &&
-          content_state == o.content_state
+          content_state == o.content_state &&
+          action == o.action
     end
 
     # @see the `==` method
@@ -118,7 +127,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [activity_id, content_state].hash
+      [activity_id, content_state, action].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_start_request.rb

@@ -18,6 +18,8 @@ module OpenapiClient
   class LiveActivityStartRequest
     attr_accessor :content_state
 
+    attr_accessor :action
+
     attr_accessor :alert
 
     attr_accessor :target
@@ -26,6 +28,7 @@ module OpenapiClient
     def self.attribute_map
       {
         :'content_state' => :'content_state',
+        :'action' => :'action',
         :'alert' => :'alert',
         :'target' => :'target'
       }
@@ -40,6 +43,7 @@ module OpenapiClient
     def self.openapi_types
       {
         :'content_state' => :'ContentStateStart',
+        :'action' => :'LiveActivityAction',
         :'alert' => :'AlertPayload',
         :'target' => :'ChannelTarget'
       }
@@ -72,6 +76,10 @@ module OpenapiClient
         self.content_state = nil
       end
 
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
+
       if attributes.key?(:'alert')
         self.alert = attributes[:'alert']
       end
@@ -107,6 +115,7 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           content_state == o.content_state &&
+          action == o.action &&
           alert == o.alert &&
           target == o.target
     end
@@ -120,7 +129,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_state, alert, target].hash
+      [content_state, action, alert, target].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_update_request.rb

@@ -20,11 +20,14 @@ module OpenapiClient
 
     attr_accessor :content_state
 
+    attr_accessor :action
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'activity_id' => :'activity_id',
-        :'content_state' => :'content_state'
+        :'content_state' => :'content_state',
+        :'action' => :'action'
       }
     end
 
@@ -37,7 +40,8 @@ module OpenapiClient
     def self.openapi_types
       {
         :'activity_id' => :'String',
-        :'content_state' => :'ContentStateUpdate'
+        :'content_state' => :'ContentStateUpdate',
+        :'action' => :'LiveActivityAction'
       }
     end
 
@@ -73,6 +77,10 @@ module OpenapiClient
       else
         self.content_state = nil
       end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +114,8 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           activity_id == o.activity_id &&
-          content_state == o.content_state
+          content_state == o.content_state &&
+          action == o.action
     end
 
     # @see the `==` method
@@ -118,7 +127,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [activity_id, content_state].hash
+      [activity_id, content_state, action].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_webhook_method.rb

@@ -0,0 +1,40 @@
+=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 LiveActivityWebhookMethod
+    GET = "GET".freeze
+    POST = "POST".freeze
+
+    def self.all_vars
+      @all_vars ||= [GET, POST].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if LiveActivityWebhookMethod.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #LiveActivityWebhookMethod"
+    end
+  end
+end

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -21,10 +21,13 @@ module OpenapiClient
 
     attr_accessor :subtitle
 
-    # Optional HTTPS URL opened when user taps the notification body.
+    # Optional HTTPS URL for an image, audio file, or video that users can preview or play when they expand the notification. If `redirection` is omitted, tapping the notification opens this URL. Cannot be combined with `actions`.
+    attr_accessor :media
+
+    # Optional HTTPS URL opened when user taps the notification body. Overrides the default tap target from `media` when both are provided.
     attr_accessor :redirection
 
-    # Optional interactive actions shown on iOS long-press.
+    # Optional interactive actions shown when users expand the notification. Cannot be combined with `media`.
     attr_accessor :actions
 
     attr_accessor :payload
@@ -41,6 +44,7 @@ module OpenapiClient
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
+        :'media' => :'media',
         :'redirection' => :'redirection',
         :'actions' => :'actions',
         :'payload' => :'payload',
@@ -61,6 +65,7 @@ module OpenapiClient
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
+        :'media' => :'String',
         :'redirection' => :'String',
         :'actions' => :'Array<PushNotificationAction>',
         :'payload' => :'Hash<String, Object>',
@@ -105,6 +110,10 @@ module OpenapiClient
         self.subtitle = attributes[:'subtitle']
       end
 
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      end
+
       if attributes.key?(:'redirection')
         self.redirection = attributes[:'redirection']
       end
@@ -143,6 +152,11 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
+      pattern = Regexp.new(/^https:\/\//)
+      if !@media.nil? && @media !~ pattern
+        invalid_properties.push("invalid value for \"media\", must conform to the pattern #{pattern}.")
+      end
+
       pattern = Regexp.new(/^https:\/\//)
       if !@redirection.nil? && @redirection !~ pattern
         invalid_properties.push("invalid value for \"redirection\", must conform to the pattern #{pattern}.")
@@ -160,11 +174,27 @@ module OpenapiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
+      return false if !@media.nil? && @media !~ Regexp.new(/^https:\/\//)
       return false if !@redirection.nil? && @redirection !~ Regexp.new(/^https:\/\//)
       return false if !@actions.nil? && @actions.length > 4
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] media Value to be assigned
+    def media=(media)
+      if media.nil?
+        fail ArgumentError, 'media cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if media !~ pattern
+        fail ArgumentError, "invalid value for \"media\", must conform to the pattern #{pattern}."
+      end
+
+      @media = media
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] redirection Value to be assigned
     def redirection=(redirection)
@@ -202,6 +232,7 @@ module OpenapiClient
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
+          media == o.media &&
           redirection == o.redirection &&
           actions == o.actions &&
           payload == o.payload &&
@@ -219,7 +250,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, message, subtitle, redirection, actions, payload, badge, sound, target].hash
+      [title, message, subtitle, media, redirection, actions, payload, badge, sound, target].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.7.0
 =end
 
 module OpenapiClient
-  VERSION = '0.1.6'
+  VERSION = '1.0.0'
 end

data/generated/activitysmith_openapi.rb

@@ -24,6 +24,8 @@ require 'activitysmith_openapi/models/content_state_end'
 require 'activitysmith_openapi/models/content_state_start'
 require 'activitysmith_openapi/models/content_state_update'
 require 'activitysmith_openapi/models/forbidden_error'
+require 'activitysmith_openapi/models/live_activity_action'
+require 'activitysmith_openapi/models/live_activity_action_type'
 require 'activitysmith_openapi/models/live_activity_end_request'
 require 'activitysmith_openapi/models/live_activity_end_response'
 require 'activitysmith_openapi/models/live_activity_limit_error'
@@ -31,6 +33,7 @@ require 'activitysmith_openapi/models/live_activity_start_request'
 require 'activitysmith_openapi/models/live_activity_start_response'
 require 'activitysmith_openapi/models/live_activity_update_request'
 require 'activitysmith_openapi/models/live_activity_update_response'
+require 'activitysmith_openapi/models/live_activity_webhook_method'
 require 'activitysmith_openapi/models/no_recipients_error'
 require 'activitysmith_openapi/models/push_notification_action'
 require 'activitysmith_openapi/models/push_notification_action_type'

data/lib/activitysmith/client.rb

@@ -11,6 +11,7 @@ module ActivitySmith
 
       config = OpenapiClient::Configuration.new
       config.access_token = api_key
+      config.user_agent = VersionedUserAgent.value if config.respond_to?(:user_agent=)
 
       api_client = OpenapiClient::ApiClient.new(config)
       @notifications = Notifications.new(OpenapiClient::PushNotificationsApi.new(api_client))

data/lib/activitysmith/notifications.rb

@@ -7,12 +7,16 @@ module ActivitySmith
     end
 
     def send(request, opts = {})
-      @api.send_push_notification(normalize_channels_target(request), opts)
+      normalized = normalize_channels_target(request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     # Backward-compatible alias.
     def send_push_notification(push_notification_request, opts = {})
-      @api.send_push_notification(normalize_channels_target(push_notification_request), opts)
+      normalized = normalize_channels_target(push_notification_request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     def method_missing(name, *args, &block)
@@ -49,5 +53,29 @@ module ActivitySmith
         []
       end
     end
+
+    def assert_valid_media_actions!(request)
+      media = request_value(request, :media)
+      actions = request_value(request, :actions)
+      has_media = media.is_a?(String) ? !media.strip.empty? : !media.nil?
+      has_actions = actions.respond_to?(:empty?) ? !actions.empty? : !actions.nil?
+
+      return unless has_media && has_actions
+
+      raise ArgumentError, "ActivitySmith: media cannot be combined with actions"
+    end
+
+    def request_value(request, key)
+      if request.is_a?(Hash)
+        return request[key] if request.key?(key)
+        return request[key.to_s] if request.key?(key.to_s)
+
+        return nil
+      end
+
+      return request.public_send(key) if request.respond_to?(key)
+
+      nil
+    end
   end
 end

data/lib/activitysmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivitySmith
-  VERSION = "0.1.6"
+  VERSION = "1.0.0"
 end

data/lib/activitysmith/versioned_user_agent.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActivitySmith
+  module VersionedUserAgent
+    def self.value
+      "activitysmith-ruby/#{ActivitySmith::VERSION}"
+    end
+  end
+end

data/lib/activitysmith.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "activitysmith/version"
+require_relative "activitysmith/versioned_user_agent"
 require_relative "activitysmith/notifications"
 require_relative "activitysmith/live_activities"
 require_relative "activitysmith/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitysmith
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - ActivitySmith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-10 00:00:00.000000000 Z
+date: 2026-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -88,6 +88,8 @@ files:
 - generated/activitysmith_openapi/models/content_state_start.rb
 - generated/activitysmith_openapi/models/content_state_update.rb
 - generated/activitysmith_openapi/models/forbidden_error.rb
+- generated/activitysmith_openapi/models/live_activity_action.rb
+- generated/activitysmith_openapi/models/live_activity_action_type.rb
 - generated/activitysmith_openapi/models/live_activity_end_request.rb
 - generated/activitysmith_openapi/models/live_activity_end_response.rb
 - generated/activitysmith_openapi/models/live_activity_limit_error.rb
@@ -95,6 +97,7 @@ files:
 - generated/activitysmith_openapi/models/live_activity_start_response.rb
 - generated/activitysmith_openapi/models/live_activity_update_request.rb
 - generated/activitysmith_openapi/models/live_activity_update_response.rb
+- generated/activitysmith_openapi/models/live_activity_webhook_method.rb
 - generated/activitysmith_openapi/models/no_recipients_error.rb
 - generated/activitysmith_openapi/models/push_notification_action.rb
 - generated/activitysmith_openapi/models/push_notification_action_type.rb
@@ -109,6 +112,7 @@ files:
 - lib/activitysmith/live_activities.rb
 - lib/activitysmith/notifications.rb
 - lib/activitysmith/version.rb
+- lib/activitysmith/versioned_user_agent.rb
 homepage: https://activitysmith.com/docs/sdks/ruby
 licenses:
 - MIT