activitysmith 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0156cf4ca24234b00d788157d7509e7ef039055f31d961d5cd69ef891fc4a00b
-  data.tar.gz: 5a677785c2474caf6c5f6c930be261e33a8587a60feb28e9780d2847cff84a08
+  metadata.gz: 0d8716c7c9794439454c8ed5a182522c0a0eb32449d198dadea37652609f4469
+  data.tar.gz: 6b84b2f13f5930404ea1fdf8fa8adc73082aa9b3b6d2564dd119819e5f0c0c3d
 SHA512:
-  metadata.gz: 7becb4ace06609d70f716db39f849fb00f11b7d0af191650543a9e80b9668edb6cc452f16e83de5c01d3a890642191776ef193a3880af26ca0e28c57964eff28
-  data.tar.gz: fbf630d410f3e0ba09fcba85121d9ba179b08e02a6d0a5f3f138094d9e1464822e3a8df0aa07d0d37e22769e8284af172b96403d675637e72fe575598af2e5a0
+  metadata.gz: cad0ad010c8285ef38626df955773b4988a307736e95f399473a2d516ff39ecfce39849e81817a5e5ebfcd5150b668fbd3489869a6dbec7ffb5ae34190c1b5ea
+  data.tar.gz: 0d502d03eb228e205234bec172022c65e87ba6375072152baef435eed94091a05382d7c0eb479315214685ebb6d768c64ce843dfe8194f33fcf7ec7f9164a288

data/README.md

@@ -24,12 +24,15 @@ activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_
 
 ### Send a Push Notification
 
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/new-subscription-push-notification.png" alt="Push notification example" width="680" />
+</p>
+
 ```ruby
 response = activitysmith.notifications.send(
   {
     title: "New subscription 💸",
-    message: "Customer upgraded to Pro plan",
-    channels: ["devs", "ops"] # Optional
+    message: "Customer upgraded to Pro plan"
   }
 )
 
@@ -39,6 +42,10 @@ puts response.devices_notified
 
 ### Start a Live Activity
 
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/start-live-activity.png" alt="Start live activity example" width="680" />
+</p>
+
 ```ruby
 start = activitysmith.live_activities.start(
   {
@@ -59,6 +66,10 @@ activity_id = start.activity_id
 
 ### Update a Live Activity
 
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Update live activity example" width="680" />
+</p>
+
 ```ruby
 update = activitysmith.live_activities.update(
   {
@@ -76,6 +87,10 @@ puts update.devices_notified
 
 ### End a Live Activity
 
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/end-live-activity.png" alt="End live activity example" width="680" />
+</p>
+
 ```ruby
 finish = activitysmith.live_activities.end(
   {
@@ -92,6 +107,52 @@ finish = activitysmith.live_activities.end(
 puts finish.success
 ```
 
+## 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(
+  {
+    title: "New subscription 💸",
+    message: "Customer upgraded to Pro plan",
+    channels: ["sales", "customer-success"] # Optional
+  }
+)
+```
+
+## Push Notification Redirection and Actions
+
+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
+response = 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"
+        }
+      }
+    ]
+  }
+)
+```
+
 ## Error Handling
 
 ```ruby
