surge_api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6419099e30ee4893563ecd9e9fd2e4707dedf5af633e5972d25b0848228deef9
-  data.tar.gz: 1c60adc5936f072f87f8b534f26a4cab6bf3a34ea5d48428675c8cfea4da6159
+  metadata.gz: 2108433baa320b26048ee5f2141841a98866a135e46330a3cee4b4555eb85b67
+  data.tar.gz: 853d2d48b5b8981ba46ab3ab589bca43fd599ed8b6d9aa63cfcbe80eb5be2b7e
 SHA512:
-  metadata.gz: 3bcb5e868464704dad067a2a1e5b36a695689c3adf03e7b8e5978b2469dbe69bf2da75d7a4b0d6ad1613357a991e5a0f57e3110a95afc20eae0df4a7cc0ac751
-  data.tar.gz: 95e41f79bf6d869ac3201c21f15c1ceb7514d2d2e35c5172cba0e5db199bd1817300c9eea8d2050ad3493f08b2ecade4288c6c6b8907f53309cff1baf2001f65
+  metadata.gz: 075d2964cab7711b2edc152d89314b5d323bcf9fd5d645409d9cd7c7ccfccf7c5ddab2c471d828bff6ff61a78ededa51e34bc2bbcd6ab298444c79f5d8ffec50
+  data.tar.gz: 6c171b025eeaa2be398b7315e5280129e198917ca5477aba3d7ca4d570def52c0d3b59a7935057ccb2aa93e35184e13989daa0d5e26461efcbc045aa6c9b36ff

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.6.0 (2026-01-18)
+
+Full Changelog: [v0.5.0...v0.6.0](https://github.com/surgeapi/ruby-sdk/compare/v0.5.0...v0.6.0)
+
+### Features
+
+* **api:** api update ([be3de20](https://github.com/surgeapi/ruby-sdk/commit/be3de209f18482fa76b1a447fd8e944efb56772f))
+
+
+### Chores
+
+* **internal:** update `actions/checkout` version ([3d4be8e](https://github.com/surgeapi/ruby-sdk/commit/3d4be8e99c4f71d93e66a2d830d23e1008490abc))
+
 ## 0.5.0 (2026-01-15)
 
 Full Changelog: [v0.4.0...v0.5.0](https://github.com/surgeapi/ruby-sdk/compare/v0.4.0...v0.5.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.5.0"
+gem "surge_api", "~> 0.6.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/link_followed_webhook_event.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class LinkFollowedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::LinkFollowedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::LinkFollowedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `link.followed` for this event.
+      #
+      #   @return [Symbol, :"link.followed"]
+      required :type, const: :"link.followed"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"link.followed")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::LinkFollowedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"link.followed"] The type of the event. Always `link.followed` for this event.
+
+      # @see SurgeAPI::Models::LinkFollowedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the link
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute message_id
+        #   The unique identifier for the message that contained the link
+        #
+        #   @return [String]
+        required :message_id, String
+
+        # @!attribute url
+        #   The original URL that was shortened
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, message_id:, url:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the link
+        #
+        #   @param message_id [String] The unique identifier for the message that contained the link
+        #
+        #   @param url [String] The original URL that was shortened
+      end
+    end
+  end
+end

data/lib/surge_api/models/unwrap_webhook_event.rb

@@ -17,6 +17,8 @@ module SurgeAPI
 
       variant :"conversation.created", -> { SurgeAPI::ConversationCreatedWebhookEvent }
 
+      variant :"link.followed", -> { SurgeAPI::LinkFollowedWebhookEvent }
+
       variant :"message.delivered", -> { SurgeAPI::MessageDeliveredWebhookEvent }
 
       variant :"message.failed", -> { SurgeAPI::MessageFailedWebhookEvent }
@@ -26,7 +28,7 @@ module SurgeAPI
       variant :"message.sent", -> { SurgeAPI::MessageSentWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent)]
+      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent)]
     end
   end
 end

data/lib/surge_api/models.rb

@@ -81,6 +81,8 @@ module SurgeAPI
 
   Error = SurgeAPI::Models::Error
 
+  LinkFollowedWebhookEvent = SurgeAPI::Models::LinkFollowedWebhookEvent
+
   Message = SurgeAPI::Models::Message
 
   MessageCreateParams = SurgeAPI::Models::MessageCreateParams

data/lib/surge_api/resources/webhooks.rb

@@ -5,7 +5,7 @@ module SurgeAPI
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent]
+      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent]
       def unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         SurgeAPI::Internal::Type::Converter.coerce(SurgeAPI::Models::UnwrapWebhookEvent, parsed)

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/surge_api.rb

@@ -74,6 +74,7 @@ require_relative "surge_api/models/contact_retrieve_params"
 require_relative "surge_api/models/contact_update_params"
 require_relative "surge_api/models/conversation_created_webhook_event"
 require_relative "surge_api/models/error"
+require_relative "surge_api/models/link_followed_webhook_event"
 require_relative "surge_api/models/message"
 require_relative "surge_api/models/message_create_params"
 require_relative "surge_api/models/message_delivered_webhook_event"

