sentdm 0.44.0 → 0.46.0

data/rbi/sentdm/models/template_mms_body_content.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateMmsBodyContent < Sentdm::Models::TemplateBodyContent
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateMmsBodyContent, Sentdm::Internal::AnyHash)
+        end
+
+      # Attachments carried by every send on this template, in order. A per-send
+      # media_urls on the request replaces this list rather than adding to it, so a
+      # template can hold a default creative and a caller can still send something
+      # recipient-specific.
+      sig { returns(T.nilable(T::Array[Sentdm::TemplateMediaItem])) }
+      attr_accessor :media
+
+      # MMS subject line. Optional — most handsets render it above the body, some ignore
+      # it entirely. Deliberately its own field rather than riding TemplateHeader: the
+      # header is authored once and shared across every channel, and carries Meta's
+      # 60-character cap plus its no-newline, no-emoji text rules, none of which
+      # describe an MMS subject.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subject
+
+      # MMS-specific body content.
+      #
+      # Why MMS needs its own type when the other channels share one: it is the only
+      # channel with a subject line and the only one with attachments. Every other
+      # channel's body is text and variables, which is exactly what TemplateBodyContent
+      # already is. Putting Subject and Media on the shared type instead would give sms,
+      # whatsapp and rcs two members none of them can ever use.
+      #
+      # Derives from TemplateBodyContent so that every existing consumer of a body slot
+      # — MessageUtils.ConvertVariableToReadable,
+      # TemplateDefinition.GetRequiredVariables,
+      # TemplateDefinitionValidator.ApplyBodyContentRules — reads it with no change. The
+      # two extra members are what the MMS strategy and the provider request need on
+      # top.
+      sig do
+        params(
+          media: T.nilable(T::Array[Sentdm::TemplateMediaItem::OrHash]),
+          subject: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Attachments carried by every send on this template, in order. A per-send
+        # media_urls on the request replaces this list rather than adding to it, so a
+        # template can hold a default creative and a caller can still send something
+        # recipient-specific.
+        media: nil,
+        # MMS subject line. Optional — most handsets render it above the body, some ignore
+        # it entirely. Deliberately its own field rather than riding TemplateHeader: the
+        # header is authored once and shared across every channel, and carries Meta's
+        # 60-character cap plus its no-newline, no-emoji text rules, none of which
+        # describe an MMS subject.
+        subject: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            media: T.nilable(T::Array[Sentdm::TemplateMediaItem]),
+            subject: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/template_ref.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateRef < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::TemplateRef, Sentdm::Internal::AnyHash) }
+
+      # Template ID (mutually exclusive with name)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+
+      # Template name (mutually exclusive with id)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # Template variable parameters for personalization, keyed by variable name.
+      #
+      # Every variable the template declares is required; GET /v3/templates/{id} lists
+      # them. Supplying a key the template does not declare is ignored.
+      #
+      # Media headers. A template whose header is an image (designed in WhatsApp Manager
+      # and imported into Sent) declares a reserved header_image key. Its value is a
+      # publicly reachable https URL that Meta fetches at send time — Sent does not host
+      # the asset, and the sample approved with the template is not reused. The key is
+      # derived from the header's media type, so header_video and header_document follow
+      # the same shape when those formats ship.
+      #
+      # "parameters": { "header_image": "https://cdn.example.com/banner.jpg", "name":
+      # "John Doe" }
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :parameters
+
+      # SDK-style template reference: resolve by ID or by name, with optional
+      # parameters.
+      sig do
+        params(
+          id: T.nilable(String),
+          name: T.nilable(String),
+          parameters: T.nilable(T::Hash[Symbol, String])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template ID (mutually exclusive with name)
+        id: nil,
+        # Template name (mutually exclusive with id)
+        name: nil,
+        # Template variable parameters for personalization, keyed by variable name.
+        #
+        # Every variable the template declares is required; GET /v3/templates/{id} lists
+        # them. Supplying a key the template does not declare is ignored.
+        #
+        # Media headers. A template whose header is an image (designed in WhatsApp Manager
+        # and imported into Sent) declares a reserved header_image key. Its value is a
+        # publicly reachable https URL that Meta fetches at send time — Sent does not host
+        # the asset, and the sample approved with the template is not reused. The key is
+        # derived from the header's media type, so header_video and header_document follow
+        # the same shape when those formats ship.
+        #
+        # "parameters": { "header_image": "https://cdn.example.com/banner.jpg", "name":
+        # "John Doe" }
+        parameters: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: T.nilable(String),
+            name: T.nilable(String),
+            parameters: T.nilable(T::Hash[Symbol, String])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/template_variable.rbi

@@ -14,10 +14,10 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :name
 
-      sig { returns(Sentdm::TemplateVariable::Props) }
+      sig { returns(Sentdm::TemplateVariableProps) }
       attr_reader :props
 
-      sig { params(props: Sentdm::TemplateVariable::Props::OrHash).void }
+      sig { params(props: Sentdm::TemplateVariableProps::OrHash).void }
       attr_writer :props
 
       # One of variable, link or media. Decides which Props fields are required.
@@ -40,7 +40,7 @@ module Sentdm
       sig do
         params(
           name: String,
-          props: Sentdm::TemplateVariable::Props::OrHash,
+          props: Sentdm::TemplateVariableProps::OrHash,
           type: String,
           id: Integer
         ).returns(T.attached_class)
@@ -68,7 +68,7 @@ module Sentdm
         override.returns(
           {
             name: String,
-            props: Sentdm::TemplateVariable::Props,
+            props: Sentdm::TemplateVariableProps,
             type: String,
             id: Integer
           }
@@ -76,82 +76,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class Props < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Sentdm::TemplateVariable::Props, Sentdm::Internal::AnyHash)
-          end
-
-        sig { returns(String) }
-        attr_accessor :media_type
-
-        # Example value substituted into the template when previewing it and when
-        # submitting it to Meta for review. Free text by nature, so the converter accepts
-        # a JSON number or boolean here and normalizes it — see
-        # JsonScalarToStringConverter for why — and guarantees it is always serialized
-        # back out as a JSON string.
-        sig { returns(String) }
-        attr_accessor :sample
-
-        sig { returns(String) }
-        attr_accessor :url
-
-        sig { returns(String) }
-        attr_accessor :variable_type
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :alt
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :regex
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :short_url
-
-        sig do
-          params(
-            media_type: String,
-            sample: String,
-            url: String,
-            variable_type: String,
-            alt: T.nilable(String),
-            regex: T.nilable(String),
-            short_url: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          media_type:,
-          # Example value substituted into the template when previewing it and when
-          # submitting it to Meta for review. Free text by nature, so the converter accepts
-          # a JSON number or boolean here and normalizes it — see
-          # JsonScalarToStringConverter for why — and guarantees it is always serialized
-          # back out as a JSON string.
-          sample:,
-          url:,
-          variable_type:,
-          alt: nil,
-          regex: nil,
-          short_url: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              media_type: String,
-              sample: String,
-              url: String,
-              variable_type: String,
-              alt: T.nilable(String),
-              regex: T.nilable(String),
-              short_url: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/template_variable_props.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateVariableProps < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateVariableProps, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :media_type
+
+      # Example value substituted into the template when previewing it and when
+      # submitting it to Meta for review. Free text by nature, so the converter accepts
+      # a JSON number or boolean here and normalizes it — see
+      # JsonScalarToStringConverter for why — and guarantees it is always serialized
+      # back out as a JSON string.
+      sig { returns(String) }
+      attr_accessor :sample
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { returns(String) }
+      attr_accessor :variable_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :alt
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :regex
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :short_url
+
+      sig do
+        params(
+          media_type: String,
+          sample: String,
+          url: String,
+          variable_type: String,
+          alt: T.nilable(String),
+          regex: T.nilable(String),
+          short_url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        media_type:,
+        # Example value substituted into the template when previewing it and when
+        # submitting it to Meta for review. Free text by nature, so the converter accepts
+        # a JSON number or boolean here and normalizes it — see
+        # JsonScalarToStringConverter for why — and guarantees it is always serialized
+        # back out as a JSON string.
+        sample:,
+        url:,
+        variable_type:,
+        alt: nil,
+        regex: nil,
+        short_url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            media_type: String,
+            sample: String,
+            url: String,
+            variable_type: String,
+            alt: T.nilable(String),
+            regex: T.nilable(String),
+            short_url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/templates_list.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplatesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::TemplatesList, Sentdm::Internal::AnyHash) }
+
+      # 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 templates on this page.
+      sig { returns(T.nilable(T::Array[Sentdm::Template])) }
+      attr_reader :templates
+
+      sig { params(templates: T::Array[Sentdm::Template::OrHash]).void }
+      attr_writer :templates
+
+      # A paginated list of templates.
+      sig do
+        params(
+          pagination: Sentdm::PaginationMeta::OrHash,
+          templates: T::Array[Sentdm::Template::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Pagination metadata for list responses
+        pagination: nil,
+        # The templates on this page.
+        templates: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            pagination: Sentdm::PaginationMeta,
+            templates: T::Array[Sentdm::Template]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/users_list.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UsersList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::UsersList, Sentdm::Internal::AnyHash) }
+
+      # 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 users on this page.
+      sig { returns(T.nilable(T::Array[Sentdm::UserResponse])) }
+      attr_reader :users
+
+      sig { params(users: T::Array[Sentdm::UserResponse::OrHash]).void }
+      attr_writer :users
+
+      # The users in the organization.
+      sig do
+        params(
+          pagination: Sentdm::PaginationMeta::OrHash,
+          users: T::Array[Sentdm::UserResponse::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Pagination metadata for list responses
+        pagination: nil,
+        # The users on this page.
+        users: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            pagination: Sentdm::PaginationMeta,
+            users: T::Array[Sentdm::UserResponse]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/call.rbi

@@ -71,7 +71,7 @@ module Sentdm
         # call your answer connected to a phone number ran the caller's leg to your number
         # and the leg to the connected number at once, and both are billed. Null until the
         # call has been priced
-        sig { returns(T.nilable(T::Array[Sentdm::Voice::Call::Leg])) }
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::CallLeg])) }
         attr_accessor :legs
 
         # The calling mode: inapp for a call between people in your app and phone numbers,
