sentdm 0.45.0 → 0.47.0

data/rbi/sentdm/models/message.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class Message < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::Message, Sentdm::Internal::AnyHash) }
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :active_contact_price
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :contact_id
+
+      sig { params(contact_id: String).void }
+      attr_writer :contact_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :customer_id
+
+      sig { params(customer_id: String).void }
+      attr_writer :customer_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :direction
+
+      sig { params(direction: String).void }
+      attr_writer :direction
+
+      sig { returns(T.nilable(T::Array[Sentdm::MessageStatusEvent])) }
+      attr_accessor :events
+
+      # Structured message body format for database storage. Preserves channel-specific
+      # components (header, header media, body, footer, buttons, MMS subject and media).
+      #
+      # Persisted as the messageBody jsonb column on Messages. Every write path goes
+      # through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
+      # shape is stable regardless of channel or status. Anything that rebuilds this
+      # object field by field — the four IMessageBodyStrategy implementations and
+      # MessageUtils.BuildSegmentBody — has to carry every member, or that member is
+      # silently dropped on whichever path forgot it.
+      sig { returns(T.nilable(Sentdm::MessageBody)) }
+      attr_reader :message_body
+
+      sig { params(message_body: T.nilable(Sentdm::MessageBody::OrHash)).void }
+      attr_writer :message_body
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone
+
+      sig { params(phone: String).void }
+      attr_writer :phone
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_international
+
+      sig { params(phone_international: String).void }
+      attr_writer :phone_international
+
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :price
+
+      # A human-readable sentence for reason_code, for example "Insufficient balance".
+      # Omitted whenever reason_code is.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # Why the message is at its current status, as a stable platform code such as
+      # DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+      # FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+      # Switch on this rather than on reason: the code is stable, the wording may be
+      # improved. It is the platform's classification of the outcome, never a carrier or
+      # vendor code.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason_code
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :region_code
+
+      sig { params(region_code: String).void }
+      attr_writer :region_code
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_category
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_name
+
+      # Message response for v3 API — same shape as v2 with snake_case JSON conventions.
+      #
+      # The shape of a message that was sent immediately: it never has a scheduled_at
+      # key. A message that is or was held for a later instant is a
+      # ScheduledMessageResponse, and the endpoint decides which of the two to answer
+      # with. From always returns this type.
+      sig do
+        params(
+          id: String,
+          active_contact_price: T.nilable(Float),
+          channel: String,
+          contact_id: String,
+          created_at: Time,
+          customer_id: String,
+          direction: String,
+          events: T.nilable(T::Array[Sentdm::MessageStatusEvent::OrHash]),
+          message_body: T.nilable(Sentdm::MessageBody::OrHash),
+          phone: String,
+          phone_international: String,
+          price: T.nilable(Float),
+          reason: T.nilable(String),
+          reason_code: T.nilable(String),
+          region_code: String,
+          status: String,
+          template_category: T.nilable(String),
+          template_id: T.nilable(String),
+          template_name: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id: nil,
+        active_contact_price: nil,
+        channel: nil,
+        contact_id: nil,
+        created_at: nil,
+        customer_id: nil,
+        direction: nil,
+        events: nil,
+        # Structured message body format for database storage. Preserves channel-specific
+        # components (header, header media, body, footer, buttons, MMS subject and media).
+        #
+        # Persisted as the messageBody jsonb column on Messages. Every write path goes
+        # through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
+        # shape is stable regardless of channel or status. Anything that rebuilds this
+        # object field by field — the four IMessageBodyStrategy implementations and
+        # MessageUtils.BuildSegmentBody — has to carry every member, or that member is
+        # silently dropped on whichever path forgot it.
+        message_body: nil,
+        phone: nil,
+        phone_international: nil,
+        price: nil,
+        # A human-readable sentence for reason_code, for example "Insufficient balance".
+        # Omitted whenever reason_code is.
+        reason: nil,
+        # Why the message is at its current status, as a stable platform code such as
+        # DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+        # FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+        # Switch on this rather than on reason: the code is stable, the wording may be
+        # improved. It is the platform's classification of the outcome, never a carrier or
+        # vendor code.
+        reason_code: nil,
+        region_code: nil,
+        status: nil,
+        template_category: nil,
+        template_id: nil,
+        template_name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            active_contact_price: T.nilable(Float),
+            channel: String,
+            contact_id: String,
+            created_at: Time,
+            customer_id: String,
+            direction: String,
+            events: T.nilable(T::Array[Sentdm::MessageStatusEvent]),
+            message_body: T.nilable(Sentdm::MessageBody),
+            phone: String,
+            phone_international: String,
+            price: T.nilable(Float),
+            reason: T.nilable(String),
+            reason_code: T.nilable(String),
+            region_code: String,
+            status: String,
+            template_category: T.nilable(String),
+            template_id: T.nilable(String),
+            template_name: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_activities.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageActivities < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageActivities, Sentdm::Internal::AnyHash)
+        end
+
+      # List of activity events ordered by most recent first
+      sig { returns(T.nilable(T::Array[Sentdm::MessageActivity])) }
+      attr_reader :activities
+
+      sig { params(activities: T::Array[Sentdm::MessageActivity::OrHash]).void }
+      attr_writer :activities
+
+      # The message ID these activities belong to
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      # Pagination metadata for list responses
+      sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+      attr_reader :pagination
+
+      sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+      attr_writer :pagination
+
+      # Response for GET /messages/{id}/activities
+      sig do
+        params(
+          activities: T::Array[Sentdm::MessageActivity::OrHash],
+          message_id: String,
+          pagination: Sentdm::PaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # List of activity events ordered by most recent first
+        activities: nil,
+        # The message ID these activities belong to
+        message_id: nil,
+        # Pagination metadata for list responses
+        pagination: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            activities: T::Array[Sentdm::MessageActivity],
+            message_id: String,
+            pagination: Sentdm::PaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_activity.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageActivity < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageActivity, Sentdm::Internal::AnyHash)
+        end
+
+      # Active contact markup applied on top of the channel cost, formatted to 4 decimal
+      # places.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :active_contact_price
+
+      # Human-readable description of the activity
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # Sender phone number for this activity (the customer's sending number for
+      # outbound, the external sender for inbound). Null when not reported by the
+      # provider.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :from
+
+      # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+      # 4 decimal places.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :price
+
+      # A human-readable sentence for reason_code, for example "The recipient is not
+      # registered on this channel" Omitted whenever reason_code is.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # Why the message reached this status, as a stable platform code such as
+      # DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+      # activities; omitted on every status that needs no explanation. Switch on this
+      # rather than on reason: the code is stable, the wording may be improved. Same
+      # wire name and vocabulary as on the message and the webhook.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason_code
+
+      # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+      # held message will be released for delivery; on a CANCELLED entry, the instant
+      # that was called off. Same wire name as on the send response, the message and the
+      # webhook. Omitted on every other activity. A message that quiet hours moved at
+      # release has two SCHEDULED entries, each carrying the instant as it stood at that
+      # moment.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :scheduled_at
+
+      # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
+      # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # When this activity occurred
+      sig { returns(T.nilable(Time)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: Time).void }
+      attr_writer :timestamp
+
+      # A single message activity event for v3 API.
+      #
+      # The activity list mixes statuses, so unlike a message it is one shape rather
+      # than two: a SCHEDULED entry carries scheduled_at, and every other entry has no
+      # such key.
+      sig do
+        params(
+          active_contact_price: T.nilable(String),
+          description: String,
+          from: T.nilable(String),
+          price: T.nilable(String),
+          reason: T.nilable(String),
+          reason_code: T.nilable(String),
+          scheduled_at: T.nilable(Time),
+          status: String,
+          timestamp: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Active contact markup applied on top of the channel cost, formatted to 4 decimal
+        # places.
+        active_contact_price: nil,
+        # Human-readable description of the activity
+        description: nil,
+        # Sender phone number for this activity (the customer's sending number for
+        # outbound, the external sender for inbound). Null when not reported by the
+        # provider.
+        from: nil,
+        # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+        # 4 decimal places.
+        price: nil,
+        # A human-readable sentence for reason_code, for example "The recipient is not
+        # registered on this channel" Omitted whenever reason_code is.
+        reason: nil,
+        # Why the message reached this status, as a stable platform code such as
+        # DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+        # activities; omitted on every status that needs no explanation. Switch on this
+        # rather than on reason: the code is stable, the wording may be improved. Same
+        # wire name and vocabulary as on the message and the webhook.
+        reason_code: nil,
+        # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+        # held message will be released for delivery; on a CANCELLED entry, the instant
+        # that was called off. Same wire name as on the send response, the message and the
+        # webhook. Omitted on every other activity. A message that quiet hours moved at
+        # release has two SCHEDULED entries, each carrying the instant as it stood at that
+        # moment.
+        scheduled_at: nil,
+        # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
+        # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
+        status: nil,
+        # When this activity occurred
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            active_contact_price: T.nilable(String),
+            description: String,
+            from: T.nilable(String),
+            price: T.nilable(String),
+            reason: T.nilable(String),
+            reason_code: T.nilable(String),
+            scheduled_at: T.nilable(Time),
+            status: String,
+            timestamp: Time
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_body.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageBody < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::MessageBody, Sentdm::Internal::AnyHash) }
+
+      sig { returns(T.nilable(T::Array[Sentdm::MessageButton])) }
+      attr_accessor :buttons
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :content
+
+      sig { params(content: String).void }
+      attr_writer :content
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :footer
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :header
+
+      # The media asset that rode a message's header, recorded as sent.
+      sig { returns(T.nilable(Sentdm::MessageHeaderMedia)) }
+      attr_reader :header_media
+
+      sig do
+        params(header_media: T.nilable(Sentdm::MessageHeaderMedia::OrHash)).void
+      end
+      attr_writer :header_media
+
+      # MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on
+      # every other channel.
+      #
+      # Persisted rather than derived because a resend and a curfew release rebuild the
+      # send from the stored row — MessageReplayCommandBuilder reads templateId and
+      # templateVariables and nothing else — so media that lives only on the original
+      # request would silently turn a replayed MMS into a text message.
+      sig { returns(T.nilable(T::Array[Sentdm::MessageMedia])) }
+      attr_accessor :media
+
+      # MMS subject line. Null on every other channel.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subject
+
+      # Structured message body format for database storage. Preserves channel-specific
+      # components (header, header media, body, footer, buttons, MMS subject and media).
+      #
+      # Persisted as the messageBody jsonb column on Messages. Every write path goes
+      # through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
+      # shape is stable regardless of channel or status. Anything that rebuilds this
+      # object field by field — the four IMessageBodyStrategy implementations and
+      # MessageUtils.BuildSegmentBody — has to carry every member, or that member is
+      # silently dropped on whichever path forgot it.
+      sig do
+        params(
+          buttons: T.nilable(T::Array[Sentdm::MessageButton::OrHash]),
+          content: String,
+          footer: T.nilable(String),
+          header: T.nilable(String),
+          header_media: T.nilable(Sentdm::MessageHeaderMedia::OrHash),
+          media: T.nilable(T::Array[Sentdm::MessageMedia::OrHash]),
+          subject: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        buttons: nil,
+        content: nil,
+        footer: nil,
+        header: nil,
+        # The media asset that rode a message's header, recorded as sent.
+        header_media: nil,
+        # MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on
+        # every other channel.
+        #
+        # Persisted rather than derived because a resend and a curfew release rebuild the
+        # send from the stored row — MessageReplayCommandBuilder reads templateId and
+        # templateVariables and nothing else — so media that lives only on the original
+        # request would silently turn a replayed MMS into a text message.
+        media: nil,
+        # MMS subject line. Null on every other channel.
+        subject: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            buttons: T.nilable(T::Array[Sentdm::MessageButton]),
+            content: String,
+            footer: T.nilable(String),
+            header: T.nilable(String),
+            header_media: T.nilable(Sentdm::MessageHeaderMedia),
+            media: T.nilable(T::Array[Sentdm::MessageMedia]),
+            subject: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_button.rbi

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

data/rbi/sentdm/models/message_cancel_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageCancelParams < Sentdm::Models::MutationRequest
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageCancelParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
+      sig do
+        params(
+          id: String,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        idempotency_key: nil,
+        x_profile_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_channel_options.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageChannelOptions < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageChannelOptions, Sentdm::Internal::AnyHash)
+        end
+
+      # Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US).
+      # Optional. Accepted and stored, not acted on yet.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country
+
+      # Sender numbers in E.164. Each must be an active sender on your account for this
+      # channel. That is account state rather than request shape, so it is decided per
+      # message: the request is accepted with 202 and a message naming an unusable
+      # number is recorded BLOCKED with error code BUSINESS_029.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :from
+
+      # How to pick a number from From, e.g. sticky or geo. Optional. Accepted and
+      # stored, not acted on yet.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :strategy
+
+      # One entry of a channel's list in Channels, e.g. {"country": "US", "from":
+      # ["+15559990002", "+15559990003"], "strategy": "sticky"}.
+      sig do
+        params(
+          country: T.nilable(String),
+          from: T.nilable(T::Array[String]),
+          strategy: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US).
+        # Optional. Accepted and stored, not acted on yet.
+        country: nil,
+        # Sender numbers in E.164. Each must be an active sender on your account for this
+        # channel. That is account state rather than request shape, so it is decided per
+        # message: the request is accepted with 202 and a message naming an unusable
+        # number is recorded BLOCKED with error code BUSINESS_029.
+        from: nil,
+        # How to pick a number from From, e.g. sticky or geo. Optional. Accepted and
+        # stored, not acted on yet.
+        strategy: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            country: T.nilable(String),
+            from: T.nilable(T::Array[String]),
+            strategy: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end