sentdm 0.45.0 → 0.46.0

data/rbi/sentdm/models/webhook_create_params.rbi

@@ -61,13 +61,12 @@ module Sentdm
       # Request-only: the events an organization webhook's sender profile clones
       # receive, one clone per existing and future profile. A version 1 webhook's
       # responses report it as WebhookSenderProfileV3Response.
-      sig { returns(T.nilable(Sentdm::WebhookCreateParams::SenderProfile)) }
+      sig { returns(T.nilable(Sentdm::WebhookSenderProfileConfig)) }
       attr_reader :sender_profile
 
       sig do
         params(
-          sender_profile:
-            T.nilable(Sentdm::WebhookCreateParams::SenderProfile::OrHash)
+          sender_profile: T.nilable(Sentdm::WebhookSenderProfileConfig::OrHash)
         ).void
       end
       attr_writer :sender_profile
@@ -106,8 +105,7 @@ module Sentdm
           is_inheritable: T::Boolean,
           retry_count: Integer,
           sandbox: T::Boolean,
-          sender_profile:
-            T.nilable(Sentdm::WebhookCreateParams::SenderProfile::OrHash),
+          sender_profile: T.nilable(Sentdm::WebhookSenderProfileConfig::OrHash),
           timeout_seconds: Integer,
           webhook_version: T.nilable(Integer),
           idempotency_key: String,
@@ -157,8 +155,7 @@ module Sentdm
             is_inheritable: T::Boolean,
             retry_count: Integer,
             sandbox: T::Boolean,
-            sender_profile:
-              T.nilable(Sentdm::WebhookCreateParams::SenderProfile),
+            sender_profile: T.nilable(Sentdm::WebhookSenderProfileConfig),
             timeout_seconds: Integer,
             webhook_version: T.nilable(Integer),
             idempotency_key: String,
