sentdm 0.2.0 → 0.3.0

data/lib/sentdm/models/template_definition.rb

@@ -7,25 +7,25 @@ module Sentdm
       #   Required template body with content for different channels (multi-channel,
       #   SMS-specific, or WhatsApp-specific)
       #
-      #   @return [Sentdm::Models::TemplateDefinition::Body]
-      required :body, -> { Sentdm::TemplateDefinition::Body }
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody]
+      required :body, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateBody }
 
       # @!attribute authentication_config
       #   Configuration specific to AUTHENTICATION category templates (optional)
       #
-      #   @return [Sentdm::Models::TemplateDefinition::AuthenticationConfig, nil]
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil]
       optional :authentication_config,
-               -> { Sentdm::TemplateDefinition::AuthenticationConfig },
+               -> { Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig },
                api_name: :authenticationConfig,
                nil?: true
 
       # @!attribute buttons
       #   Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
       #
-      #   @return [Array<Sentdm::Models::TemplateDefinition::Button>, nil]
+      #   @return [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil]
       optional :buttons,
                -> {
-                 Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateDefinition::Button]
+                 Sentdm::Internal::Type::ArrayOf[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
                },
                nil?: true
 
@@ -38,14 +38,14 @@ module Sentdm
       # @!attribute footer
       #   Optional template footer with optional variables
       #
-      #   @return [Sentdm::Models::TemplateDefinition::Footer, nil]
-      optional :footer, -> { Sentdm::TemplateDefinition::Footer }, nil?: true
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil]
+      optional :footer, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter }, nil?: true
 
       # @!attribute header
       #   Optional template header with optional variables
       #
-      #   @return [Sentdm::Models::TemplateDefinition::Header, nil]
-      optional :header, -> { Sentdm::TemplateDefinition::Header }, nil?: true
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil]
+      optional :header, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader }, nil?: true
 
       # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
       #   Some parameter documentations has been truncated, see
@@ -54,257 +54,17 @@ module Sentdm
       #   Complete definition of a message template including header, body, footer, and
       #   buttons
       #
-      #   @param body [Sentdm::Models::TemplateDefinition::Body] Required template body with content for different channels (multi-channel, SMS-s
+      #   @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Required template body with content for different channels (multi-channel, SMS-s
       #
-      #   @param authentication_config [Sentdm::Models::TemplateDefinition::AuthenticationConfig, nil] Configuration specific to AUTHENTICATION category templates (optional)
+      #   @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration specific to AUTHENTICATION category templates (optional)
       #
-      #   @param buttons [Array<Sentdm::Models::TemplateDefinition::Button>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+      #   @param buttons [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
       #
       #   @param definition_version [String, nil] The version of the template definition format
       #
-      #   @param footer [Sentdm::Models::TemplateDefinition::Footer, nil] Optional template footer with optional variables
+      #   @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Optional template footer with optional variables
       #