@@ -104,11 +165,6 @@ rescue OpenapiClient::ApiError => err
 end
 ```
 
-## API Surface
-
-- `activitysmith.notifications`
-- `activitysmith.live_activities`
-
 ## Requirements
 
 - Ruby 3.0+

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.
+    # 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).
     # @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.
+    # 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).
     # @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/push_notification_action.rb

@@ -0,0 +1,322 @@
+=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 PushNotificationAction
+    # Button title displayed in iOS expanded notification 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' => :'PushNotificationActionType',
+        :'url' => :'String',
+        :'method' => :'PushNotificationWebhookMethod',
+        :'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::PushNotificationAction` 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::PushNotificationAction`. 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/push_notification_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 PushNotificationActionType
+    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 PushNotificationActionType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #PushNotificationActionType"
+    end
+  end
+end

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -21,6 +21,12 @@ module OpenapiClient
 
     attr_accessor :subtitle
 
+    # Optional HTTPS URL opened when user taps the notification body.
+    attr_accessor :redirection
+
+    # Optional interactive actions shown on iOS long-press.
+    attr_accessor :actions
+
     attr_accessor :payload
 
     attr_accessor :badge
@@ -35,6 +41,8 @@ module OpenapiClient
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
+        :'redirection' => :'redirection',
+        :'actions' => :'actions',
         :'payload' => :'payload',
         :'badge' => :'badge',
         :'sound' => :'sound',
@@ -53,6 +61,8 @@ module OpenapiClient
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
+        :'redirection' => :'String',
+        :'actions' => :'Array<PushNotificationAction>',
         :'payload' => :'Hash<String, Object>',
         :'badge' => :'Integer',
         :'sound' => :'String',
@@ -95,6 +105,16 @@ module OpenapiClient
         self.subtitle = attributes[:'subtitle']
       end
 
+      if attributes.key?(:'redirection')
+        self.redirection = attributes[:'redirection']
+      end
+
+      if attributes.key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      end
+
       if attributes.key?(:'payload')
         if (value = attributes[:'payload']).is_a?(Hash)
           self.payload = value
@@ -123,6 +143,15 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
+      pattern = Regexp.new(/^https:\/\//)
+      if !@redirection.nil? && @redirection !~ pattern
+        invalid_properties.push("invalid value for \"redirection\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@actions.nil? && @actions.length > 4
+        invalid_properties.push('invalid value for "actions", number of items must be less than or equal to 4.')
+      end
+
       invalid_properties
     end
 
@@ -131,9 +160,40 @@ module OpenapiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
+      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] redirection Value to be assigned
+    def redirection=(redirection)
+      if redirection.nil?
+        fail ArgumentError, 'redirection cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if redirection !~ pattern
+        fail ArgumentError, "invalid value for \"redirection\", must conform to the pattern #{pattern}."
+      end
+
+      @redirection = redirection
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actions Value to be assigned
+    def actions=(actions)
+      if actions.nil?
+        fail ArgumentError, 'actions cannot be nil'
+      end
+
+      if actions.length > 4
+        fail ArgumentError, 'invalid value for "actions", number of items must be less than or equal to 4.'
+      end
+
+      @actions = actions
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -142,6 +202,8 @@ module OpenapiClient
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
+          redirection == o.redirection &&
+          actions == o.actions &&
           payload == o.payload &&
           badge == o.badge &&
           sound == o.sound &&
@@ -157,7 +219,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, message, subtitle, payload, badge, sound, target].hash
+      [title, message, subtitle, redirection, actions, payload, badge, sound, target].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/push_notification_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 PushNotificationWebhookMethod
+    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 PushNotificationWebhookMethod.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #PushNotificationWebhookMethod"
+    end
+  end
+end

data/generated/activitysmith_openapi.rb

@@ -32,8 +32,11 @@ 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/no_recipients_error'
+require 'activitysmith_openapi/models/push_notification_action'
+require 'activitysmith_openapi/models/push_notification_action_type'
 require 'activitysmith_openapi/models/push_notification_request'
 require 'activitysmith_openapi/models/push_notification_response'
+require 'activitysmith_openapi/models/push_notification_webhook_method'
 require 'activitysmith_openapi/models/rate_limit_error'
 require 'activitysmith_openapi/models/send_push_notification429_response'
 

data/lib/activitysmith/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitysmith
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - ActivitySmith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-21 00:00:00.000000000 Z
+date: 2026-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -96,8 +96,11 @@ files:
 - generated/activitysmith_openapi/models/live_activity_update_request.rb
 - generated/activitysmith_openapi/models/live_activity_update_response.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
 - generated/activitysmith_openapi/models/push_notification_request.rb
 - generated/activitysmith_openapi/models/push_notification_response.rb
+- generated/activitysmith_openapi/models/push_notification_webhook_method.rb
 - generated/activitysmith_openapi/models/rate_limit_error.rb
 - generated/activitysmith_openapi/models/send_push_notification429_response.rb
 - generated/activitysmith_openapi/version.rb