@@ -141,7 +141,7 @@ module Sentdm
             ended_at: T.nilable(Time),
             failure_reason: T.nilable(String),
             from: Sentdm::Voice::CallParty::OrHash,
-            legs: T.nilable(T::Array[Sentdm::Voice::Call::Leg::OrHash]),
+            legs: T.nilable(T::Array[Sentdm::Voice::CallLeg::OrHash]),
             mode: String,
             number: String,
             price: T.nilable(Float),
@@ -226,7 +226,7 @@ module Sentdm
               ended_at: T.nilable(Time),
               failure_reason: T.nilable(String),
               from: Sentdm::Voice::CallParty,
-              legs: T.nilable(T::Array[Sentdm::Voice::Call::Leg]),
+              legs: T.nilable(T::Array[Sentdm::Voice::CallLeg]),
               mode: String,
               number: String,
               price: T.nilable(Float),
@@ -240,89 +240,6 @@ module Sentdm
         end
         def to_hash
         end
-
-        class Leg < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(Sentdm::Voice::Call::Leg, Sentdm::Internal::AnyHash)
-            end
-
-          # The whole minutes the leg was billed for
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :billed_minutes
-
-          sig { params(billed_minutes: Integer).void }
-          attr_writer :billed_minutes
-
-          # What the leg cost, in the same unit as the call's price
-          sig { returns(T.nilable(Float)) }
-          attr_reader :cost
-
-          sig { params(cost: Float).void }
-          attr_writer :cost
-
-          # The currency of the cost: USD
-          sig { returns(T.nilable(String)) }
-          attr_reader :currency
-
-          sig { params(currency: String).void }
-          attr_writer :currency
-
-          # inbound for the caller's leg to your number, outbound for a leg placed on your
-          # behalf
-          sig { returns(T.nilable(String)) }
-          attr_reader :direction
-
-          sig { params(direction: String).void }
-          attr_writer :direction
-
-          # The phone number the leg reached, in E.164 format: your number for the inbound
-          # leg, the number dialed for an outbound one. Null for a leg to one of your app
-          # users or a room
-          sig { returns(T.nilable(String)) }
-          attr_accessor :number
-
-          # One leg of a call the price covers
-          sig do
-            params(
-              billed_minutes: Integer,
-              cost: Float,
-              currency: String,
-              direction: String,
-              number: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The whole minutes the leg was billed for
-            billed_minutes: nil,
-            # What the leg cost, in the same unit as the call's price
-            cost: nil,
-            # The currency of the cost: USD
-            currency: nil,
-            # inbound for the caller's leg to your number, outbound for a leg placed on your
-            # behalf
-            direction: nil,
-            # The phone number the leg reached, in E.164 format: your number for the inbound
-            # leg, the number dialed for an outbound one. Null for a leg to one of your app
-            # users or a room
-            number: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                billed_minutes: Integer,
-                cost: Float,
-                currency: String,
-                direction: String,
-                number: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/sentdm/models/voice/call_leg.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class CallLeg < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::CallLeg, Sentdm::Internal::AnyHash)
+          end
+
+        # The whole minutes the leg was billed for
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :billed_minutes
+
+        sig { params(billed_minutes: Integer).void }
+        attr_writer :billed_minutes
+
+        # What the leg cost, in the same unit as the call's price
+        sig { returns(T.nilable(Float)) }
+        attr_reader :cost
+
+        sig { params(cost: Float).void }
+        attr_writer :cost
+
+        # The currency of the cost: USD
+        sig { returns(T.nilable(String)) }
+        attr_reader :currency
+
+        sig { params(currency: String).void }
+        attr_writer :currency
+
+        # inbound for the caller's leg to your number, outbound for a leg placed on your
+        # behalf
+        sig { returns(T.nilable(String)) }
+        attr_reader :direction
+
+        sig { params(direction: String).void }
+        attr_writer :direction
+
+        # The phone number the leg reached, in E.164 format: your number for the inbound
+        # leg, the number dialed for an outbound one. Null for a leg to one of your app
+        # users or a room
+        sig { returns(T.nilable(String)) }
+        attr_accessor :number
+
+        # One leg of a call the price covers
+        sig do
+          params(
+            billed_minutes: Integer,
+            cost: Float,
+            currency: String,
+            direction: String,
+            number: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The whole minutes the leg was billed for
+          billed_minutes: nil,
+          # What the leg cost, in the same unit as the call's price
+          cost: nil,
+          # The currency of the cost: USD
+          currency: nil,
+          # inbound for the caller's leg to your number, outbound for a leg placed on your
+          # behalf
+          direction: nil,
+          # The phone number the leg reached, in E.164 format: your number for the inbound
+          # leg, the number dialed for an outbound one. Null for a leg to one of your app
+          # users or a room
+          number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              billed_minutes: Integer,
+              cost: Float,
+              currency: String,
+              direction: String,
+              number: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end