-      #   @param header [Sentdm::Models::TemplateDefinition::Header, nil] Optional template header with optional variables
-
-      # @see Sentdm::Models::TemplateDefinition#body
-      class Body < Sentdm::Internal::Type::BaseModel
-        # @!attribute multi_channel
-        #   Content that will be used for all channels (SMS and WhatsApp) unless
-        #   channel-specific content is provided
-        #
-        #   @return [Sentdm::Models::TemplateBodyContent, nil]
-        optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
-
-        # @!attribute sms
-        #   SMS-specific content that overrides multi-channel content for SMS messages
-        #
-        #   @return [Sentdm::Models::TemplateBodyContent, nil]
-        optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
-
-        # @!attribute whatsapp
-        #   WhatsApp-specific content that overrides multi-channel content for WhatsApp
-        #   messages
-        #
-        #   @return [Sentdm::Models::TemplateBodyContent, nil]
-        optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
-
-        # @!method initialize(multi_channel: nil, sms: nil, whatsapp: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateDefinition::Body} for more details.
-        #
-        #   Required template body with content for different channels (multi-channel,
-        #   SMS-specific, or WhatsApp-specific)
-        #
-        #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
-        #
-        #   @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
-        #
-        #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
-      end
-
-      # @see Sentdm::Models::TemplateDefinition#authentication_config
-      class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
-        # @!attribute add_security_recommendation
-        #   Whether to add the security recommendation text: "For your security, do not
-        #   share this code."
-        #
-        #   @return [Boolean, nil]
-        optional :add_security_recommendation,
-                 Sentdm::Internal::Type::Boolean,
-                 api_name: :addSecurityRecommendation
-
-        # @!attribute code_expiration_minutes
-        #   Code expiration time in minutes (1-90). If set, adds footer: "This code expires
-        #   in X minutes."
-        #
-        #   @return [Integer, nil]
-        optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
-
-        # @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateDefinition::AuthenticationConfig} for more details.
-        #
-        #   Configuration specific to AUTHENTICATION category templates (optional)
-        #
-        #   @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
-        #
-        #   @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
-      end
-
-      class Button < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique identifier of the button (1-based index)
-        #
-        #   @return [Integer, nil]
-        optional :id, Integer
-
-        # @!attribute props
-        #   Properties specific to the button type
-        #
-        #   @return [Sentdm::Models::TemplateDefinition::Button::Props, nil]
-        optional :props, -> { Sentdm::TemplateDefinition::Button::Props }
-
-        # @!attribute type
-        #   The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
-        #
-        #   @return [String, nil]
-        optional :type, String
-
-        # @!method initialize(id: nil, props: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateDefinition::Button} for more details.
-        #
-        #   Interactive button in a message template
-        #
-        #   @param id [Integer] The unique identifier of the button (1-based index)
-        #
-        #   @param props [Sentdm::Models::TemplateDefinition::Button::Props] Properties specific to the button type
-        #
-        #   @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
-
-        # @see Sentdm::Models::TemplateDefinition::Button#props
-        class Props < Sentdm::Internal::Type::BaseModel
-          # @!attribute active_for
-          #
-          #   @return [Integer, nil]
-          optional :active_for, Integer, api_name: :activeFor, nil?: true
-
-          # @!attribute autofill_text
-          #
-          #   @return [String, nil]
-          optional :autofill_text, String, api_name: :autofillText, nil?: true
-
-          # @!attribute country_code
-          #
-          #   @return [String, nil]
-          optional :country_code, String, api_name: :countryCode, nil?: true
-
-          # @!attribute offer_code
-          #
-          #   @return [String, nil]
-          optional :offer_code, String, api_name: :offerCode, nil?: true
-
-          # @!attribute otp_type
-          #
-          #   @return [String, nil]
-          optional :otp_type, String, api_name: :otpType, nil?: true
-
-          # @!attribute package_name
-          #
-          #   @return [String, nil]
-          optional :package_name, String, api_name: :packageName, nil?: true
-
-          # @!attribute phone_number
-          #
-          #   @return [String, nil]
-          optional :phone_number, String, api_name: :phoneNumber, nil?: true
-
-          # @!attribute quick_reply_type
-          #
-          #   @return [String, nil]
-          optional :quick_reply_type, String, api_name: :quickReplyType, nil?: true
-
-          # @!attribute signature_hash
-          #
-          #   @return [String, nil]
-          optional :signature_hash, String, api_name: :signatureHash, nil?: true
-
-          # @!attribute text
-          #
-          #   @return [String, nil]
-          optional :text, String, nil?: true
-
-          # @!attribute url
-          #
-          #   @return [String, nil]
-          optional :url, String, nil?: true
-
-          # @!attribute url_type
-          #
-          #   @return [String, nil]
-          optional :url_type, String, api_name: :urlType, nil?: true
-
-          # @!method initialize(active_for: nil, autofill_text: nil, country_code: nil, offer_code: nil, otp_type: nil, package_name: nil, phone_number: nil, quick_reply_type: nil, signature_hash: nil, text: nil, url: nil, url_type: nil)
-          #   Properties specific to the button type
-          #
-          #   @param active_for [Integer, nil]
-          #   @param autofill_text [String, nil]
-          #   @param country_code [String, nil]
-          #   @param offer_code [String, nil]
-          #   @param otp_type [String, nil]
-          #   @param package_name [String, nil]
-          #   @param phone_number [String, nil]
-          #   @param quick_reply_type [String, nil]
-          #   @param signature_hash [String, nil]
-          #   @param text [String, nil]
-          #   @param url [String, nil]
-          #   @param url_type [String, nil]
-        end
-      end
-
-      # @see Sentdm::Models::TemplateDefinition#footer
-      class Footer < Sentdm::Internal::Type::BaseModel
-        # @!attribute template
-        #   The footer template text with optional variable placeholders
-        #
-        #   @return [String, nil]
-        optional :template, String
-
-        # @!attribute type
-        #   The type of footer (typically "text")
-        #
-        #   @return [String, nil]
-        optional :type, String, nil?: true
-
-        # @!attribute variables
-        #   List of variables used in the footer template
-        #
-        #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
-        optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
-
-        # @!method initialize(template: nil, type: nil, variables: nil)
-        #   Optional template footer with optional variables
-        #
-        #   @param template [String] The footer template text with optional variable placeholders
-        #
-        #   @param type [String, nil] The type of footer (typically "text")
-        #
-        #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
-      end
-
-      # @see Sentdm::Models::TemplateDefinition#header
-      class Header < Sentdm::Internal::Type::BaseModel
-        # @!attribute template
-        #   The header template text with optional variable placeholders (e.g., "Welcome to
-        #   {{0:variable}}")
-        #
-        #   @return [String, nil]
-        optional :template, String
-
-        # @!attribute type
-        #   The type of header (e.g., "text", "image", "video", "document")
-        #
-        #   @return [String, nil]
-        optional :type, String, nil?: true
-
-        # @!attribute variables
-        #   List of variables used in the header template
-        #
-        #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
-        optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
-
-        # @!method initialize(template: nil, type: nil, variables: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateDefinition::Header} for more details.
-        #
-        #   Optional template header with optional variables
-        #
-        #   @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
-        #
-        #   @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
-        #
-        #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
-      end
+      #   @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Optional template header with optional variables
     end
   end
 end

