sentdm 0.45.0 → 0.46.0

data/rbi/sentdm/models/brand_with_kyc.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandWithKYC < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::BrandWithKYC, Sentdm::Internal::AnyHash) }
+
+      # Unique identifier for the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Business details and address information
+      sig { returns(T.nilable(Sentdm::BrandBusiness)) }
+      attr_reader :business
+
+      sig { params(business: T.nilable(Sentdm::BrandBusiness::OrHash)).void }
+      attr_writer :business
+
+      # Compliance and TCR-related information
+      sig { returns(T.nilable(Sentdm::BrandCompliance)) }
+      attr_reader :compliance
+
+      sig do
+        params(compliance: T.nilable(Sentdm::BrandCompliance::OrHash)).void
+      end
+      attr_writer :compliance
+
+      # Contact information for the brand
+      sig { returns(T.nilable(Sentdm::BrandContact)) }
+      attr_reader :contact
+
+      sig { params(contact: T.nilable(Sentdm::BrandContact::OrHash)).void }
+      attr_writer :contact
+
+      # When the brand was created
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # 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
+
+      sig { returns(T.nilable(Sentdm::TcrBrandIdentityStatus::TaggedSymbol)) }
+      attr_accessor :identity_status
+
+      # Whether this brand is inherited from the parent organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_inherited
+
+      sig { params(is_inherited: T::Boolean).void }
+      attr_writer :is_inherited
+
+      sig { returns(T.nilable(Sentdm::TcrBrandStatus::TaggedSymbol)) }
+      attr_accessor :status
+
+      # When the brand was submitted to TCR
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :submitted_at
+
+      # Whether this brand has been submitted to TCR
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :submitted_to_tcr
+
+      sig { params(submitted_to_tcr: T::Boolean).void }
+      attr_writer :submitted_to_tcr
+
+      # TCR brand ID (populated after TCR submission)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tcr_brand_id
+
+      # Universal EIN from TCR
+      sig { returns(T.nilable(String)) }
+      attr_accessor :universal_ein
+
+      # When the brand was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # Brand response with nested contact, business, and compliance sections — mirrors
+      # the request structure.
+      sig do
+        params(
+          id: String,
+          business: T.nilable(Sentdm::BrandBusiness::OrHash),
+          compliance: T.nilable(Sentdm::BrandCompliance::OrHash),
+          contact: T.nilable(Sentdm::BrandContact::OrHash),
+          created_at: Time,
+          csp_id: T.nilable(String),
+          identity_status: T.nilable(Sentdm::TcrBrandIdentityStatus::OrSymbol),
+          is_inherited: T::Boolean,
+          status: T.nilable(Sentdm::TcrBrandStatus::OrSymbol),
+          submitted_at: T.nilable(Time),
+          submitted_to_tcr: T::Boolean,
+          tcr_brand_id: T.nilable(String),
+          universal_ein: T.nilable(String),
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the brand
+        id: nil,
+        # Business details and address information
+        business: nil,
+        # Compliance and TCR-related information
+        compliance: nil,
+        # Contact information for the brand
+        contact: nil,
+        # When the brand was created
+        created_at: nil,
+        # 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
+        is_inherited: nil,
+        status: nil,
+        # When the brand was submitted to TCR
+        submitted_at: nil,
+        # Whether this brand has been submitted to TCR
+        submitted_to_tcr: nil,
+        # TCR brand ID (populated after TCR submission)
+        tcr_brand_id: nil,
+        # Universal EIN from TCR
+        universal_ein: nil,
+        # When the brand was last updated
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business: T.nilable(Sentdm::BrandBusiness),
+            compliance: T.nilable(Sentdm::BrandCompliance),
+            contact: T.nilable(Sentdm::BrandContact),
+            created_at: Time,
+            csp_id: T.nilable(String),
+            identity_status:
+              T.nilable(Sentdm::TcrBrandIdentityStatus::TaggedSymbol),
+            is_inherited: T::Boolean,
+            status: T.nilable(Sentdm::TcrBrandStatus::TaggedSymbol),
+            submitted_at: T.nilable(Time),
+            submitted_to_tcr: T::Boolean,
+            tcr_brand_id: T.nilable(String),
+            universal_ein: T.nilable(String),
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/cancelled_message.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class CancelledMessage < Sentdm::Models::Message
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::CancelledMessage, Sentdm::Internal::AnyHash)
+        end
+
+      # The send time that was called off, in UTC — the scheduled_at the message was
+      # being held for, whether you set it or the recipient's quiet hours moved it
+      # there. Omitted only for a held message that carried no recorded instant.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :scheduled_at
+
+      # 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 { params(scheduled_at: T.nilable(Time)).returns(T.attached_class) }
+      def self.new(
+        # The send time that was called off, in UTC — the scheduled_at the message was
+        # being held for, whether you set it or the recipient's quiet hours moved it
+        # there. Omitted only for a held message that carried no recorded instant.
+        scheduled_at: nil
+      )
+      end
+
+      sig { override.returns({ scheduled_at: T.nilable(Time) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channel_event_payload.rbi

@@ -53,12 +53,12 @@ module Sentdm
       # fetched; empty says the market has been given none. The parent object is null
       # only when the market registers with nobody and compliance was not computed —
       # nothing to show at all.
-      sig { returns(T.nilable(Sentdm::ChannelEventPayload::Compliance)) }
+      sig { returns(T.nilable(Sentdm::Channels::SuppliedCompliance)) }
       attr_reader :compliance
 
       sig do
         params(
-          compliance: T.nilable(Sentdm::ChannelEventPayload::Compliance::OrHash)
+          compliance: T.nilable(Sentdm::Channels::SuppliedCompliance::OrHash)
         ).void
       end
       attr_writer :compliance
@@ -144,8 +144,7 @@ module Sentdm
           country: String,
           account_id: String,
           channel: String,
-          compliance:
-            T.nilable(Sentdm::ChannelEventPayload::Compliance::OrHash),
+          compliance: T.nilable(Sentdm::Channels::SuppliedCompliance::OrHash),
           number_type: T.nilable(String),
           reason: T.nilable(String),
           reason_code: T.nilable(String),
@@ -236,7 +235,7 @@ module Sentdm
             country: String,
             account_id: String,
             channel: String,
-            compliance: T.nilable(Sentdm::ChannelEventPayload::Compliance),
+            compliance: T.nilable(Sentdm::Channels::SuppliedCompliance),
             number_type: T.nilable(String),
             reason: T.nilable(String),
             reason_code: T.nilable(String),
@@ -248,205 +247,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class Compliance < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::ChannelEventPayload::Compliance,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # The identity this market registers under, with inherit saying whose it is.
-        #
-        # Reported here rather than on the profile because it belongs to the registration
-        # this market files, and only one market files one. It was a top-level block for a
-        # while, which put a per-registration value beside a list of markets and left a
-        # caller to work out which market it belonged to.
-        #
-        # Absent for a market that registers with nobody — such a market asks for no
-        # identity, so there is none to report. Absent and null mean different things:
-        # absent says this market does not ask, null would say it asks and nothing was
-        # supplied.
-        #
-        # Untyped, like the request side, because its members are declared by the market's
-        # own schema rather than by a C# class. A typed pair here would be a second
-        # definition of what a market wants, free to drift from the one that validates.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_accessor :brand
-
-        # The programme this market registers, with inherit saying whose it is.
-        #
-        # One, not a list. TcrCampaigns permits several and an account built on the admin
-        # side may hold them, but this surface offers one — which is what lets the
-        # market's PATCH be an upsert rather than a collection with an addressable create
-        # behind it. An account holding several is reported as its first and refused on
-        # write, rather than half-edited.
-        #
-        # Carries no id. Nothing addresses a campaign, and an undeclared key would be
-        # refused if the caller sent this object back — which it is meant to be able to
-        # do.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_accessor :campaign
-
-        # What has been supplied for this market.
-        #
-        # Files, not values — the declared halves above carry the values. A document
-        # cannot be a JSON value, so it is sent as multipart on the channel call and
-        # reported here as a reference.
-        #
-        # Absent on a list read, which fetches identity but does not compute compliance
-        # documents per market. Absent and empty mean different things: absent says the
-        # documents were not fetched; empty says the market has been given none.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[Sentdm::ChannelEventPayload::Compliance::Document]
-            )
-          )
-        end
-        attr_accessor :documents
-
-        # What a market has been given: the identity it registers under, its programme,
-        # and any documents attached.
-        #
-        # What it does not carry is what the market asks for. That is the subject of GET
-        # /v3/compliance/requirements, and it is the same answer for every caller — a
-        # description of what a compliance regime wants, not a record of one customer's
-        # progress through it. It was reported here as well for a while, which put the
-        # same array in six response shapes and left a caller deciding which of two
-        # sources to believe.
-        #
-        # Present on a list read for markets that register (carrying brand and campaign),
-        # but with documents absent — documents are not fetched for a list, because a
-        # catalog lookup and a document read per market would multiply across a page.
-        # Absent documents is distinct from an empty list: absent says they were not
-        # fetched; empty says the market has been given none. The parent object is null
-        # only when the market registers with nobody and compliance was not computed —
-        # nothing to show at all.
-        sig do
-          params(
-            brand: T.nilable(T::Hash[Symbol, T.anything]),
-            campaign: T.nilable(T::Hash[Symbol, T.anything]),
-            documents:
-              T.nilable(
-                T::Array[
-                  Sentdm::ChannelEventPayload::Compliance::Document::OrHash
-                ]
-              )
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The identity this market registers under, with inherit saying whose it is.
-          #
-          # Reported here rather than on the profile because it belongs to the registration
-          # this market files, and only one market files one. It was a top-level block for a
-          # while, which put a per-registration value beside a list of markets and left a
-          # caller to work out which market it belonged to.
-          #
-          # Absent for a market that registers with nobody — such a market asks for no
-          # identity, so there is none to report. Absent and null mean different things:
-          # absent says this market does not ask, null would say it asks and nothing was
-          # supplied.
-          #
-          # Untyped, like the request side, because its members are declared by the market's
-          # own schema rather than by a C# class. A typed pair here would be a second
-          # definition of what a market wants, free to drift from the one that validates.
-          brand: nil,
-          # The programme this market registers, with inherit saying whose it is.
-          #
-          # One, not a list. TcrCampaigns permits several and an account built on the admin
-          # side may hold them, but this surface offers one — which is what lets the
-          # market's PATCH be an upsert rather than a collection with an addressable create
-          # behind it. An account holding several is reported as its first and refused on
-          # write, rather than half-edited.
-          #
-          # Carries no id. Nothing addresses a campaign, and an undeclared key would be
-          # refused if the caller sent this object back — which it is meant to be able to
-          # do.
-          campaign: nil,
-          # What has been supplied for this market.
-          #
-          # Files, not values — the declared halves above carry the values. A document
-          # cannot be a JSON value, so it is sent as multipart on the channel call and
-          # reported here as a reference.
-          #
-          # Absent on a list read, which fetches identity but does not compute compliance
-          # documents per market. Absent and empty mean different things: absent says the
-          # documents were not fetched; empty says the market has been given none.
-          documents: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              brand: T.nilable(T::Hash[Symbol, T.anything]),
-              campaign: T.nilable(T::Hash[Symbol, T.anything]),
-              documents:
-                T.nilable(
-                  T::Array[Sentdm::ChannelEventPayload::Compliance::Document]
-                )
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Document < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::ChannelEventPayload::Compliance::Document,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # Identifier of the upload, for fetching it back through the documents endpoints.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :document_id
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :file_name
-
-          # The catalog's name for this document, matching the requirement it satisfies.
-          sig { returns(T.nilable(String)) }
-          attr_reader :key
-
-          sig { params(key: String).void }
-          attr_writer :key
-
-          # A document a market asked for and has been given.
-          sig do
-            params(
-              document_id: T.nilable(String),
-              file_name: T.nilable(String),
-              key: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Identifier of the upload, for fetching it back through the documents endpoints.
-            document_id: nil,
-            file_name: nil,
-            # The catalog's name for this document, matching the requirement it satisfies.
-            key: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                document_id: T.nilable(String),
-                file_name: T.nilable(String),
-                key: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/channel_list_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ChannelListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ChannelListParams, Sentdm::Internal::AnyHash)
+        end
+
+      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(
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(x_profile_id: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { x_profile_id: String, request_options: Sentdm::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channel_score.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ChannelScore < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::ChannelScore, Sentdm::Internal::AnyHash) }
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # Percentage (0-100) of messages on this channel that ended in FAILED.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :fail_score
+
+      sig { params(fail_score: Integer).void }
+      attr_writer :fail_score
+
+      # Percentage (0-100) of messages on this channel that reached a successful
+      # terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :success_score
+
+      sig { params(success_score: Integer).void }
+      attr_writer :success_score
+
+      sig do
+        params(
+          channel: String,
+          fail_score: Integer,
+          success_score: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        channel: nil,
+        # Percentage (0-100) of messages on this channel that ended in FAILED.
+        fail_score: nil,
+        # Percentage (0-100) of messages on this channel that reached a successful
+        # terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+        success_score: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { channel: String, fail_score: Integer, success_score: Integer }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/api_response_of_list_of_sms_market.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class APIResponseOfListOfSMSMarket < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::APIResponseOfListOfSMSMarket,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The response data (null if error)
+        sig { returns(T.nilable(T::Array[Sentdm::Channels::SMSMarket])) }
+        attr_accessor :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(T::Array[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(
+          # The response data (null if error)
+          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(T::Array[Sentdm::Channels::SMSMarket]),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end