sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/models/template_list_response.rbi

@@ -8,67 +8,121 @@ module Sentdm
           T.any(Sentdm::Models::TemplateListResponse, Sentdm::Internal::AnyHash)
         end
 
-      sig { returns(T.nilable(T::Array[Sentdm::TemplateResponse])) }
-      attr_reader :items
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::TemplateListResponse::Data)) }
+      attr_reader :data
 
-      sig { params(items: T::Array[Sentdm::TemplateResponse::OrHash]).void }
-      attr_writer :items
-
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :page
-
-      sig { params(page: Integer).void }
-      attr_writer :page
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::TemplateListResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :page_size
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
 
-      sig { params(page_size: Integer).void }
-      attr_writer :page_size
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :total_count
+      # Metadata about the request and response
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
 
-      sig { params(total_count: Integer).void }
-      attr_writer :total_count
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :total_pages
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
 
-      sig { params(total_pages: Integer).void }
-      attr_writer :total_pages
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
 
+      # Standard API response envelope for all v3 endpoints
       sig do
         params(
-          items: T::Array[Sentdm::TemplateResponse::OrHash],
-          page: Integer,
-          page_size: Integer,
-          total_count: Integer,
-          total_pages: Integer
+          data: T.nilable(Sentdm::Models::TemplateListResponse::Data::OrHash),
+          error: T.nilable(Sentdm::APIError::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        items: nil,
-        page: nil,
-        page_size: nil,
-        total_count: nil,
-        total_pages: nil
+        # 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(
           {
-            items: T::Array[Sentdm::TemplateResponse],
-            page: Integer,
-            page_size: Integer,
-            total_count: Integer,
-            total_pages: Integer
+            data: T.nilable(Sentdm::Models::TemplateListResponse::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::TemplateListResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Pagination metadata
+        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        attr_writer :pagination
+
+        # List of templates
+        sig { returns(T.nilable(T::Array[Sentdm::Template])) }
+        attr_reader :templates
+
+        sig { params(templates: T::Array[Sentdm::Template::OrHash]).void }
+        attr_writer :templates
+
+        # The response data (null if error)
+        sig do
+          params(
+            pagination: Sentdm::PaginationMeta::OrHash,
+            templates: T::Array[Sentdm::Template::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Pagination metadata
+          pagination: nil,
+          # List of templates
+          templates: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              pagination: Sentdm::PaginationMeta,
+              templates: T::Array[Sentdm::Template]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/template_update_params.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateUpdateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateUpdateParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Template category: MARKETING, UTILITY, AUTHENTICATION
+      sig { returns(T.nilable(String)) }
+      attr_accessor :category
+
+      # Template definition including header, body, footer, and buttons
+      sig { returns(T.nilable(Sentdm::TemplateDefinition)) }
+      attr_reader :definition
+
+      sig do
+        params(definition: T.nilable(Sentdm::TemplateDefinition::OrHash)).void
+      end
+      attr_writer :definition
+
+      # Template language code (e.g., en_US)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :language
+
+      # Template display name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # Whether to submit the template for review after updating (default: false)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :submit_for_review
+
+      sig { params(submit_for_review: T::Boolean).void }
+      attr_writer :submit_for_review
+
+      # Test mode flag - when true, the operation is simulated without side effects
+      # Useful for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :test_mode
+
+      sig { params(test_mode: T::Boolean).void }
+      attr_writer :test_mode
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          category: T.nilable(String),
+          definition: T.nilable(Sentdm::TemplateDefinition::OrHash),
+          language: T.nilable(String),
+          name: T.nilable(String),
+          submit_for_review: T::Boolean,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template category: MARKETING, UTILITY, AUTHENTICATION
+        category: nil,
+        # Template definition including header, body, footer, and buttons
+        definition: nil,
+        # Template language code (e.g., en_US)
+        language: nil,
+        # Template display name
+        name: nil,
+        # Whether to submit the template for review after updating (default: false)
+        submit_for_review: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            category: T.nilable(String),
+            definition: T.nilable(Sentdm::TemplateDefinition),
+            language: T.nilable(String),
+            name: T.nilable(String),
+            submit_for_review: T::Boolean,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/user_invite_params.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserInviteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::UserInviteParams, Sentdm::Internal::AnyHash)
+        end
+
+      # User email address (required)
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # User full name (required)
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # User role: admin, billing, or developer (required)
+      sig { returns(T.nilable(String)) }
+      attr_reader :role
+
+      sig { params(role: String).void }
+      attr_writer :role
+
+      # Test mode flag - when true, the operation is simulated without side effects
+      # Useful for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :test_mode
+
+      sig { params(test_mode: T::Boolean).void }
+      attr_writer :test_mode
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          email: String,
+          name: String,
+          role: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User email address (required)
+        email: nil,
+        # User full name (required)
+        name: nil,
+        # User role: admin, billing, or developer (required)
+        role: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            name: String,
+            role: String,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/user_list_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::UserListParams, 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/user_list_response.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserListResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::Models::UserListResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::UserListResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::UserListResponse::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::UserListResponse::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::UserListResponse::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::UserListResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # List of users in the organization
+        sig { returns(T.nilable(T::Array[Sentdm::UserResponse])) }
+        attr_reader :users
+
+        sig { params(users: T::Array[Sentdm::UserResponse::OrHash]).void }
+        attr_writer :users
+
+        # The response data (null if error)
+        sig do
+          params(users: T::Array[Sentdm::UserResponse::OrHash]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # List of users in the organization
+          users: nil
+        )
+        end
+
+        sig { override.returns({ users: T::Array[Sentdm::UserResponse] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/user_remove_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserRemoveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::UserRemoveParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Test mode flag - when true, the operation is simulated without side effects
+      # Useful for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :test_mode
+
+      sig { params(test_mode: T::Boolean).void }
+      attr_writer :test_mode
+
+      # User ID from route parameter
+      sig { returns(T.nilable(String)) }
+      attr_reader :body_user_id
+
+      sig { params(body_user_id: String).void }
+      attr_writer :body_user_id
+
+      sig do
+        params(
+          test_mode: T::Boolean,
+          body_user_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        # User ID from route parameter
+        body_user_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            test_mode: T::Boolean,
+            body_user_id: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/user_response.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::UserResponse, Sentdm::Internal::AnyHash) }
+
+      # User unique identifier
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # When the user was added to the organization
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # User email address
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # When the user was invited
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :invited_at
+
+      # When the user last logged in
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :last_login_at
+
+      # User full name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # User role in the organization: admin, billing, developer
+      sig { returns(T.nilable(String)) }
+      attr_reader :role
+
+      sig { params(role: String).void }
+      attr_writer :role
+
+      # User status: active, invited, suspended, rejected
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # When the user record was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # User response for v3 API
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          email: String,
+          invited_at: T.nilable(Time),
+          last_login_at: T.nilable(Time),
+          name: String,
+          role: String,
+          status: String,
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User unique identifier
+        id: nil,
+        # When the user was added to the organization
+        created_at: nil,
+        # User email address
+        email: nil,
+        # When the user was invited
+        invited_at: nil,
+        # When the user last logged in
+        last_login_at: nil,
+        # User full name
+        name: nil,
+        # User role in the organization: admin, billing, developer
+        role: nil,
+        # User status: active, invited, suspended, rejected
+        status: nil,
+        # When the user record was last updated
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            email: String,
+            invited_at: T.nilable(Time),
+            last_login_at: T.nilable(Time),
+            name: String,
+            role: String,
+            status: String,
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/user_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class UserRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::UserRetrieveParams, 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