data/lib/sentdm/models/template_delete_params.rb

@@ -7,7 +7,28 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute delete_from_meta
+      #   Whether to also delete the template from WhatsApp/Meta (optional, defaults to
+      #   false)
+      #
+      #   @return [Boolean, nil]
+      optional :delete_from_meta, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(delete_from_meta: nil, test_mode: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateDeleteParams} for more details.
+      #
+      #   @param delete_from_meta [Boolean, nil] Whether to also delete the template from WhatsApp/Meta (optional, defaults to fa
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/template_list_params.rb

@@ -8,45 +8,44 @@ module Sentdm
       include Sentdm::Internal::Type::RequestParameters
 
       # @!attribute page
-      #   The page number (zero-indexed). Default is 0.
+      #   Page number (1-indexed)
       #
       #   @return [Integer]
       required :page, Integer
 
       # @!attribute page_size
-      #   The number of items per page (1-1000). Default is 100.
       #
       #   @return [Integer]
       required :page_size, Integer
 
       # @!attribute category
-      #   Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+      #   Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
       #   @return [String, nil]
       optional :category, String, nil?: true
 
       # @!attribute search
-      #   Optional search term to filter templates by name or content
+      #   Optional search term for filtering templates
       #
       #   @return [String, nil]
       optional :search, String, nil?: true
 
       # @!attribute status
-      #   Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+      #   Optional status filter: APPROVED, PENDING, REJECTED
       #
       #   @return [String, nil]
       optional :status, String, nil?: true
 
       # @!method initialize(page:, page_size:, category: nil, search: nil, status: nil, request_options: {})
-      #   @param page [Integer] The page number (zero-indexed). Default is 0.
+      #   @param page [Integer] Page number (1-indexed)
       #
-      #   @param page_size [Integer] The number of items per page (1-1000). Default is 100.
+      #   @param page_size [Integer]
       #
-      #   @param category [String, nil] Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+      #   @param category [String, nil] Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
-      #   @param search [String, nil] Optional search term to filter templates by name or content
+      #   @param search [String, nil] Optional search term for filtering templates
       #
