sentdm 0.26.0 → 0.27.0

data/lib/sentdm/resources/users.rb

@@ -12,7 +12,7 @@ module Sentdm
       #
       # @overload retrieve(user_id, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String]
+      # @param user_id [String] User ID from route parameter
       #
       # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
@@ -106,7 +106,7 @@ module Sentdm
       #
       # @overload remove(user_id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String] Path param
+      # @param user_id [String] Path param: User ID from route parameter
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
@@ -138,7 +138,7 @@ module Sentdm
       #
       # @overload update_role(user_id, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String] Path param
+      # @param user_id [String] Path param: User ID from route parameter
       #
       # @param role [String] Body param: User role: admin, billing, or developer (required)
       #

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.26.0"
+  VERSION = "0.27.0"
 end

data/lib/sentdm.rb

@@ -81,8 +81,12 @@ require_relative "sentdm/models/conversation_list_params"
 require_relative "sentdm/models/conversation_messages_list"
 require_relative "sentdm/models/destination_country"
 require_relative "sentdm/models/error_detail"
+require_relative "sentdm/models/inbound_message_event"
+require_relative "sentdm/models/inbound_message_event_payload"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
+require_relative "sentdm/models/message_event"
+require_relative "sentdm/models/message_event_payload"
 require_relative "sentdm/models/message_retrieve_activities_params"
 require_relative "sentdm/models/message_retrieve_activities_response"
 require_relative "sentdm/models/message_retrieve_status_params"
@@ -124,6 +128,8 @@ require_relative "sentdm/models/template_button_props"
 require_relative "sentdm/models/template_create_params"
 require_relative "sentdm/models/template_definition"
 require_relative "sentdm/models/template_delete_params"
+require_relative "sentdm/models/template_event"
+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"

