sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/models/me_retrieve_response.rbi

@@ -0,0 +1,314 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MeRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::Models::MeRetrieveResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::MeRetrieveResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::MeRetrieveResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
+
+      # Metadata about the request and response
+      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::Models::MeRetrieveResponse::Data::OrHash),
+          error: T.nilable(Sentdm::APIError::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 details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::MeRetrieveResponse::Data),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MeRetrieveResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Customer ID (organization or profile)
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # When the account was created
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Account description
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Account icon URL
+        sig { returns(T.nilable(String)) }
+        attr_accessor :icon
+
+        # Account name
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # List of profiles (only for organization type)
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Sentdm::Models::MeRetrieveResponse::Data::Profile]
+            )
+          )
+        end
+        attr_accessor :profiles
+
+        # Profile settings (only for profile type)
+        sig { returns(T.nilable(Sentdm::ProfileSettings)) }
+        attr_reader :settings
+
+        sig do
+          params(settings: T.nilable(Sentdm::ProfileSettings::OrHash)).void
+        end
+        attr_writer :settings
+
+        # Profile status (only for profile type): incomplete, pending_review, approved,
+        # etc.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :status
+
+        # The response data (null if error)
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            description: T.nilable(String),
+            icon: T.nilable(String),
+            name: String,
+            profiles:
+              T.nilable(
+                T::Array[
+                  Sentdm::Models::MeRetrieveResponse::Data::Profile::OrHash
+                ]
+              ),
+            settings: T.nilable(Sentdm::ProfileSettings::OrHash),
+            status: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Customer ID (organization or profile)
+          id: nil,
+          # When the account was created
+          created_at: nil,
+          # Account description
+          description: nil,
+          # Account icon URL
+          icon: nil,
+          # Account name
+          name: nil,
+          # List of profiles (only for organization type)
+          profiles: nil,
+          # Profile settings (only for profile type)
+          settings: nil,
+          # Profile status (only for profile type): incomplete, pending_review, approved,
+          # etc.
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              description: T.nilable(String),
+              icon: T.nilable(String),
+              name: String,
+              profiles:
+                T.nilable(
+                  T::Array[Sentdm::Models::MeRetrieveResponse::Data::Profile]
+                ),
+              settings: T.nilable(Sentdm::ProfileSettings),
+              status: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Profile < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::MeRetrieveResponse::Data::Profile,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Profile unique identifier
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # When the profile was created
+          sig { returns(T.nilable(Time)) }
+          attr_reader :created_at
+
+          sig { params(created_at: Time).void }
+          attr_writer :created_at
+
+          # Profile description
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # Profile icon URL
+          sig { returns(T.nilable(String)) }
+          attr_accessor :icon
+
+          # Profile name
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # User's role in this profile: admin, billing, developer (inherited from
+          # organization if not explicitly set)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :role
+
+          # Profile configuration settings
+          sig { returns(T.nilable(Sentdm::ProfileSettings)) }
+          attr_reader :settings
+
+          sig { params(settings: Sentdm::ProfileSettings::OrHash).void }
+          attr_writer :settings
+
+          # Profile short name (abbreviation)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :short_name
+
+          # Profile setup status: incomplete, pending_review, approved, rejected
+          sig { returns(T.nilable(String)) }
+          attr_accessor :status
+
+          # Profile (sender profile) response for v3 API
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              description: T.nilable(String),
+              icon: T.nilable(String),
+              name: String,
+              role: T.nilable(String),
+              settings: Sentdm::ProfileSettings::OrHash,
+              short_name: T.nilable(String),
+              status: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Profile unique identifier
+            id: nil,
+            # When the profile was created
+            created_at: nil,
+            # Profile description
+            description: nil,
+            # Profile icon URL
+            icon: nil,
+            # Profile name
+            name: nil,
+            # User's role in this profile: admin, billing, developer (inherited from
+            # organization if not explicitly set)
+            role: nil,
+            # Profile configuration settings
+            settings: nil,
+            # Profile short name (abbreviation)
+            short_name: nil,
+            # Profile setup status: incomplete, pending_review, approved, rejected
+            status: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                description: T.nilable(String),
+                icon: T.nilable(String),
+                name: String,
+                role: T.nilable(String),
+                settings: Sentdm::ProfileSettings,
+                short_name: T.nilable(String),
+                status: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_retrieve_activities_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageRetrieveActivitiesParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::MessageRetrieveActivitiesParams,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_retrieve_activities_response.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageRetrieveActivitiesResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::MessageRetrieveActivitiesResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The response data (null if error)
+      sig do
+        returns(
+          T.nilable(Sentdm::Models::MessageRetrieveActivitiesResponse::Data)
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            T.nilable(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Data::OrHash
+            )
+        ).void
+      end
+      attr_writer :data
+
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
+
+      # Metadata about the request and response
+      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::Models::MessageRetrieveActivitiesResponse::Data::OrHash
+            ),
+          error: T.nilable(Sentdm::APIError::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 details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T.nilable(
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data
+              ),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # List of activity events ordered by most recent first
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity
+              ]
+            )
+          )
+        end
+        attr_reader :activities
+
+        sig do
+          params(
+            activities:
+              T::Array[
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity::OrHash
+              ]
+          ).void
+        end
+        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
+
+        # The response data (null if error)
+        sig do
+          params(
+            activities:
+              T::Array[
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity::OrHash
+              ],
+            message_id: String
+          ).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
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              activities:
+                T::Array[
+                  Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity
+                ],
+              message_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Activity < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Additional content or payload for the activity (e.g., channel response)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :content
+
+          # Human-readable description of the activity
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
+          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
+          sig do
+            params(
+              content: T.nilable(String),
+              description: String,
+              status: String,
+              timestamp: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Additional content or payload for the activity (e.g., channel response)
+            content: nil,
+            # Human-readable description of the activity
+            description: nil,
+            # Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
+            status: nil,
+            # When this activity occurred
+            timestamp: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                content: T.nilable(String),
+                description: String,
+                status: String,
+                timestamp: Time
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_retrieve_status_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageRetrieveStatusParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageRetrieveStatusParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end