sentdm 0.30.0 → 0.32.0

data/lib/sentdm.rb

@@ -52,6 +52,11 @@ require_relative "sentdm/errors"
 require_relative "sentdm/internal/transport/base_client"
 require_relative "sentdm/internal/transport/pooled_net_requester"
 require_relative "sentdm/client"
+require_relative "sentdm/internal/contacts_page"
+require_relative "sentdm/internal/conversations_page"
+require_relative "sentdm/internal/templates_page"
+require_relative "sentdm/internal/webhook_events_page"
+require_relative "sentdm/internal/webhooks_page"
 require_relative "sentdm/models/mutation_request"
 require_relative "sentdm/models/api_meta"
 require_relative "sentdm/models/api_response_of_contact"
@@ -67,10 +72,13 @@ require_relative "sentdm/models/brand_business_info"
 require_relative "sentdm/models/brand_compliance_info"
 require_relative "sentdm/models/brand_contact_info"
 require_relative "sentdm/models/brands_brand_data"
+require_relative "sentdm/models/channel_event"
+require_relative "sentdm/models/channel_event_payload"
 require_relative "sentdm/models/contact_create_params"
 require_relative "sentdm/models/contact_delete_params"
+require_relative "sentdm/models/contact_event"
+require_relative "sentdm/models/contact_event_payload"
 require_relative "sentdm/models/contact_list_params"
-require_relative "sentdm/models/contact_list_response"
 require_relative "sentdm/models/contact_message_summary"
 require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_message_summary_params"
@@ -133,7 +141,6 @@ require_relative "sentdm/models/template_event_payload"
 require_relative "sentdm/models/template_footer"
 require_relative "sentdm/models/template_header"
 require_relative "sentdm/models/template_list_params"
-require_relative "sentdm/models/template_list_response"
 require_relative "sentdm/models/template_retrieve_params"
 require_relative "sentdm/models/template_update_params"
 require_relative "sentdm/models/template_variable"
@@ -152,7 +159,6 @@ require_relative "sentdm/models/webhook_list_events_response"
 require_relative "sentdm/models/webhook_list_event_types_params"
 require_relative "sentdm/models/webhook_list_event_types_response"
 require_relative "sentdm/models/webhook_list_params"
-require_relative "sentdm/models/webhook_list_response"
 require_relative "sentdm/models/webhook_response"
 require_relative "sentdm/models/webhook_retrieve_params"
 require_relative "sentdm/models/webhook_rotate_secret_params"

data/rbi/sentdm/internal/contacts_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class ContactsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :contacts
+
+        sig { params(contacts: T::Array[T.anything]).void }
+        attr_writer :contacts
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            contacts: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(contacts: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { contacts: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/conversations_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class ConversationsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :messages
+
+        sig { params(messages: T::Array[T.anything]).void }
+        attr_writer :messages
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            messages: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(messages: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { messages: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/templates_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class TemplatesPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :templates
+
+        sig { params(templates: T::Array[T.anything]).void }
+        attr_writer :templates
+
+        sig do
+          params(
+            pagination: Data::Pagination::OrHash,
+            templates: T::Array[T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(pagination: nil, templates: nil)
+        end
+
+        sig do
+          override.returns(
+            { pagination: Data::Pagination, templates: T::Array[T.anything] }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/webhook_events_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class WebhookEventsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :events
+
+        sig { params(events: T::Array[T.anything]).void }
+        attr_writer :events
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            events: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(events: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { events: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/webhooks_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class WebhooksPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :webhooks
+
+        sig { params(webhooks: T::Array[T.anything]).void }
+        attr_writer :webhooks
+
+        sig do
+          params(
+            pagination: Data::Pagination::OrHash,
+            webhooks: T::Array[T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(pagination: nil, webhooks: nil)
+        end
+
+        sig do
+          override.returns(
+            { pagination: Data::Pagination, webhooks: T::Array[T.anything] }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channel_event.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ChannelEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::ChannelEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered,
+      # message.received or contact.opt_out. Absent on events that have no subtype, so
+      # treat it as optional.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :event
+
+      # The event family, for example message, templates or contact. Route on this
+      # first, then on event for the specific change.
+      sig { returns(T.nilable(String)) }
+      attr_reader :field
+
+      sig { params(field: String).void }
+      attr_writer :field
+
+      # Body of a channel event: where one of the customer's channels stands in
+      # provisioning and compliance. Delivered when a milestone moves — a registration
+      # filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+      # customer's own onboarding UI does not have to poll GET /v3/channels.
+      #
+      # The subject is one item, never the account. A customer's "SMS channel" has no
+      # status; a market does. Country, NumberType and SenderValue name which one, so a
+      # customer terminating only to Kosovo never receives an event about US 10DLC.
+      #
+      # Status is the stable half of the contract. It is the same four-value set GET
+      # /v3/channels publishes, computed through the same code, so an event and a read
+      # of the same market cannot disagree. A subscriber that reads nothing but the
+      # status and the subject fields is a correct subscriber. The sub-type on the
+      # envelope names the specific milestone and is additive — that vocabulary comes
+      # from registries and carriers, which are parties Sent does not control.
+      #
+      # Status means provisioning and compliance are complete, not that a send will
+      # succeed right now. An account can be suspended, or a destination blocked by a
+      # routing rule, without either showing up here. Those are separate surfaces and
+      # deliberately not modelled on this payload.
+      sig { returns(T.nilable(Sentdm::ChannelEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::ChannelEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # The event-specific body.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :request_id
+
+      # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      # time, not the time the underlying change happened. Use the timestamp inside the
+      # payload for the latter.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      # this shape and varies only in Payload.
+      sig do
+        params(
+          event: T.nilable(String),
+          field: String,
+          payload: T.nilable(Sentdm::ChannelEventPayload::OrHash),
+          request_id: T.nilable(String),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered,
+        # message.received or contact.opt_out. Absent on events that have no subtype, so
+        # treat it as optional.
+        event: nil,
+        # The event family, for example message, templates or contact. Route on this
+        # first, then on event for the specific change.
+        field: nil,
+        # Body of a channel event: where one of the customer's channels stands in
+        # provisioning and compliance. Delivered when a milestone moves — a registration
+        # filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+        # customer's own onboarding UI does not have to poll GET /v3/channels.
+        #
+        # The subject is one item, never the account. A customer's "SMS channel" has no
+        # status; a market does. Country, NumberType and SenderValue name which one, so a
+        # customer terminating only to Kosovo never receives an event about US 10DLC.
+        #
+        # Status is the stable half of the contract. It is the same four-value set GET
+        # /v3/channels publishes, computed through the same code, so an event and a read
+        # of the same market cannot disagree. A subscriber that reads nothing but the
+        # status and the subject fields is a correct subscriber. The sub-type on the
+        # envelope names the specific milestone and is additive — that vocabulary comes
+        # from registries and carriers, which are parties Sent does not control.
+        #
+        # Status means provisioning and compliance are complete, not that a send will
+        # succeed right now. An account can be suspended, or a destination blocked by a
+        # routing rule, without either showing up here. Those are separate surfaces and
+        # deliberately not modelled on this payload.
+        payload: nil,
+        # The event-specific body.
+        request_id: nil,
+        # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+        # time, not the time the underlying change happened. Use the timestamp inside the
+        # payload for the latter.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: T.nilable(String),
+            field: String,
+            payload: T.nilable(Sentdm::ChannelEventPayload),
+            request_id: T.nilable(String),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end