data/rbi/sentdm/models/inbound_message_event.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class InboundMessageEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::InboundMessageEvent, Sentdm::Internal::AnyHash)
+        end
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. 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 or templates. 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 message.received event. Delivered when a contact messages one of your
+      # numbers.
+      sig { returns(T.nilable(Sentdm::InboundMessageEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(
+          payload: T.nilable(Sentdm::InboundMessageEventPayload::OrHash)
+        ).void
+      end
+      attr_writer :payload
+
+      # 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::InboundMessageEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of a message.received event. Delivered when a contact messages one of your
+        # numbers.
+        payload: 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::InboundMessageEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/inbound_message_event_payload.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class InboundMessageEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::InboundMessageEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the message belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The channel the message arrived on, for example sms or whatsapp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The contact's number in E.164 format, meaning the number the message came from.
+      sig { returns(T.nilable(String)) }
+      attr_reader :inbound_number
+
+      sig { params(inbound_number: String).void }
+      attr_writer :inbound_number
+
+      # The inbound message.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      # Your number in E.164 format, meaning the number the message was addressed to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :outbound_number
+
+      sig { params(outbound_number: String).void }
+      attr_writer :outbound_number
+
+      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(T.nilable(String)) }
+      attr_reader :received_at
+
+      sig { params(received_at: String).void }
+      attr_writer :received_at
+
+      # The message body. Sent as null when the inbound message carried no text, for
+      # example a media-only message. The field is always present, so read it and check
+      # for null rather than checking whether the key exists.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text
+
+      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
+      # ReceivedAt, kept for envelope consistency with outbound events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      # Body of a message.received event. Delivered when a contact messages one of your
+      # numbers.
+      sig do
+        params(
+          account_id: String,
+          channel: String,
+          inbound_number: String,
+          message_id: String,
+          outbound_number: String,
+          received_at: String,
+          text: T.nilable(String),
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the message belongs to.
+        account_id: nil,
+        # The channel the message arrived on, for example sms or whatsapp.
+        channel: nil,
+        # The contact's number in E.164 format, meaning the number the message came from.
+        inbound_number: nil,
+        # The inbound message.
+        message_id: nil,
+        # Your number in E.164 format, meaning the number the message was addressed to.
+        outbound_number: nil,
+        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        received_at: nil,
+        # The message body. Sent as null when the inbound message carried no text, for
+        # example a media-only message. The field is always present, so read it and check
+        # for null rather than checking whether the key exists.
+        text: nil,
+        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
+        # ReceivedAt, kept for envelope consistency with outbound events.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            channel: String,
+            inbound_number: String,
+            message_id: String,
+            outbound_number: String,
+            received_at: String,
+            text: T.nilable(String),
+            updated_at: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_event.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::MessageEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. 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 or templates. 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 an outbound message lifecycle event. Delivered once per status change,
+      # so a single message produces several of these as it moves toward a terminal
+      # status.
+      sig { returns(T.nilable(Sentdm::MessageEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::MessageEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # 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::MessageEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of an outbound message lifecycle event. Delivered once per status change,
+        # so a single message produces several of these as it moves toward a terminal
+        # status.
+        payload: 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::MessageEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_event_payload.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the message belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The agent attributed to the send, when the send was attributed to one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_id
+
+      # The channel the message went out on, for example sms or whatsapp. A message that
+      # falls back to another channel reports the channel actually used.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The message this event describes. Stable across every event in the message's
+      # lifecycle, so use it to correlate them.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+      # Sent means dispatched and delivered means confirmed, so treat them as distinct
+      # outcomes.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_status
+
+      sig { params(message_status: String).void }
+      attr_writer :message_status
+
+      # The recipient's number in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_reader :outbound_number
+
+      sig { params(outbound_number: String).void }
+      attr_writer :outbound_number
+
+      # The template the message was sent from, when it was sent from one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_id
+
+      # Name of the template the message was sent from. Omitted when the message wasn't
+      # template-based.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_name
+
+      # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      # Body of an outbound message lifecycle event. Delivered once per status change,
+      # so a single message produces several of these as it moves toward a terminal
+      # status.
+      sig do
+        params(
+          account_id: String,
+          agent_id: T.nilable(String),
+          channel: String,
+          message_id: String,
+          message_status: String,
+          outbound_number: String,
+          template_id: T.nilable(String),
+          template_name: T.nilable(String),
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the message belongs to.
+        account_id: nil,
+        # The agent attributed to the send, when the send was attributed to one.
+        agent_id: nil,
+        # The channel the message went out on, for example sms or whatsapp. A message that
+        # falls back to another channel reports the channel actually used.
+        channel: nil,
+        # The message this event describes. Stable across every event in the message's
+        # lifecycle, so use it to correlate them.
+        message_id: nil,
+        # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+        # Sent means dispatched and delivered means confirmed, so treat them as distinct
+        # outcomes.
+        message_status: nil,
+        # The recipient's number in E.164 format.
+        outbound_number: nil,
+        # The template the message was sent from, when it was sent from one.
+        template_id: nil,
+        # Name of the template the message was sent from. Omitted when the message wasn't
+        # template-based.
+        template_name: nil,
+        # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            agent_id: T.nilable(String),
+            channel: String,
+            message_id: String,
+            message_status: String,
+            outbound_number: String,
+            template_id: T.nilable(String),
+            template_name: T.nilable(String),
+            updated_at: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_detail.rbi

@@ -378,7 +378,10 @@ module Sentdm
         sig { params(created_at: Time).void }
         attr_writer :created_at
 
-        # CSP (Campaign Service Provider) ID
+        # Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+        # that registered the brand, which is Sent, so the value is the same for every
+        # brand and every account. Nothing on your side can act on it and there is no
+        # replacement. Stop reading it.
         sig { returns(T.nilable(String)) }
         attr_accessor :csp_id
 
@@ -459,7 +462,10 @@ module Sentdm
           contact: nil,
           # When the brand was created
           created_at: nil,
-          # CSP (Campaign Service Provider) ID
+          # Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+          # that registered the brand, which is Sent, so the value is the same for every
+          # brand and every account. Nothing on your side can act on it and there is no
+          # replacement. Stop reading it.
           csp_id: nil,
           identity_status: nil,
           # Whether this brand is inherited from the parent organization

data/rbi/sentdm/models/profiles/campaign_data.rbi

@@ -62,7 +62,7 @@ module Sentdm
         attr_accessor :terms_and_conditions_link
 
         # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-        # "5000"); values below 2000 bill at the low-volume tier.
+        # "5000"). Values below 2000 bill at the low-volume tier.
         sig { returns(T.nilable(String)) }
         attr_accessor :volume
 
@@ -113,7 +113,7 @@ module Sentdm
           # URL to terms and conditions
           terms_and_conditions_link: nil,
           # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-          # "5000"); values below 2000 bill at the low-volume tier.
+          # "5000"). Values below 2000 bill at the low-volume tier.
           volume: nil
         )
         end

data/rbi/sentdm/models/template_event.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::TemplateEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. 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 or templates. 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 template status event. Delivered when a template's review outcome
+      # changes, so you can react without polling.
+      sig { returns(T.nilable(Sentdm::TemplateEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::TemplateEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # 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::TemplateEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of a template status event. Delivered when a template's review outcome
+        # changes, so you can react without polling.
+        payload: 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::TemplateEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end