sentdm 0.45.0 → 0.46.0

data/rbi/sentdm/models/{profile_complete_response.rbi → api_response_of_profile_completion_result.rbi}

@@ -2,24 +2,22 @@
 
 module Sentdm
   module Models
-    class ProfileCompleteResponse < Sentdm::Internal::Type::BaseModel
+    class APIResponseOfProfileCompletionResult < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Sentdm::Models::ProfileCompleteResponse,
+            Sentdm::APIResponseOfProfileCompletionResult,
             Sentdm::Internal::AnyHash
           )
         end
 
       # Response when a profile is already in the completed state and no further action
       # is taken.
-      sig { returns(T.nilable(Sentdm::Models::ProfileCompleteResponse::Data)) }
+      sig { returns(T.nilable(Sentdm::ProfileCompletionResult)) }
       attr_reader :data
 
       sig do
-        params(
-          data: T.nilable(Sentdm::Models::ProfileCompleteResponse::Data::OrHash)
-        ).void
+        params(data: T.nilable(Sentdm::ProfileCompletionResult::OrHash)).void
       end
       attr_writer :data
 
@@ -47,8 +45,7 @@ module Sentdm
       # Standard API response envelope for all v3 endpoints
       sig do
         params(
-          data:
-            T.nilable(Sentdm::Models::ProfileCompleteResponse::Data::OrHash),
+          data: T.nilable(Sentdm::ProfileCompletionResult::OrHash),
           error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
@@ -70,7 +67,7 @@ module Sentdm
       sig do
         override.returns(
           {
-            data: T.nilable(Sentdm::Models::ProfileCompleteResponse::Data),
+            data: T.nilable(Sentdm::ProfileCompletionResult),
             error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
@@ -79,49 +76,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class Data < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::Models::ProfileCompleteResponse::Data,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # Human-readable message describing the result.
-        sig { returns(T.nilable(String)) }
-        attr_reader :message
-
-        sig { params(message: String).void }
-        attr_writer :message
-
-        # Current process status of the profile (e.g., "completed", "submitted",
-        # "in_progress").
-        sig { returns(T.nilable(String)) }
-        attr_reader :status
-
-        sig { params(status: String).void }
-        attr_writer :status
-
-        # Response when a profile is already in the completed state and no further action
-        # is taken.
-        sig do
-          params(message: String, status: String).returns(T.attached_class)
-        end
-        def self.new(
-          # Human-readable message describing the result.
-          message: nil,
-          # Current process status of the profile (e.g., "completed", "submitted",
-          # "in_progress").
-          status: nil
-        )
-        end
-
-        sig { override.returns({ message: String, status: String }) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/api_response_of_profiles_list.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfProfilesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfProfilesList, Sentdm::Internal::AnyHash)
+        end
+
+      # The profiles in the organization.
+      sig { returns(T.nilable(Sentdm::ProfilesList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::ProfilesList::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::ProfilesList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The profiles in the organization.
+        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::ProfilesList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_sender_profile.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfSenderProfile < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfSenderProfile, Sentdm::Internal::AnyHash)
+        end
+
+      # A sender profile as the API reports it — the same document the create call
+      # accepts, plus the read-only facts it cannot: each market's status and what it
+      # still owes.
+      #
+      # No status at the profile, brand or campaign level. Brand and campaign are
+      # identity, and identity has no lifecycle. What has one is the registration of a
+      # sender in a market, and the approval of a channel — so status lives there, where
+      # it says which specific thing is blocked rather than flattening several answers
+      # into one.
+      sig { returns(T.nilable(Sentdm::SenderProfile)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::SenderProfile::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::SenderProfile::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A sender profile as the API reports it — the same document the create call
+        # accepts, plus the read-only facts it cannot: each market's status and what it
+        # still owes.
+        #
+        # No status at the profile, brand or campaign level. Brand and campaign are
+        # identity, and identity has no lifecycle. What has one is the registration of a
+        # sender in a market, and the approval of a channel — so status lives there, where
+        # it says which specific thing is blocked rather than flattening several answers
+        # into one.
+        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::SenderProfile),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_sender_profiles_list.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfSenderProfilesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::APIResponseOfSenderProfilesList,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # A paginated list of sender profiles.
+      sig { returns(T.nilable(Sentdm::SenderProfilesList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::SenderProfilesList::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::SenderProfilesList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A paginated list of sender profiles.
+        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::SenderProfilesList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_templates_list.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfTemplatesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfTemplatesList, Sentdm::Internal::AnyHash)
+        end
+
+      # A paginated list of templates.
+      sig { returns(T.nilable(Sentdm::TemplatesList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::TemplatesList::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::TemplatesList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A paginated list of templates.
+        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::TemplatesList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_users_list.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfUsersList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfUsersList, Sentdm::Internal::AnyHash)
+        end
+
+      # The users in the organization.
+      sig { returns(T.nilable(Sentdm::UsersList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::UsersList::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::UsersList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The users in the organization.
+        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::UsersList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_webhook_event_types_list.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhookEventTypesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::APIResponseOfWebhookEventTypesList,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The webhook event types a customer can subscribe to.
+      sig { returns(T.nilable(Sentdm::WebhookEventTypesList)) }
+      attr_reader :data
+
+      sig do
+        params(data: T.nilable(Sentdm::WebhookEventTypesList::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::WebhookEventTypesList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The webhook event types a customer can subscribe to.
+        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::WebhookEventTypesList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_webhook_events_list.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhookEventsList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::APIResponseOfWebhookEventsList,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # A paginated list of webhook delivery records.
+      sig { returns(T.nilable(Sentdm::WebhookEventsList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhookEventsList::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::WebhookEventsList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A paginated list of webhook delivery records.
+        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::WebhookEventsList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end