-      #   @param status [String, nil] Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+      #   @param status [String, nil] Optional status filter: APPROVED, PENDING, REJECTED
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/sentdm/models/template_list_response.rb

@@ -4,37 +4,62 @@ module Sentdm
   module Models
     # @see Sentdm::Resources::Templates#list
     class TemplateListResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute items
+      # @!attribute data
+      #   The response data (null if error)
       #
-      #   @return [Array<Sentdm::Models::TemplateResponseV2>, nil]
-      optional :items, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateResponseV2] }
+      #   @return [Sentdm::Models::TemplateListResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::TemplateListResponse::Data }, nil?: true
 
-      # @!attribute page
+      # @!attribute error
+      #   Error details (null if successful)
       #
-      #   @return [Integer, nil]
-      optional :page, Integer
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
 
-      # @!attribute page_size
+      # @!attribute meta
+      #   Metadata about the request and response
       #
-      #   @return [Integer, nil]
-      optional :page_size, Integer, api_name: :pageSize
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
 
-      # @!attribute total_count
+      # @!attribute success
+      #   Indicates whether the request was successful
       #
-      #   @return [Integer, nil]
-      optional :total_count, Integer, api_name: :totalCount
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
 
-      # @!attribute total_pages
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
       #
-      #   @return [Integer, nil]
-      optional :total_pages, Integer, api_name: :totalPages
+      #   @param data [Sentdm::Models::TemplateListResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::TemplateListResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute pagination
+        #   Pagination metadata
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
+
+        # @!attribute templates
+        #   List of templates
+        #
+        #   @return [Array<Sentdm::Models::Template>, nil]
+        optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
 
-      # @!method initialize(items: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
-      #   @param items [Array<Sentdm::Models::TemplateResponseV2>]
-      #   @param page [Integer]
-      #   @param page_size [Integer]
-      #   @param total_count [Integer]
-      #   @param total_pages [Integer]
+        # @!method initialize(pagination: nil, templates: nil)
+        #   The response data (null if error)
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
+        #
+        #   @param templates [Array<Sentdm::Models::Template>] List of templates
+      end
     end
   end
 end

data/lib/sentdm/models/template_update_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Templates#update
+    class TemplateUpdateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute category
+      #   Template category: MARKETING, UTILITY, AUTHENTICATION
+      #
+      #   @return [String, nil]
+      optional :category, String, nil?: true
+
+      # @!attribute definition
+      #   Template definition including header, body, footer, and buttons
+      #
+      #   @return [Sentdm::Models::TemplateDefinition, nil]
+      optional :definition, -> { Sentdm::TemplateDefinition }, nil?: true
+
+      # @!attribute language
+      #   Template language code (e.g., en_US)
+      #
+      #   @return [String, nil]
+      optional :language, String, nil?: true
+
+      # @!attribute name
+      #   Template display name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute submit_for_review
+      #   Whether to submit the template for review after updating (default: false)
+      #
+      #   @return [Boolean, nil]
+      optional :submit_for_review, Sentdm::Internal::Type::Boolean
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(category: nil, definition: nil, language: nil, name: nil, submit_for_review: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateUpdateParams} for more details.
+      #
+      #   @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION
+      #
+      #   @param definition [Sentdm::Models::TemplateDefinition, nil] Template definition including header, body, footer, and buttons
+      #
+      #   @param language [String, nil] Template language code (e.g., en_US)
+      #
+      #   @param name [String, nil] Template display name
+      #
+      #   @param submit_for_review [Boolean] Whether to submit the template for review after updating (default: false)
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/user_invite_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#invite
+    class UserInviteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   User email address (required)
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute name
+      #   User full name (required)
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute role
+      #   User role: admin, billing, or developer (required)
+      #
+      #   @return [String, nil]
+      optional :role, String
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(email: nil, name: nil, role: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::UserInviteParams} for more details.
+      #
+      #   @param email [String] User email address (required)
+      #
+      #   @param name [String] User full name (required)
+      #
+      #   @param role [String] User role: admin, billing, or developer (required)
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/user_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#list
+    class UserListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end