@@ -169,48 +166,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class SenderProfile < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::WebhookCreateParams::SenderProfile,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
-        attr_accessor :event_filters
-
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :event_types
-
-        sig { params(event_types: T::Array[String]).void }
-        attr_writer :event_types
-
-        # Request-only: the events an organization webhook's sender profile clones
-        # receive, one clone per existing and future profile. A version 1 webhook's
-        # responses report it as WebhookSenderProfileV3Response.
-        sig do
-          params(
-            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
-            event_types: T::Array[String]
-          ).returns(T.attached_class)
-        end
-        def self.new(event_filters: nil, event_types: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
-              event_types: T::Array[String]
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/webhook_delivery.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookDelivery < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::WebhookDelivery, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :delivery_attempts
+
+      sig { params(delivery_attempts: Integer).void }
+      attr_writer :delivery_attempts
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :delivery_status
+
+      sig { params(delivery_status: String).void }
+      attr_writer :delivery_status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error_message
+
+      # The exact event body that was delivered, or attempted, for this record. One of
+      # the six webhook envelopes:
+      #
+      # message — an outbound message changed status. message with event:
+      # message.received — someone replied to you. templates — a template was approved,
+      # rejected, paused or similar. channel — one of your markets moved in provisioning
+      # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
+      # tracked short link was clicked or a hosted file downloaded, or one expired or
+      # was revoked.
+      #
+      # Read field and event to tell which, the same way your endpoint does. The two
+      # message envelopes are the reason that is two fields and not one: they share a
+      # field and differ by event.
+      #
+      # Treat the list as open. It has grown twice — channel and then link — and a
+      # handler that rejects an envelope it does not recognise will break on the next
+      # addition rather than ignore it.
+      sig { returns(T.nilable(Sentdm::WebhookDelivery::EventData::Variants)) }
+      attr_reader :event_data
+
+      sig do
+        params(
+          event_data:
+            T.any(
+              Sentdm::MessageEvent::OrHash,
+              Sentdm::InboundMessageEvent::OrHash,
+              Sentdm::TemplateEvent::OrHash,
+              Sentdm::ChannelEvent::OrHash,
+              Sentdm::ContactEvent::OrHash,
+              Sentdm::LinkEvent::OrHash,
+              Sentdm::CallEvent::OrHash
+            )
+        ).void
+      end
+      attr_writer :event_data
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :event_type
+
+      sig { params(event_type: String).void }
+      attr_writer :event_type
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :http_status_code
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processing_completed_at
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processing_started_at
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :response_body
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          delivery_attempts: Integer,
+          delivery_status: String,
+          error_message: T.nilable(String),
+          event_data:
+            T.any(
+              Sentdm::MessageEvent::OrHash,
+              Sentdm::InboundMessageEvent::OrHash,
+              Sentdm::TemplateEvent::OrHash,
+              Sentdm::ChannelEvent::OrHash,
+              Sentdm::ContactEvent::OrHash,
+              Sentdm::LinkEvent::OrHash,
+              Sentdm::CallEvent::OrHash
+            ),
+          event_type: String,
+          http_status_code: T.nilable(Integer),
+          processing_completed_at: T.nilable(Time),
+          processing_started_at: T.nilable(Time),
+          response_body: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id: nil,
+        created_at: nil,
+        delivery_attempts: nil,
+        delivery_status: nil,
+        error_message: nil,
+        # The exact event body that was delivered, or attempted, for this record. One of
+        # the six webhook envelopes:
+        #
+        # message — an outbound message changed status. message with event:
+        # message.received — someone replied to you. templates — a template was approved,
+        # rejected, paused or similar. channel — one of your markets moved in provisioning
+        # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
+        # tracked short link was clicked or a hosted file downloaded, or one expired or
+        # was revoked.
+        #
+        # Read field and event to tell which, the same way your endpoint does. The two
+        # message envelopes are the reason that is two fields and not one: they share a
+        # field and differ by event.
+        #
+        # Treat the list as open. It has grown twice — channel and then link — and a
+        # handler that rejects an envelope it does not recognise will break on the next
+        # addition rather than ignore it.
+        event_data: nil,
+        event_type: nil,
+        http_status_code: nil,
+        processing_completed_at: nil,
+        processing_started_at: nil,
+        response_body: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            delivery_attempts: Integer,
+            delivery_status: String,
+            error_message: T.nilable(String),
+            event_data: Sentdm::WebhookDelivery::EventData::Variants,
+            event_type: String,
+            http_status_code: T.nilable(Integer),
+            processing_completed_at: T.nilable(Time),
+            processing_started_at: T.nilable(Time),
+            response_body: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The exact event body that was delivered, or attempted, for this record. One of
+      # the six webhook envelopes:
+      #
+      # message — an outbound message changed status. message with event:
+      # message.received — someone replied to you. templates — a template was approved,
+      # rejected, paused or similar. channel — one of your markets moved in provisioning
+      # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
+      # tracked short link was clicked or a hosted file downloaded, or one expired or
+      # was revoked.
+      #
+      # Read field and event to tell which, the same way your endpoint does. The two
+      # message envelopes are the reason that is two fields and not one: they share a
+      # field and differ by event.
+      #
+      # Treat the list as open. It has grown twice — channel and then link — and a
+      # handler that rejects an envelope it does not recognise will break on the next
+      # addition rather than ignore it.
+      module EventData
+        extend Sentdm::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Sentdm::MessageEvent,
+              Sentdm::InboundMessageEvent,
+              Sentdm::TemplateEvent,
+              Sentdm::ChannelEvent,
+              Sentdm::ContactEvent,
+              Sentdm::LinkEvent,
+              Sentdm::CallEvent
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[Sentdm::WebhookDelivery::EventData::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_event_types_list.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookEventTypesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::WebhookEventTypesList, Sentdm::Internal::AnyHash)
+        end
+
+      # The event_types on this page.
+      sig { returns(T.nilable(T::Array[Sentdm::WebhookEventType])) }
+      attr_reader :event_types
+
+      sig do
+        params(event_types: T::Array[Sentdm::WebhookEventType::OrHash]).void
+      end
+      attr_writer :event_types
+
+      # Pagination metadata for list responses
+      sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+      attr_reader :pagination
+
+      sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+      attr_writer :pagination
+
+      # The webhook event types a customer can subscribe to.
+      sig do
+        params(
+          event_types: T::Array[Sentdm::WebhookEventType::OrHash],
+          pagination: Sentdm::PaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The event_types on this page.
+        event_types: nil,
+        # Pagination metadata for list responses
+        pagination: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event_types: T::Array[Sentdm::WebhookEventType],
+            pagination: Sentdm::PaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_events_list.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookEventsList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::WebhookEventsList, Sentdm::Internal::AnyHash)
+        end
+
+      # The events on this page.
+      sig { returns(T.nilable(T::Array[Sentdm::WebhookDelivery])) }
+      attr_reader :events
+
+      sig { params(events: T::Array[Sentdm::WebhookDelivery::OrHash]).void }
+      attr_writer :events
+
+      # Pagination metadata for list responses
+      sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+      attr_reader :pagination
+
+      sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+      attr_writer :pagination
+
+      # A paginated list of webhook delivery records.
+      sig do
+        params(
+          events: T::Array[Sentdm::WebhookDelivery::OrHash],
+          pagination: Sentdm::PaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The events on this page.
+        events: nil,
+        # Pagination metadata for list responses
+        pagination: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            events: T::Array[Sentdm::WebhookDelivery],
+            pagination: Sentdm::PaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_response.rbi

@@ -93,13 +93,12 @@ module Sentdm
       #
       # Its own type, field for field the same as the request's sender_profile. A
       # response is not a request, whatever it carries.
-      sig { returns(T.nilable(Sentdm::WebhookResponse::SenderProfile)) }
+      sig { returns(T.nilable(Sentdm::WebhookSenderProfile)) }
       attr_reader :sender_profile
 
       sig do
         params(
-          sender_profile:
-            T.nilable(Sentdm::WebhookResponse::SenderProfile::OrHash)
+          sender_profile: T.nilable(Sentdm::WebhookSenderProfile::OrHash)
         ).void
       end
       attr_writer :sender_profile
@@ -139,8 +138,7 @@ module Sentdm
           last_delivery_attempt_at: T.nilable(Time),
           last_successful_delivery_at: T.nilable(Time),
           retry_count: Integer,
-          sender_profile:
-            T.nilable(Sentdm::WebhookResponse::SenderProfile::OrHash),
+          sender_profile: T.nilable(Sentdm::WebhookSenderProfile::OrHash),
           signing_secret: T.nilable(String),
           timeout_seconds: Integer,
           updated_at: T.nilable(Time),
@@ -203,7 +201,7 @@ module Sentdm
             last_delivery_attempt_at: T.nilable(Time),
             last_successful_delivery_at: T.nilable(Time),
             retry_count: Integer,
-            sender_profile: T.nilable(Sentdm::WebhookResponse::SenderProfile),
+            sender_profile: T.nilable(Sentdm::WebhookSenderProfile),
             signing_secret: T.nilable(String),
             timeout_seconds: Integer,
             updated_at: T.nilable(Time),
@@ -213,50 +211,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class SenderProfile < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::WebhookResponse::SenderProfile,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
-        attr_accessor :event_filters
-
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :event_types
-
-        sig { params(event_types: T::Array[String]).void }
-        attr_writer :event_types
-
-        # The events a version 1 webhook's sender profile clones receive, as a response
-        # reports them.
-        #
-        # Its own type, field for field the same as the request's sender_profile. A
-        # response is not a request, whatever it carries.
-        sig do
-          params(
-            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
-            event_types: T::Array[String]
-          ).returns(T.attached_class)
-        end
-        def self.new(event_filters: nil, event_types: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
-              event_types: T::Array[String]
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/webhook_secret.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookSecret < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::WebhookSecret, Sentdm::Internal::AnyHash) }
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :signing_secret
+
+      sig { params(signing_secret: String).void }
+      attr_writer :signing_secret
+
+      sig { params(signing_secret: String).returns(T.attached_class) }
+      def self.new(signing_secret: nil)
+      end
+
+      sig { override.returns({ signing_secret: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_sender_profile.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookSenderProfile < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::WebhookSenderProfile, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+      attr_accessor :event_filters
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :event_types
+
+      sig { params(event_types: T::Array[String]).void }
+      attr_writer :event_types
+
+      # The events a version 1 webhook's sender profile clones receive, as a response
+      # reports them.
+      #
+      # Its own type, field for field the same as the request's sender_profile. A
+      # response is not a request, whatever it carries.
+      sig do
+        params(
+          event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+          event_types: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(event_filters: nil, event_types: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            event_types: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_sender_profile_config.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookSenderProfileConfig < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::WebhookSenderProfileConfig, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+      attr_accessor :event_filters
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :event_types
+
+      sig { params(event_types: T::Array[String]).void }
+      attr_writer :event_types
+
+      # Request-only: the events an organization webhook's sender profile clones
+      # receive, one clone per existing and future profile. A version 1 webhook's
+      # responses report it as WebhookSenderProfileV3Response.
+      sig do
+        params(
+          event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+          event_types: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(event_filters: nil, event_types: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            event_types: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_test.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookTest < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::WebhookTest, Sentdm::Internal::AnyHash) }
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      sig do
+        params(message: String, success: T::Boolean).returns(T.attached_class)
+      end
+      def self.new(message: nil, success: nil)
+      end
+
+      sig { override.returns({ message: String, success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end