sentdm 0.44.0 → 0.46.0

data/rbi/sentdm/models/channels/api_response_of_rcs_agent.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class APIResponseOfRcsAgent < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::APIResponseOfRcsAgent,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # An RCS agent as its owner sees it: the order form back, plus where the
+        # submission stands.
+        #
+        # Not RcsSenderResponse. That one is the admin projection and carries the pipeline
+        # we track about a customer's request — internalStatus, statusReason, isLaunched —
+        # and the S3 keys behind the assets. None of that is the customer's to read: an
+        # internal status is a note to ourselves, and an S3 key is a storage detail that
+        # would become a contract the moment it was published.
+        #
+        # What is here is what the caller sent, in the names it sent them under, plus the
+        # three things only we can answer: the record's id, its status, and the number it
+        # sends from. So a read after a write shows the form as stored rather than as
+        # echoed.
+        sig { returns(T.nilable(Sentdm::Channels::RcsAgent)) }
+        attr_reader :data
+
+        sig { params(data: T.nilable(Sentdm::Channels::RcsAgent::OrHash)).void }
+        attr_writer :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        attr_writer :meta
+
+        # Indicates whether the request was successful
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :success
+
+        sig { params(success: T::Boolean).void }
+        attr_writer :success
+
+        # Standard API response envelope for all v3 endpoints
+        sig do
+          params(
+            data: T.nilable(Sentdm::Channels::RcsAgent::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An RCS agent as its owner sees it: the order form back, plus where the
+          # submission stands.
+          #
+          # Not RcsSenderResponse. That one is the admin projection and carries the pipeline
+          # we track about a customer's request — internalStatus, statusReason, isLaunched —
+          # and the S3 keys behind the assets. None of that is the customer's to read: an
+          # internal status is a note to ourselves, and an S3 key is a storage detail that
+          # would become a contract the moment it was published.
+          #
+          # What is here is what the caller sent, in the names it sent them under, plus the
+          # three things only we can answer: the record's id, its status, and the number it
+          # sends from. So a read after a write shows the form as stored rather than as
+          # echoed.
+          data: nil,
+          # Error information
+          error: nil,
+          # Request and response metadata
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T.nilable(Sentdm::Channels::RcsAgent),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/api_response_of_sms_market.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class APIResponseOfSMSMarket < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::APIResponseOfSMSMarket,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # One SMS market the profile sends in — its sender, where that sender stands, and
+        # what the market wants.
+        #
+        # A profile may send in several: it is a tenant, not a market. Each carries its
+        # own status, because a profile can be live in one country and mid-registration in
+        # another — and each carries what it still owes, rather than that being reported
+        # in a separate array a caller has to join on.
+        sig { returns(T.nilable(Sentdm::Channels::SMSMarket)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Channels::SMSMarket::OrHash)).void
+        end
+        attr_writer :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        attr_writer :meta
+
+        # Indicates whether the request was successful
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :success
+
+        sig { params(success: T::Boolean).void }
+        attr_writer :success
+
+        # Standard API response envelope for all v3 endpoints
+        sig do
+          params(
+            data: T.nilable(Sentdm::Channels::SMSMarket::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # One SMS market the profile sends in — its sender, where that sender stands, and
+          # what the market wants.
+          #
+          # A profile may send in several: it is a tenant, not a market. Each carries its
+          # own status, because a profile can be live in one country and mid-registration in
+          # another — and each carries what it still owes, rather than that being reported
+          # in a separate array a caller has to join on.
+          data: nil,
+          # Error information
+          error: nil,
+          # Request and response metadata
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T.nilable(Sentdm::Channels::SMSMarket),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/api_response_of_whatsapp_channel.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    APIResponseOfWhatsappChannel = Channels::APIResponseOfWhatsappChannel
+
+    module Channels
+      class APIResponseOfWhatsappChannel < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::APIResponseOfWhatsappChannel,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The profile's WhatsApp account. Its status is Meta's verification state.
+        sig { returns(T.nilable(Sentdm::Channels::WhatsappChannel)) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: T.nilable(Sentdm::Channels::WhatsappChannel::OrHash)
+          ).void
+        end
+        attr_writer :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        attr_writer :meta
+
+        # Indicates whether the request was successful
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :success
+
+        sig { params(success: T::Boolean).void }
+        attr_writer :success
+
+        # Standard API response envelope for all v3 endpoints
+        sig do
+          params(
+            data: T.nilable(Sentdm::Channels::WhatsappChannel::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The profile's WhatsApp account. Its status is Meta's verification state.
+          data: nil,
+          # Error information
+          error: nil,
+          # Request and response metadata
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T.nilable(Sentdm::Channels::WhatsappChannel),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end