data/rbi/surge_api/models/link_followed_webhook_event.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class LinkFollowedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::LinkFollowedWebhookEvent, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The ID of the account in which this event occurred
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The data associated with the event
+      sig { returns(SurgeAPI::LinkFollowedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: SurgeAPI::LinkFollowedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `link.followed` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::LinkFollowedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account in which this event occurred
+        account_id:,
+        # The data associated with the event
+        data:,
+        # The timestamp when this event occurred, in ISO8601 format
+        timestamp:,
+        # The type of the event. Always `link.followed` for this event.
+        type: :"link.followed"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::LinkFollowedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::LinkFollowedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the link
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The unique identifier for the message that contained the link
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        # The original URL that was shortened
+        sig { returns(String) }
+        attr_accessor :url
+
+        # The data associated with the event
+        sig do
+          params(id: String, message_id: String, url: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The unique identifier for the link
+          id:,
+          # The unique identifier for the message that contained the link
+          message_id:,
+          # The original URL that was shortened
+          url:
+        )
+        end
+
+        sig do
+          override.returns({ id: String, message_id: String, url: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/unwrap_webhook_event.rbi

@@ -13,6 +13,7 @@ module SurgeAPI
             SurgeAPI::ContactOptedInWebhookEvent,
             SurgeAPI::ContactOptedOutWebhookEvent,
             SurgeAPI::ConversationCreatedWebhookEvent,
+            SurgeAPI::LinkFollowedWebhookEvent,
             SurgeAPI::MessageDeliveredWebhookEvent,
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,

data/rbi/surge_api/models.rbi

@@ -44,6 +44,8 @@ module SurgeAPI
 
   Error = SurgeAPI::Models::Error
 
+  LinkFollowedWebhookEvent = SurgeAPI::Models::LinkFollowedWebhookEvent
+
   Message = SurgeAPI::Models::Message
 
   MessageCreateParams = SurgeAPI::Models::MessageCreateParams

data/rbi/surge_api/resources/webhooks.rbi

@@ -11,6 +11,7 @@ module SurgeAPI
             SurgeAPI::ContactOptedInWebhookEvent,
             SurgeAPI::ContactOptedOutWebhookEvent,
             SurgeAPI::ConversationCreatedWebhookEvent,
+            SurgeAPI::LinkFollowedWebhookEvent,
             SurgeAPI::MessageDeliveredWebhookEvent,
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,

data/sig/surge_api/models/link_followed_webhook_event.rbs

@@ -0,0 +1,49 @@
+module SurgeAPI
+  module Models
+    type link_followed_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::LinkFollowedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"link.followed"
+      }
+
+    class LinkFollowedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::LinkFollowedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"link.followed"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::LinkFollowedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"link.followed"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::LinkFollowedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"link.followed"
+      }
+
+      type data = { id: String, message_id: String, url: String }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor message_id: String
+
+        attr_accessor url: String
+
+        def initialize: (id: String, message_id: String, url: String) -> void
+
+        def to_hash: -> { id: String, message_id: String, url: String }
+      end
+    end
+  end
+end

data/sig/surge_api/models/unwrap_webhook_event.rbs

@@ -6,6 +6,7 @@ module SurgeAPI
       | SurgeAPI::ContactOptedInWebhookEvent
       | SurgeAPI::ContactOptedOutWebhookEvent
       | SurgeAPI::ConversationCreatedWebhookEvent
+      | SurgeAPI::LinkFollowedWebhookEvent
       | SurgeAPI::MessageDeliveredWebhookEvent
       | SurgeAPI::MessageFailedWebhookEvent
       | SurgeAPI::MessageReceivedWebhookEvent

data/sig/surge_api/models.rbs

@@ -41,6 +41,8 @@ module SurgeAPI
 
   class Error = SurgeAPI::Models::Error
 
+  class LinkFollowedWebhookEvent = SurgeAPI::Models::LinkFollowedWebhookEvent
+
   class Message = SurgeAPI::Models::Message
 
   class MessageCreateParams = SurgeAPI::Models::MessageCreateParams

data/sig/surge_api/resources/webhooks.rbs

@@ -8,6 +8,7 @@ module SurgeAPI
       | SurgeAPI::ContactOptedInWebhookEvent
       | SurgeAPI::ContactOptedOutWebhookEvent
       | SurgeAPI::ConversationCreatedWebhookEvent
+      | SurgeAPI::LinkFollowedWebhookEvent
       | SurgeAPI::MessageDeliveredWebhookEvent
       | SurgeAPI::MessageFailedWebhookEvent
       | SurgeAPI::MessageReceivedWebhookEvent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -90,6 +90,7 @@ files:
 - lib/surge_api/models/contact_update_params.rb
 - lib/surge_api/models/conversation_created_webhook_event.rb
 - lib/surge_api/models/error.rb
+- lib/surge_api/models/link_followed_webhook_event.rb
 - lib/surge_api/models/message.rb
 - lib/surge_api/models/message_create_params.rb
 - lib/surge_api/models/message_delivered_webhook_event.rb
@@ -166,6 +167,7 @@ files:
 - rbi/surge_api/models/contact_update_params.rbi
 - rbi/surge_api/models/conversation_created_webhook_event.rbi
 - rbi/surge_api/models/error.rbi
+- rbi/surge_api/models/link_followed_webhook_event.rbi
 - rbi/surge_api/models/message.rbi
 - rbi/surge_api/models/message_create_params.rbi
 - rbi/surge_api/models/message_delivered_webhook_event.rbi
@@ -241,6 +243,7 @@ files:
 - sig/surge_api/models/contact_update_params.rbs
 - sig/surge_api/models/conversation_created_webhook_event.rbs
 - sig/surge_api/models/error.rbs
+- sig/surge_api/models/link_followed_webhook_event.rbs
 - sig/surge_api/models/message.rbs
 - sig/surge_api/models/message_create_params.rbs
 - sig/surge_api/models/message_delivered_webhook_event.rbs